@relu-interactives/spatial-ecs 0.2.10 → 0.2.12

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 (209) hide show
  1. package/dist/{System-AV2_87Zr.d.cts → System-CHCucemW.d.cts} +24 -2
  2. package/dist/{System-AV2_87Zr.d.ts → System-CHCucemW.d.ts} +24 -2
  3. package/dist/{Video-D6mObK_5.d.ts → Video-ACTSfWjH.d.cts} +2 -2
  4. package/dist/{Video-Bn93p6XV.d.cts → Video-B9ZKmBIT.d.ts} +2 -2
  5. package/dist/{chunk-Y7KXYSPD.js → chunk-ON4E5E5O.js} +4 -4
  6. package/dist/{chunk-Y7KXYSPD.js.map → chunk-ON4E5E5O.js.map} +1 -1
  7. package/dist/{chunk-ODCWJHPS.js → chunk-PH43YHUT.js} +40 -4
  8. package/dist/chunk-PH43YHUT.js.map +1 -0
  9. package/dist/{chunk-AZR6SLQN.js → chunk-XPCVEXMY.js} +2 -2
  10. package/dist/{chunk-AZR6SLQN.js.map → chunk-XPCVEXMY.js.map} +1 -1
  11. package/dist/{chunk-LE6ARNYQ.js → chunk-ZCEMOTH4.js} +4 -4
  12. package/dist/{chunk-LE6ARNYQ.js.map → chunk-ZCEMOTH4.js.map} +1 -1
  13. package/dist/components/index.cjs.map +1 -1
  14. package/dist/components/index.d.cts +2 -2
  15. package/dist/components/index.d.ts +2 -2
  16. package/dist/components/index.js +1 -1
  17. package/dist/docs/api/Behaviour/classes/Behaviour.md +29 -29
  18. package/dist/docs/api/Component/classes/Component.md +3 -1
  19. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  20. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  21. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  22. package/dist/docs/api/components/classes/EntityType.md +4 -4
  23. package/dist/docs/api/components/classes/Environment.md +3 -3
  24. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  25. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  26. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  27. package/dist/docs/api/components/classes/InstanceSlotComponent.md +52 -0
  28. package/dist/docs/api/components/classes/InstancedMeshComponent.md +82 -0
  29. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  30. package/dist/docs/api/components/classes/MaterialComponent.md +11 -11
  31. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  32. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  33. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  34. package/dist/docs/api/components/classes/Name.md +3 -3
  35. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  36. package/dist/docs/api/components/classes/ParentId.md +3 -3
  37. package/dist/docs/api/components/classes/PhysicsComponent.md +6 -6
  38. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  39. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  40. package/dist/docs/api/components/classes/Selectable.md +3 -3
  41. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  42. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  43. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  44. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  45. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  46. package/dist/docs/api/components/index.md +6 -0
  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/InstanceTransform.md +49 -0
  64. package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +15 -0
  65. package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
  66. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  67. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  68. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  69. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  70. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  71. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  72. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  73. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  74. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  75. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  76. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  77. package/dist/docs/api/components/type-aliases/ScriptEntry.md +9 -9
  78. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  79. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  80. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  81. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  82. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  83. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  84. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  85. package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +15 -0
  86. package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +15 -0
  87. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  88. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  89. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  90. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  91. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  92. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  93. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  94. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  95. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  96. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  97. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  98. package/dist/docs/api/index/classes/InstancedMeshSystem.md +62 -0
  99. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  100. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  101. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  102. package/dist/docs/api/index/classes/ObjectManagementSystem.md +39 -19
  103. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  104. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  105. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  106. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  107. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  108. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  109. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  110. package/dist/docs/api/index/classes/World.md +82 -82
  111. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  112. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  113. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  114. package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
  115. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  116. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  117. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  118. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  119. package/dist/docs/api/index/functions/createInstanceSlotComponent.md +30 -0
  120. package/dist/docs/api/index/functions/createInstancedMeshComponent.md +36 -0
  121. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  122. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  123. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  124. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  125. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  126. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  127. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  128. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  129. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  130. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  131. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  132. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  133. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  134. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  135. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  136. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  137. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  138. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  139. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  140. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  141. package/dist/docs/api/index/index.md +3 -0
  142. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  143. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  144. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  145. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  146. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +3 -2
  147. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  148. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  149. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +3 -3
  150. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  151. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  152. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  153. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  154. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  155. package/dist/docs/api/typedoc-sidebar.json +1 -1
  156. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  157. package/dist/docs/api/types/type-aliases/CheckboxInput.md +1 -1
  158. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  159. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  160. package/dist/docs/api/types/type-aliases/ComponentKind.md +3 -1
  161. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  162. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  163. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  164. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +4 -2
  165. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  166. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  167. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  168. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  169. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  170. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  171. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  172. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  173. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  174. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  175. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  176. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  177. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  178. package/dist/docs/guide/component-catalog.md +2 -0
  179. package/dist/docs/guide/components/animation.md +40 -1
  180. package/dist/docs/guide/components/instance-slot.md +102 -0
  181. package/dist/docs/guide/components/instanced-mesh.md +186 -0
  182. package/dist/docs/guide/spawning/audio.md +29 -7
  183. package/dist/docs/guide/spawning/index.md +4 -0
  184. package/dist/docs/guide/spawning/instanced-mesh.md +267 -0
  185. package/dist/docs/guide/systems/_sidebar.json +4 -0
  186. package/dist/docs/guide/systems/instanced-mesh-system.md +32 -0
  187. package/dist/docs/guide/systems/object-management-system.md +9 -0
  188. package/dist/factories/index.cjs.map +1 -1
  189. package/dist/factories/index.d.cts +2 -2
  190. package/dist/factories/index.d.ts +2 -2
  191. package/dist/factories/index.js +3 -3
  192. package/dist/{index-BO49V8aS.d.ts → index-B5JcGMJ5.d.ts} +2 -2
  193. package/dist/{index-B4-ABchF.d.cts → index-kx5O2mVU.d.cts} +2 -2
  194. package/dist/index.cjs +37 -1
  195. package/dist/index.cjs.map +1 -1
  196. package/dist/index.d.cts +5 -5
  197. package/dist/index.d.ts +5 -5
  198. package/dist/index.js +8 -8
  199. package/dist/systems/index.cjs +37 -1
  200. package/dist/systems/index.cjs.map +1 -1
  201. package/dist/systems/index.d.cts +2 -2
  202. package/dist/systems/index.d.ts +2 -2
  203. package/dist/systems/index.js +3 -3
  204. package/dist/types.d.cts +1 -1
  205. package/dist/types.d.ts +1 -1
  206. package/dist/worldSnapshotUtils.d.cts +1 -1
  207. package/dist/worldSnapshotUtils.d.ts +1 -1
  208. package/package.json +1 -1
  209. package/dist/chunk-ODCWJHPS.js.map +0 -1
