Class PlayerLeaveEvent<RoomType>

Emitted when a player leaves the room.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerLeaveEvent

Implements

Index

Properties

eventName eventName player room

Constructors

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>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
Returns PlayerLeaveEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/Leave.d.ts:14

Generated using TypeDoc