TriggerServerEvent - Revision history

Srslyyyy: /* Example */

2024-04-29T22:38:24Z

Example

← Older revision		Revision as of 22:38, 29 April 2024
Line 116:		Line 116:
	end		end

	local minTableLength = 1 -- min allowed ~~lenght~~ of table		local minTableLength = 1 -- min allowed length of table
	local maxTableLength = 3 -- max allowed length of table		local maxTableLength = 3 -- max allowed length of table
	local tableLength = (#sentTable) -- get table length		local tableLength = (#sentTable) -- get table length

Srslyyyy at 22:37, 29 April 2024

2024-04-29T22:37:14Z

← Older revision		Revision as of 22:37, 29 April 2024
Line 60:		Line 60:
	end		end

	local minStringLength = 1 -- ~~mix~~ allowed length of string		local minStringLength = 1 -- min allowed length of string
	local maxStringLength = 64 -- max allowed length of string		local maxStringLength = 64 -- max allowed length of string
	local stringLength = utf8.len(sentMessage) -- get string length		local stringLength = utf8.len(sentMessage) -- get string length

Srslyyyy at 09:58, 19 April 2024

2024-04-19T09:58:33Z

← Older revision		Revision as of 09:58, 19 April 2024
Line 83:		Line 83:
	When the command '''message''' is executed (by typing it in the player's console or in chat: '''/message'''), '''sendMessageToServer''' function is called. This triggers the server-side event ''onServerSendMessage'' and passes [[string]] '''"Hello, world!"'''. This event is then handled by function on server-side, which process security measures, and if everything is alright - outputs text to chat.		When the command '''message''' is executed (by typing it in the player's console or in chat: '''/message'''), '''sendMessageToServer''' function is called. This triggers the server-side event ''onServerSendMessage'' and passes [[string]] '''"Hello, world!"'''. This event is then handled by function on server-side, which process security measures, and if everything is alright - outputs text to chat.

	This example shows how you can send table from client to server.		This example shows how you can send table with numbers from client to server.

	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">

Srslyyyy at 04:03, 19 April 2024

2024-04-19T04:03:06Z

← Older revision		Revision as of 04:03, 19 April 2024
Line 18:		Line 18:
	*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]] and passing respective resource root element.)}}		{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource, by using [[getResourceRootElement]] and passing respective resource root element)}}

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

Srslyyyy at 04:02, 19 April 2024

2024-04-19T04:02:41Z

← Older revision		Revision as of 04:02, 19 April 2024
Line 18:		Line 18:
	*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]])}}		{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]] and passing respective resource root element.)}}

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

Srslyyyy at 04:01, 19 April 2024

2024-04-19T04:01:50Z

← Older revision		Revision as of 04:01, 19 April 2024
Line 18:		Line 18:
	*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]].)}}		{{Important Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]])}}

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

Srslyyyy at 04:01, 19 April 2024

2024-04-19T04:01:32Z

← Older revision		Revision as of 04:01, 19 April 2024
Line 18:		Line 18:
	*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].		*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
	*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.		*'''theElement:''' The element that is the [[Event system#Event handlers\|source]] of the event.
	{{Note\|To save server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 server 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 [[localPlayer]] is preferred and highly advisable. [[GetThisResource\|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 (although cheater could still trigger it from different resource by using [[getResourceRootElement]].)}}

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

Srslyyyy: Improve examples.

2024-04-19T03:59:36Z

Improve examples.

Show changes

AirNewSCR: /* Removed 'localPlayer', changed to resourceRoot */

2024-04-18T22:11:21Z

Removed 'localPlayer', changed to resourceRoot

← Older revision		Revision as of 22:11, 18 April 2024
Line 32:		Line 32:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function sendTestData()		function sendTestData()
	local dataToSend = "Hello, world!"		local dataToSend = "Hello, world!"
			triggerServerEvent("onServerSendTestData", resourceRoot, dataToSend)
	triggerServerEvent("onServerSendTestData", ~~localPlayer~~, dataToSend)
	end		end
	addCommandHandler("data", sendTestData)		addCommandHandler("data", sendTestData)
Line 43:		Line 42:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function onServerSendTestData(sentData)		function onServerSendTestData(sentData)
	if (not client) then -- 'client' points to the player who triggered the event, and should be used as security measure (in order to prevent player faking)		if (not client) then -- 'client' points to the player who triggered the event, and should be used as security measure (in order to prevent player faking)
	return false -- if this variable doesn't exists at the moment (for unknown reason, or it was the server who triggered this event), stop code execution		return false -- if this variable doesn't exists at the moment (for unknown reason, or it was the server who triggered this event), stop code execution
	end		end
			if (source ~= resourceRoot) then
	local chatMessage = "Data sent from client: "..sentData		return false
			end
	outputChatBox(chatMessage, client) -- output data sent from client-side		local chatMessage = "Data sent from client: "..sentData
			outputChatBox(chatMessage, client) -- output data sent from client-side
	end		end
	addEvent("onServerSendTestData", true) -- 2nd argument should be set to true, in order to be triggered from counter side (in this case client-side)		addEvent("onServerSendTestData", true) -- 2nd argument should be set to true, in order to be triggered from counter side (in this case client-side)
	addEventHandler("onServerSendTestData", ~~root~~, onServerSendTestData)		addEventHandler("onServerSendTestData", resourceRoot, onServerSendTestData)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Srslyyyy at 22:31, 13 April 2024

2024-04-13T22:31:46Z

← Older revision		Revision as of 22:31, 13 April 2024
Line 8:		Line 8:

	Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.		Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
	{{~~Warning~~\|You should use the global variable [[Predefined_variables_list\|''client'']] server-side instead of passing the [[localPlayer]] by parameter or source. Otherwise event faking (passing another player instead of the [[localPlayer]]) would be possible. For more information see: [[Script security]] ~~and [[addEventHandler]]~~.}}		{{Important Note\|You should use the global variable [[Predefined_variables_list\|''client'']] server-side instead of passing the [[localPlayer]] by parameter or source. Otherwise event faking (passing another player instead of the [[localPlayer]]) would be possible. For more information see: [[Script security]] article.}}
	{{Note\|It is marginally more efficient to pass one large event than two smaller ones.}}		{{Note\|It is marginally more efficient to pass one large event than two smaller ones.}}
	==Syntax==		==Syntax==