客戶端聊天模組

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

您可以使用以下聊天模組來支援 Legacy Chat System 的客戶端行為。

聊天視窗

聊天視窗 是傳統聊天系統客戶端的主要聊天模組。

方法

添加通道

移除通道

  • 參數： string : channelName
  • 說明： 移除 ChatChannelUI 用 channelName 從窗口。
  • 返回： 無效

取得頻道

取得當前頻道

切換現有頻道

  • 參數： string : channelName
  • 說明： 切換目前的頻道至 ChatChannelUI 並且提供 channelName 如果存在。
  • 返回： 無效

可見

  • 參數： 無
  • 說明： 返回窗口是否可見或不可見。注意：此為一般聊天界面的說明；當聊天窗口因閒置而消失時，窗口仍然被視為可見。
  • 返回： 是/否

可見設定

  • 參數： Boolean : visible
  • 說明： 設定聊天視窗的可見度。
  • 返回： 無效

漸漸漸漸漸

  • 參數： 漂浮 : duration
  • 說明： 在指定的 duration 秒內移除背景。 注意：稍後對控制漸漸消失的呼叫將覆蓋較早的呼叫。
  • 返回： 無效

FadeIn 背景

  • 參數： 漂浮 : duration
  • 說明： 在指定的 duration 後在背景中消失。 注意：稍後對控制漸漸消失的呼叫將覆蓋以前的呼叫。
  • 返回： 無效

漸出文字

  • 參數： 漂浮 : duration
  • 說明： 在指定的 duration 內漸漸消失。 注意：稍後對漸漸消失的控制將覆蓋上一次的控制。
  • 返回： 無效

FadeIn 文字

  • 參數： 漂浮 : duration
  • 說明： 在指定的 duration 內漸漸消失。注意：稍後對漸漸消失的控制將覆蓋以前的呼叫。
  • 返回： 無效

聊天視窗

聊天視窗 處理 Lua 聊天系統的客戶端文字輸入。聊天視窗有兩個關鍵組件：

  • 聊天視窗 ， TextBox ， 玩家輸入訊息和指令（以橙色標示）
  • 訊息模式 ，包括一個 TextLabel ，可以顯示發送的訊息的信息（綠色標示）

方法

取得額號

  • 參數： 無
  • 說明： 返回聊天欄中的 TextBox。
  • 返回： TextBox

取得訊息模式文字標籤

  • 參數： 無
  • 說明： 返回 MessageMode TextLabel。
  • 返回： TextLabel

是否專注

  • 參數： 無
  • 說明： 返回聊天欄是否在焦點 (玩家正在輸入方塊) 。 與結果 Get–Texture:IsFocused 相同。
  • 返回： 是/否

專注度

  • 參數： 無
  • 說明： 強制客戶端專注於聊天欄中的 TextBox 。與結果 Get–ResultScript 相同。
  • 返回： 無效

釋放焦點

  • 參數： 是/否 : submitted = false
  • 說明： 重新設定聊天栏的焦點 TextBox。如果 submitted 是真的，這就會像玩家按Enter提交訊息一樣。
  • 返回： 無效

重設文字

  • 參數： 無
  • 說明： 設置聊天區的 Text 的聊天欄位 TextBox 為空字串。
  • 返回： 無效

設定術語文字

  • 參數： string : text
  • 說明： 設置聊天區的 Text 到指定的 TextBox 。
  • 返回： 無效

取得 Texas 文字

  • 參數： 無
  • 說明： 返回聊天欄中的文字 TextBox.Text 。
  • 返回： string

設定文字標籤文字

  • 參數： string : text
  • 說明： 設置 MessageMode Text 的 TextLabel 到指定的 0> text0> 。
  • 返回： 無效

啟用

  • 參數： 無
  • 說明： 返回聊天欄是否為 Visible 。
  • 返回： 是/否

