Player::call: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
Line 2: Line 2:


==Syntax==
==Syntax==
<syntaxhighlight lang="typescript">
<syntaxhighlight lang="javascript">
player.call(string eventName [, ...args]);
player.call(String eventName [, ...args]);
</syntaxhighlight>  
</syntaxhighlight>  
===Required Arguments===
===Required Arguments===

Revision as of 14:57, 26 September 2017

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

Syntax

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

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.

Client-Side
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);


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

See Also