TriggerEvent

	This article needs checking.
	Reason(s): What does this return?

This function will trigger a named event on a specific element in the element tree. See event system for more information on how the event system works.

Syntax

bool triggerEvent ( string eventName, element baseElement, [ var argument1, ... ] )    

Required Arguments

• eventName: The name of the event you wish to trigger
• baseElement: The element you wish to trigger the event on. See event system for information on how this works.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

• argument1: The arguments that the event handler expects should be added after the baseElement variable.

Example

If you define a new custom event as follows:

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

-- Add a new event called onSpecialEvent
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
• getCancelReason
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• triggerClientEvent
• triggerLatentClientEvent
• wasEventCancelled