TextChannel¶
Represents a text chat channel.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
Represents a text chat channel. Contains TextSources as descendants.
To send a chat message to the TextChannel, call
TextChannel.SendAsync() from a LocalScript. The corresponding
TextSource of the user with TextSource.CanSend = true must be in
that channel.
Messages from different TextChannels can be separated into different tabs in the chat window using ChannelTabsConfiguration. Multiple channels with the same name might cause unexpected behavior with the chat window, even if the player isn't a member of the other channels.
To learn more, see In-Experience Text Chat.
Inheritance¶
Object → Instance → TextChannel
Properties¶
| Member | Signature | Summary |
|---|---|---|
AddPlayersOnJoin |
AddPlayersOnJoin: bool |
— |
DirectChatRequester |
DirectChatRequester: Player |
The TextChannel will only deliver messages to users that can send direct messages to the DirectChatRequester. |
IsDefaultTextChannel |
IsDefaultTextChannel: bool |
— |
Methods¶
| Member | Signature | Summary |
|---|---|---|
AddUserAsync |
TextChannel:AddUserAsync(userId: User): Tuple |
Adds a TextSource to the TextChannel given userId of a Player. |
DisplaySystemMessage |
TextChannel:DisplaySystemMessage(systemMessage: string, metadata: string): TextChatMessage |
Displays a system message to the user. |
SendAsync |
TextChannel:SendAsync(message: string, metadata: string): TextChatMessage |
Sends a TextChatMessage to the server. |
SendDictatedSpeechAsync |
TextChannel:SendDictatedSpeechAsync(message: string): TextChatMessage |
— |
SendInternalAsync |
TextChannel:SendInternalAsync(message: string, metadata: string): TextChatMessage |
— |
SendPresetAsync |
TextChannel:SendPresetAsync(presetId: string): TextChatMessage |
— |
SetDirectChatRequester |
TextChannel:SetDirectChatRequester(requester: Player): null |
Sets the DirectChatRequester for the TextChannel. The TextChannel will only deliver messages to users that can send direct mess… |
Events¶
| Member | Signature | Summary |
|---|---|---|
MessageReceived |
MessageReceived(incomingMessage: TextChatMessage) |
Fires when TextChannel.DisplaySystemMessage() is invoked on the client, or when the client receives a valid [TextChannel.SendAsync… |
Callbacks¶
| Member | Signature | Summary |
|---|---|---|
OnIncomingMessage |
OnIncomingMessage(message: TextChatMessage) -> Tuple |
Called when TextChannel is receiving an incoming message. |
ShouldDeliverCallback |
ShouldDeliverCallback(message: TextChatMessage, textSource: TextSource) -> Tuple |
Called for each client when TextChannel is receiving an incoming message to determine whether or not it should be delivered to that client. |
Roblox reference: TextChannel
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.