@relu-interactives/spatial-ecs 0.10.0 → 0.11.1

package/dist/docs/api/index/functions/sampleTeleportArc.md

@@ -14,7 +14,7 @@ function sampleTeleportArc(
    options?): Vector3[];
 ```
 
-Defined in: [xr/teleportArc.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportArc.ts#L31)
+Defined in: [xr/teleportArc.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportArc.ts#L31)
 
 Sample a ballistic curve starting at `origin` heading along `direction`.
 

package/dist/docs/api/index/functions/serializeEntitySubtree.md

@@ -13,7 +13,7 @@ function serializeEntitySubtree(
    options?): SerializeEntitySubtreeResult;
 ```
 
-Defined in: [prefab/serializeEntitySubtree.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/serializeEntitySubtree.ts#L42)
+Defined in: [prefab/serializeEntitySubtree.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/serializeEntitySubtree.ts#L42)
 
 Serialize `rootId` + all descendants into a self-contained snapshot:
 entity ids renumbered 1..N in BFS parent-first order, all internal id

package/dist/docs/api/index/functions/setDracoDecoderPath.md

@@ -10,7 +10,7 @@
 function setDracoDecoderPath(path): void;
 ```
 
-Defined in: [utils/dracoDecoderPath.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/utils/dracoDecoderPath.ts#L15)
+Defined in: [utils/dracoDecoderPath.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/utils/dracoDecoderPath.ts#L15)
 
 Override where the DRACO decoder files (draco_wasm_wrapper.js,
 draco_decoder.wasm, draco_decoder.js) are fetched from. Embedding apps

package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md

@@ -10,7 +10,7 @@
 function setPrefabAssetUrlResolver(resolver): void;
 ```
 
-Defined in: [prefab/spawnPrefab.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/spawnPrefab.ts#L21)
+Defined in: [prefab/spawnPrefab.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L21)
 
 Override how prefab asset URLs (the file URL itself AND every asset URL
 stored inside prefab files) are resolved before fetching. Published/preview

package/dist/docs/api/index/functions/setWorldQuaternion.md

@@ -0,0 +1,26 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / setWorldQuaternion
+
+# Function: setWorldQuaternion()
+
+```ts
+function setWorldQuaternion(o, q): void;
+```
+
+Defined in: [animation/ik.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/ik.ts#L19)
+
+Sets a node's world rotation, keeping its position (children follow).
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `o` | `Object3D` |
+| `q` | `Quaternion` |
+
+## Returns
+
+`void`

package/dist/docs/api/index/functions/soundBankFiles.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / soundBankFiles
+
+# Function: soundBankFiles()
+
+```ts
+function soundBankFiles(bank): string[];
+```
+
+Defined in: [audio/soundBank.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L38)
+
+Every recording a bank needs.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `bank` | [`SoundBankAsset`](../interfaces/SoundBankAsset.md) |
+
+## Returns
+
+`string`[]

package/dist/docs/api/index/functions/spawnPrefab.md

@@ -13,7 +13,7 @@ function spawnPrefab(
 options?): Promise<number>;
 ```
 
-Defined in: [prefab/spawnPrefab.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/spawnPrefab.ts#L144)
+Defined in: [prefab/spawnPrefab.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L146)
 
 Instantiate a prefab into a live world at runtime.
 

package/dist/docs/api/index/functions/twoBoneIK.md

@@ -0,0 +1,41 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / twoBoneIK
+
+# Function: twoBoneIK()
+
+```ts
+function twoBoneIK(
+   upper, 
+   lower, 
+   end, 
+   target, 
+   pole, 
+   forward?): number;
+```
+
+Defined in: [animation/ik.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/ik.ts#L43)
+
+Two-bone IK: rotates `upper` and `lower` so `end`'s origin (the wrist or
+ankle) reaches `target`, bending toward `pole` (pass the animated
+elbow/knee position to keep the animation's style). Unreachable targets are
+reached for as far as the limb allows. Returns how far the end stayed from
+the target (0 when reachable). `forward` is the way the character faces, for
+a limb too straight to say which way it bends.
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `upper` | `Object3D` | `undefined` |
+| `lower` | `Object3D` | `undefined` |
+| `end` | `Object3D` | `undefined` |
+| `target` | `Vector3` | `undefined` |
+| `pole` | `Vector3` | `undefined` |
+| `forward` | `Vector3` | `FORWARD` |
+
+## Returns
+
+`number`

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

@@ -15,6 +15,8 @@
 | [AnimationStateMachine](classes/AnimationStateMachine.md) | - |
 | [AnimationStateManager](classes/AnimationStateManager.md) | - |
 | [World](classes/World.md) | - |
+| [AudioMixer](classes/AudioMixer.md) | The volume groups every sound plays through: each sound's output goes to its bus instead of straight to the listener, so a game can turn music down without touching a single sound, and music dips while a voice plays. |
+| [SlotChooser](classes/SlotChooser.md) | Decides whether a slot sounds and which take: chance, cooldown, and never the same take twice running when there's another. No audio here, so it's testable. |
 | [AnimationSystem](classes/AnimationSystem.md) | - |
 | [CameraSyncSystem](classes/CameraSyncSystem.md) | - |
 | [InputSystem](classes/InputSystem.md) | - |
@@ -56,7 +58,9 @@
 | Class | Description |
 | ------ | ------ |
 | [AudioSystem](classes/AudioSystem.md) | Reconciles `AudioComponent` state with the underlying THREE.js audio objects each frame. |
+| [BoneHoldSystem](classes/BoneHoldSystem.md) | Applies each [BoneAttachmentComponent](../components/classes/BoneAttachmentComponent.md)'s `holds` for the clip its character is playing: which bone it rides, where, and whether it shows. Runs after the animation and before IK, so a hand can reach for something that just moved to a new hold. |
 | [EnvironmentSyncSystem](classes/EnvironmentSyncSystem.md) | Applies the scene's [Environment](../components/classes/Environment.md) component to the three.js scene: skybox, fog, and (when `values.lighting` is present) image-based lighting, tone mapping and exposure. |
+| [IKSystem](classes/IKSystem.md) | Runs each [IKComponent](../components/classes/IKComponent.md)'s chains after the animation: hands and feet reach their target entities. Bones the animation doesn't drive would keep last frame's IK pose and drift, so every bone IK touched is put back to its pre-IK rotation first unless the animation already overwrote it. A chain with `clips` fades with the clip that's playing. |
 | [PostprocessingSyncSystem](classes/PostprocessingSyncSystem.md) | Builds the post-processing chain from the scene's [Postprocessing](../components/classes/Postprocessing.md) component and hands it to `RenderSystem` through `scene.userData`: |
 | [RenderSystem](classes/RenderSystem.md) | Draws the frame: through the post-processing chain in `scene.userData.ecsPostprocessingComposer` while `scene.userData.ecsPostprocessingComposerActive` is `true`, otherwise with `renderer.render(scene, camera)`. Runs last in the default system list. |
 | [ScriptObjectSystem](classes/ScriptObjectSystem.md) | Builds, ticks, and disposes [ScriptObject](classes/ScriptObject.md) scripts. Unlike `ScriptBehaviourSystem`, this runs in the editor AND at runtime — there is NO `isEditorMode` gating anywhere here. A script's `build()` output is attached under the entity's `Object3DRef.object` (so it inherits transform, selection and visibility). `runtimeState` is written on transitions only (never every frame). |
@@ -68,6 +72,10 @@
 | ------ | ------ |
 | [StateMachine](interfaces/StateMachine.md) | - |
 | [EcsSystem](interfaces/EcsSystem.md) | - |
+| [SoundTake](interfaces/SoundTake.md) | One recording of a slot. `file` is an asset path; `volume` multiplies the slot's. |
+| [SoundSlot](interfaces/SoundSlot.md) | A named sound the game asks for ("hit", "footstep"), played as a random take. |
+| [SoundBankAsset](interfaces/SoundBankAsset.md) | The contents of a `.soundbank.json` asset. |
+| [NetworkHandle](interfaces/NetworkHandle.md) | A Behaviour's view of the shared world: `this.network`, `null` in a single-player run. |
 | [PostprocessingPipeline](interfaces/PostprocessingPipeline.md) | A built post-processing chain. `RenderSystem` calls `render()` in place of `renderer.render()` while it is active. |
 | [PostprocessingBuildContext](interfaces/PostprocessingBuildContext.md) | Everything a backend needs to build a post-processing chain. |
 | [ChromaKeyOptions](interfaces/ChromaKeyOptions.md) | Green-screen settings, in the same units as `VideoComponent.options`. |
@@ -78,11 +86,14 @@
 | Type Alias | Description |
 | ------ | ------ |
 | [AnimationStateCallbacks](type-aliases/AnimationStateCallbacks.md) | - |
+| [ModelBoneInfo](type-aliases/ModelBoneInfo.md) | A bone of a loaded model, for bone pickers and attachment. |
+| [AudioBus](type-aliases/AudioBus.md) | The mixer's groups. Music dips while a voice plays. |
 | [ComponentValueMaps](type-aliases/ComponentValueMaps.md) | - |
 | [EcsWorldComponentSnapshot](type-aliases/EcsWorldComponentSnapshot.md) | - |
 | [EcsWorldStateSnapshotLike](type-aliases/EcsWorldStateSnapshotLike.md) | - |
 | [HydrateWorldFromSnapshotResult](type-aliases/HydrateWorldFromSnapshotResult.md) | - |
 | [HydrateOptions](type-aliases/HydrateOptions.md) | Optional behavior tweaks for [hydrateWorldFromSnapshotDetailed](functions/hydrateWorldFromSnapshotDetailed.md). Defaults preserve the historical full-world-load behavior; prefab/subtree instantiation passes stricter options. |
+| [NetSpawnOptions](type-aliases/NetSpawnOptions.md) | Options for [NetworkHandle.spawn](interfaces/NetworkHandle.md#spawn). |
 | [ApplyPrefabToSnapshotResult](type-aliases/ApplyPrefabToSnapshotResult.md) | - |
 | [InstantiateSubtreeResult](type-aliases/InstantiateSubtreeResult.md) | - |
 | [NodeKeyMaps](type-aliases/NodeKeyMaps.md) | - |
@@ -102,6 +113,7 @@
 | [ScriptErrorEvent](type-aliases/ScriptErrorEvent.md) | Emitted by `world.onScriptError(...)` the first time a distinct script error occurs. "Distinct" is the combination of script URL, class name, phase and message: ten enemies running the same broken script report once. |
 | [ScriptErrorListener](type-aliases/ScriptErrorListener.md) | Listener registered with `world.onScriptError(...)`. |
 | [ScriptErrorReport](type-aliases/ScriptErrorReport.md) | What a system knows when it reports a script error. |
+| [PlaySlotOptions](type-aliases/PlaySlotOptions.md) | Options for [AudioSystem.playSlot](classes/AudioSystem.md#playslot). |
 | [MouseButton](type-aliases/MouseButton.md) | - |
 | [EcsComponentFactoryKind](type-aliases/EcsComponentFactoryKind.md) | - |
 | [ComponentFactory](type-aliases/ComponentFactory.md) | - |
@@ -112,6 +124,12 @@
 | [XrHitResult](type-aliases/XrHitResult.md) | Where a ray met the real world. |
 | [KeyboardKey](type-aliases/KeyboardKey.md) | - |
 | [ModuleLoader](type-aliases/ModuleLoader.md) | Resolves a script URL to its ES module namespace. |
+| [UiColorStop](type-aliases/UiColorStop.md) | The style model for spatial UI. |
+| [UiPaint](type-aliases/UiPaint.md) | - |
+| [UiShadow](type-aliases/UiShadow.md) | - |
+| [UiTextStyle](type-aliases/UiTextStyle.md) | - |
+| [UiStyle](type-aliases/UiStyle.md) | - |
+| [UiTokens](type-aliases/UiTokens.md) | - |
 | [XrHandJointName](type-aliases/XrHandJointName.md) | The 25 joints of the WebXR hand skeleton. |
 | [XrFinger](type-aliases/XrFinger.md) | - |
 | [XrHandJoints](type-aliases/XrHandJoints.md) | Joint positions, in world space. |
@@ -177,11 +195,19 @@
 
 | Function | Description |
 | ------ | ------ |
+| [listModelBones](functions/listModelBones.md) | Every bone of a loaded model, parents before children. |
+| [findModelBone](functions/findModelBone.md) | The bone an attachment names in `root`: by node name, then by its sanitized form (a name saved from a source file), then by humanoid name (the same body part on another rig). `null` when none matches. |
+| [setWorldQuaternion](functions/setWorldQuaternion.md) | Sets a node's world rotation, keeping its position (children follow). |
+| [twoBoneIK](functions/twoBoneIK.md) | Two-bone IK: rotates `upper` and `lower` so `end`'s origin (the wrist or ankle) reaches `target`, bending toward `pole` (pass the animated elbow/knee position to keep the animation's style). Unreachable targets are reached for as far as the limb allows. Returns how far the end stayed from the target (0 when reachable). `forward` is the way the character faces, for a limb too straight to say which way it bends. |
+| [gripQuaternion](functions/gripQuaternion.md) | World rotation for a hand gripping a bar along `axis` (unit), for hands whose bones run +X across the knuckles, +Y along the fingers and +Z out of the palm (the editor's fixed rigs). The back of the hand faces `back` (projected off the axis); the fingers continue away from the elbow (`forearm` = elbow → wrist). |
+| [soundBankFiles](functions/soundBankFiles.md) | Every recording a bank needs. |
 | [createAnimationComponent](functions/createAnimationComponent.md) | - |
 | [createAudioComponent](functions/createAudioComponent.md) | - |
+| [createBoneAttachmentComponent](functions/createBoneAttachmentComponent.md) | - |
 | [createCameraComponent](functions/createCameraComponent.md) | - |
 | [createEntityTypeComponent](functions/createEntityTypeComponent.md) | - |
 | [createEnvironmentComponent](functions/createEnvironmentComponent.md) | - |
+| [createIKComponent](functions/createIKComponent.md) | - |
 | [createImageComponent](functions/createImageComponent.md) | - |
 | [createImageTargetAnchorComponent](functions/createImageTargetAnchorComponent.md) | - |
 | [createImageTargetComponent](functions/createImageTargetComponent.md) | - |
@@ -193,6 +219,10 @@
 | [createMeshGeometryComponent](functions/createMeshGeometryComponent.md) | - |
 | [createModelComponent](functions/createModelComponent.md) | - |
 | [createNameComponent](functions/createNameComponent.md) | - |
+| [createNetworkIdentityComponent](functions/createNetworkIdentityComponent.md) | - |
+| [createNetworkTransformComponent](functions/createNetworkTransformComponent.md) | - |
+| [createNetworkedPropsComponent](functions/createNetworkedPropsComponent.md) | - |
+| [createNetworkSpawnerComponent](functions/createNetworkSpawnerComponent.md) | - |
 | [createObject3DRefComponent](functions/createObject3DRefComponent.md) | - |
 | [createParentIdComponent](functions/createParentIdComponent.md) | - |
 | [createPhysicsComponent](functions/createPhysicsComponent.md) | - |
@@ -252,6 +282,7 @@
 | [parsePrefabAsset](functions/parsePrefabAsset.md) | Validate untrusted JSON into a `PrefabAsset`, or null when malformed. |
 | [setDracoDecoderPath](functions/setDracoDecoderPath.md) | Override where the DRACO decoder files (draco_wasm_wrapper.js, draco_decoder.wasm, draco_decoder.js) are fetched from. Embedding apps whose bundlers relocate this package's chunks — making the default import.meta.url resolution point at a location that is never populated — should call this before any model loads. The path must end with "/". Pass null to restore the default resolution. |
 | [resolveDracoDecoderPath](functions/resolveDracoDecoderPath.md) | - |
+| [createGLTFLoader](functions/createGLTFLoader.md) | The one GLTFLoader setup for every model and clip the engine loads. |
 | [loadSharedGltf](functions/loadSharedGltf.md) | Load a GLTF once per URL and share the parsed result, so repeated spawns of the same model skip both the fetch and the parse. The cached scene must never be mounted directly (an Object3D has a single parent) — mount a cloneModelScene() of it. Failed loads are evicted so a retry re-fetches. |
 | [clearModelCache](functions/clearModelCache.md) | Forget cached models (one URL, or everything). Subsequent loads fetch and parse anew. Does not dispose GPU resources — live clones may still use them. |
 | [computeFingerCurl](functions/computeFingerCurl.md) | Curl for one finger, or null when the finger isn't tracked well enough. |

package/dist/docs/api/index/interfaces/ChromaKeyOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ChromaKeyOptions
 
-Defined in: render/RenderBackend.ts:44
+Defined in: [render/RenderBackend.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L44)
 
 Green-screen settings, in the same units as `VideoComponent.options`.
 
@@ -14,7 +14,7 @@ Green-screen settings, in the same units as `VideoComponent.options`.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="keycolor"></a> `keyColor` | `ColorRepresentation` | Colour to key out (any three.js colour representation, e.g. `"#00ff00"`). | render/RenderBackend.ts:46 |
-| <a id="similarity"></a> `similarity` | `number` | Colour distance below which a pixel is fully transparent. | render/RenderBackend.ts:48 |
-| <a id="smoothness"></a> `smoothness` | `number` | Width of the soft edge above `similarity`. | render/RenderBackend.ts:50 |
-| <a id="spill"></a> `spill` | `number` | How far past the edge the key colour is desaturated (spill removal). | render/RenderBackend.ts:52 |
+| <a id="keycolor"></a> `keyColor` | `ColorRepresentation` | Colour to key out (any three.js colour representation, e.g. `"#00ff00"`). | [render/RenderBackend.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L46) |
+| <a id="similarity"></a> `similarity` | `number` | Colour distance below which a pixel is fully transparent. | [render/RenderBackend.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L48) |
+| <a id="smoothness"></a> `smoothness` | `number` | Width of the soft edge above `similarity`. | [render/RenderBackend.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L50) |
+| <a id="spill"></a> `spill` | `number` | How far past the edge the key colour is desaturated (spill removal). | [render/RenderBackend.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L52) |

package/dist/docs/api/index/interfaces/EcsSystem.md

@@ -6,7 +6,7 @@
 
 # Interface: EcsSystem
 
-Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/System.ts#L3)
+Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/System.ts#L3)
 
 ## Methods
 
@@ -16,7 +16,7 @@ Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-
 update(world, deltaTime): void;
 ```
 
-Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/System.ts#L4)
+Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/System.ts#L4)
 
 #### Parameters
 
@@ -37,7 +37,7 @@ Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-
 optional dispose(world): void;
 ```
 
-Defined in: [System.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/System.ts#L5)
+Defined in: [System.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/System.ts#L5)
 
 #### Parameters
 

package/dist/docs/api/index/interfaces/NetworkHandle.md

@@ -0,0 +1,180 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / NetworkHandle
+
+# Interface: NetworkHandle
+
+Defined in: [network/types.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L132)
+
+A Behaviour's view of the shared world: `this.network`, `null` in a single-player run.
+
+## Properties
+
+| Property | Modifier | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="connected"></a> `connected` | `readonly` | `boolean` | - | [network/types.ts:133](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L133) |
+| <a id="sessionid"></a> `sessionId` | `readonly` | `string` | This client's id in the room. | [network/types.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L135) |
+| <a id="ishost"></a> `isHost` | `readonly` | `boolean` | Whether this client simulates the scene's shared objects. | [network/types.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L137) |
+| <a id="isowner"></a> `isOwner` | `readonly` | `boolean` | Whether this client simulates this entity. | [network/types.ts:139](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L139) |
+| <a id="players"></a> `players` | `readonly` | `string`[] | Everyone in the room, by session id. | [network/types.ts:141](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L141) |
+| <a id="voice"></a> `voice` | `readonly` | `VoiceHandle` \| `null` | Voice chat, when the project has it on. | [network/types.ts:143](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L143) |
+
+## Methods
+
+### send()
+
+```ts
+send(name, payload?): void;
+```
+
+Defined in: [network/types.ts:145](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L145)
+
+Send to the room. Others hear it in `onMessage`, unless a server hook keeps it.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `payload?` | `unknown` |
+
+#### Returns
+
+`void`
+
+***
+
+### onMessage()
+
+```ts
+onMessage(name, handler): () => void;
+```
+
+Defined in: [network/types.ts:147](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L147)
+
+Listen for a message. Returns the way to stop.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `handler` | (`payload`, `from`) => `void` |
+
+#### Returns
+
+() => `void`
+
+***
+
+### playSlot()
+
+```ts
+playSlot(id, options?): boolean;
+```
+
+Defined in: [network/types.ts:152](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L152)
+
+Play a sound-bank slot here and for everyone in the room. Returns whether it
+sounded: a slot's chance and cooldown can keep it quiet, and then no one hears it.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+| `options?` | [`PlaySlotOptions`](../type-aliases/PlaySlotOptions.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### spawn()
+
+```ts
+spawn(prefab, options?): void;
+```
+
+Defined in: [network/types.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L154)
+
+Spawn a prefab everyone sees, owned by this client.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `prefab` | \| `string` \| \{ `path`: `string`; \} |
+| `options?` | [`NetSpawnOptions`](../type-aliases/NetSpawnOptions.md) |
+
+#### Returns
+
+`void`
+
+***
+
+### despawn()
+
+```ts
+despawn(entityId?): void;
+```
+
+Defined in: [network/types.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L156)
+
+Remove a shared entity this client owns (this one by default).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId?` | `number` |
+
+#### Returns
+
+`void`
+
+***
+
+### setProp()
+
+```ts
+setProp(key, value): void;
+```
+
+Defined in: [network/types.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L158)
+
+Change a shared value on this entity. Only its owner can.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+| `value` | [`NetValue`](../../components/type-aliases/NetValue.md) |
+
+#### Returns
+
+`void`
+
+***
+
+### getProp()
+
+```ts
+getProp(key): NetValue | undefined;
+```
+
+Defined in: [network/types.ts:159](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L159)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+[`NetValue`](../../components/type-aliases/NetValue.md) \| `undefined`

package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md

@@ -6,7 +6,7 @@
 
 # Interface: PostprocessingBuildContext
 
-Defined in: render/RenderBackend.ts:33
+Defined in: [render/RenderBackend.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L33)
 
 Everything a backend needs to build a post-processing chain.
 
@@ -14,8 +14,8 @@ Everything a backend needs to build a post-processing chain.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="renderer"></a> `renderer` | [`EcsRenderer`](../type-aliases/EcsRenderer.md) | - | render/RenderBackend.ts:34 |
-| <a id="scene"></a> `scene` | `Scene` | - | render/RenderBackend.ts:35 |
-| <a id="camera"></a> `camera` | `PerspectiveCamera` | - | render/RenderBackend.ts:36 |
-| <a id="values"></a> `values` | [`PostprocessingState`](../../components/type-aliases/PostprocessingState.md) | The scene's current `Postprocessing.values` (`postEnabled` is `true`). | render/RenderBackend.ts:38 |
-| <a id="world"></a> `world?` | [`World`](../classes/World.md) | The world being rendered, when known (used to scope one-time warnings). | render/RenderBackend.ts:40 |
+| <a id="renderer"></a> `renderer` | [`EcsRenderer`](../type-aliases/EcsRenderer.md) | - | [render/RenderBackend.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L34) |
+| <a id="scene"></a> `scene` | `Scene` | - | [render/RenderBackend.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L35) |
+| <a id="camera"></a> `camera` | `PerspectiveCamera` | - | [render/RenderBackend.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L36) |
+| <a id="values"></a> `values` | [`PostprocessingState`](../../components/type-aliases/PostprocessingState.md) | The scene's current `Postprocessing.values` (`postEnabled` is `true`). | [render/RenderBackend.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L38) |
+| <a id="world"></a> `world?` | [`World`](../classes/World.md) | The world being rendered, when known (used to scope one-time warnings). | [render/RenderBackend.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L40) |

package/dist/docs/api/index/interfaces/PostprocessingPipeline.md

@@ -6,7 +6,7 @@
 
 # Interface: PostprocessingPipeline
 
-Defined in: render/RenderBackend.ts:25
+Defined in: [render/RenderBackend.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L25)
 
 A built post-processing chain. `RenderSystem` calls `render()` in place of
 `renderer.render()` while it is active.
@@ -22,7 +22,7 @@ them, while a WebGPU `RenderPipeline` reads the renderer's size every frame.
 render(): void;
 ```
 
-Defined in: render/RenderBackend.ts:26
+Defined in: [render/RenderBackend.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L26)
 
 #### Returns
 
@@ -36,7 +36,7 @@ Defined in: render/RenderBackend.ts:26
 optional setSize(width, height): void;
 ```
 
-Defined in: render/RenderBackend.ts:27
+Defined in: [render/RenderBackend.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L27)
 
 #### Parameters
 
@@ -57,7 +57,7 @@ Defined in: render/RenderBackend.ts:27
 optional setPixelRatio(pixelRatio): void;
 ```
 
-Defined in: render/RenderBackend.ts:28
+Defined in: [render/RenderBackend.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L28)
 
 #### Parameters
 
@@ -77,7 +77,7 @@ Defined in: render/RenderBackend.ts:28
 dispose(): void;
 ```
 
-Defined in: render/RenderBackend.ts:29
+Defined in: [render/RenderBackend.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L29)
 
 #### Returns
 

package/dist/docs/api/index/interfaces/RenderBackend.md

@@ -6,7 +6,7 @@
 
 # Interface: RenderBackend
 
-Defined in: render/RenderBackend.ts:63
+Defined in: [render/RenderBackend.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L63)
 
 Everything renderer-specific the engine does, behind one small interface so
 a [World](../classes/World.md) can run on WebGL or WebGPU.
@@ -19,7 +19,7 @@ The default is `webglBackend` (exported from the package root). For a
 
 | Property | Modifier | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ | ------ |
-| <a id="kind"></a> `kind` | `readonly` | [`RendererKind`](../type-aliases/RendererKind.md) | Renderer family this backend drives. | render/RenderBackend.ts:65 |
+| <a id="kind"></a> `kind` | `readonly` | [`RendererKind`](../type-aliases/RendererKind.md) | Renderer family this backend drives. | [render/RenderBackend.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L65) |
 
 ## Methods
 
@@ -29,7 +29,7 @@ The default is `webglBackend` (exported from the package root). For a
 optional install(world): void;
 ```
 
-Defined in: render/RenderBackend.ts:67
+Defined in: [render/RenderBackend.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L67)
 
 One-time renderer setup, called once from the `World` constructor.
 
@@ -51,7 +51,7 @@ One-time renderer setup, called once from the `World` constructor.
 optional prepareAreaLights(world): void;
 ```
 
-Defined in: render/RenderBackend.ts:72
+Defined in: [render/RenderBackend.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L72)
 
 Called the first time an area light (`RectAreaLight`) is created, so the
 backend can load the lookup tables those lights need. Optional.
@@ -74,7 +74,7 @@ backend can load the lookup tables those lights need. Optional.
 createPostprocessing(context): PostprocessingPipeline | null;
 ```
 
-Defined in: render/RenderBackend.ts:77
+Defined in: [render/RenderBackend.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L77)
 
 Build the post-processing chain for `context.values`. Return `null` to
 render the scene directly (no chain).
@@ -100,7 +100,7 @@ optional updatePostprocessing(
    next): boolean;
 ```
 
-Defined in: render/RenderBackend.ts:86
+Defined in: [render/RenderBackend.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L86)
 
 Apply a values change to an existing chain without rebuilding it. Return
 `true` when the chain was updated in place, `false` when the change is
@@ -127,7 +127,7 @@ When omitted, every change rebuilds.
 createChromaKeyMaterial(texture, options): Material;
 ```
 
-Defined in: render/RenderBackend.ts:92
+Defined in: [render/RenderBackend.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L92)
 
 Material that renders `texture` with `options.keyColor` keyed out.
 
@@ -150,7 +150,7 @@ Material that renders `texture` with `options.keyColor` keyed out.
 updateChromaKeyMaterial(material, options): boolean;
 ```
 
-Defined in: render/RenderBackend.ts:101
+Defined in: [render/RenderBackend.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L101)
 
 Push new options into a material made by [createChromaKeyMaterial](#createchromakeymaterial).
 Returns `false` when `material` is not one of this backend's chroma-key

package/dist/docs/api/index/interfaces/SoundBankAsset.md

@@ -0,0 +1,18 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / SoundBankAsset
+
+# Interface: SoundBankAsset
+
+Defined in: [audio/soundBank.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L32)
+
+The contents of a `.soundbank.json` asset.
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="version"></a> `version` | `1` | [audio/soundBank.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L33) |
+| <a id="slots"></a> `slots` | `Record`\<`string`, [`SoundSlot`](SoundSlot.md)\> | [audio/soundBank.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L34) |