Команды для работы со скриптами в Orion Assistant 2.0 - Hotride/OrionUO GitHub Wiki
Группа команд управления состоянием скриптов для Orion Assistant 2.0.
Формат команд:
ReturnType NameSpace.name(requiredParameters, [optionalParameters=defaultValue]);
-
ReturnType - возвращаемое значение функции (void - функция ничего не возвращает);
-
NameSpace - область видимости функции;
-
name - имя функции;
-
requiredParameters - обязательные параметры;
-
optionalParameters - не обязательные параметры, значение по умолчанию указано после знака =
void Orion.Wait('delay');
Ждать delay миллисекунд.
Помимо значения может принимать в параметр строковые константы: moveitemdelay, waittargetdelay, useitemdelay, keepcorpsedelay.
int Orion.Now();
Результат: текущее время в миллисекундах.
void Orion.LoadScript('filePath');
Загрузить файл скрипта.
void Orion.Exec('functionName', [oneScriptRunning=false], [argumentsList]);
Запустить функцию.
-
- functionName - Имя запускаемой функции.
-
- oneScriptRunning - Проверять наличие запущенного экземпляра функции с таким же названием и предотвращать повторное выполнение.
-
- argumentsList - Список параметров функции.
void Orion.Terminate('functionName', ['functionsSave']);
Завершить выполнение скрипта. Регистр названий функций важен!!!
-
- functionName - Название функции для завершения. Завершает все функции с таким именем. Если указано 'all' - завершает все функции, кроме указанных в functionsSave.
-
- functionsSave - Функции, которые не нужно завершать, указываются через '|' например Orion.Terminate('all', 'Heal|Loot|CheckMana') - завершит все работающие фукнции, кроме Heal, Loot, CheckMana.
int Orion.ScriptRunning('functionName');
Проверка, сколько запущено скриптов с указаным именем.
Результат: количество запущенных скриптов.
Introduced in 2.0.7.0
void Orion.Launch('filePath', [arguments]);
Запуск сторонней программы по пути filePath с параметрами arguments.
bool Orion.Contains(text, pattern, [ignoreCase=true]);
Проверка на наличие в строке текста, или наборов текста, разделенных |
Работает аналогично поиску текста в журнале.
-
- text - Текст для проверки.
-
- pattern - Текст (или наборы текста) для поиска.
-
- ignoreCase - true - игнорировать регистр, false - точное совпадение.
Результат: true если что-то нашлось.
StringList Orion.Split(text, [separator=' '], [skipEmptyWorld=true]);
Разбиение строки text на слова, используя разделитель между словами separator.
-
- text - Текст.
-
- separator - Разделитель между словами.
-
- skipEmptyWorld - true - пропускать пустые слова, false - добавлять их в массив.
Результат: Массив слов.
Introduced in 2.0.8.0
String Orion.OAVersion();
Результат: Текущая версия ассистента, например "2.0.8.0".
bool Orion.Connected();
Результат: true если подключены к серверу и вошли в мир.
String Orion.Time(['format'=hh:mm:ss.zzz]);
Результат: Возвращает текущее время, например "13:27:41.508".
String Orion.Date(['format'=dd.MM.yyyy]);
Результат: Возвращает текущую дату, например "26.05.2017".
int Orion.Random([value=2147483647]);
Результат: Возвращает случайное число от 0 до value-1.
int Orion.Random(minValue, maxValue);
Результат: Возвращает случайное число от minValue до maxValue-1.
Introduced in 2.0.15.0
void Orion.ActivateClient();
Активировать окно клиента.
void Orion.ShutdownWindows(['mode']);
Выключить компьютер. Если указан mode как 'forced' - добавляет соответствующий флаг.
bool Orion.OnOffHotkeys();
Получить текущее состояние использования хоткеев (включено/выключено)
Результат: true если хоткеи включены.
void Orion.OnOffHotkeys(state);
Изменить текущее состояние использования хоткеев (включено/выключено) на state.
Introduced in 3.0.0.0
void Orion.PauseScript();
Поставить текущий скрипт на паузу.
void Orion.PauseScript('name');
Поставить указанный (name) скрипт на паузу.
Если указано 'all' - ставит все скрипты на паузу.
void Orion.ResumeScript('name');
Возобновить работу указанного (name) скрипта.
Если указано 'all' - снимает все скрипты с паузы.
void Orion.ToggleScript('functionName', [oneScriptRunning=false], [argumentsList]);
Запустить или остановить запущенные скрипты с указанным именем.
-
- functionName - Имя запускаемой/останавливаемой функции.
-
- oneScriptRunning - Проверять наличие запущенного экземпляра функции с таким же названием и предотвращать повторное выполнение.
-
- argumentsList - Список параметров функции.