@relu-interactives/spatial-ecs 0.5.2 → 0.8.0

package/dist/docs/api/components/classes/VideoComponent.md

@@ -6,7 +6,7 @@
 
 # Class: VideoComponent
 
-Defined in: [components/Video.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L37)
+Defined in: [components/Video.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L37)
 
 Plays a video file as a texture on a quad. Supports green-screen keying
 (`isGreenScreen`, `backgroundColor`, `similarity`, `smoothness`, `spill`).
@@ -25,7 +25,7 @@ when the project loads.
 new VideoComponent(path, options?): VideoComponent;
 ```
 
-Defined in: [components/Video.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L90)
+Defined in: [components/Video.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L90)
 
 #### Parameters
 
@@ -46,29 +46,29 @@ Defined in: [components/Video.ts:90](https://github.com/Relu-Interactives/relu-s
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the video file. | [components/Video.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L39) |
-| <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `volume`: `number`; `width`: `number`; `height`: `number`; `isGreenScreen`: `boolean`; `backgroundColor`: `string`; `similarity`: `number`; `smoothness`: `number`; `spill`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback + green-screen options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the video is ready. | | `loop` | `true` | Loop playback indefinitely. | | `volume` | `1` | Linear gain in `[0, 1]`. | | `width` | `1` | Quad width in world units. | | `height` | `1` | Quad height in world units. | | `isGreenScreen` | `false` | Enable chroma keying using the fields below. | | `backgroundColor` | `"#00ff00"` | Color to key out (CSS color string). | | `similarity` | `0.4` | How close a pixel must be to the key to be removed (`0`–`1`). | | `smoothness` | `0.08` | Soft-edge thickness around the key threshold. | | `spill` | `0.12` | Amount of color spill suppression near edges. | | `positional` | `false` | When `true`, the video's audio stream is spatialized using the entity's 3D position. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). Positional only. | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. Positional only. | | [components/Video.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L60) |
-| `options.autoplay` | `boolean` | - | [components/Video.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L9) |
-| `options.loop` | `boolean` | - | [components/Video.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L10) |
-| `options.volume` | `number` | - | [components/Video.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L11) |
-| `options.width` | `number` | - | [components/Video.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L12) |
-| `options.height` | `number` | - | [components/Video.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L13) |
-| `options.isGreenScreen` | `boolean` | - | [components/Video.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L14) |
-| `options.backgroundColor` | `string` | - | [components/Video.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L15) |
-| `options.similarity` | `number` | - | [components/Video.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L16) |
-| `options.smoothness` | `number` | - | [components/Video.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L17) |
-| `options.spill` | `number` | - | [components/Video.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L18) |
-| `options.positional` | `boolean` | When `true`, the video's audio stream is spatialized using the entity's transform. | [components/Video.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L20) |
-| `options.refDistance` | `number` | Distance at which volume is unattenuated (positional only). | [components/Video.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L22) |
-| `options.distanceModel` | `string` | WebAudio distance model (`linear`, `inverse`, `exponential`). Positional only. | [components/Video.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L24) |
-| `options.rolloffFactor` | `number` | How quickly volume falls off past `refDistance`. Positional only. | [components/Video.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L26) |
-| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the video quad. `null` until built. | [components/Video.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L62) |
-| <a id="videoelement"></a> `videoElement` | `HTMLVideoElement` \| `null` | Underlying HTML video element. `null` until built. | [components/Video.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L64) |
-| <a id="texture"></a> `texture` | `VideoTexture` \| `null` | Three.js texture sampling the video element. `null` until built. | [components/Video.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L66) |
-| <a id="material"></a> `material` | `Material` \| `null` | Material rendering the video texture (with green-screen shader when enabled). `null` until built. | [components/Video.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L68) |
-| <a id="audionode"></a> `audioNode` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | THREE.js audio node connected to this video's audio stream via `setMediaElementSource`. Present only in preview when the camera listener is available. `null` in editor mode. | [components/Video.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L74) |
-| <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the video should be playing. Managed by `VideoSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Video.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L81) |
-| <a id="ispaused"></a> `isPaused` | `boolean` | Whether the video is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Video.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L88) |
+| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the video file. | [components/Video.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L39) |
+| <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `volume`: `number`; `width`: `number`; `height`: `number`; `isGreenScreen`: `boolean`; `backgroundColor`: `string`; `similarity`: `number`; `smoothness`: `number`; `spill`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback + green-screen options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the video is ready. | | `loop` | `true` | Loop playback indefinitely. | | `volume` | `1` | Linear gain in `[0, 1]`. | | `width` | `1` | Quad width in world units. | | `height` | `1` | Quad height in world units. | | `isGreenScreen` | `false` | Enable chroma keying using the fields below. | | `backgroundColor` | `"#00ff00"` | Color to key out (CSS color string). | | `similarity` | `0.4` | How close a pixel must be to the key to be removed (`0`–`1`). | | `smoothness` | `0.08` | Soft-edge thickness around the key threshold. | | `spill` | `0.12` | Amount of color spill suppression near edges. | | `positional` | `false` | When `true`, the video's audio stream is spatialized using the entity's 3D position. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). Positional only. | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. Positional only. | | [components/Video.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L60) |
+| `options.autoplay` | `boolean` | - | [components/Video.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L9) |
+| `options.loop` | `boolean` | - | [components/Video.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L10) |
+| `options.volume` | `number` | - | [components/Video.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L11) |
+| `options.width` | `number` | - | [components/Video.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L12) |
+| `options.height` | `number` | - | [components/Video.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L13) |
+| `options.isGreenScreen` | `boolean` | - | [components/Video.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L14) |
+| `options.backgroundColor` | `string` | - | [components/Video.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L15) |
+| `options.similarity` | `number` | - | [components/Video.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L16) |
+| `options.smoothness` | `number` | - | [components/Video.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L17) |
+| `options.spill` | `number` | - | [components/Video.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L18) |
+| `options.positional` | `boolean` | When `true`, the video's audio stream is spatialized using the entity's transform. | [components/Video.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L20) |
+| `options.refDistance` | `number` | Distance at which volume is unattenuated (positional only). | [components/Video.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L22) |
+| `options.distanceModel` | `string` | WebAudio distance model (`linear`, `inverse`, `exponential`). Positional only. | [components/Video.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L24) |
+| `options.rolloffFactor` | `number` | How quickly volume falls off past `refDistance`. Positional only. | [components/Video.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L26) |
+| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the video quad. `null` until built. | [components/Video.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L62) |
+| <a id="videoelement"></a> `videoElement` | `HTMLVideoElement` \| `null` | Underlying HTML video element. `null` until built. | [components/Video.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L64) |
+| <a id="texture"></a> `texture` | `VideoTexture`\<`HTMLVideoElement`\> \| `null` | Three.js texture sampling the video element. `null` until built. | [components/Video.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L66) |
+| <a id="material"></a> `material` | `Material`\<`MaterialEventMap`\> \| `null` | Material rendering the video texture (with green-screen shader when enabled). `null` until built. | [components/Video.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L68) |
+| <a id="audionode"></a> `audioNode` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | THREE.js audio node connected to this video's audio stream via `setMediaElementSource`. Present only in preview when the camera listener is available. `null` in editor mode. | [components/Video.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L74) |
+| <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the video should be playing. Managed by `VideoSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Video.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L81) |
+| <a id="ispaused"></a> `isPaused` | `boolean` | Whether the video is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Video.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L88) |
 
 ## Methods
 
@@ -78,7 +78,7 @@ Defined in: [components/Video.ts:90](https://github.com/Relu-Interactives/relu-s
 play(): void;
 ```
 
