Skip to main content

Class: ChatSendBeforeEvent

An event that fires as players enter chat messages.

Constructors​

new ChatSendBeforeEvent()​

private new ChatSendBeforeEvent(): ChatSendBeforeEvent

Returns​

ChatSendBeforeEvent

Properties​

cancel​

cancel: boolean

Remarks​

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

message​

readonly message: string

Remarks​

Message that is being broadcast.

sender​

readonly sender: Player

Remarks​

Player that sent the chat message.

targets?​

optional readonly targets: Player[]

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.)