@relu-interactives/spatial-ecs 0.5.3 → 0.9.0

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

@@ -6,7 +6,7 @@
 
 # Class: ScriptObjectComponent
 
-Defined in: [components/ScriptObjectComponent.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L30)
+Defined in: [components/ScriptObjectComponent.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L30)
 
 Component for a **script object** — a single [ScriptObject](../../index/classes/ScriptObject.md) whose
 THREE.js visual is built by user code and runs in the editor AND at runtime.
@@ -26,7 +26,7 @@ undo history.
 new ScriptObjectComponent(input?): ScriptObjectComponent;
 ```
 
-Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L40)
+Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L40)
 
 #### Parameters
 
@@ -46,10 +46,10 @@ Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Int
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="scripturl"></a> `scriptUrl` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L31) |
-| <a id="classname"></a> `className` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L32) |
-| <a id="enabled"></a> `enabled` | `boolean` | - | [components/ScriptObjectComponent.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L33) |
-| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | - | [components/ScriptObjectComponent.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L34) |
-| <a id="runtimestate"></a> `runtimeState` | [`ScriptObjectRuntimeState`](../type-aliases/ScriptObjectRuntimeState.md) | - | [components/ScriptObjectComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L35) |
-| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | - | [components/ScriptObjectComponent.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L36) |
-| <a id="instance"></a> `instance` | `unknown` | Live ScriptObject instance. Non-enumerable — never enters snapshots/history. | [components/ScriptObjectComponent.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L38) |
+| <a id="scripturl"></a> `scriptUrl` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L31) |
+| <a id="classname"></a> `className` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L32) |
+| <a id="enabled"></a> `enabled` | `boolean` | - | [components/ScriptObjectComponent.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L33) |
+| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | - | [components/ScriptObjectComponent.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L34) |
+| <a id="runtimestate"></a> `runtimeState` | [`ScriptObjectRuntimeState`](../type-aliases/ScriptObjectRuntimeState.md) | - | [components/ScriptObjectComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L35) |
+| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | - | [components/ScriptObjectComponent.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L36) |
+| <a id="instance"></a> `instance` | `unknown` | Live ScriptObject instance. Non-enumerable — never enters snapshots/history. | [components/ScriptObjectComponent.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L38) |

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

@@ -6,7 +6,7 @@
 
 # Class: Selectable
 
-Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L9)
+Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Selectable.ts#L9)
 
 Toggles whether the editor selection system can pick this entity. When
 `enabled` is `false`, the entity is excluded from raycast hit tests.
@@ -23,7 +23,7 @@ Toggles whether the editor selection system can pick this entity. When
 new Selectable(enabled?): Selectable;
 ```
 
-Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L13)
+Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Selectable.ts#L13)
 
 #### Parameters
 
@@ -43,4 +43,4 @@ Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/r
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L11) |
+| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Selectable.ts#L11) |

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

@@ -6,7 +6,7 @@
 
 # Class: SelectionTransformState
 
-Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L16)
+Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L16)
 
 Singleton-style component (attached once to a system entity) that mirrors
 the editor's current transform-gizmo state into the ECS world. Persisted in
@@ -27,7 +27,7 @@ new SelectionTransformState(
    selectedEntityId?): SelectionTransformState;
 ```
 
-Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L24)
+Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L24)
 
 #### Parameters
 
@@ -49,6 +49,6 @@ Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-I
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L18) |
-| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L20) |
-| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L22) |
+| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L18) |
+| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L20) |
+| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L22) |

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

@@ -6,7 +6,7 @@
 
 # Class: SpriteComponent
 
-Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L11)
+Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L11)
 
 Camera-facing 2D sprite. Unlike [ImageComponent](ImageComponent.md), sprites use
 `THREE.Sprite` and always render as billboards.
@@ -26,7 +26,7 @@ new SpriteComponent(
    height?): SpriteComponent;
 ```
 
-Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L23)
+Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L23)
 
 #### Parameters
 
@@ -48,8 +48,8 @@ Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L13) |
-| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L15) |
-| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L17) |
-| <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L19) |
-| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L21) |
+| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L13) |
+| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L15) |
+| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L17) |
+| <a id="texture"></a> `texture` | `Texture`\<`unknown`, `TextureEventMap`\> \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L19) |
+| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Sprite.ts#L21) |

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

