POMLUA. "Общие" функции.

Разъяснение. В описании каждый отдельный параметр заключен в <>. Необязательная часть в []. В самом коде эту "обвязку" указывать не нужно. Пример. func(<A>[,<B>]) - в реальном коде, при A = 10 и B = 20, будет иметь вид func(10,20). Необязательную часть можно пропускать в вызове, но если указывать, то внутреннюю последовательность нарушать нельзя. Например, (<A>[,<B>,<C>]) - параметр A нужно указывать всегда, B и C можно опустить. При этом можно указать A и B без C. Но если нужно указать C, то перед обязательно должен быть и В (выбросить В и указать только С нельзя).

dofile([[<путь\имя файла>]]).

Производит выполнение скрипта расположенного в указанном файле. В рамках одного текстового скрипта можно выполнять несколько файлов (используя несколько вызовов dofile), а так же смешивать их с выполнением других инструкций. 

message("<текст>").

Результатом выполнения будет показ отдельного окна с сообщением <текст>. Текст может быть заключен как в обычные кавычки так и в специализированные [[]].

toLog("<текст>"[,<стиль>]).

Команда по смыслу похожа на прошлую, вместо показа отдельного окна <текст> выводится только в лог рабочего окна программы. Дополнительно к нему можно применить различные стили для выделения или улучшения восприятия информации:

    fsBold - жирный; 

    fsUnderline - подчеркнутый; 

    fsItalic - наклонный;

    fsStrikeOut - зачеркнутый.

alarm(<частота>[,<длительность мс>=200,"<текст>"]).

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

getWorkMode(без параметров).

Возвращает код текущего исполняемого режима. Можно выполнить какое-то действие исходя из него (через блок if .. then .. end), либо запомнить в переменной для последующей смены и обратного восстановления.

getMainWorkMode(без параметров).

Команда по смыслу похожа на прошлую, однако возвращает первоначальный режим, с которого пользователь начал выполнение. Он может не совпадать с текущим, если была произведена "горячая" смена (программно в процессе работы). В случае возникновения в "не исходном" режиме ситуации "стоп", производится не остановка, а возврат к выполнению начального режима. 

 

setWorkMode(<код нового режима>).

Изменяет текущий режим выполнения на указанный. Для удобства восприятия можно использовать текстовые константы режимов (их ввод также продублирован вызовом меню или элементом на панели в редакторе):

   modeCave - пещерный:

   modeIsland - островной;

   modeArena - аренный;

   modePassive - пассивный (особый режим реагирующий на появление боев в браузере и проводящий их, кроме этого на его базе реализовано маршальское нападение. Также выполняет проверку доп.событий:мастерская, лавка, клан-заклы и проч.);

   modeShop - магазинный;

   modeIslShop - остроМаг (острова + магазин на каждом из них);

   modeLotoOpen - лото.Открыть;

   modeLotoBuy - лото.Купить;

   modeMessages - разбор сообщений;

   modeBoss - атака босса;

   modeMinion - атака миньонов (на боссах);

   modeTornament - турнир адептов;

   modeVortex - вихрь;

   modeWaiting - ожидание (пустой режим выполняющий только проверки доп.событий: мастерская, лавка, клан-заклы и проч.).

setMainWorkMode(<код режима>).

Не производит смены режима, но заменяет информацию об исходном. Если текущий и есть исходный, то он становится "вторым", а "под него" записывается новый. В случае возникновения в "не исходном" режиме ситуации "стоп", производится не остановка, а возврат к выполнению начального режима. Так что данной командой можно задать переход в какой-то другой режим, когда в текущем возникнет условие остановки.

restoreLastWorkMode(без параметров). 

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

stopProgram(без параметров).

Производит остановку текущего режима.

setStopCloseProgramFlag(<новое значение>).

Изменяет значение опции "Стоп=Закрыть" (вместо общего стопа программы производится ее закрытие, что может быть полезно для замораживания отсчета времени по лицензии, если прогнозируется остановка в длительное отсутствие пользователя). Ноль - отключить, не_ноль - включить.

pauseOn(<число секунд>).

Приостановить текущее выполнение на указанное число секунд. Если указан ноль, то пауза бессрочная, которая может быть снята только из другого скрипта, вызванного по наступлению какого-либо события (игровое, расписание планировщика и проч.), либо лично пользователем (отжать/потушить кнопку паузы в браузере или рабочем окне программы).

pauseOff(без параметров).

Принудительное завершение паузы.

reloadGame([[<поясняющий текст>]]).

Инициирует принудительное обновление игры в браузере. Указанный <поясняющий текст> будет указан в записи лога, что может помочь в определении причины/места вызова перезагрузки.