TriggerEvent - Revision history

Srslyyyy: /* Example */

2024-04-08T19:35:07Z

Example

← Older revision		Revision as of 19:35, 8 April 2024
Line 28:		Line 28:
	If you define a new custom event as follows:		If you define a new custom event as follows:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEvent('onMyCustomEvent', true)~~		function onCustomEvent(chatMessage)
	~~addEventHandler('onMyCustomEvent', root,~~ function(chatMessage)		outputChatBox(chatMessage)
	outputChatBox(chatMessage)		end
	end)		addEvent("onCustomEvent", false) -- set to false, so this event won't be called from counter side - important security measure
			addEventHandler("onCustomEvent", root, onCustomEvent)
	</syntaxhighlight>		</syntaxhighlight>

	You can then trigger this event later on using:		You can then trigger this event later on using:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	triggerEvent(~~'onMyCustomEvent'~~, ~~root~~, 'Hello, ~~World~~!')		triggerEvent("onCustomEvent", resourceRoot, "Hello, world!")
	</syntaxhighlight>		</syntaxhighlight>

Tracer: Updated to the newest standards

2022-11-23T15:04:27Z

Updated to the newest standards

← Older revision		Revision as of 15:04, 23 November 2022
Line 28:		Line 28:
	If you define a new custom event as follows:		If you define a new custom event as follows:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEvent(~~"onSpecialEvent"~~, true)		addEvent('onMyCustomEvent', true)
	addEventHandler(~~"onSpecialEvent"~~, ~~getRootElement()~~,		addEventHandler('onMyCustomEvent', root, function(chatMessage)
	function(chatMessage)		outputChatBox(chatMessage)
	outputChatBox(chatMessage)		end)
	end
	)
	</syntaxhighlight>		</syntaxhighlight>

	You can then trigger this event later on using:		You can then trigger this event later on using:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~triggerServerEvent~~(~~"onSpecialEvent"~~, ~~getRootElement()~~, ~~"testMessage"~~)		triggerEvent('onMyCustomEvent', root, 'Hello, World!')
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

	[[ru:triggerEvent]]		[[ru:triggerEvent]]

Nikoo.: /* Example */

2022-11-18T19:48:40Z

Example

← Older revision		Revision as of 19:48, 18 November 2022
Line 28:		Line 28:
	If you define a new custom event as follows:		If you define a new custom event as follows:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Add a new event called onSpecialEvent~~		addEvent("onSpecialEvent", true)
	addEvent ( "onSpecialEvent", true )		addEventHandler("onSpecialEvent", getRootElement(),
	~~-- Define our handler function~~		function(chatMessage)
	function ~~specialEventHandler~~ ( ~~text~~ )		outputChatBox(chatMessage)
	outputChatBox ( ~~text~~ )		end
	end		)
	~~-- Add the event handler~~
	~~addEventHandler ( "onSpecialEvent", root, specialEventHandler~~ )
	</syntaxhighlight>		</syntaxhighlight>

	You can then trigger this event later on using:		You can then trigger this event later on using:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~triggerEvent~~ ( "onSpecialEvent", ~~root~~, "~~test~~" )		triggerServerEvent("onSpecialEvent", getRootElement(), "testMessage")
	</syntaxhighlight>		</syntaxhighlight>

AlexTMjugador: Display spaces instead of underscores in the recently added link

2017-04-07T14:38:16Z

Display spaces instead of underscores in the recently added link

← Older revision		Revision as of 14:38, 7 April 2017
Line 5:		Line 5:
	You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.		You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.
	{{Note\|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}		{{Note\|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}
	{{Note\|See [[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.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Necktrox: Added Event_Source_Element note

2017-04-05T13:52:34Z

Added Event_Source_Element note

← Older revision		Revision as of 13:52, 5 April 2017
Line 5:		Line 5:
	You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.		You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.
	{{Note\|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}		{{Note\|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}
			{{Note\|See [[Event_Source_Element]] for a descriptive visualization of the event system handling an event trigger.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ccw at 22:05, 24 November 2013

2013-11-24T22:05:08Z

← Older revision		Revision as of 22:05, 24 November 2013
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	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.		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.

	You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.

	You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.		You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.
			{{Note\|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Callum: Removed useless rootElement variable from example.

2012-06-25T10:56:11Z

Removed useless rootElement variable from example.

← Older revision		Revision as of 10:56, 25 June 2012
Line 29:		Line 29:
	If you define a new custom event as follows:		If you define a new custom event as follows:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Get the root map element~~
	~~rootElement = getRootElement ()~~

	-- Add a new event called onSpecialEvent		-- Add a new event called onSpecialEvent
	addEvent ( "onSpecialEvent", true )		addEvent ( "onSpecialEvent", true )
Line 39:		Line 36:
	end		end
	-- Add the event handler		-- Add the event handler
	addEventHandler ( "onSpecialEvent", ~~rootElement~~, specialEventHandler )		addEventHandler ( "onSpecialEvent", root, specialEventHandler )
	</syntaxhighlight>		</syntaxhighlight>

	You can then trigger this event later on using:		You can then trigger this event later on using:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	triggerEvent ( "onSpecialEvent", ~~rootElement~~, "test" )		triggerEvent ( "onSpecialEvent", root, "test" )
	</syntaxhighlight>		</syntaxhighlight>

Damage22 at 21:17, 8 July 2010

2010-07-08T21:17:43Z

← Older revision		Revision as of 21:17, 8 July 2010
Line 49:		Line 49:
	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}
			[[ru:triggerEvent]]

Bardokas: /* Example */

2008-02-16T18:59:51Z

Example

← Older revision		Revision as of 18:59, 16 February 2008
Line 33:		Line 33:

	-- Add a new event called onSpecialEvent		-- Add a new event called onSpecialEvent
	addEvent ( "onSpecialEvent", ~~"text"~~ )		addEvent ( "onSpecialEvent", true )
	-- Define our handler function		-- Define our handler function
	function specialEventHandler ( text )		function specialEventHandler ( text )

EAi at 23:07, 6 December 2007

2007-12-06T23:07:16Z

← Older revision		Revision as of 23:07, 6 December 2007
Line 3:		Line 3:
	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.		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.

	You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.		You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the element tree, which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.

			You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an ''onFlagCapture'' event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have ''onPlayerKill'' as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.

	==Syntax==		==Syntax==