Player::outputChatBox: Difference between revisions

Latest revision as of 09:55, 1 December 2019

This functions writes a chat message to player.

Syntax

player.outputChatBox(text);

Required Arguments

text: String Text what should be output in player chat.

Example #1

This example welcomes player on connect.

mp.events.add(`playerJoin`, 
	player => {
		player.outputChatBox(`Welcome to the server, ${player.name}!`);
	}
);

Example #2

This example just output color texts. Note: chat.colors property should be enabled - if you wanna use that.

let red = `#ff0000`;
let player = mp.players.at(1337); // 1337 is a player id
if (player) {
	player.outputChatBox(`!{#dddddd}This is Grey! !{#ffffff}This is White! !{${red}}This is Red!`);
	player.outputChatBox(` !{255, 0, 0}This is too Red! !{green}This is Green! !{255, 0, 255, 0.5}This is opacity Pink!`);
};

@@ Line 1: / Line 1: @@
 This functions writes a chat message to player.
 == Syntax ==
 <syntaxhighlight lang="javascript">
-player.outputChatBox(reason);
+player.outputChatBox(text);
 </syntaxhighlight>
-== Arguments ==
-<div>
+===Required Arguments===
-*reason - string
+*'''text:''' {{RageType|String}} Text what should be output in player chat.
-</div>
-== Example ==
+== Example #1 ==
 This example welcomes player on connect.
-<syntaxhighlight lang="javascript">
+<syntaxhighlight lang="javascript" highlight="3">
-mp.events.add('playerJoin', player => {
+mp.events.add(`playerJoin`,
-  player.outputChatBox('Welcome to the server, ' + player.name + '!');
+	player => {
-});
+		player.outputChatBox(`Welcome to the server, ${player.name}!`);
+	}
+);
+</syntaxhighlight>
+== Example #2 ==
+This example just output color texts.
+Note: [[chat.colors]] property should be enabled - if you wanna use that.
+<syntaxhighlight lang="javascript" highlight="4,5">
+let red = `#ff0000`;
+let player = mp.players.at(1337); // 1337 is a player id
+if (player) {
+	player.outputChatBox(`!{#dddddd}This is Grey! !{#ffffff}This is White! !{${red}}This is Red!`);
+	player.outputChatBox(` !{255, 0, 0}This is too Red! !{green}This is Green! !{255, 0, 255, 0.5}This is opacity Pink!`);
+};
 </syntaxhighlight>
-==See Also==
+==See also==
 {{Player_block}}
+[[Category:Player API]]
+[[Category:Server-side Function]]