@relu-interactives/spatial-ecs 0.2.13 → 0.2.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/dist/{System-CTTwEGn1.d.cts → System-BeuJ1xt5.d.cts} +2 -0
  2. package/dist/{System-CTTwEGn1.d.ts → System-BeuJ1xt5.d.ts} +2 -0
  3. package/dist/{Video-CV1-u6hL.d.ts → Video-Cym2C52L.d.ts} +1 -1
  4. package/dist/{Video-BMWPYc3q.d.cts → Video-D4B-z74P.d.cts} +1 -1
  5. package/dist/{chunk-KDZ6VBRO.js → chunk-D3AKP6QQ.js} +33 -6
  6. package/dist/chunk-D3AKP6QQ.js.map +1 -0
  7. package/dist/components/index.d.cts +2 -2
  8. package/dist/components/index.d.ts +2 -2
  9. package/dist/docs/api/Behaviour/classes/Behaviour.md +29 -29
  10. package/dist/docs/api/Component/classes/Component.md +1 -1
  11. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  12. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  13. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  14. package/dist/docs/api/components/classes/EntityType.md +3 -3
  15. package/dist/docs/api/components/classes/Environment.md +3 -3
  16. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  17. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  18. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  19. package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
  20. package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
  21. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  22. package/dist/docs/api/components/classes/MaterialComponent.md +11 -11
  23. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  24. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  25. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  26. package/dist/docs/api/components/classes/Name.md +3 -3
  27. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  28. package/dist/docs/api/components/classes/ParentId.md +3 -3
  29. package/dist/docs/api/components/classes/PhysicsComponent.md +6 -6
  30. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  31. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  32. package/dist/docs/api/components/classes/Selectable.md +3 -3
  33. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  34. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  35. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  36. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  37. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  38. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
  39. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
  40. package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
  41. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
  42. package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
  43. package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
  44. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
  45. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
  46. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
  47. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
  48. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
  49. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
  50. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
  51. package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
  52. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
  53. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
  54. package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
  55. package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
  56. package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
  57. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  58. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  59. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  60. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  61. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  62. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  63. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  64. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  65. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  66. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  67. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  68. package/dist/docs/api/components/type-aliases/ScriptEntry.md +9 -9
  69. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  70. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  71. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  72. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  73. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  74. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  75. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  76. package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
  77. package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
  78. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  79. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  80. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  81. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  82. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  83. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  84. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  85. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  86. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  87. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  88. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  89. package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
  90. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  91. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  92. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  93. package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
  94. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  95. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  96. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  97. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  98. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  99. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  100. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  101. package/dist/docs/api/index/classes/World.md +124 -84
  102. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  103. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  104. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  105. package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
  106. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  107. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  108. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  109. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  110. package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
  111. package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
  112. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  113. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  114. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  115. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  116. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  117. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  118. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  119. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  120. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  121. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  122. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  123. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  124. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  125. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  126. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  127. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  128. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  129. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  130. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  131. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  132. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  133. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  134. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  135. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  136. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +1 -1
  137. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  138. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  139. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +3 -3
  140. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  141. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  142. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  143. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  144. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  145. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  146. package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
  147. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  148. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  149. package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
  150. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  151. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  152. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  153. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
  154. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  155. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  156. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  157. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  158. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  159. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  160. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  161. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  162. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  163. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  164. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  165. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  166. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  167. package/dist/docs/guide/components/parent-id.md +25 -0
  168. package/dist/docs/guide/world-api.md +34 -0
  169. package/dist/factories/index.d.cts +2 -2
  170. package/dist/factories/index.d.ts +2 -2
  171. package/dist/{index-D7q4SRCp.d.cts → index-BfoOC2CG.d.cts} +2 -2
  172. package/dist/{index-ByX7502C.d.ts → index-BoJ3_6a3.d.ts} +2 -2
  173. package/dist/index.cjs +49 -4
  174. package/dist/index.cjs.map +1 -1
  175. package/dist/index.d.cts +5 -5
  176. package/dist/index.d.ts +5 -5
  177. package/dist/index.js +21 -3
  178. package/dist/index.js.map +1 -1
  179. package/dist/systems/index.cjs +31 -4
  180. package/dist/systems/index.cjs.map +1 -1
  181. package/dist/systems/index.d.cts +6 -2
  182. package/dist/systems/index.d.ts +6 -2
  183. package/dist/systems/index.js +1 -1
  184. package/dist/types.d.cts +1 -1
  185. package/dist/types.d.ts +1 -1
  186. package/dist/worldSnapshotUtils.d.cts +1 -1
  187. package/dist/worldSnapshotUtils.d.ts +1 -1
  188. package/package.json +1 -1
  189. package/dist/chunk-KDZ6VBRO.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, n as EntityType, I as ImageComponent, o as ImageTarget, p as ImageTargetAnchor, q as ImageTargetAnchorOptions, r as ImageTargetReference, s as InstanceSlotComponent, t as InstanceTransform, u as InstancedMeshComponent, v as InstancedMeshKind, L as LightComponent, w as LightValueState, M as MaterialComponent, x as MaterialTypeValue, y as MaterialValueState, z as MeshComponent, B as MeshGeometryComponent, F as MeshGeometryParameters, G as MeshGeometryParametersByKind, H as ModelComponent, N as Name, O as Object3DRef, P as PhysicsComponent, J as PhysicsState, K as PlaneMeshParameters, R as RadiusHeightMeshParameters, Q as RadiusMeshParameters, S as RigidbodyState, T as RigidbodyType, U as ScriptComponent, V as ScriptEntry, W as Selectable, X as SelectionTransformState, Y as SpriteComponent, Z as TextureFilteringValue, _ as TransformModeValue, $ as TransformSpaceValue, a0 as VideoComponent, a1 as normalizePhysicsState } from '../Video-BMWPYc3q.cjs';
