@relu-interactives/spatial-ecs 0.2.3 → 0.2.5

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 (219) hide show
  1. package/dist/{System-BTyYvKVH.d.cts → System-CIiWteft.d.cts} +2 -2
  2. package/dist/{System-BTyYvKVH.d.ts → System-CIiWteft.d.ts} +2 -2
  3. package/dist/{Video-D2H5H-K3.d.cts → Video-ChVFs9Tl.d.cts} +139 -75
  4. package/dist/{Video-BWhbvVPg.d.ts → Video-DCMCLInA.d.ts} +139 -75
  5. package/dist/{chunk-XWIEEJ7Z.js → chunk-4A66FSFT.js} +128 -82
  6. package/dist/chunk-4A66FSFT.js.map +1 -0
  7. package/dist/{chunk-AYEF3X2P.js → chunk-CRP3W2GK.js} +3 -3
  8. package/dist/chunk-CRP3W2GK.js.map +1 -0
  9. package/dist/{chunk-MAWBTMCG.js → chunk-KRZLEPRI.js} +156 -88
  10. package/dist/chunk-KRZLEPRI.js.map +1 -0
  11. package/dist/{chunk-NFDTIYR4.js → chunk-NB6I5JJN.js} +17 -2
  12. package/dist/chunk-NB6I5JJN.js.map +1 -0
  13. package/dist/{chunk-P2YDX5DB.js → chunk-RXCUHGRB.js} +124 -5
  14. package/dist/chunk-RXCUHGRB.js.map +1 -0
  15. package/dist/components/index.cjs +161 -93
  16. package/dist/components/index.cjs.map +1 -1
  17. package/dist/components/index.d.cts +2 -2
  18. package/dist/components/index.d.ts +2 -2
  19. package/dist/components/index.js +1 -1
  20. package/dist/docs/api/Behaviour/classes/Behaviour.md +29 -29
  21. package/dist/docs/api/Component/classes/Component.md +1 -1
  22. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  23. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  24. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  25. package/dist/docs/api/components/classes/EntityType.md +3 -3
  26. package/dist/docs/api/components/classes/Environment.md +3 -3
  27. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  28. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  29. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  30. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  31. package/dist/docs/api/components/classes/MaterialComponent.md +11 -11
  32. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  33. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  34. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  35. package/dist/docs/api/components/classes/Name.md +3 -3
  36. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  37. package/dist/docs/api/components/classes/ParentId.md +3 -3
  38. package/dist/docs/api/components/classes/PhysicsComponent.md +6 -6
  39. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  40. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  41. package/dist/docs/api/components/classes/Selectable.md +3 -3
  42. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  43. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  44. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  45. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  46. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  47. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
  48. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
  49. package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
  50. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
  51. package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
  52. package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
  53. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
  54. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
  55. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
  56. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
  57. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
  58. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
  59. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
  60. package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
  61. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
  62. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
  63. package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
  64. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  65. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  66. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  67. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  68. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  69. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  70. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  71. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  72. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  73. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  74. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  75. package/dist/docs/api/components/type-aliases/ScriptEntry.md +9 -9
  76. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  77. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  78. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  79. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  80. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  81. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  82. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  83. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  84. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  85. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  86. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  87. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  88. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  89. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  90. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  91. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  92. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  93. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  94. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  95. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  96. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  97. package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
  98. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  99. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  100. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  101. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  102. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  103. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  104. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  105. package/dist/docs/api/index/classes/World.md +95 -81
  106. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  107. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  108. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  109. package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
  110. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  111. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  112. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  113. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  114. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  115. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  116. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  117. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  118. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  119. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  120. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  121. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  122. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  123. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  124. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  125. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  126. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  127. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  128. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  129. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  130. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  131. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  132. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  133. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  134. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  135. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  136. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  137. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  138. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +1 -1
  139. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  140. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  141. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +3 -3
  142. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  143. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  144. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  145. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  146. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  147. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  148. package/dist/docs/api/types/type-aliases/CheckboxInput.md +1 -1
  149. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  150. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  151. package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
  152. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  153. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  154. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  155. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
  156. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  157. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  158. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  159. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  160. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  161. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  162. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  163. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  164. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  165. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  166. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  167. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  168. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  169. package/dist/docs/guide/spawning/ambient-light.md +2 -2
  170. package/dist/docs/guide/spawning/area-light.md +2 -2
  171. package/dist/docs/guide/spawning/audio.md +27 -16
  172. package/dist/docs/guide/spawning/camera.md +2 -2
  173. package/dist/docs/guide/spawning/capsule.md +2 -2
  174. package/dist/docs/guide/spawning/cube.md +2 -2
  175. package/dist/docs/guide/spawning/cylinder.md +2 -2
  176. package/dist/docs/guide/spawning/directional-light.md +2 -2
  177. package/dist/docs/guide/spawning/empty.md +2 -2
  178. package/dist/docs/guide/spawning/image-target.md +2 -2
  179. package/dist/docs/guide/spawning/image.md +2 -2
  180. package/dist/docs/guide/spawning/index.md +2 -2
  181. package/dist/docs/guide/spawning/model.md +2 -2
  182. package/dist/docs/guide/spawning/plane.md +2 -2
  183. package/dist/docs/guide/spawning/point-light.md +2 -2
  184. package/dist/docs/guide/spawning/sphere.md +2 -2
  185. package/dist/docs/guide/spawning/spot-light.md +2 -2
  186. package/dist/docs/guide/spawning/sprite.md +2 -2
  187. package/dist/docs/guide/spawning/video.md +2 -2
  188. package/dist/docs/guide/world-api.md +3 -5
  189. package/dist/factories/index.cjs +217 -105
  190. package/dist/factories/index.cjs.map +1 -1
  191. package/dist/factories/index.d.cts +9 -3
  192. package/dist/factories/index.d.ts +9 -3
  193. package/dist/factories/index.js +3 -3
  194. package/dist/{index-KdEzEZox.d.cts → index-D1I5L7bA.d.cts} +8 -3
  195. package/dist/{index-Dm6zF1MY.d.ts → index-DGZDgt3p.d.ts} +8 -3
  196. package/dist/index.cjs +468 -179
  197. package/dist/index.cjs.map +1 -1
  198. package/dist/index.d.cts +7 -7
  199. package/dist/index.d.ts +7 -7
  200. package/dist/index.js +51 -12
  201. package/dist/index.js.map +1 -1
  202. package/dist/systems/index.cjs +248 -63
  203. package/dist/systems/index.cjs.map +1 -1
  204. package/dist/systems/index.d.cts +15 -3
  205. package/dist/systems/index.d.ts +15 -3
  206. package/dist/systems/index.js +3 -3
  207. package/dist/types.d.cts +1 -1
  208. package/dist/types.d.ts +1 -1
  209. package/dist/worldSnapshotUtils.cjs +15 -0
  210. package/dist/worldSnapshotUtils.cjs.map +1 -1
  211. package/dist/worldSnapshotUtils.d.cts +1 -1
  212. package/dist/worldSnapshotUtils.d.ts +1 -1
  213. package/dist/worldSnapshotUtils.js +1 -1
  214. package/package.json +1 -1
  215. package/dist/chunk-AYEF3X2P.js.map +0 -1
  216. package/dist/chunk-MAWBTMCG.js.map +0 -1
  217. package/dist/chunk-NFDTIYR4.js.map +0 -1
  218. package/dist/chunk-P2YDX5DB.js.map +0 -1
  219. package/dist/chunk-XWIEEJ7Z.js.map +0 -1
