AddEvent

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 [, bool allowRemoteTrigger = false ] )   

Required Arguments

• eventName: The name of the event you wish to create.

Optional Arguments

• allowRemoteTrigger: A boolean specifying whether this event can be called from the client using triggerServerEvent or not.

Returns

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

Example

This example will define a new event called onSpecialEvent.

-- Add a new event called onSpecialEvent
addEvent ( "onSpecialEvent" )

-- Define our handler function, that takes a "text" parameter and outputs it to the chatbox
function specialEventHandler ( text )
	outputChatBox ( text )
end

-- Add it as a handler for our event
addEventHandler ( "onSpecialEvent", getRootElement(), specialEventHandler )

You can then trigger this event later on using:

	triggerEvent ( "onSpecialEvent", getRootElement(), "test" )

This will cause the handler to be triggered, so "test" will be output to the chatbox.

See Also

• getCancelReason
• triggerClientEvent
• triggerLatentClientEvent

Shared

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