newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
Chat
chevron_left Classes
class
Chat

Static Properties

data_objectEnableddata_objectMaxMessageLengthdata_objectShowUI

Static Methods

functionsAddTextfunctionsSay
Chat
Platform-level text chat system. Provides an API for sending and receiving chat messages to users.
class Sandbox.Platform .
staticsealedabstractSandbox.Engine

data_object Static Properties 3

Enabled
bool
Whether chat is enabled for the current game.
MaxMessageLength
int
Maximum length of a single chat message.
ShowUI
bool
Whether the built-in chat UI overlay should be shown.

functions Static Methods 2

AddText (message)
Add a notification to the chat. This is local-only and has no sender.
Say (message)
Says a message in chat. This will be sent to the host, validated, then filtered to clients.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.