自訂聊天窗口

經驗內的文字聊天系統，由 提供支持，可讓玩家在實時體驗中簡單地交流和社交。除了支持預設文字聊天外，您還可以自定義前端使用者介面。

聊天窗口配置

總體聊天窗口包括：

• 聊天窗口
• 輸入欄
• 通道標籤(可選)

通道標籤預設為停用狀態，每個組件可以在 Studio 或通過指令碼化開啟和關閉：

在 檢索器 窗口中，擴展 TextChatService 分支並選擇 ChatWindowConfiguration 、 ChatInputBarConfiguration 或 ChannelTabsConfiguration 。然後在 屬性 窗口中啟用或禁用組件。

當 ChannelTabsConfiguration 啟用時，每個預設 TextChannel 會出現在下列表中。此外，每個自訂 TextChannel 創建一個對應通頻道的 Name 屬性的標籤。

窗口外觀

整個聊天窗口的外觀可通過 ChatWindowConfiguration 自定義。

輸入欄外觀

聊天輸入欄的外觀可通過 ChatInputBarConfiguration 自定義。

通道標籤外觀

通道標籤 的外觀可通過ChannelTabsConfiguration來調整。

自訂訊息

您可以使用 ChatWindowMessageProperties 和 TextChatService.OnChatWindowAdded 回呼來自定義聊天訊息體和前缀的外觀，而不會覆蓋現有的使用者介面。自訂選項讓您修改聊天訊息的外觀，以符合體驗主題，您也可以通過上色前缀或添加 聊天標籤 來排序或標示不同使用者群組的訊息。

顏色使用者名稱

當使用者傳送聊天訊息時，其 DisplayName 會顯示為訊息的前缀部分。預設每個使用者的名稱會依照其 Player.TeamColor 而變色，但您可以使用 ChatWindowMessageProperties 和 OnChatWindowAdded 來變更聊天名稱的顏色。下列 LocalScript 在 StarterPlayerScripts 為每個使用者指定預設顏色，隨機從 RGB 顏色表中選擇。

本地腳本 - 隨機用戶名顏色
local TextChatService = game:GetService("TextChatService")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local nameColors = {
	Color3.fromRGB(255, 0, 0),
	Color3.fromRGB(0, 255, 0),
	Color3.fromRGB(0, 0, 255),
	Color3.fromRGB(255, 255, 0),
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	local textSource = message.TextSource
	if textSource then
		local index: number = (textSource.UserId % #nameColors) + 1
		local randomColor: Color3 = nameColors[index]

    	properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		properties.PrefixTextProperties.TextColor3 = randomColor
	end

	return properties
end

您也可以使用 UIGradient 將顏色和透明度傾向應用到顏色訊息前缀上。

傾斜使用者名稱顏色
local TextChatService = game:GetService("TextChatService")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local gradient = Instance.new("UIGradient")
gradient.Color = ColorSequence.new{
	ColorSequenceKeypoint.new(0, Color3.fromRGB(255, 0, 0)),
	ColorSequenceKeypoint.new(0.5, Color3.fromRGB(255, 255, 0)),
	ColorSequenceKeypoint.new(1, Color3.fromRGB(255, 0, 255))
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	local textSource = message.TextSource
	if textSource then
    	properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		gradient:Clone().Parent = properties.PrefixTextProperties
	end

	return properties
end

豐富文字自訂

富文本 字體顏色標籤 可用於格式化聊天訊息，如果您想對訊息的特定部分進行格式化，這很有用。請注意，豐富文字不支持渐變，但以下代碼示例顯示您如何將使用者名稱(儲存在 TextChatMessage.PrefixText )移至訊息體，然後應用豐富文字標籤只於名稱部分。

豐富文字自訂
local TextChatService = game:GetService("TextChatService")
local Players = game:GetService("Players")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local gradient = Instance.new("UIGradient")
gradient.Color = ColorSequence.new{
	ColorSequenceKeypoint.new(0, Color3.fromRGB(255, 0, 0)),
	ColorSequenceKeypoint.new(0.5, Color3.fromRGB(255, 255, 0)),
	ColorSequenceKeypoint.new(1, Color3.fromRGB(255, 0, 255))
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	if message.TextSource then
		properties.PrefixText = "[VIP]"
		properties.Text = string.format("<font color='#00ffff'>%s</font>", message.PrefixText) .. " " .. message.Text

		properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		gradient:Clone().Parent = properties.PrefixTextProperties
	end

	return properties
end

從非玩家來源傳送訊息

有時候，您可能想在聊天窗口中顯示非玩家對話，例如來自公共地址系統或非玩家角色的「對話」。

系統

若要向本地玩家傳送系統訊息，請從預設 RBXGeneral 通道中呼叫 DisplaySystemMessage()，並在玩家顯示名稱前加上一個前缀。

客戶端腳本
local Players = game:GetService("Players")
local TextChatService = game:GetService("TextChatService")

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

local PREFIX = "[Guide] Welcome "

-- 向附有顯示名稱的玩家發送「系統訊息」
generalChannel:DisplaySystemMessage(PREFIX .. player.DisplayName)

若要更詳細地了解如何自訂系統訊息的外觀，請參閱 自訂系統訊息 。

預設系統訊息

當 TextChatService.CreateDefaultTextChannels 是 true 時，預設文字通道之一是 RBXSystem 頻道。預設聊天腳本會自動在此頻道中顯示系統訊息。您可以使用 TextChannel.OnIncomingMessage 回調來自定義這些訊息的外觀。

您可能想自定義或更改聊天系統自動發出的系統訊息。因為預設系統訊息是為使用者本地化的，因此如果您想自定义其外觀，您應該在 TextChatMessage.Metadata 中以 引用 它們。

以下是聊天系統發出的預設系統訊息的參考：

NPC/對象

您也可以為非玩家對話添加 聊天泡泡 來讓它看起來像來自 NPC 或 3D 世界內的物體。

客戶端腳本
local TextChatService = game:GetService("TextChatService")
local Workspace = game:GetService("Workspace")

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

TextChatService.OnIncomingMessage = function(textChatMessage: TextChatMessage)
	local properties = Instance.new("TextChatMessageProperties")

	-- 檢查包含元數據的系統訊息
	if not textChatMessage.TextSource and textChatMessage.Metadata ~= "" then

		-- 添加前缀以使訊息看起來像是由玩家發送
		properties.PrefixText = string.format("<font color='#%s'>%s: </font>", "#50C999", textChatMessage.Metadata)

		-- 新增對話泡泡
		TextChatService:DisplayBubble(Workspace.Statue, textChatMessage.Text)
	end

	return properties
end

local message = "Welcome! I will be your guide."
local speakerName = "Ancient Knight"
generalChannel:DisplaySystemMessage(message, speakerName)