screeps-api
    Preparing search index...

    Interface GameRoomOverviewResponse

    GET /api/game/room-overview response

    interface GameRoomOverviewResponse {
        ok: 1;
        owner: { badge: UserBadge; username: string } | null;
        stats: {
            creepsLost: { endTime: number; value: number }[];
            creepsProduced: { endTime: number; value: number }[];
            energyConstruction: { endTime: number; value: number }[];
            energyControl: { endTime: number; value: number }[];
            energyCreeps: { endTime: number; value: number }[];
            energyHarvested: { endTime: number; value: number }[];
            powerProcessed: { endTime: number; value: number }[];
        };
        statsMax: {
            creepsLost1440: number;
            creepsLost180: number;
            creepsLost8: number;
            creepsProduced1440: number;
            creepsProduced180: number;
            creepsProduced8: number;
            energyConstruction1440: number;
            energyConstruction180: number;
            energyConstruction8: number;
            energyControl1440: number;
            energyControl180: number;
            energyControl8: number;
            energyCreeps1440: number;
            energyCreeps180: number;
            energyCreeps8: number;
            energyHarvested1440: number;
            energyHarvested180: number;
            energyHarvested8: number;
            powerProcessed1440: number;
            powerProcessed180: number;
            powerProcessed8: number;
        };
        totals: {
            creepsLost: number
            | undefined;
            creepsProduced: number | undefined;
            energyConstruction: number | undefined;
            energyControl: number | undefined;
            energyCreeps: number | undefined;
            energyHarvested: number | undefined;
            powerProcessed: number | undefined;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    ok: 1

    An API success response always contains { ok: 1 }

    owner: { badge: UserBadge; username: string } | null
    stats: {
        creepsLost: { endTime: number; value: number }[];
        creepsProduced: { endTime: number; value: number }[];
        energyConstruction: { endTime: number; value: number }[];
        energyControl: { endTime: number; value: number }[];
        energyCreeps: { endTime: number; value: number }[];
        energyHarvested: { endTime: number; value: number }[];
        powerProcessed: { endTime: number; value: number }[];
    }
    statsMax: {
        creepsLost1440: number;
        creepsLost180: number;
        creepsLost8: number;
        creepsProduced1440: number;
        creepsProduced180: number;
        creepsProduced8: number;
        energyConstruction1440: number;
        energyConstruction180: number;
        energyConstruction8: number;
        energyControl1440: number;
        energyControl180: number;
        energyControl8: number;
        energyCreeps1440: number;
        energyCreeps180: number;
        energyCreeps8: number;
        energyHarvested1440: number;
        energyHarvested180: number;
        energyHarvested8: number;
        powerProcessed1440: number;
        powerProcessed180: number;
        powerProcessed8: number;
    }
    totals: {
        creepsLost: number | undefined;
        creepsProduced: number | undefined;
        energyConstruction: number | undefined;
        energyControl: number | undefined;
        energyCreeps: number | undefined;
        energyHarvested: number | undefined;
        powerProcessed: number | undefined;
    }

    Total values for each non-zero stat (stats with 0 totals are undefined)