客户端聊天模块

*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按此处。

本指南涵盖传统聊天系统的客户端聊天模块，其已被弃用并不再为新用户提供入门。如果您使用 TextChatService 与更轻松、更现代的聊天设置，请参阅TextChatService。

您可以使用以下聊天模块支持客户端对传统聊天系统的客户端行为。

聊天窗口

聊天窗口是传统聊天系统客户端的主要聊天模块。

方法

添加频道

参数： string : channelName
描述：添加一个 ChatChannelUI 用 channelName 给窗口。
返回： ChatChannelUI

移除频道

参数： string : channelName
描述：移除一个 ChatChannelUI 用 channelName 从窗口。
返回：无

获取频道

参数： string : channelName
描述：获取 ChatChannelUI 用指定的 channelName 如果它存在。
返回： ChatChannelUI 或 nil

获取当前频道

参数： string : channelName
描述：返回当前 ChatChannelUI 。
返回： ChatChannelUI

切换当前频道

参数： string : channelName
描述：切换当前频道到 ChatChannelUI 中，如果它存在，它将返回给 channelName 。
返回：无

可见

参数：无
描述：返回是否显示窗口。注意：此处指的是聊天界面的整通用; 当聊天窗口因无聊而变得透明时，窗口仍然被视为可见。
返回：是否：

可见设置

参数：是/否： : visible
描述：设置聊天窗口的可见度。
返回：无

渐变背景

参数：漂浮 : duration
描述：在给定的 duration 后，背景将会渐渐消失。注意：后续调用控制渐变将覆盖以前的调用。
返回：无

FadeInBackground 背景

参数：漂浮 : duration
描述：在指定的 duration 后逐渐消失。注意：后续调用控制渐变/退出将覆盖以前的调用。
返回：无

渐变文本

参数：漂浮 : duration
描述：在指定的 duration 秒内，文本会渐变消失。注意：后续调用控制渐变的/出现的调用将覆盖以前的调用。
返回：无

在文本中渐变

参数：漂浮 : duration
描述：在给定的 duration 内的文本中渐变。注意：后续调用控制渐变/退出将覆盖以前的调用。
返回：无

聊天栏

聊天栏处理 Lua 聊天系统的客户端文本条目。聊天栏由两个主要组成部分：

聊天栏，一个 TextBox ，在 котором玩家输入消息和命令（高亮在橙色）
消息模式， TextLabel ，可以显示发送的消息的信息 (高亮为绿色)

方法

获取更多信息

参数：无
描述：返回聊天栏的 TextBox。
返回： TextBox

获取消息模式文本标签

参数：无
描述：返回消息模式 TextLabel。
返回： TextLabel

是否专注

参数：无
描述：返回聊天栏的 TextBox 是否在焦点上（玩家正在输入方块）。相当于调用 GetSTM 上的 TextBox:IsFocused 。
返回：是否：

集中焦点

参数：无
描述：强制客户端专注在聊天栏的 TextBox 上。相当于调用 TextBox:CaptureFocus 在 GetExecutor 的结果上。
返回：无

释放焦点

参数：是/否： : submitted = false
描述：将聊天栏的焦点关闭 TextBox 。如果 submitted 是真的，这会像玩家按“Enter”发送消信息一样。
返回：无

重置文本

参数：无
描述：将聊天栏的 Text 设置为空字符串。
返回：无

设置菜单文本

参数： string : text
描述：将聊天栏的 Text 设置为 TextBox 的给定 0> text0> 。
返回：无

获取 Texas 文本

参数：无
描述：返回聊天栏中的文本 TextBox.Text 。
返回： string

设置文本标签文本

参数： string : text
描述：将 Text 的MessageMode TextLabel 设置为 0>text0> 。
返回：无

获取启用

参数：无
描述：返回是否返回聊天栏 Visible 。
返回：是否：

设置启用

参数：是/否： : enabled
描述：设置聊天栏是否Visible。
返回：无

设置文本大小

参数： int : textSize
描述：设置聊天栏的 TextSize 和 TextBox 以及消息模式的 0> TextLabel0> 。
返回：无

重置大小

参数：无
描述：将聊天栏的大小重置为一行文本。
返回：无

设置频道目标

参数： string : channelName
描述：将目标 ChatChannelUI 设置给其 channelName ，聊天栏应向其提交消息。
返回：无

渐变背景

