Skip to main content

Chat

Configure, send and intercept chat messages.

🗿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.

Examples

Server/Index.lua
-- sends a chat message to everyone
Chat.BroadcastMessage("Welcome to the server!")

Static Functions

ReturnsNameDescription
AddMessageAdds a chat message which will display local only
SendMessageSends a chat message to a Player only
SetConfigurationConfigures the Chat visuals and position
SetVisibilitySets if the Chat is visible or not
ClearClears all messages
BroadcastMessageSends a chat message to all Players

AddMessage

Adds a chat message which will display local only

Chat.AddMessage(message)
TypeParameterDefaultDescription
stringmessage

SendMessage

Sends a chat message to a Player only

Chat.SendMessage(player, message)
TypeParameterDefaultDescription
PlayerplayerThe player to receive the message
stringmessageThe message

SetConfiguration

Configures the Chat visuals and position

Chat.SetConfiguration(screen_location?, size?, anchors_min?, anchors_max?, alignment?, justify?, show_scrollbar?)
TypeParameterDefaultDescription
Vector2Dscreen_location?Vector(-25, 0)
Vector2Dsize?Vector(600, 250)
Vector2Danchors_min?Vector(1, 0.5)
Vector2Danchors_max?Vector(1, 0.5)
Vector2Dalignment?Vector(1, 0.5)
booleanjustify?true
booleanshow_scrollbar?true

SetVisibility

Sets if the Chat is visible or not

Chat.SetVisibility(is_visible)
TypeParameterDefaultDescription
booleanis_visible

Clear

Clears all messages

Chat.Clear()

BroadcastMessage

Sends a chat message to all Players

Chat.BroadcastMessage(message)
TypeParameterDefaultDescription
stringmessageThe message to send to all Players

Events

NameDescription
PlayerSubmitCalled when a player submits a message in the chat
ChatEntryCalled when a new Chat Message is received, this is also triggered when new messages are sent programatically
OpenWhen player opens the Chat
CloseWhen player closes the Chat

PlayerSubmit

Called when a player submits a message in the chat

Return false to prevent the message from being sent
Chat.Subscribe("PlayerSubmit", function(message, player)
-- PlayerSubmit was called
end)
TypeArgumentDescription
stringmessageThe message sent by the player
PlayerplayerThe player who sent the message - on client it will always be the localplayer

ChatEntry

Called when a new Chat Message is received, this is also triggered when new messages are sent programatically

This is useful for creating your own Chat interface while still use the built-in system
Chat.Subscribe("ChatEntry", function(message, player)
-- ChatEntry was called
end)
TypeArgumentDescription
stringmessageThe message
Player or nilplayerThe player who sent the message or nil if this was called on client side or was sent through code

Open

When player opens the Chat
Chat.Subscribe("Open", function()
-- Open was called
end)

Close

When player closes the Chat
Chat.Subscribe("Close", function()
-- Close was called
end)