W3Booster SDK 4.6.0
    Preparing search index...

    Interface PlayerStatistics

    Cumulative engine player counters (own player in self-play). Missing is unavailable, never zero.

    interface PlayerStatistics {
        aiDifficulty?: 0 | 2 | 1;
        gameTime: number;
        goldCredited?: number;
        goldDiversionTax?: number;
        goldMined?: number;
        goldUpkeepLost?: number;
        handicapPercent?: number;
        heroes?: Readonly<Record<string, HeroStatistics>>;
        items?: Readonly<Record<string, ItemStatistics>>;
        lumberCredited?: number;
        lumberDiversionTax?: number;
        lumberUpkeepLost?: number;
        playerRace?: number;
        racePreference?: number;
        realTimeApm?: number;
        slotState?: 0 | 2 | 1;
        timeInUpkeepMs?: readonly number[];
        units?: Readonly<Record<string, UnitTypeStatistics>>;
    }
    Index
    aiDifficulty? gameTime goldCredited? goldDiversionTax? goldMined? goldUpkeepLost? handicapPercent? heroes? items? lumberCredited? lumberDiversionTax? lumberUpkeepLost? playerRace? racePreference? realTimeApm? slotState? timeInUpkeepMs? units?
    aiDifficulty?: 0 | 2 | 1
    gameTime: number
    goldCredited?: number
    goldDiversionTax?: number
    goldMined?: number
    goldUpkeepLost?: number
    handicapPercent?: number

    Native handicap multiplier expressed as a percentage (100 = normal).

    heroes?: Readonly<Record<string, HeroStatistics>>

    Full hero instance IDs, scoped with heroes:read.

    items?: Readonly<Record<string, ItemStatistics>>
    lumberCredited?: number
    lumberDiversionTax?: number
    lumberUpkeepLost?: number
    playerRace?: number
    racePreference?: number

    Native lobby preference bit flags, and the actual native race enum.

    realTimeApm?: number
    slotState?: 0 | 2 | 1
    timeInUpkeepMs?: readonly number[]

    Ten native upkeep-tier durations in milliseconds; engine clock semantics.

    units?: Readonly<Record<string, UnitTypeStatistics>>

    Nonhero, nonbuilding types, scoped with units:read.

    Settings

    On This Page
    Properties