Skip to content

@vgai/engine API

VGAI Reference 0.3

Planned versioned generated-api truth covering Game root and multi-world runtime, Object3D-as-truth GameComponent model, Fixed-step game loop and ordered systems, Scene and prefab schemas, parsing, and runtime loading, Scene queries and validated scene diffs, Typed data assets and references, Typed input actions, devices, prompts, and rebinding, Three-dimensional Rapier physics, Authored three-dimensional physics joints, Two-dimensional Rapier/Pixi physics, Native XState animation state machines and blend trees, Masked and additive animation layers, Deterministic animation/cinematic clock and cues, Theatre.js deterministic integration, GSAP deterministic integration, Runtime and offline audio, Navigation mesh and crowd navigation, Render settings, features, and automatic batching, Scene materials and material registry, Scene lighting, shadows, and environment, Generated geometry and splines, Scene particle systems, Postprocessing pipeline, Scene cameras and deterministic camera ownership, React game state and selection hooks, First-party PixiJS worlds and 2D authoring, Game, authoring, and system adapter seams, Existing-game ingestion for Three.js, PixiJS, and React DOM, Runtime performance panels and profiling, Direct Colyseus-authored multiplayer, Runtime asset cache, loaders, references, and registries, Debug draw, console bridge, and structured engine logging, Project-defined editor tool contract, Current engine and schema reference generation.

planned · generated · immutable Reference 0.3

Lifecycle and constraints

Detailed constraints will publish with the generated or reviewed entry.

Runnable Learn material

Generated package API

7 packages, 189 modules, and 1791 public symbol appearances at 27379135c75d09f5e06ff5e5894c63a97d80e777.