Class RecentFinish

Represents a player recent finish.

Hierarchy (view full)

Constructors

constructor

Properties

mapName mapType players rank region timeSeconds timestamp timeString

Methods

toMap toString

Constructors

constructor

Properties

mapName

mapName: string

The name of the finished map.

mapType

mapType: Type

The type of the map.

players

players: {
    name: string;
    toPlayer: (() => Promise<Player>);
}[]

The finish player(s).

rank

rank: Rank

The rank obtained.

region

region: RankAvailableRegion

The region of this finish.

timeSeconds

timeSeconds: number

The time of this finish in seconds.

timestamp

timestamp: number

The timestamp of this finish.

timeString

timeString: string

The string formatted time of this finish.

Example

"03:23"

Methods

toMap

  • toMap(rankSource?, force?): Promise<Map>

  • Returns a new Map object from the mapName of this finish.

    Parameters

    • OptionalrankSource: null | RankAvailableRegion

      The region to pull ranks from in the toMap function from the returned value. Omit for global ranks.

    • force: boolean = false

      Wether to bypass the cache.

    Returns Promise<Map>

toString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods