Class GameDataAddPlayerEvent<RoomType>

Emitted when a player is added to gamedata.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

RevertableEvent
- GameDataAddPlayerEvent

Implements

Index

Properties

eventName eventName gamedata player reverted room

Constructors

Methods

Properties

`Static` eventName

eventName: "gamedata.addplayer"

eventName

eventName: "gamedata.addplayer"

`Readonly` gamedata

gamedata: GameData<RoomType>

The gamedata object that this event is for.

`Readonly` player

player: PlayerInfo<RoomType>

The player information that was added.

reverted

reverted: boolean

`Readonly` room

room: RoomType

The room or client that the event came from.

Constructors

constructor

new GameDataAddPlayerEvent<RoomType>(room: RoomType, gamedata: GameData<RoomType>, player: PlayerInfo<RoomType>): GameDataAddPlayerEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- gamedata: GameData<RoomType>
- player: PlayerInfo<RoomType>
  
  The player information that was added.
Returns GameDataAddPlayerEvent<RoomType>
Overrides RevertableEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/gamedata/AddPlayer.d.ts:19

Methods

revert

revert(): void
Returns void
Inherited from RevertableEvent.revert
- Defined in node_modules/@skeldjs/events/dist/lib/RevertableEvent.d.ts:5

Generated using TypeDoc