Class BeforeChatEvent

An event that fires as players enter chat messages.

Hierarchy

  • BeforeChatEvent

Constructors

Properties

cancel: boolean

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

message: string

Message that is being broadcast. In a beforeChat event handler, message can be updated with edits before the message is displayed to players.

sendToTargets: boolean

If true, this message is directly targeted to one or more players (i.e., is not broadcast.)

sender: Player

Player that sent the chat message.

targets: Player[]

List of players that will receive this message.