2
- export { D as DEFAULT_ENVIRONMENT_STATE, a as DEFAULT_POSTPROCESSING_STATE, E as Environment, b as EnvironmentFogState, c as EnvironmentFogType, d as EnvironmentGradientEffect, e as EnvironmentSkyboxState, f as EnvironmentSkyboxType, g as EnvironmentState, P as ParentId, h as Postprocessing, i as PostprocessingState, T as TransformComponent, j as TransformData, V as Vec3 } from '../System-CTTwEGn1.cjs';
1
+ export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, n as EntityType, I as ImageComponent, o as ImageTarget, p as ImageTargetAnchor, q as ImageTargetAnchorOptions, r as ImageTargetReference, s as InstanceSlotComponent, t as InstanceTransform, u as InstancedMeshComponent, v as InstancedMeshKind, L as LightComponent, w as LightValueState, M as MaterialComponent, x as MaterialTypeValue, y as MaterialValueState, z as MeshComponent, B as MeshGeometryComponent, F as MeshGeometryParameters, G as MeshGeometryParametersByKind, H as ModelComponent, N as Name, O as Object3DRef, P as PhysicsComponent, J as PhysicsState, K as PlaneMeshParameters, R as RadiusHeightMeshParameters, Q as RadiusMeshParameters, S as RigidbodyState, T as RigidbodyType, U as ScriptComponent, V as ScriptEntry, W as Selectable, X as SelectionTransformState, Y as SpriteComponent, Z as TextureFilteringValue, _ as TransformModeValue, $ as TransformSpaceValue, a0 as VideoComponent, a1 as normalizePhysicsState } from '../Video-D4B-z74P.cjs';
2
+ export { D as DEFAULT_ENVIRONMENT_STATE, a as DEFAULT_POSTPROCESSING_STATE, E as Environment, b as EnvironmentFogState, c as EnvironmentFogType, d as EnvironmentGradientEffect, e as EnvironmentSkyboxState, f as EnvironmentSkyboxType, g as EnvironmentState, P as ParentId, h as Postprocessing, i as PostprocessingState, T as TransformComponent, j as TransformData, V as Vec3 } from '../System-BeuJ1xt5.cjs';
3
3
  import 'three';
4
4
  import '@dimforge/rapier3d-compat';
@@ -1,4 +1,4 @@
1
- export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, n as EntityType, I as ImageComponent, o as ImageTarget, p as ImageTargetAnchor, q as ImageTargetAnchorOptions, r as ImageTargetReference, s as InstanceSlotComponent, t as InstanceTransform, u as InstancedMeshComponent, v as InstancedMeshKind, L as LightComponent, w as LightValueState, M as MaterialComponent, x as MaterialTypeValue, y as MaterialValueState, z as MeshComponent, B as MeshGeometryComponent, F as MeshGeometryParameters, G as MeshGeometryParametersByKind, H as ModelComponent, N as Name, O as Object3DRef, P as PhysicsComponent, J as PhysicsState, K as PlaneMeshParameters, R as RadiusHeightMeshParameters, Q as RadiusMeshParameters, S as RigidbodyState, T as RigidbodyType, U as ScriptComponent, V as ScriptEntry, W as Selectable, X as SelectionTransformState, Y as SpriteComponent, Z as TextureFilteringValue, _ as TransformModeValue, $ as TransformSpaceValue, a0 as VideoComponent, a1 as normalizePhysicsState } from '../Video-CV1-u6hL.js';
2
- export { D as DEFAULT_ENVIRONMENT_STATE, a as DEFAULT_POSTPROCESSING_STATE, E as Environment, b as EnvironmentFogState, c as EnvironmentFogType, d as EnvironmentGradientEffect, e as EnvironmentSkyboxState, f as EnvironmentSkyboxType, g as EnvironmentState, P as ParentId, h as Postprocessing, i as PostprocessingState, T as TransformComponent, j as TransformData, V as Vec3 } from '../System-CTTwEGn1.js';
1
+ export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, n as EntityType, I as ImageComponent, o as ImageTarget, p as ImageTargetAnchor, q as ImageTargetAnchorOptions, r as ImageTargetReference, s as InstanceSlotComponent, t as InstanceTransform, u as InstancedMeshComponent, v as InstancedMeshKind, L as LightComponent, w as LightValueState, M as MaterialComponent, x as MaterialTypeValue, y as MaterialValueState, z as MeshComponent, B as MeshGeometryComponent, F as MeshGeometryParameters, G as MeshGeometryParametersByKind, H as ModelComponent, N as Name, O as Object3DRef, P as PhysicsComponent, J as PhysicsState, K as PlaneMeshParameters, R as RadiusHeightMeshParameters, Q as RadiusMeshParameters, S as RigidbodyState, T as RigidbodyType, U as ScriptComponent, V as ScriptEntry, W as Selectable, X as SelectionTransformState, Y as SpriteComponent, Z as TextureFilteringValue, _ as TransformModeValue, $ as TransformSpaceValue, a0 as VideoComponent, a1 as normalizePhysicsState } from '../Video-Cym2C52L.js';
2
+ export { D as DEFAULT_ENVIRONMENT_STATE, a as DEFAULT_POSTPROCESSING_STATE, E as Environment, b as EnvironmentFogState, c as EnvironmentFogType, d as EnvironmentGradientEffect, e as EnvironmentSkyboxState, f as EnvironmentSkyboxType, g as EnvironmentState, P as ParentId, h as Postprocessing, i as PostprocessingState, T as TransformComponent, j as TransformData, V as Vec3 } from '../System-BeuJ1xt5.js';
3
3
  import 'three';
