@relu-interactives/spatial-ecs 0.11.0 → 0.11.1

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

@@ -6,7 +6,7 @@
 
 # Class: ObjectManagementSystem
 
-Defined in: [systems/ObjectManagementSystem.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L112)
+Defined in: [systems/ObjectManagementSystem.ts:147](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L147)
 
 ## Implements
 
@@ -23,7 +23,7 @@ new ObjectManagementSystem(
    isEditor?): ObjectManagementSystem;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L123)
+Defined in: [systems/ObjectManagementSystem.ts:163](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L163)
 
 #### Parameters
 
@@ -45,7 +45,7 @@ Defined in: [systems/ObjectManagementSystem.ts:123](https://github.com/Relu-Inte
 register(kind, factory): void;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:133](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L133)
+Defined in: [systems/ObjectManagementSystem.ts:173](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L173)
 
 #### Parameters
 
@@ -66,7 +66,7 @@ Defined in: [systems/ObjectManagementSystem.ts:133](https://github.com/Relu-Inte
 registerComponentFactory(kind, factory): void;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L137)
+Defined in: [systems/ObjectManagementSystem.ts:177](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L177)
 
 #### Parameters
 
@@ -87,7 +87,7 @@ Defined in: [systems/ObjectManagementSystem.ts:137](https://github.com/Relu-Inte
 getOrCreateAudioListener(): AudioListener;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L144)
+Defined in: [systems/ObjectManagementSystem.ts:184](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L184)
 
 #### Returns
 
@@ -101,7 +101,7 @@ Defined in: [systems/ObjectManagementSystem.ts:144](https://github.com/Relu-Inte
 isEditorMode(): boolean;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L156)
+Defined in: [systems/ObjectManagementSystem.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L196)
 
 #### Returns
 
@@ -115,7 +115,7 @@ Defined in: [systems/ObjectManagementSystem.ts:156](https://github.com/Relu-Inte
 getComponentFactory(kind): ComponentFactory | null;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L160)
+Defined in: [systems/ObjectManagementSystem.ts:200](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L200)
 
 #### Parameters
 
@@ -139,7 +139,7 @@ createComponentNow(
    args): unknown;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L164)
+Defined in: [systems/ObjectManagementSystem.ts:204](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L204)
 
 #### Parameters
 
@@ -165,7 +165,7 @@ requestCreate(
    onCreated?): void;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L178)
+Defined in: [systems/ObjectManagementSystem.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L218)
 
 #### Parameters
 
@@ -190,7 +190,7 @@ createNow(
    payload?): number;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L186)
+Defined in: [systems/ObjectManagementSystem.ts:226](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L226)
 
 #### Parameters
 
@@ -215,7 +215,7 @@ deleteEntity(
    dispose?): boolean;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:238](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L238)
+Defined in: [systems/ObjectManagementSystem.ts:278](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L278)
 
 Removes an entity from the ECS world and its associated `Object3D` from the
 THREE.js scene graph.
@@ -257,7 +257,7 @@ setParent(
    options?): boolean;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:272](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L272)
+Defined in: [systems/ObjectManagementSystem.ts:312](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L312)
 
 #### Parameters
 
@@ -281,7 +281,7 @@ Defined in: [systems/ObjectManagementSystem.ts:272](https://github.com/Relu-Inte
 reconcileSceneFromWorld(world): void;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L362)
+Defined in: [systems/ObjectManagementSystem.ts:406](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L406)
 
 #### Parameters
 
