Class RecentFinish

Represents a player recent finish.

Hierarchy (View Summary)

Finish
- RecentFinish

Index

Constructors

constructor

new RecentFinish(
    data: {
        mapName: string;
        players: string[];
        rank: Rank;
        region: RankAvailableRegion;
        timeSeconds: number;
        timestamp: number;
    } & { mapType: Type },
): RecentFinish
Construct a new RecentFinish instance.
Parameters
- data: {
      mapName: string;
      players: string[];
      rank: Rank;
      region: RankAvailableRegion;
      timeSeconds: number;
      timestamp: number;
  } & { mapType: Type }
Returns RecentFinish
Overrides Finish.constructor
- Defined in src/classes/other/Finish.ts:101

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?: 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 Finish.toMap
- Defined in src/classes/other/Finish.ts:66

toString

toString(): string
Returns the names of the players and their finish time.

Returns string
Example
```
"Sans3108 | 03:23"
```
Inherited from Finish.toString
- Defined in src/classes/other/Finish.ts:84

Class RecentFinish

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RecentFinish

Properties

mapName

mapType

players

rank

region

timeSeconds

timestamp

timeString

Example

Methods

toMap

Parameters

Returns Promise<Map>

toString

Returns string

Example

Settings

On This Page