Class PlayerRegistryImpl

A registry of non-disposed players. Used for leak detection and debugging diagnostics.

Implements

Index

Constructors

Properties

maxPlayersWarning

Accessors

Methods

addPlayer dispose removePlayer

Constructors

constructor

new PlayerRegistryImpl(maxPlayersWarning?: number): PlayerRegistryImpl
Parameters
- maxPlayersWarning: number = DEFAULT_MAX_PLAYERS
  The number of concurrent players before a warning is logged. default: 5
Returns PlayerRegistryImpl
- Defined in vinyl/src/global/PlayerRegistry.ts:59

Properties

maxPlayersWarning

maxPlayersWarning: number = DEFAULT_MAX_PLAYERS

The number of concurrent players before a warning is logged. default: 5

Accessors

players

get players(): readonly AnyRecord[]
Returns the non-disposed Vinyl players.

Returns readonly AnyRecord[]
Implementation of PlayerRegistry.players
- Defined in vinyl/src/global/PlayerRegistry.ts:67

Methods

addPlayer

addPlayer(player: AnyRecord): void
Adds a player reference. All players must be removed before disposing VinylGlobal.
Parameters
- player: AnyRecord
Returns void
Implementation of PlayerRegistry.addPlayer
- Defined in vinyl/src/global/PlayerRegistry.ts:71

dispose

dispose(): void
Returns void

Throws
An IllegalStateError if all players have not been removed.
Implementation of Disposable.dispose
- Defined in vinyl/src/global/PlayerRegistry.ts:90

removePlayer

removePlayer(player: AnyRecord): void
Removes a player reference.
Parameters
- player: AnyRecord
Returns void
Implementation of PlayerRegistry.removePlayer
- Defined in vinyl/src/global/PlayerRegistry.ts:83