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

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• allowRemoteTrigger (default: false): A boolean specifying whether this event can be called remotely using triggerClientEvent / triggerServerEvent or not.

Returns

• bool: result

Returns true if the event was added successfully, otherwise false if the event already exists built-in game events or if it fails for any other reason.

Code Examples

shared

This example will define a new event.

addEvent("onSpecialEvent", true)

function specialEventHandler(text)
  outputChatBox(text)
end
addEventHandler("onSpecialEvent", root, specialEventHandler)

See Also

Event Functions

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getCancelReason
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerClientEvent
• triggerEvent
• triggerLatentClientEvent
• triggerLatentServerEvent
• triggerServerEvent
• wasEventCancelled

Reference

• Scripting Functions