RU/addEvent: Difference between revisions
Jump to navigation
Jump to search
(Blanked the page) |
|||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{RU/Server_client_function}} | |||
Эта функция позволяет вам зарегистрировать свое собственное событие ( [[event]] ). Созданные вами события работают точно по такому же принципу, как и встроенные. Подробнее о системе событий в статье [[event system]]. | |||
==Синтаксис== | |||
<syntaxhighlight lang="lua"> | |||
bool addEvent ( string eventName [, bool allowRemoteTrigger = false ] ) | |||
</syntaxhighlight> | |||
===Обязательные аргументы=== | |||
*'''eventName:''' Название создаваемого вами события. | |||
===Дополнительные аргументы=== | |||
*'''allowRemoteTrigger:''' Логическая (boolean) переменная, которая определяет, может ли это событие быть вызванным удаленно с помощью функций [[RU/triggerClientEvent|triggerClientEvent]] / [[RU/triggerServerEvent|triggerServerEvent]] или нет. | |||
===Вывод функции=== | |||
Возвращает ''true'' если событие было успешно создано, ''false'' в противном случае. | |||
==Пример== | |||
В этом примере мы создадим новое событие под названием ''onSpecialEvent''. | |||
<syntaxhighlight lang="lua"> | |||
-- Добавить новое событие под названием "onSpecialEvent" | |||
addEvent ( "onSpecialEvent", true ) | |||
-- Описываем функцию для обработки, которая принимает параметр "text" и выводит его в чат | |||
function specialEventHandler ( text ) | |||
outputChatBox ( text ) | |||
end | |||
-- Добавляем эту функцию, как обработчик нашего нового события | |||
addEventHandler ( "onSpecialEvent", getRootElement(), specialEventHandler ) | |||
</syntaxhighlight> | |||
Затем вы можете вызвать это событие с помощью функции triggerEvent: | |||
<syntaxhighlight lang="lua"> | |||
triggerEvent ( "onSpecialEvent", getRootElement(), "test" ) | |||
</syntaxhighlight> | |||
Это приведет к тому, что сработает обработчик события, и в чат будет выведен текст "test" | |||
==Смотрите также== | |||
{{RU/Event functions}} | |||
[[en:addEvent]] |
Latest revision as of 03:06, 1 April 2016
Эта функция позволяет вам зарегистрировать свое собственное событие ( event ). Созданные вами события работают точно по такому же принципу, как и встроенные. Подробнее о системе событий в статье event system.
Синтаксис
bool addEvent ( string eventName [, bool allowRemoteTrigger = false ] )
Обязательные аргументы
- eventName: Название создаваемого вами события.
Дополнительные аргументы
- allowRemoteTrigger: Логическая (boolean) переменная, которая определяет, может ли это событие быть вызванным удаленно с помощью функций triggerClientEvent / triggerServerEvent или нет.
Вывод функции
Возвращает true если событие было успешно создано, false в противном случае.
Пример
В этом примере мы создадим новое событие под названием onSpecialEvent.
-- Добавить новое событие под названием "onSpecialEvent" addEvent ( "onSpecialEvent", true ) -- Описываем функцию для обработки, которая принимает параметр "text" и выводит его в чат function specialEventHandler ( text ) outputChatBox ( text ) end -- Добавляем эту функцию, как обработчик нашего нового события addEventHandler ( "onSpecialEvent", getRootElement(), specialEventHandler )
Затем вы можете вызвать это событие с помощью функции triggerEvent:
triggerEvent ( "onSpecialEvent", getRootElement(), "test" )
Это приведет к тому, что сработает обработчик события, и в чат будет выведен текст "test"
Смотрите также
Серверные функции
- getCancelReason - получает причину отмены события
- triggerClientEvent - позволяет вызвать срабатывание события, предварительно созданного на клиенте
- triggerLatentClientEvent - аналог triggerClientEvent, но скорость передачи может быть ограничена
Клиентские функции
- triggerLatentServerEvent - аналог triggerServerEvent, но скорость передачи может быть ограничена
- triggerServerEvent - позволяет вызвать срабатывание события, предварительно созданного на сервере
Общие функции
- addEvent - позволяет зарегистрировать своё собственное событие
- addEventHandler - прикрепляет к событию обработчик
- cancelEvent - останавливает автоматическую внутреннюю обработку события
- cancelLatentEvent - останавливает автоматическую внутреннюю обработку скрытого события
- getEventHandlers - получает прикреплённые функции из события и присоединённый элемент из текущего lua-скрипта
- getLatentEventHandles - получает текущие скрытые события в очереди
- getLatentEventStatus - получает состояние одного скрытого события в очереди
- removeEventHandler - открепляет от события обработчик
- triggerEvent - вызывает срабатывание указанного события для указанного элемента в дереве элементов
- wasEventCancelled - проверяет, было ли отменено последнее завершённое событие