参数：漂浮 : duration 0> duration0>
描述：在给定的 duration 后，背景将会渐渐消失。注意：后续调用控制渐变将覆盖以前的调用。
返回：无

FadeInBackground 背景

参数：漂浮 : duration 0> duration0>
描述：在指定的 duration 后逐渐消失。注意：后续调用控制渐变/退出将覆盖以前的调用。
返回：无

渐变文本

参数：漂浮 : duration 0> duration0>
描述：在指定的 duration 秒内，文本会渐变消失。注意：后续调用控制渐变的/出现的调用将覆盖以前的调用。
返回：无

在文本中渐变

参数：漂浮 : duration 0> duration0>
描述：在给定的 duration 内的文本中渐变。注意：后续调用控制渐变/退出将覆盖以前的调用。
返回：无

聊天频道用户界面

聊天频道用户界面是聊天频道的客户端版本。它从服务器收到聊天消息并将它们传递给聊天消息显示。与它相关的聊天消息显示显示。

方法

添加消息到频道

参数：聊天消息
描述：从服务器收到的聊天消息添加到聊天MessageLogDisplay。
返回：无

从频道中移除最后一条消息

参数：无
描述：移除在 ChatMessageLogDisplay 中找到的最旧的聊天消息。
返回：无

清除消息日志

参数：无
描述：移除所有聊天消息在聊天消息显示中。
返回：无

聊天消息记录

聊天消息显示器显示聊天消息，在聊天频道中。

方法

添加消息

参数：聊天消息 message
描述：添加一个 message 到消息日志显示。
返回：无

移除最后一条消息

参数：无
描述：移除在消息日志显示中最旧的 ChatMessage 。
返回：无

重新排序所有消息

参数：无
描述：重新排序所有消息显示，根据消息显示大小。这应该是调整消息日志显示大小的时候调用。
返回：无

清除

参数：无
描述：从消息日志显示器中移除所有聊天消息。
返回：无

渐变文本

参数：漂浮 duration
描述：在指定的 duration 秒内，文本会渐变消失。注意：后续调用控制渐变的/出现的调用将覆盖以前的调用。
返回：无

在文本中渐变

参数：漂浮 duration
描述：在给定的 duration 内的文本中渐变。注意：后续调用控制渐变/退出将覆盖以前的调用。
返回：无

聊天自定义状态

聊天自定义状态是在聊天栏中创建自定义聊天状态时使用的接口。

悄悄聊天和团队聊天使用 ChatCustomState 指向玩家发送消息的地方。

调用

文本更新

参数：无
描述：在聊天栏中更新时调用。
返回：无

获取消息

参数：无
描述：调用以恢复单个命令的文本，如果它将以单个命令的形式写入服务器，这将是服务器在处理命令时需要处理命令的文本的情况。
返回： string

处理完成消息

参数：无
描述：调用时玩家提交的信息处理器的状态。如果消息不应显示或发送到服务器，这应该返回 true。
返回：是否：

摧毁

参数：无
描述：被称为聊天栏正在重置以前的状态，以便在自定义状态修改之前恢复到其原始状态。
返回：无

聊天设置

ChatSettings 是 Lua 聊天系统的客户端设置的字典。它们存储在一个名为 ModuleScript 的 ModuleScript 中，该游戏服务在 1>Chat1> 游戏中的客户端下。模块可能需要，它的属性可以在运行时更改。

要更改设置，请使用 LocalScript 在以下方式使用：


-- 需要聊天设置模块 (等待它加载)
local Chat = game:GetService("Chat")
local ClientChatModules = Chat:WaitForChild("ClientChatModules")
local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))
-- 更改设置，就像你所做的任何其他表。
ChatSettings.MaximumMessageLength = 100

聊天行为设置

可拖动窗口

类型：是/否
默认： false
描述：确定聊天窗口是否为Draggable。

可调整窗口

类型：是/否
默认： false
描述：确定聊天窗口是否可以由玩家调整大小

游戏手柄导航已启用

类型：是/否
默认： false
描述：确定是否支持游戏手柄导航聊天界面。

显示用户拥有过滤器的消息

类型：是/否
默认： true
描述：确定玩家是否应该看到过滤版本的聊天消息，或是他们键入的原始内容。

聊天框架顶部栏

类型：是/否
默认： false
描述：确定聊天界面是否启用，即使顶部栏已禁用。

泡泡聊天已启用

类型：是/否
默认： game:GetService("Players").BubbleChat
描述：确定是否启用泡泡聊天。

