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

    Sequences waypoint matching against dimension changes. One per loaded scene; LuxarApp creates it in applyViewerConfigState and drops it on the next load.

    Index
    current: number = -1
    transit: boolean = false
    activeFlight: Promise<FlightResult> | null = null

    Identity of the live flight; an index can be revisited before its stale flight resolves.

    waypoints: readonly ZarrWaypoint[]
    • get inTransit(): boolean

      True while the current waypoint asked for reveal: "on_arrival" and its flight has not resolved yet — the window in which the overlay manager holds the story's captions back. False after a snap, for a waypoint without a camera block, and for reveal: "immediate" (the default).

      Returns boolean

    • waypoint-arrived: right away for a snap or a camera-less waypoint, else when the flight resolves — unless a newer match superseded it meanwhile (see the port docs).

      Parameters

      Returns void