@@ -295,13 +295,268 @@ Defined in: [systems/ObjectManagementSystem.ts:362](https://github.com/Relu-Inte
 
 ***
 
+### hasBoneHold()
+
+```ts
+hasBoneHold(entityId): boolean;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:551](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L551)
+
+Whether [applyBoneHold](#applybonehold) is managing this attachment.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### applyBoneHold()
+
+```ts
+applyBoneHold(
+   world, 
+   entityId, 
+   hold, 
+   hidden): void;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:560](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L560)
+
+Put an attachment in a hold for the clip now playing (`hold` null: the
+attachment's own bone and Transform), moving it to the hold's bone if that
+changed. Called each frame, since a socket can be rebuilt under it.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+| `hold` | [`BoneHold`](../../components/type-aliases/BoneHold.md) \| `null` |
+| `hidden` | `boolean` |
+
+#### Returns
+
+`void`
+
+***
+
+### releaseBoneHold()
+
+```ts
+releaseBoneHold(world, entityId): void;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:597](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L597)
+
+Stop managing an attachment that no longer has holds, and put it back.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+
+#### Returns
+
+`void`
+
+***
+
+### reloadModel()
+
+```ts
+reloadModel(world, entityId): boolean;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:606](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L606)
+
+Load a model entity's file again and swap it in (the file was rewritten);
+the entity, its components and children stay, attachments re-home.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### reloadModelsAt()
+
+```ts
+reloadModelsAt(world, matches): number;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:611](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L611)
+
+Reload every model entity whose path `matches` (returns how many).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `matches` | (`path`) => `boolean` |
+
+#### Returns
+
+`number`
+
+***
+
+### listModelBones()
+
+```ts
+listModelBones(world, entityId): ModelBoneInfo[];
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:621](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L621)
+
+The bones of an entity's loaded model (empty until it loads, or for a model without a skeleton).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+
+#### Returns
+
+[`ModelBoneInfo`](../type-aliases/ModelBoneInfo.md)[]
+
+***
+
+### getBoneSocket()
+
+```ts
+getBoneSocket(entityId): Object3D<Object3DEventMap> | null;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:627](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L627)
+
+The socket object an attached entity currently hangs under, if resolved.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`Object3D`\<`Object3DEventMap`\> \| `null`
+
+***
+
+### attachToBone()
+
+```ts
+attachToBone(
+   world, 
+   entityId, 
+   parentEntityId, 
+   ref, 
+   options?): {
+  ok: boolean;
+  resolved: boolean;
+  bone: string | null;
+};
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:639](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L639)
+
+Fix `entityId` to a bone of `parentEntityId`'s model (making it the
+parent if it isn't). With `preserveWorldTransform` (default) it stays
+where it is and its Transform becomes the offset from the bone; without,
+it snaps onto the bone (zero offset). Returns whether the bone was found
+(when the model is still loading, the attachment is stored and resolves
+once it loads, without preserving the pose).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+| `parentEntityId` | `number` |
+| `ref` | \{ `bone?`: `string`; `humanoid?`: `string` \| `null`; \} |
+| `ref.bone?` | `string` |
+| `ref.humanoid?` | `string` \| `null` |
+| `options?` | \{ `preserveWorldTransform?`: `boolean`; `compensateScale?`: `boolean`; \} |
+| `options.preserveWorldTransform?` | `boolean` |
+| `options.compensateScale?` | `boolean` |
+
+#### Returns
+
+```ts
+{
+  ok: boolean;
+  resolved: boolean;
+  bone: string | null;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `ok` | `boolean` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
+| `resolved` | `boolean` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
+| `bone` | `string` \| `null` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
+
+***
+
+### detachFromBone()
+
+```ts
+detachFromBone(
+   world, 
+   entityId, 
+   options?): boolean;
+```
+
+Defined in: [systems/ObjectManagementSystem.ts:703](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L703)
+
+Release a bone attachment. The entity stays a child of the character
+(or moves to the root with `toRoot`), and by default keeps its place in
+the world.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `entityId` | `number` |
+| `options?` | \{ `preserveWorldTransform?`: `boolean`; `toRoot?`: `boolean`; \} |
+| `options.preserveWorldTransform?` | `boolean` |
+| `options.toRoot?` | `boolean` |
+
+#### Returns
+
+`boolean`
+
+***
+
 ### update()
 
 ```ts
 update(world): void;
 ```
 
-Defined in: [systems/ObjectManagementSystem.ts:406](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L406)
+Defined in: [systems/ObjectManagementSystem.ts:734](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L734)
 
 #### Parameters
 

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

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

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

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

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

@@ -6,7 +6,7 @@
 
 # Class: PostprocessingSyncSystem
 
-Defined in: [systems/PostprocessingSyncSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L39)
+Defined in: [systems/PostprocessingSyncSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L39)
 
 Builds the post-processing chain from the scene's [Postprocessing](../../components/classes/Postprocessing.md)
 component and hands it to `RenderSystem` through `scene.userData`:
@@ -46,7 +46,7 @@ new PostprocessingSyncSystem(
    backend?): PostprocessingSyncSystem;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L54)
+Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L54)
 
 #### Parameters
 
@@ -69,7 +69,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Int
 update(world): void;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L156)
+Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L156)
 
 #### Parameters
 
@@ -93,7 +93,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-In
 dispose(): void;
 ```
 
-Defined in: [systems/PostprocessingSyncSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L186)
+Defined in: [systems/PostprocessingSyncSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L186)
 
 #### Returns
 

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

@@ -6,7 +6,7 @@
 
 # Class: RenderSystem
 
-Defined in: [systems/RenderSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L31)
+Defined in: [systems/RenderSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L31)
 
 Draws the frame: through the post-processing chain in
 `scene.userData.ecsPostprocessingComposer` while
@@ -33,7 +33,7 @@ new RenderSystem(
    afterRender?): RenderSystem;
 ```
 
-Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L43)
+Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L43)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/re
 update(_world): void;
 ```
 
-Defined in: [systems/RenderSystem.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L119)
+Defined in: [systems/RenderSystem.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L119)
 
 #### Parameters
 

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

@@ -6,7 +6,7 @@
 
 # Class: ScriptBehaviourSystem
 
-Defined in: [systems/ScriptBehaviourSystem.ts:131](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L131)
+Defined in: [systems/ScriptBehaviourSystem.ts:131](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L131)
 
 ## Implements
 
@@ -23,7 +23,7 @@ new ScriptBehaviourSystem(
    options?): ScriptBehaviourSystem;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L151)
+Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L151)
 
 #### Parameters
 
@@ -45,7 +45,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Inter
 update(world, deltaTime): void;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L286)
+Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L286)
 
 #### Parameters
 
@@ -70,7 +70,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Inter
 dispose(world): void;
 ```
 
-Defined in: [systems/ScriptBehaviourSystem.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L512)
+Defined in: [systems/ScriptBehaviourSystem.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L512)
 
 #### Parameters
 

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

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

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

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