Class default

Hierarchy

Constructors

constructor

Properties

absentPlayers event players

Methods

add clearClientSecret getAll getByIdentifier getByName getValidName permanentlyDelete remove repair reset setLocal

Constructors

constructor

Properties

Readonly absentPlayers

absentPlayers: (undefined | default)[] = []

Readonly event

event: IEventEmitter<default, IPlayerManagerEvents> = ...

Readonly players

players: (undefined | default)[] = []

Methods

add

  • Parameters

    • Optional playerOptions: Partial<IPlayerOptions>
    • Optional allowSetup: boolean

    Returns default

clearClientSecret

  • Clears the existing client secret for the player

    Parameters

    • playerIdentifier: string

      Player identifier

    Returns void

getAll

  • Get players. Parameters include additional players that may not be relevant, such as ghosts, connecting players, absent players, the dedicated server fake player.

    Returns

    Array of Player objects

    Parameters

    • Optional includeGhosts: boolean

      True to include players that are ghosts

    • Optional includeConnecting: boolean

      True to include players that are connecting

    • Optional includeDedicatedServer: boolean

      True to include the dedicated server fake player

    • Optional includeAbsent: boolean

      True to include the absent players

    Returns default[]

getByIdentifier

  • Parameters

    • identifier: string
    • includeAbsent: boolean = true

    Returns undefined | default

getByName

  • Parameters

    • name: string

    Returns undefined | default

getValidName

  • Parameters

    • name: undefined | string

    Returns string

permanentlyDelete

  • Removes and deletes a player. Use with caution!

    Parameters

    Returns void

remove

  • Parameters

    Returns void

repair

  • Support loading dedicated server saves & backups in single player games Support loading single player saves in dedicated servers All while not losing data for any players - regardless of if the player was in the server or not at the time of the backup

    Parameters

    Returns Promise<void>

reset

  • Returns void

setLocal

  • Parameters

    • player: default
    • setLocalIsland: boolean = true

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc