TextChannel

显示已弃用

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

代表一个文字聊天频道。包含 TextSources 作为后代。

要向 TextChannel 发送聊天消息,请从 TextChannel:SendAsync() 调用 LocalScript 。该用户的相应 1>Class.TextSource1> 必须位于该频道。

不同的文字频道消息可以在聊天窗口中使用 ChannelTabsConfiguration 来分为不同的选项卡。

了解更多信息,请参阅体验内嵌文字聊天

概要

方法

回调

属性

DirectChatRequester

只读
未复制
读取并联

方法

DisplaySystemMessage

显示系统消息给用户。仅能在 LocalScriptScript 中使用,并且在 RunContext 的 1>Class.Script.RunContext|RunContext1> 中使用 4>Class.Script.Run4> 的 7>Class.Script7> 。 消息只对该用户可见,并且不会自动过滤或本

参数

systemMessage: string

系统向 TextChannel 发送系统消息。

metadata: string

用于识别系统消息类型,例如默认系统消息。

默认值:""

返回

一个 TextChatMessage ,其中 TextChatMessage.Status 属性,表示消信息的状态。

SetDirectChatRequester

void

参数

requester: Player

返回

void

AddUserAsync

暂停

添加一个 TextSourceTextChannel 给予用户的用户 id(Player.UserId )。只能在 2>Class.Script2> 中使用。

如果代表用户存在的 TextSource 不存在,这将添加一个 TextSource

如果代表用户存在的 TextSource,这将返回 TextSource

如果用户关闭聊天或不在服务器上,这将返回一个树型nilfalse

参数

userId: number

Class.Player 的用户ID。


返回

如果用户创建了一个新的 TextSource ,返回 trueTextSource ,如果 2>Class.TextSource2> 已经存在,或 5>Class.TextSource5> 已经

暂停

向服务器发送一个 TextChatMessage 。仅能在 LocalScriptScript 中使用,或在 1> Class.Script.RunContext|RunContext1> 中使用 4> Class.Script.RunContext4> 的 7> Class.Script.Run7>。

参数

message: string

发送到 TextChannel 的消息。

metadata: string

自定义数据添加到消信息。

默认值:""

返回

一个 TextChatMessage ,其中 TextChatMessage.Status 属性,表示消信息的状态。

活动

MessageReceived

喜欢 TextChatService.MessageReceived , 发生在客户端调用 TextChannel:DisplaySystemMessage() 或服务器收到有效的 TextChannel:SendAsync() 回应时。 此事件仅在客户端发生。

如果服务器的 TextChannel.ShouldDeliverCallback 属性是可以绑定的,并且返回 false ,客户端将不会发射 TextChannel.MessageReceived

使用 TextChatMessage 参数获取 TextSource 和消息的文本(含 TextChatMessage.Text)。

Class.TextChatMessage 参数是指定 TextChatService.OnIncomingMessageTextChannel.OnIncomingMessage 的所有函数的最终结果。

参数

incomingMessage: TextChatMessage

收到 TextChatMessage


回调

OnIncomingMessage

调用时 TextChannel 正在接收来自消信息。仅能在客户端实现。

使用这个来装饰 TextChatMessages 。如果此回调返回一个 TextChatMessageProperties ,那些属性将与 TextChatMessage 参数合并创建一个新的 1> Class.TextChatMessage1> 。

当发送消信息时,客户端发送消息时,此回调调用两次;首先,当消息发送到本地时,并且接受到服务器的过滤器消息,然后客户端接受到服务器的结果消息。

TextChannel.OnIncomingMessage 回调总是会在 Class.TextChatService.OnIncomingMessage 回调后运行。

这应该在源代验证码中定义一次 TextChannel 。多个对同一频道的绑定将在非 deterministic 方式中相互覆盖。

TextChatService:CreateDefaultTextChannels() 是真的时候,那些默认 TextChannels 有其内部的 TextChannel.OnIncomingMessage 回调,以显示特殊默认行为。

参数

收到的 TextChatMessage


返回

如果返回一个 TextChatMessageProperties,那些属性将与 TextChatMessage 参数合并,以创建一个新的 TextChatMessage ,并且保留这些属性。

ShouldDeliverCallback

调用每个客户端,当 TextChannel 正在接收一个进入的消息来确定它是否应该发送到该客户端。只能在服务器上定义。

一旦定义, 此回调需要返回一个值得信任的值, 例如 true , 1"hello" 来将消息发送到指定的客户端。如果回调返回任何其他值 (包括 2> nil2> ),消息将不会发送到该客户端, 但发送器仍然会看到消息。

发件人可以通过 TextChatMessage.TextSource 来参考。

参数

textSource: TextSource

返回