Struct SpatialRuntime 

pub struct SpatialRuntime { /* private fields */ }

A reusable language machine coupled to a persistent deterministic Rapier world.

Implementations

impl SpatialRuntime

pub fn new( source: &str, modules: &BTreeMap<String, String>, ) -> Result<Self, Vec<Diagnostic>>

Compiles, initializes, and validates a program without advancing physics. Imports use only the explicitly supplied module map.

pub const fn execution_state(&self) -> (u64, bool)

Returns the language fixed tick and terminal lifecycle state without materializing a scene or snapshot.

pub fn step(&mut self, count: u32) -> Result<Snapshot, Diagnostic>

Advances up to MAX_STEP_COUNT fixed ticks. A rejected batch preserves all previously committed language and physics state, including impulses.

pub fn finish(&mut self) -> Result<Snapshot, Diagnostic>

Runs system teardown and validates its spatial edits as one transaction. Repeated calls return the finished snapshot without repeating callbacks.

Errors

A failed callback or invalid spatial edit preserves the running world.

pub fn invoke( &mut self, name: &str, arguments: &[Value], ) -> Result<Value, Diagnostic>

Invokes an exported function, validating all resulting spatial edits before committing. Impulses are applied only when a subsequent tick succeeds.

pub fn invoke_component( &mut self, id: u64, component: &str, field: &str, arguments: &[Value], ) -> Result<Value, Diagnostic>

Invokes a function stored in an exact component field. Resulting spatial edits and physics reconciliation join the language transaction.

pub fn invoke_entity( &mut self, id: u64, method: &str, arguments: &[Value], ) -> Result<Value, Diagnostic>

Invokes an unambiguous zero-argument or typed component method on one entity, with the same spatial transaction as a named function call.

pub fn snapshot(&self) -> Snapshot

Returns the committed ECS, globals, logs, and simulation clock.

pub fn render(&self) -> Result<RenderOutput, Diagnostic>

Validates and adapts every geometry component to an SDK scene and mesh.

impl SpatialRuntime

pub fn ui_document(&self) -> Result<UiDocument, PresentationError>

Returns semantic controls for a standalone interpreter instance.

pub fn invoke_ui(&mut self, event: &UiEvent) -> Result<Snapshot, Diagnostic>

Validates and executes one semantic input transactionally in a standalone instance.

Trait Implementations

impl Clone for SpatialRuntime

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.