@relu-interactives/spatial-ecs 0.2.25 → 0.3.0

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 (254) hide show
  1. package/dist/{chunk-J6736FFO.js → chunk-7BPHZWQ6.js} +45 -13
  2. package/dist/chunk-7BPHZWQ6.js.map +1 -0
  3. package/dist/{chunk-3P3ZBP7K.js → chunk-7JFSEV7A.js} +5 -4
  4. package/dist/chunk-7JFSEV7A.js.map +1 -0
  5. package/dist/{chunk-RJ4J5UEX.js → chunk-AT5SPSPM.js} +4 -4
  6. package/dist/{chunk-RJ4J5UEX.js.map → chunk-AT5SPSPM.js.map} +1 -1
  7. package/dist/{chunk-XFD74BQL.js → chunk-PZ4CAALA.js} +3 -3
  8. package/dist/{chunk-XFD74BQL.js.map → chunk-PZ4CAALA.js.map} +1 -1
  9. package/dist/components/index.cjs +43 -11
  10. package/dist/components/index.cjs.map +1 -1
  11. package/dist/components/index.js +1 -1
  12. package/dist/docs/api/Behaviour/classes/Behaviour.md +98 -51
  13. package/dist/docs/api/Component/classes/Component.md +4 -1
  14. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  15. package/dist/docs/api/components/classes/AudioComponent.md +19 -19
  16. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  17. package/dist/docs/api/components/classes/EntityType.md +4 -4
  18. package/dist/docs/api/components/classes/Environment.md +3 -3
  19. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  20. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  21. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  22. package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
  23. package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
  24. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  25. package/dist/docs/api/components/classes/MaterialComponent.md +57 -11
  26. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  27. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  28. package/dist/docs/api/components/classes/ModelComponent.md +4 -4
  29. package/dist/docs/api/components/classes/Name.md +3 -3
  30. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  31. package/dist/docs/api/components/classes/ParentId.md +3 -3
  32. package/dist/docs/api/components/classes/PhysicsComponent.md +12 -13
  33. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  34. package/dist/docs/api/components/classes/PrefabInstance.md +80 -0
  35. package/dist/docs/api/components/classes/PrefabNode.md +54 -0
  36. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  37. package/dist/docs/api/components/classes/ScriptObjectComponent.md +55 -0
  38. package/dist/docs/api/components/classes/Selectable.md +3 -3
  39. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  40. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  41. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  42. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  43. package/dist/docs/api/components/functions/defaultMaterialValue.md +17 -0
  44. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  45. package/dist/docs/api/components/functions/setPhysicsLiveRef.md +34 -0
  46. package/dist/docs/api/components/index.md +8 -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/InstanceTransform.md +13 -13
  64. package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
  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 +8 -10
  78. package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +20 -0
  79. package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +13 -0
  80. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  81. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  82. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  83. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  84. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  85. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  86. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  87. package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
  88. package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
  89. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  90. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  91. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  92. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  93. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  94. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  95. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  96. package/dist/docs/api/index/classes/AudioSystem.md +4 -4
  97. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  98. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  99. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  100. package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
  101. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  102. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  103. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  104. package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
  105. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  106. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  107. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  108. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  109. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +5 -5
  110. package/dist/docs/api/index/classes/ScriptObject.md +156 -0
  111. package/dist/docs/api/index/classes/ScriptObjectSystem.md +129 -0
  112. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  113. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  114. package/dist/docs/api/index/classes/World.md +183 -86
  115. package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +32 -0
  116. package/dist/docs/api/index/functions/buildComponentValueMaps.md +23 -0
  117. package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +25 -0
  118. package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +23 -0
  119. package/dist/docs/api/index/functions/canonicalizeComponentValue.md +38 -0
  120. package/dist/docs/api/index/functions/clearModelCache.md +26 -0
  121. package/dist/docs/api/index/functions/clearPrefabCache.md +25 -0
  122. package/dist/docs/api/index/functions/collectDiffPaths.md +38 -0
  123. package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +27 -0
  124. package/dist/docs/api/index/functions/collectEntitySubtree.md +29 -0
  125. package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +26 -0
  126. package/dist/docs/api/index/functions/computeInstanceOverrides.md +44 -0
  127. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  128. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  129. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  130. package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
  131. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  132. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  133. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  134. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  135. package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
  136. package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
  137. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  138. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  139. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  140. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  141. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  142. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  143. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  144. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  145. package/dist/docs/api/index/functions/createPhysicsComponent.md +2 -4
  146. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  147. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  148. package/dist/docs/api/index/functions/createScriptObjectComponent.md +28 -0
  149. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  150. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  151. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  152. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  153. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  154. package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +28 -0
  155. package/dist/docs/api/index/functions/despawnPrefab.md +32 -0
  156. package/dist/docs/api/index/functions/encodeOverride.md +28 -0
  157. package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +25 -0
  158. package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +28 -0
  159. package/dist/docs/api/index/functions/groupOverridePaths.md +25 -0
  160. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  161. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +4 -2
  162. package/dist/docs/api/index/functions/indexSnapshotByEntity.md +25 -0
  163. package/dist/docs/api/index/functions/instantiateSubtree.md +32 -0
  164. package/dist/docs/api/index/functions/loadPrefab.md +28 -0
  165. package/dist/docs/api/index/functions/loadSharedGltf.md +29 -0
  166. package/dist/docs/api/index/functions/mergeComponentValue.md +32 -0
  167. package/dist/docs/api/index/functions/parseOverride.md +34 -0
  168. package/dist/docs/api/index/functions/parsePrefabAsset.md +25 -0
  169. package/dist/docs/api/index/functions/prefabFileVersionFor.md +25 -0
  170. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  171. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  172. package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +46 -0
  173. package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +17 -0
  174. package/dist/docs/api/index/functions/restoreComponentState.md +34 -0
  175. package/dist/docs/api/index/functions/restorePostCreateComponents.md +36 -0
  176. package/dist/docs/api/index/functions/serializeEntitySubtree.md +35 -0
  177. package/dist/docs/api/index/functions/setDracoDecoderPath.md +30 -0
  178. package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +30 -0
  179. package/dist/docs/api/index/functions/spawnPrefab.md +36 -0
  180. package/dist/docs/api/index/index.md +65 -0
  181. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  182. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  183. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  184. package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +23 -0
  185. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  186. package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +69 -0
  187. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +2 -1
  188. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  189. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  190. package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +27 -0
  191. package/dist/docs/api/index/type-aliases/HydrateOptions.md +27 -0
  192. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +7 -5
  193. package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +23 -0
  194. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  195. package/dist/docs/api/index/type-aliases/ModuleLoader.md +25 -0
  196. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  197. package/dist/docs/api/index/type-aliases/NestedRegion.md +27 -0
  198. package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +30 -0
  199. package/dist/docs/api/index/type-aliases/NodeMaps.md +25 -0
  200. package/dist/docs/api/index/type-aliases/PrefabAsset.md +32 -0
  201. package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +21 -0
  202. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  203. package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +25 -0
  204. package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +27 -0
  205. package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +19 -0
  206. package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +43 -0
  207. package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +19 -0
  208. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  209. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  210. package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +13 -0
  211. package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +15 -0
  212. package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +16 -0
  213. package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +13 -0
  214. package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +15 -0
  215. package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +15 -0
  216. package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +17 -0
  217. package/dist/docs/api/typedoc-sidebar.json +1 -1
  218. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  219. package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
  220. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  221. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  222. package/dist/docs/api/types/type-aliases/ComponentKind.md +2 -1
  223. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  224. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  225. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  226. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +3 -2
  227. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  228. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  229. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  230. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  231. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  232. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  233. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  234. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  235. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  236. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  237. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  238. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  239. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  240. package/dist/docs/guide/components/_sidebar.json +4 -0
  241. package/dist/docs/guide/components/material.md +1 -0
  242. package/dist/docs/guide/components/script-object.md +32 -0
  243. package/dist/factories/index.cjs +43 -11
  244. package/dist/factories/index.cjs.map +1 -1
  245. package/dist/factories/index.js +3 -3
  246. package/dist/index.cjs +44 -11
  247. package/dist/index.cjs.map +1 -1
  248. package/dist/index.js +8 -8
  249. package/dist/systems/index.cjs +44 -11
  250. package/dist/systems/index.cjs.map +1 -1
  251. package/dist/systems/index.js +3 -3
  252. package/package.json +4 -4
  253. package/dist/chunk-3P3ZBP7K.js.map +0 -1
  254. package/dist/chunk-J6736FFO.js.map +0 -1