-Defined in: [components/Video.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L127)
+Defined in: [components/Video.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L127)
 
 Signals `VideoSystem` to start (or resume) playback.
 Has no direct effect in the editor — `VideoSystem` drives the actual
@@ -96,7 +96,7 @@ HTML video element call in preview.
 pause(): void;
 ```
 
-Defined in: [components/Video.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L137)
+Defined in: [components/Video.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L137)
 
 Signals `VideoSystem` to pause playback, preserving the current position.
 Calling [play](#play) afterwards resumes from where it paused.
@@ -114,7 +114,7 @@ No-op if not currently playing.
 stop(): void;
 ```
 
-Defined in: [components/Video.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Video.ts#L146)
+Defined in: [components/Video.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Video.ts#L146)
 
 Signals `VideoSystem` to stop playback and reset the playback position.
 

package/dist/docs/api/components/classes/XRAnchorComponent.md

@@ -0,0 +1,64 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRAnchorComponent
+
+# Class: XRAnchorComponent
+
+Defined in: [components/XRAnchor.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L33)
+
+Pins an entity to a real-world position.
+
+A headset's idea of where the room is keeps being refined while a session
+runs — it re-recognises the space, corrects drift, and quietly shifts its
+coordinate system by a few centimetres. Content placed at fixed scene
+coordinates does not move with those corrections, so a vase carefully set on a
+real table gradually slides off it.
+
+An anchor is the runtime's own handle on a point in the room. Attaching this
+component hands the entity's pose over to that handle, so the entity moves
+exactly as the runtime's understanding of the room moves and stays put
+relative to the real world.
+
+Because the anchor OWNS the transform once created, moving the entity by
+script or by physics has no lasting effect — release it first if you want to
+move it, then re-anchor.
+
+Anchors last only as long as the session. Persisting one across launches
+needs `requestPersistentHandle`, which is still a draft extension and not
+supported here.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRAnchorComponent(options?): XRAnchorComponent;
+```
+
+Defined in: [components/XRAnchor.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L37)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`XRAnchorOptions`](../type-aliases/XRAnchorOptions.md) |
+
+#### Returns
+
+`XRAnchorComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled` | `boolean` | Whether the entity should anchor. Turning this off releases the anchor. | [components/XRAnchor.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L35) |

package/dist/docs/api/components/classes/XREnvironmentComponent.md

@@ -0,0 +1,64 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XREnvironmentComponent
+
+# Class: XREnvironmentComponent
+
+Defined in: [components/XREnvironment.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L26)
+
+Marks an entity as a piece of the user's REAL room, detected at runtime.
+
+These entities are spawned by `XREnvironmentSystem` from WebXR plane and mesh
+detection — they are never authored, never saved, and vanish with the session.
+They exist as ordinary entities (rather than colliders hidden inside a system)
+so the normal physics pipeline builds their colliders, and so scripts can find
+them with a plain `world.query(XREnvironmentComponent)`.
+
+`semanticLabel` is what makes them useful to a game rather than just solid:
+it is how a script says "spawn the target on a WALL" or "only drop coins on the
+FLOOR". It is whatever the runtime reported — commonly `floor`, `wall`,
+`ceiling`, `table`, `desk`, `couch`, `door`, `window` — and is `null` on
+runtimes that classify nothing, so always handle the null case.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XREnvironmentComponent(
+   kind, 
+   semanticLabel?, 
+   orientation?): XREnvironmentComponent;
+```
+
+Defined in: [components/XREnvironment.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L34)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `kind` | [`XrEnvironmentKind`](../type-aliases/XrEnvironmentKind.md) | `undefined` |
+| `semanticLabel` | `string` \| `null` | `null` |
+| `orientation` | \| [`XrEnvironmentOrientation`](../type-aliases/XrEnvironmentOrientation.md) \| `null` | `null` |
+
+#### Returns
+
+`XREnvironmentComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | [`XrEnvironmentKind`](../type-aliases/XrEnvironmentKind.md) | Whether this came from plane detection or the room mesh. | [components/XREnvironment.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L28) |
+| <a id="semanticlabel"></a> `semanticLabel` | `string` \| `null` | The runtime's classification, or `null` when it did not provide one. | [components/XREnvironment.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L30) |
+| <a id="orientation"></a> `orientation` | \| [`XrEnvironmentOrientation`](../type-aliases/XrEnvironmentOrientation.md) \| `null` | Plane orientation, or `null` for mesh geometry and unclassified planes. | [components/XREnvironment.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L32) |

package/dist/docs/api/components/classes/XRHandPoseComponent.md

@@ -0,0 +1,50 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRHandPoseComponent
+
+# Class: XRHandPoseComponent
+
+Defined in: [components/XRHandPose.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L135)
+
+Listens for hand poses and reports them to the entity's Behaviours.
+
+Attached to any entity that wants to react to a gesture — the poses are
+detected on the user's hands, not on the entity, so this is a subscription
+rather than a property of the object itself.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRHandPoseComponent(options?): XRHandPoseComponent;
+```
+
+Defined in: [components/XRHandPose.ts:139](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L139)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`XRHandPoseOptions`](../type-aliases/XRHandPoseOptions.md) |
+
+#### Returns
+
+`XRHandPoseComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled` | `boolean` | [components/XRHandPose.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L136) |
+| <a id="poses"></a> `poses` | [`XrHandPoseEntry`](../type-aliases/XrHandPoseEntry.md)[] | [components/XRHandPose.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L137) |

package/dist/docs/api/components/classes/XRInteractableComponent.md

@@ -0,0 +1,74 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRInteractableComponent
+
+# Class: XRInteractableComponent
+
+Defined in: [components/XRInteractable.ts:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L123)
+
+Makes an entity respond to XR pointers and hands.
+
+Split into `pointable` and `grabbable` because they are different
+affordances: a wall panel should receive select events without being
+liftable, while a physics prop should be both.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRInteractableComponent(options?): XRInteractableComponent;
+```
+
+Defined in: [components/XRInteractable.ts:168](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L168)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`XRInteractableOptions`](../type-aliases/XRInteractableOptions.md) |
+
+#### Returns
+
+`XRInteractableComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled` | `boolean` | - | [components/XRInteractable.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L124) |
+| <a id="grabbable"></a> `grabbable` | `boolean` | - | [components/XRInteractable.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L125) |
+| <a id="pointable"></a> `pointable` | `boolean` | - | [components/XRInteractable.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L126) |
+| <a id="grabreach"></a> `grabReach` | [`XrGrabReach`](../type-aliases/XrGrabReach.md) | Whether the object can be grabbed up close, at range, or either. | [components/XRInteractable.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L128) |
+| <a id="distancebehavior"></a> `distanceBehavior` | [`XrDistanceGrabBehavior`](../type-aliases/XrDistanceGrabBehavior.md) | What a distance grab does — bring it here, or manipulate it in place. | [components/XRInteractable.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L130) |
+| <a id="grabgesture"></a> `grabGesture` | [`XrGrabGesture`](../type-aliases/XrGrabGesture.md) | Which gesture grabs it. | [components/XRInteractable.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L132) |
+| <a id="grabradius"></a> `grabRadius` | `number` | Metres within which a physical grab registers. | [components/XRInteractable.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L134) |
+| <a id="graboffsetposition"></a> `grabOffsetPosition` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Position offset from the hand while held. | [components/XRInteractable.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L136) |
+| `grabOffsetPosition.x` | `number` | - | [components/XRInteractable.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L136) |
+| `grabOffsetPosition.y` | `number` | - | [components/XRInteractable.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L136) |
+| `grabOffsetPosition.z` | `number` | - | [components/XRInteractable.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L136) |
+| <a id="graboffsetrotation"></a> `grabOffsetRotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Rotation offset (radians) while held. | [components/XRInteractable.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L138) |
+| `grabOffsetRotation.x` | `number` | - | [components/XRInteractable.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L138) |
+| `grabOffsetRotation.y` | `number` | - | [components/XRInteractable.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L138) |
+| `grabOffsetRotation.z` | `number` | - | [components/XRInteractable.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L138) |
+| <a id="grabhands"></a> `grabHands` | [`XrGrabHands`](../type-aliases/XrGrabHands.md) | How many hands may hold it, and whether a second grab transfers it. | [components/XRInteractable.ts:140](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L140) |
+| <a id="twohandrotation"></a> `twoHandRotation` | [`XrTwoHandRotation`](../type-aliases/XrTwoHandRotation.md) | Whether the second hand aims the object or only scales it. | [components/XRInteractable.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L142) |
+| <a id="allowtwohandscale"></a> `allowTwoHandScale` | `boolean` | Whether a two-hand grab may resize the object. | [components/XRInteractable.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L144) |
+| <a id="minscale"></a> `minScale` | `number` | Scale floor for one gesture, as a fraction of the size at grab time. | [components/XRInteractable.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L146) |
+| <a id="maxscale"></a> `maxScale` | `number` | Scale ceiling for one gesture, as a multiple of the size at grab time. | [components/XRInteractable.ts:148](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L148) |
+| <a id="attachpoints"></a> `attachPoints` | [`XrAttachPoint`](../type-aliases/XrAttachPoint.md)[] | Authored hand-holds; empty means grab anywhere. | [components/XRInteractable.ts:150](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L150) |
+| <a id="applyvelocityonrelease"></a> `applyVelocityOnRelease` | `boolean` | Hand the object the velocity it was moving with when released. Applies to every release, not just a deliberate throw — letting go while your hand drifts should nudge the object, which is why this is not called "throw". | [components/XRInteractable.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L158) |
+| <a id="velocityscale"></a> `velocityScale` | `number` | Multiplier on released velocity. | [components/XRInteractable.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L160) |
+| <a id="hoverbehavior"></a> `hoverBehavior` | `XrHoverBehavior` | Feedback shown while a pointer is on the object. | [components/XRInteractable.ts:162](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L162) |
+| <a id="hovercolor"></a> `hoverColor` | `string` | Outline colour for the `color` and `both` behaviours. | [components/XRInteractable.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L164) |
+| <a id="hoverscale"></a> `hoverScale` | `number` | Size multiplier for the `scale` and `both` behaviours. | [components/XRInteractable.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L166) |

package/dist/docs/api/components/classes/XRInteractorComponent.md

@@ -0,0 +1,57 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRInteractorComponent
+
+# Class: XRInteractorComponent
+
+Defined in: [components/XRInteractor.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L71)
+
+Configures what the user sees as their hands, and hosts custom hand content.
+
+An interactor entity owns two children — a left and a right interactor —
+whose transforms are driven by the corresponding tracked hand. Anything an
+author parents under those children renders at that hand, which is how custom
+tools, gloves, or held props are built without any scripting.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRInteractorComponent(options?): XRInteractorComponent;
+```
+
+Defined in: [components/XRInteractor.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L90)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`XRInteractorOptions`](../type-aliases/XRInteractorOptions.md) |
+
+#### Returns
+
+`XRInteractorComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="interactortype"></a> `interactorType` | [`XrInteractorType`](../type-aliases/XrInteractorType.md) | What to render at the hands. | [components/XRInteractor.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L73) |
+| <a id="handpreset"></a> `handPreset` | [`XrHandPreset`](../type-aliases/XrHandPreset.md) | Look for tracked-hand meshes. | [components/XRInteractor.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L75) |
+| <a id="handcolor"></a> `handColor` | `string` | Tint applied by the preset. | [components/XRInteractor.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L77) |
+| <a id="handopacity"></a> `handOpacity` | `number` | 0-1 opacity for translucent presets. | [components/XRInteractor.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L79) |
+| <a id="handemissiveintensity"></a> `handEmissiveIntensity` | `number` | Emissive strength for glowing presets. | [components/XRInteractor.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L81) |
+| <a id="rayvisibility"></a> `rayVisibility` | `XrRayVisibility` | When the pointer ray is drawn. | [components/XRInteractor.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L84) |
+| <a id="raycolor"></a> `rayColor` | `string` | Pointer ray colour. | [components/XRInteractor.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L86) |
+| <a id="raythickness"></a> `rayThickness` | `number` | Pointer ray thickness (diameter), metres. | [components/XRInteractor.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L88) |

package/dist/docs/api/components/classes/XRInteractorSideComponent.md

@@ -0,0 +1,50 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRInteractorSideComponent
+
+# Class: XRInteractorSideComponent
+
+Defined in: [components/XRInteractor.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L114)
+
+Marks an entity as the left or right hand slot of an [XRInteractorComponent](XRInteractorComponent.md).
+
+Its transform is driven every frame from the tracked hand, so authored
+children ride along. Authors never set this by hand — the interactor factory
+creates both slots.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRInteractorSideComponent(options?): XRInteractorSideComponent;
+```
+
+Defined in: [components/XRInteractor.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L118)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `side?`: [`XrInteractorSide`](../type-aliases/XrInteractorSide.md); \} |
+| `options.side?` | [`XrInteractorSide`](../type-aliases/XrInteractorSide.md) |
+
+#### Returns
+
+`XRInteractorSideComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="side"></a> `side` | [`XrInteractorSide`](../type-aliases/XrInteractorSide.md) | Which hand this slot follows. | [components/XRInteractor.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L116) |

package/dist/docs/api/components/classes/XRRigComponent.md

@@ -0,0 +1,68 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRRigComponent
+
+# Class: XRRigComponent
+
+Defined in: [components/XRRig.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L85)
+
+Marks an entity as the XR rig — the player's movable origin.
+
+The rig exists because a WebXR headset owns the camera pose absolutely: three
+composes the render camera as `rig.matrixWorld × headPose`, so the ONLY way
+to move the player is to move the camera's parent. The camera entity must be
+a child of this entity.
+
+Defaults are deliberately comfort-first — teleport locomotion with snap
+turning is the combination least likely to cause motion sickness, and is what
+every platform's design guidance recommends as the baseline.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRRigComponent(options?): XRRigComponent;
+```
+
+Defined in: [components/XRRig.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L125)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`XRRigOptions`](../type-aliases/XRRigOptions.md) |
+
+#### Returns
+
+`XRRigComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="trackingorigin"></a> `trackingOrigin` | [`XrTrackingOrigin`](../type-aliases/XrTrackingOrigin.md) | Where the headset origin sits (floor-relative vs eye-relative). | [components/XRRig.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L87) |
+| <a id="locomotion"></a> `locomotion` | [`XrLocomotionMode`](../type-aliases/XrLocomotionMode.md) | Movement style. | [components/XRRig.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L89) |
+| <a id="movespeed"></a> `moveSpeed` | `number` | Metres/second for `smooth` locomotion. | [components/XRRig.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L91) |
+| <a id="snapturn"></a> `snapTurn` | `boolean` | Rotate in fixed steps rather than continuously. | [components/XRRig.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L93) |
+| <a id="snapturndegrees"></a> `snapTurnDegrees` | `number` | Degrees per snap-turn step. | [components/XRRig.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L95) |
+| <a id="fallbackeyeheight"></a> `fallbackEyeHeight` | `number` | Eye height fallback for devices without a floor-relative reference space. | [components/XRRig.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L97) |
+| <a id="teleportarccolor"></a> `teleportArcColor` | `string` | Teleport arc colour when it lands somewhere valid. | [components/XRRig.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L99) |
+| <a id="teleportarcinvalidcolor"></a> `teleportArcInvalidColor` | `string` | Teleport arc colour when it lands nowhere teleportable. | [components/XRRig.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L101) |
+| <a id="teleportarcthickness"></a> `teleportArcThickness` | `number` | Teleport arc thickness (diameter), metres. | [components/XRRig.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L103) |
+| <a id="passthrough"></a> `passthrough` | `boolean` | Run the session in passthrough — the real room shows through. This is the VR/MR switch for the whole project: the entry button requests `immersive-ar` instead of `immersive-vr`. Blend mode is fixed for the life of a session, so this cannot be flipped mid-session — ending and re-entering is the only way to change it. | [components/XRRig.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L113) |
+| <a id="depthocclusion"></a> `depthOcclusion` | `boolean` | Let real objects occlude virtual ones, via WebXR depth sensing. | [components/XRRig.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L115) |
+| <a id="environmentphysics"></a> `environmentPhysics` | [`XrEnvironmentPhysics`](../type-aliases/XrEnvironmentPhysics.md) | Which detected real-world geometry becomes physics colliders. | [components/XRRig.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L117) |
+| <a id="environmentdebug"></a> `environmentDebug` | `boolean` | Draw the detected room geometry on-device, for checking a scan. | [components/XRRig.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L119) |
+| <a id="hittest"></a> `hitTest` | `boolean` | Allow scripts to raycast against the real room (`hit-test`). | [components/XRRig.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L121) |
+| <a id="anchors"></a> `anchors` | `boolean` | Allow content to be pinned to real-world features (`anchors`). | [components/XRRig.ts:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L123) |

package/dist/docs/api/components/functions/createAttachPoint.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / createAttachPoint
+
+# Function: createAttachPoint()
+
+```ts
+function createAttachPoint(partial): XrAttachPoint;
+```
+
+Defined in: [components/XRInteractable.ts:206](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L206)
+
+An attach point with every field populated, for the editor and AI tools.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `partial` | `Partial`\<[`XrAttachPoint`](../type-aliases/XrAttachPoint.md)\> & \{ `id`: `string`; \} |
+
+## Returns
+
+[`XrAttachPoint`](../type-aliases/XrAttachPoint.md)

package/dist/docs/api/components/functions/createHandPoseEntry.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / createHandPoseEntry
+
+# Function: createHandPoseEntry()
+
+```ts
+function createHandPoseEntry(partial): XrHandPoseEntry;
+```
+
+Defined in: [components/XRHandPose.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L70)
+
+A pose entry with every field populated, for the editor and AI tools.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `partial` | `Partial`\<[`XrHandPoseEntry`](../type-aliases/XrHandPoseEntry.md)\> & \{ `id`: `string`; \} |
+
+## Returns
+
+[`XrHandPoseEntry`](../type-aliases/XrHandPoseEntry.md)