eventMacro

Содержание

1 Описание
2 Установка
3 Консольные команды
- 3.1 Синтаксис
4 Файлы настроек
5 Синтаксис эвент-макросов
6 Автомакросы
7 Подпрограммы Perl
8 Комментарии
9 Примеры с пояснениями
10 Как написать макрос
11 Собрание макросов
12 FAQ
13 Авторы-программисты

Описание

Этот плагин представляет собой переделанный и обновлённый macro плагин, написанный таким образом, чтобы потреблять меньше процессорной мощности. Имеет более расширенный функционал по сравнению со своим предшественником.
С помощью этого плагина, Вы сможете составлять блоки с условиями, называемые автомакросами (automacro) и блоки исполняемых инструкций, называемые макросами (macro).
Автомакросы срабатывают при достижении условий, описанных в блоке (например, появление определённого слова в чате, или достижение определённого уровня, и т.д.). По результату срабатывания выполняется один или несколько макросов.
Макросы могут быть простыми (например, «сказать что-то в чате» или «сохранить предметы в кафре»), или сложными (например, «выполнить полный квест»). Макросы вызываются несколькими способами: автомакросами, вручную консольной командой eventMacro <название_макроса>, либо инструкцией call <название_макроса>.

* Старые макросы не совместимы с эвент-макросами! Их следует переписать, используя новый синтаксис эвент-макросов.

Установка

eventMacro по умолчанию включён в стандартную версию OpenKore.
Чтобы начать использовать плагин, просто создайте в папке control файл eventMacros.txt и наполните файл эвент-макросами.

Консольные команды

Синтаксис

eventMacro [MACRO|auto|list|status|check|stop|pause|unpause|var_get|var_set|enable|disable|include] [extra]

eventMacro <MACRO>

Запустить макрос с названием <MACRO>. При запуске можно использовать предустановленные опции, либо произвольные параметры.

Опция	Значение	Описание
-repeat \| -r	n (целое_число)	Повторяет выполнение макроса n раз
-overrideAI		игнорирует ИИ (см. описание ниже)
-macro_delay	секунды	задержка между выполняемыми командами в макросе
-exclusive		Запрещает прерывать выполнение макроса другими автомакросами
-orphan	terminate reregister reregister_safe terminate_last_call	Что делать с макросами которые были удалены из очереди ИИ (AI queue)

Макросы можно запускать с произвольными параметрами. Они указываются с помощью двойной черты +пробел -- , либо просто через пробел. Эти параметры сохраняются в массиве @.param. Пример:

macro showParam {
 log Parameter 1 is $.param[0]
 log Parameter 2 is $.param[1]
}

Если запустить макрос с помощью консольной команды eventMacro showParam -- foo bar (либо eventMacro showParam foo bar), то он выведет в консоль:

[eventmacro log] Parameter 1 is foo
[eventmacro log] Parameter 2 is bar

eventMacro auto <AUTOMACRO>: Получить информацию об автомакросе с названием <AUTOMACRO> и его условиях

eventMacro list: Получить список доступных макросов и автомакросов

eventMacro status [macro|automacro]: Получить текущее состояние макросов или автомакросов

eventMacro check (force_stop|force_start|resume)

Указать состояние проверки автомакросов:

eventMacro check force_stop - принудительно остановить проверку условий автомакросов
eventMacro check force_start - принудительно остановить проверку условий автомакросов
eventMacro check resume - вернуть проверку условий автомакросов в нормальное состояние

eventMacro stop: Отменить выполнение текущего макроса

eventMacro pause: Поставить на паузу текущий макрос

eventMacro unpause: Возобновить выполнение текущего макроса

eventMacro var_get [<var_name>]: Показать значение переменной <var_name>, либо если параметр не указан, всех переменных. С помощью этой команды можно посмотреть значения следующих переменных: скаляра ($var_name), массива (@var_name) или хэша (%var_name)

eventMacro var_set <var_name> <value>: Присвоить значение <value> переменной <var_name>

eventMacro enable [automacro]: Включить один, либо если параметр не указан, все автомакросы

eventMacro disable [automacro]: Выключить один, либо если параметр не указан, все автомакросы

eventMacro include (on | off | list) [filename or pattern]: Включить или отключить дополнительный файл, подключенный с помощью !include, в файле eventMacros.txt

Примечание. Консольную команду "eventMacro" писать очень долго и не удобно. В конфиге OpenKore можно назначить синоним на эту команду, например: " alias_em eventMacro".

Файлы настроек

control/eventMacros.txt: Поместите свои эвент-макросы и автомакросы в этот файл. Вы можете изменить имя файла в настройке конфига eventMacro_file.

control/timeouts.txt: Добавтьте параметр eventMacro_delay и укажите количество секунд которые плагин должен подождать между выполнением команд.

control/config.txt

Параметр	Значение	По умолчанию	Описание
eventMacro_orphans	terminate reregister reregister_safe terminate_last_call	terminate	Что делать с макросами которые были удалены из очереди ИИ (AI queue)
eventMacro_file	имя файла	eventMacros.txt	файл с эвент-макросами и автомакросами
eventMacro_CheckOnAI	список 'auto', 'manual' и\или 'off'	auto	При каких значениях ИИ должны проверяться автомакросы

Синтаксис эвент-макросов

macro MacroName {
   do this..
   and that..
   yattayatta..
}

Вы можете использовать любое имя для макроса (кроме символа "пробел"). Следите, чтобы макросы не назывались одинаково, иначе ни один из этих макросов не будет загружен.
Команды в макросе выполняются по порядку сверху вниз.
В теле макроса можно использовать ТОЛЬКО специальные макро-команды. Чтобы вызвать в теле макроса консольную команду, следует использовать макро-команду do.

Макро-команды

do <команда>: выполняет <команду>, как будто она была набрана в консоли OpenKore. См. список консольных команд.

macro foo {
   do move 123 234 prontera
   do sit
   do c привет!
}

Команда ai clear по умолчанию выключена в плагине, т.е. её не удастся выполнить через макрос.
Если выполнится команда do ai off, то макрос остановит своё выполнение. Также после команды do ai manual может остановиться проверка условий автомакросов (см. параметр eventMacro_CheckOnAI)

log <текст>
warning <текст>
error <текст>: выводит <текст> в консоль. В тексте можно использовать переменные эвент-макроса ($var_name), специальные переменные ($.***) а также специальные ключевые слова (&config, &rand и т.д.). Эту макро-команду удобно использовать для отладки своих эвент-макросов.

macro foo {
  log Эта строка записывает текст в консоль.
  warning Бот достиг $.lvl уровня
}

pause <секунды>: останавливает эвент-макрос на указанное количество секунд.

macro foo {
   log сейчас 10:00:00
   pause 10
   log теперь 10:00:10 
   log после первого сообщения прошло 10 секунд.
}

макро-команда pause останавливает не только выполнение эвент-макроса, но и все действия OpenKore.

call <MACRO> [<параметры>]: выполняет другой макрос с произвольным именем <MACRO>, также можно указать произвольные <параметры>. После выполнения эвент-макроса <MACRO> продолжится выполняться текущий макрос.; В имени <MACRO> можно использовать переменные (например: call $killmacro)

macro foo {
   $killmacro = bar
   log сейчас будет выполняться макрос bar
   call $killmacro
}

lock (<AUTOMACRO> | all): выключает автомакрос с произвольным именем <AUTOMACRO> (т.е. прекращается проверка его условий срабатывания). Выключенный автомарос никогда не выполнится. Команда lock all выключает все автомакросы. Включить автомакрос обратно можно с помощью команды code>release</code>.

release (<AUTOMACRO> | all): включает обратно заблокированный автомакрос с произвольным именем <AUTOMACRO> или включает все автомакросы при использовании release all (Автомакрос может быть заблокирован условием run-once 1 или командой lock). Включённый автомакрос может повторно запуститься если выполнятся все условия его срабатывания.

stop: немедленно прерывает выполнение текущего макроса.

include (on | off | list) [<имя_файла или шаблон_имени>]: включает или выключает строчки !include в файле eventMacros.txt.

set <опция> <значение>

устанавливает значения следующим опциям:

orphan (<terminate | terminate_last_call | reregister | reregister_safe>)
macro_delay <секунды>
overrideAI <булев_флаг>
repeat <целое_число>
exclusive <булев_флаг>

Переменные

В эвент-макросе есть возможность работать с переменными. Объявлять переменные не нужно. Все переменные макросов - глобальные, т.е. переменная из одного макроса может быть использована в другом макросе.
Система переменных в eventMacro основывается на типах данных языка Perl. Переменные могут быть скалярами, массивами и хешами.
В названии переменной можно использовать только буквы и цифры.
Если Вы хотите использовать какую-либо переменную без подстановки её значения, то следует экранировать её с помощью "\" (например, \$var).

Типы переменных

Скаляр

Скалярная переменная содержит только одну величину, например, число и\или текст.
Скалярные переменные начинаются со знака $.

Массив

Переменная массив содержит список величин (элементов).
У каждого элемента в массиве есть свой индекс, который указывает на позицию в списке.
Первый элемент массива имеет индекс 0, а последний - длина массива минус один.
Массивы начинаются со знака @.

Хэш

Переменная хэш содержит пары величин.
Каждая пара состоит из ключа и значения.
Каждый ключ имеет только одно значение, но несколько ключей могут иметь одинаковые значения.
Хэши начинаются со знака %.

Объявление и использование

Скаляр

Присвоить переменной значение: $variable = значение

Получить значение переменной (НО это касается только макросов, для автомакросов есть другой синтаксис, как и для параметров конфига и т.п.): $variable

macro Hello {
   $var = Hello
   $var1 = World!
   log $var $var1
}

Данный макрос выведет на консоль:

[eventmacro message] Hello World!

Увеличить на 1 значение переменной: $variable++ или уменьшить $variable--

macro Counter {
    $counter = 0
    log Значение счётчика: $counter
    $counter++
    log Новое значение: $counter
    $counter--
    log Прежнее значение: $counter
}

В консоли увидим:

[eventmacro message] Значение счётчика: 0
[eventmacro message] Новое значение: 1
[eventmacro message] Прежнее значение: 0

Переменную можно удалить, присвоив ей специальное значение undef или unset:

macro undef {
    $counter = 0
    $x = 1
    log \$x = $x
    $x = undef  # также можно использовать 'unset'
    log \$x теперь уничтожена: $x
}

В консоли увидим:

[eventmacro message] $x = 1
[eventmacro message] $x теперь уничтожена:

Операция присвоения не вычисляет значение справа от знака равно, а тупо подставляет вместо переменных их величины. Для расчетов нужно вызывать функцию &eval().

macro math {
    $num = 2
    $num2 = 3
    $result = $num+$num2
    $result2 = &eval($num+$num2)
    log обычная подстановка значений переменных \$result = $result
    log сумма $num и $num2 равна $result2
}

В консоли увидим:

[eventmacro message] обычная подстановка значений переменных $result = 2+3
[eventmacro message] сумма 2 и 3 равна 5

У скаляров есть следующая функция:

&defined($<переменная>}): Функции &defined требуется указать <переменную>, существование которой следует проверить. Если <переменная> существует, то функция вернёт 1, в противном случае - 0.; Примечание: если значение переменной =0, то считается, что она существует, т.е. функция &defined вернёт "1".

macro defined {
  $var = 0;
  @array = (a, b)
  %hash = (a => 1, b => 2)
  log переменная \$var существует: &defined($var)
  log элемент 1 в массиве \@array - существует: &defined($array[1])
  log ключа "с" в хэше \%hash - не существует: &defined($hash{c})
}

В консоли увидим:

[eventmacro message] переменная $var существует: 1
[eventmacro message] элемент 1 в массиве @array - существует: 1
[eventmacro message] ключа "с" в хэше %hash - не существует: 0

Массив

Присвоить массиву несколько значений можно указав их в скобках через запятую: @variable = (member0, member1, member2)

Получить доступ к конкретному элементу массива можно по его индексу. Для этого нужно вместо знака @ подставить $ и в квадратных скобках [...] указать индекс элемента: $variable[0]

Узнать длину массива: @variable

macro Hello {
   @var = (drops, poring)
   log Кол-во элементов в массиве \@var = @var, первый элемент: $var[0], второй элемент: $var[1]
}

В консоли увидим:

[eventmacro message] Кол-во элементов в массиве @var = 2, первый элемент: drops, второй элемент: poring

Отдельные элементы массива - это скалярные переменные.

Элементам массива можно присвоить значение:

$myarray[0] = Гарри
$myarray[1] = Поттер

Увеличить\уменьшить элемент массива на единицу:

macro Counter {
    $counterArray[1] = 0
    log Значение элемента \$counterArray[1]: $counterArray[1]
    $counterArray[1]++
    log Новое значение: $counterArray[1]
    $counterArray[1]--
    log Прежнее значение: $counterArray[1]
}

В консоли увидим:

[eventmacro message] Значение элемента $counterArray[1]: 0
[eventmacro message] Новое значение: 1
[eventmacro message] Прежнее значение: 0

Удаление элемента массива:

macro undef {
    $var[5] = 1
    log значение элемента \$var[5]: $var[5]
    $var[5] = undef  # также можно использовать 'unset'
    log значение элемента \$var[5] теперь уничтожено: $var[5]
}

В консоли увидим:

[eventmacro message] значение элемента $var[5]: 1
[eventmacro message] значение элемента $var[5] теперь уничтожено:

Функции для работы с массивами

Существует четыре функции, которые предназначены для работы с массивами:

&push: добавляет элемент в конец массива, увеличивая таким образом длину массива на единицу.
&pop: убирает элемент из конца массива, уменьшая таким образом длину массива на единицу.
&shift: убирает первый элемент массива, сдвигая таким образом все остальные элементы массива влево, ближе к началу и уменьшает на единицу длину массива.
&unshift: добавляет новый элемент в начало массива и сдвигает все остальные элементы вправо, ближе к концу массива, увеличивает длину массива на 1.

&push(@array, newmember): Функции &push требуется два аргумента: массив и его новый элемент.; Пример создания массива с помощью функции &push:

macro push {
    &push(@monsters, Поринг)
    &push(@monsters, Волк)
    &push(@monsters, Мая)
    log Массив \@monsters состоит из @monsters элементов: $monsters[0], $monsters[1] и $monsters[2]
}

В консоли увидим:

[eventmacro message] Массив @monsters состоит из 3 элементов: Поринг, Волк и Мая

&pop(@array): Функции &pop нужен только один аргумент - массив, из которого надо вытолкнуть последний элемент.; Пример массива в котором сначала было три элемента, потом из него вытолкнули два последних элемента и остался только один:

