Class PlayerSendQuickChatEvent<RoomType>

Emitted when a player sends a quick chat message. See PlayerSendChatEvent to litsen for normal chat messages.

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

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerSendQuickChatEvent

Implements

PlayerEvent<RoomType>
ProtocolEvent

Index

Constructors

Properties

eventName chatMessage eventName message player room

Constructors

constructor

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

Properties

`Static`eventName

eventName: "player.quickchat" = ...

`Readonly`chatMessage

chatMessage: QuickChatMessageData

The message that the player sent.

eventName

eventName: "player.quickchat" = ...

`Readonly`message

message: undefined | SendQuickChatMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

`Readonly`room