Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface PlayOptions

    Options for starting dimension animation

    interface PlayOptions {
        targetFPS?: number;
        loopMode?: LoopMode;
        direction?: AnimationDirection;
        ladderDepth?: number | "auto" | null;
    }
    Index
    targetFPS? loopMode? direction? ladderDepth?
    targetFPS?: number
    loopMode?: LoopMode
    direction?: AnimationDirection
    ladderDepth?: number | "auto" | null

    Playback "detail": a number pins the additive-ladder depth (rungs) for every frame, 'auto' resolves it per ladder from the energy stamps, null streams whatever fits the tick. See DimensionAnimationState.ladderDepth.

    Settings
    Member Visibility

    On This Page
    Properties