代表文字聊天訊息的不可變更數據對象。
要了解更多關於使用 TextChatMessages 的信息,請參閱 體驗內文字聊天。
概要
屬性
對 TextChatMessage 的獨特標識。
一個通用的欄位,用於存儲有關 TextChatMessage 的各種雜項數據。
一個前缀,可添加到使用者的訊息。
指示 TextChatMessage 的狀態。
對使用者的過濾文字訊息。
參考來源 TextChannel 。
參考來源 TextSource 。
訊息最初傳送時的時戳。
翻譯和過濾的文字訊息。
屬性
BubbleChatMessageProperties
ChatWindowMessageProperties
Metadata
一個通用的欄位,用於存儲有關 TextChatMessage 的各種雜項數據。TextChannel:SendAsync() 和 TextChannel:DisplaySystemMessage() 的第二個參數用於填充此欄位。
如果 TextChatService.CreateDefaultTextChannels 是 true,系統傳送到系統通道的預設系統訊息具有獨特的 TextChatMessage.Metadata 值。
使用此欄位來應用 TextChatService.OnIncomingMessage 和 TextChannel.OnIncomingMessage 回呼中特殊訊息的額外格式。
PrefixText
用於添加到使用者的訊息的前缀。這支持豐富文字,因此開發人員可以為此文字設定自訂屬性,以支持聊天標籤。
預設情況下,TextChatMessage.PrefixText 是指與 TextSource 通過 Player.DisplayName 相關的使用者的名稱,這是 TextSource 的 TextSource.UserId 。