TextChatMessage

TextChatMessage 的唯一标识符。

用于存储有关 TextChatMessage 的杂项数据的通用字段。TextChannel:SendAsync() 和 TextChannel:DisplaySystemMessage() 的第二个参数用于填充此字段。

使用此字段在 TextChatService.OnIncomingMessage 和 TextChannel.OnIncomingMessage 回调中为特殊消息应用额外格式。

local TextChatService = game:GetService("TextChatService")

local generalChannel: TextChannel = TextChatService:WaitForChild("TextChannels").RBXGeneral

generalChannel:DisplaySystemMessage("这是一个错误！", "Game.Error.Generic")
generalChannel:DisplaySystemMessage("找不到保存数据！", "Game.Error.SaveDataNotFound")

generalChannel:DisplaySystemMessage("你赢得了游戏！", "Game.Info.Win")
generalChannel:DisplaySystemMessage("你输了游戏！", "Game.Info.Lose")

generalChannel.OnIncomingMessage = function(message: TextChatMessage)
    if string.find(message.Metadata, "错误") then
        local overrideProperties = Instance.new("TextChatMessageProperties")
        overrideProperties.TextColor = Color3.fromRGB(255, 0, 0)
        return overrideProperties
    elseif string.find(message.Metadata, "信息") then
        local overrideProperties = Instance.new("TextChatMessageProperties")
        overrideProperties.TextColor = Color3.fromRGB(0, 255, 150)
        return overrideProperties
    end

    return nil
end

以下是聊天系统发出的默认系统消息的参考：

要添加到用户消息的前缀。支持 Rich Text，因此开发人员可以为此文本设置自定义属性以支持聊天标签。

默认情况下，TextChatMessage.PrefixText 是 TextSource 的名称，它是通过 TextSource.UserId 与用户的 Player.DisplayName 关联的。

表示 TextChatMessage 的状态。

用户的过滤文本消息。不同用户可能会根据过滤规则从此属性接收不同的字符串。它可以是一个空字符串。

对原始 TextChannel 的引用。

对原始 TextSource 的引用。

消息最初发送的时间戳。

代表根据用户的本地化设置翻译和过滤后的文本消息。系统不会在具有相同本地化设置或使用没有文本过滤支持的语言之间翻译消息，因此如果没有发生翻译，此属性可以是一个空字符串。有关自定义的细节，请参见 自定义翻译的消息。