@@ -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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/EntityType.ts#L12)
9
+ Defined in: [components/EntityType.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/EntityType.ts#L16)
28
+ Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/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"` \| `"cylinder"` \| `"cube"` \| `"sphere"` \| `"plane"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/EntityType.ts#L14) |
48
+ | <a id="value"></a> `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cylinder"` \| `"cube"` \| `"sphere"` \| `"plane"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"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/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/EntityType.ts#L14) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Environment
8
8
 
9
- Defined in: [components/Environment.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L160)
9
+ Defined in: [components/Environment.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L160)
10
10
 
11
11
  Scene environment settings: skybox (gradient/color/image), fog
12
12
  (linear/exponential), and gravity vector for the physics world.
@@ -24,7 +24,7 @@ Singleton-style — attached to one environment entity per scene.
24
24
  new Environment(values?): Environment;
25
25
  ```
26
26
 
27
- Defined in: [components/Environment.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L164)
27
+ Defined in: [components/Environment.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L164)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -44,4 +44,4 @@ Defined in: [components/Environment.ts:164](https://github.com/Relu-Interactives
44
44
 
45
45
  | Property | Type | Description | Defined in |
46
46
  | ------ | ------ | ------ | ------ |
47
- | <a id="values"></a> `values` | [`EnvironmentState`](../type-aliases/EnvironmentState.md) | Aggregated environment authoring state (skybox, fog, gravity). Saved with the project. | [components/Environment.ts:162](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L162) |
47
+ | <a id="values"></a> `values` | [`EnvironmentState`](../type-aliases/EnvironmentState.md) | Aggregated environment authoring state (skybox, fog, gravity). Saved with the project. | [components/Environment.ts:162](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Environment.ts#L162) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ImageComponent
8
8
 
9
- Defined in: [components/Image.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L13)
9
+ Defined in: [components/Image.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L13)
10
10
 
11
11
  Renders a 2D image as a textured quad in the scene. Width/height are in
12
12
  world units. Texture loading is handled by the image system, which
@@ -28,7 +28,7 @@ new ImageComponent(
28
28
  height?): ImageComponent;
29
29
  ```
30
30
 
31
- Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L25)
31
+ Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L25)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -50,8 +50,8 @@ Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-s
50
50
 
51
51
  | Property | Type | Description | Defined in |
52
52
  | ------ | ------ | ------ | ------ |
53
- | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the image file. | [components/Image.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L15) |
54
- | <a id="width"></a> `width` | `number` | Width of the rendered quad in world units. | [components/Image.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L17) |
55
- | <a id="height"></a> `height` | `number` | Height of the rendered quad in world units. | [components/Image.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L19) |
56
- | <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously by the image system. `null` until loaded. | [components/Image.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L21) |
57
- | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object representing the textured quad. `null` until built. | [components/Image.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Image.ts#L23) |
53
+ | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the image file. | [components/Image.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L15) |
54
+ | <a id="width"></a> `width` | `number` | Width of the rendered quad in world units. | [components/Image.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L17) |
55
+ | <a id="height"></a> `height` | `number` | Height of the rendered quad in world units. | [components/Image.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L19) |
56
+ | <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously by the image system. `null` until loaded. | [components/Image.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L21) |
57
+ | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object representing the textured quad. `null` until built. | [components/Image.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Image.ts#L23) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ImageTarget
8
8
 
9
- Defined in: [components/ImageTarget.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L29)
9
+ Defined in: [components/ImageTarget.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L29)
10
10
 
11
11
  Image-tracking target metadata used by AR projects. Holds the source images
12
12
  users uploaded plus the URL of the compiled `.mind` target file produced by
@@ -28,7 +28,7 @@ new ImageTarget(
28
28
  object?): ImageTarget;
29
29
  ```
30
30
 
31
- Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L41)
31
+ Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L41)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -53,8 +53,8 @@ Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/
53
53
 
54
54
  | Property | Type | Description | Defined in |
55
55
  | ------ | ------ | ------ | ------ |
56
- | <a id="targets"></a> `targets` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] | Source images that were combined into the compiled `.mind` target. | [components/ImageTarget.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L31) |
57
- | <a id="compiledtargeturl"></a> `compiledTargetUrl?` | `string` | URL of the compiled `.mind` target file. Set after the image-target compiler finishes. | [components/ImageTarget.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L33) |
58
- | <a id="compiledtargetdir"></a> `compiledTargetDir?` | `string` | Directory containing the compiled `.mind` file (desktop projects). | [components/ImageTarget.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L35) |
59
- | <a id="texture"></a> `texture` | `Texture` \| `null` | Optional preview texture used in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L37) |
60
- | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Optional preview object placed in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L39) |
56
+ | <a id="targets"></a> `targets` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] | Source images that were combined into the compiled `.mind` target. | [components/ImageTarget.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L31) |
57
+ | <a id="compiledtargeturl"></a> `compiledTargetUrl?` | `string` | URL of the compiled `.mind` target file. Set after the image-target compiler finishes. | [components/ImageTarget.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L33) |
58
+ | <a id="compiledtargetdir"></a> `compiledTargetDir?` | `string` | Directory containing the compiled `.mind` file (desktop projects). | [components/ImageTarget.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L35) |
59
+ | <a id="texture"></a> `texture` | `Texture` \| `null` | Optional preview texture used in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L37) |
60
+ | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Optional preview object placed in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTarget.ts#L39) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ImageTargetAnchor
8
8
 
