Script API - v26.50.24
    Preparing search index...

    Class ChatSendBeforeEventBeta

    An event that fires as players enter chat messages.

    export class ChatSendBeforeEvent {
        private constructor();
        cancel: boolean;
        readonly message: string;
        readonly sender: Player;
        targets?: Player[];
    }
    Index

    Constructors

    constructor

    Properties

    cancel message sender targets?

    Constructors

    Properties

    cancel: boolean

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

    This property can't be read in early-execution mode.

    message: string

    Message that is being broadcast.

    This property can't be read in early-execution mode.

    sender: Player

    Player that sent the chat message.

    This property can't be read in early-execution mode.

    targets?: Player[]

    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). This list can be modified to change the message recipients.

    This property can't be read in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties