Player::call: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
Line 1: Line 1:
This function call client event for player.
This function call added client-side event for selected player.
== Syntax ==
 
==Syntax==
<syntaxhighlight lang="typescript">
void 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 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: #D86C6C; color: #D65757; border: 1px solid #D65757;">
<div style="margin: 4px 0px 4px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
player.call(eventName [, ...args]);
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.execute(`insertMessageToChat(\`${text}\`)`); //Output text to default chatbox
};
 
mp.events.add(
{
`disablePlayerRegeneration`: disableRegeneration
}
);
</syntaxhighlight>
</syntaxhighlight>
</div>
<div class="header" style="background-color: #A5B5C5; color: #5892D8; border: 1px solid #5892D8;">
<div style="margin: 4px 0px 4px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let player = mp.player.at(1337); //Get player by ID
if (!!player) {
let playerHealth = player.health;
player.call(`disablePlayerRegeneration`, playerHealth);
};
</syntaxhighlight>
</div>


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

Revision as of 14:12, 4 May 2017

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

Syntax

void player.call(string eventName [, ...args]);

Required Arguments

  • eventName: Event name, what will be called.
  • args: Any arguments, what should be sended to client. Supports 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.execute(`insertMessageToChat(\`${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