screeps-api
    Preparing search index...

    Interface StructureLink

    Remotely transfers energy to another Link in the same room.

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

    interface StructureLink {
        _id: string;
        _isDisabled: boolean;
        actionLog: { transferEnergy: unknown };
        cooldown: number;
        effects?: { [index: number]: Effect } | null;
        hits: number;
        hitsMax: number;
        name?: string;
        notifyWhenAttacked: boolean;
        room: string;
        store: { energy: number };
        storeCapacityResource: { energy: number | null };
        type: "link";
        user: string;
        x: number;
        y: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id _isDisabled actionLog cooldown effects? hits hitsMax name? notifyWhenAttacked room store storeCapacityResource type user x y

    Properties

    _id

    _id: string

    _isDisabled

    _isDisabled: boolean
    actionLog: { transferEnergy: unknown }
    cooldown: number
    effects?: { [index: number]: Effect } | null

    Temporary effects that are active on this object

    hits: number
    hitsMax: number
    name?: string
    notifyWhenAttacked: boolean
    room: string
    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: "link"
    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