@relu-interactives/spatial-ecs 0.10.0 → 0.11.1

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

@@ -0,0 +1,59 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / SlotChooser
+
+# Class: SlotChooser
+
+Defined in: [audio/soundBank.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L63)
+
+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.
+
+## Constructors
+
+### Constructor
+
+```ts
+new SlotChooser(random?): SlotChooser;
+```
+
+Defined in: [audio/soundBank.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L67)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `random` | () => `number` | `Math.random` |
+
+#### Returns
+
+`SlotChooser`
+
+## Methods
+
+### choose()
+
+```ts
+choose(
+   id, 
+   slot, 
+   now): SoundTake | null;
+```
+
+Defined in: [audio/soundBank.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L70)
+
+The take to play now, or `null` to stay silent. `now` is in milliseconds.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+| `slot` | [`SoundSlot`](../interfaces/SoundSlot.md) |
+| `now` | `number` |
+
+#### Returns
+
+[`SoundTake`](../interfaces/SoundTake.md) \| `null`

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

@@ -6,7 +6,7 @@
 
 # Class: TeleportAimGate
 
-Defined in: [xr/teleportAimGate.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L17)
+Defined in: [xr/teleportAimGate.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportAimGate.ts#L17)
 
 Decides when a teleport may actually commit.
 
@@ -46,7 +46,7 @@ update(
    releasing): boolean;
 ```
 
-Defined in: [xr/teleportAimGate.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L25)
+Defined in: [xr/teleportAimGate.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportAimGate.ts#L25)
 
 Feed one frame for one source.
 
@@ -72,7 +72,7 @@ whether the teleport should commit this frame.
 isAiming(source): boolean;
 ```
 
-Defined in: [xr/teleportAimGate.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L42)
+Defined in: [xr/teleportAimGate.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportAimGate.ts#L42)
 
 True if this source currently has an aim engaged.
 
@@ -94,7 +94,7 @@ True if this source currently has an aim engaged.
 cancel(source): boolean;
 ```
 
-Defined in: [xr/teleportAimGate.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportAimGate.ts#L54)
+Defined in: [xr/teleportAimGate.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportAimGate.ts#L54)
 
 Drop a source's aim without committing.
 

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

@@ -6,7 +6,7 @@
 
 # Class: ThrowVelocityTracker
 
-Defined in: [xr/throwVelocity.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L52)
+Defined in: [xr/throwVelocity.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L52)
 
 Rolling buffer of hand positions used to recover throw velocity.
 
@@ -32,7 +32,7 @@ new ThrowVelocityTracker(): ThrowVelocityTracker;
 record(position, time): void;
 ```
 
-Defined in: [xr/throwVelocity.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L56)
+Defined in: [xr/throwVelocity.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L56)
 
 Record where the hand is now. Call once per frame while held.
 
@@ -55,7 +55,7 @@ Record where the hand is now. Call once per frame while held.
 computeVelocity(now): Vector3;
 ```
 
-Defined in: [xr/throwVelocity.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L71)
+Defined in: [xr/throwVelocity.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L71)
 
 Velocity to release with, in metres/second.
 
@@ -82,7 +82,7 @@ what matches the motion the user actually felt they made.
 clear(): void;
 ```
 
-Defined in: [xr/throwVelocity.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L105)
+Defined in: [xr/throwVelocity.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L105)
 
 #### Returns
 

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

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

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

@@ -6,7 +6,7 @@
 
 # Class: UIInteractionSystem
 
-Defined in: [systems/UIInteractionSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L56)
+Defined in: [systems/UIInteractionSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIInteractionSystem.ts#L79)
 
 ## Implements
 
@@ -20,7 +20,7 @@ Defined in: [systems/UIInteractionSystem.ts:56](https://github.com/Relu-Interact
 new UIInteractionSystem(interaction, options?): UIInteractionSystem;
 ```
 
-Defined in: [systems/UIInteractionSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L72)
+Defined in: [systems/UIInteractionSystem.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIInteractionSystem.ts#L96)
 
 #### Parameters
 
@@ -42,7 +42,7 @@ Defined in: [systems/UIInteractionSystem.ts:72](https://github.com/Relu-Interact
 update(world, deltaTime?): void;
 ```
 
-Defined in: [systems/UIInteractionSystem.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIInteractionSystem.ts#L86)
+Defined in: [systems/UIInteractionSystem.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIInteractionSystem.ts#L110)
 
 #### Parameters
 

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

@@ -6,7 +6,7 @@
 
 # Class: UIPanelSystem
 
-Defined in: [systems/UIPanelSystem.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L70)
+Defined in: [systems/UIPanelSystem.ts:129](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L129)
 
 ## Implements
 
@@ -20,7 +20,7 @@ Defined in: [systems/UIPanelSystem.ts:70](https://github.com/Relu-Interactives/r
 new UIPanelSystem(options?): UIPanelSystem;
 ```
 
-Defined in: [systems/UIPanelSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L74)
+Defined in: [systems/UIPanelSystem.ts:145](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L145)
 
 #### Parameters
 
@@ -41,7 +41,7 @@ Defined in: [systems/UIPanelSystem.ts:74](https://github.com/Relu-Interactives/r
 update(world, deltaTime?): void;
 ```
 
-Defined in: [systems/UIPanelSystem.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L80)
+Defined in: [systems/UIPanelSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L151)
 
 #### Parameters
 
@@ -66,7 +66,7 @@ Defined in: [systems/UIPanelSystem.ts:80](https://github.com/Relu-Interactives/r
 dispose(): void;
 ```
 
-Defined in: [systems/UIPanelSystem.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/UIPanelSystem.ts#L130)
+Defined in: [systems/UIPanelSystem.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L207)
 
 All GPU/canvas resources; call on world teardown.
 

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

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

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

@@ -6,7 +6,7 @@
 
 # Class: VideoSystem
 
-Defined in: [systems/VideoSystem.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L66)
+Defined in: [systems/VideoSystem.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/VideoSystem.ts#L66)
 
 Reconciles `VideoComponent` state with the underlying HTML video element
 and THREE.js mesh/material each frame.
@@ -36,7 +36,7 @@ no-op so the editor is unaffected).
 new VideoSystem(__namedParameters?): VideoSystem;
 ```
 
-Defined in: [systems/VideoSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L75)
+Defined in: [systems/VideoSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/VideoSystem.ts#L75)
 
 #### Parameters
 
@@ -57,7 +57,7 @@ Defined in: [systems/VideoSystem.ts:75](https://github.com/Relu-Interactives/rel
 update(world, _deltaTime): void;
 ```
 
-Defined in: [systems/VideoSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L79)
+Defined in: [systems/VideoSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/VideoSystem.ts#L79)
 
 #### Parameters
 
@@ -82,7 +82,7 @@ Defined in: [systems/VideoSystem.ts:79](https://github.com/Relu-Interactives/rel
 dispose(_world): void;
 ```
 
-Defined in: [systems/VideoSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/VideoSystem.ts#L246)
+Defined in: [systems/VideoSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/VideoSystem.ts#L246)
 
 #### Parameters