Player::call

2018-01-07T18:38:37Z

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

This function call added client-side event for selected player.

==Syntax==
<syntaxhighlight lang="javascript">
player.call(String eventName [, ...args]);
</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==
That's example will call event added on client side for player with ID 1337, disable regeneration health and send number current player health.

<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>
<syntaxhighlight lang="javascript">
let disableRegeneration = (currentHealth) => { //currentHealth - value, what we send from server.
mp.game.player.setHealthRechargeMultiplier(0); //Disable regeneration
let text = `Regeneration disabled. Current health: ${currentHealth}`;
mp.gui.chat.push(text); //Output text to default chatbox
};

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

<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">
let player = mp.player.at(1337); //Get player by ID
if (player) {
let playerHealth = player.health;
player.call(`disablePlayerRegeneration`, playerHealth);
};
</syntaxhighlight>
</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==
{{Player_block}}

RAGE Multiplayer Wiki - User contributions [en]

Player::call