Class UncompletedMapStats

Represents a player's unfinished map stats.

Hierarchy (view full)

MapStatsBase
- UncompletedMapStats

Index

Constructors

Properties

finishCount mapName mapType points

Methods

Constructors

constructor

new UncompletedMapStats(data): UncompletedMapStats
Construct a new UncompletedMapStats instance.
Parameters
- data: {
      mapName: string;
      mapType: Type;
      pointsReward: number;
  }
  - mapName: string
  - mapType: Type
  - pointsReward: number
Returns UncompletedMapStats
Overrides MapStatsBase.constructor
- Defined in src/classes/players/MapStats.ts:60

Properties

finishCount

finishCount: number

The amount of finishes on this map.

Remarks

This will always be 0.

mapName

mapName: string

The map name.

mapType

mapType: Type

The server type of this map.

points

points: number

The amount of points awarded for completing this map.

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>
Inherited from MapStatsBase.toMap
- Defined in src/classes/players/MapStats.ts:32