Функции - k1zn/RakBot GitHub Wiki

adminsAdd

Описание: Добавляет ник в список администрации

Сигнатура: adminsAdd(admin)

adminsClear

Описание: Очищает список администрации для текущей сессии

Сигнатура: adminsClear()

bitStreamData

Описание: Возвращает данные потока BitStream

Сигнатура: bitStreamData(bs)

bitStreamDelete

Описание: Удаление ранее созданного объекта BitStream

Сигнатура: bitStreamDelete(bs)

bitStreamIgnore

Описание: Игнорирует байты в потоке BitStream

Сигнатура: bitStreamIgnore(bs, amount)

bitStreamInit

Описание: Создание нового объекта BitStream из готовых данных

Сигнатура: bitStreamInit(data, size)

bitStreamNew

Описание: Создание нового объекта BitStream

Сигнатура: bitStreamNew()

bitStreamReadByte

Описание: Считывает 1 байт из потока BitStream

Сигнатура: bitStreamReadByte(bs)

bitStreamReadDWord

Описание: Считывает 4 байта из потока BitStream

Сигнатура: bitStreamReadDWord(bs)

bitStreamReadFloat

Описание: Считывает float из потока BitStream

Сигнатура: bitStreamReadFloat(bs)

bitStreamReadString

Описание: Считывает string из потока BitStream

Сигнатура: bitStreamReadString(bs, size[, encode])

bitStreamReadWord

Описание: Считывает 2 байта из потока BitStream

Сигнатура: bitStreamReadWord(bs)

bitStreamReset

Описание: Очистка потока BitSteam

Сигнатура: bitStreamReset(bs)

Примечание: после длительного использования может вызывать неполадки. Используйте bitStreamDelete

bitStreamSetReadOffset

Описание: Устанавливает смещение для чтения

Сигнатура: bitStreamSetReadOffset(bs, offset)

bitStreamSetWriteOffset

Описание: Устанавливает смещение для записи

Сигнатура: bitStreamSetWriteOffset(bs, offset)

bitStreamSize

Описание: Возвращает размер данных потока BitStream

Сигнатура: bitStreamSize(bs)

bitStreamWriteByte

Описание: Записывает 1 байт в поток BitStream

Сигнатура: bitStreamWriteByte(bs, value[, compressed])

bitStreamWriteDWord

Описание: Записывает 4 байта в поток BitStream

Сигнатура: bitStreamWriteDWord(bs, value[, compressed])

bitStreamWriteFloat

Описание: Записывает float в поток BitStream

Сигнатура: bitStreamWriteFloat(bs, value[, compressed])

bitStreamWriteString

Описание: Записывает строку в поток BitStream

Сигнатура: bitStreamWriteString(bs, str, len[, encode])

bitStreamWriteWord

Описание: Записывает 2 байта в поток BitStream

Сигнатура: bitStreamWriteWord(bs, value[, compressed])

clickTextDraw

Описание: Отправка клика по текстдраву

Сигнатура: clickTextDraw(textDrawId)

connect

Описание: Подключение бота к текущему серверу

Сигнатура: connect()

coordMasterStart

Описание: Запустить коордмастер

Сигнатура: coordMasterStart(posX, posY, posZ)

coordMasterState

Описание: Получить текущее состояние коордмастера

Сигнатура: coordMasterState()

coordMasterStop

Описание: Остановить работу коордмастера

Сигнатура: coordMasterStop()

createDialog

Описание: Функция, создающая оффлайн диалог

Сигнатура: createDialog(dialogId, dialogStyle, title, btn1, btn2, text)

defCallAdd

Описание: Создать отложенный вызов функции

Сигнатура: defCallAdd(delay, repeat, func[, params])

defCallDelete

Описание: Удалить отложенный вызов функции

Сигнатура: defCallDelete(defCallId)

disconnect

Описание: Отключить бота от сервера

Сигнатура: disconnect(timeout)

Примечание:

Аргумент timeout - bool (true/false), с таймаутом или без

downloadFile

Описание: Загрузить файл по ссылке

Сигнатура: downloadFile(url, file)

dumpMem

Описание: Получение строки дампа участка памяти

Сигнатура: dumpMem(data, size)

enterVehicle

Описание: Сесть в транспортное средство

