Latest revision as of 11:05, 10 November 2024

Server-Side
Function

JavaScript

JavaScript Syntax

Summary

The `mp.players.broadcast` function sends a chat message to all connected players on the server. This function is commonly used for global announcements or notifications.

Required Params

text: string — The message text to broadcast to all players.

Return value

void

Syntax

mp.players.broadcast(text);

Example

This example sends a player's message to all other players.

mp.events.addCommand("say", (player, message) => {
    mp.players.broadcast(`Message from ${player.name}: ${message}`);
});

@@ Line 1: / Line 1: @@
-This function writes a chat message for all players (like [[Player::outputChatBox]]).
+{{ServersideJsFunction}}
+{{JSContainer|
+==Summary==
+The `mp.players.broadcast` function sends a chat message to all connected players on the server. This function is commonly used for global announcements or notifications.
+===Required Params===
+*'''text:''' {{RageType|string}} — The message text to broadcast to all players.
+===Return value===
+*''' {{RageType|void}} '''
 ==Syntax==
 <syntaxhighlight lang="typescript">
-void players.broadcast(string text);
+mp.players.broadcast(text);
 </syntaxhighlight>
-===Required Arguments===
-*'''text:''' The text to be sent
 ==Example==
-This example sends player message to all
+This example sends a player's message to all other players.
 <syntaxhighlight lang="javascript">
 mp.events.addCommand("say", (player, message) => {
-	mp.players.broadcast(`Message from ${player.name}: ${message}`);
+    mp.players.broadcast(`Message from ${player.name}: ${message}`);
 });
 </syntaxhighlight>
-==See Also==
+}}
-{{PlayerPool_function}}
+==See also==
+{{PlayerPool_block}}
+[[Category:Serverside API]]