TriggerClientEvent - Revision history

Fernando187: /* Examples */

2025-06-08T13:50:51Z

Examples

← Older revision		Revision as of 13:50, 8 June 2025
Line 64:		Line 64:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 81:		Line 83:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.~~

	This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).		This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

Fernando187: /* Examples */

2025-06-08T13:50:29Z

Examples

← Older revision		Revision as of 13:50, 8 June 2025
Line 42:		Line 42:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>



	When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.		When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

Fernando187: /* Examples */

2025-06-08T13:50:17Z

Examples

← Older revision		Revision as of 13:50, 8 June 2025
Line 42:		Line 42:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>



			When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 50:		Line 54:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

	This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.		This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

Fernando187: Fix examples header

2025-06-08T13:49:53Z

Fix examples header

← Older revision		Revision as of 13:49, 8 June 2025
Line 30:		Line 30:
	Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.		Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

	==~~Example==~~		==Examples==
	~~===Example 1=~~==
	This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.		This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

Line 54:		Line 53:
	When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.		When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

	~~===Example 2===~~
	This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.		This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

Line 86:		Line 84:
	This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.		This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

	~~===Example 3===~~
	This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).		This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

FileEX: /* See Also */

2024-09-06T22:33:16Z

AirNewSCR: Added example 3 (with resourceRoot)

2024-06-25T08:36:53Z

Added example 3 (with resourceRoot)

← Older revision		Revision as of 08:36, 25 June 2024
Line 85:		Line 85:

	This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.		This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

			===Example 3===
			This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

			<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">
			function nameFunction(message)
			if source == resourceRoot then
			outputChatBox(message)
			end
			end
			addEvent("toClientSide", true )
			addEventHandler("toClientSide", resourceRoot, nameFunction)
			</syntaxhighlight>
			</section>
			<section name="Server" class="server" show="true">
			<syntaxhighlight lang="lua">
			function commandFunction(source)
			triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
			end
			addCommandHandler("cool", commandFunction)
			</syntaxhighlight>
			</section>

	==Changelog==		==Changelog==

Srslyyyy at 04:03, 19 April 2024

2024-04-19T04:03:58Z

← Older revision		Revision as of 04:03, 19 April 2024
Line 20:		Line 20:
	*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}		{{Important Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

	===Optional Arguments===		===Optional Arguments===

Srslyyyy: /* Syntax */

2024-04-08T20:35:53Z

Syntax

← Older revision		Revision as of 20:35, 8 April 2024
Line 20:		Line 20:
	*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when ~~you want~~ restrict event to single certain resource.}}		{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

	===Optional Arguments===		===Optional Arguments===

Srslyyyy: /* Required Arguments */

2024-04-08T20:34:41Z

Required Arguments

← Older revision		Revision as of 20:34, 8 April 2024
Line 20:		Line 20:
	*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to one ~~player~~) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when you want restrict event to single certain resource.}}		{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when you want restrict event to single certain resource.}}

	===Optional Arguments===		===Optional Arguments===

Srslyyyy: /* Required Arguments */

2024-04-08T20:31:07Z

Required Arguments

← Older revision		Revision as of 20:31, 8 April 2024
Line 20:		Line 20:
	*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''sourceElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Note\|To save client CPU, you should avoid setting theElement to the root element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element (player who should receive event, if expected to be delivered to one player) is preferred and highly advisable. resourceRoot can also be used as alternative choice, if addEventHandler is bound to root element, or to resourceRoot when you want restrict event to single certain resource.}}		{{Note\|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to one player) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when you want restrict event to single certain resource.}}

	===Optional Arguments===		===Optional Arguments===

← Older revision		Revision as of 22:33, 6 September 2024
Line 114:		Line 114:

	==See Also==		==See Also==
	{{Event functions}}		{{Event functions\|server}}
	[[ru:triggerClientEvent]]		[[ru:triggerClientEvent]]