Сигнатура: enterVehicle(vehicleId, seatId)

exit

Описание: Выход из бота(закрытие окна)

Сигнатура: exit()

exitVehicle

Описание: Выйти из текущего транспортного средства

Сигнатура: exitVehicle()

getAnimation

Описание: Получение текущей анимации бота

Сигнатура: getAnimation()

getArmour

Описание: Получить текущее количество брони

Сигнатура: getArmour()

getBotId

Описание: Получение id текущего бота

Сигнатура: getBotId()

getBotState

Описание: Получение состояния бота

Сигнатура: getBotState()

Информация: Функция возвращает одно из следующих значений:

0 - "Подключение"
1 - "Пешеход"
2 - "Водитель"
3 - "Пассажир"
4 - "Наблюдатель"
5 - "Садится в машину"

getBotVehicle

Описание: Получение id транспортного средства бота

Сигнатура: getBotVehicle()

getCheckpoint

Описание: Возвращает информацию о текущем чекпоинте

Сигнатура: getCheckpoint()

Возвращаемый массив: distance, size, position[x, y, z]

Информация:

distance - дистанция до чекпоинта
size - размер (диаметр) чекпоинта
position[x, y, z] - координаты чекпоинта

getDialog

Описание: Получение информации о последнем показанном диалоге (или текущем)

Сигнатура: getDialog()

Возвращаемый массив: { isActive, cancelButtonText, title, isOffline, okButtonText, id, style, text }

Информация:

