UnregisterEventHandler

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 17:12, 22 November 2013 by Vis apiuser (talk) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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")