Lua Api Функции Hex Хаба, Описание функций

Делаю тему закрытой. Переодически будет обновляться. Помощь в переводе или замечания в личку.

1. События

OnLoad() and OnUnload() - Выполняется при загрузке/выгрузке скрипта.

OnError(sErrorMessage) - Выполняется при обнаружении в скрипте ошибки.
sErrorMessage - текст ошибки.

OnUserJoined() and OnUserParts() - Выполняется при входе пользователя на хаб.

OnPmToBot(iBotId, iUserId, sData) - Выполняется при получении зарегистрированным ботом приватного сообщения.
iBotId - идентификатор бота.
iUserId - идентификатор пользователя.
sData - текст сообщения.

OnTrigger(iTriggerId, iUserId, bIsPm, sParameters) - Выполняется при использовании зарегистрированного триггера.
iTriggerID - идентификатор триггера.
iUserId - идентификатор пользователя.
bIsPm - личка/глав. Чат.
sParameters - Параметры триггера.

OnCommand(iUserId, sData) - Выполняется при поступлении команды (аля $ConnectToMe, $Search, итд)
iUserId - идентификатор пользователя.
sData - текст команды.

OnUnknownCommand(iUserId, sData) - Выполняется при поступлении неизвестной хабу команды.
iUserId - идентификатор пользователя.
sData - текст команды.

OnSaveSettings() - Выполняется при сохранении настроек через GUI либо с использованием триггера.

OnNickChange(iUserId, sOldNick, sNewNick) - Выполняется при смене ника.
iUserId - идентификатор пользователя.
sOldNick - старый ник.
sNewNick - новый ник.

OnChatMessage(iUserId, sData) - Выполняется при отправке пользователем сообщения в чат.
iUserId - идентификатор пользователя.
sData - текст сообщения.

OnPublicMessage(iUserId, sData) - Выполняется при вызове плагином или скриптом Hex.Broadcast()
iUserId - идентификатор пользователя.
sData - текст сообщения.

2. Таблица Hex

Hex.Broadcast(sData) - Отправляет всем подключенным пользователям сообщение.
sData - текст сообщения. Примечание: Сообщение содержащие команды ($ConnectToMe, $RevConnectTome, $To:) не будет отправлено.

Hex.OpchatMessage(sData) - Отправляет сообщение в ОпЧат.
sData - текст сообщения.

Hex.UserCount() - Возвращает количество подключенных пользователей.

Hex.GetTopic() - Возвращает текущий топик.

Hex.SetTopic(sTopic) - Устанавливает новый топик.
sTopic - содержимое топика.

Hex.GetMOTD() - Возвращает текущее сообщение дня.

Hex.SetMOTD(sMotd) - Устанавливает новое сообщение дня.
sMotd - содержимое сообщения дня.

Hex._GetVersion() - Возвращает версию Hex хаба.

Hex.GetScriptsFolder() - Возвращает путь до папки со скриптами.

3. Класс Bot

Bot:Register(sNick) - Регистрирует бота на хабе.
sNick - ник бота.

Bot:Unregister() - Удаляет зарегистрированного бота.
sNick - ник бота.

Bot:GetBotId() - Возвращает идентификатор зарегистрированнго бота.

Bot:GetNick() - Возвращает ник зарегистрированного бота.

4. Класс HelpString

Hex.HelpString(iSection, sLanguage) - Возвращает объект типа HelpString.
iSection - 0 = Информация хаба, 1 = Команды сообщений, 2 = Команды оператора, 3 = reserved, 4 = Управление профилем, 5 = DC++ команды, 6 = Экстра
sLanguage - идентификатор языка ("RU", "EN", "UK" итд)

HelpString:SetString(sHelpString) - Функция добавляет или изменяет предыдущую строку в меню хаба (!help)
sHelpString - сообщение которое будет помещено в !help.

4. Класс User

User:SendData(sData) - Отсылает пользователю сообщение в гл. чат.
sData - Текст сообщения.Присутствие "|"(pipe) в коце сообщения обязательно! Иначе конечный пользователь не увидит сообщения.

User:Disconnect() - Отключает пользователя от хаба.

User:GetNick() - Возвращает ник пользователя. Если пользователь себя переименовал, используйте User:GetClientNick()