設定啟用

  • 參數： 是/否 : enabled
  • 說明： 設定聊天栏是否為Visible。
  • 返回： 無效

設定文字大小

  • 參數： int : textSize
  • 說明： 設置聊天栏的 TextSize 和訊息模式的 TextBox。
  • 返回： 無效

重設尺寸

  • 參數： 無
  • 說明： 重設聊天視窗的大小為一條文字線。
  • 返回： 無效

設定通道目標

  • 參數： string : channelName
  • 說明： 設置目標 ChatChannelUI 給其 channelName ，以便聊天室提交訊息。
  • 返回： 無效

漸漸漸漸漸

  • 參數： 漂浮 : duration 0> duration0>
  • 說明： 在指定的 duration 秒內移除背景。 注意：稍後對控制漸漸消失的呼叫將覆蓋較早的呼叫。
  • 返回： 無效

FadeIn 背景

  • 參數： 漂浮 : duration 0> duration0>
  • 說明： 在指定的 duration 後在背景中消失。 注意：稍後對控制漸漸消失的呼叫將覆蓋以前的呼叫。
  • 返回： 無效

漸出文字

  • 參數： 漂浮 : duration 0> duration0>
  • 說明： 在指定的 duration 內漸漸消失。 注意：稍後對漸漸消失的控制將覆蓋上一次的控制。
  • 返回： 無效

FadeIn 文字

  • 參數： 漂浮 : duration 0> duration0>
  • 說明： 在指定的 duration 內漸漸消失。注意：稍後對漸漸消失的控制將覆蓋以前的呼叫。
  • 返回： 無效

聊天室UI

聊天채널UI 是 聊天채널 的客戶端版本。它從服務器收到 聊天訊息 並將它們傳送至 1>聊天訊息顯示1> 。與它相關的。

方法

添加訊息至頻道

從頻道移除最後一個訊息

清除訊息記錄

聊天訊息記錄

聊天訊息顯示 管理 聊天訊息 在 聊天ChannelUI 中的渲染。

方法

添加訊息

  • 參數： 聊天訊息 message
  • 說明： 在訊息記錄顯示中添加 message 。
  • 返回： 無效

移除最後一個訊息

  • 參數： 無
  • 說明： 移除訊息記錄顯示中最舊的 聊天訊息。
  • 返回： 無效

重新排序所有訊息

  • 參數： 無
  • 說明： 重新排序所有訊息顯示，按照訊息顯示大小的增加順序。這應該是個要被稱為訊息記錄顯示的變更。
  • 返回： 無效

清除

  • 參數： 無
  • 說明： 移除所有 聊天訊息 從訊息記錄顯示。
  • 返回： 無效

漸出文字

  • 參數： 漂浮duration
  • 說明： 在指定的 duration 內漸漸消失。 注意：稍後對漸漸消失的控制將覆蓋上一次的控制。
  • 返回： 無效

FadeIn 文字

  • 參數： 漂浮duration
  • 說明： 在指定的 duration 內漸漸消失。注意：稍後對漸漸消失的控制將覆蓋以前的呼叫。
  • 返回： 無效

聊天自訂狀態

聊天自訂狀態是一個 接口 的回撥機制，可用於在聊天欄中創建自訂聊天狀態。

偷偷聊天和團隊聊天使用 ChatCustomState 指示玩家他們的訊息將被發送到哪裡。

回調

文字更新

  • 參數： 無
  • 說明： 會在聊天區的文字更新時呼叫。
  • 返回： 無效

取得訊息

  • 參數： 無
  • 說明： 呼叫，以取回發送為單一指令的訊息的文字。這是在服務器需要處理指令為文字而不是視覺化狀態的情況下使用的。
  • 返回： string

已完成訊息

  • 參數： 無
  • 說明： 會在玩家提交狀態自訂器處理的訊息時呼叫。這應該會在訊息不應該顯示或傳送到服務伺服器時返回 true。
  • 返回： 是/否

