💬 Chat

Configure, envoie et intercepte les messages du chat.

🗿Static Class

This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.

💂Authority

This static class can be accessed on both 🟧 Client and 🟦 Server side.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🎒 Examples

(Chat.BroadcastMessage) Sends a message to everyone

Chat.BroadcastMessage("Welcome to the server!")

Colors in Chat

It is also possible to send colored messages in the Chat! For that, just circumvent a piece of text with a style tag: \<TAG>my awesome text</>.

Server/Index.lua

Chat.BroadcastMessage("Hello with <cyan>Cyan</> text message!")

All supported text styles/tags:

\<cyan> \<green> \<blue> \<purple> \<marengo> \<yellow> \<orange> \<red> \<grey> \<bold> \<italic>

note

It is NOT possible to combine two or more styles together (e.g. \<bold> + \<red>).

🗿 Static Functions

	Returns	Name	Description
		AddMessage	Ajoute un message de chat qui s'affichera uniquement en local
		BroadcastMessage	Envoie un message de chat à tous les Joueurs
		Clear	Efface tous les messages
		SendMessage	Envoie un message de chat à un seul Joueur
		SetConfiguration	Configure l'apparence et la position du Chat
		SetVisibility	Définit si le Chat est visible ou non

---

AddMessage

Ajoute un message de chat qui s'affichera uniquement en local

Chat.AddMessage(message)

Parameters

Type	Parameter	Default	Description
string	message	Required parameter	No description provided

---

BroadcastMessage

Envoie un message de chat à tous les Joueurs

Chat.BroadcastMessage(message)

Parameters

Type	Parameter	Default	Description
string	message	Required parameter	Le message à envoyer à tous les Joueurs

Chat.BroadcastMessage Examples

Sends a message to everyone

Chat.BroadcastMessage("Welcome to the server!")

---

Clear

Efface tous les messages

Chat.Clear()

---

SendMessage

Envoie un message de chat à un seul Joueur

Chat.SendMessage(player, message)

Parameters

Type	Parameter	Default	Description
Player	player	Required parameter	Le joueur qui recevra le message
string	message	Required parameter	Le message

---

SetConfiguration

Configure l'apparence et la position du Chat

Chat.SetConfiguration(screen_location?, size?, anchors_min?, anchors_max?, alignment?, justify?, show_scrollbar?)

Parameters

Type	Parameter	Default	Description
Vector2D	screen_location?	Vector2D(-25, 0)	No description provided
Vector2D	size?	Vector2D(600, 250)	No description provided
Vector2D	anchors_min?	Vector2D(1, 0.5)	No description provided
Vector2D	anchors_max?	Vector2D(1, 0.5)	No description provided
Vector2D	alignment?	Vector2D(1, 0.5)	No description provided
boolean	justify?	true	No description provided
boolean	show_scrollbar?	true	No description provided

---

SetVisibility

Définit si le Chat est visible ou non

Chat.SetVisibility(is_visible)

Parameters

Type	Parameter	Default	Description
boolean	is_visible	Required parameter	No description provided

🚀 Events

	Name	Description
	ChatEntry	Appelé lorsqu'un nouveau message de chat est reçu ; se déclenche également lorsque des messages sont envoyés par programmation
	Close	Lorsqu'un joueur ferme le chat
	Open	Lorsqu'un joueur ouvre le chat
	PlayerSubmit	Appelé lorsqu'un joueur envoie un message dans le chat

---

ChatEntry

Appelé lorsqu'un nouveau message de chat est reçu ; se déclenche également lorsque des messages sont envoyés par programmation.

Utile pour créer votre propre interface de chat tout en conservant le système intégré

Chat.Subscribe("ChatEntry", function(message, player)
	-- ChatEntry was called
end)

Arguments

Type	Argument	Description
string	message	Le message
Player or nil	player	Le joueur ayant envoyé le message, ou nil si l'appel a été effectué côté client ou via du code

---

Close

Lorsqu'un joueur ferme le chat

Chat.Subscribe("Close", function()
	-- Close was called
end)

---

Open

Lorsqu'un joueur ouvre le chat

Chat.Subscribe("Open", function()
	-- Open was called
end)

---

PlayerSubmit

Appelé lorsqu'un joueur envoie un message dans le chat

Renvoyez false pour empêcher l'envoi du message

Chat.Subscribe("PlayerSubmit", function(message, player)
	-- PlayerSubmit was called
	return true
end)

Arguments

Type	Argument	Description
string	message	Le message envoyé par le joueur
Player	player	Le joueur ayant envoyé le message — côté client, il s'agira toujours du localplayer