9
- Defined in: [components/ImageTargetAnchor.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L18)
9
+ Defined in: [components/ImageTargetAnchor.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L18)
10
10
 
11
11
  Marks an entity as an anchor for an image-tracking target. The image
12
12
  tracking system reveals the entity when the referenced target is found and
@@ -24,7 +24,7 @@ hides it when the target is lost.
24
24
  new ImageTargetAnchor(options?): ImageTargetAnchor;
25
25
  ```
26
26
 
27
- Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L24)
27
+ Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L24)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -44,5 +44,5 @@ Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interac
44
44
 
45
45
  | Property | Type | Description | Defined in |
46
46
  | ------ | ------ | ------ | ------ |
47
- | <a id="targetid"></a> `targetId` | `number` \| `null` | Tracked target id this anchor follows. `null` when unbound. | [components/ImageTargetAnchor.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L20) |
48
- | <a id="targeturl"></a> `targetUrl?` | `string` | Canonical target image URL, retained as a fallback identifier. | [components/ImageTargetAnchor.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L22) |
47
+ | <a id="targetid"></a> `targetId` | `number` \| `null` | Tracked target id this anchor follows. `null` when unbound. | [components/ImageTargetAnchor.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L20) |
48
+ | <a id="targeturl"></a> `targetUrl?` | `string` | Canonical target image URL, retained as a fallback identifier. | [components/ImageTargetAnchor.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ImageTargetAnchor.ts#L22) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: LightComponent
8
8
 
9
- Defined in: [components/Light.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L65)
9
+ Defined in: [components/Light.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L65)
10
10
 
11
11
  Light source attached to an entity. `type` selects the underlying three.js
12
12
  light class (directional, point, spot, ambient, hemisphere, rect-area).
@@ -25,7 +25,7 @@ type-specific fields (distance, decay, angle, penumbra, width, height).
25
25
  new LightComponent(light): LightComponent;
26
26
  ```
