UnregisterEventHandler
From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 21:28, 30 September 2014 by Vis apiuser (talk)
Contents
unregisterEventHandler
Available since: v4.0
Unregisters an event handler function for a specific event.
Lua Syntax:
unregisterEventHandler(event, eventHandler)
Arguments
event
- "string" - The event which triggers the event handler to be called. Currently supported events: "mainLoop", "mouseEvent".
eventHandler
- "string" - The name of the lua function which is called when the event occurs.
Flags
Return Values
None.
Examples
Example 1: mainLoop
function onMainLoop()
-- do something
end
registerEventHandler("mainLoop", "onMainLoop")
-- ... later on, when the main loop event handler is not needed anymore:
unregisterEventHandler("mainLoop", "onMainLoop")