Difference between revisions of "RegisterEventHandler"
(→RegisterEventHandler(...) =) |
|||
| Line 22: | Line 22: | ||
|- | |- | ||
| (string)mEventIdentifier: || Event Identifier of the specific event (described in the [[http://shardsonline.com/lN2rwhz4jSVambqesEBZ/lua-reference/events.html Events]] section of the documentation | | (string)mEventIdentifier: || Event Identifier of the specific event (described in the [[http://shardsonline.com/lN2rwhz4jSVambqesEBZ/lua-reference/events.html Events]] section of the documentation | ||
| − | | | + | |- |
| (function)mEventHandler: || Handler function reference. Can be a function name or a function defined inline. | | (function)mEventHandler: || Handler function reference. Can be a function name or a function defined inline. | ||
|} | |} | ||
Revision as of 18:49, 1 November 2016
RegisterEventHandler official Doc
RegisterSingleEventHandler official Doc
OverrideEventHandler official Doc
RegisterEventHandler(...) =
| Function Type: | Engine API |
| Function Category: | Global |
Description
Registers an event handler which calls the specified function when the Events fires with a matching event identifier.
Prototype
RegisterEventHandler( (EventType)mEvent, (string)mEventIdentifier, (function)mEventHandler)
Parameters:
| (LuaEventType) mEvent: | The event type the handler shall respond to (EventType.Message, EventType.Timer, etc ...) |
| (string)mEventIdentifier: | Event Identifier of the specific event (described in the [Events] section of the documentation |
| (function)mEventHandler: | Handler function reference. Can be a function name or a function defined inline. |
Return Values
(boolean) mBool: True on success. False otherwise.
Notes and Caveats
These handlers are not saved and must be registered every time the object is loaded.
