API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceSceneTransitionEnvironment

@codexo/exojs / core / stable

Handed to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object was constructed.

3
props
1
methods
0
events
Import
import { SceneTransitionEnvironment } from '@codexo/exojs'

Handed to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object was constructed.

Methods1
commit(): void
Request the scene switch. May be called synchronously from createSession(), update(), or render(). Exactly once per session - a second call is a dev-mode lifecycle error (SceneTransitionLifecycleError, reason 'commit-reentrant') and a production no-op. Never swaps the active scene reentrantly from inside the caller's own callback - the Director processes the actual switch only after the current callback has fully returned control.
Properties3
commitRequested: boolean
true once SceneTransitionEnvironment.commit has been called. Live view.
committed: boolean
true once the atomic commit boundary has actually been crossed. Live view.
context: SceneTransitionContextImmutable, read-only description of the navigation a SceneTransition is being asked to run for - passed to SceneTransition.getRequirements and into the SceneTr…
Source
src/core/scene/SceneTransition.ts