Player::call: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
m (Reworded description and example)
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}}

Revision as of 01:35, 29 September 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