macro pop {
    @jobs = (нуб, вор, охотник)
    log Массив \@jobs состоит из @jobs элементов: $jobs[0], $jobs[1] и $jobs[2]
    &pop(@jobs)
    log Теперь массив \@jobs состоит из @jobs элементов: $jobs[0], $jobs[1]
    &pop(@jobs)
    log Теперь массив \@jobs состоит из @jobs элемента: $jobs[0]
}

В консоли увидим:

[eventmacro message] Массив @jobs состоит из 3 элементов: нуб, вор и охотник
[eventmacro message] Теперь массив @jobs состоит из 2 элементов: нуб, вор
[eventmacro message] Теперь массив @jobs состоит из 1 элемента: нуб

&shift(@array): Функции &shift нужен только один аргумент - массив, из которого надо вытолкнуть первый элемент.; Пример массива в котором сначала было три элемента, потом из него вытолкнули два первых элемента и остался только один:

macro shift {
    @jobs = (нуб, вор, охотник)
    log Массив \@jobs состоит из @jobs элементов: $jobs[0], $jobs[1] и $jobs[2]
    &shift(@jobs)
    log Теперь массив \@jobs состоит из @jobs элементов: $jobs[0] и $jobs[1]
    &shift(@jobs)
    log Теперь массив \@jobs состоит из @jobs элемента: $jobs[0]
}

В консоли увидим:

[eventmacro message] Массив @jobs состоит из 3 элементов: нуб, вор и охотник
[eventmacro message] Теперь массив @jobs состоит из 2 элементов: вор и охотник
[eventmacro message] Теперь массив @jobs состоит из 1 элемента: охотник

Обратите внимание, что функция &shift сдвигает весь массив влево, т.е. после первого сдвига элемент 'охотник' переместится с индекса 2 на 1, а после второго сдвига получит индекс 0.

&unshift(@array, newmember): Функция &unshift требует два аргумента - массив и его новый элемент, который после сдвига массива вправо попадёт на освободившееся место в начале.; Пример создания массива с помощью функции &unshift:

macro unshift {
    &unshift(@monsters, Поринг)
    &unshift(@monsters, Волк)
    &unshift(@monsters, Мая)
    log Массив \@monsters состоит из @monsters элементов: $monsters[0], $monsters[1] и $monsters[2]
}

В консоли увидим:

[eventmacro message] Массив \@monsters состоит из @monsters элементов: Мая, Волк, Поринг

Обратите внимание, что функция &unshift сдвигает весь массив вправо, т.е. последний добавленный элемент 'Мая', оказывается на первом месте.

Хэш

Чтобы инициализировать переменную типа хэш, нужно в круглых скобках прописать через запятую список пар: "ключ => значение": %variable = (key1 => value1, key2 => value2)

Чтобы обратиться к элементу хэша, нужно использовать знак $ вместо % и в фигурных скобках { } написать ключ: $variable{key1}

Ключ может состоять из букв и цифр.

Получить количество элементов (т.е. пар) в хеше: %variable

macro Hello {
   %ages = (Kaya => 25, Namrok => 32)
   log Возраст Каи: $ages{Kaya} лет, а Намрока: $ages{Namrok} года
}

В консоли увидим:

[eventmacro message] Возраст Каи: 25 лет, а Намрока: 32 года

значения ключей хеша - это обычные скаляры.

Значениям хеша можно присвоить данные:

$name{first} = Гарри
$name{last} = Поттер

Числовые значения хеша можно увеличить\уменьшить на единицу:

macro Counter {
    $hash{monterskilled} = 0
    log Значение \$hash{monterskilled}: $hash{monterskilled}
    $hash{monterskilled}++
    log Новое значение: $hash{monterskilled}
    $hash{monterskilled}--
    log Прежнее значение: $hash{monterskilled}
}

Значение ключа хеша можно уничтожить, присвоив ему специальное слово undef или unset:

macro undef {
    $myhash{value} = 1
    log Значение \$myhash{value}: $myhash{value}
    $myhash{value} = undef  # также можно использовать 'unset'
    log \$myhash{value} теперь уничтожена: $myhash{value}
}

В консоли увидим:

[eventmacro message] Значение $myhash{value}: 1
[eventmacro message] $myhash{value} теперь уничтожена:

Функции для работы с хэшами

Существует две функции, которые предназначены для работы с хэшами:

&delete: удаляет пару ключ\значение
&exists: проверяет существует ли значение у заданного ключа

&delete($<хэш>{<ключ>}): Функции &delete требуется указать ключ хэша, который следует удалить, например: &delete ( $hash{key} )

&exists($<хэш>{<ключ>}): Функции &exists требуется указать ключ хэша, который следует проверить. Если у заданного <ключа>есть значение, то функция вернёт 1, в противном случае - 0. Например: &exists ( $hash{key} )

Пример

macro hash {
   %fruitsprice = (apple => 1000, banana => 700)
   log Хэш \%fruitsprice состоит из  %fruitsprice элементов
   log Цена на яблоки: $fruitsprice{apple}, а на бананы: $fruitsprice{banana}
   &delete($fruitsprice{apple})
   log Хэш \%fruitsprice состоит из %fruitsprice элемента
     if ( &exists($fruitsprice{apple}) ) {
       log Цена на яблоки: $fruitsprice{banana}
     } else {
       log В хэше нет яблок
     }
     if ( &exists($fruitsprice{banana}) ) {
       log Цена на бананы: $fruitsprice{banana}
     } else {
       log В хэше нет бананов
     }
}

В консоли увидим:

[eventmacro message] Хэш %fruitsprice состоит из 2 элементов
[eventmacro message] Цена на яблоки: 1000, а на бананы: 700
[eventmacro message] Хэш %fruitsprice состоит из 1 элемента
[eventmacro message] В хэше нет яблок
[eventmacro message] Цена на бананы: 700

Особые переменные

В эвент-макросе есть особые переменные, названия которых начинаются с точки. Они автоматически создаются плагином eventMacro.

Переменная	Описание	Пример
$.time	текущее время в виде unix timestamp	1482275422
$.datetime	текущая дата и время	Tue Dec 20 21:22:34 2016
$.second	текущее значение секунд (0 - 59)	53
$.minute	текущее значение минут (0 - 59)	34
$.hour	текущее значение часов в 24-х часовом формате	14
$.dayofmonth	день месяца	19
$.dayofweek	день недели (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday)	Wednesday
$.map	местонахождение персонажа, локация	prontera
$.incity	булев_флаг, 1 если персонаж в городе, иначе 0	1
$.inlockmap	булев_флаг, 1 если персонаж на lockMap, иначе 0	1
$.job	профессия персонажа	Swordman
$.pos	координаты персонажа	123 234
$.name	имя персонажа	ya4ept
$.hp	значение HP (жизнь)	2304
$.sp	значение SP (мана)	345
$.lvl	значение базового уровня	175
$.joblvl	значение профессионального уровня	60
$.spirits	количество сферок у монка или монеток у ганса	3
$.zeny	количество денег (зени)	8478341
$.weight	вес инвентаря персонажа	1948
$.weightpercent	загруженность персонажа в процентах	81.5
$.maxweight	максимальная грузоподъемность персонажа	2400
$.status	список висящих на персонаже статусов (см. файл statusnametable.txt)	Attention Concentrate,Endure,Two-Hand Quicken
$.statushandle	список висящих на персонаже статусов, в виде констант	SM_ENDURE,KN_TWOHANDQUICKEN
$.inventoryitems	количество предметов в инвентаре	13
$.cartweight	вес предметов в телеге	800
$.cartweightpercent	загруженность телеги в процентах	10
$.cartmaxweight	максимальная грузоподъемность телеги	8000
$.cartitems	количество предметов в телеге	21
$.cartmaxitems	максимально возможное количество предметов в телеге	100
$.shopopen	булев_флаг, 1 если магазин открыт, иначе 0	0
$.storageopen	булев_флаг, 1 если открыт склад, иначе 0	1
$.storageitems	количество предметов на складе	432
$.storagemaxitems	максимально возможное количество предметов на складе	600
$.param[N]	аргументы командной строки (см. Синтаксис)	-
$.caller	название последнего сработавшего автомакроса	-

Функции эвент-макроса

Функции макро-языка имеют вид &<название> (<аргументы>). Функциями можно пользоваться почти везде внутри блока macro (кроме goto, end, названиях меток (label), названиях макроса в конструкциях call и set). Все функции кроме &nick() могут принимать переменные в качестве аргументов.

&questStatus (<questID>): Вернёт статус квеста по его <questID>, возможные значения: "inactive", "incomplete" или "complete".

&questInactiveCount (<questID1>,<questID2>,<questID3>,etc): Вернёт количество взятых, но не активных (т.е. "inactive"), квестов.

&questIncompleteCount (<questID1>,<questID2>,<questID3>,etc): Вернёт количество взятых, но незавершенных (т.е. "incomplete"), квестов.

&questCompleteCount (<questID1>,<questID2>,<questID3>,etc): Вернет количество завершенных квестов, т.е. со статусом "complete".

&inventory (<имя_предмета> | <ID_предмета>): Вернёт индекс предмета в инвентаре. В качестве аргумента принимает имя предмета или его ИД. Если такого предмета нет, то возвращает -1.

&Inventory (<имя_предмета> | <ID_предмета>): Как и &inventory вернёт индекс предмета в инвентаре, но если таких предметов несколько - вернёт список их индексов через запятую. Если такого предмета нет, то возвращает -1.

&invamount (<имя_предмета> | <ID_предмета>): Вернёт количество указанного предмета в инвентаре. Если такого предмета нет, то возвращает 0.

&InventoryType (usable|equip|card|etc): Вернёт список индексов предметов заданного типа (через запятую), находящихся в инвентаре. Если таких предметов нет, то вернёт -1.

&cart (<имя_предмета> | <ID_предмета>): Вернёт индекс указанного предмета в телеге. Если такого предмета нет, то возвращает -1.

&Cart (<имя_предмета> | <ID_предмета>): Как и &cart вернёт индекс предмета в телеге, но если таких предметов несколько - вернёт список их индексов через запятую. Если такого предмета нет, то возвращает -1.

&cartamount (<имя_предмета> | <ID_предмета>): Вернёт количество предмета в телеге. Если такого предмета нет, то возвращает 0.

&storage (<имя_предмета> | <ID_предмета>): Вернёт индекс указанного предмета на складе. Если такого предмета на складе нет, то возвращает -1.

&Storage (<имя_предмета> | <ID_предмета>): Как и &storage вернёт индекс предмета на складе, но если таких предметов несколько - вернёт список их индексов через запятую. Если такого предмета нет, то возвращает -1.

&storamount (<имя_предмета> | <ID_предмета>): Вернёт количество предмета на складе. Если такого предмета нет, то возвращает 0.

&vender (<name>): Вернёт индекс продавца (игрока) с именем <name>. Если такого продавца нет в пределах видимости, то возвращает -1.

&venderitem (<имя_предмета | <ID_предмета>): Вернёт индекс предмета в магазине у торгаша (игрока). Если такого предмета в магазине нет, то возвращает -1.

&venderprice (<имя_предмета> | <indexID>): Вернёт цену предмета в магазине у торгаша (игрока). В качестве аргумента принимает имя предмета или его индекс (который можно получить через функцию выше &venderitem).

&venderamount (<индекс_предмета>): Вернёт количество предметов у торгаша (игрока). Если такого предмета в магазине нет, то возвращает -1.

&store (<имя_предмета> | <ID_предмета>): Ищёт заданный предмет в открытом магазине (НЦП) и возвращает его индекс. Если такого предмета нет, то возвращает -1.

&shopamount (<имя_предмета> | <ID_предмета>): Вернёт количество предметов, продающихся в магазине (НПЦ).

&npc (<x> <y> | "<NPC_name>" | /regexp/i): Вернёт индекс неписи, стоящей на заданных координатах <x> <y> или с именем <NPC_name> или если имя НПЦ соответствует шаблону regexp. Если непись найти не удалось, то возвращает -1.

&player (<name>): Вернёт индекс игрока с именем <name>. Если такого игрока нет в пределах видимости, то возвращает -1.

&monster (<имя_моба> | <ID>): Вернёт индекс моба. В качестве аргумента принимает имя моба или его ИД. Если такого моба нет в пределах видимости, то возвращает -1.

&config (<параметр>): Вернёт значение <параметра> из config.txt

&random ("<параметр 1>", "<параметр 2>", $var, ...): Вернёт один из перечисленных в скобках параметров. Параметры необходимо указывать в кавычках. В качестве параметров можно указывать переменные.

&rand (<n>, <m>): Вернёт случайное число в диапазоне от <n> до <m> включительно.

&eval (<параметр>): Вычисляет значение <параметра>. Например, если "$v = 8", то результатом функции &eval ($v + 2) будет число 10. Параметр функции &eval - это выражение на языке Perl, и оно не имеет ничего общего с синтаксисом эвент-макроса. В <параметре> можно использовать переменные эвент-макроса вида $var и результаты других &<функций>, например: warning &eval(&rand(0,5) + 1)

&arg ("<строка>", <n>): Вернёт <n>-ое слово из <строки>. Слова в строке разделяются знаками: ,.:;\"\'!?\r\n. Если <n> больше количества слов в строке, то возвращается пустая строка. Аргумент <n> может быть как целым числом, так и целочисленной переменной. Например:

$n = 3
log &arg("aa ! bb : cc . dd",$n)

&nick (<строка>): Экранирует все метасимволы regexp и некоторые специальные символы perl с помощью \ (обратного слэша). Придуман специально для экранирования некоторых имён персонажей. Например, ник "}|{oJIA" будет преобразован в "\}|\{oJIA"

&split (<разделитель>, <переменная>): Создаёт массив из <переменной> на основе <разделителя>. Вывод этой функции обязательно должен присваиваться массиву. Например:

macro split {
  $list = a~b~c
  log переменная: $list
  @array = &split('~', $list)
  log размер массива: @array, array[1]=$array[1]
}

&keys (<%хэш>): Создаёт массив из ключей <хэша>. Вывод этой функции обязательно должен присваиваться массиву. Например:

macro split {
  %hash = (a => "foo", b => "bar")
  log размер хэша: %hash
  @array = &keys (%hash)
  log размер массива: @array, array[1]=$array[1]
}

&values (<%хэш>): Создаёт массив из ключей <хэша>. Вывод этой функции обязательно должен присваиваться массиву.

&listlength (<список_разделённый_запятой>): Вернёт количество элементов в списке разделённом запятой, например:

