Struct Scene 

pub struct Scene {
    pub world: World,
    pub settings: SceneSettings,
    pub signals: SignalBus,
    pub audio: AudioBus,
    pub globals: BTreeMap<String, Value>,
}

ECS world plus environment settings. Default registers every built-in component.

Serialized scenes omit transient entities and rebuild world transforms on load. Entity handles are remapped on load and must not be persisted outside the scene.

Fields

world: World

Live entity/component storage, including runtime-only components.

settings: SceneSettings

Scene lighting, physics and display configuration.

signals: SignalBus

Bounded next-frame script messages. Not serialized or copied into scene snapshots.

audio: AudioBus

Sound requests for the shell’s audio backend. Not serialized.

globals: BTreeMap<String, Value>

Named values shared by all scripts (score, difficulty…). Not serialized; see Ctx::set_global.

Implementations

impl Scene

pub fn to_json(&self, reg: &Registry) -> String

Serializes persistent entities and registered components as pretty JSON. Runtime-only state is omitted. Prefer Self::try_to_json when saving files.

pub fn try_to_json(&self, reg: &Registry) -> Result<String, String>

Serializes a scene, reporting JSON encoding errors instead of returning an empty string. Component serializers in the registry may omit components they cannot encode.

pub fn from_json( reg: &Registry, text: &str, ) -> Result<(Scene, Vec<String>), String>

Returns the scene and any non-fatal warnings (unknown or malformed components).

pub fn add_json( &mut self, reg: &Registry, text: &str, ) -> Result<Vec<String>, String>

Adds every object of a scene file to this scene (its settings are ignored). Returns the warnings of the load; the new root objects keep their places.

pub fn load(reg: &Registry, path: &Path) -> Result<(Scene, Vec<String>), String>

Loads a UTF-8 JSON scene from disk, preserving non-fatal component/hierarchy warnings.

pub fn save(&self, reg: &Registry, path: &Path) -> Result<(), String>

Saves persistent scene data. Parent directories must already exist.

pub fn snapshot(&self, reg: &Registry) -> Result<(Scene, Vec<String>), String>

Creates an independent persistent snapshot, omitting transient/runtime-only state. Returns the same warnings as loading the serialized scene.

pub fn validate(&self, reg: &Registry) -> Vec<String>

Reports persistence errors, dangling parents and hierarchy cycles without mutation. Missing transforms are allowed by the ECS but reported here for editor-visible entities. This explicit diagnostic pass does not run automatically on every gameplay tick.

pub fn spawn(&mut self, name: &str) -> Entity

Spawns a named entity with an identity local transform.

pub fn find(&self, name: &str) -> Option<Entity>

First exact name match, if present. Entity names need not be unique.

pub fn despawn(&mut self, entity: Entity)

Removes an entity and its complete subtree, including transient children.

Trait Implementations

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.