Встроенные функции основного скрипта


Исключения

Исключения служат для занесения пользователей в список, который не будет обрабатываться антиматом, антирекламой и не будет проверяться движком триггеров и автозамен бота. Список этих пользователей хранится в файле TableName в папке бота. Плагинам список ников-исключений доспупен в таблице TableName[ник].
Чтобы добавить пользователя в исключения, нужно использовать команду !исключения+ <ник>. Чтобы удалить пользователя из исключений, используется команда !исключения- <ник>. Список всех пользователей в исключении по команде !исключения.

Перезапуск при ошибке

Эта функция позволяет перезагружать скрипт после возникновения какой-либо ошибки в скрипте. При этом в ОП-чат посылается отчёт о возникшей ошибке. Включение и отключение этой функции производится по команде !ekzekutor_restartonerror.

Отправка последних сообщений

Эта функция служит для запоминания последних сообщений чата и отправку их в приват или чат входящим пользователям. Количество запоминаемых сообщений настраивается командой !lastmsgcount <число>. Включение/выключение функции по команде !lastmsgchat <тип>. Тип отправки сообщений: 1 - в Чат, 2 - в Приват, 0 - выключено. Просмотреть последние сообщения можно также по команде !getlastmsg.

Перезагрузка настроек

Перезагружает настройки и все таблицы скрипта (горячая перезагрузка). По команде !ekzekutor_reload в чате или по команде !reload в приват боту.

Информационное приветствие

В данном скрипте имеется возможность выводить пользователю при подключении информацию, содержание которой задаётся скриптом в папке welcome. Название скрипта соответствует названию текущей локализации. Если в этой папке нет скрипта с названием нужной локализации (с добавлением расширения .lua), то ничего не выводится. Приветствие может отправляться в чат или в приват пользователю. Переключение режима отправки производится командой !welcometype <тип>. Тип может быть 1 (в чат) или 2 (в приват). Если тип установлен как 0, то функция информационного приветствия отключена. Формат файла:

function getwelcomemessage(curUser)
    ...
    return "text"
end

Имеется возможность создавать индивидуальные файлы приветствия для классов с названием localisation_lang.lua, где localisation - текущий тип сервера, lang - язык. Этот файл проверяется перед проверкой общего приветствия и при его наличии обрабатывается он. Формат файла:

function (curUser)
    ...
    return "text"
end

Текстовые файлы

Эта функция служит для вывода пользователю текста из текстового файла, название которого совпадает с введённой пользователем командой (с добавлением расширения .txt). Текстовые файлы должны храниться в папке txt. Когда введённая команда соответствует названию одного из имеющихся текстовых файлов, пользователю в приват посылается содержимое этого файла. Включение/выключение функции производится командой !txtseek <тип>. Тип отправки текстового файла может быть 1 - Чат, 2 - Приват, 0 - выкл. В тексте возможно применять мультиязычные вставки, как в файлах меню: gl{Type_index}, которые описаны в мультиязычных функциях бота.

Незаметная заглушка

Эта функция представляет из себя "gag", только отличие от обычного "гага" в том, что "незаметнозаглушенный" пользователь не догадывается о том, что его не слышно. С его стороны всё выглядит так, что на него просто никто не обращает внимания и ему не отвечают (эффективно против неадекватных пользователей с динамическим IP-адресом). Можно указывать как ник, так и IP-адрес для внесения в список незаметнозаглушенных. При этом можно включить возможность операторам Хаба слышать таких пользователей, а также возможность отключать слышимость заглушенными пользователями общий чат (при этом у них складывается впечатление, что просто все молчат и никто с ними не общается). Список заглушенных хранится в файле MaskGagged. Заглушить пользователя на заданное число минут можно командой !maskgag <ник/IP> <минуты>. Снять заглушку с пользователя можно командой !unmaskgag <ник/IP>. Посмотреть список заглушенных можно командой !maskgags. Включить/выключить режим слышимости операторами Хаба заглушенных можно командой !oplistengag. Включить/выключить режим слышимости заглушенными общего чата можно командой !mglisten.

Shell и LUA консоль