macro listlength {
   log количество элементов: &listlength(a, b, c)
}

&strip (<текст>): Удаляет из <текста> круглые скобки ( ), например:

macro strip {
   $text = (привет))))) мир)
   log текст без скобок: "&strip($text)"
}

Цепочка команд

Несколько команд выполняются друг за другом без задержки, если они объединены в цепочку команд квадратными скобками [ и ].

0 macro foo {
1  do whatever
2  log yet another line
3  [
4     do something
5     do something else
6     log foo
7  ]
8  log done
9 }

Строка 3 начинает цепочку команд и сама по себе не вносит никакой задержки. Строки 4, 5 и 6 выполняются сразу же, как только предыдущая команда завершится. В цепочке команд нет задержек и выполнение команд не может быть прервано. Строка 7 завершает цепочку команд и строка 8 будет выполнятся через положенную задерку в $macro_delay секунд.

Подстроки

Вместо использования по одной команде на строку, можно отделять команды между собой символом точки с запятой ";" и располагать их в одной строке.

macro foo {
    $i = 1; pause 5; log \$i = $i; $ii = 2; $iii = 3; $i++; $ii--; lock automacroName; release automacroName; set overrideAI 1
}

Разделенные точкой с запятой ";" команды будут выполняться с обычной задержной macro_delay.

Операторы сравнения

Плагин eventMacro предлагает следующие операторы сравнения:

Оператор	Описание
<	меньше
<=	меньше, либо равно
== или =	равенство, см. ~~(link)~~
>	больше
>=	больше, либо равно
!=	неравенство
~	<леваячасть> есть элемент <праваячасть>, где <праваячасть> список, разделенный символом запятой ","
=~	<леваячасть> подпадает под регулярное выражение - regexp из <праваячасть>. Подробнее: Forums
arg .. arg2	диапазон значений между arg и arg2, где arg число, процент или переменная.

Управление потоком и метки

Как и в большинстве языков программирования, в плагине eventMacro реализованы привычные конструции типа "if .. else", "while", "foreach", "for .. next", "do .. while" и некоторые другие.
Кроме того есть операции "if", "else", "elsif", "switch", "case", "goto" и "while". При помощи label можно ставить метки в коде.

Синтаксис условных операторов

If

Right now, macro if conditions are very close to the perl if statements. It accepts unlimited number of statements in just one if condition line, regexp matching is allowed (unfortunately, no backreference using parenthesis) and the use of && for and meaning and || for or meaning.

Можно использовать простое выражение, которое проверяет одно условие:

