@relu-interactives/spatial-ecs 0.2.3 → 0.2.4

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 (170) hide show
  1. package/dist/docs/api/Behaviour/classes/Behaviour.md +29 -29
  2. package/dist/docs/api/Component/classes/Component.md +1 -1
  3. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  4. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  5. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  6. package/dist/docs/api/components/classes/EntityType.md +3 -3
  7. package/dist/docs/api/components/classes/Environment.md +3 -3
  8. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  9. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  10. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  11. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  12. package/dist/docs/api/components/classes/MaterialComponent.md +11 -11
  13. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  14. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  15. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  16. package/dist/docs/api/components/classes/Name.md +3 -3
  17. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  18. package/dist/docs/api/components/classes/ParentId.md +3 -3
  19. package/dist/docs/api/components/classes/PhysicsComponent.md +6 -6
  20. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  21. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  22. package/dist/docs/api/components/classes/Selectable.md +3 -3
  23. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  24. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  25. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  26. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  27. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  28. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
  29. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
  30. package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
  31. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
  32. package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
  33. package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
  34. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
  35. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
  36. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
  37. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
  38. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
  39. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
  40. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
  41. package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
  42. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
  43. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
  44. package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
  45. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  46. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  47. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  48. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  49. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  50. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  51. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  52. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  53. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  54. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  55. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  56. package/dist/docs/api/components/type-aliases/ScriptEntry.md +9 -9
  57. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  58. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  59. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  60. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  61. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  62. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  63. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  64. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  65. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  66. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  67. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  68. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  69. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  70. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  71. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  72. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  73. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  74. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  75. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  76. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  77. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  78. package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
  79. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  80. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  81. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  82. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  83. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  84. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  85. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  86. package/dist/docs/api/index/classes/World.md +95 -81
  87. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  88. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  89. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  90. package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
  91. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  92. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  93. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  94. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  95. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  96. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  97. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  98. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  99. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  100. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  101. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  102. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  103. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  104. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  105. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  106. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  107. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  108. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  109. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  110. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  111. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  112. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  113. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  114. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  115. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  116. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  117. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  118. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  119. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +1 -1
  120. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  121. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  122. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +3 -3
  123. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  124. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  125. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  126. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  127. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  128. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  129. package/dist/docs/api/types/type-aliases/CheckboxInput.md +1 -1
  130. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  131. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  132. package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
  133. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  134. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  135. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  136. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
  137. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  138. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  139. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  140. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  141. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  142. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  143. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  144. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  145. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  146. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  147. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  148. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  149. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  150. package/dist/docs/guide/spawning/ambient-light.md +2 -2
  151. package/dist/docs/guide/spawning/area-light.md +2 -2
  152. package/dist/docs/guide/spawning/audio.md +27 -16
  153. package/dist/docs/guide/spawning/camera.md +2 -2
  154. package/dist/docs/guide/spawning/capsule.md +2 -2
  155. package/dist/docs/guide/spawning/cube.md +2 -2
  156. package/dist/docs/guide/spawning/cylinder.md +2 -2
  157. package/dist/docs/guide/spawning/directional-light.md +2 -2
  158. package/dist/docs/guide/spawning/empty.md +2 -2
  159. package/dist/docs/guide/spawning/image-target.md +2 -2
  160. package/dist/docs/guide/spawning/image.md +2 -2
  161. package/dist/docs/guide/spawning/index.md +2 -2
  162. package/dist/docs/guide/spawning/model.md +2 -2
  163. package/dist/docs/guide/spawning/plane.md +2 -2
  164. package/dist/docs/guide/spawning/point-light.md +2 -2
  165. package/dist/docs/guide/spawning/sphere.md +2 -2
  166. package/dist/docs/guide/spawning/spot-light.md +2 -2
  167. package/dist/docs/guide/spawning/sprite.md +2 -2
  168. package/dist/docs/guide/spawning/video.md +2 -2
  169. package/dist/docs/guide/world-api.md +3 -5
  170. package/package.json +1 -1
package/dist/docs/api/index/classes/VideoSystem.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: VideoSystem
8
8
 
9
- Defined in: [systems/VideoSystem.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/VideoSystem.ts#L63)
9
+ Defined in: [systems/VideoSystem.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L63)
10
10
 
11
11
  Reconciles `VideoComponent` state with the underlying HTML video element
12
12
  and THREE.js mesh/material each frame.
@@ -34,7 +34,7 @@ no-op so the editor is unaffected).
34
34
  new VideoSystem(__namedParameters?): VideoSystem;
35
35
  ```
36
36
 
37
- Defined in: [systems/VideoSystem.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/VideoSystem.ts#L70)
37
+ Defined in: [systems/VideoSystem.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L70)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -55,7 +55,7 @@ Defined in: [systems/VideoSystem.ts:70](https://github.com/Relu-Interactives/rel
55
55
  update(world, _deltaTime): void;
56
56
  ```
57
57
 
58
- Defined in: [systems/VideoSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/VideoSystem.ts#L74)
58
+ Defined in: [systems/VideoSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L74)
59
59
 
60
60
  #### Parameters
61
61
 
@@ -80,7 +80,7 @@ Defined in: [systems/VideoSystem.ts:74](https://github.com/Relu-Interactives/rel
80
80
  dispose(_world): void;
81
81
  ```
82
82
 
83
- Defined in: [systems/VideoSystem.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/VideoSystem.ts#L218)
83
+ Defined in: [systems/VideoSystem.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L218)
84
84
 
85
85
  #### Parameters
86
86