API reference

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

E

enumSceneState

@codexo/exojs / core / stable

Lifecycle state of one Scene activation, owned by its internal `SceneScope` and exposed read-only via Scene.state. State is read-only from user code - it changes only in response to director-driven lifecycle events: preparation, activation, retention (suspend/restore), and teardown. Pause is not a state - it is an orthogonal flag that only applies while `Active`; see Scene.paused. | State | fixed/update | draw | input & interaction | meaning | |---|---:|---:|---|---| | `Preparing` | no | no | registrations accepted, dispatch gated | `load()`/`init()` running | | `Ready` | no | no | registrations accepted, dispatch gated | fully prepared, never yet activated | | `Active` (not paused) | yes | yes | active | live | | `Active` (paused) | no | yes | pause-policy filtered | live, simulation frozen | | `Suspended` | no | no | registrations accepted, dispatch gated | previously active, retained | | `Destroying` / `Destroyed` | no | no | disabled | permanent teardown |

0
props
0
methods
0
events
Import
import { SceneState } from '@codexo/exojs'

Lifecycle state of one Scene activation, owned by its internal `SceneScope` and exposed read-only via Scene.state. State is read-only from user code - it changes only in response to director-driven lifecycle events: preparation, activation, retention (suspend/restore), and teardown. Pause is not a state - it is an orthogonal flag that only applies while `Active`; see Scene.paused.

| State | fixed/update | draw | input & interaction | meaning | |---|---:|---:|---|---| | `Preparing` | no | no | registrations accepted, dispatch gated | `load()`/`init()` running | | `Ready` | no | no | registrations accepted, dispatch gated | fully prepared, never yet activated | | `Active` (not paused) | yes | yes | active | live | | `Active` (paused) | no | yes | pause-policy filtered | live, simulation frozen | | `Suspended` | no | no | registrations accepted, dispatch gated | previously active, retained | | `Destroying` / `Destroyed` | no | no | disabled | permanent teardown |

Members6
Active
Destroyed
Destroying
Preparing
Ready
Suspended
Source
src/core/scene/SceneState.ts