Options
All
  • Public
  • Public/Protected
  • All
Menu

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: Hostable

Hierarchy

Implements

Index

Properties

Constructors

Properties

Static eventName

eventName: "player.chat" = ...

Readonly chatMessage

chatMessage: string

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

  • new PlayerSendChatEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SendChatMessage, chatMessage: string): PlayerSendChatEvent<RoomType>

Generated using TypeDoc