Class ChatSendBeforeEventBeta

An event that fires as players enter chat messages.

Hierarchy

Constructors

Properties

cancel: boolean

Remarks

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

message: string

Remarks

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

Remarks

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

sender: Player

Remarks

Player that sent the chat message.

Methods

  • Returns Player[]

    List of player objects.

    Remarks

    List of players that will receive this message.

  • Parameters

    • players: Player[]

      Updated array of players that should receive this message.

    Returns void

    Remarks

    Sets an updated list of players that will receive this message.