RemoveEventHandler

This functions removes a handler function from an event, so that the function is not called anymore when the event is triggered. See event system for more information on how the event system works.

Syntax

bool removeEventHandler ( string eventName, element attachedTo, function functionVar ) 

Required Arguments

• eventName: The name of the event you want to detach the handler function from.
• attachedTo: The element the handler was attached to.
• functionVar: The handler function that was attached.

Returns

Returns true if the event handler was removed successfully. Returns false if the specified event handler could not be found or invalid parameters were passed.

Example

This page does not have an example.

--add an example here

See Also

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• wasEventCancelled