4
4
  import '@dimforge/rapier3d-compat';
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Behaviour
8
8
 
9
- Defined in: [Behaviour.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L62)
9
+ Defined in: [Behaviour.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L62)
10
10
 
11
11
  Base class for all user-authored scripts attached to an entity through a
12
12
  `ScriptComponent`. Subclass `Behaviour` to drive per-frame logic on a single
@@ -76,7 +76,7 @@ new Behaviour(
76
76
  component): Behaviour;
77
77
  ```
78
78
 
79
- Defined in: [Behaviour.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L120)
79
+ Defined in: [Behaviour.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L120)
80
80
 
81
81
  Engine-managed constructor. Hosts (`ScriptBehaviourSystem`) instantiate
82
82
  subclasses with the owning world, the entity id, and the script's `data`
@@ -98,13 +98,13 @@ payload. User code should not call this directly.
98
98
 
99
99
  | Property | Type | Default value | Description | Defined in |
100
100
  | ------ | ------ | ------ | ------ | ------ |
101
- | <a id="data"></a> `data` | \| [`Component`](../../Component/classes/Component.md) \| `Record`\<`string`, `unknown`\> | `undefined` | Inspector-bound payload from the entity's `ScriptComponent`. Override the type on subclasses with `declare data: MyDataShape` to get type safety inside hooks. Saved with the project so values persist across reloads. | [Behaviour.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L78) |
102
- | <a id="entityid"></a> `entityId` | `number` | `undefined` | Numeric id of the entity this script is attached to. | [Behaviour.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L81) |
103
- | <a id="entity"></a> `entity` | `WorldEntityView` | `undefined` | View of the owning entity (id + components) at construction time. | [Behaviour.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L84) |
104
- | <a id="threeref"></a> `threeRef` | [`Object3DRef`](../../components/classes/Object3DRef.md) | `undefined` | Live three.js object wrapper for the entity. May be `null` for entities with no scene presence; helpers on this class return `null` in that case. | [Behaviour.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L90) |
105
- | <a id="transform"></a> `transform` | [`TransformComponent`](../../components/classes/TransformComponent.md) | `undefined` | The entity's [TransformComponent](../../components/classes/TransformComponent.md). Mutating `position`, `rotation`, or `scale` here is picked up the same frame by `TransformSyncSystem`. | [Behaviour.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L96) |
106
- | <a id="world"></a> `world` | [`World`](../../index/classes/World.md) | `undefined` | The owning [World](../../index/classes/World.md). Refreshed each frame in [Behaviour.update](#update). Use it to query other entities or components. | [Behaviour.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L102) |
107
- | <a id="deltatime"></a> `deltaTime` | `number` | `0` | Seconds elapsed since the last frame. Set by the engine before each [Behaviour.onUpdate](#onupdate). | [Behaviour.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L108) |
101
+ | <a id="data"></a> `data` | \| [`Component`](../../Component/classes/Component.md) \| `Record`\<`string`, `unknown`\> | `undefined` | Inspector-bound payload from the entity's `ScriptComponent`. Override the type on subclasses with `declare data: MyDataShape` to get type safety inside hooks. Saved with the project so values persist across reloads. | [Behaviour.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L78) |
102
+ | <a id="entityid"></a> `entityId` | `number` | `undefined` | Numeric id of the entity this script is attached to. | [Behaviour.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L81) |
103
+ | <a id="entity"></a> `entity` | `WorldEntityView` | `undefined` | View of the owning entity (id + components) at construction time. | [Behaviour.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L84) |
104
+ | <a id="threeref"></a> `threeRef` | [`Object3DRef`](../../components/classes/Object3DRef.md) | `undefined` | Live three.js object wrapper for the entity. May be `null` for entities with no scene presence; helpers on this class return `null` in that case. | [Behaviour.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L90) |
105
+ | <a id="transform"></a> `transform` | [`TransformComponent`](../../components/classes/TransformComponent.md) | `undefined` | The entity's [TransformComponent](../../components/classes/TransformComponent.md). Mutating `position`, `rotation`, or `scale` here is picked up the same frame by `TransformSyncSystem`. | [Behaviour.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L96) |
106
+ | <a id="world"></a> `world` | [`World`](../../index/classes/World.md) | `undefined` | The owning [World](../../index/classes/World.md). Refreshed each frame in [Behaviour.update](#update). Use it to query other entities or components. | [Behaviour.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L102) |
107
+ | <a id="deltatime"></a> `deltaTime` | `number` | `0` | Seconds elapsed since the last frame. Set by the engine before each [Behaviour.onUpdate](#onupdate). | [Behaviour.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L108) |
108
108
 
109
109
  ## Methods
110
110
 
@@ -114,7 +114,7 @@ payload. User code should not call this directly.
114
114
  update(world, deltaTime): void;
115
115
  ```
116
116
 
