Players::call - Revision history

Shr0x at 11:09, 10 November 2024

2024-11-10T11:09:15Z

← Older revision		Revision as of 11:09, 10 November 2024
Line 1:		Line 1:
	~~This function triggers an event for:~~		{{ServersideJsFunction}}
	* the whole server		{{JSContainer\|
	* specified players array

			==Summary==
			The `mp.players.call` function triggers a specified event on the client-side for either all players or a defined array of players. It is useful for synchronizing client events across multiple players on the server.

	==~~Syntax~~==		===Required Params===
	~~<pre>~~		*'''eventName:''' {{RageType\|string}} — The name of the client event to trigger.
	~~mp.players.call(String eventName[,~~ Array Arguments~~]);~~		*'''args:''' {{RageType\|Array}} — Arguments to send with the event. Supports strings, numbers, booleans, entities; objects and arrays should be in JSON format.
	mp.~~players.call(Array players~~, ~~String eventName[~~, ~~Array Arguments])~~;
	~~</pre>~~

	===~~Required Arguments~~===		===Syntax===
	*'''eventName~~:''' Event name~~, ~~what will be called~~.		<syntaxhighlight lang="javascript">
	*'''args:''' Any arguments, what should be sended to client. ~~Supports entities~~, ~~strings~~, ~~numbers and booleans. (Objects and Arrays should be packed to JSON format.~~)		mp.players.call(eventName[, args]);
			mp.players.call(playersArray, eventName[, args]);
			</syntaxhighlight>

	==~~Example~~==		==Examples==
	1. Trigger "disablePlayerRegeneration" event for ~~everyone near new mp.Vector3~~(150, 100, 50).		1. Trigger an event for nearby players: This example triggers the `"disablePlayerRegeneration"` event for all players within 20 units of a position `(150, 100, 50)`.
	~~{{ServersideCode\|~~
	<~~pre~~>		<syntaxhighlight lang="javascript">
	const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20));		const playersArray = mp.players.toArray().filter((player) =>
			player.dist(new mp.Vector3(150, 100, 50)) < 20
			);
	mp.players.call(playersArray, "disablePlayerRegeneration");		mp.players.call(playersArray, "disablePlayerRegeneration");
	</~~pre~~>		</syntaxhighlight>
	}}

			2. Trigger an event for all players: This example triggers the `"disablePlayerRegeneration"` event for everyone on the server.

	~~2. Trigger~~ "~~disablePlayerRegeneration~~" ~~event for everyone.~~		<syntaxhighlight lang="javascript">
	~~{{ServersideCode\|~~
	~~<pre~~>
	mp.players.call("disablePlayerRegeneration");		mp.players.call("disablePlayerRegeneration");
	</~~pre~~>		</syntaxhighlight>

	}}		}}
			==See also==

	==See ~~Also~~==
	{{Player_block}}		{{Player_block}}
			[[Category:Serverside API]]

Rootcause: Replaced HTML with template

2018-10-26T12:26:13Z

Replaced HTML with template

← Older revision		Revision as of 12:26, 26 October 2018
Line 5:		Line 5:

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>		<pre>
	mp.players.call(String eventName[, Array Arguments]);		mp.players.call(String eventName[, Array Arguments]);
	mp.players.call(Array players, String eventName[, Array Arguments]);		mp.players.call(Array players, String eventName[, Array Arguments]);
	</~~syntaxhighlight~~>		</pre>

	===Required Arguments===		===Required Arguments===
	*'''eventName:''' Event name, what will be called.		*'''eventName:''' Event name, what will be called.
Line 15:		Line 16:
	==Example==		==Example==
	1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50).		1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50).
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~		<pre>
	<~~syntaxhighlight lang="javascript" highlight="4"~~>
	const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20));		const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20));
	mp.players.call(playersArray, "disablePlayerRegeneration");		mp.players.call(playersArray, "disablePlayerRegeneration");
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}


	2. Trigger "disablePlayerRegeneration" event for everyone.		2. Trigger "disablePlayerRegeneration" event for everyone.
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~		<pre>
	<~~syntaxhighlight lang="javascript" highlight="4"~~>
	mp.players.call("disablePlayerRegeneration");		mp.players.call("disablePlayerRegeneration");
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}


	==See Also==		==See Also==
	{{Player_block}}		{{Player_block}}

Ragempdev at 14:48, 18 August 2018

2018-08-18T14:48:34Z

← Older revision		Revision as of 14:48, 18 August 2018
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.players.call(String eventName, Array Arguments);		mp.players.call(String eventName[, Array Arguments]);
	mp.players.call(Array players, String eventName, Array Arguments);		mp.players.call(Array players, String eventName[, Array Arguments]);
	</syntaxhighlight>		</syntaxhighlight>
	===Required Arguments===		===Required Arguments===

Ragempdev at 14:47, 18 August 2018

2018-08-18T14:47:37Z

← Older revision		Revision as of 14:47, 18 August 2018
Line 1:		Line 1:
	This function ~~calls~~ an event for a) the whole server~~; b)~~ specified players array		This function triggers an event for:
			* the whole server
			* specified players array


	==Syntax==		==Syntax==

Ragempdev at 14:46, 18 August 2018

2018-08-18T14:46:41Z

← Older revision		Revision as of 14:46, 18 August 2018
Line 1:		Line 1:
	~~{{Incomplete Functions}}~~
	This function calls an event for a) the whole server; b) specified players array		This function calls an event for a) the whole server; b) specified players array
	~~NB: I just tested in local, without error, but it need to be tested with, at least, two players (in different dimensions).~~

	==Syntax==		==Syntax==

Ragempdev at 14:46, 18 August 2018

2018-08-18T14:46:21Z

← Older revision		Revision as of 14:46, 18 August 2018
Line 1:		Line 1:
	{{Incomplete Functions}}		{{Incomplete Functions}}
			This function calls an event for a) the whole server; b) specified players array
			NB: I just tested in local, without error, but it need to be tested with, at least, two players (in different dimensions).

			==Syntax==
			<syntaxhighlight lang="javascript">
			mp.players.call(String eventName, Array Arguments);
			mp.players.call(Array players, String eventName, Array Arguments);
			</syntaxhighlight>
			===Required Arguments===
			*'''eventName:''' Event name, what will be called.
			*'''args:''' Any arguments, what should be sended to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.)

			==Example==
			1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50).
			<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
			<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
			<syntaxhighlight lang="javascript" highlight="4">
			const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20));
			mp.players.call(playersArray, "disablePlayerRegeneration");
			</syntaxhighlight>
			</div>


			2. Trigger "disablePlayerRegeneration" event for everyone.
			<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
			<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
			<syntaxhighlight lang="javascript" highlight="4">
			mp.players.call("disablePlayerRegeneration");
			</syntaxhighlight>
			</div>


			==See Also==
			{{Player_block}}

CocaColaBear: Created page with "{{Incomplete Functions}}"

2017-10-15T20:51:16Z

Created page with "{{Incomplete Functions}}"

New page