myDC.ru

Здравствуйте, гость ( Вход | Регистрация )

 
 
Тема закрытаНачать новую тему

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

Теги
Jaska
сообщение 3.6.2009, 18:37
Сообщение #1


Освоившийся участник
*****

Группа: Администраторы
Сообщений: 344
Регистрация: 2.6.2008
Из: RB,Ufa
Пользователь №: 8
Спасибо сказали: 106 раз




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

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, 20:08
Причина редактирования: Описаны некоторые классы..


Спасибо сказали:
Go to the top of the page
+Quote Post
Saymon21
сообщение 22.6.2010, 22:07
Сообщение #2


Site Reliability Engineer
*********

Группа: Модераторы
Сообщений: 1 772
Регистрация: 27.6.2009
Из: Чувашия, г. Чебоксары
Пользователь №: 3 719
Спасибо сказали: 479 раз




Так же небольшой справочник по функциям хаба.
Конечно на английском языке но для разработчиков не будет думаю особой проблемы?! big_smile.gif
Прикрепленные файлы
Прикрепленный файл  HexScript_Help___CHM.rar ( 37.38 килобайт ) Кол-во скачиваний: 39
 


Спасибо сказали:
Go to the top of the page
+Quote Post

Тема закрытаНачать новую тему
1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0

Collapse

> Похожие темы

  Тема Ответов Автор Просмотров Последнее сообщение
No New Posts Topic has attachmentsУстановка хаба PtokaX 0.5.2.2 на роутер под прошивкой LEDE 2017
DC++ сервер в роутере
13 мамин_парень 2 987 13.1.2018, 19:05 Посл. сообщение: мамин_парень
No New Posts Вопрос по функции
0 000000 376 7.1.2018, 12:55 Посл. сообщение: 000000
No New Posts Topic has attachmentsСоздание хаба
не получается
7 sadira 2 171 29.8.2017, 18:21 Посл. сообщение: Tsd
No New Posts Установка Linux хаба DC++ в ANDROID
Теперь ты видел все ))
0 мамин_парень 998 5.8.2017, 9:49 Посл. сообщение: мамин_парень
No new ВАЖНО: Домены Для Вашего Хаба
Как думаете?
228 Nickolya 100 025 25.9.2016, 13:16 Посл. сообщение: Saymon21
No new Topic has attachmentsСкрипты API 2. Защита хаба. Базы TTH
Скрипты защиты от спама, флуда, рекламы, порно
40 GULAM33 20 259 24.5.2015, 16:55 Посл. сообщение: Артём
No new Topic has attachmentsОшибки текущей версии хаба
Обнаруженные ошибки публикуются в этой теме
150 Otshelnik-Fm 65 988 30.7.2014, 20:58 Посл. сообщение: Alexey
No New Posts СРОЧНО куплю домены для хаба
от 50 и выше
0 neotop 2 581 20.4.2014, 12:22 Посл. сообщение: neotop
No new votes Опрос: Какой DC Сервер Вы Используете Для Своего Хаба?
Опрос для администраторов DC хабов
44 Svyat 34 472 12.3.2014, 2:02 Посл. сообщение: dmvn
No new От: Функции Для Разработчиков
От темы с ID: 334
19 Nickolya 6 049 22.2.2014, 15:22 Посл. сообщение: Ksan
No new ВАЖНО: Topic has attachmentsФункции Для Разработчиков
склад полезных функций
68 Setuper 54 831 22.2.2014, 12:35 Посл. сообщение: Tsd
No New Posts Скрипт сообщающий о падении хаба
7 SonicX 4 229 9.12.2013, 16:44 Посл. сообщение: HackFresse
No New Posts Готовая сборка хаба
Идея создания готовой сборки RusHub
2 Enyby 4 178 10.8.2013, 22:30 Посл. сообщение: Артём
No new Topic has attachmentsАвтоматическое изменение Приветствия хаба (мода)
Можно ли реализовать такой скрипт ?
14 valera_ 7 154 3.6.2013, 12:34 Посл. сообщение: valera_
No new Запрос помощи или особенности плагиностроения для хаба
для домохозяек и пенсионеров
17 hjet 9 644 11.12.2012, 18:13 Посл. сообщение: Setuper

 



RSS Сейчас: 24.5.2018, 20:44