API reference

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

E

enumSceneAvailability

@codexo/exojs / core / stable

When a scene-scoped registration stays live relative to the owning scene's pause flag. Shared by every scene facility that accepts a `when` option - SceneAudio, SceneInputs and SceneTweens - so one policy vocabulary covers voices, bindings and tweens alike. Pause is orthogonal to SceneState: these values only discriminate within `Active`, which is the only state where the pause flag applies. A suspended or preparing scope dispatches nothing regardless of the policy chosen here. | Value | while running | while paused | |---|---:|---:| | `Active` | yes | no | | `Paused` | no | yes | | `Always` | yes | yes | `Paused` is what pause menus are built from: input bindings and tweens that exist *only* while the scene is frozen.

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

When a scene-scoped registration stays live relative to the owning scene's pause flag. Shared by every scene facility that accepts a `when` option - SceneAudio, SceneInputs and SceneTweens - so one policy vocabulary covers voices, bindings and tweens alike.

Pause is orthogonal to SceneState: these values only discriminate within `Active`, which is the only state where the pause flag applies. A suspended or preparing scope dispatches nothing regardless of the policy chosen here.

| Value | while running | while paused | |---|---:|---:| | `Active` | yes | no | | `Paused` | no | yes | | `Always` | yes | yes |

`Paused` is what pause menus are built from: input bindings and tweens that exist *only* while the scene is frozen.

Members3
Active
Always
Paused
Source
src/core/scene/SceneAvailability.ts