screeps-api
    Preparing search index...

    Interface StructureSpawn

    Spawn is your colony center. This structure can create, renew, and recycle creeps.

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

    interface StructureSpawn {
        _id: string;
        _isDisabled: boolean;
        effects?: { [index: number]: Effect } | null;
        hits: number;
        hitsMax: number;
        name: string;
        notifyWhenAttacked: boolean;
        off: boolean;
        room: string;
        spawning?: { name: string; needTime: number; spawnTime: number };
        store: { energy: number };
        storeCapacityResource: { energy: number | null };
        type: "spawn";
        user: string;
        x: number;
        y: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id _isDisabled effects? hits hitsMax name notifyWhenAttacked off room spawning? store storeCapacityResource type user x y

    Properties

    _id

    _id: string

    _isDisabled

    _isDisabled: boolean
    effects?: { [index: number]: Effect } | null

    Temporary effects that are active on this object

    hits: number
    hitsMax: number
    name: string
    notifyWhenAttacked: boolean
    off: boolean
    room: string
    spawning?: { name: string; needTime: number; spawnTime: number }

    Type Declaration

    • name: string
    • needTime: number

      Total number of ticks required to spawn this creep

    • spawnTime: number

      Tick at which this creep will finish spawning

    store: { energy: number }
    storeCapacityResource: { energy: number | null }

    Capacities should not be null, except on minerals in a lab when another mineral type is already being stored.

    type: "spawn"
    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