@@ -6,7 +6,7 @@
 
 # Class: TransformComponent
 
-Defined in: [components/Transform.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L50)
+Defined in: [components/Transform.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L50)
 
 Position, rotation, and scale of an entity in its parent's local space.
 
@@ -29,7 +29,7 @@ helpers so dependent systems pick up the change.
 new TransformComponent(data?): TransformComponent;
 ```
 
-Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L58)
+Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L58)
 
 #### Parameters
 
@@ -49,9 +49,9 @@ Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/re
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="position"></a> `position` | [`Vec3`](../type-aliases/Vec3.md) | Local position relative to the parent (or world if no parent). | [components/Transform.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L52) |
-| <a id="rotation"></a> `rotation` | [`Vec3`](../type-aliases/Vec3.md) | Local rotation as Euler XYZ in **radians**. | [components/Transform.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L54) |
-| <a id="scale"></a> `scale` | [`Vec3`](../type-aliases/Vec3.md) | Local scale factors per axis (`1` = identity). | [components/Transform.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L56) |
+| <a id="position"></a> `position` | [`Vec3`](../type-aliases/Vec3.md) | Local position relative to the parent (or world if no parent). | [components/Transform.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L52) |
+| <a id="rotation"></a> `rotation` | [`Vec3`](../type-aliases/Vec3.md) | Local rotation as Euler XYZ in **radians**. | [components/Transform.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L54) |
+| <a id="scale"></a> `scale` | [`Vec3`](../type-aliases/Vec3.md) | Local scale factors per axis (`1` = identity). | [components/Transform.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L56) |
 
 ## Methods
 
@@ -61,7 +61,7 @@ Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/re
 toPositionVector3(target?): Vector3;
 ```
 
-Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L84)
+Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L84)
 
 #### Parameters
 
@@ -81,7 +81,7 @@ Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/re
 toRotationEuler(target?, order?): Euler;
 ```
 
-Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L88)
+Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L88)
 
 #### Parameters
 
@@ -102,7 +102,7 @@ Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/re
 toRotationQuaternion(target?, order?): Quaternion;
 ```
 
-Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L95)
+Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L95)
 
 #### Parameters
 
@@ -123,7 +123,7 @@ Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/re
 toScaleVector3(target?): Vector3;
 ```
 
-Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L108)
+Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L108)
 
 #### Parameters
 
@@ -143,7 +143,7 @@ Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/r
 setPosition(input): this;
 ```
 
-Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L112)
+Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L112)
 
 #### Parameters
 
@@ -163,7 +163,7 @@ Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/r
 setScale(input): this;
 ```
 
-Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L120)
+Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L120)
 
 #### Parameters
 
@@ -183,7 +183,7 @@ Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/r
 setRotation(input, order?): this;
 ```
 
-Defined in: [components/Transform.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L128)
+Defined in: [components/Transform.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L128)
 
 #### Parameters
 

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

@@ -0,0 +1,63 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIButtonComponent
+
+# Class: UIButtonComponent
+
+Defined in: [components/UIButton.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L31)
+
+A pressable control.
+
+A press is CLICK-ON-RELEASE: it arms when the pinch/trigger/mouse goes down
+on the button and fires only if the release still points at it — sliding
+off cancels, matching platform UX. Scripts hear it via
+`Behaviour.onUiPress`, on the button's own entity first and then bubbling
+up the parent chain, carrying `actionId` (defaults to the entity's name) so
+one panel script can handle all of its buttons.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UIButtonComponent(options?): UIButtonComponent;
+```
+
+Defined in: [components/UIButton.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L49)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`UIButtonOptions`](../type-aliases/UIButtonOptions.md) |
+
+#### Returns
+
+`UIButtonComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="label"></a> `label` | `string` | - | [components/UIButton.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L32) |
+| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UIButton.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L34) |
+| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIButton.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L36) |
+| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIButton.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L38) |
+| <a id="fontsize"></a> `fontSize` | `number` | Label glyph height in metres. | [components/UIButton.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L40) |
+| <a id="fontweight"></a> `fontWeight` | `number` | - | [components/UIButton.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L41) |
+| <a id="textcolor"></a> `textColor` | `string` | - | [components/UIButton.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L42) |
+| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIButton.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L43) |
+| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | - | [components/UIButton.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L44) |
+| <a id="cornerradius"></a> `cornerRadius` | `number` | - | [components/UIButton.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L45) |
+| <a id="borderwidth"></a> `borderWidth` | `number` | - | [components/UIButton.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L46) |
+| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIButton.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L47) |

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