@@ -0,0 +1,62 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / InstancedMeshSystem
6
+
7
+ # Class: InstancedMeshSystem
8
+
9
+ Defined in: [systems/InstancedMeshSystem.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/InstancedMeshSystem.ts#L128)
10
+
11
+ Maintains the runtime geometry for entities with an [InstancedMeshComponent](../../components/classes/InstancedMeshComponent.md).
12
+
13
+ - **Primitive kinds** (`cube`, `sphere`, `plane`, `cylinder`, `capsule`): creates a single
14
+ `THREE.InstancedMesh` on the anchor and writes per-instance matrices every frame.
15
+ - **Model kind** (`model`): asynchronously loads the GLTF/GLB at `comp.modelPath`, traverses
16
+ the scene to collect all `THREE.Mesh` nodes, and creates one `THREE.InstancedMesh` per mesh
17
+ (preserving the mesh's local transform and original materials). All sub-meshes are grouped
18
+ under a `THREE.Group` stored in `comp.instancedMesh`. Per-instance matrices are composed as
19
+ `instanceTransform × meshLocalMatrix` every frame.
20
+
21
+ Geometry is rebuilt whenever the signature (`meshKind:parameters:instanceCount` for primitives,
22
+ `model:path:instanceCount` for model kind) changes.
23
+
24
+ ## Implements
25
+
26
+ - [`EcsSystem`](../interfaces/EcsSystem.md)
27
+
28
+ ## Constructors
29
+
30
+ ### Constructor
31
+
32
+ ```ts
33
+ new InstancedMeshSystem(): InstancedMeshSystem;
34
+ ```
35
+
36
+ #### Returns
37
+
38
+ `InstancedMeshSystem`
39
+
40
+ ## Methods
41
+
42
+ ### update()
43
+
44
+ ```ts
45
+ update(world): void;
46
+ ```
47
+
48
+ Defined in: [systems/InstancedMeshSystem.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/InstancedMeshSystem.ts#L146)
49
+
50
+ #### Parameters
51
+
52
+ | Parameter | Type |
53
+ | ------ | ------ |
54
+ | `world` | [`World`](World.md) |
55
+
56
+ #### Returns
57
+
58
+ `void`
59
+
60
+ #### Implementation of
61
+
62
+ [`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: LightSyncSystem
8
8
 
9
- Defined in: [systems/LightSyncSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/LightSyncSystem.ts#L69)
9
+ Defined in: [systems/LightSyncSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/LightSyncSystem.ts#L69)
10
10
 
11
11
  ## Implements
12
12
 
@@ -32,7 +32,7 @@ new LightSyncSystem(): LightSyncSystem;
32
32
  update(world): void;
33
33
  ```
34
34
 
35
- Defined in: [systems/LightSyncSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/LightSyncSystem.ts#L72)
35
+ Defined in: [systems/LightSyncSystem.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/LightSyncSystem.ts#L72)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MaterialSyncSystem
8
8
 
9
- Defined in: [systems/MaterialSyncSystem.ts:282](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/MaterialSyncSystem.ts#L282)
9
+ Defined in: [systems/MaterialSyncSystem.ts:282](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/MaterialSyncSystem.ts#L282)
10
10
 
11
11
  ## Implements
12
12
 
@@ -32,7 +32,7 @@ new MaterialSyncSystem(): MaterialSyncSystem;
32
32
  update(world): void;
33
33
  ```
34
34
 
35
- Defined in: [systems/MaterialSyncSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/MaterialSyncSystem.ts#L286)
35
+ Defined in: [systems/MaterialSyncSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/MaterialSyncSystem.ts#L286)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -56,7 +56,7 @@ Defined in: [systems/MaterialSyncSystem.ts:286](https://github.com/Relu-Interact
56
56
  dispose(): void;
57
57
  ```
58
58
 
59
- Defined in: [systems/MaterialSyncSystem.ts:365](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/MaterialSyncSystem.ts#L365)
59
+ Defined in: [systems/MaterialSyncSystem.ts:365](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/MaterialSyncSystem.ts#L365)
60
60
 
61
61
  #### Returns
62
62
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MeshGeometrySystem
8
8
 
9
- Defined in: [systems/MeshGeometrySystem.ts:161](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/MeshGeometrySystem.ts#L161)
9
+ Defined in: [systems/MeshGeometrySystem.ts:161](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/MeshGeometrySystem.ts#L161)
10
10
 
11
11
  ## Implements
12
12
 
@@ -32,7 +32,7 @@ new MeshGeometrySystem(): MeshGeometrySystem;
32
32
  update(world): void;
33
33
  ```
34
34
 
35
- Defined in: [systems/MeshGeometrySystem.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/MeshGeometrySystem.ts#L165)
35
+ Defined in: [systems/MeshGeometrySystem.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/MeshGeometrySystem.ts#L165)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ObjectManagementSystem
8
8
 
9
- Defined in: [systems/ObjectManagementSystem.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L90)
9
+ Defined in: [systems/ObjectManagementSystem.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L91)
10
10
 
11
11
  ## Implements
12
12
 
@@ -23,7 +23,7 @@ new ObjectManagementSystem(
23
23
  isEditor?): ObjectManagementSystem;
24
24
  ```
25
25
 
26
- Defined in: [systems/ObjectManagementSystem.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L101)
26
+ Defined in: [systems/ObjectManagementSystem.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L102)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -45,7 +45,7 @@ Defined in: [systems/ObjectManagementSystem.ts:101](https://github.com/Relu-Inte
45
45
  register(kind, factory): void;
46
46
  ```
47
47
 
48
- Defined in: [systems/ObjectManagementSystem.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L111)
48
+ Defined in: [systems/ObjectManagementSystem.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L112)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -66,7 +66,7 @@ Defined in: [systems/ObjectManagementSystem.ts:111](https://github.com/Relu-Inte
66
66
  registerComponentFactory(kind, factory): void;
67
67
  ```
68
68
 
69
- Defined in: [systems/ObjectManagementSystem.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L115)
69
+ Defined in: [systems/ObjectManagementSystem.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L116)
70
70
 
71
71
  #### Parameters
72
72
 
@@ -87,7 +87,7 @@ Defined in: [systems/ObjectManagementSystem.ts:115](https://github.com/Relu-Inte
87
87
  getOrCreateAudioListener(): AudioListener;
88
88
  ```
89
89
 
90
- Defined in: [systems/ObjectManagementSystem.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L122)
90
+ Defined in: [systems/ObjectManagementSystem.ts:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L123)
91
91
 
92
92
  #### Returns
93
93
 
@@ -101,7 +101,7 @@ Defined in: [systems/ObjectManagementSystem.ts:122](https://github.com/Relu-Inte
101
101
  isEditorMode(): boolean;
102
102
  ```
103
103
 
104
- Defined in: [systems/ObjectManagementSystem.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L134)
104
+ Defined in: [systems/ObjectManagementSystem.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L135)
105
105
 
106
106
  #### Returns
107
107
 
@@ -115,7 +115,7 @@ Defined in: [systems/ObjectManagementSystem.ts:134](https://github.com/Relu-Inte
115
115
  getComponentFactory(kind): ComponentFactory | null;
116
116
  ```
117
117
 
118
- Defined in: [systems/ObjectManagementSystem.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L138)
118
+ Defined in: [systems/ObjectManagementSystem.ts:139](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L139)
119
119
 
120
120
  #### Parameters
121
121
 
@@ -139,7 +139,7 @@ createComponentNow(
139
139
  args): unknown;
140
140
  ```
141
141
 
142
- Defined in: [systems/ObjectManagementSystem.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L142)
142
+ Defined in: [systems/ObjectManagementSystem.ts:143](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L143)
143
143
 
144
144
  #### Parameters
145
145
 
@@ -165,7 +165,7 @@ requestCreate(
165
165
  onCreated?): void;
166
166
  ```
167
167
 
168
- Defined in: [systems/ObjectManagementSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L156)
168
+ Defined in: [systems/ObjectManagementSystem.ts:157](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L157)
169
169
 
170
170
  #### Parameters
171
171
 
@@ -190,7 +190,7 @@ createNow(
190
190
  payload?): number;
191
191
  ```
192
192
 
193
- Defined in: [systems/ObjectManagementSystem.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L164)
193
+ Defined in: [systems/ObjectManagementSystem.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L165)
194
194
 
195
195
  #### Parameters
196
196
 
@@ -209,22 +209,42 @@ Defined in: [systems/ObjectManagementSystem.ts:164](https://github.com/Relu-Inte
209
209
  ### deleteEntity()
210
210
 
211
211
  ```ts
212
- deleteEntity(world, entityId): boolean;
212
+ deleteEntity(
213
+ world,
214
+ entityId,
215
+ dispose?): boolean;
213
216
  ```
214
217
 
215
- Defined in: [systems/ObjectManagementSystem.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L194)
218
+ Defined in: [systems/ObjectManagementSystem.ts:217](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L217)
219
+
220
+ Removes an entity from the ECS world and its associated `Object3D` from the
221
+ THREE.js scene graph.
216
222
 
217
223
  #### Parameters
218
224
 
219
- | Parameter | Type |
220
- | ------ | ------ |
221
- | `world` | [`World`](World.md) |
222
- | `entityId` | `number` |
225
+ | Parameter | Type | Default value | Description |
226
+ | ------ | ------ | ------ | ------ |
227
+ | `world` | [`World`](World.md) | `undefined` | The world the entity belongs to. |
228
+ | `entityId` | `number` | `undefined` | The entity to remove. |
229
+ | `dispose` | `boolean` | `false` | When `true`, traverses the entity's `Object3D` subtree and calls `.dispose()` on every `BufferGeometry` and `Material` found. Pass `true` when the entity will not be reused and you want to free GPU memory immediately (e.g. dynamically spawned objects). Defaults to `false`. |
223
230
 
224
231
  #### Returns
225
232
 
226
233
  `boolean`
227
234
 
235
+ `true` if the entity existed and was removed; `false` if the entity
236
+ was not found.
237
+
238
+ #### Example
239
+
240
+ ```ts
241
+ // Remove from scene, keep GPU resources (safe if geometry is shared)
242
+ objects.deleteEntity(world, entityId);
243
+
244
+ // Remove from scene and free GPU memory (use for one-off spawned objects)
245
+ objects.deleteEntity(world, entityId, true);
246
+ ```
247
+
228
248
  ***
229
249
 
230
250
  ### setParent()
@@ -237,7 +257,7 @@ setParent(
237
257
  options?): boolean;
238
258
  ```
239
259
 
240
- Defined in: [systems/ObjectManagementSystem.ts:208](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L208)
260
+ Defined in: [systems/ObjectManagementSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L246)
241
261
 
242
262
  #### Parameters
243
263
 
@@ -261,7 +281,7 @@ Defined in: [systems/ObjectManagementSystem.ts:208](https://github.com/Relu-Inte
261
281
  reconcileSceneFromWorld(world): void;
262
282
  ```
263
283
 
264
- Defined in: [systems/ObjectManagementSystem.ts:298](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L298)
284
+ Defined in: [systems/ObjectManagementSystem.ts:336](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L336)
265
285
 
266
286
  #### Parameters
267
287
 
@@ -281,7 +301,7 @@ Defined in: [systems/ObjectManagementSystem.ts:298](https://github.com/Relu-Inte
281
301
  update(world): void;
282
302
  ```
283
303
 
284
- Defined in: [systems/ObjectManagementSystem.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectManagementSystem.ts#L342)
304
+ Defined in: [systems/ObjectManagementSystem.ts:380](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L380)
285
305
 
286
306
  #### Parameters
287
307
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ObjectVisibilitySystem
8
8
 
9
- Defined in: [systems/ObjectVisibilitySystem.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectVisibilitySystem.ts#L5)
9
+ Defined in: [systems/ObjectVisibilitySystem.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectVisibilitySystem.ts#L5)
10
10
 
11
11
  ## Implements
12
12
 
@@ -32,7 +32,7 @@ new ObjectVisibilitySystem(): ObjectVisibilitySystem;
32
32
  update(world): void;
33
33
  ```
34
34
 
35
- Defined in: [systems/ObjectVisibilitySystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ObjectVisibilitySystem.ts#L6)
35
+ Defined in: [systems/ObjectVisibilitySystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectVisibilitySystem.ts#L6)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: PhysicsSyncSystem
8
8
 
9
- Defined in: [systems/PhysicsSyncSystem.ts:285](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PhysicsSyncSystem.ts#L285)
9
+ Defined in: [systems/PhysicsSyncSystem.ts:285](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PhysicsSyncSystem.ts#L285)
10
10
 
11
11
  ## Implements
12
12
 
@@ -20,7 +20,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:285](https://github.com/Relu-Interacti
20
20
  new PhysicsSyncSystem(options?): PhysicsSyncSystem;
21
21
  ```
22
22
 
23
- Defined in: [systems/PhysicsSyncSystem.ts:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PhysicsSyncSystem.ts#L295)
23
+ Defined in: [systems/PhysicsSyncSystem.ts:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PhysicsSyncSystem.ts#L295)
24
24
 
25
25
  #### Parameters
26
26
 
@@ -41,7 +41,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:295](https://github.com/Relu-Interacti
41
41
  update(world, deltaTime): void;
42
42
  ```
43
43
 
44
- Defined in: [systems/PhysicsSyncSystem.ts:349](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PhysicsSyncSystem.ts#L349)
44
+ Defined in: [systems/PhysicsSyncSystem.ts:349](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PhysicsSyncSystem.ts#L349)
45
45
 
46
46
  #### Parameters
47
47
 
@@ -66,7 +66,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:349](https://github.com/Relu-Interacti
66
66
  dispose(world): void;
67
67
  ```
68
68
 
69
- Defined in: [systems/PhysicsSyncSystem.ts:570](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PhysicsSyncSystem.ts#L570)
69
+ Defined in: [systems/PhysicsSyncSystem.ts:570](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PhysicsSyncSystem.ts#L570)
70
70
 
71
71
  #### Parameters
72
72
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: PostprocessingSyncSystem
8
8
 
9
- Defined in: [systems/PostprocessingSyncSystem.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PostprocessingSyncSystem.ts#L20)
9
+ Defined in: [systems/PostprocessingSyncSystem.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PostprocessingSyncSystem.ts#L20)
10
10
 
11
11
  ## Implements
12
12
 
@@ -23,7 +23,7 @@ new PostprocessingSyncSystem(
23
23
  camera): PostprocessingSyncSystem;
24
24
  ```
25
25
 
26
- Defined in: [systems/PostprocessingSyncSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PostprocessingSyncSystem.ts#L28)
26
+ Defined in: [systems/PostprocessingSyncSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PostprocessingSyncSystem.ts#L28)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -45,7 +45,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:28](https://github.com/Relu-Int
45
45
  update(world): void;
46
46
  ```
47
47
 
48
- Defined in: [systems/PostprocessingSyncSystem.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PostprocessingSyncSystem.ts#L170)
48
+ Defined in: [systems/PostprocessingSyncSystem.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PostprocessingSyncSystem.ts#L170)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -69,7 +69,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:170](https://github.com/Relu-In
69
69
  dispose(): void;
70
70
  ```
71
71
 
72
- Defined in: [systems/PostprocessingSyncSystem.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/PostprocessingSyncSystem.ts#L197)
72
+ Defined in: [systems/PostprocessingSyncSystem.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/PostprocessingSyncSystem.ts#L197)
73
73
 
74
74
  #### Returns
75
75
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: RenderSystem
8
8
 
9
- Defined in: [systems/RenderSystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/RenderSystem.ts#L6)
9
+ Defined in: [systems/RenderSystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/RenderSystem.ts#L6)
10
10
 
11
11
  ## Implements
12
12
 
@@ -24,7 +24,7 @@ new RenderSystem(
24
24
  afterRender?): RenderSystem;
25
25
  ```
26
26
 
27
- Defined in: [systems/RenderSystem.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/RenderSystem.ts#L12)
27
+ Defined in: [systems/RenderSystem.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/RenderSystem.ts#L12)
28
28
 
29
29
  #### Parameters
30
30
 
@@ -47,7 +47,7 @@ Defined in: [systems/RenderSystem.ts:12](https://github.com/Relu-Interactives/re
47
47
  update(_world): void;
48
48
  ```
49
49
 
50
- Defined in: [systems/RenderSystem.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/RenderSystem.ts#L24)
50
+ Defined in: [systems/RenderSystem.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/RenderSystem.ts#L24)
51
51
 
52
52
  #### Parameters
53
53
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ScriptBehaviourSystem
8
8
 
9
- Defined in: [systems/ScriptBehaviourSystem.ts:265](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ScriptBehaviourSystem.ts#L265)
9
+ Defined in: [systems/ScriptBehaviourSystem.ts:265](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L265)
10
10
 
11
11
  ## Implements
12
12
 
@@ -20,7 +20,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:265](https://github.com/Relu-Inter
20
20
  new ScriptBehaviourSystem(moduleLoader?, selectionContext?): ScriptBehaviourSystem;
21
21
  ```
22
22
 
23
- Defined in: [systems/ScriptBehaviourSystem.ts:280](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ScriptBehaviourSystem.ts#L280)
23
+ Defined in: [systems/ScriptBehaviourSystem.ts:280](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L280)
24
24
 
25
25
  #### Parameters
26
26
 
@@ -41,7 +41,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:280](https://github.com/Relu-Inter
41
41
  update(world, deltaTime): void;
42
42
  ```
43
43
 
44
- Defined in: [systems/ScriptBehaviourSystem.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ScriptBehaviourSystem.ts#L378)
44
+ Defined in: [systems/ScriptBehaviourSystem.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L378)
45
45
 
46
46
  #### Parameters
47
47
 
@@ -66,7 +66,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:378](https://github.com/Relu-Inter
66
66
  dispose(world): void;
67
67
  ```
68
68
 
69
- Defined in: [systems/ScriptBehaviourSystem.ts:564](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/ScriptBehaviourSystem.ts#L564)
69
+ Defined in: [systems/ScriptBehaviourSystem.ts:564](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L564)
70
70
 
71
71
  #### Parameters
72
72
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: TransformSyncSystem
8
8
 
9
- Defined in: [systems/TransformSyncSystem.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/TransformSyncSystem.ts#L7)
9
+ Defined in: [systems/TransformSyncSystem.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/TransformSyncSystem.ts#L7)
10
10
 
11
11
  ## Implements
12
12
 
@@ -32,7 +32,7 @@ new TransformSyncSystem(): TransformSyncSystem;
32
32
  update(world): void;
33
33
  ```
34
34
 
35
- Defined in: [systems/TransformSyncSystem.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/TransformSyncSystem.ts#L8)
35
+ Defined in: [systems/TransformSyncSystem.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/TransformSyncSystem.ts#L8)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -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/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L63)
9
+ Defined in: [systems/VideoSystem.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/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/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L70)
37
+ Defined in: [systems/VideoSystem.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/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/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L74)
58
+ Defined in: [systems/VideoSystem.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/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/bdd9282dee928f9a7d192d992833af9bda98772b/core/systems/VideoSystem.ts#L218)
83
+ Defined in: [systems/VideoSystem.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/VideoSystem.ts#L218)
84
84
 
85
85
  #### Parameters
86
86