摧毀

  • 參數： 無
  • 說明： 以 聊天視窗 的名稱重設為原始狀態，以前儲存的狀態將在自訂狀態修改之前儲存。
  • 返回： 無效

聊天設定

ChatSettings 是 Lua 聊天系統的客戶端設定典禮。它們存放在 ModuleScript 中，名為 ChatSettings ，可以在 1>Chat1> 遊戲服務中找到。模組可以需要並且它們的屬性可以在執行時

若要變更設定，請使用 LocalScript 在下列方式來變更：

-- 需要聊天設定模組 (等待載入)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))

-- 改變您與任何其他桌子的設定。

ChatSettings.MaximumMessageLength = 100

聊天行為設定

可拖曳視窗

  • 類型: bool
  • 預設值： false
  • 說明： 確定 聊天視窗 是否為 Draggable 。

可重新設定窗口大小

  • 類型: bool
  • 預設值： false
  • 說明： 決定玩家是否可以調整 聊天視窗 的大小

啟用遊戲手柄導航

  • 類型: bool
  • 預設值： false
  • 說明： 決定遊戲控制器是否能夠瀏覽聊天 UI。

顯示使用者自定義過濾器訊息

  • 類型: bool
  • 預設值： true
  • 說明： 決定玩家是否應該看到過濾版本的聊天訊息，或是否看到他們輸入的原始內容。

聊天室外掛

  • 類型: bool
  • 預設值： false
  • 說明： 決定聊天 UI 是否啟用，即使檢視欄位已停用。

啟用泡泡聊天

  • 類型: bool
  • 預設值： game:GetService("Players").BubbleChat
  • 說明： 決定是否啟用泡泡聊天。

啟用經典聊天

  • 類型: bool
  • 預設值： game:GetService("Players").ClassicChat
  • 說明： 決定是否啟用經典聊天。

聊天文字大小設定

聊天視窗文字大小

  • 類型: int
  • 預設值： 18
  • 說明： 決定聊天視窗內的文字大小。

聊天視窗文字大小

  • 類型: int
  • 預設值： 18
  • 說明： 決定聊天視窗內的文字大小。

聊天視窗文字大小

  • 類型: int
  • 預設值： 14
  • 說明： 確定電話的 聊天視窗 的文字大小。

聊天視窗大小

  • 類型: int
  • 預設值： 14
  • 說明： 確定電話上的聊天視窗的文字大小。

字體設定

預設字體

聊天字體

顏色設定

背景顏色

  • 類型: Color3
  • 預設值： Color3.new(0, 0, 0)
  • 說明： 決定 BackgroundColor3 的 聊天窗戶 。

預設訊息顏色

  • 類型: Color3
  • 預設值： Color3.new(1, 1, 1)
  • 說明： 決定 TextColor3 的預設值 在 聊天窗口 中。

預設名稱顏色

  • 類型: Color3
  • 預設值： Color3.new(1, 1, 1)
  • 說明： 決定 TextColor3 的講師名稱在 聊天窗口 中的預設值。

聊天視窗背景顏色

  • 類型: Color3
  • 預設值： Color3.new(0, 0, 0)
  • 說明： 決定 BackgroundColor3 的 聊天視窗 。

聊天視窗顏色

  • 類型: Color3
  • 預設值： Color3.new(1, 1, 1)
  • 說明： 確定 BackgroundColor3 的 ChatBar 0>Executor0>。

聊天欄文字顏色

  • 類型: Color3
  • 預設值： Color3.new(0, 0, 0)
  • 說明： 決定 TextColor3 的 聊天視窗 。

錯誤訊息文字顏色

  • 類型: Color3
  • 預設值： Color3.fromRGB(245, 50, 50)
  • 說明： 決定錯誤訊息的 TextColor3。

視窗設定

