@relu-interactives/spatial-ecs 0.2.2

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

@@ -0,0 +1,82 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / PhysicsComponent
+
+# Class: PhysicsComponent
+
+Defined in: [components/Physics.ts:350](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L350)
+
+Unified physics component combining a Rapier rigid body and a Rapier
+collider into a single authoring and runtime container.
+
+Use `values.rigidbody` to configure body type, mass, damping, locks, etc.
+Use `values.collider` to configure collider shape, size, offset, material
+properties, and sensor mode.
+
+The runtime `rigidBody` and `collider` references are created by the physics
+system when the project loads and are `null` until physics is initialized.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new PhysicsComponent(values?): PhysicsComponent;
+```
+
+Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L358)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `values?` | \{ `rigidbody?`: `Partial`\<[`RigidbodyState`](../type-aliases/RigidbodyState.md)\>; `collider?`: `Partial`\<[`ColliderState`](../type-aliases/ColliderState.md)\>; \} |
+| `values.rigidbody?` | `Partial`\<[`RigidbodyState`](../type-aliases/RigidbodyState.md)\> |
+| `values.collider?` | `Partial`\<[`ColliderState`](../type-aliases/ColliderState.md)\> |
+
+#### Returns
+
+`PhysicsComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L352) |
+| <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. | [components/Physics.ts:354](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L354) |
+| <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. | [components/Physics.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L356) |
+
+## Methods
+
+### setValues()
+
+```ts
+setValues(patch): void;
+```
+
+Defined in: [components/Physics.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L369)
+
+Patch rigidbody and/or collider state. Each sub-object is deep-merged
+with the current values via the respective normalizer.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `patch` | \{ `rigidbody?`: `Partial`\<[`RigidbodyState`](../type-aliases/RigidbodyState.md)\>; `collider?`: `Partial`\<[`ColliderState`](../type-aliases/ColliderState.md)\>; \} |
+| `patch.rigidbody?` | `Partial`\<[`RigidbodyState`](../type-aliases/RigidbodyState.md)\> |
+| `patch.collider?` | `Partial`\<[`ColliderState`](../type-aliases/ColliderState.md)\> |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,49 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / Postprocessing
+
+# Class: Postprocessing
+
+Defined in: [components/Postprocessing.ts:427](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L427)
+
+Postprocessing stack settings (depth-of-field, bloom, vignette, chromatic
+aberration, noise, pixelation, tone mapping, hue/saturation, sepia, SMAA,
+SSAO, dot-screen, glitch). The render system applies enabled effects in a
+`postprocessing`-library composer when `postEnabled` is `true`. Singleton-
+style — attached to one entity per scene.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new Postprocessing(values?): Postprocessing;
+```
+
+Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L431)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `values?` | `Partial`\<[`PostprocessingState`](../type-aliases/PostprocessingState.md)\> |
+
+#### Returns
+
+`Postprocessing`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:429](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L429) |

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

@@ -0,0 +1,54 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ScriptComponent
+
+# Class: ScriptComponent
+
+Defined in: [components/ScriptComponent.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L42)
+
+Component holding the list of [scripts](../type-aliases/ScriptEntry.md) attached to an
+entity. Loaded from the saved project; the runtime-side fields
+(`scriptInstance`, `scriptInstances`) are non-enumerable so they never leak
+into save data or undo history.
+
+## Remarks
+
+Authored scripts subclass [Behaviour](../../Behaviour/index.md).
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new ScriptComponent(entries?): ScriptComponent;
+```
+
+Defined in: [components/ScriptComponent.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L50)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | `[]` |
+
+#### Returns
+
+`ScriptComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L44) |
+| <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L46) |
+| <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L48) |

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

@@ -0,0 +1,46 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / Selectable
+
+# Class: Selectable
+
+Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new Selectable(enabled?): Selectable;
+```
+
+Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Selectable.ts#L13)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `enabled` | `boolean` | `true` |
+
+#### Returns
+
+`Selectable`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| 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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Selectable.ts#L11) |

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

@@ -0,0 +1,54 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / SelectionTransformState
+
+# Class: SelectionTransformState
+
+Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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
+snapshots so undo/redo restores the exact gizmo configuration.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SelectionTransformState(
+   transform?, 
+   space?, 
+   selectedEntityId?): SelectionTransformState;
+```
+
+Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/SelectionTransformState.ts#L24)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | `"translate"` |
+| `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | `"world"` |
+| `selectedEntityId` | `number` \| `null` | `null` |
+
+#### Returns
+
+`SelectionTransformState`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| 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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/SelectionTransformState.ts#L22) |

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

@@ -0,0 +1,55 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / SpriteComponent
+
+# Class: SpriteComponent
+
+Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Sprite.ts#L11)
+
+Camera-facing 2D sprite. Unlike [ImageComponent](ImageComponent.md), sprites use
+`THREE.Sprite` and always render as billboards.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SpriteComponent(
+   path, 
+   width?, 
+   height?): SpriteComponent;
+```
+
+Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Sprite.ts#L23)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `path` | `string` | `undefined` |
+| `width` | `number` | `1` |
+| `height` | `number` | `1` |
+
+#### Returns
+
+`SpriteComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| 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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Sprite.ts#L21) |

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