if (arg1 <Operators> arg2) (goto <label> | call <macro> [<parameters>] | stop | { )

Проверка двух условий, объединённых оператором или, хотя бы одно условие должно быть истинным:

if (arg1 <Operators> arg2 || arg3 <Operators> arg4) (goto <label> | call <macro> <parameters> | stop | { )

Проверка двух условий, объединённых оператором и, оба условия должны быть истинными:

if (arg1 <Operators> arg2 && arg3 <Operators> arg4) (goto <label> | call <macro> <parameters> | stop | { )

Примеры использования обоих операторов:

if ((arg1 <Operators> arg2 || arg3 <Operators> arg4) && arg5 <Operators> arg6) (goto <label> | call <macro> <parameters> | stop | { )
if ((arg1 <Operators> arg2 && arg3 <Operators> arg4) || arg5 <Operators> arg6) (goto <label> | call <macro> <parameters> | stop | { )
if ((arg1 <Operators> arg2 && arg3 <Operators> arg4) || (arg5 <Operators> arg6 && arg7 <Operators> arg8)) (goto <label> | call <macro> <parameters> | stop | { )
if ((arg1 <Operators> arg2 || arg3 <Operators> arg4) && (arg5 <condition> arg6 || arg7 <condition> arg8)) (goto <label> | call <macro> <parameters> | stop | { )

Notice inside of each brackets containing the AND and OR symbols.

причём

arg может быть переменной, a nested variable, a special keyword, &eval, текстом или числом или даже Perl Subroutines функцией.
<label>, название метки в коде, может быть только из букв и цифр.
<macro>, название макроса
<parameters> параметры макроса, внутри макроса можно к ним обратиться как $.param[0], $param[1] и т.д.
< { >, начало блока команд, которые запустятся, если условие истинно. Блок команд закрывается соответствующей фигурной скобкой }.

Примечание: Внутри скобок можно использовать неограниченное количество сравнений.

if (arg1 <Operators> arg2 || arg3 <Operators> arg4 || ... || argN <Operators> argN+1) (goto <label> | call <macro> <parameters> | stop)

Where;

arg can be a variable, a nested variable, a special keyword, &eval or letters and numbers.
All the conditions is up to the Nth argument <Operators> N+1th argument.
While N is an integer number/s which is greater than zero.

Постфиксный if

Кроме того, можно использовать if после команды.

<command> if (arg1 <Operators> arg2)

Т.е. команда перед if запустится только тогда, когда условие истинно. Условие пишется по точно таким же правилам, как было сказано выше.

В следующем примере обе команды равнозначны и делают одно и то же:

call buy if ($.zeny > 1000)
if ($.zeny > 1000) call buy

Else

В случае, если if использовался с фигурными скобками ( { ), то можно использовать else после закрывающей фигурной скобки ( } ).

if (arg1 <Operators> arg2) {
   command1
   command2
   ...
   commandN
} else {
   command3
   command4
   ...
   commandN
}

В этом случае если условие в круглых скобках истинно, то выполнятся только команды 1 и 2, если условие ложное, то выполнятся только команды 3 и 4.

Примечание: в фигурных скобках можно использовать неограниченное количество команд.
Примечание: ветка else - не обязательна.

Elsif

Этот оператор работает как else + if одновременно. Оператор elsif нужен для проверки следующего условия. Оператор else срабатывает, когда ни одно условие не выполнилось.

if (arg1 <Operators> arg2) {
   command1
   command2
   ...
   comandoN
} elsif (arg1 <Operators> arg2) {
   command3
   command4
   ...
   commandN
} else {
   command5
   command6
   ...
   commandN
}

В этом случае если первое условие истинно, то будут выполнены только команды 1 и 2, если оно ложное, то далее идёт проверка второго условия. Если второе условие истинно, то будут выполнены только команды 3 и 4. Если оба условия ложные, то будут выполнены только команды 5 и 6.

Примечание: ветки elsif и else - не обязательны.

Switch/case

Этот оператор напоминает if с кучей последующих elseif. Данный оператор будет полезным, когда необходимо проверить одну переменную на разные условия.

switch (arg1) {
    case (<Operators> arg2) (goto <label> | call <macro> <parameters> | stop | {)
        (Если вы используете "{", то команды для выполнения должна находиться здесь. Каждая команда должна быть написана в новой строчке. В конце обязательно должна быть закрывающая скобка "}")
    case (<Operators> arg2) (goto <label> | call <macro> <parameters> | stop | {)
        (Если вы используете "{", то команды для выполнения должна находиться здесь. Каждая команда должна быть написана в новой строчке. В конце обязательно должна быть закрывающая скобка "}")
    ...
    else (goto <label> | call <macro> <parameters> | stop | {)
        (Если вы используете "{", то команды для выполнения должна находиться здесь. Каждая команда должна быть написана в новой строчке. В конце обязательно должна быть закрывающая скобка "}")
}

Примечание: если не сработал ни один case, тогда отработает else.
Примечание: использовать else не обязательно.

Примеры с условными операторами

Этот макрос двигает персонажа в случайном направлении: на север, юг, восток или запад.

macro walk {
   $num = &rand(1, 4)
   if ($num == 1) {
       do c я пойду в сторону 1 (на север)
       do north
   }
   if ($num == 2) {
       do c я пойду в сторону 2 (на юг)
       do south
   }
   if ($num == 3) {
       do c я пойду в сторону 3 (на восток)
       do east
   }
   if ($num == 4) {
       do c я пойду в сторону 4 (на запад)
       do west
   }
}

Давайте перепишем этот макрос с постфиксным if:

macro walk {
   $num = &rand(1, 4)
   do c я пойду в сторону $num
   do north if ($num == 1)
   do south if ($num == 2)
   do east  if ($num == 3)
   do west  if ($num == 4)
}

Следующий макрос использует конструкцию if/else, чтобы определить, есть ли у персонажа больше 1000 зени или нет.

macro checkZeny {
   if ($.zeny > 1000) {
      do c У меня больше 1.000z! 
   } else {
      do c у меня 1.000z или меньше...
   }
}

Чуть усложнённый пример, чтобы узнать сколько зени в кармане: больше тысячи, ровно тысяча или меньше. В зависимости от этого выдаются разные смайлики.

macro checkZeny {
   if ($.zeny > 1000) {
      do c у меня больше 1.000z! 
      do e money
   } elsif ($.zeny == 1000) {
      do c у меня ровно 1.000z.
      do e !
   } else {
      do c у меня меньше 1.000z
      do e panic
   }
}

Переработаем предыдущий макрос, с использованием switch/case:

macro checkZeny {
    switch ($.zeny) {
        case (> 1000) {
            do c у меня больше 1.000z! 
            do e money
        }
        case (== 1000) {
            do c у меня ровно 1.000z.
            do e !
        }
        else {
            do c у меня меньше 1.000z
            do e panic
        }
    }
}

Следующий макрос показывает использование if вместе с goto:

macro checknum {
    $num = &rand(1, 3)
    if ($num == 1) goto one
    if ($num == 2) goto two
    if ($num == 3) goto three
    :one
    log \$num = 1
    stop
    :two
    log \$num = 2
    stop
    :three
    log \$num = 3
}

Переработаем предыдущий макрос, с использованием call вместо goto.

macro checknum {
    $num = &rand(1, 3)
    if ($num == 1) call one
    if ($num == 2) call two
    if ($num == 3) call three
}
macro one {
    log $num = 1
}
macro two {
    log $num = 2
}
macro three {
    log $num = 3
}

Сложный макрос, где переменная $i, равная 1, подвергается изощрённым проверкам и так и сяк.

macro if {
 $i = 1
 log \$i = $i
 if (((($i = 1 || $i < 5 || $i ~ 0 .. 5) && &eval(&eval($i - 1) - &eval($i - 0)) = -1) && ($i != 2 && $i > 0 && &eval($i - 1) = 0) && ($i != 2 && $i > 0 && &eval($i - 1) = 0)) && $i = 1) goto somewhere
 if (($i = 1 || $i < 5 || $i ~ 0 .. 5) && ($i != "" && $i > 0 && &eval($i - 1) = 0)) goto somewhere
 if (&eval (&eval($i-1) - 1) != "") goto somewhere
 if ((($i = 1) || ($i < 5 && $i ~ 0 .. 5)) && ($i != "" && $i > 0 && &eval($i - 1) > 0)) goto somewhere
 log ko
 stop
:somewhere
 log OK
}

Цикл while

Цикл по условию while запускает команды раз за разом до тех пор, пока условие не перестанет быть истинным.

Синктаксис

while (arg <condition> arg) {
    do bla bla
    ...
}

причём

arg - может переменной, вложенной переменной, ключевым словом, &eval, числом или строкой.

Операторы сравнения смотри тут: Operators.

Пример

Пробежим цикл десять раз, от $i равного 0 до 9.

macro while {
    $i = 0
    while ($i < 10) {
    log \$i = $i
    $i++
    }
}

Вывод на консоль:

[eventmacro log] \$i = 0
[eventmacro log] \$i = 1
[eventmacro log] \$i = 2
[eventmacro log] \$i = 3
[eventmacro log] \$i = 4
[eventmacro log] \$i = 5
[eventmacro log] \$i = 6
[eventmacro log] \$i = 7
[eventmacro log] \$i = 8
[eventmacro log] \$i = 9

Автомакросы

На данный момент вы научились объявлять макросы и вызывать их, набирая в консоли OpenKore 'eventMacro <macro name>'.

Автомакрос нужен для того, чтобы автоматически запускать макрос при срабатывании некоторых условий.

Автомакрос состоит из:

одного или нескольких параметров (параметр call среди них единственный обязательный).
одного или нескольких условий.

Автомакрос не сработает, если в данный момент исполняется макрос в т.н. эксклюзивном режиме. В любом другом случае очередь макросов очищается (другими словами, всё останавливается) и уже тогда запускается нужный макрос.

Ещё раз - мы используем автомакрос для проверки неких условий, если они выполняются, то автомакрос срабатывает и запускает указанный макрос.

Параметры

Каждый параметр упоминается не больше одного раза.
Параметры определяют, каким образом будет работать автомакрос или вызванный им макрос.
У большинства параметров есть значение по умолчанию.

call

call - это единственный обязательный параметр в каждом автомакросе.
call определяет, какой макрос будет запущен.
call может быть названием макроса или блоком команд.

Пример с использованием названия макроса:

automacro <название автомакроса> {
    <тут только условия и параметры автомакроса>
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    # например:
    do move prontera
    do move payon
}

Пример с использованием блока команд:

automacro <название автомакроса> {
    <тут только условия и параметры автомакроса>
    call {
        <тут обычные инструкции макроса>
        # например:
        do move prontera
        do move payon
    }
}

Оба примера выше равнозначны и делают то же самое.
Обратите внимание, что блок команд в параметре call подчиняется тем же правилам что и обычный macro-блок.

Синтаксис первого автомакроса удобен, когда у вас есть несколько автомакросов, которые могут вызывать один и тот же макрос:

automacro First {
    <одни условия> 
    call print
}
automacro Second {
    <другие условия> 
    call print
}
macro print {
    log $.caller triggered
}

delay

delay - необязательный параметр.
delay определяет время в секундах, которое пройдёт перед тем, как запустится макрос из параметра call.
Значение по умолчанию: 0.
Значением параметра может быть только число.

automacro <название автомакроса> {
    <тут только условия и параметры автомакроса>
    delay 5
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Текст будет напечатан через 5 секунд, после того, как сработает автомакрос.
}

run-once

run-once - необязательный параметр.
run-once определяет, сколько раз может сработать автомакрос - только один раз или неограниченное количество раз.
Значение по умолчанию: 0.
Если 1 , то автомакрос сработает лишь однажды, если 0, то может сработать много раз.
Чтобы уже сработавшему автомакросу с run-once 1 разрешить сработать ещё раз, можно использовать команду 'release' Macro Syntax.

automacro myautomacro {
    <тут только условия и параметры автомакроса>
    run-once 1
    call myMacro
}
automacro myaotherauto {
    <тут только условия и параметры автомакроса>
    run-once 0
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Данный макрос может быть вызван из myautomacro только один раз,
    log но из myaotherauto он может быть вызван много раз.
}

CheckOnAI

CheckOnAI - необязательный параметр.
CheckOnAI определяет, в каком режиме AI может сработать автомакрос.
Значение по умолчанию можно установить в параметре конфига eventMacro_CheckOnAI Configuration files.
Если не указать данный параметр в автомакросе, то будет использовано значение по умолчанию, которое берётся из параметра конфига eventMacro_CheckOnAI.
Если в конфиге не прописано значение по умолчанию eventMacro_CheckOnAI, то используется: auto
Значение параметра - список через запятую следующих слов: auto, manual и off.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    CheckOnAI manual
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Автомакрос MyAuto сработает только в ручном режиме бота (manual)
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    CheckOnAI manual, off
    call myMacro
}
macro myMacro2 {
    <тут обычные инструкции макроса>
    log Автомакрос MyAuto2 сработает в режимах manual или off.
}

disabled

disabled - необязательный параметр.
disabled определяет, активен ли автомакрос.
Значение по умолчанию: 0.
Если 1, то автомакрос не активен и не сможет сработать. Если 0, то сработает при наступлении условий.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    disabled 1
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Автомакрос MyAuto никогда не сработает, он выключен.
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    disabled 0
    call myMacro
}
macro myMacro2 {
    <тут обычные инструкции макроса>
    log Автомакрос MyAuto2 сработает как положено при наступлении условий.
}

overrideAI

overrideAI - необязательный параметр.
overrideAI определяет, занесёт ли плагин eventMacro макро-команды в очередь задач AI.
Значение по умолчанию: 0.
Если 0, то команды макроса попадают в очередь задач AI как 'eventMacro' и каждая команда сработает только тогда, когда до неё дойдёт очередь, т.е. AI переключится на задачу 'eventMacro'.
Если 1, то команды макроса не попадут в очередь задач AI и не будут управляться ею. Команды тупо выполняются одна за другой с интервалом macro_delay.
It's important to note that when it's value is 1 since it won't be put into AI queue normal AI functions will continue as normal, like mob hunting or autostorage.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    overrideAI 0
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    do move prontera
    log До этой строки макроса дело дойдёт только тогда, когда бот дойдёт до Пронтеры, т.е. довольно длительная команда 'move prontera' выполнится. Ибо в списке задач AI команда 'move' стоит первая в очереди.
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    overrideAI 1
    call myMacro
}
macro myMacro2 {
    <тут обычные инструкции макроса>
    do move prontera
    log До этой строки макроса дело дойдёт практически сразу, через короткий промежуток macro_delay, потому что оно работает без оглядки на очередь команд AI.
}

exclusive

exclusive - необязательный параметр.
exclusive определяет, может ли исполнение макроса быть прервано.
Значение по умолчанию: 0.
Если 0, то исполнение макроса может быть прервано другим автомакросом.
Если 1, то исполнение макроса невозможно прервать другим автомакросом.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    exclusive 0
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Исполнение макроса может быть прервано в любой момент, что может привести к ошибке.
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    exclusive 1
    call myMacro
}
macro myMacro2 {
    <тут обычные инструкции макроса>
    log Так как exclusive равен 1, то макрос нельзя прервать и он отработает полностью.
}

priority

priority - необязательный параметр.
priority определяет очерёдность срабатывания автомакросов. Чем меньше номер, тем раньше до него дойдёт очередь.
Значение по умолчанию: 0.
Значение должно быть числом.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    priority 5
    call {
        log Этот автомакрос стоит в очереди после MyAuto2, потому он и сработает позже.
    }
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    priority 2
    call {
        log Этот автомакрос сработает раньше MyAuto, потому что он первый в очереди.
    }
}

macro_delay

macro_delay - необязательный параметр.
macro_delay определяет паузу между выполнениями команд в макросе, измеряется в секундах.
Значение по умолчанию: 1.
Значение должно быть числом.

automacro MyAuto {
    <тут только условия и параметры автомакроса>
    macro_delay 2
    call {
        log Этот текст выведется при запуске макроса.
        log А этот текст напечатается через две секунды.
    }
}

automacro MyAuto2 {
    <тут только условия и параметры автомакроса>
    macro_delay 5
    call {
        log Этот текст выведется при запуске макроса.
        log А этот текст напечатается через пять секунд.
    }
}

orphan

orphan - необязательный параметр.
orphan определяет, что будет делать плагин eventMacro делать с макросами в том случае, когда плагин уберут из очереди задач AI.
Значение по умолчанию можно настроить в параметре конфига eventMacro_orphans Configuration files.
Если параметр не указан в автомакросе, то тогда будет использовано значение из параметра конфига eventMacro_orphans.
Если и в конфиге не указан параметр eventMacro_orphans, тогда используется значение: terminate
Возможные значения параметра:

Значение	Описание
terminate	прервать, остановить работу макроса (равнозначно команде eventMacro stop)
terminate_last_call	прервать только последний вызванный макрос. Таким образом, если макрос 'mac1' вызвал 'mac2', который в свою очередь вызвал 'mac3', то только 'mac3' будет прерван, а вызвавший его макрос 'mac2' продолжит работу.
reregister	заново регистрирует макросы в очередь задач AI, затирая другие записи. Таким образом брошенный макрос сможет сразу же продолжить работу.
reregister_safe	заново регистрирует макросы в очередь задач AI, когда она пустеет и AI нечего делать. Это означает, что макрос продолжит работать только после завершения всех остальных задач.

repeat

repeat - необязательный параметр.
repeat определяет сколько раз подряд будет запущен макрос.
Значение по умолчанию: 1.
Значение должно быть числом.

automacro <automacro name> {
    <тут только условия и параметры автомакроса>
    repeat 3
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Это сообщение будет напечатано трижды, потому что макрос будет вызван три раза.
}

timeout

timeout - необязательный параметр.
timeout - определяет, через какое время этот автомакрос может сработать снова.
Значение по умолчанию: 0.
Значение должно быть числом.

automacro <automacro name> {
    <тут только условия и параметры автомакроса>
    timeout 60
    call myMacro
}
macro myMacro {
    <тут обычные инструкции макроса>
    log Этот макрос будет вызываться не чаще одного раза в минуту.
}

Условия

Условия делятся на две категории: состояние и событие.
Большинство условий присваивают некие значения специальным переменным, когда автомакрос срабатывает.
В большинстве условий можно использовать переменные.
Каждый автомакрос может срабатывать только на одно событие.
Большинство условий состояния может быть использовано более одного раза в автомакросе.
Для каждого условие далее следует подробное описание.
Плагин eventMacro устроен так, что для каждого условия есть свой модуль - файл pm. Все файлы в папке eventMacro/Condition - это условия автомакросов.

Состояние

Условные выражения состояний возвращают true или false.
Автомакрос сработает только если все ого условия состояний будут true.

BaseLevel

Описание: Проверяет базовый уровень персонажа.
Не поддерживает проценты прогресса.

Синтаксис:

BaseLevel <Math condition operators>

Пример:

BaseLevel >= 30

Устанавливает значение переменной:

$.BaseLevelLast => в переменную записывается базовый уровень, при котором условное выражение стало true

JobLevel

Описание: Проверяет профессиональный уровень персонажа.
Не поддерживает проценты прогресса.

Синтаксис:

JobLevel <Math condition operators>

Пример:

JobLevel = 70

Устанавливает значение переменной:

$.JobLevelLast => в переменную записывается профессиональный уровень, при котором выражение стало true

CartCurrentWeight

Описание: Смотрит вес предметов в телеге.
Может работать с процентами.

Синтаксис:

CartCurrentWeight <Math condition operators>

Примеры:

CartCurrentWeight > 80%
CartCurrentWeight > 4000

Устанавливает значения переменных:

$.CartCurrentWeightLast => запоминает вес предметов в телеге, при котором выполнилось условие
$.CartCurrentWeightLastPercent => запоминает вес предметов в телеге в процентах от максимального, при котором выполнилось условие

CartMaxWeight

Описание: Проверяет вместимость телеги, т.е. максимальный вес предметов в телеге.
Не работает с процентами.

Синтаксис:

CartMaxWeight <Math condition operators>

Пример:

CartMaxWeight > 4000

Устанавливает значение переменной:

$.CartMaxWeightLast => запоминает вместимость телеги на момент срабатывания условия

CartCurrentSize

Описание: Проверяет количество предметов в телеге.
Может работать с процентами.

Синтаксис:

CartCurrentSize <Math condition operators>

Примеры:

CartCurrentSize > 80%
CartCurrentSize > 4000

Устанавливает значение переменных:

$.CartCurrentSizeLast => запоминает количество предметов в телеге на момент срабатывания условия
$.CartCurrentSizeLastPercent => запоминает количество предметов в телеге в процентах от максимального на момент срабатывания условия

CartMaxSize

Описание: Проверить вместимость телеги в предметах.
Не работает с процентами.

Синтаксис:

CartMaxSize <Math condition operators>

Пример:

CartMaxSize > 4000

Устанавливает значение переменной:

$.CartMaxSizeLast => запоминает максимальную вместимость телеги на момент срабатывания условия

CharCurrentWeight

Описание: проверяет текущий вес инвентаря у персонажа.
Может работать с процентами.

Синтаксис:

CharCurrentWeight <Math condition operators>

Примеры:

CharCurrentWeight > 80%
CharCurrentWeight > 4000

Устанавливает значения переменных:

$.CharCurrentWeightLast => запоминает вес инвентаря персонажа на момент срабатывания условия
$.CharCurrentWeightLastPercent => запоминает вес инвентаря персонажа в процентах от максимальной загрузки на момент срабатывания условия

CharMaxWeight

Описание: проверяет максимально переносимый груз в инвентаре персонажа.
Не работает с процентами.

Синтаксис:

CharMaxWeight <Math condition operators>

Пример:

CharMaxWeight > 4000

Устанавливает значение переменной:

$.CharMaxWeightLast => запоминает максимально переносимый груз в инвентаре персонажа на момент срабатывания условия

FreeStatPoints

Описание: проверяет нераспределённые стат-поинты.
Не работает с процентами.

Синтаксис:

FreeStatPoints <Math condition operators>

Пример:

FreeStatPoints > 20

Устанавливает значение переменной:

$.FreeStatPointsLast => запоминает количество свободных стат-поинтов на момент срабатывания условия

FreeSkillPoints

Описание: проверяет количество свободных очков умений.
Не работает с процентами.

Синтаксис:

FreeSkillPoints <Math condition operators>

Пример:

FreeSkillPoints > 20

Устанавливает значение переменной:

$.FreeSkillPointsLast => запоминает количество свободных очков умений на момент срабатывания условия

CurrentHP

Описание: проверяет количество очков жизни (т.е. hp) у персонажа.
Может работать с процентами.

Синтаксис:

CurrentHP <Math condition operators>

Примеры:

CurrentHP > 80%
CurrentHP > 4000

Устанавливает значение переменных:

$.CurrentHPLast => запоминает, сколько было здоровья у персонажа на момент проверки условия
$.CurrentHPLastPercent => то же самое, но в процентах

MaxHP

Описание: проверяет, какое максимальное количество hp может быть у персонажа.
Не работает с процентами.

Синтаксис:

MaxHP <Math condition operators>

Пример:

MaxHP > 4000

Устанавливает значение переменной:

$.MaxHPLast => запоминает, какое максимальное количество hp могло быть у персонажа на момент проверки условия

CurrentSP

Описание: запоминает текущее значение sp у персонажа.
Работает с процентами.

Синтаксис:

CurrentSP <Math condition operators>

Пример:

CurrentSP > 80%
CurrentSP > 4000

Устанавливает значение переменной:

$.CurrentSPLast => запоминает текущее значение sp на момент проверки условия
$.CurrentSPLastPercent => то же самое, в процентах

MaxSP

Описание: проверяет максимально возможное количество sp у персонажа.
Не работает с процентами.

Синтаксис:

MaxSP <Math condition operators>

Пример:

MaxSP > 4000

Устанавливает значение переменной:

$.MaxSPLast => запоминает максимально возможное количество sp у персонажа на момент проверки условия

InInventory

Описание: по названию предмета проверяет его количество у персонажа в инвентаре.
Не работает с процентами.

Синтаксис:

InInventory "<название предмета>" <Math condition operators>

Обратите внимание на кавычки, это важно.

Пример:

InInventory "Red Potion" < 10

Устанавливает значение переменной:

$.InInventoryLast => запоминает название проверяемого предмета
$.InInventoryLastAmount => запоминает количество предметов

InInventoryID

Описание: по идентификатору предмета проверяет его количество у персонажа в инвентаре.
Не работает с процентами.

Синтаксис:

InInventoryID <идентификатор предмета> <Math condition operators>

Пример:

InInventoryID 501 < 10

Устанавливает значение переменной:

$.InInventoryIDLast => запоминает идентификатор предмета
$.InInventoryIDLastAmount => запоминает количество предмета на момент срабатывания условия

InStorage

Описание: по названию предмета проверяет его количество на складе.
Не работает с процентами.

Синтаксис:

InStorage "<название предмета>" <Math condition operators>

Обратите внимание на кавычки.

Пример:

InStorage "Blue Potion" > 100

Устанавливает значение переменной:

$.InStorageLast => запоминает название предмета
$.InStorageLastAmount => запоминает количество на момент срабатывания условия

InStorageID

Описание: по идентификатору предмета проверят его количество на складе.
Не работает с процентами.

Синтаксис:

InStorageID <item ID> <Math condition operators>

Пример:

InStorageID 507 100..500

Устанавливает значение переменной:

$.InStorageIDLast => запоминает идентификатор предмета
$.InStorageIDLastAmount => запоминает количество предметов на складе на момент срабатывания условия

InCart

Описание: по названию предмета смотрит его количество в телеге.
Не работает с процентами.

Синтаксис:

InCart "название предмета" <Math condition operators>

Обратите внимание на кавычки.

Пример:

InCart "Blue Potion" > 100

Устанавливает значение переменной:

$.InCartLast => запоминает название предмета
$.InCartLastAmount => запоминает количество на момент срабатывания условия

InCartID

Описание: по идентификатору предмета смотрит его количество в телеге.
Не работает с процентами.

Синтаксис:

InCartID <идентификатор предмета> <Math condition operators>

Пример:

InCartID 507 100..500

Устанавливает значение переменной:

$.InCartIDLast => запоминает идентификатор предмета
$.InCartIDLastAmount => запоминает количество в телеге на момент срабатывания условия

InventoryCurrentSize

Описание: проверяет текущее количество предметов в инвентаре (ячейки).
Работает с процентами. (но смысла в этом особого нет ибо места в инвентаре как раз на 100 предметов)

Синтаксис:

InventoryCurrentSize <Math condition operators>

Пример:

InventoryCurrentSize > 70%
InventoryCurrentSize > 30

Устанавливает значение переменной:

$.InventoryCurrentSizeLast => запоминает количество занятых ячеек в инвентаре персонажа на момент срабатывания условия

SkillLevel

Описание: по идентификатору умения или по константе проверяет, насколько умение прокачано.
Не работает с процентами.

Синтаксис:

SkillLevel <идентификатор умения или константа> <Math condition operators>

Пример:

SkillLevel NV_FIRSTAID = 0
SkillLevel 10 > 5

Устанавливает значение переменной:

$.SkillLevelLastName => запоминает название умения
$.SkillLevelLastID => запоминает идентификатор умения
$.SkillLevelLastHandle => запоминает константу
$.SkillLevelLastLevel => собственно запоминает уровень, на который было прокачано умение на момент срабатывания условия

Zeny

Описание: проверяет, сколько у персонажа зени.
Не работает с процентами.

Синтаксис:

Zeny <Math condition operators>

Пример:

Zeny > 500000

Устанавливает значение переменной:

$.ZenyLast => запоминает количество зени на момент срабатывания условия

StorageOpened

Описание: истина, если 1 и персонаж открыл склад. Также истина, если 0 и склад закрыт. Смотря что хотим проверить.

Синтаксис:

StorageOpened <1|0>

Пример:

StorageOpened 1

ShopOpened

Описание: истина, если 1 и персонаж открыл свою торговую лавку. Также истина, если 0 и торговая лавка не открыта. Смотря что хотим проверить.

Синтаксис:

ShopOpened <1|0>

Пример:

ShopOpened 1

InChatRoom

Описание: истина, если 1 и персонаж находится в чат-комнате. Также истина, если 0 и персонаж не находится в чат-комнате.

Синтаксис:

InChatRoom <1|0>

Пример:

InChatRoom 0

ChatRoomNear

Описание: по регулярному выражению проверяет, есть ли рядом подходящая чат-комната.

Примечание переводчика: Тут не хватает синтаксиса, примера и описания переменных для ChatRoomNear.

Примечание переводчика: Тут не хватает описания про NpcNear.

Синтаксис:

NpcNear <Regex>

Пример:

NpcNear /kafra/
NpcNear /special agent/

Устанавливает значение переменной:

$.ChatRoomNearLastID => Saves the ID of the last chat room that made ChatRoomNear become true
$.ChatRoomNearLastOwnerID => Saves the ID of the owner of the last chat room that made ChatRoomNear become true
$.ChatRoomNearLastOwnerName => Saves the name of the owner of the last chat room that made ChatRoomNear become true
$.ChatRoomNearLastTitle => Saves the title of the last chat room that made ChatRoomNear become true

InMap

Описание: проверяет, находится ли персонаж на одной из перечисленных локаций.

Синтаксис:

InMap <список локаций>

Название локации может быть переменной.

Пример:

InMap prontra, geffen, gef_fild10

Устанавливает значение переменной:

$.InMapLast => запоминает локацию, которая вызвала срабатывание условия

InLockMap

Описание: истина, если 1 и персонаж находится на локмапе. Также истина, если 0 и персонаж не на локмапе.

Синтаксис:

InLockMap <1|0>

Пример:

InLockMap 1

InSaveMap

Описание: истина, если 1 и персонаж находится на локации, где у него точка сохранения. Также истина, если 0 и персонаж не находится на локации с его точкой сохранения.

Синтаксис:

InSaveMap <1|0>

Пример:

InSaveMap 0

IsInCoordinate

Описание: проверяет, находится ли персонаж по указанным координатам.

Синтаксис:

IsInCoordinate <разделённый запятыми список пар координат x и y>

Кроме точных координат понимает также диапазоны. (типа 100..200 вместо координаты x и 50..100 вместо координаты y)

Пример:

IsInCoordinate 100 150
IsInCoordinate 120 100, 115 289, 158 236
IsInCoordinate 20..80 200, 50 60, 80 90..150, 100..200 150..200
IsInCoordinate 30..35 40..45

Устанавливает значение переменной:

$.IsInCoordinateLast => запоминает координаты, при которых сработало условие
$.IsInCoordinateLastMemberIndex => запоминает номер в списке, к которому подошли координаты персонажа

IsInMapAndCoordinate

Описание: проверяет, находится ли персонаж по заданным координатам.

Синтаксис:

IsInMapAndCoordinate <список локаций и координат>

Можно использовать диапазоны чисел, например 100..200 50..100

Можно проверять только по названию локации, только по координатам или всё вместе - локацию с координатами

Пример:

IsInMapAndCoordinate 100 150
IsInMapAndCoordinate prontera
IsInMapAndCoordinate prontra, geffen, gef_fild10
IsInMapAndCoordinate 120 100, 115 289, 158 236
IsInMapAndCoordinate prontera, 100 200, gef_fild10 100..150 250
IsInMapAndCoordinate gef_fild10 20..80 200, payon 50 60

Устанавливает значение переменной:

$.IsInMapAndCoordinateLast => запоминает координаты, которые привели к срабатыванию условия
$.IsInMapAndCoordinateLastMemberIndex => запоминает номер элемента из списка локаций и координат, который привёл к срабатыванию условия

InPvP

Описание: проверяет локацию на заданный режим pvp.

Синтаксис:

InPvP <список режимов pvp>

Режимы: pvp, gvg и battleground.

Пример:

InPvP battleground, pvp

Устанавливает значение переменной:

$.InPvPLast => запоминает режим pvp, который привёл к срабатыванию условия

InCity

Описание: проверяет, находится ли персонаж в городе или нет.

Синтаксис:

InCity <0 | 1>

Если 0, то сработает не в городе

Если 1, то сработает в городу

Пример:

InCity 1

Устанавливает значение переменной:

$.InCityLast => запоминает название локации на которой условие сработало

InMapRegex

Описание: Соответствует ли название текущей локации заданному в regex шаблону.

Синтаксис:

InMapRegex <Regex>

Пример:

InMapRegex /field\d+$/
InMapRegex /^pay/

Устанавливает значение переменной:

$.InMapRegexLast => запоминает название локации, при котором условие InMapRegex стало true

NpcNear

Описание: Есть ли поблизости непись, имя которой подпадает под заданный regex-шаблон.

Синтаксис:

NpcNear <Regex>

Пример:

NpcNear /kafra/
NpcNear /special agent/

Устанавливает значение переменной:

$.NpcNearLast => запоминает имя неписи
$.NpcNearLastPos => запоминает местоположение неписи, можно использовать в дальнейшем для команды 'talknpc'
$.NpcNearLastBinId => запоминает индекс неписи в списке openkore, можно в дальнейшем использовать в команде 'talk'
$.NpcNearLastDist => запоминает дистанцию до обнаруженной неписи

NpcNearDist

Описание: Есть ли на определённом удалении непись, имя которой подпадает под заданный regex-шаблон.

Синтаксис:

NpcNearDist <Regex> <Math condition operators>

Пример:

NpcNearDist /kafra/ <= 4
NpcNearDist /special agent/ >= 5

Устанавливает значение переменной:

$.NpcNearDistLast => запоминает имя неписи
$.NpcNearDistLastPos => запоминает местоположение неписи, можно использовать в дальнейшем для команды 'talknpc'
$.NpcNearDistLastBinId => запоминает индекс неписи в списке openkore, можно в дальнейшем использовать в команде 'talk'
$.NpcNearDistLastDist => запоминает дистанцию до обнаруженной неписи

NpcNotNear

Описание: Проверяет, что поблизости нет неписи с заданным в regex именем.

Синтаксис:

NpcNotNear <Regex>

Пример:

NpcNotNear /kafra/
NpcNotNear /special agent/

Не создаёт никаких переменных

PlayerNear

Описание: Есть ли рядом игроки с заданным в regex именем.

Синтаксис:

PlayerNear <Regex>

Пример:

PlayerNear /john/
PlayerNear /henry the best TM/i

Устанавливает значение переменной:

$.PlayerNearLast => запоминает имя персонажа
$.PlayerNearLastPos => запоминает местоположение персонажа
$.PlayerNearLastBinId => запоминает номер игрока в списке openkore
$.PlayerNearLastDist => запоминает расстояние до игрока

PlayerNearDist

Описание: Есть ли на указанном расстоянии игроки с именем, совпадающим с regex-шаблоном.

Синтаксис:

PlayerNearDist <Regex> <Math condition operators>

Пример:

PlayerNearDist /bad gm/ < 10
PlayerNearDist /good guy healer/ <5

Устанавливает значение переменной:

$.PlayerNearDistLast => Запоминает имя игрока
$.PlayerNearDistLastPos => Запоминает местоположение игрока
$.PlayerNearDistLastBinId => Запоминает номер игрока в списке openkore
$.PlayerNearDistLastDist => Запоминает расстояние до игрока

PlayerNotNear

Описание: Удостоверяется, что рядом нет игрока с похожим на regex-шаблон именем.

Синтаксис:

PlayerNotNear <Regex>

Пример:

PlayerNotNear /the guy I need to see/
PlayerNotNear /^(john|george|paul|ringo)$/i

Не создаёт никаких переменных

MobNear

Описание: Проверяет, есть ли рядом моб с заданным в regex названием.

Синтаксис:

MobNear <Regex>

Пример:

MobNear /(edga|maya|ifrit|bad mvps)/i
MobNear /oring/

Устанавливает значение переменной:

$.MobNearLast => запоминает название моба
$.MobNearLastPos => хранит местоположение моба
$.MobNearLastBinId => запоминает номер моба в списке openkore
$.MobNearLastDist => расстояние до моба

MobNearDist

Описание: есть ли на заданном расстоянии моб с названием, подходящим под regex.

Синтаксис:

MobNearDist <Regex> <Math condition operators>

Пример:

MobNearDist /(Poporing|Drops|Poring|Marin)/ < 3

Устанавливает значение переменной:

$.MobNearDistLast => запоминает название найденного моба
$.MobNearDistLastPos => запоминает местоположение моба
$.MobNearDistLastBinId => номер моба в списке openkore
$.MobNearDistLastDist => расстояние до моба

MobNotNear

Описание: Удостоверяется, что рядом нет моба с заданным в regex названием.

Синтаксис:

MobNotNear <Regex>

Пример:

MobNotNear /mvp I am look for/
MobNotNear /edga/i

Не создаёт никаких переменных

JobID

Описание: Входит ли профессия персонажа в заданный список профессий. Профессии обозначаются числовым кодом. См. Job ID

Синтаксис:

JobID <job ID 1>, <job ID 2>, <job ID 3>, и т.д.

Пример:

JobID 6, 4053

Устанавливает значение переменной:

$.JobIDLast => запоминает идентификатор профессии персонажа

JobIDNot

Описание: Проверяет, что профессия персонажа не входит в заданный список. Профессия обозначается числовым кодом. См. Job ID

Синтаксис:

JobIDNot <job ID>

Пример:

JobIDNot 6

Устанавливает значение переменной:

$.JobIDNotLast => запоминает профессию персонажа

IsEquippedID

Описание: проверяет, одета та или иная экипировка в заданном слоте.

Синтаксис:

IsEquippedID <список пар значений место и идентификатор, разделяется запятой>

Пример:

IsEquippedID topHead 5055
IsEquippedID rightHand 13040, topHead 5055
IsEquippedID topHead 5055, leftHand 2112, robe 2510, shoes 2414, armor 2352, rightHand 1243

Устанавливает значение переменной:

$.IsEquippedIDLastID => запоминает идентификатор эквипа
$.IsEquippedIDLastName => запоминает название эквипа
$.IsEquippedIDLastSlot => запоминает слот, т.е. место экипировки
$.IsEquippedIDLastListIndex => запоминает индекс, номер позиции в списке, которая привела к срабатыванию условия

IsNotEquippedID

Описание: проверяет, что указанная экипировка не одета в заданный слот

Синтаксис:

IsNotEquippedID <список пар значений место и идентификатор, разделяется запятой>

Пример:

IsNotEquippedID topHead 5055
IsNotEquippedID rightHand 13040, topHead 5055
IsNotEquippedID topHead 5055, leftHand 2112, robe 2510, shoes 2414, armor 2352, rightHand 1243

Устанавливает значение переменной:

$.IsNotEquippedIDLastIsEmpty => запоминает, был ли слот пустой
$.IsNotEquippedIDLastSlot => запоминает слот, на котором сработало условие IsNotEquippedID

ConfigKey

Описание: проверяет несколько параметров конфига на то, что они соответствуют заданным значениям.

Синтаксис:

ConfigKey <список пар параметр конфига и его значение, разделённый запятыми>

И параметр конфига и тем более его значение может быть представлено переменными. Т.е. attackAuto $myattack или $vars{atk} 2, где $vars{atk} содержит название параметра конфига.

Пример:

ConfigKey attackAuto 2, itemsTakeAuto 2

Устанавливает значение переменной:

$.ConfigKeyLastKey => запоминает параметр конфига, при котором сработало условие
$.ConfigKeyLastValue => запоминает значение параметра
$.ConfigKeyLastMemberIndex => запоминает позицию из списка, которая привела к срабатыванию условия ConfigKey

ConfigKeyNot

Описание: проверяет, что хотя бы один параметр конфига из заданного списка не соответствует нужному значению.

Синтаксис:

ConfigKeyNot <список пар параметр конфига и его значение, разделённый запятыми>

И параметр конфига и тем более его значение может быть представлено переменными. Т.е. ConfigKeyNot attackAuto $myattack или ConfigKeyNot $vars{atk} 2, где $vars{atk} содержит название параметра конфига.

Пример:

ConfigKeyNot $vars{atk} 2
ConfigKeyNot itemsTakeAuto 1, attackAuto 2

Устанавливает значение переменной:

$.ConfigKeyNotLastKey => запоминает название параметра конфига, проверка которого привела к срабатыванию условия ConfigKeyNot
$.ConfigKeyNotLastWantedValue => хранит требуемое значение параметра конфига
$.ConfigKeyNotLastKeyValue => хранит текущее значение параметра конфига
$.ConfigKeyNotLastMemberIndex => запоминает номер позиции в списке, которая привела к срабатыванию условия

Примечание: Хорошо подходит для того, чтобы удостовериться, что параметры конфига настроены так, как вам надо. Например:

automacro ConfigWasWrong {
    exclusive 1
    timeout 10
    overrideAI 1
    ConfigKeyNot itemsTakeAuto 2, attackAuto 2
    call {
        log Обнаружен неправильно настроенный параметр конфига
        log Параметр: $.ConfigKeyNotLastKey
        log Требуемое значение: $.ConfigKeyNotLastWantedValue
        log Текущее значение: $.ConfigKeyNotLastKeyValue
        log Индекс в списке проверок: $.ConfigKeyNotLastMemberIndex
        log Автоматически выставляем подходящее значение для $.ConfigKeyNotLastKey. Меняем его с $.ConfigKeyNotLastKeyValue на $.ConfigKeyNotLastWantedValue
        do conf $.ConfigKeyNotLastKey $.ConfigKeyNotLastWantedValue
    }
}

Все перечисленные в условии ConfigKeyNot параметры конфига получат требуемые значения.

ConfigKeyNotExist

Описание: проверяет, что хотя бы один параметр из списка отсутствует в файле config.txt.

Синтаксис:

ConfigKeyNotExist <список параметров через запятую>

Может быть переменной

Пример:

ConfigKeyNotExist gameGuard, saveMap

Устанавливает значение переменной:

$.ConfigKeyNotExistLastKey => запоминает параметр конфига, которого нет в config.txt
$.ConfigKeyNotExistLastMemberIndex => запоминает номер из списка параметров, на котором сработало условие ConfigKeyNotExist

Примечание: Пригодится для добавления нестандартных параметров конфига, например от каких-нибудь плагинов. В нижеследующем примере среди прочего используется подпрограмма на perl для добавления отсутствующего параметра:

automacro AddgameGuardMissingKey {
    exclusive 1
    timeout 10
    overrideAI 1
    CheckOnAI auto, manual, off
    ConfigKeyNotExist gameGuard
    call {
        $wantedkey = $.ConfigKeyNotExistLastKey
        $wantedvalue = 1
        call AddMissingKey
    }
}

automacro AddcmdOnLoginMissingKey {
    exclusive 1
    timeout 10
    overrideAI 1
    CheckOnAI auto, manual, off
    ConfigKeyNotExist cmdOnLogin
    call {
        $wantedkey = $.ConfigKeyNotExistLastKey
        $wantedvalue = c \@autoloot
        call AddMissingKey
    }
}

macro AddMissingKey {
    log В файле config.txt нет одного важного параметра
    log Параметр называется $wantedkey
    log Его значение должно быть $wantedvalue
    log Добавим параметр $wantedkey равный $wantedvalue при помощи подпрограммы на perl - 'add_key'
    add_key("$wantedkey","$wantedvalue")
}

sub add_key {
    my ($key, $value) = @_;
    configModify($key, $value);
}

Данный макрос добавит параметры конфига для плагинов gameGuard и cmdOnLogin.

InProgressBar

Описание: Проверяет, ожидает ли игрок окончания какого-либо процесса.

Синтаксис:

InProgressBar <0 | 1>

Если 0, то сработает, если игрок не ждёт т.н. progress bar

Если 1, то сработает, если игрок в данный момент ожидает окончания некоего progress bar

Пример:

InProgressBar 1

Не создаёт переменных

StatusActiveHandle

Описание: Проверяет, наложен ли на игрока какой-нибудь статус из списка. Статусы задаются константами.

Синтаксис:

StatusActiveHandle <список статусов в виде констант>

Может быть переменной

Пример:

StatusActiveHandle EFST_INC_AGI, EFST_IMPOSITIO

Устанавливает значение переменной:

$.StatusActiveHandleLastName => запоминает название статуса
$.StatusActiveHandleLastHandle => запоминает константу, которая описывает статус
$.StatusActiveHandleLastListIndex => запоминает номер в списке статусов, который сработал в условии StatusActiveHandle

StatusInactiveHandle

Описание: Проверяет, что у игрока нет ни одного из перечисленных статусов. Для описания статуса используется специальная константа.

Синтаксис:

StatusInactiveHandle <список статусов в виде констант>

Может быть переменной

Пример:

StatusInactiveHandle EFST_BLESSING, EFST_CONCENTRATION

Устанавливает значение переменной:

$.StatusInactiveHandleLastName => запоминает название статуса
$.StatusInactiveHandleLastHandle => запоминает константу
$.StatusInactiveHandleLastListIndex => запоминает номер в списке статусов, который сработал в условии StatusInactiveHandle

QuestActive

Описание: Проверяет, активен ли у персонажа один из перечисленных квестов. В списке используются идентификаторы квестов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestActive <список идентификаторов квестов>

Идентификатор может быть представлен переменной

Пример:

QuestActive 7121, 7122

Устанавливает значение переменной:

$.QuestActiveLastID => запоминает идентификатор квеста
$.QuestActiveLastListIndex => запоминает позицию из списка квестов

QuestInactive

Описание: Проверяет неактивные квесты у персонажа. В списке используются идентификаторы квестов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestInactive <список идентификаторов квестов>

Идентификатор может быть представлен переменной

Пример:

QuestInactive 7121, 7122

Устанавливает значение переменной:

$.QuestInactiveLastID => запоминает идентификатор квеста
$.QuestInactiveLastListIndex => запоминает позицию из списка квестов

QuestOnTime

Описание: Проверяет, есть ли у персонажа заданный квест, для которого ещё тикает таймер. В списке используются идентификаторы квестов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestOnTime <список идентификаторов квестов>

Идентификатор может быть представлен переменной

Пример:

QuestOnTime 7121, 7122

Устанавливает значение переменной:

$.QuestOnTimeLastID => запоминает идентификатор квеста
$.QuestOnTimeLastListIndex => запоминает позицию из списка квестов

QuestTimeOverdue

Описание: Проверяет, есть ли у персонажа заданный квест, для которого таймер уже истёк. В списке используются идентификаторы квестов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestTimeOverdue <список идентификаторов квестов>

Идентификатор может быть представлен переменной

Пример:

QuestTimeOverdue 7121, 7122

Устанавливает значение переменной:

$.QuestTimeOverdueLastID => запоминает идентификатор квеста
$.QuestTimeOverdueLastListIndex => запоминает позицию из списка квестов

QuestHuntCompleted

Описание: Проверяет, есть ли среди перечисленных квестов на охоту за мобами какой-то завершенный. В списке используются идентификаторы квестов и идентификаторы мобов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestHuntCompleted <пары значений - идентификатор квеста и идентификатор моба>

Идентификаторы квестов и мобов могут быть представлены переменными

Пример:

QuestHuntCompleted 7122 1002, 7127 1004

Устанавливает значение переменной:

$.QuestHuntCompletedLastQuestID => идентификатор квеста
$.QuestHuntCompletedLastMobID => идентификатор моба
$.QuestHuntCompletedLastListIndex => запоминает позицию из списка, которая заставила сработать условие

QuestHuntOngoing

Описание: Проверяет незаконченные квесты на охоту за мобами. В списке используются идентификаторы квестов и идентификаторы мобов. Чтобы посмотреть, какой у квеста идентификатор, воспользуйтесь консольной командой 'quest list'.

Синтаксис:

QuestHuntOngoing <пары значений - идентификатор квеста и идентификатор моба>

Идентификаторы квестов и мобов могут быть представлены переменными

Пример:

QuestHuntOngoing 7122 1002, 7127 1004

Устанавливает значение переменной:

$.QuestHuntOngoingLastQuestID => идентификатор квеста
$.QuestHuntOngoingLastMobID => идентификатор моба
$.QuestHuntOngoingLastListIndex => запоминает позицию из списка, которая заставила сработать условие

NoPlayerNear

Описание: Проверяет, что поблизости нет никаких других игроков.

Синтаксис:

NoPlayerNear 1

Пример:

NoPlayerNear 1

Не порождает переменных.

NoPortalNear

Описание: Проверяет, что поблизости нет ни одного портала.

Синтаксис:

NoPortalNear 1

Пример:

NoPortalNear 1

Не использует переменные.

NoMobNear

Описание: Удостовериться, что рядом нет ни одного моба.

Синтаксис:

NoMobNear 1

Пример:

NoMobNear 1

Нет переменных.

NoNpcNear

Описание: Проверка на отсутствие рядом неписей.

Синтаксис:

NoNpcNear 1

Пример:

NoNpcNear 1

Не использует переменные.

PlayerNearCount

Описание: Сравнивает количество находящихся рядом игроков с заданным условием.

Синтаксис:

PlayerNearCount <Math condition operators>

Пример:

PlayerNearCount > 5

Устанавливает значение переменной:

$.PlayerNearCountLast => запоминает количество игроков рядом с персонажем

NpcNearCount

Описание: Сравнивает количество находящихся рядом неписей с заданным условием.

Синтаксис:

NpcNearCount <Math condition operators>

Пример:

NpcNearCount > 5

Устанавливает значение переменной:

$.NpcNearCountLast => запоминает количество находящихся рядом неписей

MobNearCount

Описание: Сравнивает количество находящихся рядом неписей с заданным условием.

Синтаксис:

MobNearCount <Math condition operators>

Пример:

MobNearCount > 10

Устанавливает значение переменной:

$.MobNearCountLast => запоминает количество мобов рядом с персонажем

PortalNearCount

Описание: Сравнивает количество находящихся рядом порталов с заданным условием.

Синтаксис:

PortalNearCount <Math condition operators>

Пример:

PortalNearCount > 5

Устанавливает значение переменной:

$.PortalNearCountLast => запоминает количество порталов рядом с персонажем

События

События не имеют значения true или false, они просто случаются.
Когда происходит некоторое событие, то соответствующее условие проверяется. Если информация в событии соответствует ожидаемой и все условия состояния выполняются (т.е. все их условия возвращают true), то автомакрос срабатывает.
Каждый автомакрос может реагировать только на одно событие.

PubMsg

Описание: условие проверяется при поступлении публичного сообщения, если сообщение подпадает под regex-шаблон, то условие возвращает true, т.е. автомакрос срабатывает.

Синтаксис:

PubMsg <Regex>

Пример:

PubMsg /(buff|bless)/

Устанавливает значение переменной:

$.PubMsgLastName => запоминает имя игрока, отправившего публичное сообщение
$.PubMsgLastMsg => запоминает сообщение

PubMsgDist

Описание: событие наступает при получении публичного сообщения, сообщение проверяется на соответствие regex-шаблону и расстояния до говорящего. Если проверка пройдена, то возвращается true и автомакрос срабатывает.

Синтаксис:

PubMsgDist <Regex> <Math condition operators>

Пример:

PubMsgDist /(buff|bless)/ < 5

Устанавливает значения переменных:

$.PubMsgDistLastName => запоминает имя игрока, публичное сообщение от которого привело к срабатыванию события PubMsgDist
$.PubMsgDistLastMsg => запоминает само публичное сообщение
$.PubMsgDistLastPos => запоминает координаты игрока
$.PubMsgDistLastDist => запоминает расстояние до игрока
$.PubMsgDistLastID => запоминает опенкоровский номер игрока

PubMsgName

Описание: событие наступает при получении публичного сообщения, сообщение проверятся на соответствие regex-шаблону, а также проверяется имя игрока (тоже regexp). Если проверка пройдена, то возвращается true и автомакрос срабатывает.

Синтаксис:

PubMsgName <Regex> <Regex>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PubMsgName /(buff|bless)/ /Player to buff/
PubMsgName /stop/ /GM/

Устанавливает значения переменных:

$.PubMsgNameLastName => Запоминает имя игрока, сообщение которого привело к срабатыванию события PubMsgName
$.PubMsgNameLastMsg => Запоминает само сообщение

PubMsgNameDist

Описание: событие наступает при получении публичного сообщения, проверяется текст сообщения, имя игрока и дистанция до него. Если текст и имя игрока отвечают заданным regex-шаблонам и расстояние до игрока тоже удовлетворяет заданному условнию, то возвращается true и автомакрос срабатывает.

Синтаксис:

PubMsgNameDist <Regex> <Regex> <Math condition operators>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PubMsgNameDist /(buff|bless)/ /Player to buff/ < 3
PubMsgNameDist /stop/ /GM/ >= 4

Устанавливает значения переменных:

$.PubMsgNameDistLastName => Запоминает игрока, сообщение которого привело к срабатыванию события PubMsgNameDist
$.PubMsgNameDistLastMsg => Запоминает само сообщение
$.PubMsgNameDistLastPos => Запоминает координаты игрока
$.PubMsgNameDistLastDist => Запоминает расстояние до игрока
$.PubMsgNameDistLastID => Запоминает опенкоровский номер игрока

PrivMsg

Описание: событие наступает при получении личного сообщения, если сообщение подпадает под regex-шаблон, то условие возвращает true, т.е. автомакрос срабатывает.

Синтаксис:

PrivMsg <Regex>

Пример:

PrivMsg /(buff|bless)/

Устанавливает значения переменных:

$.PrivMsgLastName => Запоминает имя игрока, сообщение которого привело к срабатыванию события PrivMsg
$.PrivMsgLastMsg => Запоминает само сообщение

PrivMsgDist

Описание: событие наступает при получении личного сообщения, оно проверяется regexp-шаблоном и на расстояние до игрока. Если условия выполняются, то автомакрос срабатывает.

Синтаксис:

PrivMsgDist <Regex> <Math condition operators>

Пример:

PrivMsgDist /(buff|bless)/ < 5

Устанавливает значения переменных:

$.PrivMsgDistLastName => Запоминает имя игрока, личное сообщение от которого привело к срабатыванию события PrivMsgDist
$.PrivMsgDistLastMsg => Запоминает само сообщение
$.PrivMsgDistLastPos => Запоминает координаты игрока
$.PrivMsgDistLastDist => Запоминает расстояние до игрока
$.PrivMsgDistLastID => Запоминает опенкоровский номер игрока

PrivMsgName

Описание: событие наступает при получении личного сообщения, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам.

Синтаксис:

PrivMsgName <Regex> <Regex>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PrivMsgName /(buff|bless)/ /Player to buff/
PrivMsgName /stop/ /GM/

Устанавливает значения переменных:

$.PrivMsgNameLastName => Запоминает имя игрока, личное сообщение от которого привело к срабатыванию события PrivMsgName
$.PrivMsgNameLastMsg => Запоминает само сообщение

PrivMsgNameDist

Описание: событие наступает при получении личного сообщения, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам, а также после проверки расстояния до игрока.

Синтаксис:

PrivMsgNameDist <Regex> <Regex> <Math condition operators>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PrivMsgNameDist /(buff|bless)/ /Player to buff/ < 3
PrivMsgNameDist /stop/ /GM/ >= 4

Устанавливает значения переменных:

$.PrivMsgNameDistLastName => Запоминает имя игрока, личное сообщение от которого привело к срабатыванию события PrivMsgNameDist
$.PrivMsgNameDistLastMsg => Запоминает само сообщение
$.PrivMsgNameDistLastPos => Запоминает координаты игрока
$.PrivMsgNameDistLastDist => Запоминает расстояние до игрока
$.PrivMsgNameDistLastID => Запоминает опенкоровский номер игрока

PartyMsg

Описание: событие наступает при получении сообщения в пати-чат, автомакрос сработает после проверки сообщения на соответствие regexp-шаблону.

Синтаксис:

PartyMsg <Regex>

Пример:

PartyMsg /(buff|bless)/

Устанавливает значения переменных:

$.PartyMsgLastName => Запоминает имя игрока, личное сообщение от которого привело к срабатыванию события PartyMsg
$.PartyMsgLastMsg => Запоминает само сообщение

PartyMsgDist

Описание: событие наступает при получении сообщения в пати-чат, автомакрос сработает после проверки сообщения на соответствие regexp-шаблону и расстояния до игрока.

Синтаксис:

PartyMsgDist <Regex> <Math condition operators>

Пример:

PartyMsgDist /(buff|bless)/ < 5

Устанавливает значения переменных:

$.PartyMsgDistLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события PartyMsgDist
$.PartyMsgDistLastMsg => Запоминает само сообщение
$.PartyMsgDistLastPos => Запоминает координаты игрока
$.PartyMsgDistLastDist => Запоминает расстояние до игрока
$.PartyMsgDistLastID => Запоминает опенкоровский номер игрока

PartyMsgName

Описание: событие наступает при получении сообщения в пати-чат, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам.

Синтаксис:

PartyMsgName <Regex> <Regex>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PartyMsgName /(buff|bless)/ /Player to buff/
PartyMsgName /stop/ /GM/

Устанавливает значения переменных:

$.PartyMsgNameLastName => Запоминает имя игрока, личное сообщение от которого привело к срабатыванию события PartyMsgName
$.PartyMsgNameLastMsg => Запоминает само сообщение

PartyMsgNameDist

Описание: событие наступает при получении сообщения в пати-чат, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам, а также после проверки расстояния до игрока.

Синтаксис:

PartyMsgNameDist <Regex> <Regex> <Math condition operators>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

PartyMsgNameDist /(buff|bless)/ /Player to buff/ < 3
PartyMsgNameDist /stop/ /GM/ >= 4

Устанавливает значение переменной:

$.PartyMsgNameDistLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события PartyMsgNameDist
$.PartyMsgNameDistLastMsg => Запоминает само сообщение
$.PartyMsgNameDistLastPos => Запоминает координаты игрока
$.PartyMsgNameDistLastDist => Запоминает расстояние до игрока
$.PartyMsgNameDistLastID => Запоминает опенкоровский номер игрока

GuildMsg

Описание: событие наступает при получении сообщения в чате гильдии, автомакрос сработает, если сообщение совпадает с regexp-шаблоном.

Синтаксис:

GuildMsg <Regex>

Пример:

GuildMsg /(buff|bless)/

Устанавливает значения переменных:

$.GuildMsgLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события GuildMsg
$.GuildMsgLastMsg => Запоминает само сообщение

GuildMsgDist

Описание: событие наступает при получении сообщения в чате гильдии, автомакрос сработает после проверки сообщения на совпадение с regexp-шаблоном и проверки расстояния до игрока.

Синтаксис:

GuildMsgDist <Regex> <Math condition operators>

Пример:

GuildMsgDist /(buff|bless)/ < 5

Устанавливает значение переменной:

$.GuildMsgDistLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события GuildMsgDist
$.GuildMsgDistLastMsg => Запоминает само сообщение
$.GuildMsgDistLastPos => Запоминает координаты игрока
$.GuildMsgDistLastDist => Запоминает расстояние до игрока
$.GuildMsgDistLastID => Запоминает опенкоровский номер игрока

GuildMsgName

Описание: событие наступает при получении сообщения в чате гильдии, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам.

Синтаксис:

GuildMsgName <Regex> <Regex>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

GuildMsgName /(buff|bless)/ /Player to buff/
GuildMsgName /stop/ /GM/

Устанавливает значения переменных:

$.GuildMsgNameLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события GuildMsgName
$.GuildMsgNameLastMsg => Запоминает само сообщение

GuildMsgNameDist

Описание: событие наступает при получении сообщения в чате гильдии, автомакрос сработает после проверки сообщения и имени игрока на соответствие заданным regexp-шаблонам, а также расстояния до игрока.

Синтаксис:

GuildMsgNameDist <Regex> <Regex> <Math condition operators>

Первый regexp-шаблон отвечает за проверку сообщения, а второй - за имя игрока.

Пример:

GuildMsgNameDist /(buff|bless)/ /Player to buff/ < 3
GuildMsgNameDist /stop/ /GM/ >= 4

Устанавливает значение переменной:

$.GuildMsgNameDistLastName => Запоминает имя игрока, сообщение от которого привело к срабатыванию события GuildMsgNameDist
$.GuildMsgNameDistLastMsg => Запоминает само сообщение
$.GuildMsgNameDistLastPos => Запоминает координаты игрока
$.GuildMsgNameDistLastDist => Запоминает расстояние до игрока
$.GuildMsgNameDistLastID => Запоминает опенкоровский номер игрока

NpcMsg

Описание: событие наступает при получении сообщения от неписи, автомакрос сработает после проверки сообщения на совпадение с regexp-шаблоном.

Синтаксис:

NpcMsg <Regex>

Пример:

NpcMsg /your return point was saved/

Устанавливает значения переменных:

$.NpcMsgLastName => Запоминает имя неписи, чьё сообщение привело к срабатыванию события NpcMsg
$.NpcMsgLastMsg => Запоминает само сообщение

NpcMsgDist

Описание: событие наступает при получении сообщения от неписи, автомакрос сработает после проверки сообщения на совпадение с regexp-шаблоном и проверки расстояния до неписи.

Синтаксис:

NpcMsgDist <Regex> <Math condition operators>

Пример:

NpcMsgDist /please come near to me/ > 5

Устанавливает значения переменных:

$.NpcMsgDistLastName => Запоминает имя неписи, чьё сообщение привело к срабатыванию события NpcMsgDist
$.NpcMsgDistLastMsg => Запоминает само сообщение
$.NpcMsgDistLastPos => Запоминает координаты неписи
$.NpcMsgDistLastDist => Запоминает расстояние до неписи
$.NpcMsgDistLastID => Запоминает опенкоровский номер неписи

NpcMsgName

Описание: событие наступает при получении сообщения от неписи, автомакрос сработает после проверки сообщения и имени неписи на совпадение с regexp-шаблонами.

Синтаксис:

NpcMsgName <Regex> <Regex>

Первый regexp-шаблон - для сообщения, а второй - для имени неписи

Пример:

NpcMsgName /You don't have zeny/ /kafra/

Устанавливает значения переменных:

$.NpcMsgNameLastName => Запоминает имя неписи, чьё сообщение привело к срабатыванию события NpcMsgName
$.NpcMsgNameLastMsg => Запоминает само сообщение

NpcMsgNameDist

Описание: событие наступает при получении сообщения от неписи, автомакрос сработает после проверки сообщения и имени неписи на совпадение с regexp-шаблонами, а также после проверки расстояния до неписи.

Синтаксис:

NpcMsgNameDist <Regex> <Regex> <Math condition operators>

Первый regexp-шаблон - для сообщения, а второй - для имени неписи

Пример:

NpcMsgNameDist /You need to be closer to punch me/ /punchable npc/ > 5

Устанавливает значение переменной:

$.NpcMsgNameDistLastName => Запоминает имя неписи, чьё сообщение привело к срабатыванию события NpcMsgNameDist
$.NpcMsgNameDistLastMsg => Запоминает само сообщение
$.NpcMsgNameDistLastPos => Запоминает координаты неписи
$.NpcMsgNameDistLastDist => Запоминает расстояние до неписи
$.NpcMsgNameDistLastID => Запоминает опенкоровский номер неписи

LocalMsg

Описание: событие наступает при получении местного оповещения, например при перелётах на дирижабле. Автомакрос сработает, если сообщение подойдёт к regexp-шаблону.

Синтаксис:

LocalMsg <Regex>

Пример:

LocalMsg /airship is arriving/

Устанавливает значение переменной:

$.LocalMsgLastMsg => Запоминает сообщение, которое привело к срабатыванию события LocalMsg

BusMsg

Описание: событие проверяет сообщения, поступающие по bus-шине. Автомакрос сработает, если сообщение совпадёт с regexp-шаблоном.

Синтаксис:

BusMsg <Regex>

Пример:

BusMsg /gm near/

Устанавливает значение переменной:

$.BusMsgLastMsg => Запоминает сообщение, которое привело к срабатыванию события BusMsg

MapLoaded

Описание: событие наступает каждый раз, когда сменяется локация персонажа, т.е. при телепортации и переходах на другую локацию. Автомакрос сработает, если персонаж попал на одну из локаций в указанном списке.

Синтаксис:

MapLoaded <список локаций, локации разделяются запятыми>

Вместо названия локации можно использовать переменную.

Пример:

MapLoaded prontra, geffen, gef_fild10

Устанавливает значение переменной:

$.MapLoadedLast => Запоминает название локации, которая привела к срабатыванию события MapLoaded

OnCharLogIn

Описание: событие наступает каждый раз, когда персонаж заходит в игру.

Синтаксис:

OnCharLogIn 1

Пример:

OnCharLogIn 1

Нет никаких переменных.

ZenyChanged

Описание: событие наступает всякий раз, когда у персонажа изменияется количество зени. Автомакрос сработает, если выполнится заданное условие.
Может работать с процентами, где 100% - это количество зени до изменения.

Синтаксис:

ZennyChanged <Math condition operators>

Пример:

ZennyChanged > 10%
ZennyChanged >= 1000

Устанавливает значения переменных:

$.ZennyChangedLastChange => Запоминает количество зени, которое привело к срабатыванию события ZennyChanged
$.ZennyChangedLastZennyAfter => Запоминает количество зени после срабатывания события, т.е. сколько зени есть на текущий момент

SimpleHookEvent

Описание: Событие наступает всякий раз, когда внутри openkore срабатывает заданный хук (т.е. опять же - событие).

Синтаксис:

SimpleHookEvent <hook name>

Пример:

SimpleHookEvent target_died

Все переменные события сохраняются в переменных вида:

$.SimpleHookEventLast<capitalized variable name>

Пример:

$.SimpleHookEventLastMonster => идентификатор моба из хука target_died

Приложения

Операторы сравнения

(<|<=|=|==|!=|!|>=|>|)\s*($number_qr%?|$general_wider_variable_qr)(?:\s*\.\.\s*($number_qr%?|$general_wider_variable_qr))

Оператор	Описание	Пример
< <value>	меньше чем <value>	< 50
> <value>	больше чем <value>	> 20
<= <value>	меньше либо равно <value>	<= 10
>= <value>	больше либо равно <value>	>= 25
= <value> \| == <value> \| <value>	равно <value>	= 150 \| == 150 \| 150
!= <value> \| ! <value>	не равно <value>	! 1000 \| != 1000
<value1>..<value2>	в диапазоне от <value1> до <value2>	20..80

Примечание: <value> может быть числом или переменной.

Примеры:

Math_condition >= 50 # условие истинно, если величина больше либо равна 50
Math_condition < $variable # условие истинно, если величина меньше, чем переменная $variable

Примечание: <value> может быть процентной величиной (переменная тоже может хранить проценты).

Примеры:

Math_condition <= 10% # меньше либо равно 10%
Math_condition != $variable # в переменной $variable может быть '50%'

Regex

Про регулярные выражения, т.е. regexp, можно почитать тут: regexp tutorial

Имейте в виду, что regex в условиях умеют работать со всеми типами переменных

Подпрограммы Perl

Плагин eventMacro устроен так, что можно написать самую настоящую подпрограмму на языке Perl, а затем вызвать её в макросе. Раньше вы были бы ограничены возможностями команды eval, теперь таких ограничений нет.

Первый пример покажет, как можно описать подпрограмму existsInList на языке Perl, которая я бы проверяла, есть ли в списке искомый элемент.

macro sub {
    $list = Orange, Milk, Soya, Peach
    if (existsInList("$list", "PeAch")) goto ok 
    log Not Match!!!; stop
    :ok
    log Match!!!
    $x = &eval(existsInList("$list", "PeAch"))
    log \$x = $x   # $x here is 1
}
sub existsInList {
    my ($list, $val) = @_;
    return 0 if ($val eq "");
    my @array = split / *, */, $list;
    $val = lc($val);
    foreach (@array) {
        s/^\s+//;
        s/\s+$//;
        s/\s+/ /g;
        next if $_ eq "";
        return 1 if lc eq $val;
    }
    return 0;
}

Во втором примере приводится подпрограмма rewrite. В её задачу входит чтение и перезапись файла mon_control.txt.

automacro confHP1 {
    CurrentHP > 85%
    exclusive 1
    run-once 1
    call {
        $setting = Demon Pungus #becareful on your case, its case sensitive
        $attack = 1
        $teleport = 0
        $telesearch = 1
        call HP
    }
}

automacro confHP2 {
    CurrentHP < 75%
    exclusive 1
    run-once 1
    call {
        $setting = Demon Pungus #becareful on your case, its case sensitive
        $attack = 1
        $teleport = 2
        $telesearch = 1
        call HP
    }
}

macro HP {
    #Getting the value of the $setting monster name Ex: $setting $exist1 $exist2 $exist3
    $exist1 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{attack_auto}:"None")
    $exist2 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{teleport_auto}:"None")
    $exist3 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{teleport_search}:"None")
    log Old Values are $setting $exist1 $exist2 $exist3
    log Changing the values to $setting $attack $teleport $telesearch
    do eval Misc::mon_control("$::Macro::Data::varStack{setting}")->{attack_auto} = $attack; Misc::mon_control("$::Macro::Data::varStack{setting}")->{teleport_auto} = $teleport; Misc::mon_control("$::Macro::Data::varStack{setting}")->{teleport_search} = $telesearch
    log Writting mon_control.txt with new values
    rewrite()  # see the sub-routine function below
    log Reloading mon_control.txt
    do reload mon_control
    $exist1 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{attack_auto}:"None")
    $exist2 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{teleport_auto}:"None")
    $exist3 = &eval (defined Misc::mon_control("$setting")?Misc::mon_control("$setting")->{teleport_search}:"None")
    log New mon_control.txt Setting: $setting $exist1 $exist2 $exist3
    log Macro done
    #if $teleport = 0 ; means the Higher automacro HP is currently triggered
    #if $teleport = 2 ; means the Lower automacro HP is currently triggered
    if ($teleport < 2) goto releaseHighHp
    :releaseLowHp
        release confHP1
        stop
    :releaseHighHp
        release confHP2
        stop
}