isActive - показан ли диалог на данный момент
cancelButtonText - текст второй кнопки
title - заголовок диалога
isOffline - оффлайн диалог (функция createDialog)
okButtonText - текст первой кнопки
id - id диалога
style - стиль диалога (https://sampwiki.blast.hk/wiki/Dialog_Styles_RU)
text - текст диалога

getHealth

Описание: Получение текущего ХП бота

Сигнатура: getHealth()

getIniString

Описание: Получить значение из INI файла

Сигнатура: getIniString(file, section, key)

getKeys

Описание: Получение "нажатых" клавиш из исходящей синхронизации

Сигнатура: getKeys()

getMail

Описание: Получение текущего e-mail для регистрации

Сигнатура: getMail()

getMoney

Описание: Получить текущее количество денег бота(на руках)

Сигнатура: getMoney()

getNickName

Описание: Получение ника текущего бота

Сигнатура: getNickName()

getObject

Описание: Получение информации и объекте

Сигнатура: getObject(objectId)

Возвращаемый массив: { objectId, rotation[x, y, z], position[x, y, z], id, model, drawDistance, distance }

Примечание: objectId в возвращаемом массиве содержит неверный ID объекта, неизвестно, для чего он добавлен внутри массива.

Информация:

objectId - ? (неизвестно для чего было добавлено, не содержит верный id объекта)
rotation[x, y, z] - наклоны объекта по осям
position[x, y, z] - координаты объекта
id - id объекта
model - модель объекта
drawDistance - дистанция прорисовки
distance - дистанция до объекта

getPassword

Описание: Получение пароля текущего бота

Сигнатура: getPassword()

getPickup

Описание: Получение информации о пикапе

Сигнатура: getPickup(pickupId)

Возвращаемый массив: { position[x, y, z], id, type, model, distance }

Информация:

position[x, y, z] - координаты пикапа
id - id пикапа
type - тип пикапа (https://sampwiki.blast.hk/wiki/PickupTypes)
model - модель пикапа
distance - дистанция до пикапа

getPing

Описание: Получение пинга бота

Сигнатура: getPing()

getPlayer

Описание: Получение информации и игроке

Сигнатура: getPlayer(playerId)

Возвращаемый массив: { inCar, id, health, speed[x, y, z], distance, score, anim[animFlags, animId], ping, armour, quaternion[x, y, z, w], weapon, position[x, y, z], isAdmin, state, inStream, name, keys[udAnalog, keys, lrAnalog] }

Информация:

inCar - в транспорте ли игрок
id - id игрока
health - здоровье игрока
speed[x, y, z] - таблица со скоростями игрока по осям
distance - дистанция до игрока
score - уровень игрока
anim[animFlags, animId] - таблица с флагами и id анимации игрока
ping - пинг игрока
armour - броня игрока
quaternion[x, y, z, w] - кватернион игрока
weapon - id оружия в руке игрока
position[x, y, z] - позиция игрока
isAdmin - админ ли игрок (проверяется по админ списку ракбота)
state - состояние игрока (1 - на ногах, 2 - водитель, 3 - пассажир)
inStream - в зоне стрима ли игрок
name - ник игрока
keys[udAnalog, keys, lrAnalog] - клавиши игрока (?)

getPlayersCount

Описание: Получение количества игроков на сервере

Сигнатура: getPlayersCount()

getPosition

Описание: Получение координат бота

Сигнатура: getPosition()

getQuaternion

Описание: Получение кватерниона бота

Сигнатура: getQuaternion()

getRaceCheckpoint

Описание: Получает информацию о гоночном чекпоинте

Сигнатура: getRaceCheckpoint()

Возвращаемый массив: { size, type, distance, position[x, y, z], nextPosition[x, y, z] }

Информация:

size - размер (диаметр) чекпоинта
type - тип чекпоинта (https://sampwiki.blast.hk/wiki/SetPlayerRaceCheckpoint)
distance - дистанция до чекпоинта
position[x, y, z] - координаты чекпоинта
nextPosition[x, y, z] - координаты следующего чекпоинта

getRakBotPath

Описание: Получить путь относительно корневой папки бота

Сигнатура: getRakBotPath(append)

getReconnectDelay

Описание: Получить значение задержки переподключения из конфига RakBot (+500мс)

Сигнатура: getReconnectDelay()

getReferer

Описание: Получение текущего рефферала для регистрации

Сигнатура: getReferer()

getRegKey

Описание: Получение ключа активации RakBot

Сигнатура: getRegKey()

getScore

Описание: Получение уровня бота

Сигнатура: getScore()

getServerAddress

Описание: Получение IP адреса текущего сервера

Сигнатура: getServerAddress()

getServerName

Описание: Получение названия текущего сервера

Сигнатура: getServerName()

getServerPassword

Описание: Получение текущего пароля сервера

Сигнатура: getServerPassword()

getSex

Описание: Получение пола для регистрации

Сигнатура: getSex()

getSkin

Описание: Получение id скина текущего бота

Сигнатура: getSkin()

getSpeed

Описание: Получение скорости бота по координатам

Сигнатура: getSpeed()

getVehicle

Описание: Получение информации о автомобиле

Сигнатура: getVehicle(vehicleId)

Возвращаемый массив: { id, health, speed[x, y, z], gearState, quaternion[x, y, z], position[x, y, z], engine, trainSpeed, class, firstColor, trailerId, seatsAmount, secondColor, distance, model, lights, passengers[seatId = playerId], name, siren }

Информация:

id - id транспорта
health - здоровье транспорта
speed[x, y, z] - скорость транспорта по осям
gearState - состояние колес (?)
quaternion[x, y, z, w] - кватернион транспорта
position[x, y, z] - координаты транспорта
engine - запущен ли двигатель
trainSpeed - скорость поезда (?)
class - id класса (?)
firstColor - первый цвет транспорта
trailerId - id прицепа (0, если отсутствует)
seatsAmount - количество мест (включая водительское)
secondColor - второй цвет транспорта
distance - дистанция до автомобиля
model - модель транспорта
lights - включены ли фары
passengers[id места = id последнего игрока, который на нем сидел] - таблица с информацией о пассажирских местах
name - название транспорта
siren - установлена ли сирена (баг: если сирена установлена через addSiren, то данный элемент будет возвращать false)

getWeapon

Описание: Получить id оружия в руках бота

Сигнатура: getWeapon()

hideDialog

Описание: Функция, которая скрывает открытый диалог

Сигнатура: hideDialog()

isBotConnected

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

Сигнатура: isBotConnected()

isBotSpawned

Описание: Получение состояния спавна бота

Сигнатура: isBotSpawned()

isConnectRequested

Описание: Получить состояние процесса подключения к серверу

Сигнатура: isConnectRequested()

isGameInited

Описание: Получить состояние инициализации игры

Сигнатура: isGameInited()

messageBox

Описание: Показывает окно с указанным текстом

Сигнатура: messageBox(message)

openUrl

Описание: Отправка GET запроса по ссылке через сетевой адаптер, указанный в custom.ini

Сигнатура: openUrl(url)

printLog

Описание: Вывод строки в лог-окно бота

Сигнатура: printLog(text)

randomString

Описание: Генерация случайной строки

Сигнатура: randomString(len, numbers)

reconnect

Описание: Перезаход на сервер

Сигнатура: reconnect(reconnectDelay)

requestClass

Описание: Отправляет запрос серверу на смену класса

Сигнатура: requestClass(classId)

requestSpawn

Описание: Отправляет запрос серверу на спавн

Сигнатура: requestSpawn()

reset

Описание: Функция, которая сбрасывает состояние бота

Сигнатура: reset(reconnect)

runCommand

Описание: Печать строки в лог окно программы

Сигнатура: runCommand(command)

sendDialog

Описание: Отправляет серверу информацию об использовании диалога

Сигнатура: sendDialog(dialogId, button, item, input)

sendInput

Описание: Отправка сообщения серверу (команда или чат)

Сигнатура: sendInput(input)

sendPacket

Описание: Функция, которая отправляет пакет на сервер

Сигнатура: sendPacket(bs)

sendPickup

Описание: Отправляет серверу информацию о поднятии пикапа и телепортируется к нему

Сигнатура: sendPickup(pickupId, checkDist)

Примечание: Чтобы бот не телепортировался, определите эту функцию до вызова sendPickup

sendRpc

Описание: Функция, которая отправляет RPC на сервер

Сигнатура: sendRpc(id, bs)

sendSpawn

Описание: Отправляет серверу информацию о спавне

Сигнатура: sendSpawn()

sendSync

Описание: Обновление позиции бота

Сигнатура: sendSync()

sendVkNotify

Описание: Функция отправляет оповещение на страницу ВКонтакте, привязанную к учетной записи на сайте

Сигнатура: sendVkNotify(message)

setAnimation

Описание: Установить боту анимацию

Сигнатура: setAnimation(animId, animFlags)

setArmour

Описание: Установить броню боту

Сигнатура: setArmour(armour)

setHealth

Описание: Установить ХП боту

Сигнатура: setHealth(health)

setIniString

Описание: Установить значение в INI файле

Примечание: Тип аргумента value - string

Сигнатура: setIniString(file, section, key, value)

setKeys

Описание: Установка "нажатых" клавиш для исходящей синхронизации

Сигнатура: setKeys(keys, leftRightKey, upDownKey)

setMail

Описание: Установить e-mail для авторегистрации

Сигнатура: setMail(mail)

setNickName

Описание: Устанавливает новый ник боту для входа

Сигнатура: setNickName(nickname)

setOwnAutoReg

Описание: Включить собственную авторегистрацию

Сигнатура: setOwnAutoReg(state)

setPassword

Описание: Установить новый пароль для авторизации

Сигнатура: setPassword(password)

setPosition

Описание: Установить координаты боту

Сигнатура: setPosition(x, y, z)

setQuaternion

Описание: Установить кватернион боту

Сигнатура: setQuaternion(w, x, y, z)

setReconnectDelay

Описание: Установить значение задержки переподключения

Сигнатура: setReconnectDelay(delay)

setReferer

Описание: Установить ник рефферала для авторегистрации

Сигнатура: setReferer(referer)

setServerAddress

Описание: Установить новый IP адрес сервера

Сигнатура: setServerAddress(address)

setServerPassword

Описание: Устанавливает пароль сервера

Сигнатура: setServerPassword(password)

setSex

Описание: Установить пол для авторегистрации

Сигнатура: setSex(sex)

setSpeed

Описание: Установить скорость боту по координатам

Сигнатура: setSpeed(x, y, z)

setWeapon

Описание: Выдает оружие боту

Сигнатура: setWeapon(weaponId)

showDialog

Описание: Функция, которая открывает созданный диалог (сервером или Вами)

Сигнатура: showDialog()

sleep

Описание: Функция, которая замораживает выполнение функции

Сигнатура: sleep(delay)

takeCheckpoint

Описание: Функция поднятия чекпоинта

Сигнатура: takeCheckpoint()

teleport

Описание: Телепорт бота на координаты

Сигнатура: teleport(posX, posY, posZ)