GSmGpE6CwX2y9JjB25B8
我们使用此网站上的 Cookie 增强您的用户体验

Lua 聊天系统 — 服务器 API — ChatSpeaker

Lua 聊天系统 — 服务器 API — ChatSpeaker

10 min

< Return to Lua Chat System

ChatSpeaker 表示可以在 ChatChannel 中发言的一个实体。连接到游戏的每个 Player 都会自动具有一个关联的 ChatSpeaker。可以使用 ChatService:AddSpeaker() 为非玩家(例如播音员或提示消息)构造其他 ChatSpeaker。

属性

Name

  • 类型: string Name
  • 描述: 发言人的名称,用于在调用许多其他函数时引用此发言人。

方法

JoinChannel

  • 参数: string channelName
  • 描述: 将发言人添加到具有给定 channelName 的通道中
  • 返回: void

LeaveChannel

  • 参数: string channelName
  • 描述: 从具有给定 channelName 的通道中移除发言人
  • 返回: void

GetChannelList

  • 参数:
  • 描述: 返回发言人所在的所有通道的名称列表。
  • 返回: array<string>

IsInChannel

  • 参数: string channelName
  • 描述: 返回发言人是否在具有给定 channelName 的通道中。
  • 返回: bool

SayMessage

  • 参数: string messagestring channelName、dictionary<string、Variant> extraData
  • 描述: 使发言人说出 message 并返回这样做时创建的 ChatMessage 对象。
  • 返回: ChatMessage

SendMessage

  • 参数: string messagestring channelstring fromSpeaker
  • 描述: 向具有给定的 fromSpeaker 名称的 ChatSpeaker 发送消息。如果通道中没有此类发言人,则此方法将创建警告,并且发言人将看不到此消息。
  • 返回: void

SendSystemMessage

  • 参数: string messagestring channelName
  • 描述: 向具有给定的 channelNameChatChannel 发送消息。如果通道中没有发言人,则此消息将创建警告,并且通道中的其他发言人将看不到此消息。
  • 返回: void

GetPlayer

  • 参数:
  • 描述: 返回与发言人关联的 Player 对象。如果发言人不适合玩家(机器人),则返回 nil
  • 返回: Player or nil

SetExtraData

  • 参数: string key、Variant data
  • 描述: 特定的 key 下为发言人设置一些额外的数据。发言人发送 ChatMessage 消息时,如果消息中没有明确提供任何额外的数据,就会向此消息附加额外的数据。例如,这允许设置发言人的聊天颜色。
  • 返回: void

GetExtraData

  • 参数: string key
  • 描述: 返回使用 SetExtraData 设置的与给定 key 关联的额外数据。
  • 返回: Variant

事件

SaidMessage

ReceivedMessage

ReceivedSystemMessage

ChannelJoined

  • 参数: string channelNamestring channelWelcomeMessage
  • 描述: 发言人加入具有给定 channelNameChatChannel 时触发。

ChannelLeft

  • 参数: string channelName
  • 描述: 发言人离开具有给定 channelNameChatChannel 时触发。

Muted

  • 参数: string channelNamestring reason = nilint duration = 0
  • 描述: 当发言人在具有给定 channelNameChatChannel 上静音给定的持续时间(如果提供)时触发。可能会提供,也可能不提供 reason

Unmuted

  • 参数: string channelName
  • 描述: 发言人在具有给定 channelNameChatChannel 上取消静音时触发。

ExtraDataUpdated

  • 参数: string key、Variant data
  • 描述: 当使用 SetExtraData 更新发言人额外数据中某个键的默认值时触发。

MainChannelSet

  • 参数: string channelName
  • 描述: 当发言人主通道更改为具有给定 channelNameChatChannel 时触发。