screeps-api
    Preparing search index...

    Interface StructureController

    Claim this structure to take control over the room.

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

    interface StructureController {
        _id: string;
        _isDisabled: boolean;
        downgradeTime?: number | null;
        effects?: { [index: number]: Effect } | null;
        isPowerEnabled?: boolean;
        level: number;
        name?: string;
        progress?: number;
        progressTotal?: number;
        reservation?: { endTime?: number; user: string } | null;
        room: string;
        safeMode?: number | null;
        safeModeAvailable?: number;
        safeModeCooldown?: number | null;
        sign?: { datetime: number; text: string; time: number; user: string };
        type: "controller";
        upgradeBlocked?: number | null;
        user: string;
        x: number;
        y: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id _isDisabled downgradeTime? effects? isPowerEnabled? level name? progress? progressTotal? reservation? room safeMode? safeModeAvailable? safeModeCooldown? sign? type upgradeBlocked? user x y

    Properties

    _id

    _id: string

    _isDisabled

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

    Temporary effects that are active on this object

    isPowerEnabled?: boolean
    level: number
    name?: string
    progress?: number
    progressTotal?: number
    reservation?: { endTime?: number; user: string } | null

    Type Declaration

    • { endTime?: number; user: string }
      • OptionalendTime?: number

        Tick at which this reservation will end

      • user: string

        ID of the user who reserved this controller

    • null
    room: string
    safeMode?: number | null
    safeModeAvailable?: number
    safeModeCooldown?: number | null
    sign?: { datetime: number; text: string; time: number; user: string }

    Type Declaration

    • datetime: number

      UNIX timestamp at which this controller was signed

    • text: string

      Sign message

    • time: number

      Tick at which this controller was signed

    • user: string

      ID of the user who signed this controller

    type: "controller"
    upgradeBlocked?: number | null
    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