Engine API Reference - v2.23.0-beta.7
    Preparing search index...

    Interface InspectorOptions

    interface InspectorOptions {
        dock?: "left" | "right";
        hierarchyInterval?: number;
        highlight?: boolean;
        highlightColor?: Color;
        lockedNode?: GraphNode | null;
        pauseKey?: string;
        physicsDraw?: boolean;
        physicsDrawOptions?: InspectorPhysicsDrawOptions;
        propertyInterval?: number;
        stepKey?: string;
        storageKey?: string | null;
        toggleKey?: string;
        top?: number;
        visible?: boolean;
        width?: number;
    }
    Index
    dock?: "left" | "right"

    The side of the viewport the panel docks to. Defaults to 'right'.

    hierarchyInterval?: number

    Seconds between list refreshes. Defaults to 0.5.

    highlight?: boolean

    Whether the selected node is outlined in the viewport. Defaults to true.

    highlightColor?: Color

    The color of the outline. Defaults to orange.

    lockedNode?: GraphNode | null

    A node whose enabled checkbox, and those of its ancestors, are withheld. A script hosting the inspector passes its own entity so the panel cannot switch itself off. Defaults to null.

    pauseKey?: string

    The key that pauses and resumes the app. Defaults to 'F9'.

    physicsDraw?: boolean

    Whether the physics world is drawn from the start. Defaults to false.

    physicsDrawOptions?: InspectorPhysicsDrawOptions

    Which parts of the physics world are drawn. Defaults to the wireframe only.

    propertyInterval?: number

    Seconds between property refreshes. Defaults to 0.1.

    stepKey?: string

    The key that advances one frame while paused. Defaults to 'F10'.

    storageKey?: string | null

    The local storage key the panel's settings are kept under, so they survive a reload or a restart of the app: the physics drawing switch and options, the bodies excluded from it (by entity path), the active tab, the panel width and the GPU timings switch. Stored settings take precedence over the defaults given here. Defaults to 'pc-inspector'; null keeps nothing.

    toggleKey?: string

    The KeyboardEvent.code or key that shows and hides the panel. Defaults to 'Backquote'. Empty disables the key.

    top?: number

    A gap left above the panel in CSS pixels, to keep it clear of other overlays. Defaults to 0.

    visible?: boolean

    Whether the panel starts shown. Defaults to true.

    width?: number

    The width of the docked panel in CSS pixels. Defaults to 420.