User:GetClientNick() - Возвращает ник пользователя установленного в клиенте.

User:GetIP() - Возвращает ip-адрес пользователя как 32-битный номер.

User:GetIPString() - Возвращает ip-адрес пользователя в привычном виде (IPv4)

User:GetOpStatus() - Возвращает статус пользователя на хабе (0 - обычный пользователь, 1 - оператор, 2 скрытый оператор)

User:SetOpStatus(iOpStatus) - Устанавливает статус пользователя на хабе.
iOpStatus - 0 - обычный пользователь, 1 - оператор, 2 скрытый оператор

User:GetUserID() - Возвращает идентификатор пользователя.

User:GetAccountID() - Возвращает идентификатор аккаунта пользователя или 0 если пользователь незарегистрирован.

User:GetProfileID() - Возвращает идентификатор профиля пользователя или -1 если пользователь незарегистрирован.

User:GetLanguage() - Возвращает выбранный пользователем язык хаба.

User:SetLanguage(sLanguage) - Устанавливает пользователю указаный язык хаба.
sLanguage - идентификатор языка ("RU", "EN", "UK" итд)

User:GetMode() - Функция возвращает имя фильтра чата установленного на пользователе.

User:SetMode(sMode) - Функция устанавливает имя фильтра чата на пользователе.
sMode - Имя фильтра чата

User:GetISPName() - Возвращает имя ISP (Internet Service Provider - организация, предоставляющая доступ в интернет конечным пользователям - организациям и частным лицам.)

User:GetAccessLevel() - Возвращает уровень доступа пользователя.

User:SetAccessLevel(iAccess) - Устанавливает уровень доступа пользователя.
iAccess - уровень доступа (от 0 до 49999)

User:BanIP(sReason, iTime) - Функция банит ip-адрес, но не отключает пользователя от хаба.
sReason - причина бана. Обязательно указывать тип бана (_ban0_, _ban1_, _ban2)
iTime - время бана. 0 - "вечный" бан.

User:BanNick(sReason, iTime) - Функция банит ник, но не отключает пользователя от хаба.
sReason - причина бана. Обязательно указывать тип бана (_ban0_, _ban1_, _ban2)
iTime - время бана. 0 - "вечный" бан.

User:BanNickIP(sReason, iTime)(sReason, iTime) - Функция банит ник и ip-адрес, но не отключает пользователя от хаба.
sReason - причина бана. Обязательно указывать тип бана (_ban0_, _ban1_, _ban2)
iTime - время бана. 0 - "вечный" бан.

User:GetFullMyINFO() - Возвращает полную строку $MyINFO пользователя.

User:GetINFO() - Возвращает строку инфо с ограничениями.

User:SetINFO(sMyINFO) - Изменяет строку $MyINFO, но не отправляет пользователям. Измененную строку получат только новые пользователи.
sMyINFO - строка $MyINFO

5. Класс UserCommand

Object:SetUserCommandString(sUserCommand) - Устанавливает меню, которое будет отослано при входе на хаб.
sUserCommand - Команда $UserCommand (максимально 512 символов)

6. Класс Trigger

Trigger:SetTrigger(sTrigger) - Устанавливает имя триггера.
sTrigger - Имя триггера (максимально 40 символов)

Trigger:GetTriggerId() - Возвращает идентификатор триггера.

7. Класс Profile

Profile:GetProfileName() - Возвращает имя профиля.

Profile:Next() - Функция получает следущий профиль. Если следущего профиля не существует или если вы не инициализировали этот объект со значением -1 то функция вернет false, в остальных случаях true.

8. Класс Timer

Timer:Start(iDueTime, iPeriod, sFunctionName) - Функция запускает таймер.
iDueTime = время до первого срабатываения таймера (минимально 1000 ms)
iPeriod = интервал таймера (минимально 250 ms)
sFunctionName = название вызываемой функции при срабатывании таймера.

Timer:Stop() - Функция останавливает таймер.

Timer:GetId() - Функция возвращает идентификатор таймера или 0 если таймер не активен.

Сообщение отредактировал Jaska - 13.10.2009, 21:08

Так же небольшой справочник по функциям хаба.
Конечно на английском языке но для разработчиков не будет думаю особой проблемы?!