Player::call: Difference between revisions

Revision as of 07:18, 13 September 2019

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

Syntax

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

Required Arguments

eventName: The event name that will be called
args: Any arguments, what should be sent to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.) Arguments has to be packed in an array.

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]);
};

@@ Line 3: / Line 3: @@
 ==Syntax==
 <pre>
-player.call(String eventName [, ...args]);
+player.call(String eventName [, Array args]);
 </pre>
 ===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.) Arguments has to be packed in an array.
+*'''args:''' Any arguments, what should be sent to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.) Arguments has to be packed in an array.
 ==Example==

Revision as of 07:18, 13 September 2019

Syntax

Required Arguments

Example

See Also