@@ -0,0 +1,197 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / TransformComponent
+
+# Class: TransformComponent
+
+Defined in: [components/Transform.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L50)
+
+Position, rotation, and scale of an entity in its parent's local space.
+
+## Remarks
+
+Rotation is stored in **radians** (Euler XYZ). The editor inspector converts
+to/from degrees for display — do not store degrees in this component.
+Mutations should go through the `setPosition` / `setRotation` / `setScale`
+helpers so dependent systems pick up the change.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new TransformComponent(data?): TransformComponent;
+```
+
+Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L58)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | [`TransformData`](../type-aliases/TransformData.md) |
+
+#### Returns
+
+`TransformComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| 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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L56) |
+
+## Methods
+
+### toPositionVector3()
+
+```ts
+toPositionVector3(target?): Vector3;
+```
+
+Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L84)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `target` | `Vector3` |
+
+#### Returns
+
+`Vector3`
+
+***
+
+### toRotationEuler()
+
+```ts
+toRotationEuler(target?, order?): Euler;
+```
+
+Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L88)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `target` | `Euler` | `...` |
+| `order` | `EulerOrder` | `"XYZ"` |
+
+#### Returns
+
+`Euler`
+
+***
+
+### toRotationQuaternion()
+
+```ts
+toRotationQuaternion(target?, order?): Quaternion;
+```
+
+Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L95)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `target` | `Quaternion` | `...` |
+| `order` | `EulerOrder` | `"XYZ"` |
+
+#### Returns
+
+`Quaternion`
+
+***
+
+### toScaleVector3()
+
+```ts
+toScaleVector3(target?): Vector3;
+```
+
+Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L108)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `target` | `Vector3` |
+
+#### Returns
+
+`Vector3`
+
+***
+
+### setPosition()
+
+```ts
+setPosition(input): this;
+```
+
+Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L112)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | `TransformInput` |
+
+#### Returns
+
+`this`
+
+***
+
+### setScale()
+
+```ts
+setScale(input): this;
+```
+
+Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L120)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | `TransformInput` |
+
+#### Returns
+
+`this`
+
+***
+
+### setRotation()
+
+```ts
+setRotation(input, order?): this;
+```
+
+Defined in: [components/Transform.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L128)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `input` | `TransformInput` | `undefined` |
+| `order` | `EulerOrder` | `"XYZ"` |
+
+#### Returns
+
+`this`

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

@@ -0,0 +1,123 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / VideoComponent
+
+# Class: VideoComponent
+
+Defined in: [components/Video.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L37)
+
+Plays a video file as a texture on a quad. Supports green-screen keying
+(`isGreenScreen`, `backgroundColor`, `similarity`, `smoothness`, `spill`).
+The video element, texture, and material are runtime-only and re-created
+when the project loads.
+
+## Extends
+
+- [`Component`](../../Component/classes/Component.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new VideoComponent(path, options?): VideoComponent;
+```
+
+Defined in: [components/Video.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L90)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `options` | `Partial`\<*typeof* `DEFAULT_VIDEO_OPTIONS`\> |
+
+#### Returns
+
+`VideoComponent`
+
+#### Overrides
+
+[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
+
+## Properties
+
+| 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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L60) |
+| `options.autoplay` | `boolean` | - | [components/Video.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L9) |
+| `options.loop` | `boolean` | - | [components/Video.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L10) |
+| `options.volume` | `number` | - | [components/Video.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L11) |
+| `options.width` | `number` | - | [components/Video.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L12) |
+| `options.height` | `number` | - | [components/Video.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L13) |
+| `options.isGreenScreen` | `boolean` | - | [components/Video.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L14) |
+| `options.backgroundColor` | `string` | - | [components/Video.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L15) |
+| `options.similarity` | `number` | - | [components/Video.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L16) |
+| `options.smoothness` | `number` | - | [components/Video.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L17) |
+| `options.spill` | `number` | - | [components/Video.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L88) |
+
+## Methods
+
+### play()
+
+```ts
+play(): void;
+```
+
+Defined in: [components/Video.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L127)
+
+Signals `VideoSystem` to start (or resume) playback.
+Has no direct effect in the editor — `VideoSystem` drives the actual
+HTML video element call in preview.
+
+#### Returns
+
+`void`
+
+***
+
+### pause()
+
+```ts
+pause(): void;
+```
+
+Defined in: [components/Video.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L137)
+
+Signals `VideoSystem` to pause playback, preserving the current position.
+Calling [play](#play) afterwards resumes from where it paused.
+No-op if not currently playing.
+
+#### Returns
+
+`void`
+
+***
+
+### stop()
+
+```ts
+stop(): void;
+```
+
+Defined in: [components/Video.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Video.ts#L146)
+
+Signals `VideoSystem` to stop playback and reset the playback position.
+
+#### Returns
+
+`void`