117
- Defined in: [Behaviour.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L144)
117
+ Defined in: [Behaviour.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L144)
118
118
 
119
119
  Engine-managed per-frame entry point. Refreshes [Behaviour.deltaTime](#deltatime)
120
120
  and delegates to [Behaviour.onUpdate](#onupdate).
@@ -149,7 +149,7 @@ CustomEcsSystem.update
149
149
  optional dispose(world): void;
150
150
  ```
151
151
 
152
- Defined in: [Behaviour.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L156)
152
+ Defined in: [Behaviour.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L156)
153
153
 
154
154
  Optional cleanup hook invoked when the script is detached or the entity
155
155
  is destroyed. Override to release timers, listeners, or other resources.
@@ -178,7 +178,7 @@ CustomEcsSystem.dispose
178
178
  getWorldPosition(): Vector3 | null;
179
179
  ```
180
180
 
181
- Defined in: [Behaviour.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L164)
181
+ Defined in: [Behaviour.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L164)
182
182
 
183
183
  Returns the entity's world-space position as a new `THREE.Vector3`, or
184
184
  `null` if the entity has no scene presence.
@@ -195,7 +195,7 @@ Returns the entity's world-space position as a new `THREE.Vector3`, or
195
195
  getWorldDirection(): Vector3 | null;
196
196
  ```
197
197
 
198
- Defined in: [Behaviour.ts:179](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L179)
198
+ Defined in: [Behaviour.ts:179](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L179)
199
199
 
200
200
  Returns the entity's forward direction in world space (the +Z axis of its
201
201
  world matrix), or `null` if the entity has no scene presence.
@@ -212,7 +212,7 @@ world matrix), or `null` if the entity has no scene presence.
212
212
  directionTo(targetPosition): Vector3 | null;
213
213
  ```
214
214
 
215
- Defined in: [Behaviour.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L196)
215
+ Defined in: [Behaviour.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L196)
216
216
 
217
217
  Returns a unit vector pointing from this entity toward the given world
218
218
  position, or `null` if the entity has no scene presence.
@@ -235,7 +235,7 @@ position, or `null` if the entity has no scene presence.
235
235
  distanceTo(targetPosition): number | null;
236
236
  ```
237
237
 
238
- Defined in: [Behaviour.ts:211](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L211)
238
+ Defined in: [Behaviour.ts:211](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L211)
239
239
 
240
240
  Returns the world-space distance from this entity to the given position,
241
241
  or `null` if the entity has no scene presence.
@@ -258,7 +258,7 @@ or `null` if the entity has no scene presence.
258
258
  lerpTo(targetPosition, alpha): void;
259
259
  ```
260
260
 
261
- Defined in: [Behaviour.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L229)
261
+ Defined in: [Behaviour.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L229)
262
262
 
263
263
  Linearly interpolates the entity's position toward `targetPosition` and
264
264
  writes the result back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if the
@@ -283,7 +283,7 @@ entity has no scene presence.
283
283
  slerpTo(targetRotation, alpha): void;
284
284
  ```
285
285
 
286
- Defined in: [Behaviour.ts:251](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L251)
286
+ Defined in: [Behaviour.ts:251](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L251)
287
287
 
288
288
  Spherically interpolates the entity's rotation toward `targetRotation`
289
289
  and writes the result back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if
@@ -308,7 +308,7 @@ the entity has no scene presence.
308
308
  lookAt(targetPosition): void;
309
309
  ```
310
310
 
311
- Defined in: [Behaviour.ts:270](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L270)
311
+ Defined in: [Behaviour.ts:270](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L270)
312
312
 
313
313
  Rotates the entity to face `targetPosition` in world space and writes the
314
314
  resulting orientation back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if
@@ -332,7 +332,7 @@ the entity has no scene presence.
332
332
  getComponents(): Component[];
333
333
  ```
334
334
 
335
- Defined in: [Behaviour.ts:284](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L284)
335
+ Defined in: [Behaviour.ts:284](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L284)
336
336
 
337
337
  Returns every component currently attached to this entity.
338
338
 
@@ -348,7 +348,7 @@ Returns every component currently attached to this entity.
348
348
  getComponent<T>(componentClass): T | null;
349
349
  ```
350
350
 
351
- Defined in: [Behaviour.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L301)
351
+ Defined in: [Behaviour.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L301)
352
352
 
353
353
  Returns the entity's component of the given class, or `null` if it has
354
354
  no such component.
@@ -384,7 +384,7 @@ if (mesh) console.log(mesh.geometryRef);
384
384
  getEntity(): WorldEntityView | null;
385
385
  ```
386
386
 
387
- Defined in: [Behaviour.ts:311](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L311)
387
+ Defined in: [Behaviour.ts:311](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L311)
388
388
 
389
389
  Returns the latest [WorldEntityView](../../types/type-aliases/WorldEntityView.md) snapshot for this entity, or
390
390
  `null` if it was destroyed.
@@ -401,7 +401,7 @@ Returns the latest [WorldEntityView](../../types/type-aliases/WorldEntityView.md
401
401
  getParent(): ParentLookup;
402
402
  ```
403
403
 
404
- Defined in: [Behaviour.ts:321](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L321)
404
+ Defined in: [Behaviour.ts:321](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L321)
405
405
 
406
406
  Resolves the entity's parent from the [ParentId](../../components/classes/ParentId.md) component, if any.
407
407
 
@@ -420,7 +420,7 @@ A [ParentLookup](../../types/type-aliases/ParentLookup.md) with the parent compo
420
420
  getChildren(): WorldEntityView[];
421
421
  ```
422
422
 
423
- Defined in: [Behaviour.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L342)
423
+ Defined in: [Behaviour.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L342)
424
424
 
425
425
  Returns every direct child entity of this one (entities whose
426
426
  [ParentId](../../components/classes/ParentId.md) matches `entityId`).
@@ -437,7 +437,7 @@ Returns every direct child entity of this one (entities whose
437
437
  protected init(): void;
438
438
  ```
439
439
 
440
- Defined in: [Behaviour.ts:361](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L361)
440
+ Defined in: [Behaviour.ts:361](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L361)
441
441
 
442
442
  Called once before the first [Behaviour.onUpdate](#onupdate). Override to
443
443
  default and validate [Behaviour.data](#data), cache references, or set
@@ -460,7 +460,7 @@ entry.
460
460
  protected onUpdate(): void;
461
461
  ```
462
462
 
463
- Defined in: [Behaviour.ts:374](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L374)
463
+ Defined in: [Behaviour.ts:374](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L374)
464
464
 
465
465
  Called every frame while the script is enabled. Override with the
466
466
  script's main per-frame logic.
@@ -483,7 +483,7 @@ rendering work such as custom shaders or procedural geometry.
483
483
  onSelect(): void;
484
484
  ```
485
485
 
486
- Defined in: [Behaviour.ts:379](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L379)
486
+ Defined in: [Behaviour.ts:379](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L379)
487
487
 
488
488
  Called when the editor selects this entity. Optional UX hook.
489
489
 
@@ -499,7 +499,7 @@ Called when the editor selects this entity. Optional UX hook.
499
499
  onDeselect(): void;
500
500
  ```
501
501
 
502
- Defined in: [Behaviour.ts:384](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L384)
502
+ Defined in: [Behaviour.ts:384](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L384)
503
503
 
504
504
  Called when the editor deselects this entity. Optional UX hook.
505
505
 
@@ -515,7 +515,7 @@ Called when the editor deselects this entity. Optional UX hook.
515
515
  onTargetFound(target): void;
516
516
  ```
517
517
 
518
- Defined in: [Behaviour.ts:394](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L394)
518
+ Defined in: [Behaviour.ts:394](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L394)
519
519
 
520
520
  Called when an image-tracking target this entity depends on becomes
521
521
  visible. Optional AR hook.
@@ -538,7 +538,7 @@ visible. Optional AR hook.
538
538
  onTargetLost(target): void;
539
539
  ```
540
540
 
541
- Defined in: [Behaviour.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Behaviour.ts#L404)
541
+ Defined in: [Behaviour.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Behaviour.ts#L404)
542
542
 
543
543
  Called when an image-tracking target this entity depends on is lost.
544
544
  Optional AR hook.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Component
8
8
 
9
- Defined in: [Component.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/Component.ts#L12)
9
+ Defined in: [Component.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/Component.ts#L12)
10
10
 
11
11
  Marker base class for every ECS component. Subclass `Component` to declare
12
12
  a typed data container that systems can query.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: AnimationComponent
8
8
 
9
- Defined in: [components/Animation.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L71)
9
+ Defined in: [components/Animation.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L71)
10
10
 
11
11
  Animation catalog and runtime state for an entity. Combines clips imported
12
12
  from a model with externally added clips, exposes a state machine for
@@ -30,7 +30,7 @@ machine directly so the animation system observes transitions.
30
30
  new AnimationComponent(options?): AnimationComponent;
31
31
  ```
32
32
 
33
- Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L102)
33
+ Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L102)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -50,18 +50,18 @@ Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/r
50
50
 
51
51
  | Property | Type | Description | Defined in |
52
52
  | ------ | ------ | ------ | ------ |
53
- | <a id="clips"></a> `clips` | `AnimationClip`[] | Combined ordered list of clips (model + external) currently loaded. | [components/Animation.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L78) |
54
- | <a id="clipcatalog"></a> `clipCatalog` | `AnimationClipCatalogEntry`[] | Per-clip metadata used by the inspector. | [components/Animation.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L80) |
55
- | <a id="availableclips"></a> `availableClips` | `string`[] | Display names of clips available for state-machine bindings. | [components/Animation.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L82) |
56
- | <a id="externalclipsources"></a> `externalClipSources` | `string`[] | URLs/paths of external clip sources (saved with the project). | [components/Animation.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L84) |
57
- | <a id="paused"></a> `paused` | `boolean` | Whether playback is currently paused. | [components/Animation.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L86) |
58
- | <a id="reverse"></a> `reverse` | `boolean` | Play the active clip in reverse. | [components/Animation.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L88) |
59
- | <a id="timescale"></a> `timeScale` | `number` | Playback speed multiplier (`1` = real-time). | [components/Animation.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L90) |
60
- | <a id="crossfadeduration"></a> `crossFadeDuration` | `number` | Default cross-fade duration in seconds when switching states. | [components/Animation.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L92) |
61
- | <a id="states"></a> `states` | [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md)[] | All state-machine entries authored on this entity. | [components/Animation.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L94) |
62
- | <a id="active"></a> `active` | \| [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md) \| `null` | State currently being played, or `null` if none. | [components/Animation.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L96) |
63
- | <a id="activestatename"></a> `activeStateName` | `string` \| `null` | Name of the [active](#active) state, or `null` if none. | [components/Animation.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L98) |
64
- | <a id="statemanager"></a> `stateManager` | [`AnimationStateManager`](../../index/classes/AnimationStateManager.md) | Manager that drives state transitions; mutate via [addState](#addstate)/[switchState](#switchstate). | [components/Animation.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L100) |
53
+ | <a id="clips"></a> `clips` | `AnimationClip`[] | Combined ordered list of clips (model + external) currently loaded. | [components/Animation.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L78) |
54
+ | <a id="clipcatalog"></a> `clipCatalog` | `AnimationClipCatalogEntry`[] | Per-clip metadata used by the inspector. | [components/Animation.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L80) |
55
+ | <a id="availableclips"></a> `availableClips` | `string`[] | Display names of clips available for state-machine bindings. | [components/Animation.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L82) |
56
+ | <a id="externalclipsources"></a> `externalClipSources` | `string`[] | URLs/paths of external clip sources (saved with the project). | [components/Animation.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L84) |
57
+ | <a id="paused"></a> `paused` | `boolean` | Whether playback is currently paused. | [components/Animation.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L86) |
58
+ | <a id="reverse"></a> `reverse` | `boolean` | Play the active clip in reverse. | [components/Animation.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L88) |
59
+ | <a id="timescale"></a> `timeScale` | `number` | Playback speed multiplier (`1` = real-time). | [components/Animation.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L90) |
60
+ | <a id="crossfadeduration"></a> `crossFadeDuration` | `number` | Default cross-fade duration in seconds when switching states. | [components/Animation.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L92) |
61
+ | <a id="states"></a> `states` | [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md)[] | All state-machine entries authored on this entity. | [components/Animation.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L94) |
62
+ | <a id="active"></a> `active` | \| [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md) \| `null` | State currently being played, or `null` if none. | [components/Animation.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L96) |
63
+ | <a id="activestatename"></a> `activeStateName` | `string` \| `null` | Name of the [active](#active) state, or `null` if none. | [components/Animation.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L98) |
64
+ | <a id="statemanager"></a> `stateManager` | [`AnimationStateManager`](../../index/classes/AnimationStateManager.md) | Manager that drives state transitions; mutate via [addState](#addstate)/[switchState](#switchstate). | [components/Animation.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L100) |
65
65
 
66
66
  ## Methods
67
67
 
@@ -71,7 +71,7 @@ Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/r
71
71
  setModelClips(clips): void;
72
72
  ```
73
73
 
74
- Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L234)
74
+ Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L234)
75
75
 
76
76
  #### Parameters
77
77
 
@@ -91,7 +91,7 @@ Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/r
91
91
  setImportedClips(clips): void;
92
92
  ```
93
93
 
94
- Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L239)
94
+ Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L239)
95
95
 
96
96
  #### Parameters
97
97
 
@@ -111,7 +111,7 @@ Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/r
111
111
  setExternalClipSources(sources): void;
112
112
  ```
113
113
 
114
- Defined in: [components/Animation.ts:276](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L276)
114
+ Defined in: [components/Animation.ts:276](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L276)
115
115
 
116
116
  #### Parameters
117
117
 
@@ -136,7 +136,7 @@ addState(
136
136
  | null;
137
137
  ```
138
138
 
139
- Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L301)
139
+ Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L301)
140
140
 
141
141
  #### Parameters
142
142
 
@@ -159,7 +159,7 @@ Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/r
159
159
  setStates(states): void;
160
160
  ```
161
161
 
162
- Defined in: [components/Animation.ts:316](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L316)
162
+ Defined in: [components/Animation.ts:316](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L316)
163
163
 
164
164
  #### Parameters
165
165
 
@@ -184,7 +184,7 @@ getStateConfigs(): {
184
184
  }[];
185
185
  ```
186
186
 
187
- Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L343)
187
+ Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L343)
188
188
 
