Player::call - Revision history

Mos at 19:52, 1 November 2025

2025-11-01T19:52:43Z

← Older revision		Revision as of 19:52, 1 November 2025
Line 2:		Line 2:
	'''FROM SERVER''':		'''FROM SERVER''':
	*This function calls a client-side event for the selected player.		*This function calls a client-side event for the selected player.

	'''FROM CLIENT''':		'''FROM CLIENT''':
	*For Peer 2 Peer connections. The current client can call an event on another client's scriptside and that other client can handle that event.		*For Peer 2 Peer connections. The current client can call an event on another client's scriptside and that other client can handle that event.
Line 12:		Line 13:
	*''' {{RageType\|void}} '''		*''' {{RageType\|void}} '''

			'''Note:''' payload is limited to 8192 bytes.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">

Shr0x at 11:16, 1 June 2024

2024-06-01T11:16:38Z

← Older revision		Revision as of 11:16, 1 June 2024
Line 1:		Line 1:
	FROM SERVER: This function calls a client-side event for the selected player.		{{JSContainer\|
	FROM CLIENT: For Peer 2 Peer connections. The current client can call an event on another client's scriptside and that other client can handle that event.		'''FROM SERVER''':
			*This function calls a client-side event for the selected player.
			'''FROM CLIENT''':
			*For Peer 2 Peer connections. The current client can call an event on another client's scriptside and that other client can handle that event.

			===Required Params===
			*'''eventName:''' {{RageType\|string}} - the event name that will be called
			*'''args:''' {{RageType\|Array[]}} - Any arguments, what should be sent to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.)

			===Return value===
			*''' {{RageType\|void}} '''

	==Syntax==		==Syntax==
	<~~pre~~>		<syntaxhighlight lang="javascript">
	player.call(~~String~~ eventName [, ~~Array~~ args]);		player.call(eventName, ...args);
	</~~pre~~>		</syntaxhighlight>
	~~===Required Arguments===~~
	*'''eventName:''' The event name that will be called
	*'''args:''' Any arguments, what should be sent to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.) Arguments has to be packed in an array.

	~~==Example==~~
	~~This example will call the client-side event 'disablePlayerRegeneration' for the player with the ID 1337.~~

			==Example==
			Register the event that you want to call in client-side using [[Events::add\|mp.events.add]]
	{{ClientsideCode\|		{{ClientsideCode\|
	<~~pre>~~		<syntaxhighlight lang="javascript">
	~~let disableRegeneration = (currentHealth)~~ => ~~{ //currentHealth - value, what we send from server.~~		mp.events.add('setPlayerConfigFlag', (flag, enable) => {
	mp.~~game~~.~~player.setHealthRechargeMultiplier~~(0)~~; //Disable regeneration~~		mp.players.local.setConfigFlag(flag, enable);
	mp.~~gui~~.~~chat~~.~~push~~(~~`Regeneration disabled. Current health: ${currentHealth}`~~); ~~//Output text to default chatbox~~		})
	};		</syntaxhighlight>

	~~mp.events.add('disablePlayerRegeneration', disableRegeneration~~);
	</~~pre~~>
	}}		}}

			Here we create a function that will call 'setPlayerConfigFlag' event and it will set the given player a given config flag.
			{{ServersideCode\|
			<syntaxhighlight lang="javascript">
			function setPlayerConfigFlag(id, flag, enable) {
			const player = mp.players.at(id); //Find player with ID 1337;
			if (!player \|\| !mp.players.exists(player)) return; //Do nothing if no player was found
			player.call("setPlayerConfigFlag", [flag, enable]);
			}

	~~{{ServersideCode\|~~		setPlayerConfigFlag(1337, 18, true); //enable can punch flag for player id 1337
	~~<pre>~~		</syntaxhighlight>
	~~let player = mp.player.at~~(1337); //~~Get~~ player ~~by ID~~
	~~if (player) {~~
	~~let playerHealth = player.health;~~
	~~player.call(`disablePlayerRegeneration`, [playerHealth]);~~
	};
	</~~pre~~>
	}}		}}

	==See ~~Also~~==		}}
			==See also==
	{{Player_block}}		{{Player_block}}

Kar at 16:20, 6 November 2019

2019-11-06T16:20:39Z

← Older revision		Revision as of 16:20, 6 November 2019
Line 1:		Line 1:
	This function calls a client-side event for the selected player.		FROM SERVER: This function calls a client-side event for the selected player.
			FROM CLIENT: For Peer 2 Peer connections. The current client can call an event on another client's scriptside and that other client can handle that event.

	==Syntax==		==Syntax==

Mos: /* Syntax */

2019-09-13T07:18:37Z

Syntax

← Older revision		Revision as of 07:18, 13 September 2019
Line 3:		Line 3:
	==Syntax==		==Syntax==
	<pre>		<pre>
	player.call(String eventName [, ~~...~~args]);		player.call(String eventName [, Array args]);
	</pre>		</pre>
	===Required Arguments===		===Required Arguments===
	*'''eventName:''' The event name that will be called		*'''eventName:''' The event name that 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.) Arguments has to be packed in an array.		*'''args:''' Any arguments, what should be sent to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.) Arguments has to be packed in an array.

	==Example==		==Example==

Geramy92 at 21:38, 10 January 2019

2019-01-10T21:38:04Z

← Older revision		Revision as of 21:38, 10 January 2019
Line 7:		Line 7:
	===Required Arguments===		===Required Arguments===
	*'''eventName:''' The event name that will be called		*'''eventName:''' The event name that 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.)		*'''args:''' Any arguments, what should be sended to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.) Arguments has to be packed in an array.

	==Example==		==Example==

Rootcause: Replaced HTML with template

2018-10-26T11:47:21Z

Replaced HTML with template

← Older revision		Revision as of 11:47, 26 October 2018
Line 2:		Line 2:

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>		<pre>
	player.call(String eventName [, ...args]);		player.call(String eventName [, ...args]);
	</~~syntaxhighlight~~>		</pre>
	===Required Arguments===		===Required Arguments===
	*'''eventName:''' The event name that will be called		*'''eventName:''' The event name that will be called
Line 12:		Line 12:
	This example will call the client-side event 'disablePlayerRegeneration' for the player with the ID 1337.		This example will call the client-side event 'disablePlayerRegeneration' for the player with the ID 1337.

	~~<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">~~		{{ClientsideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>~~
	<pre>		<pre>
	let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.		let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.
Line 22:		Line 21:
	mp.events.add('disablePlayerRegeneration', disableRegeneration);		mp.events.add('disablePlayerRegeneration', disableRegeneration);
	</pre>		</pre>
	~~</div>~~		}}


	~~<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>		<pre>
	let player = mp.player.at(1337); //Get player by ID		let player = mp.player.at(1337); //Get player by ID
Line 34:		Line 32:
	};		};
	</pre>		</pre>
	~~</div>~~		}}

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

MrPancakers: Reworded description and example

2018-09-29T01:35:34Z

Reworded description and example

← Older revision		Revision as of 01:35, 29 September 2018
Line 1:		Line 1:
	This function ~~call added~~ client-side event for selected player.		This function calls a client-side event for the selected player.

	==Syntax==		==Syntax==
Line 6:		Line 6:
	</syntaxhighlight>		</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	*'''eventName:''' ~~Event~~ name~~, what~~ will be called.		*'''eventName:''' The event name that 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.)		*'''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==		==Example==
	~~That's~~ example will call ~~event added on~~ client side for player with ID 1337~~, disable regeneration health and send number current player health~~.		This example will call the client-side event 'disablePlayerRegeneration' for the player with the ID 1337.

	<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">		<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
	<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
	<~~syntaxhighlight lang="javascript"~~>		<pre>
	let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.		let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.
	mp.game.player.setHealthRechargeMultiplier(0); //Disable regeneration		mp.game.player.setHealthRechargeMultiplier(0); //Disable regeneration
	~~let text =~~ `Regeneration disabled. Current health: ${currentHealth}`;		mp.gui.chat.push(`Regeneration disabled. Current health: ${currentHealth}`); //Output text to default chatbox
	~~mp.gui.chat.push(text~~); //Output text to default chatbox
	};		};

	mp.events.add('disablePlayerRegeneration', disableRegeneration);		mp.events.add('disablePlayerRegeneration', disableRegeneration);
	</~~syntaxhighlight~~>		</pre>
	</div>		</div>

Line 28:		Line 27:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<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>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<~~syntaxhighlight lang="javascript" highlight="4"~~>		<pre>
	let player = mp.player.at(1337); //Get player by ID		let player = mp.player.at(1337); //Get player by ID
	if (player) {		if (player) {
Line 34:		Line 33:
	player.call(`disablePlayerRegeneration`, [playerHealth]);		player.call(`disablePlayerRegeneration`, [playerHealth]);
	};		};
	</~~syntaxhighlight~~>		</pre>
	</div>		</div>

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

Ragempdev at 14:39, 18 August 2018

2018-08-18T14:39:10Z

← Older revision		Revision as of 14:39, 18 August 2018
Line 36:		Line 36:
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>



	~~<b> You cannot pass Vector3 types </b> ''(send them through x,y,z and put them in a Vector3 type variable in the client function)''~~

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

Maximus: /* Example */

2018-01-09T17:17:17Z

Example

← Older revision		Revision as of 17:17, 9 January 2018
Line 32:		Line 32:
	if (player) {		if (player) {
	let playerHealth = player.health;		let playerHealth = player.health;
	player.call(`disablePlayerRegeneration`, playerHealth);		player.call(`disablePlayerRegeneration`, [playerHealth]);
	};		};
	</syntaxhighlight>		</syntaxhighlight>

ENN: informed anyone reading that you cant pass vector3 type variables through this call

2018-01-07T18:38:37Z

informed anyone reading that you cant pass vector3 type variables through this call

← Older revision		Revision as of 18:38, 7 January 2018
Line 36:		Line 36:
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>



			<b> You cannot pass Vector3 types </b> ''(send them through x,y,z and put them in a Vector3 type variable in the client function)''

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