AddEvent

	This article needs checking.
	Reason(s): Event handlers aren't coded in the map structure anymore, so the second parameter is not necessary anymore (it doesn't limit the argument number either). --jbeta

This function allows you to register a custom event. Custom events function exactly like the built in events. See event system for more information on the event system.

Syntax

bool addEvent ( string eventName, string arguments )   

Required Arguments

• eventName: The name of the event you wish to create
• arguments: A string of comma seperated variable names indicating the arguments your event takes. These names are used for event handlers that are coded in the map structure. For example "message, playerName".

Returns

Returns true if the event was added successfully, false otherwise.

Example

This example will define a new event called onSpecialEvent.

-- Get the root map element
rootElement = getRootElement ()

-- Add a new event called onSpecialEvent that has one parameter 'text'
addEvent ( "onSpecialEvent", "text" )

-- Add an event handler
addEventHandler ( "onSpecialEvent", rootElement, "specialEventHandler" )
-- Define our handler function
function specialEventHandler ( text )
	outputChatBox ( text )
end

You can then trigger this event later on using:

	triggerEvent ( "onSpecialEvent", rootElement, "test" )

See Also

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