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

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerSendChatEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName chatMessage eventName message player room

Constructors

constructor

new PlayerSendChatEvent<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | SendChatMessage,
    chatMessage: string,
): PlayerSendChatEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | SendChatMessage
- chatMessage: string
  The message that the player sent.
Returns PlayerSendChatEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/SendChat.ts:18

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: Player<RoomType>

`Readonly`room