Class PlayerLeaveEvent<RoomType>

Emitted when a player leaves the room.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerLeaveEvent

Implements

Index

Properties

Constructors

constructor

Properties

Static eventName

eventName: "player.leave" = ...

eventName

eventName: "player.leave" = ...

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 PlayerLeaveEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>): PlayerLeaveEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/Leave.ts:15
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
Returns PlayerLeaveEvent<RoomType>

Generated using TypeDoc