Class GameDataRemovePlayerEvent<RoomType>

Emitted when a player is removed from gamedata.

Type parameters

RoomType: Hostable

Hierarchy

RevertableEvent
- GameDataRemovePlayerEvent

Implements

Index

Properties

Constructors

constructor

Methods

revert

Properties

Static eventName

eventName: "gamedata.removeplayer" = ...

eventName

eventName: "gamedata.removeplayer" = ...

Readonly gamedata

gamedata: GameData<RoomType>

The gamedata object that this event is for.

Readonly player

player: PlayerInfo<RoomType>

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Constructors

constructor

new GameDataRemovePlayerEvent<RoomType>(room: RoomType, gamedata: GameData<RoomType>, player: PlayerInfo<RoomType>): GameDataRemovePlayerEvent<RoomType>

Overrides RevertableEvent.constructor
- Defined in core/lib/events/gamedata/RemovePlayer.ts:15
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- gamedata: GameData<RoomType>
- player: PlayerInfo<RoomType>
Returns GameDataRemovePlayerEvent<RoomType>

Methods

revert

revert(): void

Inherited from RevertableEvent.revert
- Defined in events/lib/RevertableEvent.ts:12
Returns void

Generated using TypeDoc