@@ -0,0 +1,62 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIPanelComponent
+
+# Class: UIPanelComponent
+
+Defined in: [components/UIPanel.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L33)
+
+A flat UI surface in the world — the backdrop menus and HUDs are built on.
+
+Size is authored in METRES on the component, never via transform scale:
+the canvas texture is rasterised for the authored size, so scaling the
+entity would stretch texels into blur. Child widgets (text, buttons,
+toggles, sliders) are ordinary entities parented under the panel and placed
+with their transforms.
+
+`follow: "billboard"` yaw-faces the camera each frame; for a wrist menu,
+parent the panel under an XR Interactor's Left/Right slot entity instead.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UIPanelComponent(options?): UIPanelComponent;
+```
+
+Defined in: [components/UIPanel.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L50)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`UIPanelOptions`](../type-aliases/UIPanelOptions.md) |
+
+#### Returns
+
+`UIPanelComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIPanel.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L35) |
+| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIPanel.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L37) |
+| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIPanel.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L38) |
+| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | 0–1. Panels are usually slightly translucent in XR. | [components/UIPanel.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L40) |
+| <a id="cornerradius"></a> `cornerRadius` | `number` | Corner radius in metres. | [components/UIPanel.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L42) |
+| <a id="borderwidth"></a> `borderWidth` | `number` | Border thickness in metres; 0 disables the border. | [components/UIPanel.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L44) |
+| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIPanel.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L45) |
+| <a id="pixeldensity"></a> `pixelDensity` | `number` | Texture density in px/metre, clamped 256–2048 at render time. | [components/UIPanel.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L47) |
+| <a id="follow"></a> `follow` | [`UiFollowMode`](../type-aliases/UiFollowMode.md) | - | [components/UIPanel.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L48) |

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

@@ -0,0 +1,59 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UISliderComponent
+
+# Class: UISliderComponent
+
+Defined in: [components/UISlider.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L27)
+
+A draggable value control.
+
+Press and drag along the track: the value is the clamped projection of the
+pointer onto the track's local X. The fill and knob are separate quads
+positioned from `value`, so dragging repositions geometry and never
+redraws the canvas. Scripts hear changes via `Behaviour.onUiChange`
+(throttled to real value changes, plus a final dispatch on release).
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UISliderComponent(options?): UISliderComponent;
+```
+
+Defined in: [components/UISlider.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L43)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`UISliderOptions`](../type-aliases/UISliderOptions.md) |
+
+#### Returns
+
+`UISliderComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="value"></a> `value` | `number` | Current value, clamped to [min, max]. | [components/UISlider.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L29) |
+| <a id="min"></a> `min` | `number` | - | [components/UISlider.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L30) |
+| <a id="max"></a> `max` | `number` | - | [components/UISlider.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L31) |
+| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UISlider.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L33) |
+| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UISlider.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L35) |
+| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UISlider.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L37) |
+| <a id="trackcolor"></a> `trackColor` | `string` | - | [components/UISlider.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L38) |
+| <a id="accentcolor"></a> `accentColor` | `string` | Fill colour between min and the current value. | [components/UISlider.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L40) |
+| <a id="knobcolor"></a> `knobColor` | `string` | - | [components/UISlider.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L41) |

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

