screeps-api
    Preparing search index...

    Interface StructurePortal

    A non-player structure. Instantly teleports your creeps to a distant room acting as a room exit tile.

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

    interface StructurePortal {
        _id: string;
        _isDisabled: boolean;
        decayTime?: number;
        destination: IntershardDestination | IntrashardDestination;
        effects?: { [index: number]: Effect } | null;
        name?: string;
        room: string;
        type: "portal";
        unstableDate?: number | null;
        x: number;
        y: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id _isDisabled decayTime? destination effects? name? room type unstableDate? x y

    Properties

    _id

    _id: string

    _isDisabled

    _isDisabled: boolean
    decayTime?: number

    Number of ticks before this portal disappears; undefined if unstableDate is undefined or null

    destination: IntershardDestination | IntrashardDestination
    effects?: { [index: number]: Effect } | null

    Temporary effects that are active on this object

    name?: string
    room: string
    type: "portal"
    unstableDate?: number | null

    UNIX timestamp at which this portal will begin to decay; undefined for intershard portals; null if portal is already decaying

    x: number
    y: number

    Settings

    Member Visibility

    On This Page

    Properties