最小視窗尺寸

  • 類型: UDim2
  • 預設值： UDim2.new(0.3, 0, 0.25, 0)
  • 說明： 確定 聊天視窗 的最小尺寸 (視窗可調整為可調整的 WindowResizable 的情況下)。

最大視窗尺寸

  • 類型: UDim2
  • 預設值： UDim2.new(1, 0, 1, 0)
  • 說明： 決定 聊天視窗 的最大尺寸 (視窗可調整為可容納的 窗戶寬度 （視窗可調整為可容納的 0>視窗寬度0>）。
  • 注意： 如果此項目變更為超過全螢幕尺寸，大小/位置限制檢查時會發生奇怪的事件。

預設視窗位置

  • 類型: UDim2
  • 預設值： UDim2.new(0, 0, 0, 0)
  • 說明： 決定 聊天視窗 的預設位置。

預設視窗尺寸電話

  • 類型: UDim2
  • 預設值： UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
  • 說明： 決定手機上的 聊天視窗 的預設尺寸。

預設視窗尺寸表

  • 類型: UDim2
  • 預設值： UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
  • 說明： 決定桌子上的 聊天視窗 的預設尺寸。

預設視窗尺寸

  • 類型: UDim2
  • 預設值： UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
  • 說明： 確定 聊桌面視窗 的預設尺寸。

在設定中退出和重新設置

聊天視窗背景淡出時間

  • 類型: 漂浮 (秒)
  • 預設值： 0.5
  • 說明： 決定 ChatWindow 背景漸漸消失的時間。

聊天視窗文字淡出時間

  • 類型: 漂浮 (秒)
  • 預設值： 30
  • 說明： 決定要從 聊天視窗 文字中漸漸消失的時間。

聊天預設時效

  • 類型: 漂浮 (秒)
  • 預設值： 0.8
  • 說明： 決定要使用的聊天 UI 元素淡出時間。

聊天應該從新資訊中消失

  • 類型: bool
  • 預設值： false
  • 說明： 決定聊天室應在收到新訊息時是否淡出。

聊天動畫FPS

  • 類型： 漂浮
  • 預設值： 20.0
  • 說明： 決定聊天 UI 中漸漸動畫的速率。

頻道設定

一般通道名稱

  • 類型: string
  • 預設值： "All"
  • 說明： 決定預設頻道的名稱。

一般通道消息

  • 類型: bool
  • 預設值： true
  • 說明： 決定是否要將訊息傳送至其他非預設頻道。

最大通道名稱長度

  • 類型: int
  • 預設值： 12
  • 說明： 確定通道名稱的最大長度，然後它就會被切斷。

訊息歷史長度每頻道

  • 類型: int
  • 預設值： 50
  • 說明： 決定顯示在聊天頻道中顯示的 聊天訊息 最大數量。

顯示加入和離開協助文字

  • 類型: bool
  • 預設值： false
  • 說明： 決定要顯示儲存/離開頻道的說明。

訊息設定

最大訊息長度

  • 類型: int
  • 預設值： 200
  • 說明： 確定 聊天訊息 的最大長度。

禁用白色空格

  • 類型: 列表< string >
  • 預設值： {"\n", "\r", "\t", "\v", "\f"}
  • 說明： 確定不允許的白色角色。

點擊玩家名稱以偷偷

  • 類型: bool
  • 預設值： true
  • 說明： 決定玩家是否可以點擊其他玩家的名稱以進行偷偷聊天。

點擊頻道名稱設定主頻道

  • 類型: bool
  • 預設值： true
  • 說明： 決定玩家是否可以點擊頻道的標籤來設定為主頻道。

其他設定

偷偷指令自動完成玩家名稱

  • 類型: bool
  • 預設值： true
  • 說明： 決定是否要自動完成玩家名稱。

事件

設定已變更

  • 參數： string settingName ，變體 0> newValue0>
  • 說明： 設定與指定的 settingName 變更為 newValue 時會發生。