@@ -0,0 +1,59 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UITextComponent
+
+# Class: UITextComponent
+
+Defined in: [components/UIText.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L30)
+
+A block of text drawn onto a transparent canvas quad.
+
+Pure text — put a [UIPanelComponent](UIPanelComponent.md) entity behind it for a card
+look. `fontSize` is in METRES (how tall the glyphs stand in the world), so
+text reads the same regardless of texture density. Wrapping is automatic
+inside `width`; overflow past `height` is line-clamped with an ellipsis.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UITextComponent(options?): UITextComponent;
+```
+
+Defined in: [components/UIText.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L48)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`UITextOptions`](../type-aliases/UITextOptions.md) |
+
+#### Returns
+
+`UITextComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="text"></a> `text` | `string` | - | [components/UIText.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L31) |
+| <a id="width"></a> `width` | `number` | Layout box width in metres — wrap happens against this. | [components/UIText.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L33) |
+| <a id="height"></a> `height` | `number` | Layout box height in metres — overflow clamps to it. | [components/UIText.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L35) |
+| <a id="fontsize"></a> `fontSize` | `number` | Glyph height in metres. | [components/UIText.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L37) |
+| <a id="fontweight"></a> `fontWeight` | `number` | CSS font weight (400 normal, 600 semibold…). | [components/UIText.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L39) |
+| <a id="color"></a> `color` | `string` | - | [components/UIText.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L40) |
+| <a id="align"></a> `align` | [`UiTextAlign`](../type-aliases/UiTextAlign.md) | - | [components/UIText.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L41) |
+| <a id="valign"></a> `valign` | [`UiTextVAlign`](../type-aliases/UiTextVAlign.md) | - | [components/UIText.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L42) |
+| <a id="lineheight"></a> `lineHeight` | `number` | Unitless multiplier over fontSize. | [components/UIText.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L44) |
+| <a id="padding"></a> `padding` | `number` | Inner padding in metres. | [components/UIText.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L46) |

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

@@ -0,0 +1,56 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIToggleComponent
+
+# Class: UIToggleComponent
+
+Defined in: [components/UIToggle.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L24)
+
+An on/off switch.
+
+The knob is a separate quad positioned from `value` — flipping animates
+geometry, never redrawing the canvas. Scripts hear changes via
+`Behaviour.onUiToggle` (bubbling like button presses); `value` is authored
+state and persists with the scene.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UIToggleComponent(options?): UIToggleComponent;
+```
+
+Defined in: [components/UIToggle.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L38)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`UIToggleOptions`](../type-aliases/UIToggleOptions.md) |
+
+#### Returns
+
+`UIToggleComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="value"></a> `value` | `boolean` | - | [components/UIToggle.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L25) |
+| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UIToggle.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L27) |
+| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIToggle.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L29) |
+| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIToggle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L31) |
+| <a id="trackcolor"></a> `trackColor` | `string` | Track colour while OFF. | [components/UIToggle.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L33) |
+| <a id="accentcolor"></a> `accentColor` | `string` | Track colour while ON. | [components/UIToggle.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L35) |
+| <a id="knobcolor"></a> `knobColor` | `string` | - | [components/UIToggle.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L36) |

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

@@ -0,0 +1,53 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / VRTeleportAreaComponent
+
+# Class: VRTeleportAreaComponent
+
+Defined in: [components/VRTeleportArea.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L28)
+
+Marks an entity's surface as a valid teleport destination.
+
+Teleport is an allow-list, not a physics query: only entities carrying an
+enabled area can be teleported onto. That keeps destinations deliberate —
+authors decide where the player may stand rather than discovering that every
+collider in the scene is walkable.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new VRTeleportAreaComponent(options?): VRTeleportAreaComponent;
+```
+
+Defined in: [components/VRTeleportArea.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L38)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`VRTeleportAreaOptions`](../type-aliases/VRTeleportAreaOptions.md) |
+
+#### Returns
+
+`VRTeleportAreaComponent`
+
+#### 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 this area currently accepts teleports. | [components/VRTeleportArea.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L30) |
+| <a id="shape"></a> `shape` | [`VrTeleportShape`](../type-aliases/VrTeleportShape.md) | Footprint shape. | [components/VRTeleportArea.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L32) |
+| <a id="width"></a> `width` | `number` | Full width in metres (diameter for `circle`). | [components/VRTeleportArea.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L34) |
+| <a id="depth"></a> `depth` | `number` | Full depth in metres (unused for `circle`). | [components/VRTeleportArea.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L36) |