screeps-api
    Preparing search index...

    Interface Creep

    Creeps are your units. Creeps can move, harvest energy, construct structures, attack another creeps, and perform other actions.

    https://docs.screeps.com/api/#Creep

    interface Creep {
        _id: string;
        actionLog: {
            attack: Position | null;
            attacked: unknown;
            build: Position | null;
            harvest: Position | null;
            heal: Position | null;
            healed: unknown;
            rangedAttack: Position | null;
            rangedHeal: Position | null;
            rangedMassAttack: unknown;
            repair: Position | null;
            reserveController: Position | null;
            say: SayAction | null;
            upgradeController: Position | null;
        };
        ageTime: number;
        body: {
            $name: string;
            boost?: MineralBoostResource;
            hits: number;
            name: BodyPartType;
        }[];
        effects?: { [index: number]: Effect }
        | null;
        fatigue: number;
        hits: number;
        hitsMax: number;
        name: string;
        notifyWhenAttacked: boolean;
        room: string;
        store: {
            alloy: number | undefined;
            battery: number | undefined;
            Biomass: number | undefined;
            Catalyst: number | undefined;
            cell: number | undefined;
            circuit: number | undefined;
            composite: number | undefined;
            concentrate: number | undefined;
            condensate: number | undefined;
            crystal: number | undefined;
            device: number | undefined;
            emanation: number | undefined;
            energy: number | undefined;
            essence: number | undefined;
            extract: number | undefined;
            fixtures: number | undefined;
            frame: number | undefined;
            G: number | undefined;
            GH: number | undefined;
            GH2O: number | undefined;
            GHO2: number | undefined;
            ghodium_melt: number | undefined;
            GO: number | undefined;
            hydraulics: number | undefined;
            Hydrogen: number | undefined;
            Keanium: number | undefined;
            keanium_bar: number | undefined;
            KH: number | undefined;
            KH2O: number | undefined;
            KHO2: number | undefined;
            KO: number | undefined;
            Lemergium: number | undefined;
            lemergium_bar: number | undefined;
            LH: number | undefined;
            LH2O: number | undefined;
            LHO2: number | undefined;
            liquid: number | undefined;
            LO: number | undefined;
            machine: number | undefined;
            Metal: number | undefined;
            microchip: number | undefined;
            Mist: number | undefined;
            muscle: number | undefined;
            OH: number | undefined;
            ops: number | undefined;
            organism: number | undefined;
            organoid: number | undefined;
            oxidant: number | undefined;
            Oxygen: number | undefined;
            phlegm: number | undefined;
            power: number | undefined;
            purifier: number | undefined;
            reductant: number | undefined;
            Silicon: number | undefined;
            spirit: number | undefined;
            switch: number | undefined;
            tissue: number | undefined;
            transistor: number | undefined;
            tube: number | undefined;
            UH: number | undefined;
            UH2O: number | undefined;
            UHO2: number | undefined;
            UL: number | undefined;
            UO: number | undefined;
            Utrium: number | undefined;
            utrium_bar: number | undefined;
            wire: number | undefined;
            XGH2O: number | undefined;
            XGHO2: number | undefined;
            XKH2O: number | undefined;
            XKHO2: number | undefined;
            XLH2O: number | undefined;
            XLHO2: number | undefined;
            XUH2O: number | undefined;
            XUHO2: number | undefined;
            XZH2O: number | undefined;
            XZHO2: number | undefined;
            ZH: number | undefined;
            ZH2O: number | undefined;
            ZHO2: number | undefined;
            ZK: number | undefined;
            ZO: number | undefined;
            Zynthium: number | undefined;
            zynthium_bar: number | undefined;
        };
        storeCapacity: number;
        type: "creep";
        user: string;
        x: number;
        y: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id actionLog ageTime body effects? fatigue hits hitsMax name notifyWhenAttacked room store storeCapacity type user x y

    Properties

    _id

    _id: string
    actionLog: {
        attack: Position | null;
        attacked: unknown;
        build: Position | null;
        harvest: Position | null;
        heal: Position | null;
        healed: unknown;
        rangedAttack: Position | null;
        rangedHeal: Position | null;
        rangedMassAttack: unknown;
        repair: Position | null;
        reserveController: Position | null;
        say: SayAction | null;
        upgradeController: Position | null;
    }
    ageTime: number

    Tick at which this creep will expire

    body

    body: {
        $name: string;
        boost?: MineralBoostResource;
        hits: number;
        name: BodyPartType;
    }[]
    effects?: { [index: number]: Effect } | null

    Temporary effects that are active on this object

    fatigue: number
    hits: number
    hitsMax: number
    name: string
    notifyWhenAttacked: boolean
    room: string
    store: {
        alloy: number | undefined;
        battery: number | undefined;
        Biomass: number | undefined;
        Catalyst: number | undefined;
        cell: number | undefined;
        circuit: number | undefined;
        composite: number | undefined;
        concentrate: number | undefined;
        condensate: number | undefined;
        crystal: number | undefined;
        device: number | undefined;
        emanation: number | undefined;
        energy: number | undefined;
        essence: number | undefined;
        extract: number | undefined;
        fixtures: number | undefined;
        frame: number | undefined;
        G: number | undefined;
        GH: number | undefined;
        GH2O: number | undefined;
        GHO2: number | undefined;
        ghodium_melt: number | undefined;
        GO: number | undefined;
        hydraulics: number | undefined;
        Hydrogen: number | undefined;
        Keanium: number | undefined;
        keanium_bar: number | undefined;
        KH: number | undefined;
        KH2O: number | undefined;
        KHO2: number | undefined;
        KO: number | undefined;
        Lemergium: number | undefined;
        lemergium_bar: number | undefined;
        LH: number | undefined;
        LH2O: number | undefined;
        LHO2: number | undefined;
        liquid: number | undefined;
        LO: number | undefined;
        machine: number | undefined;
        Metal: number | undefined;
        microchip: number | undefined;
        Mist: number | undefined;
        muscle: number | undefined;
        OH: number | undefined;
        ops: number | undefined;
        organism: number | undefined;
        organoid: number | undefined;
        oxidant: number | undefined;
        Oxygen: number | undefined;
        phlegm: number | undefined;
        power: number | undefined;
        purifier: number | undefined;
        reductant: number | undefined;
        Silicon: number | undefined;
        spirit: number | undefined;
        switch: number | undefined;
        tissue: number | undefined;
        transistor: number | undefined;
        tube: number | undefined;
        UH: number | undefined;
        UH2O: number | undefined;
        UHO2: number | undefined;
        UL: number | undefined;
        UO: number | undefined;
        Utrium: number | undefined;
        utrium_bar: number | undefined;
        wire: number | undefined;
        XGH2O: number | undefined;
        XGHO2: number | undefined;
        XKH2O: number | undefined;
        XKHO2: number | undefined;
        XLH2O: number | undefined;
        XLHO2: number | undefined;
        XUH2O: number | undefined;
        XUHO2: number | undefined;
        XZH2O: number | undefined;
        XZHO2: number | undefined;
        ZH: number | undefined;
        ZH2O: number | undefined;
        ZHO2: number | undefined;
        ZK: number | undefined;
        ZO: number | undefined;
        Zynthium: number | undefined;
        zynthium_bar: number | undefined;
    }
    storeCapacity: number
    type: "creep"
    user: string

    ID of the user who owns this object.

    Note: NPCs do not have long-form hex ID strings like normal players:

    • Invader: "2"
    • SourceKeeper: "3"
    x: number
    y: number

    Settings

    Member Visibility

    On This Page

    Properties