Class PlayerSendChatEvent<RoomType>

Emitted when a player sends a free chat message. See PlayerSendQuickChatEvent to listen for quick chat messages.

Due to technical impossibilities, this event cannot be canceled or reverted.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSendChatEvent

Implements

Properties

eventName chatMessage eventName message player room

Constructors

constructor

Properties

Static eventName

eventName: "player.chat"

Readonly chatMessage

chatMessage: string

The message that the player sent.

eventName

eventName: "player.chat"

Readonly message

message: undefined | SendChatMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SendChatMessage
    • chatMessage: string

      The message that the player sent.

    Returns PlayerSendChatEvent<RoomType>

Settings

Member Visibility

Theme

Generated using TypeDoc