AddEvent: Difference between revisions

Latest revision as of 07:58, 4 November 2020

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 remotely using triggerClientEvent / triggerServerEvent or not.

Returns

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

Example

This example will define a new event called onSpecialEvent.

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

-- 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", root, specialEventHandler )

You can then trigger this event later on using:

	triggerEvent ( "onSpecialEvent", root, "test" )

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

@@ Line 1: / Line 1: @@
 __NOTOC__
-This function allows you to define an [[event]]. These function exactly like the built in events. See [[event system]] for more information on the event system.
+{{Server client function}}
+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==
 <syntaxhighlight lang="lua">
-bool addEvent ( string eventName, string arguments )
+bool addEvent ( string eventName [, bool allowRemoteTrigger = false ] )
 </syntaxhighlight>
 ===Required Arguments===
-*'''eventName:''' The name of the event you wish to create
+*'''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".
+===Optional Arguments===
+*'''allowRemoteTrigger:''' A boolean specifying whether this event can be called remotely using [[triggerClientEvent]] / [[triggerServerEvent]] or not.
 ===Returns===
-Returns ''true'' if the event was added successfully, ''false'' otherwise.
+Returns ''true'' if the event was added successfully, ''false'' if the event was already added.
 ==Example==
-This example will define a new event called ''onSpecialEvent''. You could trigger this later using [[triggerEvent]].
+This example will define a new event called ''onSpecialEvent''.
 <syntaxhighlight lang="lua">
--- Get the root map element
+-- Add a new event called onSpecialEvent
-rootElement = getRootElement ()
+addEvent ( "onSpecialEvent", true )
--- Add a new event called onSpecialEvent that has one parameter 'text'
-addEvent ( "onSpecialEvent", "text" )
--- Add an event handler
+-- Define our handler function, that takes a "text" parameter and outputs it to the chatbox
-addEventHandler ( "onSpecialEvent", rootElement, "specialEventHandler" )
--- Define our handler function
 function specialEventHandler ( text )
 	outputChatBox ( text )
 end
+-- Add it as a handler for our event
+addEventHandler ( "onSpecialEvent", root, specialEventHandler )
+</syntaxhighlight>
+You can then trigger this event later on using:
+<syntaxhighlight lang="lua">
+	triggerEvent ( "onSpecialEvent", root, "test" )
 </syntaxhighlight>
+This will cause the handler to be triggered, so "test" will be output to the chatbox.
 ==See Also==
 {{Event functions}}
+[[ru:addEvent]]