Документация RakBot
Информация о боте для SAMP
Установка бота
Использование RakBot
Написание скриптов RakBot
Инструменты пользователя
Боковая панель
scripting:functions
Содержание
Список Lua-функций RakBot
Здесь предоставлен список функций RakBot для использования в Lua-скриптах. Помимо данных функций можно использовать стандартные функции языка Lua.
Скрипты для RakBot необходимо помещать в папку «scripts» с расширением «.lua» (файл должен быть обязательно в кодировке ANSI!)
События
События - функции, которые вызываются самим ботом, когда происходит какое либо событие. Данные функции перечислены ниже.
| Функция | Описание |
|---|---|
| onScriptStart() | Вызывается при загрузке скрипта |
| onScriptExit() | Вызывается при выгрузке скрипта |
| onRunCommand(cmd) | return bool (найдена ли команда), вызывается после отправки команды в бот |
| onPrintLog(msg) | return bool (true - не показывать текущую строку лога в боте), Вызывается при добавлении строки в лог-список |
| onDialogShow(id, style, title, btn1, btn2, data) | return bool (закрыть диалог), вызывается при получении диалога |
| onBotSpawn(x, y, z) | вызывается, когда бот был заспавнен, в аргументах содержит координаты спавна |
| onSetPosition(x, y, z) | вызывается, когда позиция бота была изменена, в аргументах содержит новые координаты |
| onConnect() | вызывается, когда бот был подключен к серверу |
| onGameInited() | вызывается после инициализации сервера |
| onServerJoin(id, name) | вызывается, когда другой игрок подключился к серверу, в аргументах содержит ID и имя игрока |
| onServerQuit(id, reason) | вызывается, когда другой игрок отключился от сервера, в аргументах содержит ID игрока и причину отключения |
| onSetHealth(health) | вызывается при изменении ХП бота сервером, в аргументах содержит новый уровень здоровья |
| onSetMoney(money) | вызывается при изменении количества наличных сервером, в аргументах содержит новое значение суммы на руках |
| onScriptUpdate() | вызывается циклически для выполнения действий независимо от других событий |
| onRecvPacket(id, data, size) | вызывается при получении пакета |
| onSendPacket(id, data, size) | вызывается при отправке пакета |
| onRecvRPC(id, data, size) | вызывается при получении RPC |
| onSendRPC(id, data, size) | вызывается при отправке RPC |
Функции
Данные функции Вы можете вызывать из своих скриптов для выполнения каких-либо действий или получения информации.
| Функция | Описание |
|---|---|
| printLog(text) | добавить лог-строку |
| runCommand(cmd) | выполнить команду |
| getBotInfo() | return string (информация из окошка справа), возвращает информацию о боте |
| getBotPos() | return float, float, float (x, y, z), возвращает позицию бота |
| getPlayerInfo(id) | return bool, string, integer, float, float, float (подключен, ник, уровень, координаты: x, y, z), возвращает информацию об игроке с определенным id |
| sendDialog(id, btn, item, input) | отправляет ответ на диалог |
| openUrl(url) | return string (тело ответа), отправка get запроса по url |
| getNickName() | return string (ник), получение ника бота |
| getServerAddress() | return string (IP адрес), получение адреса сервера |
| getServerName() | return string (название сервера), получение названия сервера |
| sleep(time) | задержка <time> миллисекунд |
| sendPacket(data) | отправка пакета с данными data (data - указатель на битстрим, о нем ниже будет) |
| sendRPC(id, data) | отправка RPC с ID = id и данными = data (data - указатель на битстрим, о нем ниже будет) |
| bitStreamNew() | создание нового объекта битстрим с пустыми данными, возвращает указатель на него |
| bitStreamInit(data, size) | создание нового объекта битстрим из готовых данных (data - указатель на данные, size - размер), возвращает указатель на него |
| bitStreamData(bs) | возвращает данные потока битстрим |
| bitStreamSize(bs) | возвращает размер данных потока битстрим |
| bitStreamDelete(bs) | удаляет объект битстрим (принимает указатель на объект, указание неверного вызовет краш!) |
| bitStreamIgnore(bs, amount) | игнорирует байты в потоке битстрим (bs - указатель на объект, amount - количество) |
| bitStreamReset(bs) | очистить поток битстрим |
| bitStreamSetReadOffset(bs, offset) | установить смещение чтения |
| bitStreamSetWriteOffset(bs, offset) | установить смещение записи |
| bitStreamReadByte(bs) | считывает 1 байт из потока (bs - указатель на объект), возвращает считанные данные |
| bitStreamReadWord(bs) | считывает 2 байта из потока (bs - указатель на объект), возвращает считанные данные |
| bitStreamReadDWord(bs) | считывает 4 байта из потока (bs - указатель на объект), возвращает считанные данные |
| bitStreamReadFloat(bs) | считывает float из потока (bs - указатель на объект), возвращает считанные данные |
| bitStreamReadString(bs, size) | считывает строку из потока (bs - указатель на объект, size - длина строки), возвращает считанные данные |
| bitStreamWriteByte(bs, val) | записывает 1 байт в поток (bs - указатель на объект, val - значение для записи) |
| bitStreamWriteWord(bs, val) | записывает 2 байта в поток (bs - указатель на объект, val - значение для записи) |
| bitStreamWriteDWord(bs, val) | записывает 4 байта в поток (bs - указатель на объект, val - значение для записи) |
| bitStreamWriteFloat(bs, val) | записывает float в поток (bs - указатель на объект, val - значение для записи) |
| bitStreamWriteString(bs, str, size) | записывает строку в поток (bs - указатель на объект, str - строка для записи, size - длина строки) |
| getPassword() | получить пароль для логина |
| getMail() | получить почту для регистрации |
| getReferer() | получить ник пригласившего |
| getSex() | получить пол для регистрации (1 - мужской, 0 - женский) |
| setOwnAutoReg(state) | включить собственную авторегистрацию (state=true - отключает встроенную в боте авторегистраци, state=false - включает авторегистрацию в боте) |
scripting/functions.txt · Последние изменения: 2019/03/16 00:42 (внешнее изменение)
Инструменты страницы
За исключением случаев, когда указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: GNU Free Documentation License 1.3
