Try our affiliated browser extension - redirect to BreezeWiki automatically!

Class:Chat

This article is about the chat service in Roblox Studio. For the in-game chat, see In-game chat.

The Chat class inherits from Instance. It is a service, so it cannot be instantiated. It is used to make characters or inanimate objects chat and to filter text.

Properties

BubbleChatEnabled: bool

This class member is missing documentation. Create or add to its subpage at Class:Chat/BubbleChatEnabled.
  • Category: Behavior.
  • Serialization: can save and load.
  • Thread safety: read safe

IsAutoMigrated: bool

  • HiddenThis property is not shown in the object browser and properties window.
This class member is missing documentation. Create or add to its subpage at Class:Chat/IsAutoMigrated.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

LoadDefaultChat: bool

This class member is missing documentation. Create or add to its subpage at Class:Chat/LoadDefaultChat.
  • Category: Behavior.
  • Write security: NotAccessibleSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

Methods

CanUserChatAsync(userId: int64): bool

  • YieldsThis function can yield the script it is used in.
Parameters
NameType
userIdint64
  • Thread safety: unsafe

CanUsersChatAsync(userIdFrom: int64, userIdTo: int64): bool

  • YieldsThis function can yield the script it is used in.
Parameters
NameType
userIdFromint64
userIdToint64
  • Thread safety: unsafe

Chat(partOrCharacter: Instance, message: string, color: ChatColor = Blue): null

Parameters
NameTypeDefault
partOrCharacterInstance
messagestring
colorChatColorBlue
  • Thread safety: unsafe

ChatLocal(partOrCharacter: Instance, message: string, color: ChatColor = Blue): null

Parameters
NameTypeDefault
partOrCharacterInstance
messagestring
colorChatColorBlue
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

FilterStringAsync(stringToFilter: string, playerFrom: Player, playerTo: Player): string

  • YieldsThis function can yield the script it is used in.
Parameters
NameType
stringToFilterstring
playerFromPlayer
playerToPlayer
  • Thread safety: unsafe

FilterStringForBroadcast(stringToFilter: string, playerFrom: Player): string

  • YieldsThis function can yield the script it is used in.
Parameters
NameType
stringToFilterstring
playerFromPlayer
  • Thread safety: unsafe

FilterStringForPlayerAsync(stringToFilter: string, playerToFilterFor: Player): string

  • YieldsThis function can yield the script it is used in.
  • DeprecatedThis member will be phased out and should be avoided while it is still available.
Parameters
NameType
stringToFilterstring
playerToFilterForPlayer
  • Thread safety: unsafe

GetShouldUseLuaChat(): bool

This class member is missing documentation. Create or add to its subpage at Class:Chat/GetShouldUseLuaChat.
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

InvokeChatCallback(callbackType: ChatCallbackType, callbackArguments: Tuple): Tuple

Parameters
NameType
callbackTypeChatCallbackType
callbackArgumentsTuple
  • Thread safety: unsafe

RegisterChatCallback(callbackType: ChatCallbackType, callbackFunction: Function): null

Parameters
NameType
callbackTypeChatCallbackType
callbackFunctionFunction
  • Thread safety: unsafe

SetBubbleChatSettings(settings: Variant): null

Parameters
NameType
settingsVariant
  • Thread safety: unsafe

Events

BubbleChatSettingsChanged(settings: Variant)

Parameters
NameType
settingsVariant
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

Chatted(part: Instance, message: string, color: ChatColor)

Parameters
NameType
partInstance
messagestring
colorChatColor
  • Thread safety: unsafe

TimeoutChatAttempt(isPermanentTimeout: bool, endTime: int64)

This class member is missing documentation. Create or add to its subpage at Class:Chat/TimeoutChatAttempt.
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

Removed members

Methods

External links