启用经典聊天

类型：是/否
默认： game:GetService("Players").ClassicChat
描述：确定是否启用经典聊天。

聊天文本大小设置

聊天窗口文本大小

类型： int
默认： 18
描述：确定聊天窗口中的文本大小。

聊天栏文本大小

类型： int
默认： 18
描述：确定聊天栏中的文本大小。

聊天窗口文本大小

类型： int
默认： 14
描述：确定聊天窗口（为手机）的文本大小。

聊天栏文本大小

类型： int
默认： 14
描述：确定聊天栏中的文本大小。

字体设置

默认字体

类型： Enum.Font
默认： Enum.Font.SourceSansBold
描述：确定 Font 的默认值。

聊天字体

类型： Enum.Font
默认： Enum.Font.SourceSansBold
描述：确定 Font 的默认值 Executor 。

颜色设置

背景颜色

类型： Color3
默认： Color3.new(0, 0, 0)
描述：确定 BackgroundColor3 的聊天窗口。

默认消息颜色

类型： Color3
默认： Color3.new(1, 1, 1)
描述：确定默认 TextColor3 的聊天消息在 0>聊天窗口0> 中。

默认名称颜色

类型： Color3
默认： Color3.new(1, 1, 1)
描述：确定 TextColor3 的默认值，并且在聊天窗口中的聊天名称的扬声器名称。

聊天栏背景颜色

类型： Color3
默认： Color3.new(0, 0, 0)
描述：确定 BackgroundColor3 的聊天栏。

聊天栏框色

类型： Color3
默认： Color3.new(1, 1, 1)
描述：确定聊天栏的BackgroundColor3。

聊天栏文本颜色

类型： Color3
默认： Color3.new(0, 0, 0)
描述：确定 TextColor3 的 ChatBar 。

错误消息文本颜色

类型： Color3
默认： Color3.fromRGB(245, 50, 50)
描述：确定错误消息的 TextColor3 。

窗口设置

最小窗口大小

类型： UDim2
默认值： UDim2.new(0.3, 0, 0.25, 0)
描述：确定聊天窗口的最小尺寸 (given that 窗户可调整已启用).

最大窗口尺寸

类型： UDim2
默认： UDim2.new(1, 0, 1, 0)
描述：确定聊天窗口的最大可能尺寸 (given that 窗户可调整已启用).
注意：如果此选项改为屏幕尺寸的更大，大小/位置边界检查时会发生奇怪的事情。

默认窗口位置

类型： 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
描述：确定要在渐变窗口背景消失后，聊天窗口的背景应该持续多久。

聊天窗口文本渐变时间

类型：漂浮 (秒)
默认： 30
描述：确定要使用 ChatWindow 文本渐变的时间。

聊天默认时长

类型：漂浮 (秒)
默认： 0.8
描述：确定聊天界面的渐变是否需要更长时间。

聊天应该从新信息中消失

类型：是/否
默认： false
描述：确定聊天是否在接收新消息时消失。

聊天动画FPS

类型：漂浮
默认： 20.0
描述：确定聊天界面中渐变动画的帧率。

频道设置

通用频道名称

类型： string
默认： "All"
描述：确定默认频道的名称。

通用频道消息

类型：是/否
默认： true
描述：确定是否要将消息传递到其他于默认频道的频道。

最大通道名称长度

类型： int
默认： 12
描述：确定管道名称的最大长度，然后它会被切分。

每个频道的消息长度

类型： int
默认： 50
描述：确定最多可以在聊天频道中显示的聊天消息数量。

显示加入和离开帮助文本

类型：是/否
默认： false
描述：决定是否显示加入/离开频道的帮助文本。

消息设置

最大消息长度

类型： int
默认值： 200
描述：确定 ChatMessages 的最大长度。

不允许白色空格

类型：阵列< string >
默认： {"\n", "\r", "\t", "\v", "\f"}
描述：确定禁止的空格字符。

点击玩家名称

类型：是/否
默认： true
描述：确定玩家是否可以点击其他玩家的名称以进行悄悄聊天。

单击主频道名称设置

类型：是/否
默认： true
描述：确定玩家是否可以点击频道选项卡以设置它为主频道。

其他设置

喝气指令自动完成玩家名称

类型：是/否
默认： true
描述：确定是否要自动完成玩家名称。

事件

已更改设置

参数： string settingName，变体 0> newValue0>
描述：设置与指定的 settingName 值改为 newValue 时触发。