Players::broadcastInRange: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "This function writes a chat message for all players in range (like Player::outputChatBox). ==Syntax== <syntaxhighlight lang="typescript"> void players.broadcastInRange(Ve...")
 
No edit summary
Line 6: Line 6:
</syntaxhighlight>  
</syntaxhighlight>  
===Required Arguments===
===Required Arguments===
*'''position:''' The position from which the broadcast will be sent.
*'''range:''' The range from position.
*'''text:''' The text to be sent.
*'''text:''' The text to be sent.
*'''position:''' The position from which the broadcast will be sent.


===Optional Arguments===  
===Optional Arguments===  

Revision as of 13:25, 17 April 2017

This function writes a chat message for all players in range (like Player::outputChatBox).

Syntax

void players.broadcastInRange(Vecto3 position, number range [, number dimension], string text);

Required Arguments

  • position: The position from which the broadcast will be sent.
  • range: The range from position.
  • text: The text to be sent.

Optional Arguments

  • dimension: The dimension in which the broadcast will be sent.

Example

This example sends message to all players in 15 units from the player

mp.events.addCommand("say", (player, message) => {
	let pos = player.position;

	mp.players.broadcastInRange(pos, 15, `Message from ${player.name}: ${message}`);

});

See Also