Class DatasetSession

constructor

• new DatasetSession(src: string | undefined): DatasetSession

  Parameters

  • src: string | undefined

    The dataset this session loads; undefined for "no dataset yet".

  Returns DatasetSession

controlPanelConfig

Readonlysrc

isDisposed

• get isDisposed(): boolean

  True once the app was disposed or a newer load started: an in-flight load reading this must stop at its next await.

  Returns boolean

loadedSrc

• get loadedSrc(): string | undefined

  The dataset's src once its load has succeeded, else undefined.

  Returns string | undefined

fault

• get fault(): DatasetFaultPayload | null

  The loaded dataset's latched archive fault, if any.

  Returns DatasetFaultPayload | null

waypointDriver

• get waypointDriver(): WaypointDriver | undefined

  The scene's story-waypoint driver, while one is installed.

  Returns WaypointDriver | undefined

markLoaded

• markLoaded(source: ArchiveFaultSource | null): void

  The load committed: the dataset is available and its fault latch is the given loader's. A no-op on a session already disposed (the app was disposed, or a newer load started, while this one was in flight).

  Parameters

  • source: ArchiveFaultSource | null

  Returns void

reportFaults

• reportFaults(onFault: (error: Error) => void): void

  Report the loaded dataset's archive faults from now on. A fault latched during the load is replayed immediately — so call this AFTER announcing the dataset (the public ordering: available, then faulted).

  Parameters

  • onFault: (error: Error) => void

  Returns void

setWaypoints

• setWaypoints(waypoints: InstalledWaypoints | null): void

  Replace the installed waypoints (the previous binding is released). A disposed session releases the new binding at once: a load superseded mid-flight must not leave its dims listener behind.

  Parameters

  • waypoints: InstalledWaypoints | null

  Returns void

setKioskTeardown

• setKioskTeardown(teardown: (() => void) | null): void

  Replace the kiosk watchdog teardown (run at once on a disposed session).

  Parameters

  • teardown: (() => void) | null

  Returns void

dispose

• dispose(): void

  Release everything the dataset installed. Idempotent.

  Returns void