@relu-interactives/spatial-ecs 0.5.2 → 0.8.0

package/dist/docs/api/index/classes/ObjectVisibilitySystem.md

@@ -6,7 +6,7 @@
 
 # Class: ObjectVisibilitySystem
 
-Defined in: [systems/ObjectVisibilitySystem.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ObjectVisibilitySystem.ts#L5)
+Defined in: [systems/ObjectVisibilitySystem.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectVisibilitySystem.ts#L5)
 
 ## Implements
 
@@ -32,7 +32,7 @@ new ObjectVisibilitySystem(): ObjectVisibilitySystem;
 update(world): void;
 ```
 
-Defined in: [systems/ObjectVisibilitySystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ObjectVisibilitySystem.ts#L6)
+Defined in: [systems/ObjectVisibilitySystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectVisibilitySystem.ts#L6)
 
 #### Parameters
 

package/dist/docs/api/index/classes/PhysicsSyncSystem.md

@@ -6,7 +6,7 @@
 
 # Class: PhysicsSyncSystem
 
-Defined in: [systems/PhysicsSyncSystem.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PhysicsSyncSystem.ts#L352)
+Defined in: [systems/PhysicsSyncSystem.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L352)
 
 ## Implements
 
@@ -20,7 +20,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:352](https://github.com/Relu-Interacti
 new PhysicsSyncSystem(options?): PhysicsSyncSystem;
 ```
 
-Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PhysicsSyncSystem.ts#L362)
+Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L362)
 
 #### Parameters
 
@@ -41,7 +41,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interacti
 update(world, deltaTime): void;
 ```
 
-Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PhysicsSyncSystem.ts#L416)
+Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L416)
 
 #### Parameters
 
@@ -66,7 +66,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interacti
 dispose(world): void;
 ```
 
-Defined in: [systems/PhysicsSyncSystem.ts:642](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PhysicsSyncSystem.ts#L642)
+Defined in: [systems/PhysicsSyncSystem.ts:681](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L681)
 
 #### Parameters
 

package/dist/docs/api/index/classes/PostprocessingSyncSystem.md

@@ -6,7 +6,29 @@
 
 # Class: PostprocessingSyncSystem
 
-Defined in: [systems/PostprocessingSyncSystem.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PostprocessingSyncSystem.ts#L20)
+Defined in: [systems/PostprocessingSyncSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L39)
+
+Builds the post-processing chain from the scene's [Postprocessing](../../components/classes/Postprocessing.md)
+component and hands it to `RenderSystem` through `scene.userData`:
+
+- `ecsPostprocessingComposer` — the built chain (`render()`, `dispose()`,
+  optional `setSize()` / `setPixelRatio()`). On WebGL it is the
+  `EffectComposer` itself.
+- `ecsPostprocessingComposerActive` — `true` while `RenderSystem` should
+  render through it.
+- `ecsPostprocessing` — the values the chain was built from.
+
+The chain itself comes from the world's render backend: an
+`EffectComposer` on WebGL (pass order: scene render → depth of field →
+bloom → vignette → hue/saturation → sepia → film noise → dot screen →
+SSAO → glitch → chromatic aberration → pixelation → SMAA → output), a
+`RenderPipeline` of TSL nodes with `webgpuBackend`. A backend that can
+update a chain in place (the WebGPU one) skips the rebuild when only
+parameters changed.
+
+The `toneMapping` effect has no pass of its own: when active it asks the
+renderer for tone mapping, which the chain's output step then applies. See
+`Environment.values.lighting.toneMapping` for how the two combine.
 
 ## Implements
 
@@ -20,18 +42,20 @@ Defined in: [systems/PostprocessingSyncSystem.ts:20](https://github.com/Relu-Int
 new PostprocessingSyncSystem(
    renderer, 
    scene, 
-   camera): PostprocessingSyncSystem;
+   camera, 
+   backend?): PostprocessingSyncSystem;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PostprocessingSyncSystem.ts#L28)
+Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L54)
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `renderer` | `WebGLRenderer` |
-| `scene` | `Scene` |
-| `camera` | `PerspectiveCamera` |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `renderer` | [`EcsRenderer`](../type-aliases/EcsRenderer.md) | - |
+| `scene` | `Scene` | - |
+| `camera` | `PerspectiveCamera` | - |
+| `backend?` | [`RenderBackend`](../interfaces/RenderBackend.md) | Builds the chain. When omitted, the world's backend (`world.getRenderBackend()`) is used. |
 
 #### Returns
 
@@ -45,7 +69,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:28](https://github.com/Relu-Int
 update(world): void;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PostprocessingSyncSystem.ts#L170)
+Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L156)
 
 #### Parameters
 
@@ -69,7 +93,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:170](https://github.com/Relu-In
 dispose(): void;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/PostprocessingSyncSystem.ts#L197)
+Defined in: [systems/PostprocessingSyncSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L186)
 
 #### Returns
 

package/dist/docs/api/index/classes/RenderSystem.md

@@ -6,7 +6,16 @@
 
 # Class: RenderSystem
 
-Defined in: [systems/RenderSystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/RenderSystem.ts#L6)
+Defined in: [systems/RenderSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L31)
+
+Draws the frame: through the post-processing chain in
+`scene.userData.ecsPostprocessingComposer` while
+`scene.userData.ecsPostprocessingComposerActive` is `true`, otherwise with
+`renderer.render(scene, camera)`. Runs last in the default system list.
+
+Works with `WebGLRenderer` and `WebGPURenderer`. A `WebGPURenderer` must be
+initialised (`await renderer.init()`) first; until it is, frames are
+skipped with a single warning instead of throwing.
 
 ## Implements
 
@@ -24,13 +33,13 @@ new RenderSystem(
    afterRender?): RenderSystem;
 ```
 
-Defined in: [systems/RenderSystem.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/RenderSystem.ts#L12)
+Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L43)
 
 #### Parameters
 
 | Parameter | Type |
 | ------ | ------ |
-| `renderer` | `WebGLRenderer` |
+| `renderer` | [`EcsRenderer`](../type-aliases/EcsRenderer.md) |
 | `scene` | `Scene` |
 | `camera` | `PerspectiveCamera` |
 | `afterRender?` | () => `void` |
@@ -47,7 +56,7 @@ Defined in: [systems/RenderSystem.ts:12](https://github.com/Relu-Interactives/re
 update(_world): void;
 ```
 
-Defined in: [systems/RenderSystem.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/RenderSystem.ts#L24)
+Defined in: [systems/RenderSystem.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L119)
 
 #### Parameters
 

package/dist/docs/api/index/classes/ScriptBehaviourSystem.md

@@ -6,7 +6,7 @@
 
 # Class: ScriptBehaviourSystem
 
-Defined in: [systems/ScriptBehaviourSystem.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptBehaviourSystem.ts#L111)
+Defined in: [systems/ScriptBehaviourSystem.ts:131](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L131)
 
 ## Implements
 
@@ -17,10 +17,13 @@ Defined in: [systems/ScriptBehaviourSystem.ts:111](https://github.com/Relu-Inter
 ### Constructor
 
 ```ts
-new ScriptBehaviourSystem(moduleLoader?, selectionContext?): ScriptBehaviourSystem;
+new ScriptBehaviourSystem(
+   moduleLoader?, 
+   selectionContext?, 
+   options?): ScriptBehaviourSystem;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptBehaviourSystem.ts#L126)
+Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L151)
 
 #### Parameters
 
@@ -28,6 +31,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:126](https://github.com/Relu-Inter
 | ------ | ------ |
 | `moduleLoader?` | [`ModuleLoader`](../type-aliases/ModuleLoader.md) |
 | `selectionContext?` | [`SelectionContext`](../type-aliases/SelectionContext.md) |
+| `options?` | [`ScriptBehaviourSystemOptions`](../type-aliases/ScriptBehaviourSystemOptions.md) |
 
 #### Returns
 
@@ -41,7 +45,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:126](https://github.com/Relu-Inter
 update(world, deltaTime): void;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptBehaviourSystem.ts#L224)
+Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L286)
 
 #### Parameters
 
@@ -66,7 +70,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:224](https://github.com/Relu-Inter
 dispose(world): void;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:411](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptBehaviourSystem.ts#L411)
+Defined in: [systems/ScriptBehaviourSystem.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L512)
 
 #### Parameters
 

package/dist/docs/api/index/classes/ScriptObject.md

@@ -6,7 +6,7 @@
 
 # Class: ScriptObject
 
-Defined in: [ScriptObject.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L51)
+Defined in: [ScriptObject.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L51)
 
 Base class for **script objects** — entities whose THREE.js visual is built
 entirely by user code (procedural geometry, shaders, particle systems,
@@ -64,7 +64,7 @@ new ScriptObject(
    data?): ScriptObject;
 ```
 
-Defined in: [ScriptObject.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L84)
+Defined in: [ScriptObject.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L84)
 
 Engine-managed constructor. `ScriptObjectSystem` instantiates subclasses
 with the owning world, the entity id, and the component's `data`. User code
@@ -86,11 +86,11 @@ should not call this directly.
 
 | Property | Modifier | Type | Default value | Description | Defined in |
 | ------ | ------ | ------ | ------ | ------ | ------ |
-| <a id="__reluscriptobjectclass"></a> `__reluScriptObjectClass` | `readonly` | `true` | `undefined` | Static marker used by `ScriptObjectSystem` to detect `ScriptObject` subclasses even when a bundler ships a second copy of the package into the script blob (breaking `instanceof`). Do NOT override. | [ScriptObject.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L57) |
-| <a id="data"></a> `data` | `public` | `Record`\<`string`, `unknown`\> | `{}` | The script's data payload (the `ScriptObjectComponent.data`). Declare a concrete shape on subclasses with `declare data: MyShape` for type safety. Use the same typed input envelopes as Behaviours (`ColorInput`, `SliderInput`, `EntityInput`, …) to get inspector fields. | [ScriptObject.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L65) |
-| <a id="world"></a> `world` | `public` | [`World`](World.md) | `undefined` | The owning ECS world. | [ScriptObject.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L68) |
-| <a id="entityid"></a> `entityId` | `public` | `number` | `undefined` | The entity this script object is bound to. | [ScriptObject.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L71) |
-| <a id="root"></a> `root` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | `null` | The Object3D returned by [ScriptObject.build](#build). Assigned by `ScriptObjectSystem` after `build()` runs; `null` until then. | [ScriptObject.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L77) |
+| <a id="__reluscriptobjectclass"></a> `__reluScriptObjectClass` | `readonly` | `true` | `undefined` | Static marker used by `ScriptObjectSystem` to detect `ScriptObject` subclasses even when a bundler ships a second copy of the package into the script blob (breaking `instanceof`). Do NOT override. | [ScriptObject.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L57) |
+| <a id="data"></a> `data` | `public` | `Record`\<`string`, `unknown`\> | `{}` | The script's data payload (the `ScriptObjectComponent.data`). Declare a concrete shape on subclasses with `declare data: MyShape` for type safety. Use the same typed input envelopes as Behaviours (`ColorInput`, `SliderInput`, `EntityInput`, …) to get inspector fields. | [ScriptObject.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L65) |
+| <a id="world"></a> `world` | `public` | [`World`](World.md) | `undefined` | The owning ECS world. | [ScriptObject.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L68) |
+| <a id="entityid"></a> `entityId` | `public` | `number` | `undefined` | The entity this script object is bound to. | [ScriptObject.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L71) |
+| <a id="root"></a> `root` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | `null` | The Object3D returned by [ScriptObject.build](#build). Assigned by `ScriptObjectSystem` after `build()` runs; `null` until then. | [ScriptObject.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L77) |
 
 ## Methods
 
@@ -100,7 +100,7 @@ should not call this directly.
 build(): Object3D;
 ```
 
-Defined in: [ScriptObject.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L96)
+Defined in: [ScriptObject.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L96)
 
 REQUIRED — build and return the visual root. Called once by
 `ScriptObjectSystem` after construction. The returned object is attached
@@ -119,7 +119,7 @@ and visibility). Subclasses MUST override.
 optional update(deltaTime): void;
 ```
 
-Defined in: [ScriptObject.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L106)
+Defined in: [ScriptObject.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L106)
 
 OPTIONAL — per-frame hook. Runs in the editor AND at runtime (e.g. advance
 a shader time uniform, procedural animation). Keep per-frame work on local
@@ -144,7 +144,7 @@ churns the editor's undo history).
 optional dispose(): void;
 ```
 
-Defined in: [ScriptObject.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/ScriptObject.ts#L114)
+Defined in: [ScriptObject.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L114)
 
 OPTIONAL — free any GPU resources this script created (geometries,
 materials, textures, render targets). Called by `ScriptObjectSystem` when

package/dist/docs/api/index/classes/ScriptObjectSystem.md

@@ -6,7 +6,7 @@
 
 # Class: ScriptObjectSystem
 
-Defined in: [systems/ScriptObjectSystem.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L97)
+Defined in: [systems/ScriptObjectSystem.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L101)
 
 Builds, ticks, and disposes [ScriptObject](ScriptObject.md) scripts. Unlike
 `ScriptBehaviourSystem`, this runs in the editor AND at runtime — there is NO
@@ -29,7 +29,7 @@ Construct it and pass it to `World.setup({ systems })`.
 new ScriptObjectSystem(moduleLoader?): ScriptObjectSystem;
 ```
 
-Defined in: [systems/ScriptObjectSystem.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L104)
+Defined in: [systems/ScriptObjectSystem.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L110)
 
 #### Parameters
 
@@ -49,7 +49,7 @@ Defined in: [systems/ScriptObjectSystem.ts:104](https://github.com/Relu-Interact
 update(world, deltaTime): void;
 ```
 
-Defined in: [systems/ScriptObjectSystem.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L108)
+Defined in: [systems/ScriptObjectSystem.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L114)
 
 #### Parameters
 
@@ -74,7 +74,7 @@ Defined in: [systems/ScriptObjectSystem.ts:108](https://github.com/Relu-Interact
 invalidateAll(): void;
 ```
 
-Defined in: [systems/ScriptObjectSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L407)
+Defined in: [systems/ScriptObjectSystem.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L441)
 
 Dispose all live instances so the next update() reloads with fresh modules.
 
@@ -90,7 +90,7 @@ Dispose all live instances so the next update() reloads with fresh modules.
 invalidate(scriptUrl): void;
 ```
 
-Defined in: [systems/ScriptObjectSystem.ts:422](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L422)
+Defined in: [systems/ScriptObjectSystem.ts:458](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L458)
 
 Invalidate only the entities whose script matches `scriptUrl`.
 
@@ -112,7 +112,7 @@ Invalidate only the entities whose script matches `scriptUrl`.
 dispose(world): void;
 ```
 
-Defined in: [systems/ScriptObjectSystem.ts:439](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/ScriptObjectSystem.ts#L439)
+Defined in: [systems/ScriptObjectSystem.ts:476](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L476)
 
 #### Parameters
 

package/dist/docs/api/index/classes/TeleportAimGate.md

@@ -0,0 +1,114 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / TeleportAimGate
+
+# Class: TeleportAimGate
+
+Defined in: [xr/teleportAimGate.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L17)
+
+Decides when a teleport may actually commit.
+
+Teleport commits on RELEASE so the user can cancel by aiming away — the
+standard interaction. The trap is that a release edge alone is not evidence
+of intent: on hand tracking the SAME pinch drives grabbing, so the release
+that drops an object looks identical to the release that ends a teleport aim.
+Without this gate, letting go of a grabbed object teleports the player
+whenever the arc happens to land somewhere valid — and passing an object
+between hands does it too.
+
+The rule is simply: a release only commits if this source engaged an aim
+first, and going busy (grabbing) discards any aim it had engaged.
+
+Keyed per input source so the two hands are independent.
+
+## Constructors
+
+### Constructor
+
+```ts
+new TeleportAimGate(): TeleportAimGate;
+```
+
+#### Returns
+
+`TeleportAimGate`
+
+## Methods
+
+### update()
+
+```ts
+update(
+   source, 
+   aiming, 
+   releasing): boolean;
+```
+
+Defined in: [xr/teleportAimGate.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L25)
+
+Feed one frame for one source.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `object` |
+| `aiming` | `boolean` |
+| `releasing` | `boolean` |
+
+#### Returns
+
+`boolean`
+
+whether the teleport should commit this frame.
+
+***
+
+### isAiming()
+
+```ts
+isAiming(source): boolean;
+```
+
+Defined in: [xr/teleportAimGate.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L42)
+
+True if this source currently has an aim engaged.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `object` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### cancel()
+
+```ts
+cancel(source): boolean;
+```
+
+Defined in: [xr/teleportAimGate.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L54)
+
+Drop a source's aim without committing.
+
+Called when a hand starts interacting, so the release that ends the grab
+cannot cash in an aim engaged before it.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `object` |
+
+#### Returns
+
+`boolean`
+
+whether an aim was actually discarded.

package/dist/docs/api/index/classes/ThrowVelocityTracker.md

@@ -0,0 +1,89 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ThrowVelocityTracker
+
+# Class: ThrowVelocityTracker
+
+Defined in: [xr/throwVelocity.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L52)
+
+Rolling buffer of hand positions used to recover throw velocity.
+
+One per active grab; cleared on release.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ThrowVelocityTracker(): ThrowVelocityTracker;
+```
+
+#### Returns
+
+`ThrowVelocityTracker`
+
+## Methods
+
+### record()
+
+```ts
+record(position, time): void;
+```
+
+Defined in: [xr/throwVelocity.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L56)
+
+Record where the hand is now. Call once per frame while held.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `position` | `Vector3` |
+| `time` | `number` |
+
+#### Returns
+
+`void`
+
+***
+
+### computeVelocity()
+
+```ts
+computeVelocity(now): Vector3;
+```
+
+Defined in: [xr/throwVelocity.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L71)
+
+Velocity to release with, in metres/second.
+
+Uses the FASTEST segment inside the window rather than the most recent or
+the window average. Users decelerate as they open their hand, so the last
+segment understates the throw and the average washes it out; peak speed is
+what matches the motion the user actually felt they made.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `now` | `number` |
+
+#### Returns
+
+`Vector3`
+
+***
+
+### clear()
+
+```ts
+clear(): void;
+```
+
+Defined in: [xr/throwVelocity.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L105)
+
+#### Returns
+
+`void`

package/dist/docs/api/index/classes/TransformSyncSystem.md

@@ -6,7 +6,7 @@
 
 # Class: TransformSyncSystem
 
-Defined in: [systems/TransformSyncSystem.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/TransformSyncSystem.ts#L7)
+Defined in: [systems/TransformSyncSystem.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/TransformSyncSystem.ts#L7)
 
 ## Implements
 
@@ -32,7 +32,7 @@ new TransformSyncSystem(): TransformSyncSystem;
 update(world): void;
 ```
 
-Defined in: [systems/TransformSyncSystem.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/systems/TransformSyncSystem.ts#L8)
+Defined in: [systems/TransformSyncSystem.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/TransformSyncSystem.ts#L8)
 
 #### Parameters
 

package/dist/docs/api/index/classes/UIInteractionSystem.md

@@ -0,0 +1,60 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UIInteractionSystem
+
+# Class: UIInteractionSystem
+
+Defined in: [systems/UIInteractionSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L56)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UIInteractionSystem(interaction, options?): UIInteractionSystem;
+```
+
+Defined in: [systems/UIInteractionSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L72)
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `interaction` | [`XRInteractionSystem`](XRInteractionSystem.md) \| `null` | The XR interaction system, or null in a world with no XR (flat 3D experiences) — the mouse path still works via `options.inputSystem`. |
+| `options?` | \{ `inputSystem?`: [`InputSystem`](InputSystem.md); \} | - |
+| `options.inputSystem?` | [`InputSystem`](InputSystem.md) | - |
+
+#### Returns
+
+`UIInteractionSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime?): void;
+```
+
+Defined in: [systems/UIInteractionSystem.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L86)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `world` | [`World`](World.md) | `undefined` |
+| `deltaTime` | `number` | `0` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)