steam-condenser/dist/lib/SteamCondenser/Servers/SteamPlayer.d.ts

TypeScript port of steam-condenser.

declare class SteamPlayer {
    private connectTime;
    private id;
    private name;
    private score;
    private extended;
    private connectionId?;
    private state?;
    private steamId?;
    private loss?;
    private ping?;
    private ipAddress?;
    private clientPort?;
    private rate?;
    constructor(id: number, name: string, score: number, connectTime: number);
    /**
     * Extends a player object with information retrieved from a RCON call to
     * the status command
     *
     * @param string playerData The player data retrieved from
     *    <var>rcon status</var>
     * @throws SteamCondenserException if the information belongs to another
     *     player
     */
    addInformation(playerData: {
        [key: string]: string;
    }): void;
    /**
     * Returns the client port of this player
     *
     * @return int The client port of the player
     */
    getClientPort(): number | undefined;
    /**
     * Returns the connection ID (as used on the server) of this player
     *
     * @return int The connection ID of this player
     */
    getConnectionId(): number | undefined;
    /**
     * Returns the time this player is connected to the server
     *
     * @return float The connection time of the player
     */
    getConnectTime(): number | undefined;
    /**
     * Returns the ID of this player
     *
     * @return int The ID of this player
     */
    getId(): number | undefined;
    /**
     * Returns the IP address of this player
     *
     * @return string The IP address of this player
     */
    getIpAddress(): string | undefined;
    /**
     * Returns the packet loss of this player's connection
     *
     * @return string The packet loss of this player's connection
     */
    getLoss(): number | undefined;
    /**
     * Returns the nickname of this player
     *
     * @return string The name of this player
     */
    getName(): string | undefined;
    /**
     * Returns the ping of this player
     *
     * @return int The ping of this player
     */
    getPing(): number | undefined;
    /**
     * Returns the rate of this player
     *
     * @return int The rate of this player
     */
    getRate(): number | undefined;
    /**
     * Returns the score of this player
     *
     * @return int The score of this player
     */
    getScore(): number | undefined;
    /**
     * Returns the connection state of this player
     *
     * @return string The connection state of this player
     */
    getState(): string | undefined;
    /**
     * Returns the SteamID of this player
     *
     * @return string The SteamID of this player
     */
    getSteamId(): string | undefined;
    /**
     * Returns whether this player is a bot
     *
     * @return bool <var>true</var> if this player is a bot
     */
    isBot(): boolean | undefined;
    /**
     * Returns whether this player object has extended information gathered
     * using RCON
     *
     * @return bool <var>true</var> if extended information for this player
     *     is available
     */
    isExtended(): boolean;
    /**
     * Returns a string representation of this player
     *
     * @return string A string representing this player
     */
    toString(): string;
}
export { SteamPlayer };