189
189
  #### Returns
190
190
 
@@ -203,7 +203,7 @@ Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/r
203
203
  setActiveState(name, autoPlay?): boolean;
204
204
  ```
205
205
 
206
- Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L352)
206
+ Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L352)
207
207
 
208
208
  #### Parameters
209
209
 
@@ -224,7 +224,7 @@ Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/r
224
224
  removeState(name): boolean;
225
225
  ```
226
226
 
227
- Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L363)
227
+ Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L363)
228
228
 
229
229
  #### Parameters
230
230
 
@@ -244,7 +244,7 @@ Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/r
244
244
  switchState(name, autoPlay?): boolean;
245
245
  ```
246
246
 
247
- Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L371)
247
+ Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L371)
248
248
 
249
249
  #### Parameters
250
250
 
@@ -265,7 +265,7 @@ Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/r
265
265
  playState(name?): boolean;
266
266
  ```
267
267
 
268
- Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L382)
268
+ Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L382)
269
269
 
270
270
  #### Parameters
271
271
 
@@ -285,7 +285,7 @@ Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/r
285
285
  pauseState(name?): boolean;
286
286
  ```
287
287
 
288
- Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L393)
288
+ Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L393)
289
289
 
290
290
  #### Parameters
291
291
 
@@ -305,7 +305,7 @@ Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/r
305
305
  stopState(name?): boolean;
306
306
  ```
