ddnet/dist/classes/maps/MaxFinish.d.ts

A typescript npm package for interacting with data from ddnet.org

import { Player } from '../players/Player.js';
/**
 * Represents a player's highest amount of finishes on a map.
 */
export declare class MaxFinish {
    /**
     * The obtained rank.
     */
    rank: number;
    /**
     * The name of the player which achieved this rank.
     */
    player: string;
    /**
     * The amount of times this map has been finished by the player.
     */
    count: number;
    /**
     * Total time from all runs in seconds.
     */
    timeSeconds: number;
    /**
     * Total time from all runs in DDNet time string format. (ex. 02:47:23)
     */
    timeString: string;
    /**
     * Could be the timestamp of the first time this map was finished.
     * @remarks I haven't figured out what minTimestamp is supposed to represent.
     */
    minTimestamp: number;
    /**
     * Could be the timestamp of the last time this map was finished.
     * @remarks I haven't figured out what minTimestamp is supposed to represent.
     */
    maxTimestamp: number;
    /**
     * Construct a new {@link MaxFinish} instance.
     */
    constructor(data: {
        rank: number;
        player: string;
        count: number;
        time: number;
        minTimestamp: number;
        maxTimestamp: number;
    });
    /**
     * Returns a new {@link Player} object from this rank.
     */
    toPlayer(): Promise<Player>;
    /**
     * Returns the name of the player and finish count.
     *
     * @example "Sans3108 | 69"
     */
    toString(): string;
}