TextChatMessage

Show Deprecated
Not Creatable

Immutable data object representing a text chat message.

Summary

Properties

A unique identifier for the TextChatMessage.

A general purpose field for storing miscellaneous data about the TextChatMessage.

A prefix to add to a user's message.

Indicates the status of the TextChatMessage.

The filtered text message for the user.

A reference to the origin TextChannel.

A reference to the origin TextSource.

A timestamp of when the message was originally sent.

Events

Methods

Properties

MessageId

A unique identifier for the TextChatMessage.

Metadata

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

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.

Indicates the status of the TextChatMessage.

Text

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

A reference to the origin TextChannel.

TextSource

A reference to the origin TextSource.

Timestamp

A timestamp of when the message was originally sent.

Events

Methods