AddEventHandler - Revision history

Srslyyyy at 16:39, 8 April 2024

2024-04-08T16:39:25Z

← Older revision		Revision as of 16:39, 8 April 2024
Line 17:		Line 17:

	The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.		The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.
			Each function closure can only be added once to each event. On the second attempt to add the function closure to the same event a warning will be emitted to the debug console and the call to addEventHandler will fail.
	{{Note\|See [[Event_Source_Element\|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}		{{Note\|See [[Event_Source_Element\|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}

	Each function closure can only be added once to each event. On the second attempt to add the function closure to the same event a warning will be emitted to the debug console and the call to addEventHandler will fail.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Srslyyyy at 16:25, 8 April 2024

2024-04-08T16:25:39Z

← Older revision		Revision as of 16:25, 8 April 2024
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.		This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.
	{{Important Note\|See [[Script security]] for how-to prevent cheaters from abusing [[~~Event~~ system]] and [[~~Element~~ data]].}}		{{Important Note\|See [[Script security]] for how-to prevent cheaters from abusing [[event system]] and [[element data]].}}
	{{Note\|You shouldn't re-use the same name for your handler function as the event name - if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}		{{Note\|You shouldn't re-use the same name for your handler function as the event name - if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}
	Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:		Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:

Srslyyyy at 16:25, 8 April 2024

2024-04-08T16:25:23Z

← Older revision		Revision as of 16:25, 8 April 2024
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.		This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.
	{{Important Note\|See [[Script security]] for how-to prevent cheaters from abusing ~~events~~ and ~~element~~ data.}}		{{Important Note\|See [[Script security]] for how-to prevent cheaters from abusing [[Event system]] and [[Element data]].}}
	{{Note\|You shouldn't re-use the same name for your handler function as the event name - if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}		{{Note\|You shouldn't re-use the same name for your handler function as the event name - if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}
	Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:		Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:

Srslyyyy at 16:24, 8 April 2024

2024-04-08T16:24:29Z

← Older revision		Revision as of 16:24, 8 April 2024
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.		This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.
	{{Important Note\|See [[Script security]] for ~~tips on preventing~~ cheaters ~~when using~~ events and element data.}}		{{Important Note\|See [[Script security]] for how-to prevent cheaters from abusing events and element data.}}
	{{Note\|You shouldn't re-use the same name for your handler function as the event name, if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}		{{Note\|You shouldn't re-use the same name for your handler function as the event name - if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}

	Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:		Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:
	*'''source''': the element that triggered the event		*'''source''': the element that triggered the event

Srslyyyy at 16:22, 8 April 2024

2024-04-08T16:22:46Z

← Older revision		Revision as of 16:22, 8 April 2024
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{Important Note\|Do '''NOT''' use the same name for your handler function as the event name, as this can lead to confusion if multiple handler functions are used. On the same note, for multiple reasons, it is '''NOT''' a good idea to export the same functions that you use locally as remote event handlers.}}
	This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.		This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.
	{{Important Note\|See [[Script security]] for tips on preventing cheaters when using events and element data.}}		{{Important Note\|See [[Script security]] for tips on preventing cheaters when using events and element data.}}
			{{Note\|You shouldn't re-use the same name for your handler function as the event name, if multiple handler functions are used, as this can lead to confusion. On the same note, for multiple reasons, it isn't a good idea to export the same functions that you use locally as remote event handlers.}}

	Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:		Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:

Srslyyyy at 16:20, 8 April 2024

2024-04-08T16:20:46Z

← Older revision		Revision as of 16:20, 8 April 2024
Line 3:		Line 3:
	{{Important Note\|Do '''NOT''' use the same name for your handler function as the event name, as this can lead to confusion if multiple handler functions are used. On the same note, for multiple reasons, it is '''NOT''' a good idea to export the same functions that you use locally as remote event handlers.}}		{{Important Note\|Do '''NOT''' use the same name for your handler function as the event name, as this can lead to confusion if multiple handler functions are used. On the same note, for multiple reasons, it is '''NOT''' a good idea to export the same functions that you use locally as remote event handlers.}}
	This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.		This function will add an [[event]] handler. An event handler is a function that will be called when the event it's attached to is triggered. See [[event system]] for more information on how the event system works.
	{{Important Note\|See ~~code~~ for ~~this note below~~}}		{{Important Note\|See [[Script security]] for tips on preventing cheaters when using events and element data.}}

	Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:		Event handlers are functions that are called when a particular event happens. Each event specifies a specific set of variables that are passed to the event handler and can be read by your function. The following global variables are available for use in handler functions:
Line 18:		Line 18:

	The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.		The order in which event handlers are triggered is undefined, you should not rely on one event handler being executed before another.
	~~{{Note\|See [[Script security]] for tips on preventing cheaters when using events and element data}}~~
	{{Note\|See [[Event_Source_Element\|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}		{{Note\|See [[Event_Source_Element\|Event Source Element]] for a descriptive visualization of the event system handling an event trigger.}}

Icensow: Fixed misinfo about sourceResourceRoot on client

2024-02-16T15:20:37Z

Fixed misinfo about sourceResourceRoot on client

← Older revision		Revision as of 15:20, 16 February 2024
Line 9:		Line 9:
	*'''this''': the element that the event handler is attached to		*'''this''': the element that the event handler is attached to
	*'''sourceResource''': the resource that triggered the event.		*'''sourceResource''': the resource that triggered the event.
	*'''sourceResourceRoot''': the root element of the resource that triggered the event.		*'''sourceResourceRoot''': the root element ([[getResourceDynamicElementRoot\|dynamic element root]] on client) of the resource that triggered the event.
	*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.		*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.
	{{New_feature\|3\|1.0\|		{{New_feature\|3\|1.0\|

Newton: remove wrong information about sourceResource and sourceResourceRoot global variables

2023-11-11T18:05:37Z

remove wrong information about sourceResource and sourceResourceRoot global variables

← Older revision		Revision as of 18:05, 11 November 2023
Line 8:		Line 8:
	*'''source''': the element that triggered the event		*'''source''': the element that triggered the event
	*'''this''': the element that the event handler is attached to		*'''this''': the element that the event handler is attached to
	*'''sourceResource''': the resource that triggered the event~~. Not set if the event was not triggered from a client~~.		*'''sourceResource''': the resource that triggered the event.
	*'''sourceResourceRoot''': the root element of the resource that triggered the event~~. Not set if the event was not triggered from a client~~.		*'''sourceResourceRoot''': the root element of the resource that triggered the event.
	*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.		*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.
	{{New_feature\|3\|1.0\|		{{New_feature\|3\|1.0\|

Nikoo834: Adding warning messages to sourceResource and sourceResourceRoot.

2023-02-07T15:14:19Z

Adding warning messages to sourceResource and sourceResourceRoot.

← Older revision		Revision as of 15:14, 7 February 2023
Line 8:		Line 8:
	*'''source''': the element that triggered the event		*'''source''': the element that triggered the event
	*'''this''': the element that the event handler is attached to		*'''this''': the element that the event handler is attached to
	*'''sourceResource''': the resource that triggered the event		*'''sourceResource''': the resource that triggered the event. Not set if the event was not triggered from a client.
	*'''sourceResourceRoot''': the root element of the resource that triggered the event		*'''sourceResourceRoot''': the root element of the resource that triggered the event. Not set if the event was not triggered from a client.
	*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.		*'''client''': the client that triggered the event using [[triggerServerEvent]]. Not set if the event was not triggered from a client.
	{{New_feature\|3\|1.0\|		{{New_feature\|3\|1.0\|

Skully: Fix invalid characters.

2022-06-26T00:56:26Z

Fix invalid characters.

← Older revision		Revision as of 00:56, 26 June 2022
Line 28:		Line 28:

	===Required Arguments===		===Required Arguments===
	*'''eventName:''' The name of the [[event]] you want to attach the handler function to. '''Note: The maximum allowed length is 100 ASCII characters (that is, English letters and numerals)~~```~~		*'''eventName:''' The name of the [[event]] you want to attach the handler function to. '''Note: The maximum allowed length is 100 ASCII characters (that is, English letters and numerals)'''
	*'''attachedTo:''' The [[element]] you wish to attach the handler to. The handler will only be called when the event it is attached to is triggered for this element, or one of its children. Often, this can be the root element (meaning the handler will be called when the event is triggered for ''any'' element).		*'''attachedTo:''' The [[element]] you wish to attach the handler to. The handler will only be called when the event it is attached to is triggered for this element, or one of its children. Often, this can be the root element (meaning the handler will be called when the event is triggered for ''any'' element).
	*'''handlerFunction:''' The handler function you wish to call when the event is triggered. This function will be passed all of the event's parameters as arguments, but it isn't required that it takes all of them.		*'''handlerFunction:''' The handler function you wish to call when the event is triggered. This function will be passed all of the event's parameters as arguments, but it isn't required that it takes all of them.