307
307
 
308
- Defined in: [components/Animation.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Animation.ts#L404)
308
+ Defined in: [components/Animation.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Animation.ts#L404)
309
309
 
310
310
  #### Parameters
311
311
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: AudioComponent
8
8
 
9
- Defined in: [components/Audio.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L27)
9
+ Defined in: [components/Audio.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L27)
10
10
 
11
11
  Plays an audio clip from `path`. Supports both global stereo (`positional:
12
12
  false`) and 3D positional audio with the configured distance model.
@@ -25,7 +25,7 @@ when the project loads and are never persisted to saved snapshots.
25
25
  new AudioComponent(path, options?): AudioComponent;
26
26
  ```
27
27
 
28
- Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L64)
28
+ Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L64)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -46,20 +46,20 @@ Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-s
46
46
 
47
47
  | Property | Type | Description | Defined in |
48
48
  | ------ | ------ | ------ | ------ |
49
- | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the audio file. | [components/Audio.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L29) |
50
- | <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `pitch`: `number`; `volume`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the clip is loaded. | | `loop` | `false` | Loop playback indefinitely. | | `pitch` | `1` | Playback rate multiplier (`1` = normal speed/pitch). | | `volume` | `1` | Linear gain in `[0, 1]`. | | `positional` | `false` | When `true`, audio is spatialized using the entity's transform. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. | | [components/Audio.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L44) |
51
- | `options.autoplay` | `boolean` | - | [components/Audio.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L9) |
52
- | `options.loop` | `boolean` | - | [components/Audio.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L10) |
53
- | `options.pitch` | `number` | - | [components/Audio.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L11) |
54
- | `options.volume` | `number` | - | [components/Audio.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L12) |
55
- | `options.positional` | `boolean` | - | [components/Audio.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L13) |
56
- | `options.refDistance` | `number` | - | [components/Audio.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L14) |
57
- | `options.distanceModel` | `string` | - | [components/Audio.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L15) |
58
- | `options.rolloffFactor` | `number` | - | [components/Audio.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L16) |
59
- | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the audio (a parented `Audio`/`PositionalAudio`). `null` until built. | [components/Audio.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L46) |
60
- | <a id="audio"></a> `audio` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | Live three.js audio source. `null` until built. Recreated when the project loads. | [components/Audio.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L48) |
61
- | <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the audio should be playing. Managed by `AudioSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Audio.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L55) |
62
- | <a id="ispaused"></a> `isPaused` | `boolean` | Whether the audio is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Audio.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L62) |
49
+ | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the audio file. | [components/Audio.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L29) |
50
+ | <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `pitch`: `number`; `volume`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the clip is loaded. | | `loop` | `false` | Loop playback indefinitely. | | `pitch` | `1` | Playback rate multiplier (`1` = normal speed/pitch). | | `volume` | `1` | Linear gain in `[0, 1]`. | | `positional` | `false` | When `true`, audio is spatialized using the entity's transform. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. | | [components/Audio.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L44) |
51
+ | `options.autoplay` | `boolean` | - | [components/Audio.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L9) |
52
+ | `options.loop` | `boolean` | - | [components/Audio.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L10) |
53
+ | `options.pitch` | `number` | - | [components/Audio.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L11) |
54
+ | `options.volume` | `number` | - | [components/Audio.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L12) |
55
+ | `options.positional` | `boolean` | - | [components/Audio.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L13) |
56
+ | `options.refDistance` | `number` | - | [components/Audio.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L14) |
57
+ | `options.distanceModel` | `string` | - | [components/Audio.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L15) |
58
+ | `options.rolloffFactor` | `number` | - | [components/Audio.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L16) |
59
+ | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the audio (a parented `Audio`/`PositionalAudio`). `null` until built. | [components/Audio.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L46) |
60
+ | <a id="audio"></a> `audio` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | Live three.js audio source. `null` until built. Recreated when the project loads. | [components/Audio.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L48) |
61
+ | <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the audio should be playing. Managed by `AudioSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Audio.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L55) |
62
+ | <a id="ispaused"></a> `isPaused` | `boolean` | Whether the audio is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Audio.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L62) |
63
63
 
64
64
  ## Methods
65
65
 
@@ -69,7 +69,7 @@ Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-s
69
69
  play(): void;
70
70
  ```
