@relu-interactives/spatial-ecs 0.2.2

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

@@ -0,0 +1,98 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AudioSystem
+
+# Class: AudioSystem
+
+Defined in: [systems/AudioSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AudioSystem.ts#L46)
+
+Reconciles `AudioComponent` state with the underlying THREE.js audio objects
+each frame.
+
+**Playback** — drives `play()`, `pause()`, and `stop()` on the THREE.js
+audio node based on the `isPlaying` / `isPaused` flags set by
+`AudioComponent.play()`, `.pause()`, and `.stop()`.
+
+**Option sync** — detects changes to `loop`, `pitch`, `volume`,
+`refDistance`, `distanceModel`, and `rolloffFactor` and applies them live.
+Changes take effect on the next frame, so scripts and inspector edits during
+runtime are reflected without reloading the scene.
+
+Only active in **preview** mode (`isEditor: true` makes every update a
+no-op so the editor is unaffected).
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new AudioSystem(__namedParameters?): AudioSystem;
+```
+
+Defined in: [systems/AudioSystem.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AudioSystem.ts#L53)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | \{ `isEditor?`: `boolean`; \} |
+| `__namedParameters.isEditor?` | `boolean` |
+
+#### Returns
+
+`AudioSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, _deltaTime): void;
+```
+
+Defined in: [systems/AudioSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AudioSystem.ts#L57)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `_deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(_world): void;
+```
+
+Defined in: [systems/AudioSystem.ts:157](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AudioSystem.ts#L157)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,49 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / CameraSyncSystem
+
+# Class: CameraSyncSystem
+
+Defined in: [systems/CameraSyncSystem.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/CameraSyncSystem.ts#L115)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new CameraSyncSystem(): CameraSyncSystem;
+```
+
+#### Returns
+
+`CameraSyncSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/CameraSyncSystem.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/CameraSyncSystem.ts#L118)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)

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

@@ -0,0 +1,75 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EnvironmentSyncSystem
+
+# Class: EnvironmentSyncSystem
+
+Defined in: [systems/EnvironmentSyncSystem.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/EnvironmentSyncSystem.ts#L67)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EnvironmentSyncSystem(scene): EnvironmentSyncSystem;
+```
+
+Defined in: [systems/EnvironmentSyncSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/EnvironmentSyncSystem.ts#L74)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `scene` | `Scene` |
+
+#### Returns
+
+`EnvironmentSyncSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/EnvironmentSyncSystem.ts:174](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/EnvironmentSyncSystem.ts#L174)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/EnvironmentSyncSystem.ts:203](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/EnvironmentSyncSystem.ts#L203)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,449 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / InputSystem
+
+# Class: InputSystem
+
+Defined in: [systems/InputSystem.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L32)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new InputSystem(): InputSystem;
+```
+
+Defined in: [systems/InputSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L186)
+
+#### Returns
+
+`InputSystem`
+
+## Methods
+
+### setPointerLockElement()
+
+```ts
+setPointerLockElement(element): void;
+```
+
+Defined in: [systems/InputSystem.ts:202](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L202)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `element` | `HTMLElement` \| `null` |
+
+#### Returns
+
+`void`
+
+***
+
+### lockMousePointer()
+
+```ts
+lockMousePointer(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:206](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L206)
+
+#### Returns
+
+`boolean`
+
+***
+
+### unlockMousePointer()
+
+```ts
+unlockMousePointer(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:233](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L233)
+
+#### Returns
+
+`boolean`
+
+***
+
+### isMousePointerLocked()
+
+```ts
+isMousePointerLocked(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:249](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L249)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getKey()
+
+```ts
+getKey(key): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:266](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L266)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getKeyDown()
+
+```ts
+getKeyDown(key): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:270](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L270)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getKeyUp()
+
+```ts
+getKeyUp(key): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:274](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L274)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### consumePressed()
+
+```ts
+consumePressed(key): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:278](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L278)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouse()
+
+```ts
+getMouse(button): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:288](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L288)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouseDown()
+
+```ts
+getMouseDown(button): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:297](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L297)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouseUp()
+
+```ts
+getMouseUp(button): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:306](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L306)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClick()
+
+```ts
+getScrollClick(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:315](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L315)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClickDown()
+
+```ts
+getScrollClickDown(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:319](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L319)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClickUp()
+
+```ts
+getScrollClickUp(): boolean;
+```
+
+Defined in: [systems/InputSystem.ts:323](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L323)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollDelta()
+
+```ts
+getScrollDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [systems/InputSystem.ts:327](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L327)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [systems/InputSystem.ts:327](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L327) |
+| `y` | `number` | [systems/InputSystem.ts:327](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L327) |
+
+***
+
+### consumeScrollDelta()
+
+```ts
+consumeScrollDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [systems/InputSystem.ts:334](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L334)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [systems/InputSystem.ts:334](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L334) |
+| `y` | `number` | [systems/InputSystem.ts:334](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L334) |
+
+***
+
+### getMousePosition()
+
+```ts
+getMousePosition(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [systems/InputSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L341)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [systems/InputSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L341) |
+| `y` | `number` | [systems/InputSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L341) |
+
+***
+
+### getMouseDelta()
+
+```ts
+getMouseDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [systems/InputSystem.ts:348](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L348)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [systems/InputSystem.ts:348](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L348) |
+| `y` | `number` | [systems/InputSystem.ts:348](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L348) |
+
+***
+
+### consumeMouseDelta()
+
+```ts
+consumeMouseDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [systems/InputSystem.ts:355](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L355)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [systems/InputSystem.ts:355](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L355) |
+| `y` | `number` | [systems/InputSystem.ts:355](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L355) |
+
+***
+
+### update()
+
+```ts
+update(_world, _deltaTime): void;
+```
+
+Defined in: [systems/InputSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L362)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_world` | [`World`](World.md) |
+| `_deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/InputSystem.ts:398](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L398)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,49 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / LightSyncSystem
+
+# Class: LightSyncSystem
+
+Defined in: [systems/LightSyncSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/LightSyncSystem.ts#L69)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new LightSyncSystem(): LightSyncSystem;
+```
+
+#### Returns
+
+`LightSyncSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/LightSyncSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/LightSyncSystem.ts#L72)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)