Class CompletedMapStats

Represents a player's finished map stats.

Hierarchy (View Summary)

MapStatsBase
- CompletedMapStats

Index

Constructors

constructor

new CompletedMapStats(
    data: { mapName: string; mapType: Type; pointsReward: number } & {
        bestTimeSeconds: number;
        finishCount: number;
        firstFinishTimestamp: number;
        rank: number;
        teamRank?: number;
    },
): CompletedMapStats
Construct a new CompletedMapStats instance.
Parameters
- data: { mapName: string; mapType: Type; pointsReward: number } & {
      bestTimeSeconds: number;
      finishCount: number;
      firstFinishTimestamp: number;
      rank: number;
      teamRank?: number;
  }
Returns CompletedMapStats
Overrides MapStatsBase.constructor
- Defined in src/classes/players/MapStats.ts:105

Properties

bestTimeSeconds

bestTimeSeconds: number

Best finish time for this map in seconds.

bestTimeString

bestTimeString: string

The string formatted best finish time for this map.

Example

"03:23"

finishCount

finishCount: number

The amount of finishes on this map.

firstFinishTimestamp

firstFinishTimestamp: number

Timestamp for the first ever finish on this map.

mapName

mapName: string

The map name.

mapType

mapType: Type

The server type of this map.

placement

placement: number

The placement obtained on this map.

points

points: number

The amount of points awarded for completing this map.

teamRank

teamRank: null | number

The team rank obtained on this map.

Methods

toMap

toMap(rankSource?: null | RankAvailableRegion, force?: boolean): 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>
Inherited from MapStatsBase.toMap
- Defined in src/classes/players/MapStats.ts:32

Class CompletedMapStats

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CompletedMapStats

Properties

bestTimeSeconds

bestTimeString

Example

finishCount

firstFinishTimestamp

mapName

mapType

placement

points

teamRank

Methods

toMap

Parameters

Returns Promise<Map>

Settings

On This Page