Difference between revisions of "UnregisterEventHandler"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "==unregisterEventHandler== <div class="command-min-version-info">Available since: <span class="command-min-version">v3.8</span></div> <div class="command-doc">Unregisters an...")
 
Line 24: Line 24:
 
registerEventHandler("mainLoop", "onMainLoop")unregisterEventHandler("mainLoop", "onMainLoop")
 
registerEventHandler("mainLoop", "onMainLoop")unregisterEventHandler("mainLoop", "onMainLoop")
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
[[Category:Player Commands]]

Revision as of 15:57, 26 November 2013

unregisterEventHandler

Available since: v3.8
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".

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")unregisterEventHandler("mainLoop", "onMainLoop")