For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server/classes/ChatSendBeforeEvent.md.

Class: ChatSendBeforeEvent experimental

event

Beta

当玩家输入聊天消息时触发的事件。

An event that fires as players enter chat messages.

Properties

cancel

cancel: boolean

Beta

Remarks

如果在 beforeChat 事件处理程序中设置为 true,则此消息不会广播出去。

If set to true in a beforeChat event handler, this message is not broadcast out.


message

readonly message: string

Beta

Remarks

正在广播的消息。

Message that is being broadcast.


sender

readonly sender: Player

Beta

Remarks

发送聊天消息的玩家。

Player that sent the chat message.


targets?

readonly optional targets?: Player[]

Beta

Remarks

可选的要接收此消息的玩家列表。如果已定义,此消息将直接发送给一个或多个玩家(即不进行广播)。

Optional list of players that will receive this message. If defined, this message is directly targeted to one or more players (i.e., is not broadcast.)

同领域相关