@@ -13,7 +13,7 @@ function createSelectableComponent(
13
13
  args): Selectable;
14
14
  ```
15
15
 
16
- Defined in: [factories/components/SelectableFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/SelectableFactory.ts#L4)
16
+ Defined in: [factories/components/SelectableFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/SelectableFactory.ts#L4)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -13,7 +13,7 @@ function createSelectionTransformStateComponent(
13
13
  args): SelectionTransformState;
14
14
  ```
15
15
 
16
- Defined in: [factories/components/SelectionTransformStateFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/SelectionTransformStateFactory.ts#L4)
16
+ Defined in: [factories/components/SelectionTransformStateFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/SelectionTransformStateFactory.ts#L4)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -13,7 +13,7 @@ function createSpriteComponent(
13
13
  args): SpriteComponent;
14
14
  ```
15
15
 
16
- Defined in: [factories/components/SpriteFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/SpriteFactory.ts#L4)
16
+ Defined in: [factories/components/SpriteFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/SpriteFactory.ts#L4)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -13,7 +13,7 @@ function createTransformComponent(
13
13
  args): TransformComponent;
14
14
  ```
15
15
 
16
- Defined in: [factories/components/TransformFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/TransformFactory.ts#L4)
16
+ Defined in: [factories/components/TransformFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/TransformFactory.ts#L4)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -13,7 +13,7 @@ function createVideoComponent(
13
13
  args): VideoComponent;
14
14
  ```
15
15
 
16
- Defined in: [factories/components/VideoFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/VideoFactory.ts#L4)
16
+ Defined in: [factories/components/VideoFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/VideoFactory.ts#L4)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -0,0 +1,28 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / decanonicalizeComponentValue
6
+
7
+ # Function: decanonicalizeComponentValue()
8
+
9
+ ```ts
10
+ function decanonicalizeComponentValue(value, nodeToId): unknown;
11
+ ```
12
+
13
+ Defined in: [prefab/overrides.ts:256](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L256)
14
+
15
+ Replace every `{$node}` marker (at any depth) with the mapped entity id
16
+ from `nodeToId`, or null when the node no longer exists. Exact inverse of
17
+ canonicalization for the id-bearing positions.
18
+
19
+ ## Parameters
20
+
21
+ | Parameter | Type |
22
+ | ------ | ------ |
23
+ | `value` | `unknown` |
24
+ | `nodeToId` | `Map`\<`string`, `number`\> |
25
+
26
+ ## Returns
27
+
28
+ `unknown`
@@ -0,0 +1,32 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / despawnPrefab
6
+
7
+ # Function: despawnPrefab()
8
+
9
+ ```ts
10
+ function despawnPrefab(
11
+ world,
12
+ rootId,
13
+ dispose?): number;
14
+ ```
15
+
16
+ Defined in: [prefab/spawnPrefab.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/spawnPrefab.ts#L201)
17
+
18
+ Delete a spawned prefab instance: the root entity plus every descendant
19
+ (children first). Returns the number of entities removed. `dispose`
20
+ releases GPU resources not flagged as shared (safe with the model cache).
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Default value |
25
+ | ------ | ------ | ------ |
26
+ | `world` | [`World`](../classes/World.md) | `undefined` |
27
+ | `rootId` | `number` | `undefined` |
28
+ | `dispose` | `boolean` | `true` |
29
+
30
+ ## Returns
31
+
32
+ `number`
@@ -0,0 +1,28 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / encodeOverride
6
+
7
+ # Function: encodeOverride()
8
+
9
+ ```ts
10
+ function encodeOverride(
11
+ nodeId,
12
+ componentName,
13
+ path): string;
14
+ ```
15
+
16
+ Defined in: [prefab/overrides.ts:277](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L277)
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `nodeId` | `string` |
23
+ | `componentName` | `string` |
24
+ | `path` | `string` |
25
+
26
+ ## Returns
27
+
28
+ `string`
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / findSnapshotRootEntityIds
6
+
7
+ # Function: findSnapshotRootEntityIds()
8
+
9
+ ```ts
10
+ function findSnapshotRootEntityIds(snapshot): number[];
11
+ ```
12
+
13
+ Defined in: [prefab/overrides.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L73)
14
+
15
+ Entity ids of entities whose ParentId is null or absent.
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
22
+
23
+ ## Returns
24
+
25
+ `number`[]
@@ -0,0 +1,28 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / findTopLevelNestedRegions
6
+
7
+ # Function: findTopLevelNestedRegions()
8
+
9
+ ```ts
10
+ function findTopLevelNestedRegions(snapshot): NestedRegion[];
11
+ ```
12
+
13
+ Defined in: [prefab/nodeKeys.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/nodeKeys.ts#L207)
14
+
15
+ TOP-LEVEL-RELATIVE nested instance regions of a document: instance roots
16
+ that are not the scope root and not themselves inside another region.
17
+ Deeper nesting is reached by cascading through the intermediate prefab's
18
+ own file, never directly.
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type |
23
+ | ------ | ------ |
24
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
25
+
26
+ ## Returns
27
+
28
+ [`NestedRegion`](../type-aliases/NestedRegion.md)[]
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / groupOverridePaths
6
+
7
+ # Function: groupOverridePaths()
8
+
9
+ ```ts
10
+ function groupOverridePaths(overrides): Map<string, Map<string, Set<string>>>;
11
+ ```
12
+
13
+ Defined in: [prefab/overrides.ts:302](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L302)
14
+
15
+ nodeId → componentName → set of overridden paths.
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `overrides` | `string`[] |
22
+
23
+ ## Returns
24
+
25
+ `Map`\<`string`, `Map`\<`string`, `Set`\<`string`\>\>\>
@@ -13,7 +13,7 @@ function hydrateWorldFromSnapshot(
13
13
  objectManagementSystem): number;
14
14
  ```
15
15
 
16
- Defined in: [hydration/hydrateWorld.ts:289](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/hydration/hydrateWorld.ts#L289)
16
+ Defined in: [hydration/hydrateWorld.ts:318](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/hydrateWorld.ts#L318)
17
17
 
18
18
  ## Parameters
19
19
 
@@ -10,10 +10,11 @@
10
10
  function hydrateWorldFromSnapshotDetailed(
11
11
  snapshot,
12
12
  world,
13
- objectManagementSystem): HydrateWorldFromSnapshotResult;
13
+ objectManagementSystem,
14
+ options?): HydrateWorldFromSnapshotResult;
14
15
  ```
15
16
 
16
- Defined in: [hydration/hydrateWorld.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/hydration/hydrateWorld.ts#L201)
17
+ Defined in: [hydration/hydrateWorld.ts:221](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/hydrateWorld.ts#L221)
17
18
 
18
19
  ## Parameters
19
20
 
@@ -22,6 +23,7 @@ Defined in: [hydration/hydrateWorld.ts:201](https://github.com/Relu-Interactives
22
23
  | `snapshot` | \| [`EcsWorldStateSnapshotLike`](../type-aliases/EcsWorldStateSnapshotLike.md) \| `null` \| `undefined` |
23
24
  | `world` | [`World`](../classes/World.md) |
24
25
  | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
26
+ | `options?` | [`HydrateOptions`](../type-aliases/HydrateOptions.md) |
25
27
 
26
28
  ## Returns
27
29
 
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / indexSnapshotByEntity
6
+
7
+ # Function: indexSnapshotByEntity()
8
+
9
+ ```ts
10
+ function indexSnapshotByEntity(snapshot): Map<number, Map<string, unknown>>;
11
+ ```
12
+
13
+ Defined in: [prefab/overrides.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L109)
14
+
15
+ Invert the columnar snapshot into entityId → (componentName → value).
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
22
+
23
+ ## Returns
24
+
25
+ `Map`\<`number`, `Map`\<`string`, `unknown`\>\>
@@ -0,0 +1,32 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / instantiateSubtree
6
+
7
+ # Function: instantiateSubtree()
8
+
9
+ ```ts
10
+ function instantiateSubtree(
11
+ world,
12
+ objectManagementSystem,
13
+ snapshot): InstantiateSubtreeResult;
14
+ ```
15
+
16
+ Defined in: [prefab/instantiateSubtree.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/instantiateSubtree.ts#L33)
17
+
18
+ Hydrate a self-contained subtree snapshot (a prefab file's `snapshot`)
19
+ into a LIVE world: fresh entity ids, internal references remapped, no
20
+ camera promotion, transform pass scoped to the created entities.
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `world` | [`World`](../classes/World.md) |
27
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
28
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
29
+
30
+ ## Returns
31
+
32
+ [`InstantiateSubtreeResult`](../type-aliases/InstantiateSubtreeResult.md)
@@ -0,0 +1,28 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / loadPrefab
6
+
7
+ # Function: loadPrefab()
8
+
9
+ ```ts
10
+ function loadPrefab(url): Promise<PrefabAsset>;
11
+ ```
12
+
13
+ Defined in: [prefab/spawnPrefab.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/spawnPrefab.ts#L61)
14
+
15
+ Fetch + parse (and cache) a `.prefab` asset. All strings inside the
16
+ snapshot are passed through the registered URL resolver, so asset
17
+ references load correctly in published/preview builds. Use this from
18
+ preloaders to warm the same cache `spawnPrefab` reads.
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type |
23
+ | ------ | ------ |
24
+ | `url` | `string` |
25
+
26
+ ## Returns
27
+
28
+ `Promise`\<[`PrefabAsset`](../type-aliases/PrefabAsset.md)\>
@@ -0,0 +1,29 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / loadSharedGltf
6
+
7
+ # Function: loadSharedGltf()
8
+
9
+ ```ts
10
+ function loadSharedGltf(url, load): Promise<GLTF>;
11
+ ```
12
+
13
+ Defined in: [utils/modelCache.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/utils/modelCache.ts#L39)
14
+
15
+ Load a GLTF once per URL and share the parsed result, so repeated spawns of
16
+ the same model skip both the fetch and the parse. The cached scene must
17
+ never be mounted directly (an Object3D has a single parent) — mount a
18
+ cloneModelScene() of it. Failed loads are evicted so a retry re-fetches.
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type |
23
+ | ------ | ------ |
24
+ | `url` | `string` |
25
+ | `load` | () => `Promise`\<`GLTF`\> |
26
+
27
+ ## Returns
28
+
29
+ `Promise`\<`GLTF`\>
@@ -0,0 +1,32 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / mergeComponentValue
6
+
7
+ # Function: mergeComponentValue()
8
+
9
+ ```ts
10
+ function mergeComponentValue(
11
+ newFileCanonical,
12
+ instanceCanonical,
13
+ overridePaths): unknown;
14
+ ```
15
+
16
+ Defined in: [prefab/overrides.ts:542](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L542)
17
+
18
+ Merge a component's NEW canonical file value with an instance's canonical
19
+ value, preserving the instance side at every overridden path. An empty
20
+ path ("") means the whole component is overridden → instance wins.
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `newFileCanonical` | `unknown` |
27
+ | `instanceCanonical` | `unknown` |
28
+ | `overridePaths` | `Set`\<`string`\> \| `undefined` |
29
+
30
+ ## Returns
31
+
32
+ `unknown`
@@ -0,0 +1,34 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / parseOverride
6
+
7
+ # Function: parseOverride()
8
+
9
+ ```ts
10
+ function parseOverride(encoded):
11
+ | {
12
+ nodeId: string;
13
+ componentName: string;
14
+ path: string;
15
+ }
16
+ | null;
17
+ ```
18
+
19
+ Defined in: [prefab/overrides.ts:283](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L283)
20
+
21
+ ## Parameters
22
+
23
+ | Parameter | Type |
24
+ | ------ | ------ |
25
+ | `encoded` | `string` |
26
+
27
+ ## Returns
28
+
29
+ \| \{
30
+ `nodeId`: `string`;
31
+ `componentName`: `string`;
32
+ `path`: `string`;
33
+ \}
34
+ \| `null`
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / parsePrefabAsset
6
+
7
+ # Function: parsePrefabAsset()
8
+
9
+ ```ts
10
+ function parsePrefabAsset(json): PrefabAsset | null;
11
+ ```
12
+
13
+ Defined in: [prefab/types.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/types.ts#L32)
14
+
15
+ Validate untrusted JSON into a `PrefabAsset`, or null when malformed.
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `json` | `unknown` |
22
+
23
+ ## Returns
24
+
25
+ [`PrefabAsset`](../type-aliases/PrefabAsset.md) \| `null`
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / prefabFileVersionFor
6
+
7
+ # Function: prefabFileVersionFor()
8
+
9
+ ```ts
10
+ function prefabFileVersionFor(snapshot): number;
11
+ ```
12
+
13
+ Defined in: [prefab/types.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/types.ts#L9)
14
+
15
+ File version to write for a given snapshot: 2 iff it nests instances.
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
22
+
23
+ ## Returns
24
+
25
+ `number`
@@ -10,7 +10,7 @@
10
10
  function registerDefaultComponentFactories(objectManagementSystem): void;
11
11
  ```
12
12
 
13
- Defined in: [factories/registerDefaultComponentFactories.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/registerDefaultComponentFactories.ts#L30)
13
+ Defined in: [factories/registerDefaultComponentFactories.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/registerDefaultComponentFactories.ts#L31)
14
14
 
15
15
  ## Parameters
16
16
 
@@ -10,7 +10,7 @@
10
10
  function registerDefaultFactories(objectManagementSystem): void;
11
11
  ```
12
12
 
13
- Defined in: [factories/registerDefaultFactories.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/registerDefaultFactories.ts#L24)
13
+ Defined in: [factories/registerDefaultFactories.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/registerDefaultFactories.ts#L25)
14
14
 
15
15
  ## Parameters
16
16
 
@@ -0,0 +1,46 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / remapSnapshotEntityIds
6
+
7
+ # Function: remapSnapshotEntityIds()
8
+
9
+ ```ts
10
+ function remapSnapshotEntityIds(
11
+ snapshot,
12
+ idMap,
13
+ options?): {
14
+ snapshot: SubtreeSnapshot;
15
+ warnings: ExternalRefWarning[];
16
+ };
17
+ ```
18
+
19
+ Defined in: [prefab/snapshotIdUtils.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/snapshotIdUtils.ts#L108)
20
+
21
+ Return a deep-cloned snapshot with every entity id (entity list, entry
22
+ keys, and all id-bearing component fields) remapped through `idMap`.
23
+ References to ids missing from the map follow `externalRefPolicy` and are
24
+ reported in `warnings` (with ids in the INPUT snapshot's id space).
25
+
26
+ ## Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
31
+ | `idMap` | `Map`\<`number`, `number`\> |
32
+ | `options?` | [`RemapSnapshotOptions`](../type-aliases/RemapSnapshotOptions.md) |
33
+
34
+ ## Returns
35
+
36
+ ```ts
37
+ {
38
+ snapshot: SubtreeSnapshot;
39
+ warnings: ExternalRefWarning[];
40
+ }
41
+ ```
42
+
43
+ | Name | Type | Defined in |
44
+ | ------ | ------ | ------ |
45
+ | `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) | [prefab/snapshotIdUtils.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/snapshotIdUtils.ts#L112) |
46
+ | `warnings` | [`ExternalRefWarning`](../type-aliases/ExternalRefWarning.md)[] | [prefab/snapshotIdUtils.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/snapshotIdUtils.ts#L112) |
@@ -0,0 +1,17 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / resolveDracoDecoderPath
6
+
7
+ # Function: resolveDracoDecoderPath()
8
+
9
+ ```ts
10
+ function resolveDracoDecoderPath(): string;
11
+ ```
12
+
13
+ Defined in: [utils/dracoDecoderPath.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/utils/dracoDecoderPath.ts#L23)
14
+
15
+ ## Returns
16
+
17
+ `string`
@@ -0,0 +1,34 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / restoreComponentState
6
+
7
+ # Function: restoreComponentState()
8
+
9
+ ```ts
10
+ function restoreComponentState(
11
+ world,
12
+ objectManagementSystem,
13
+ targetEntityId,
14
+ sourceEntityId,
15
+ entityType,
16
+ values): void;
17
+ ```
18
+
19
+ Defined in: [hydration/restoreComponentState.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/restoreComponentState.ts#L59)
20
+
21
+ ## Parameters
22
+
23
+ | Parameter | Type |
24
+ | ------ | ------ |
25
+ | `world` | [`World`](../classes/World.md) |
26
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
27
+ | `targetEntityId` | `number` |
28
+ | `sourceEntityId` | `number` |
29
+ | `entityType` | `string` \| `null` |
30
+ | `values` | [`ComponentValueMaps`](../type-aliases/ComponentValueMaps.md) |
31
+
32
+ ## Returns
33
+
34
+ `void`
@@ -0,0 +1,36 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / restorePostCreateComponents
6
+
7
+ # Function: restorePostCreateComponents()
8
+
9
+ ```ts
10
+ function restorePostCreateComponents(
11
+ world,
12
+ objectManagementSystem,
13
+ targetEntityId,
14
+ sourceEntityId,
15
+ entityType,
16
+ values,
17
+ idMap): void;
18
+ ```
19
+
20
+ Defined in: [hydration/postCreateComponents.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/postCreateComponents.ts#L45)
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `world` | [`World`](../classes/World.md) |
27
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
28
+ | `targetEntityId` | `number` |
29
+ | `sourceEntityId` | `number` |
30
+ | `entityType` | `string` \| `null` |
31
+ | `values` | [`ComponentValueMaps`](../type-aliases/ComponentValueMaps.md) |
32
+ | `idMap` | `Map`\<`number`, `number`\> |
33
+
34
+ ## Returns
35
+
36
+ `void`