TextChatMessage

Show Deprecated
not creatable

Immutable data object representing a text chat message.

To learn more about using TextChatMessages, see In-Experience Text Chat.

Summary

Properties

Properties

BubbleChatMessageProperties

read parallel

MessageId

read parallel

A unique identifier for the TextChatMessage.

Metadata

read parallel

A general purpose field for storing miscellaneous data about the TextChatMessage. The second argument of TextChannel:SendAsync() and TextChannel:DisplaySystemMessage() is used to populate this field.

If TextChatService.CreateDefaultTextChannels is true, default system messages sent to the system channel have unique TextChatMessage.Metadata values.

Use this field to apply additional formatting for special messages within TextChatService.OnIncomingMessage and TextChannel.OnIncomingMessage callbacks.

PrefixText

read parallel

A prefix to add to a user's message. This supports Rich Text, so developers can set custom properties for this text to support chat tags.

By default, TextChatMessage.PrefixText is the name of the TextSource, which is the Player.DisplayName of the user associated with the TextSource via TextSource.UserId.

read parallel

Indicates the status of the TextChatMessage.

Text

read parallel

The filtered text message for the user. Different users may receive different strings from this property based on filtering rules. It can be an empty string.

TextChannel

read parallel

A reference to the origin TextChannel.

TextSource

read parallel

A reference to the origin TextSource.

Timestamp

read parallel

A timestamp of when the message was originally sent.

Translation

read parallel

Represents translated and filtered text messages based on users' localization settings. The system doesn't translate messages between users with the same localization settings or using languages without the text filter support, so this property can be an empty string if no translation happens. For customization, see Customizing Translated Messages.

Methods

Events