27
27
 
28
- Defined in: [components/Light.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L73)
28
+ Defined in: [components/Light.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L73)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,9 +45,9 @@ Defined in: [components/Light.ts:73](https://github.com/Relu-Interactives/relu-s
45
45
 
46
46
  | Property | Type | Description | Defined in |
47
47
  | ------ | ------ | ------ | ------ |
48
- | <a id="light"></a> `light` | `Light` | Live three.js light placed in the scene. Recreated when the project loads. | [components/Light.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L67) |
49
- | <a id="type"></a> `type` | `string` | Three.js class name of the light (e.g. `"DirectionalLight"`, `"PointLight"`, `"SpotLight"`). | [components/Light.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L69) |
50
- | <a id="values"></a> `values` | [`LightValueState`](../type-aliases/LightValueState.md) | Serialized authoring state. Saved with the project. | [components/Light.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L71) |
48
+ | <a id="light"></a> `light` | `Light` | Live three.js light placed in the scene. Recreated when the project loads. | [components/Light.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L67) |
49
+ | <a id="type"></a> `type` | `string` | Three.js class name of the light (e.g. `"DirectionalLight"`, `"PointLight"`, `"SpotLight"`). | [components/Light.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L69) |
50
+ | <a id="values"></a> `values` | [`LightValueState`](../type-aliases/LightValueState.md) | Serialized authoring state. Saved with the project. | [components/Light.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L71) |
51
51
 
52
52
  ## Methods
53
53
 
@@ -57,7 +57,7 @@ Defined in: [components/Light.ts:73](https://github.com/Relu-Interactives/relu-s
57
57
  setValues(patch): void;
58
58
  ```
59
59
 
60
- Defined in: [components/Light.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L80)
60
+ Defined in: [components/Light.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Light.ts#L80)
61
61
 
62
62
  #### Parameters
63
63
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MaterialComponent
8
8
 
9
- Defined in: [components/Material.ts:190](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L190)
9
+ Defined in: [components/Material.ts:190](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L190)
10
10
 
11
11
  Material catalog for an entity. Tracks the live three.js materials
12
12
  (`materials`, `material`) plus serialized authoring state (`values[]`)
@@ -32,7 +32,7 @@ inside the editor.
32
32
  new MaterialComponent(materialOrMaterials?): MaterialComponent;
33
33
  ```
34
34
 
35
- Defined in: [components/Material.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L198)
35
+ Defined in: [components/Material.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L198)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -52,9 +52,9 @@ Defined in: [components/Material.ts:198](https://github.com/Relu-Interactives/re
52
52
 
53
53
  | Property | Type | Description | Defined in |
54
54
  | ------ | ------ | ------ | ------ |
55
- | <a id="materials"></a> `materials` | `Material`[] | Live three.js materials currently bound to the entity's mesh (one per submesh). | [components/Material.ts:192](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L192) |
56
- | <a id="material"></a> `material` | `Material` \| `null` | Convenience reference to `materials[0]`. `null` when no material is assigned. | [components/Material.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L194) |
57
- | <a id="values"></a> `values` | [`MaterialValueState`](../type-aliases/MaterialValueState.md)[] | Serialized authoring state (one entry per material in [materials](#materials)). Saved with the project. | [components/Material.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L196) |
55
+ | <a id="materials"></a> `materials` | `Material`[] | Live three.js materials currently bound to the entity's mesh (one per submesh). | [components/Material.ts:192](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L192) |
56
+ | <a id="material"></a> `material` | `Material` \| `null` | Convenience reference to `materials[0]`. `null` when no material is assigned. | [components/Material.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L194) |
57
+ | <a id="values"></a> `values` | [`MaterialValueState`](../type-aliases/MaterialValueState.md)[] | Serialized authoring state (one entry per material in [materials](#materials)). Saved with the project. | [components/Material.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L196) |
58
58
 
59
59
  ## Methods
60
60
 
@@ -64,7 +64,7 @@ Defined in: [components/Material.ts:198](https://github.com/Relu-Interactives/re
64
64
  setMaterials(materialOrMaterials?): void;
65
65
  ```
66
66
 
67
- Defined in: [components/Material.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L207)
67
+ Defined in: [components/Material.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L207)
68
68
 
69
69
  #### Parameters
70
70
 
@@ -84,7 +84,7 @@ Defined in: [components/Material.ts:207](https://github.com/Relu-Interactives/re
84
84
  updateValue(index, patch): void;
85
85
  ```
86
86
 
87
- Defined in: [components/Material.ts:223](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L223)
87
+ Defined in: [components/Material.ts:223](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L223)
88
88
 
89
89
  #### Parameters
90
90
 
@@ -105,7 +105,7 @@ Defined in: [components/Material.ts:223](https://github.com/Relu-Interactives/re
105
105
  resetValue(index): void;
106
106
  ```
107
107
 
108
- Defined in: [components/Material.ts:238](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L238)
108
+ Defined in: [components/Material.ts:238](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L238)
109
109
 
110
110
  #### Parameters
111
111
 
@@ -125,7 +125,7 @@ Defined in: [components/Material.ts:238](https://github.com/Relu-Interactives/re
125
125
  setMaterialType(index, type): void;
126
126
  ```
127
127
 
128
- Defined in: [components/Material.ts:254](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L254)
128
+ Defined in: [components/Material.ts:254](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L254)
129
129
 
130
130
  #### Parameters
131
131
 
@@ -146,7 +146,7 @@ Defined in: [components/Material.ts:254](https://github.com/Relu-Interactives/re
146
146
  setTextureFiltering(index, filtering): void;
147
147
  ```
148
148
 
149
- Defined in: [components/Material.ts:258](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L258)
149
+ Defined in: [components/Material.ts:258](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L258)
150
150
 
151
151
  #### Parameters
152
152
 
@@ -167,7 +167,7 @@ Defined in: [components/Material.ts:258](https://github.com/Relu-Interactives/re
167
167
  setUseMipmaps(index, enabled): void;
168
168
  ```
169
169
 
170
- Defined in: [components/Material.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L262)
170
+ Defined in: [components/Material.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Material.ts#L262)
171
171
 
172
172
  #### Parameters
173
173
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MeshComponent
8
8
 
9
- Defined in: [components/Mesh.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L13)
9
+ Defined in: [components/Mesh.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Mesh.ts#L13)
10
10
 
11
11
  Holds the live three.js `Object3D` for an entity that renders as a primitive
12
12
  mesh (cube, sphere, plane, capsule, cylinder). For loaded GLTF/GLB models
@@ -25,7 +25,7 @@ see [ModelComponent](ModelComponent.md); for the editable geometry parameters se
25
25
  new MeshComponent(mesh): MeshComponent;
26
26
  ```
27
27
 
28
- Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L17)
28
+ Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Mesh.ts#L17)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,4 +45,4 @@ Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-sp
45
45
 
46
46
  | Property | Type | Description | Defined in |
47
47
  | ------ | ------ | ------ | ------ |
48
- | <a id="mesh"></a> `mesh` | `Object3D` | Underlying three.js mesh placed in the scene graph. | [components/Mesh.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L15) |
48
+ | <a id="mesh"></a> `mesh` | `Object3D` | Underlying three.js mesh placed in the scene graph. | [components/Mesh.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Mesh.ts#L15) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MeshGeometryComponent
8
8
 
9
- Defined in: [components/MeshGeometry.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L88)
9
+ Defined in: [components/MeshGeometry.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L88)
10
10
 
11
11
  Editable geometry parameters for primitive meshes (cube, sphere, plane,
12
12
  capsule, cylinder) and the placeholder for `model` entities. Holds the
@@ -29,7 +29,7 @@ new MeshGeometryComponent(
29
29
  options?): MeshGeometryComponent;
30
30
  ```
31
31
 
32
- Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L104)
32
+ Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L104)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -55,10 +55,10 @@ Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactive
55
55
 
56
56
  | Property | Modifier | Type | Description | Defined in |
57
57
  | ------ | ------ | ------ | ------ | ------ |
58
- | <a id="kind"></a> `kind` | `readonly` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) | Primitive kind (`cube`, `sphere`, `plane`, `capsule`, `cylinder`) or `model` for loaded assets. | [components/MeshGeometry.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L90) |
59
- | <a id="geometrytype"></a> `geometryType` | `readonly` | `string` | Three.js geometry class name (e.g. `"BoxGeometry"`, `"SphereGeometry"`). Derived from [kind](#kind). | [components/MeshGeometry.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L92) |
60
- | <a id="parameters"></a> `parameters` | `public` | [`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md) | Editable parameters whose shape depends on [kind](#kind). The mesh-geometry system rebuilds geometry when these change. | [components/MeshGeometry.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L94) |
61
- | <a id="object"></a> `object` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object whose geometry is being managed. `null` until the object is built. | [components/MeshGeometry.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L96) |
62
- | <a id="modelname"></a> `modelName` | `public` | `string` | Human-readable model name shown in the inspector for `model` entities; empty for primitives. | [components/MeshGeometry.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L98) |
63
- | <a id="castshadow"></a> `castShadow` | `public` | `boolean` | Whether the mesh casts shadows in the renderer. | [components/MeshGeometry.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L100) |
64
- | <a id="receiveshadow"></a> `receiveShadow` | `public` | `boolean` | Whether the mesh receives shadows in the renderer. | [components/MeshGeometry.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L102) |
58
+ | <a id="kind"></a> `kind` | `readonly` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) | Primitive kind (`cube`, `sphere`, `plane`, `capsule`, `cylinder`) or `model` for loaded assets. | [components/MeshGeometry.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L90) |
59
+ | <a id="geometrytype"></a> `geometryType` | `readonly` | `string` | Three.js geometry class name (e.g. `"BoxGeometry"`, `"SphereGeometry"`). Derived from [kind](#kind). | [components/MeshGeometry.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L92) |
60
+ | <a id="parameters"></a> `parameters` | `public` | [`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md) | Editable parameters whose shape depends on [kind](#kind). The mesh-geometry system rebuilds geometry when these change. | [components/MeshGeometry.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L94) |
61
+ | <a id="object"></a> `object` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object whose geometry is being managed. `null` until the object is built. | [components/MeshGeometry.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L96) |
62
+ | <a id="modelname"></a> `modelName` | `public` | `string` | Human-readable model name shown in the inspector for `model` entities; empty for primitives. | [components/MeshGeometry.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L98) |
63
+ | <a id="castshadow"></a> `castShadow` | `public` | `boolean` | Whether the mesh casts shadows in the renderer. | [components/MeshGeometry.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L100) |
64
+ | <a id="receiveshadow"></a> `receiveShadow` | `public` | `boolean` | Whether the mesh receives shadows in the renderer. | [components/MeshGeometry.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/MeshGeometry.ts#L102) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ModelComponent
8
8
 
9
- Defined in: [components/Model.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L13)
9
+ Defined in: [components/Model.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Model.ts#L13)
10
10
 
11
11
  References a GLTF/GLB asset loaded from `path`. The model loading system
12
12
  resolves the asset asynchronously and populates [ModelComponent.object](#object)
@@ -25,7 +25,7 @@ the model finishes loading.
25
25
  new ModelComponent(path): ModelComponent;
26
26
  ```
27
27
 
28
- Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L19)
28
+ Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Model.ts#L19)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -45,5 +45,5 @@ Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-s
45
45
 
46
46
  | Property | Type | Description | Defined in |
47
47
  | ------ | ------ | ------ | ------ |
48
- | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the GLTF/GLB asset. | [components/Model.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L15) |
49
- | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Loaded model object, populated asynchronously by the model loader. `null` until loaded. | [components/Model.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L17) |
48
+ | <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the GLTF/GLB asset. | [components/Model.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Model.ts#L15) |
49
+ | <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Loaded model object, populated asynchronously by the model loader. `null` until loaded. | [components/Model.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Model.ts#L17) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Name
8
8
 
9
- Defined in: [components/Name.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L9)
9
+ Defined in: [components/Name.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Name.ts#L9)
10
10
 
11
11
  Human-readable name for an entity. Shown in the editor hierarchy panel and
12
12
  preserved across save/reload.
@@ -23,7 +23,7 @@ preserved across save/reload.
23
23
  new Name(value): Name;
24
24
  ```
25
25
 
26
- Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L13)
26
+ Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Name.ts#L13)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -43,4 +43,4 @@ Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-sp
43
43
 
44
44
  | Property | Type | Description | Defined in |
45
45
  | ------ | ------ | ------ | ------ |
46
- | <a id="value"></a> `value` | `string` | Display name for the entity. Shown in the editor hierarchy. | [components/Name.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L11) |
46
+ | <a id="value"></a> `value` | `string` | Display name for the entity. Shown in the editor hierarchy. | [components/Name.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Name.ts#L11) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Object3DRef
8
8
 
9
- Defined in: [components/Object3DRef.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L16)
9
+ Defined in: [components/Object3DRef.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Object3DRef.ts#L16)
10
10
 
11
11
  Wraps the live `THREE.Object3D` for an entity. Almost every entity that
12
12
  renders to the scene carries an `Object3DRef` so transform sync, selection,
@@ -29,7 +29,7 @@ fresh inside system/script hooks rather than caching it across frames.
29
29
  new Object3DRef(object, visibility?): Object3DRef;
30
30
  ```
31
31
 
32
- Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L22)
32
+ Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Object3DRef.ts#L22)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -50,5 +50,5 @@ Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/
50
50
 
51
51
  | Property | Type | Description | Defined in |
52
52
  | ------ | ------ | ------ | ------ |
53
- | <a id="object"></a> `object` | `Object3D` | Live three.js object placed in the scene graph. May be replaced when assets finish loading. | [components/Object3DRef.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L18) |
54
- | <a id="visibility"></a> `visibility` | `boolean` | Whether the object is currently visible. Mirrors `object.visible` and is preserved across reloads. | [components/Object3DRef.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L20) |
53
+ | <a id="object"></a> `object` | `Object3D` | Live three.js object placed in the scene graph. May be replaced when assets finish loading. | [components/Object3DRef.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Object3DRef.ts#L18) |
54
+ | <a id="visibility"></a> `visibility` | `boolean` | Whether the object is currently visible. Mirrors `object.visible` and is preserved across reloads. | [components/Object3DRef.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Object3DRef.ts#L20) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ParentId
8
8
 
9
- Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L11)
9
+ Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ParentId.ts#L11)
10
10
 
11
11
  Records the parent entity id for hierarchical scene graphs. `null` means
12
12
  the entity is at the world root. The `ObjectManagementSystem` reconciles
@@ -24,7 +24,7 @@ scene-graph parenting from this component each frame.
24
24
  new ParentId(value?): ParentId;
25
25
  ```
26
26
 
27
- Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L15)
27
+ Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ParentId.ts#L15)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -44,4 +44,4 @@ Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/rel
44
44
 
45
45
  | Property | Type | Description | Defined in |
46
46
  | ------ | ------ | ------ | ------ |
47
- | <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L13) |
47
+ | <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ParentId.ts#L13) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: PhysicsComponent
8
8
 
9
- Defined in: [components/Physics.ts:350](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L350)
9
+ Defined in: [components/Physics.ts:350](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L350)
10
10
 
11
11
  Unified physics component combining a Rapier rigid body and a Rapier
12
12
  collider into a single authoring and runtime container.
@@ -30,7 +30,7 @@ system when the project loads and are `null` until physics is initialized.
30
30
  new PhysicsComponent(values?): PhysicsComponent;
31
31
  ```
32
32
 
33
- Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L358)
33
+ Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L358)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -52,9 +52,9 @@ Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/rel
52
52
 
53
53
  | Property | Type | Description | Defined in |
54
54
  | ------ | ------ | ------ | ------ |
55
- | <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L352) |
56
- | <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. | [components/Physics.ts:354](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L354) |
57
- | <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. | [components/Physics.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L356) |
55
+ | <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L352) |
56
+ | <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. | [components/Physics.ts:354](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L354) |
57
+ | <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. | [components/Physics.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L356) |
58
58
 
59
59
  ## Methods
60
60
 
@@ -64,7 +64,7 @@ Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/rel
64
64
  setValues(patch): void;
65
65
  ```
66
66
 
67
- Defined in: [components/Physics.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L369)
67
+ Defined in: [components/Physics.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Physics.ts#L369)
68
68
 
69
69
  Patch rigidbody and/or collider state. Each sub-object is deep-merged
70
70
  with the current values via the respective normalizer.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Postprocessing
8
8
 
9
- Defined in: [components/Postprocessing.ts:427](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L427)
9
+ Defined in: [components/Postprocessing.ts:427](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L427)
10
10
 
11
11
  Postprocessing stack settings (depth-of-field, bloom, vignette, chromatic
12
12
  aberration, noise, pixelation, tone mapping, hue/saturation, sepia, SMAA,
@@ -26,7 +26,7 @@ style — attached to one entity per scene.
26
26
  new Postprocessing(values?): Postprocessing;
27
27
  ```
28
28
 
29
- Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L431)
29
+ Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L431)
30
30
 
31
31
  #### Parameters
32
32
 
@@ -46,4 +46,4 @@ Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interacti
46
46
 
47
47
  | Property | Type | Description | Defined in |
48
48
  | ------ | ------ | ------ | ------ |
49
- | <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:429](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L429) |
49
+ | <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:429](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Postprocessing.ts#L429) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ScriptComponent
8
8
 
9
- Defined in: [components/ScriptComponent.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L42)
9
+ Defined in: [components/ScriptComponent.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ScriptComponent.ts#L42)
10
10
 
11
11
  Component holding the list of [scripts](../type-aliases/ScriptEntry.md) attached to an
12
12
  entity. Loaded from the saved project; the runtime-side fields
@@ -29,7 +29,7 @@ Authored scripts subclass [Behaviour](../../Behaviour/index.md).
29
29
  new ScriptComponent(entries?): ScriptComponent;
30
30
  ```
31
31
 
32
- Defined in: [components/ScriptComponent.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L50)
32
+ Defined in: [components/ScriptComponent.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ScriptComponent.ts#L50)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -49,6 +49,6 @@ Defined in: [components/ScriptComponent.ts:50](https://github.com/Relu-Interacti
49
49
 
50
50
  | Property | Type | Description | Defined in |
51
51
  | ------ | ------ | ------ | ------ |
52
- | <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L44) |
53
- | <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L46) |
54
- | <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ScriptComponent.ts#L48) |
52
+ | <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ScriptComponent.ts#L44) |
53
+ | <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ScriptComponent.ts#L46) |
54
+ | <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/ScriptComponent.ts#L48) |
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Selectable
8
8
 
9
- Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Selectable.ts#L9)
9
+ Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Selectable.ts#L9)
10
10
 
11
11
  Toggles whether the editor selection system can pick this entity. When
12
12
  `enabled` is `false`, the entity is excluded from raycast hit tests.
@@ -23,7 +23,7 @@ Toggles whether the editor selection system can pick this entity. When
23
23
  new Selectable(enabled?): Selectable;
24
24
  ```
25
25
 
26
- Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Selectable.ts#L13)
26
+ Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Selectable.ts#L13)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -43,4 +43,4 @@ Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/r
43
43
 
44
44
  | Property | Type | Description | Defined in |
45
45
  | ------ | ------ | ------ | ------ |
46
- | <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Selectable.ts#L11) |
46
+ | <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/components/Selectable.ts#L11) |