Roblox Wiki
Roblox Wiki
36,934
pages

The TextChatService class inherits from Instance. It cannot be instantiated. It was added in version 496 (September 2021). It enables the new TextChatService Chat system.

Properties

ChatTranslationEnabled: bool

  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextChatService/ChatTranslationEnabled.
  • Category: Data.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ChatTranslationFTUXShown: bool

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

ChatTranslationToggleEnabled: bool

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

ChatVersion: ChatVersion

This class member is missing documentation. Create or add to its subpage at Class:TextChatService/ChatVersion.
  • Category: Data.
  • Write security: RobloxScriptSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

CreateDefaultCommands: bool

This class member is missing documentation. Create or add to its subpage at Class:TextChatService/CreateDefaultCommands.
  • Category: Data.
  • Write security: PluginSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

CreateDefaultTextChannels: bool

This class member is missing documentation. Create or add to its subpage at Class:TextChatService/CreateDefaultTextChannels.
  • Category: Data.
  • Write security: PluginSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

HasSeenDeprecationDialog: bool

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

IsLegacyChatDisabled: 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:TextChatService/IsLegacyChatDisabled.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • 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

CanUsersDirectChatAsync(requesterUserId: int64, userIds: Array): Array

  • YieldsThis function can yield the script it is used in.
This class member is missing documentation. Create or add to its subpage at Class:TextChatService/CanUsersDirectChatAsync.
  • Thread safety: unsafe

CanUsersWhisperAsync(fromUserId: int64, toUserId: int64): bool

  • YieldsThis function can yield the script it is used in.
This class member is missing documentation. Create or add to its subpage at Class:TextChatService/CanUsersWhisperAsync.
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

DisplayBubble(partOrCharacter: Instance, message: string): null

Parameters
NameType
partOrCharacterInstance
messagestring
  • Thread safety: unsafe

SendExpChatLoadSuccess(loadingLatency: int): null

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

SendExpChatMessageClientRendered(textChatMessage: TextChatMessage, messageRenderedSurface: string = unknown): null

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

SendExpChatWindowScroll(): null

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

SendExpChatWindowStatusChange(timeClosed: int, timeOpen: int, timeBackgroundIdle: int, timeTextIdle: int): null

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

Events

BubbleDisplayed(partOrCharacter: Instance, textChatMessage: TextChatMessage)

Parameters
NameType
partOrCharacterInstance
textChatMessageTextChatMessage
  • Thread safety: unsafe

MessageReceived(textChatMessage: TextChatMessage)

Parameters
NameType
textChatMessageTextChatMessage
  • Thread safety: unsafe

SendingMessage(textChatMessage: TextChatMessage)

Parameters
NameType
textChatMessageTextChatMessage
  • Thread safety: unsafe

Callbacks

OnBubbleAdded(message: TextChatMessage, adornee: Instance): Tuple

Parameters
NameType
messageTextChatMessage
adorneeInstance
  • Thread safety: unsafe

OnChatWindowAdded(message: TextChatMessage): Tuple

This class member is missing documentation. Create or add to its subpage at Class:TextChatService/OnChatWindowAdded.
  • Thread safety: unsafe

OnIncomingMessage(message: TextChatMessage): Tuple

Parameters
NameType
messageTextChatMessage
  • Thread safety: unsafe

Removed members

Properties

  • isLegacyChatDisabled


External Links[]