Функция позволяет главным администраторам Хаба получать доступ к системной консоли или интерпретатору LUA через приват Бота. При этом будьте внимательны, если используете системную консоль, так как если Вы запустите программу, которая не вернёт управление (не завершится сразу после запуска), то скрипт будет ожидать возврата управления и будет "зависшим". Если программа (сервис) возвращает текст в стандартный поток вывода, то он будет отправлен в приват пользователю. При использовании LUA-консоли вводимый пользователем текст пропускается через интерпретатор LUA. Если возвращается какой-либо текст в стандартный вывод, то он отправляется в приват пользователю. Чтобы функция была активной, необходимо, чтобы константе isShellEnable в блоке настроек скрипта было присвоено текстовое значение. Этот текст является паролем для доступа к этой функции. Если задано пустое значение (""), то функция консоли будет отключена. Для запуска системной консоли нужно ввести в приват Боту команду !shell <пароль>. Для запуска LUA-консоли нужно ввести !lua <пароль>. Для завершения работы с консолью нужно ввести команду !stop. На операционных системах windows функция коммандной оболочки может не работать в виду функциональной ограниченности этих систем.

Псевдонимы команд

Функция служит для создания командам Бота псевдонимов. У каждой команды может быть несколько псевдонимов по выбору администрации. Псевдонимы хранятся в файле cmdAliasesTable. Если используется команда, которая задана как псевдоним для какой-либо команды, то Бот проверяет эту команду именно как команду, для которой текущая команда является псевдонимом. Добавить псевдоним для выбранной команды можно по команде !setcmdalias <команда> <псевдоним>. Удалить псевдоним для команды можно по команде !delcmdalias <псевдоним>. Посмотреть список всех псевдонимов для команд можно по команде !cmdaliases.

Разрешённые символы ников

Это перечень символов, которые разрешены для ников (используется, например, плагином с проверкой ников). Посмотреть список можно по команде !allowchars без параметров. Добавить символ с список разрешённых можно по команде !allowchars + <символ>. Удалить символ из списка разрешённых можно по команде !allowchars - <символ>.

Время и дата в списке пользователей

Функция служит для отображение вверху списка пользователей текущего времени и даты. В скрипте в таблице clockFormat задаётся формат отображения часов и даты. Включение/выключение отображения производится по команде !isclock.

Дата первого запуска

При первом запуске Бот отмечает время и заносит в массив настроек отметку, когда он был запущен первый раз. Отметка представляет собой число секунд, прошедшее от начала "эпохи" (01.01.1970). Посмотреть дату первого запуска можно по команде !birthday.

Вставка собственного кода

Можно добавлять свой собственный код в файлы в папке Бота, которые обрабатываются при запуске. Файл MyCodePreLoad.lua загружается перед загрузкой плагинов, а файл MyCodePostLoad.lua после. Удобно добавлять собственные функции, переопределять значения переменных, заменять функции на свои и т.д.

Плавная отправка меню по запросу

По умолчанию включен режим отправки меню по запросу при нажатии на соответствующий пункт в меню пользователя, текст которого задан в файле языковой локализации Bot_lang.lua. Отправка производится порциями. Размер порции задаётся в константе iMenuDividerFactor. Режим отправки для меню Бота и Хаба задаётся в константах isSendBotMenu и isSendHubMenu. Если установлено значение -1, то соответствующее меню не отправляется. Значение 1 означает немедленную отправку при входе (не рекомендуется при большом объёме меню в виду увеличения трафика и возможных сбоев клиентов). Значение 0 означает отправку меню по запрсу. Константа isMixMenus определяет объединение меню Бота и Хаба в один пункт для отправки (1 - да, 0 - нет). Если активны мультиязычные функции, при запросе меню надо указать язык (2 символа), если у пользователя не сохранён его язык.

Мультиязычные функции

Бот имеет возможность работы с пользователями на их языке индивидуально. Язык зарегистрированных пользователей при наличии плагина типов аккаунтов запоминается. Язык по умолчанию задаётся в константе DefaultLang в виде двух букв в нижнем регистре. Этот язык должен поддерживаться всеми файлами языковой локализации и присутствовать в таблице с перечнем языков EkzekutorLangs. Сменить/задать свой язык можно командой !lang <язык>. Активность мультиязычных функций задаются в константе isMultilingual (1 - функции активны, 0 - только язык по умолчанию). Текст разных языков для Бота находится в файле Bot_lang.lua; Хаба - Hub_lang.lua; плагинов - в папке плагина в файле Text_lang.lua.


<<< назад | печать | К началу...
PhazaSoft© Экзекутор©
Hosted by uCoz