Script API - v1.20.30
    Preparing search index...

    An event that fires as players enter chat messages.

    Hierarchy (View Summary)

    Index

    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.

    sender: Player

    Player that sent the chat message.

    sendToTargets: boolean

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

    Methods

    • Beta

      Parameters

      • players: Player[]

        Updated array of players that should receive this message.

      Returns void

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