Player::call: Difference between revisions

From RAGE Multiplayer Wiki
m (Reworded description and example)
m (Replaced HTML with template)
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}}

Revision as of 11:47, 26 October 2018

This function calls a client-side event for the selected player.

Syntax

player.call(String eventName [, ...args]);

Required Arguments

  • 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.)

Example

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

Client-Side
let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.
	mp.game.player.setHealthRechargeMultiplier(0); //Disable regeneration
	mp.gui.chat.push(`Regeneration disabled. Current health: ${currentHealth}`); //Output text to default chatbox
};

mp.events.add('disablePlayerRegeneration', disableRegeneration);


Server-Side
let player = mp.player.at(1337); //Get player by ID
if (player) {
	let playerHealth = player.health;
	player.call(`disablePlayerRegeneration`, [playerHealth]);
};

See Also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Player::call&oldid=15932"