71
71
 
72
- Defined in: [components/Audio.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L98)
72
+ Defined in: [components/Audio.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L98)
73
73
 
74
74
  Signals `AudioSystem` to start (or resume) playback.
75
75
  Has no direct effect in the editor — `AudioSystem` drives the actual
@@ -87,7 +87,7 @@ THREE.js call in preview.
87
87
  pause(): void;
88
88
  ```
89
89
 
90
- Defined in: [components/Audio.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L108)
90
+ Defined in: [components/Audio.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L108)
91
91
 
92
92
  Signals `AudioSystem` to pause playback, preserving the current position.
93
93
  Calling [play](#play) afterwards resumes from where it paused.
@@ -105,7 +105,7 @@ No-op if not currently playing.
105
105
  stop(): void;
106
106
  ```
107
107
 
108
- Defined in: [components/Audio.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Audio.ts#L117)
108
+ Defined in: [components/Audio.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Audio.ts#L117)
109
109
 
110
110
  Signals `AudioSystem` to stop playback and reset the playback position.
111
111
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: CameraComponent
8
8
 
9
- Defined in: [components/Camera.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L160)
9
+ Defined in: [components/Camera.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L160)
10
10
 
11
11
  Camera entity state. Supports perspective and orthographic projections, a
12
12
  `3d` or `ar` runtime type, and an `isDefault` flag for the camera that the
@@ -25,7 +25,7 @@ zoom are persisted; the live `THREE.Camera` is recreated when the project loads.
25
25
  new CameraComponent(payload?): CameraComponent;
26
26
  ```
27
27
 
28
- Defined in: [components/Camera.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L186)
28
+ Defined in: [components/Camera.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L186)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,15 +45,15 @@ Defined in: [components/Camera.ts:186](https://github.com/Relu-Interactives/relu
45
45
 
46
46
  | Property | Type | Description | Defined in |
47
47
  | ------ | ------ | ------ | ------ |
48
- | <a id="camera"></a> `camera` | `Camera` | Live three.js camera. Recreated when the project loads to match [projection](#projection). | [components/Camera.ts:162](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L162) |
49
- | <a id="type"></a> `type` | [`CameraRuntimeType`](../type-aliases/CameraRuntimeType.md) | Runtime camera mode (`3d` or `ar`). | [components/Camera.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L164) |
50
- | <a id="isdefault"></a> `isDefault` | `boolean` | When `true`, this is the active rendering camera. Only one camera per scene should be the default. | [components/Camera.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L166) |
51
- | <a id="projection"></a> `projection` | [`CameraProjection`](../type-aliases/CameraProjection.md) | Active projection model (`perspective` or `orthographic`). | [components/Camera.ts:168](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L168) |
52
- | <a id="fov"></a> `fov` | `number` | Vertical field of view in **degrees**. Used when [projection](#projection) is `perspective`. | [components/Camera.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L170) |
53
- | <a id="near"></a> `near` | `number` | Near clip plane in world units. | [components/Camera.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L172) |
54
- | <a id="far"></a> `far` | `number` | Far clip plane in world units. | [components/Camera.ts:174](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L174) |
55
- | <a id="left"></a> `left` | `number` | Left edge of the orthographic frustum (orthographic only). | [components/Camera.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L176) |
56
- | <a id="right"></a> `right` | `number` | Right edge of the orthographic frustum (orthographic only). | [components/Camera.ts:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L178) |
57
- | <a id="top"></a> `top` | `number` | Top edge of the orthographic frustum (orthographic only). | [components/Camera.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L180) |
58
- | <a id="bottom"></a> `bottom` | `number` | Bottom edge of the orthographic frustum (orthographic only). | [components/Camera.ts:182](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L182) |
59
- | <a id="zoom"></a> `zoom` | `number` | Zoom multiplier applied to the projection. | [components/Camera.ts:184](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/Camera.ts#L184) |
48
+ | <a id="camera"></a> `camera` | `Camera` | Live three.js camera. Recreated when the project loads to match [projection](#projection). | [components/Camera.ts:162](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L162) |
49
+ | <a id="type"></a> `type` | [`CameraRuntimeType`](../type-aliases/CameraRuntimeType.md) | Runtime camera mode (`3d` or `ar`). | [components/Camera.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L164) |
50
+ | <a id="isdefault"></a> `isDefault` | `boolean` | When `true`, this is the active rendering camera. Only one camera per scene should be the default. | [components/Camera.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L166) |
51
+ | <a id="projection"></a> `projection` | [`CameraProjection`](../type-aliases/CameraProjection.md) | Active projection model (`perspective` or `orthographic`). | [components/Camera.ts:168](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L168) |
52
+ | <a id="fov"></a> `fov` | `number` | Vertical field of view in **degrees**. Used when [projection](#projection) is `perspective`. | [components/Camera.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L170) |
53
+ | <a id="near"></a> `near` | `number` | Near clip plane in world units. | [components/Camera.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L172) |
54
+ | <a id="far"></a> `far` | `number` | Far clip plane in world units. | [components/Camera.ts:174](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L174) |
55
+ | <a id="left"></a> `left` | `number` | Left edge of the orthographic frustum (orthographic only). | [components/Camera.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L176) |
56
+ | <a id="right"></a> `right` | `number` | Right edge of the orthographic frustum (orthographic only). | [components/Camera.ts:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L178) |
57
+ | <a id="top"></a> `top` | `number` | Top edge of the orthographic frustum (orthographic only). | [components/Camera.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L180) |
58
+ | <a id="bottom"></a> `bottom` | `number` | Bottom edge of the orthographic frustum (orthographic only). | [components/Camera.ts:182](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L182) |
59
+ | <a id="zoom"></a> `zoom` | `number` | Zoom multiplier applied to the projection. | [components/Camera.ts:184](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/Camera.ts#L184) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: EntityType
8
8
 
9
- Defined in: [components/EntityType.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/EntityType.ts#L12)
9
+ Defined in: [components/EntityType.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/EntityType.ts#L12)
10
10
 
11
11
  Tags an entity with the kind it was created from (`cube`, `sphere`,
12
12
  `model`, `directionalLight`, etc.). Factories use this to drive
@@ -25,7 +25,7 @@ editors.
25
25
  new EntityType(value): EntityType;
26
26
  ```
27
27
 
28
- Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/EntityType.ts#L16)
28
+ Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/EntityType.ts#L16)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,4 +45,4 @@ Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/r
45
45
 
46
46
  | Property | Type | Description | Defined in |
47
47
  | ------ | ------ | ------ | ------ |
48
- | <a id="value"></a> `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"editorUtility"` | Kind tag identifying which factory created this entity (e.g. `cube`, `directionalLight`, `model`). | [components/EntityType.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/375a01d80bdda3cdfa41b844bb575dcfc06ec96b/core/components/EntityType.ts#L14) |
48
+ | <a id="value"></a> `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"editorUtility"` | Kind tag identifying which factory created this entity (e.g. `cube`, `directionalLight`, `model`). | [components/EntityType.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/EntityType.ts#L14) |