RegisterEventHandler: Difference between revisions
Jump to navigation
Jump to search
(Created page with "==registerEventHandler== Registers an event handler function for a specific event. Lua Syntax: <pre>registerEventHandler(event, eventHandler)</pre> ===Arguments=== ====event==...") |
No edit summary |
||
| Line 11: | Line 11: | ||
====eventHandler==== | ====eventHandler==== | ||
:'''"string"''' - The name of the lua function which is called when the event occurs. The function (except for "mainLoop" event handler) should take exactly one argument which is the affected visionaire object. There are no arguments for the "mainLoop" event handler. | :'''"string"''' - The name of the lua function which is called when the event occurs. The function (except for "mainLoop" event handler) should take exactly one argument which is the affected visionaire object. There are no arguments for the "mainLoop" event handler. | ||
===Flags=== | |||
===Return Values=== | |||
None. | |||
* Documentation for Visionaire 3.7 and higher: | |||
==registerEventHandler== | |||
Registers an event handler function for a specific event. | |||
Lua Syntax: | |||
<pre>registerEventHandler(event, eventHandler [, eventFlags])</pre> | |||
===Arguments=== | |||
====event==== | |||
:'''"string"''' - The event which triggers the event handler to be called. Currently supported events: "mainLoop", "mouseEvent", "animationStarted", "animationStopped", "textStarted", "textStopped". | |||
====eventHandler==== | |||
:'''"string"''' - The name of the lua function which is called when the event occurs. The function for the events "animationStarted", "animationStopped", "textStarted" and "textStopped" should take exactly one argument which is the affected visionaire object. | |||
:There are no arguments for the "mainLoop" event handler. | |||
:The function for the "mouseEvent" takes two arguments, the first one is the mouse event (see "eventFlags" parameter) and the second argument is the current mouse position (a table containing x- and y-position). | |||
====eventFlags==== | |||
:'''{int,...}''' - Can only be specified for event "mouseEvent": a list of mouse events where the event handler is called. | |||
:Currently the following mouse events are supported: eEvtMouseMove, eEvtMouseLeftButtonDoubleClick, eEvtMouseLeftButtonDown, eEvtMouseLeftButtonUp, eEvtMouseLeftButtonHold, eEvtMouseLeftButtonHolding, eEvtMouseRightButtonDoubleClick, eEvtMouseRightButtonDown, eEvtMouseRightButtonUp, eEvtMouseWheelUp and eEvtMouseWheelDown. If no mouse event is specified then the event handler is registered for all mouse events. | |||
===Flags=== | ===Flags=== | ||
===Return Values=== | ===Return Values=== | ||
None. | None. | ||
Revision as of 23:18, 17 August 2011
registerEventHandler
Registers an event handler function for a specific event.
Lua Syntax:
registerEventHandler(event, eventHandler)
Arguments
event
- "string" - The event which triggers the event handler to be called. Currently supported events: "mainLoop", "animationStarted", "animationStopped", "textStarted", "textStopped".
eventHandler
- "string" - The name of the lua function which is called when the event occurs. The function (except for "mainLoop" event handler) should take exactly one argument which is the affected visionaire object. There are no arguments for the "mainLoop" event handler.
Flags
Return Values
None.
- Documentation for Visionaire 3.7 and higher:
registerEventHandler
Registers an event handler function for a specific event.
Lua Syntax:
registerEventHandler(event, eventHandler [, eventFlags])
Arguments
event
- "string" - The event which triggers the event handler to be called. Currently supported events: "mainLoop", "mouseEvent", "animationStarted", "animationStopped", "textStarted", "textStopped".
eventHandler
- "string" - The name of the lua function which is called when the event occurs. The function for the events "animationStarted", "animationStopped", "textStarted" and "textStopped" should take exactly one argument which is the affected visionaire object.
- There are no arguments for the "mainLoop" event handler.
- The function for the "mouseEvent" takes two arguments, the first one is the mouse event (see "eventFlags" parameter) and the second argument is the current mouse position (a table containing x- and y-position).
eventFlags
- {int,...} - Can only be specified for event "mouseEvent": a list of mouse events where the event handler is called.
- Currently the following mouse events are supported: eEvtMouseMove, eEvtMouseLeftButtonDoubleClick, eEvtMouseLeftButtonDown, eEvtMouseLeftButtonUp, eEvtMouseLeftButtonHold, eEvtMouseLeftButtonHolding, eEvtMouseRightButtonDoubleClick, eEvtMouseRightButtonDown, eEvtMouseRightButtonUp, eEvtMouseWheelUp and eEvtMouseWheelDown. If no mouse event is specified then the event handler is registered for all mouse events.
Flags
Return Values
None.