sub rewrite {
    my $monster = Misc::mon_control("$::Macro::Data::varStack{setting}");
    my @lines = ();
    if (open(FILE, "<:utf8", Settings::getControlFilename("mon_control.txt"))) {
        while (<FILE>) {
            s/\x{FEFF}//g; chomp;
            if (/^#/ || /^\n/ || /^\r/) {
                push @lines,$_;
                next
            }
            /^(\d+|([a-zA-Z' ]+)*) -?\d/;
            if ("$::Macro::Data::varStack{setting}" eq $1 && defined $monster) {
                $_ = $1; s/\s+$//;
                push(@lines, ($_ . " $monster->{attack_auto} $monster->{teleport_auto} $monster->{teleport_search} $monster->{attack_lvl} $monster->{attack_jlvl} $monster->{attack_hp} $monster->{attack_sp} $monster->{weight}"));
            } else {
                push(@lines, $_);
            }
        }
        close FILE
    }
    open(FILE, ">:utf8", Settings::getControlFilename("mon_control.txt"));
    print FILE join "\n", @lines;
    close FILE;
}

Примеры с пояснениями

Я предполагаю, что вы уже умеете пользоваться консольными командами и понимаете, как они работают. Если это не так, то пробегитесь по разделу консольные команды и попробуйте например a, ai, move, cart get, storage add, talk, deal, take, sl, sm, relog, pm и т.д.

Держите под рукой документацию на консольные команды, чтобы обращаться к ней по ходу дела.

Итак, есть два вида блоков Okay, so there are 2 types of blocks

автомакросы – срабатывают автоматически
макросы – не срабатывают автоматически, их надо вызывать руками из консоли или вызывать из автомакроса

Автомакросы

Автомакросы срабатывают автоматически, когда выполняется ряд условий. Прямо как блоки в config.txt срабатывают в зависимости от описанных в них условий.

Смысл автомакросов заключается в том, что они проверяют условия. Если условия выполняются, то будут выполнены некие команды. Команды можно писать прямо в автомакросе или вынести в отдельный макрос и вызвать их по имени макроса. Автомакросы выглядят так:

automacro <НазваниеАвтомакроса> {
        Первое условие
        Второе условие
        и т.д.
        …...
        call {
                Команда 1
                Команда 2
                и т.д.
                …..
        }
        timeout <n секунды> #(по желанию)
}

Предположим, что вы играете лично, но за вами бегает прист под управлением openkore. Вы бы хотели, чтобы бот предупреждал вас в чате, когда у него остаётся мало маны. Для этого можно написать следующий автомакрос.

automacro sp {
   CurrentSP < 200
   timeout 10
   call {
      do c мало маны
   }
}

Давайте разберём автомакрос строка за строкой:

automacro sp { - сначала надо объявить автомакрос, написав ключевое слово automacro, потом дать автомакросу название, в данном случае “sp”. Затем идёт открывающая фигурная скобка “{“, с которой начинается тело автомакроса.
CurrentSP < 200 – в теле необходимо записать условия срабатывания автомакроса, по одному на каждой строке. В данном примере у нас есть только одно условие; данное выражение истинно, когда количество маны у персонажа опустится ниже двухсот единиц.
timeout 10 – данное выражение - это не условие и не команда, а параметр. Он работает также, как и в обычных блоках в конфиге, то есть не даёт срабатывать автомакросу в течение следующих десяти секунд с последнего раза. Я всегда использую timeout, чтобы автомакросы не запускались раз за разом, если я напутал в условиях.
call { – ключевое слово “call” определяет, что произойдёт, когда сработает автомакрос. После открывающей фигурной скобки “{“ нужно будет написать команды.
do c мало маны – тут идёт собственно макрокоманда “do”, которая в данном случае вызывает консольную команду “c”, чтобы написать в чат, что у бота осталось мало маны.
} – эта фигурная скобка закрывает блок с командами.
} – вторая фигурная скобка закрывает тело автомакроса.

Короче говоря, если у бота будет меньше 200 единиц маны, он напишет в чат “мало маны”. Таким образом бот станет чуть больше походить на человека =p.

Вот другой пример, который показывает, как бот может бороться с внезапной пропажей оружия. Например металлинги очень любят выбивать оружие из рук и тогда ваш глупый бот будет драться кулаками. Чтобы обойти данную проблему, следует прописать в конфиге стандартное оружие и применить следующий автомакрос.

automacro strip {
   StatusActiveHandle EFST_NOEQUIPWEAPON
   timeout 10
   call {
      do tele
      do relog 10
   }
}

Разберём данный пример.

automacro strip { - объявляем автомакрос "strip", после '{' начнётся описание автомакроса.
StatusActiveHandle EFST_NOEQUIPWEAPON - единственное условие автомакроса, которое пробегается по списку статусов персонажа в поиске "EFST_NOEQUIPWEAPON". Данный статус накладывается, когда металлинг выбивает оружие у бота из рук.
timeout 10 - обезопасим себя от слишком частого срабатывания автомакроса. Десяти секунд будет достаточно, чтобы описанный далее макрос успел полностью отработать.
call { - после ключевого слова "call" и фигурной скобки "{" пойдут команды.
do tele - макрокоманда "do" запускает консольную команду "tele", чтобы сбежать от металлинга телепортом, чтобы не помереть от него безоружным.
do relog 10 - данная команда говорит боту перезайти в игру, потому что после захода в игру статус "strip weapon" пропадёт.
} - первая фигурная скобка '}' закрывает блок с командами.
} - вторая фигурная скобка '}' закрывает описание автомакроса.

В итоге, если с бота сняли оружие, он телепортируется от моба и перезаходит в игру. Второй раз автомакрос сработает не раньше, чем через 10 секунд. Так как в конфиге прописано оружие по умолчанию, то после входа в игру бот автоматически возьмёт в руки оружие.

Перейдём к более сложному макросу. Если у вас есть прист, то вы бы наверное хотели, чтобы он открывал портал прямо на локацию кача или ближайшую к ней локацию, доступную через варп. Данный макрос как раз этим и занимается. Предположим, что прист сохранился в Геффене и всегда выходит из города влево, чтобы добраться до нужной локации. Тогда на первой же локации за городом надо отвести его в сторонку, вызвать варп и зайти в него. Между командами расставим паузы, чтобы команды успели отработать.

automacro warp {
    InMap gef_fild07
    InInventory "Blue Gemstone" > 0
    timeout 20
    call {
        do ai manual
        pause 1
        do move 319 187
        do sl 27 316 188
        pause 2
        do warp 1
        pause 1
        do move 316 188
        do ai on
    }
}

Итак, давайте посмотрим:

automacro warp { - объявляем автомакрос "warp", после фигурной скобки “{“ начинается описание собственно автомакроса.
InMap get_fild07 - первое условие, автомакрос сработает только на локе слева от Геффена, т.е. на gef_fild07.
InInventory “Blue Gemstone” > 0 - второе условие проверяет, что в инвентаре есть необходимый для вызова варп-портала расходник. Было бы неплохо прописать в конфиге getAuto для синих камней.
timeout 20 - на всякий случай, чтобы автомакрос не срабатывал каждую секунду. Двадцати секунд должно быть достаточно для выполнения команд макроса, чтобы автомакрос не сработал повторно, перебивая таким образом последовательность команд макроса.
call { - команды макроса начнутся со следующей строки.
do ai manual - данной командой openkore переводится в ручной режим, я часто так делаю в длинных и сложных макросах, чтобы openkore своим автоматическим поведением не помешала выполнению команд. В данном случае команда нужна, чтобы бот не шел дальше.
pause 1 - очень важно расставлять паузы, чтобы команды точно успели отработать и не помешали друг другу.
do move 319 187 - консольная команда "move" отправит бота по указанным координатам.
do sl 27 316 188 - консольной командой "sl" будет вызван варп-портал недалеко от бота, в данном случае по координатам (316,188).
pause 2 - очень важно дать пару секунд времени на вызов портала, если у приста мало dex, то паузу стоит увеличить.
do warp 1 - консольной командой "warp" выбираем из списка пункт назначения под номером один.
pause 1 - одна секунда задержки на создание портала.
do move 316 188 - заходим в портал, персонаж варпнулся на нужную локацию.
do ai on - в конце макроса включаем автоматический режим openkore обратно.
} - первая фигурная скобка закрывает блок команд.
} - вторая фигурная скобка закрывает автомакрос.

Обратите внимание, что паузы в сумме укладываются в отведённое в timeout время для автомакроса.

Мы закончили рассматривать большие примеры автомакросов. Давайте напоследок глянем несколько небольших примеров, которые занимают всего пару строк.

Плагин eventMacro предоставляет много встроенных переменных. Например в переменной $.pos лежат координаты персонажа. Давайте посмотрим, как можно извлечь из нее отдельно координаты x и y.

Итак, в переменной $.pos лежат координаты персонажа. А вот так можно достать из неё x и y:

  $px = &arg ("$.pos", 1)
  $py = &arg ("$.pos", 2)

Где координата x стоит на первом месте в $.pos, поэтому пишем '1'. Соответственно координата y стоит на втором месте в $.pos, поэтому для неё нужна цифра '2'.

Второй похожий пример. Если в автомакросе есть условие “MobNear”, то в макросе будет переменная $.MobNearLastPos с координатами моба. Чтобы достать оттуда отдельно координаты x и y повторим уже описанный выше приём:

  $mx = &arg ("$.MobNearLastPos", 1)
  $my = &arg ("$.MobNearLastPos", 2)

"run-once"

Часто вместо параметра timeout используют run-once 1, который даёт автомакросу сработать только один раз, после чего автомакрос блокируется. Если же требуется автомакрос разблокировать, то для этого есть соответствующая команда. Однако по необъяснимой причине бывает так, что макрос зависает и команда на разблокирование автомакроса не срабатывает. В итоге автомакрос как был заблокирован, так и остался. Чтобы избежать данной неприятности используйте лучше timeout.

Как написать макрос

Пусть у вас появилось желание написать макрос, попробуйте данный алгоритм:

Уточните условия срабатывания автомакроса. Запишите их в теле автомакроса.
Шаг за шагом продумайте, какие действия должен совершить бот, чтобы достигнуть результата. Запишите команды в call { ... }.
Расставьте между командами макроса необходимые паузы.
Используйте в автомакросе timeout или run-once, чтобы предотвратить немедленное повторное срабатывание автомакроса.
Код автомакроса сохраниете в файле eventMacros.txt, запустите бота или если он уже запущен, перечитайте файл. Если в коде закралась синтаксическая ошибка, например вы забыли написать "}", то вы получите сообщение об ошибке и макрос не сработает. Найдите и исправьте ошибку, перечитайте файл eventMacros.txt. При наступлении условий автомакрос сработает и выполнит код.

Собрание макросов

Я бы хотел поделиться парочкой полезных макросов, надеюсь никто не против.

Определение предметов при помощи увеличительного стекла

Пусть у вас в инвентаре лежит неопределённая экипировка и вы хотите её распознать, используя для этого увеличительные стекла. Введите в консоли команду "eventMacro id", чтобы распознать один предмет. Вводите команду столько раз, сколько потребуется, чтобы распознать все. Вам не нужно указывать, какой предмет распознавать. Макрос возьмёт первый попавшийся.

macro id {
    $id = &inventory(Magnifier)
    do is $id
    pause 1
    do identify 0
}

Обогащение руды (Ori / Elu)

Макрос ref отправит бота в кузнецу Пронтеры и будет до упора обменивать пять единиц руды на один металл Ori / Elu. Возможно у вас есть идеи, как улучшить макрос?

Чтобы запустить макрос введите eventMacro ref. Чтобы прервать выполнение макроса введите eventMacro stop.

macro ref {
    do move prt_in 59 60
    call ref-while
}

macro ref-while {
    log start refining with
    $ori = &invamount(Rough Oridecon)
    $elu = &invamount(Rough Elunium)
    log I have $ori Rough Oridecons
    log I have $elu Rough Eluniums
    while (&invamount(Rough Oridecon) > 4) {
        do talk 0 # примечание переводчика: а мы точно попадём на нужную непись?
        pause 0.8
        do talk resp 0
        call ref-while # примечание переводчика: а это точно нужно? Зачем рекурсия из цикла?
    }
    while (&inventory(Rough Elunium) > 4) {
        do talk 0
        pause 0.8
        do talk resp 1
        call ref-while
    }
    stop # примечание переводчика: а это точно нужно? Зачем останавливать макрос, ведь это и так последняя строка?
}

FAQ

Меня отключило от сервера локации, когда я запустил макрос. В чем дело?: Команды макроса отправлялись слишком быстро. Увеличьте macro_delay или расставьте паузы между командами

У меня проблемы в кодировкой UTF-8. В чем дело?: Данная ошибка всплывает, когда файл eventMacros.txt сохранён в отличной от UTF-8 кодировке.; Откройте файл eventMacros.txt программой Notepad и при сохранении надо выбрать кодировку UTF-8. (Если не помогло - не используйте Notepad.); Откройте файл eventMacros.txt программой Notepad++, в главном меню надо выбрать Format > UTF-8 (without BOM) и сохранить файл.

Авторы-программисты

Henrybk написал плагин eventMacro.

Предком плагина eventMacro был macro-плагин, его написал arachno, затем руку приложили ezza, daigaku, keplerbr, eternalhavest и technologyguild.

emjustin протестировал eventMacro.

allanon придумал и запрограммировал некоторые весьма важные функции плагина eventMacro.

eventMacro

Содержание

Описание

Установка

Консольные команды

Синтаксис

Файлы настроек

Синтаксис эвент-макросов

Макро-команды

Переменные

Типы переменных

Объявление и использование

Скаляр

Массив

Хэш

Особые переменные

Функции эвент-макроса

Цепочка команд

Подстроки

Операторы сравнения

Управление потоком и метки

Синтаксис условных операторов

If

Else

Elsif

Switch/case

Примеры с условными операторами

Цикл while

Синктаксис

Пример

Автомакросы

Параметры

Условия

Состояние

События

Приложения

Операторы сравнения

Regex

Подпрограммы Perl

Комментарии

Примеры с пояснениями

Как написать макрос

Собрание макросов

FAQ

Авторы-программисты

Навигация

Поиск