@relu-interactives/spatial-ecs 0.2.2

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 (308) hide show
  1. package/README.md +125 -0
  2. package/dist/System-rXAmagXA.d.cts +659 -0
  3. package/dist/System-rXAmagXA.d.ts +659 -0
  4. package/dist/Video-CDemv74U.d.cts +1261 -0
  5. package/dist/Video-ChKV1UI7.d.ts +1261 -0
  6. package/dist/assets/draco/draco_decoder.js +34 -0
  7. package/dist/assets/draco/draco_decoder.wasm +0 -0
  8. package/dist/assets/draco/draco_wasm_wrapper.js +117 -0
  9. package/dist/chunk-AYEF3X2P.js +223 -0
  10. package/dist/chunk-AYEF3X2P.js.map +1 -0
  11. package/dist/chunk-MAWBTMCG.js +1722 -0
  12. package/dist/chunk-MAWBTMCG.js.map +1 -0
  13. package/dist/chunk-NFDTIYR4.js +248 -0
  14. package/dist/chunk-NFDTIYR4.js.map +1 -0
  15. package/dist/chunk-OY7ZODZP.js +16 -0
  16. package/dist/chunk-OY7ZODZP.js.map +1 -0
  17. package/dist/chunk-P2YDX5DB.js +3304 -0
  18. package/dist/chunk-P2YDX5DB.js.map +1 -0
  19. package/dist/chunk-QHILSPT4.js +3 -0
  20. package/dist/chunk-QHILSPT4.js.map +1 -0
  21. package/dist/chunk-XWIEEJ7Z.js +1315 -0
  22. package/dist/chunk-XWIEEJ7Z.js.map +1 -0
  23. package/dist/components/index.cjs +1745 -0
  24. package/dist/components/index.cjs.map +1 -0
  25. package/dist/components/index.d.cts +4 -0
  26. package/dist/components/index.d.ts +4 -0
  27. package/dist/components/index.js +4 -0
  28. package/dist/components/index.js.map +1 -0
  29. package/dist/docs/api/Behaviour/classes/Behaviour.md +554 -0
  30. package/dist/docs/api/Behaviour/index.md +15 -0
  31. package/dist/docs/api/Component/classes/Component.md +57 -0
  32. package/dist/docs/api/Component/index.md +15 -0
  33. package/dist/docs/api/components/classes/AnimationComponent.md +318 -0
  34. package/dist/docs/api/components/classes/AudioComponent.md +114 -0
  35. package/dist/docs/api/components/classes/CameraComponent.md +59 -0
  36. package/dist/docs/api/components/classes/EntityType.md +48 -0
  37. package/dist/docs/api/components/classes/Environment.md +47 -0
  38. package/dist/docs/api/components/classes/ImageComponent.md +57 -0
  39. package/dist/docs/api/components/classes/ImageTarget.md +60 -0
  40. package/dist/docs/api/components/classes/ImageTargetAnchor.md +48 -0
  41. package/dist/docs/api/components/classes/LightComponent.md +70 -0
  42. package/dist/docs/api/components/classes/MaterialComponent.md +181 -0
  43. package/dist/docs/api/components/classes/MeshComponent.md +48 -0
  44. package/dist/docs/api/components/classes/MeshGeometryComponent.md +64 -0
  45. package/dist/docs/api/components/classes/ModelComponent.md +49 -0
  46. package/dist/docs/api/components/classes/Name.md +46 -0
  47. package/dist/docs/api/components/classes/Object3DRef.md +54 -0
  48. package/dist/docs/api/components/classes/ParentId.md +47 -0
  49. package/dist/docs/api/components/classes/PhysicsComponent.md +82 -0
  50. package/dist/docs/api/components/classes/Postprocessing.md +49 -0
  51. package/dist/docs/api/components/classes/ScriptComponent.md +54 -0
  52. package/dist/docs/api/components/classes/Selectable.md +46 -0
  53. package/dist/docs/api/components/classes/SelectionTransformState.md +54 -0
  54. package/dist/docs/api/components/classes/SpriteComponent.md +55 -0
  55. package/dist/docs/api/components/classes/TransformComponent.md +197 -0
  56. package/dist/docs/api/components/classes/VideoComponent.md +123 -0
  57. package/dist/docs/api/components/functions/normalizePhysicsState.md +23 -0
  58. package/dist/docs/api/components/index.md +94 -0
  59. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +42 -0
  60. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +45 -0
  61. package/dist/docs/api/components/type-aliases/CameraProjection.md +15 -0
  62. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +15 -0
  63. package/dist/docs/api/components/type-aliases/ColliderShape.md +15 -0
  64. package/dist/docs/api/components/type-aliases/ColliderState.md +62 -0
  65. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +27 -0
  66. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +15 -0
  67. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +37 -0
  68. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +15 -0
  69. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +15 -0
  70. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +34 -0
  71. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +15 -0
  72. package/dist/docs/api/components/type-aliases/EnvironmentState.md +29 -0
  73. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +25 -0
  74. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +33 -0
  75. package/dist/docs/api/components/type-aliases/LightValueState.md +41 -0
  76. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +15 -0
  77. package/dist/docs/api/components/type-aliases/MaterialValueState.md +75 -0
  78. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +13 -0
  79. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +33 -0
  80. package/dist/docs/api/components/type-aliases/PhysicsState.md +25 -0
  81. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +25 -0
  82. package/dist/docs/api/components/type-aliases/PostprocessingState.md +164 -0
  83. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +25 -0
  84. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +23 -0
  85. package/dist/docs/api/components/type-aliases/RigidbodyState.md +53 -0
  86. package/dist/docs/api/components/type-aliases/RigidbodyType.md +19 -0
  87. package/dist/docs/api/components/type-aliases/ScriptEntry.md +38 -0
  88. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +15 -0
  89. package/dist/docs/api/components/type-aliases/TransformData.md +27 -0
  90. package/dist/docs/api/components/type-aliases/TransformModeValue.md +15 -0
  91. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +15 -0
  92. package/dist/docs/api/components/type-aliases/Vec3.md +27 -0
  93. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +13 -0
  94. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +13 -0
  95. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +13 -0
  96. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +13 -0
  97. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +13 -0
  98. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +13 -0
  99. package/dist/docs/api/index/classes/AnimationStateMachine.md +201 -0
  100. package/dist/docs/api/index/classes/AnimationStateManager.md +253 -0
  101. package/dist/docs/api/index/classes/AnimationSystem.md +68 -0
  102. package/dist/docs/api/index/classes/AudioSystem.md +98 -0
  103. package/dist/docs/api/index/classes/CameraSyncSystem.md +49 -0
  104. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +75 -0
  105. package/dist/docs/api/index/classes/InputSystem.md +449 -0
  106. package/dist/docs/api/index/classes/LightSyncSystem.md +49 -0
  107. package/dist/docs/api/index/classes/MaterialSyncSystem.md +67 -0
  108. package/dist/docs/api/index/classes/MeshGeometrySystem.md +49 -0
  109. package/dist/docs/api/index/classes/ObjectManagementSystem.md +298 -0
  110. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +49 -0
  111. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +83 -0
  112. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +80 -0
  113. package/dist/docs/api/index/classes/RenderSystem.md +64 -0
  114. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +83 -0
  115. package/dist/docs/api/index/classes/TransformSyncSystem.md +49 -0
  116. package/dist/docs/api/index/classes/VideoSystem.md +97 -0
  117. package/dist/docs/api/index/classes/World.md +1405 -0
  118. package/dist/docs/api/index/functions/createAnimationComponent.md +28 -0
  119. package/dist/docs/api/index/functions/createAudioComponent.md +32 -0
  120. package/dist/docs/api/index/functions/createCameraComponent.md +28 -0
  121. package/dist/docs/api/index/functions/createEntityTypeComponent.md +28 -0
  122. package/dist/docs/api/index/functions/createEnvironmentComponent.md +28 -0
  123. package/dist/docs/api/index/functions/createImageComponent.md +28 -0
  124. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +28 -0
  125. package/dist/docs/api/index/functions/createImageTargetComponent.md +28 -0
  126. package/dist/docs/api/index/functions/createLightComponent.md +28 -0
  127. package/dist/docs/api/index/functions/createMaterialComponent.md +28 -0
  128. package/dist/docs/api/index/functions/createMeshComponent.md +28 -0
  129. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +28 -0
  130. package/dist/docs/api/index/functions/createModelComponent.md +28 -0
  131. package/dist/docs/api/index/functions/createNameComponent.md +28 -0
  132. package/dist/docs/api/index/functions/createObject3DRefComponent.md +28 -0
  133. package/dist/docs/api/index/functions/createParentIdComponent.md +28 -0
  134. package/dist/docs/api/index/functions/createPhysicsComponent.md +30 -0
  135. package/dist/docs/api/index/functions/createPostprocessingComponent.md +28 -0
  136. package/dist/docs/api/index/functions/createScriptComponent.md +28 -0
  137. package/dist/docs/api/index/functions/createSelectableComponent.md +28 -0
  138. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +28 -0
  139. package/dist/docs/api/index/functions/createSpriteComponent.md +28 -0
  140. package/dist/docs/api/index/functions/createTransformComponent.md +28 -0
  141. package/dist/docs/api/index/functions/createVideoComponent.md +28 -0
  142. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +28 -0
  143. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +28 -0
  144. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +23 -0
  145. package/dist/docs/api/index/functions/registerDefaultFactories.md +23 -0
  146. package/dist/docs/api/index/index.md +249 -0
  147. package/dist/docs/api/index/interfaces/EcsSystem.md +50 -0
  148. package/dist/docs/api/index/interfaces/StateMachine.md +26 -0
  149. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +25 -0
  150. package/dist/docs/api/index/type-aliases/ComponentFactory.md +25 -0
  151. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +37 -0
  152. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +26 -0
  153. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +25 -0
  154. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +23 -0
  155. package/dist/docs/api/index/type-aliases/KeyboardKey.md +13 -0
  156. package/dist/docs/api/index/type-aliases/MouseButton.md +13 -0
  157. package/dist/docs/api/index/type-aliases/SelectionContext.md +31 -0
  158. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +13 -0
  159. package/dist/docs/api/index/variables/KeyboardKeys.md +195 -0
  160. package/dist/docs/api/index.md +15 -0
  161. package/dist/docs/api/typedoc-sidebar.json +1 -0
  162. package/dist/docs/api/types/index.md +34 -0
  163. package/dist/docs/api/types/type-aliases/AssetInput.md +23 -0
  164. package/dist/docs/api/types/type-aliases/CheckboxInput.md +13 -0
  165. package/dist/docs/api/types/type-aliases/ColorInput.md +13 -0
  166. package/dist/docs/api/types/type-aliases/ComponentInput.md +52 -0
  167. package/dist/docs/api/types/type-aliases/ComponentKind.md +37 -0
  168. package/dist/docs/api/types/type-aliases/DropdownInput.md +23 -0
  169. package/dist/docs/api/types/type-aliases/DropdownOption.md +23 -0
  170. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +15 -0
  171. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +35 -0
  172. package/dist/docs/api/types/type-aliases/EntityId.md +16 -0
  173. package/dist/docs/api/types/type-aliases/EntityInput.md +23 -0
  174. package/dist/docs/api/types/type-aliases/FloatInput.md +13 -0
  175. package/dist/docs/api/types/type-aliases/IntersectionResult.md +29 -0
  176. package/dist/docs/api/types/type-aliases/ParentLookup.md +26 -0
  177. package/dist/docs/api/types/type-aliases/SelectionListener.md +25 -0
  178. package/dist/docs/api/types/type-aliases/SliderInput.md +27 -0
  179. package/dist/docs/api/types/type-aliases/TextInput.md +13 -0
  180. package/dist/docs/api/types/type-aliases/ToggleInput.md +13 -0
  181. package/dist/docs/api/types/type-aliases/Vec3.md +23 -0
  182. package/dist/docs/api/types/type-aliases/Vector2Input.md +23 -0
  183. package/dist/docs/api/types/type-aliases/Vector3Input.md +25 -0
  184. package/dist/docs/api/types/type-aliases/WorldEntityView.md +17 -0
  185. package/dist/docs/guide/accessing-components.md +399 -0
  186. package/dist/docs/guide/authoring-a-behaviour.md +166 -0
  187. package/dist/docs/guide/behaviour-lifecycle.md +43 -0
  188. package/dist/docs/guide/component-catalog.md +59 -0
  189. package/dist/docs/guide/components/_sidebar.json +78 -0
  190. package/dist/docs/guide/components/animation.md +171 -0
  191. package/dist/docs/guide/components/audio.md +181 -0
  192. package/dist/docs/guide/components/camera.md +179 -0
  193. package/dist/docs/guide/components/entity-type.md +141 -0
  194. package/dist/docs/guide/components/image-target-anchor.md +103 -0
  195. package/dist/docs/guide/components/image-target.md +122 -0
  196. package/dist/docs/guide/components/image.md +146 -0
  197. package/dist/docs/guide/components/light.md +157 -0
  198. package/dist/docs/guide/components/material.md +161 -0
  199. package/dist/docs/guide/components/mesh-geometry.md +153 -0
  200. package/dist/docs/guide/components/mesh.md +151 -0
  201. package/dist/docs/guide/components/model.md +96 -0
  202. package/dist/docs/guide/components/name.md +121 -0
  203. package/dist/docs/guide/components/object3d-ref.md +115 -0
  204. package/dist/docs/guide/components/parent-id.md +108 -0
  205. package/dist/docs/guide/components/physics.md +163 -0
  206. package/dist/docs/guide/components/script.md +142 -0
  207. package/dist/docs/guide/components/sprite.md +155 -0
  208. package/dist/docs/guide/components/transform.md +155 -0
  209. package/dist/docs/guide/components/video.md +153 -0
  210. package/dist/docs/guide/concepts.md +34 -0
  211. package/dist/docs/guide/getting-started/creating-objects.md +50 -0
  212. package/dist/docs/guide/getting-started/editing-objects.md +62 -0
  213. package/dist/docs/guide/getting-started/editor/assets-browser.md +55 -0
  214. package/dist/docs/guide/getting-started/editor/hierarchy.md +47 -0
  215. package/dist/docs/guide/getting-started/editor/index.md +16 -0
  216. package/dist/docs/guide/getting-started/editor/inspector.md +36 -0
  217. package/dist/docs/guide/getting-started/editor/modules.md +35 -0
  218. package/dist/docs/guide/getting-started/editor/scene-inspector.md +64 -0
  219. package/dist/docs/guide/getting-started/editor/toolbar.md +39 -0
  220. package/dist/docs/guide/getting-started/editor/viewport.md +43 -0
  221. package/dist/docs/guide/getting-started/first-launch.md +17 -0
  222. package/dist/docs/guide/getting-started/index.md +37 -0
  223. package/dist/docs/guide/getting-started/installation.md +59 -0
  224. package/dist/docs/guide/getting-started/preview-and-test.md +55 -0
  225. package/dist/docs/guide/getting-started/project-types/3d.md +30 -0
  226. package/dist/docs/guide/getting-started/project-types/ar.md +6 -0
  227. package/dist/docs/guide/getting-started/project-types/face-tracking.md +6 -0
  228. package/dist/docs/guide/getting-started/project-types/image-tracking.md +42 -0
  229. package/dist/docs/guide/getting-started/project-types/index.md +25 -0
  230. package/dist/docs/guide/getting-started/project-types/vr.md +6 -0
  231. package/dist/docs/guide/getting-started/projects.md +53 -0
  232. package/dist/docs/guide/getting-started/shortcuts.md +43 -0
  233. package/dist/docs/guide/inspector-data-binding.md +367 -0
  234. package/dist/docs/guide/reading-input.md +202 -0
  235. package/dist/docs/guide/scene/environment.md +101 -0
  236. package/dist/docs/guide/scene/index.md +36 -0
  237. package/dist/docs/guide/scene/postprocessing.md +108 -0
  238. package/dist/docs/guide/spawning/ambient-light.md +28 -0
  239. package/dist/docs/guide/spawning/area-light.md +32 -0
  240. package/dist/docs/guide/spawning/audio.md +42 -0
  241. package/dist/docs/guide/spawning/camera.md +50 -0
  242. package/dist/docs/guide/spawning/capsule.md +29 -0
  243. package/dist/docs/guide/spawning/cube.md +31 -0
  244. package/dist/docs/guide/spawning/cylinder.md +29 -0
  245. package/dist/docs/guide/spawning/directional-light.md +32 -0
  246. package/dist/docs/guide/spawning/empty.md +31 -0
  247. package/dist/docs/guide/spawning/image-target.md +48 -0
  248. package/dist/docs/guide/spawning/image.md +33 -0
  249. package/dist/docs/guide/spawning/index.md +79 -0
  250. package/dist/docs/guide/spawning/model.md +31 -0
  251. package/dist/docs/guide/spawning/plane.md +31 -0
  252. package/dist/docs/guide/spawning/point-light.md +32 -0
  253. package/dist/docs/guide/spawning/sphere.md +29 -0
  254. package/dist/docs/guide/spawning/spot-light.md +32 -0
  255. package/dist/docs/guide/spawning/sprite.md +31 -0
  256. package/dist/docs/guide/spawning/video.md +53 -0
  257. package/dist/docs/guide/system-overview.md +73 -0
  258. package/dist/docs/guide/systems/_sidebar.json +66 -0
  259. package/dist/docs/guide/systems/animation-system.md +32 -0
  260. package/dist/docs/guide/systems/audio-system.md +28 -0
  261. package/dist/docs/guide/systems/camera-sync-system.md +31 -0
  262. package/dist/docs/guide/systems/environment-sync-system.md +31 -0
  263. package/dist/docs/guide/systems/input-system.md +217 -0
  264. package/dist/docs/guide/systems/light-sync-system.md +29 -0
  265. package/dist/docs/guide/systems/material-sync-system.md +32 -0
  266. package/dist/docs/guide/systems/mesh-geometry-system.md +40 -0
  267. package/dist/docs/guide/systems/object-management-system.md +38 -0
  268. package/dist/docs/guide/systems/object-visibility-system.md +26 -0
  269. package/dist/docs/guide/systems/physics-sync-system.md +56 -0
  270. package/dist/docs/guide/systems/postprocessing-sync-system.md +43 -0
  271. package/dist/docs/guide/systems/render-system.md +22 -0
  272. package/dist/docs/guide/systems/script-behaviour-system.md +59 -0
  273. package/dist/docs/guide/systems/transform-sync-system.md +29 -0
  274. package/dist/docs/guide/systems/video-system.md +30 -0
  275. package/dist/docs/guide/world-api.md +405 -0
  276. package/dist/factories/index.cjs +3077 -0
  277. package/dist/factories/index.cjs.map +1 -0
  278. package/dist/factories/index.d.cts +69 -0
  279. package/dist/factories/index.d.ts +69 -0
  280. package/dist/factories/index.js +6 -0
  281. package/dist/factories/index.js.map +1 -0
  282. package/dist/index-B4-YyUNR.d.cts +73 -0
  283. package/dist/index-BZUOKeTO.d.ts +73 -0
  284. package/dist/index.cjs +8584 -0
  285. package/dist/index.cjs.map +1 -0
  286. package/dist/index.d.cts +283 -0
  287. package/dist/index.d.ts +283 -0
  288. package/dist/index.js +1729 -0
  289. package/dist/index.js.map +1 -0
  290. package/dist/systems/index.cjs +5119 -0
  291. package/dist/systems/index.cjs.map +1 -0
  292. package/dist/systems/index.d.cts +200 -0
  293. package/dist/systems/index.d.ts +200 -0
  294. package/dist/systems/index.js +6 -0
  295. package/dist/systems/index.js.map +1 -0
  296. package/dist/types.cjs +4 -0
  297. package/dist/types.cjs.map +1 -0
  298. package/dist/types.d.cts +3 -0
  299. package/dist/types.d.ts +3 -0
  300. package/dist/types.js +3 -0
  301. package/dist/types.js.map +1 -0
  302. package/dist/worldSnapshotUtils.cjs +259 -0
  303. package/dist/worldSnapshotUtils.cjs.map +1 -0
  304. package/dist/worldSnapshotUtils.d.cts +3 -0
  305. package/dist/worldSnapshotUtils.d.ts +3 -0
  306. package/dist/worldSnapshotUtils.js +4 -0
  307. package/dist/worldSnapshotUtils.js.map +1 -0
  308. package/package.json +80 -0
@@ -0,0 +1,28 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createTransformComponent
6
+
7
+ # Function: createTransformComponent()
8
+
9
+ ```ts
10
+ function createTransformComponent(
11
+ world,
12
+ entityId, ...
13
+ args): TransformComponent;
14
+ ```
15
+
16
+ Defined in: [factories/components/TransformFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/TransformFactory.ts#L4)
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `world` | [`World`](../classes/World.md) |
23
+ | `entityId` | `number` |
24
+ | ...`args` | \[[`TransformData`](../../components/type-aliases/TransformData.md)\] |
25
+
26
+ ## Returns
27
+
28
+ [`TransformComponent`](../../components/classes/TransformComponent.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) / createVideoComponent
6
+
7
+ # Function: createVideoComponent()
8
+
9
+ ```ts
10
+ function createVideoComponent(
11
+ world,
12
+ entityId, ...
13
+ args): VideoComponent;
14
+ ```
15
+
16
+ Defined in: [factories/components/VideoFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/VideoFactory.ts#L4)
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `world` | [`World`](../classes/World.md) |
23
+ | `entityId` | `number` |
24
+ | ...`args` | \[`string`, `Partial`\<\{ `autoplay`: `boolean`; `loop`: `boolean`; `volume`: `number`; `width`: `number`; `height`: `number`; `isGreenScreen`: `boolean`; `backgroundColor`: `string`; `similarity`: `number`; `smoothness`: `number`; `spill`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \}\>\] |
25
+
26
+ ## Returns
27
+
28
+ [`VideoComponent`](../../components/classes/VideoComponent.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) / hydrateWorldFromSnapshot
6
+
7
+ # Function: hydrateWorldFromSnapshot()
8
+
9
+ ```ts
10
+ function hydrateWorldFromSnapshot(
11
+ snapshot,
12
+ world,
13
+ objectManagementSystem): number;
14
+ ```
15
+
16
+ Defined in: [hydration/hydrateWorld.ts:258](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/hydrateWorld.ts#L258)
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `snapshot` | \| [`EcsWorldStateSnapshotLike`](../type-aliases/EcsWorldStateSnapshotLike.md) \| `null` \| `undefined` |
23
+ | `world` | [`World`](../classes/World.md) |
24
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
25
+
26
+ ## Returns
27
+
28
+ `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) / hydrateWorldFromSnapshotDetailed
6
+
7
+ # Function: hydrateWorldFromSnapshotDetailed()
8
+
9
+ ```ts
10
+ function hydrateWorldFromSnapshotDetailed(
11
+ snapshot,
12
+ world,
13
+ objectManagementSystem): HydrateWorldFromSnapshotResult;
14
+ ```
15
+
16
+ Defined in: [hydration/hydrateWorld.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/hydrateWorld.ts#L170)
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `snapshot` | \| [`EcsWorldStateSnapshotLike`](../type-aliases/EcsWorldStateSnapshotLike.md) \| `null` \| `undefined` |
23
+ | `world` | [`World`](../classes/World.md) |
24
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
25
+
26
+ ## Returns
27
+
28
+ [`HydrateWorldFromSnapshotResult`](../type-aliases/HydrateWorldFromSnapshotResult.md)
@@ -0,0 +1,23 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / registerDefaultComponentFactories
6
+
7
+ # Function: registerDefaultComponentFactories()
8
+
9
+ ```ts
10
+ function registerDefaultComponentFactories(objectManagementSystem): void;
11
+ ```
12
+
13
+ Defined in: [factories/registerDefaultComponentFactories.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/registerDefaultComponentFactories.ts#L29)
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------ | ------ |
19
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
20
+
21
+ ## Returns
22
+
23
+ `void`
@@ -0,0 +1,23 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / registerDefaultFactories
6
+
7
+ # Function: registerDefaultFactories()
8
+
9
+ ```ts
10
+ function registerDefaultFactories(objectManagementSystem): void;
11
+ ```
12
+
13
+ Defined in: [factories/registerDefaultFactories.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/registerDefaultFactories.ts#L22)
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------ | ------ |
19
+ | `objectManagementSystem` | [`ObjectManagementSystem`](../classes/ObjectManagementSystem.md) |
20
+
21
+ ## Returns
22
+
23
+ `void`
@@ -0,0 +1,249 @@
1
+ [**@relu-interactives/spatial-ecs**](../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../index.md) / index
6
+
7
+ # index
8
+
9
+ ## Classes
10
+
11
+ ### Other
12
+
13
+ | Class | Description |
14
+ | ------ | ------ |
15
+ | [AnimationStateMachine](classes/AnimationStateMachine.md) | - |
16
+ | [AnimationStateManager](classes/AnimationStateManager.md) | - |
17
+ | [World](classes/World.md) | - |
18
+ | [AnimationSystem](classes/AnimationSystem.md) | - |
19
+ | [CameraSyncSystem](classes/CameraSyncSystem.md) | - |
20
+ | [EnvironmentSyncSystem](classes/EnvironmentSyncSystem.md) | - |
21
+ | [InputSystem](classes/InputSystem.md) | - |
22
+ | [LightSyncSystem](classes/LightSyncSystem.md) | - |
23
+ | [MaterialSyncSystem](classes/MaterialSyncSystem.md) | - |
24
+ | [MeshGeometrySystem](classes/MeshGeometrySystem.md) | - |
25
+ | [ObjectManagementSystem](classes/ObjectManagementSystem.md) | - |
26
+ | [ObjectVisibilitySystem](classes/ObjectVisibilitySystem.md) | - |
27
+ | [PhysicsSyncSystem](classes/PhysicsSyncSystem.md) | - |
28
+ | [PostprocessingSyncSystem](classes/PostprocessingSyncSystem.md) | - |
29
+ | [RenderSystem](classes/RenderSystem.md) | - |
30
+ | [ScriptBehaviourSystem](classes/ScriptBehaviourSystem.md) | - |
31
+ | [TransformSyncSystem](classes/TransformSyncSystem.md) | - |
32
+
33
+ ### Systems
34
+
35
+ | Class | Description |
36
+ | ------ | ------ |
37
+ | [AudioSystem](classes/AudioSystem.md) | Reconciles `AudioComponent` state with the underlying THREE.js audio objects each frame. |
38
+ | [VideoSystem](classes/VideoSystem.md) | Reconciles `VideoComponent` state with the underlying HTML video element and THREE.js mesh/material each frame. |
39
+
40
+ ## Interfaces
41
+
42
+ | Interface | Description |
43
+ | ------ | ------ |
44
+ | [StateMachine](interfaces/StateMachine.md) | - |
45
+ | [EcsSystem](interfaces/EcsSystem.md) | - |
46
+
47
+ ## Type Aliases
48
+
49
+ | Type Alias | Description |
50
+ | ------ | ------ |
51
+ | [AnimationStateCallbacks](type-aliases/AnimationStateCallbacks.md) | - |
52
+ | [EcsWorldComponentSnapshot](type-aliases/EcsWorldComponentSnapshot.md) | - |
53
+ | [EcsWorldStateSnapshotLike](type-aliases/EcsWorldStateSnapshotLike.md) | - |
54
+ | [HydrateWorldFromSnapshotResult](type-aliases/HydrateWorldFromSnapshotResult.md) | - |
55
+ | [MouseButton](type-aliases/MouseButton.md) | - |
56
+ | [EcsComponentFactoryKind](type-aliases/EcsComponentFactoryKind.md) | - |
57
+ | [ComponentFactory](type-aliases/ComponentFactory.md) | - |
58
+ | [SelectionContext](type-aliases/SelectionContext.md) | Optional context that enables raycast-based onSelect / onDeselect dispatch. When provided, pointer/touch taps on the canvas fire a raycast against the scene. If the hit object (or any ancestor) carries userData.entityId, every Behaviour instance for that entity receives onSelect(); the previously selected entity's instances receive onDeselect(). |
59
+ | [KeyboardKey](type-aliases/KeyboardKey.md) | - |
60
+
61
+ ## Variables
62
+
63
+ | Variable | Description |
64
+ | ------ | ------ |
65
+ | [HYDRATABLE\_ENTITY\_KINDS](variables/HYDRATABLE_ENTITY_KINDS.md) | - |
66
+ | [KeyboardKeys](variables/KeyboardKeys.md) | - |
67
+
68
+ ## Functions
69
+
70
+ | Function | Description |
71
+ | ------ | ------ |
72
+ | [createAnimationComponent](functions/createAnimationComponent.md) | - |
73
+ | [createAudioComponent](functions/createAudioComponent.md) | - |
74
+ | [createCameraComponent](functions/createCameraComponent.md) | - |
75
+ | [createEntityTypeComponent](functions/createEntityTypeComponent.md) | - |
76
+ | [createEnvironmentComponent](functions/createEnvironmentComponent.md) | - |
77
+ | [createImageComponent](functions/createImageComponent.md) | - |
78
+ | [createImageTargetAnchorComponent](functions/createImageTargetAnchorComponent.md) | - |
79
+ | [createImageTargetComponent](functions/createImageTargetComponent.md) | - |
80
+ | [createLightComponent](functions/createLightComponent.md) | - |
81
+ | [createMaterialComponent](functions/createMaterialComponent.md) | - |
82
+ | [createMeshComponent](functions/createMeshComponent.md) | - |
83
+ | [createMeshGeometryComponent](functions/createMeshGeometryComponent.md) | - |
84
+ | [createModelComponent](functions/createModelComponent.md) | - |
85
+ | [createNameComponent](functions/createNameComponent.md) | - |
86
+ | [createObject3DRefComponent](functions/createObject3DRefComponent.md) | - |
87
+ | [createParentIdComponent](functions/createParentIdComponent.md) | - |
88
+ | [createPhysicsComponent](functions/createPhysicsComponent.md) | - |
89
+ | [createPostprocessingComponent](functions/createPostprocessingComponent.md) | - |
90
+ | [createScriptComponent](functions/createScriptComponent.md) | - |
91
+ | [createSelectableComponent](functions/createSelectableComponent.md) | - |
92
+ | [createSelectionTransformStateComponent](functions/createSelectionTransformStateComponent.md) | - |
93
+ | [createSpriteComponent](functions/createSpriteComponent.md) | - |
94
+ | [createTransformComponent](functions/createTransformComponent.md) | - |
95
+ | [createVideoComponent](functions/createVideoComponent.md) | - |
96
+ | [registerDefaultComponentFactories](functions/registerDefaultComponentFactories.md) | - |
97
+ | [registerDefaultFactories](functions/registerDefaultFactories.md) | - |
98
+ | [hydrateWorldFromSnapshotDetailed](functions/hydrateWorldFromSnapshotDetailed.md) | - |
99
+ | [hydrateWorldFromSnapshot](functions/hydrateWorldFromSnapshot.md) | - |
100
+
101
+ ## References
102
+
103
+ ### Component
104
+
105
+ Re-exports [Component](../Component/classes/Component.md)
106
+
107
+ ***
108
+
109
+ ### Behaviour
110
+
111
+ Re-exports [Behaviour](../Behaviour/classes/Behaviour.md)
112
+
113
+ ***
114
+
115
+ ### CoreComponents
116
+
117
+ Renames and re-exports [components](../components/index.md)
118
+
119
+ ***
120
+
121
+ ### EntityId
122
+
123
+ Re-exports [EntityId](../types/type-aliases/EntityId.md)
124
+
125
+ ***
126
+
127
+ ### EcsEntityKind
128
+
129
+ Re-exports [EcsEntityKind](../types/type-aliases/EcsEntityKind.md)
130
+
131
+ ***
132
+
133
+ ### EcsEntityEditorKind
134
+
135
+ Re-exports [EcsEntityEditorKind](../types/type-aliases/EcsEntityEditorKind.md)
136
+
137
+ ***
138
+
139
+ ### SelectionListener
140
+
141
+ Re-exports [SelectionListener](../types/type-aliases/SelectionListener.md)
142
+
143
+ ***
144
+
145
+ ### TextInput
146
+
147
+ Re-exports [TextInput](../types/type-aliases/TextInput.md)
148
+
149
+ ***
150
+
151
+ ### FloatInput
152
+
153
+ Re-exports [FloatInput](../types/type-aliases/FloatInput.md)
154
+
155
+ ***
156
+
157
+ ### ColorInput
158
+
159
+ Re-exports [ColorInput](../types/type-aliases/ColorInput.md)
160
+
161
+ ***
162
+
163
+ ### Vector2Input
164
+
165
+ Re-exports [Vector2Input](../types/type-aliases/Vector2Input.md)
166
+
167
+ ***
168
+
169
+ ### Vector3Input
170
+
171
+ Re-exports [Vector3Input](../types/type-aliases/Vector3Input.md)
172
+
173
+ ***
174
+
175
+ ### SliderInput
176
+
177
+ Re-exports [SliderInput](../types/type-aliases/SliderInput.md)
178
+
179
+ ***
180
+
181
+ ### DropdownOption
182
+
183
+ Re-exports [DropdownOption](../types/type-aliases/DropdownOption.md)
184
+
185
+ ***
186
+
187
+ ### DropdownInput
188
+
189
+ Re-exports [DropdownInput](../types/type-aliases/DropdownInput.md)
190
+
191
+ ***
192
+
193
+ ### CheckboxInput
194
+
195
+ Re-exports [CheckboxInput](../types/type-aliases/CheckboxInput.md)
196
+
197
+ ***
198
+
199
+ ### ToggleInput
200
+
201
+ Re-exports [ToggleInput](../types/type-aliases/ToggleInput.md)
202
+
203
+ ***
204
+
205
+ ### AssetInput
206
+
207
+ Re-exports [AssetInput](../types/type-aliases/AssetInput.md)
208
+
209
+ ***
210
+
211
+ ### EntityInput
212
+
213
+ Re-exports [EntityInput](../types/type-aliases/EntityInput.md)
214
+
215
+ ***
216
+
217
+ ### ComponentKind
218
+
219
+ Re-exports [ComponentKind](../types/type-aliases/ComponentKind.md)
220
+
221
+ ***
222
+
223
+ ### ComponentInput
224
+
225
+ Re-exports [ComponentInput](../types/type-aliases/ComponentInput.md)
226
+
227
+ ***
228
+
229
+ ### WorldEntityView
230
+
231
+ Re-exports [WorldEntityView](../types/type-aliases/WorldEntityView.md)
232
+
233
+ ***
234
+
235
+ ### ParentLookup
236
+
237
+ Re-exports [ParentLookup](../types/type-aliases/ParentLookup.md)
238
+
239
+ ***
240
+
241
+ ### Vec3
242
+
243
+ Re-exports [Vec3](../types/type-aliases/Vec3.md)
244
+
245
+ ***
246
+
247
+ ### IntersectionResult
248
+
249
+ Re-exports [IntersectionResult](../types/type-aliases/IntersectionResult.md)
@@ -0,0 +1,50 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EcsSystem
6
+
7
+ # Interface: EcsSystem
8
+
9
+ Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/System.ts#L3)
10
+
11
+ ## Methods
12
+
13
+ ### update()
14
+
15
+ ```ts
16
+ update(world, deltaTime): void;
17
+ ```
18
+
19
+ Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/System.ts#L4)
20
+
21
+ #### Parameters
22
+
23
+ | Parameter | Type |
24
+ | ------ | ------ |
25
+ | `world` | [`World`](../classes/World.md) |
26
+ | `deltaTime` | `number` |
27
+
28
+ #### Returns
29
+
30
+ `void`
31
+
32
+ ***
33
+
34
+ ### dispose()?
35
+
36
+ ```ts
37
+ optional dispose(world): void;
38
+ ```
39
+
40
+ Defined in: [System.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/System.ts#L5)
41
+
42
+ #### Parameters
43
+
44
+ | Parameter | Type |
45
+ | ------ | ------ |
46
+ | `world` | [`World`](../classes/World.md) |
47
+
48
+ #### Returns
49
+
50
+ `void`
@@ -0,0 +1,26 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / StateMachine
6
+
7
+ # Interface: StateMachine
8
+
9
+ Defined in: [AnimationStateMachine.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L3)
10
+
11
+ ## Properties
12
+
13
+ | Property | Type | Defined in |
14
+ | ------ | ------ | ------ |
15
+ | <a id="name"></a> `name` | `string` | [AnimationStateMachine.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L4) |
16
+ | <a id="clip"></a> `clip` | `AnimationClip` | [AnimationStateMachine.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L5) |
17
+ | <a id="clipid"></a> `clipId` | `string` \| `null` | [AnimationStateMachine.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L6) |
18
+ | <a id="loop"></a> `loop` | `boolean` | [AnimationStateMachine.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L7) |
19
+ | <a id="isplaying"></a> `isPlaying` | `boolean` | [AnimationStateMachine.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L8) |
20
+ | <a id="ispaused"></a> `isPaused` | `boolean` | [AnimationStateMachine.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L9) |
21
+ | <a id="onstart"></a> `onStart` | () => `void` | [AnimationStateMachine.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L10) |
22
+ | <a id="onplaying"></a> `onPlaying` | () => `void` | [AnimationStateMachine.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L11) |
23
+ | <a id="onend"></a> `onEnd` | () => `void` | [AnimationStateMachine.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L12) |
24
+ | <a id="play"></a> `play` | () => `void` | [AnimationStateMachine.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L13) |
25
+ | <a id="pause"></a> `pause` | () => `void` | [AnimationStateMachine.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L14) |
26
+ | <a id="stop"></a> `stop` | () => `void` | [AnimationStateMachine.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L15) |
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AnimationStateCallbacks
6
+
7
+ # Type Alias: AnimationStateCallbacks
8
+
9
+ ```ts
10
+ type AnimationStateCallbacks = {
11
+ onStart?: () => void;
12
+ onPlaying?: () => void;
13
+ onEnd?: () => void;
14
+ };
15
+ ```
16
+
17
+ Defined in: [AnimationStateMachine.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L18)
18
+
19
+ ## Properties
20
+
21
+ | Property | Type | Defined in |
22
+ | ------ | ------ | ------ |
23
+ | <a id="onstart"></a> `onStart?` | () => `void` | [AnimationStateMachine.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L19) |
24
+ | <a id="onplaying"></a> `onPlaying?` | () => `void` | [AnimationStateMachine.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L20) |
25
+ | <a id="onend"></a> `onEnd?` | () => `void` | [AnimationStateMachine.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L21) |
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ComponentFactory
6
+
7
+ # Type Alias: ComponentFactory
8
+
9
+ ```ts
10
+ type ComponentFactory = (world, entityId, ...args) => unknown;
11
+ ```
12
+
13
+ Defined in: [systems/ObjectManagementSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/ObjectManagementSystem.ts#L57)
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------ | ------ |
19
+ | `world` | [`World`](../classes/World.md) |
20
+ | `entityId` | [`EntityId`](../../types/type-aliases/EntityId.md) |
21
+ | ...`args` | `any`[] |
22
+
23
+ ## Returns
24
+
25
+ `unknown`
@@ -0,0 +1,37 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EcsComponentFactoryKind
6
+
7
+ # Type Alias: EcsComponentFactoryKind
8
+
9
+ ```ts
10
+ type EcsComponentFactoryKind =
11
+ | "animation"
12
+ | "audio"
13
+ | "camera"
14
+ | "environment"
15
+ | "entityType"
16
+ | "image"
17
+ | "imageTargetAnchor"
18
+ | "imageTarget"
19
+ | "light"
20
+ | "material"
21
+ | "mesh"
22
+ | "meshGeometry"
23
+ | "model"
24
+ | "name"
25
+ | "object3DRef"
26
+ | "parentId"
27
+ | "physics"
28
+ | "postprocessing"
29
+ | "script"
30
+ | "selectable"
31
+ | "selectionTransformState"
32
+ | "sprite"
33
+ | "transform"
34
+ | "video";
35
+ ```
36
+
37
+ Defined in: [systems/ObjectManagementSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/ObjectManagementSystem.ts#L31)
@@ -0,0 +1,26 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EcsWorldComponentSnapshot
6
+
7
+ # Type Alias: EcsWorldComponentSnapshot
8
+
9
+ ```ts
10
+ type EcsWorldComponentSnapshot = {
11
+ component: string;
12
+ entries: {
13
+ entityId: number;
14
+ value: unknown;
15
+ }[];
16
+ };
17
+ ```
18
+
19
+ Defined in: [hydration/types.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L38)
20
+
21
+ ## Properties
22
+
23
+ | Property | Type | Defined in |
24
+ | ------ | ------ | ------ |
25
+ | <a id="component"></a> `component` | `string` | [hydration/types.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L39) |
26
+ | <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L40) |
@@ -0,0 +1,25 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EcsWorldStateSnapshotLike
6
+
7
+ # Type Alias: EcsWorldStateSnapshotLike
8
+
9
+ ```ts
10
+ type EcsWorldStateSnapshotLike = {
11
+ selectedEntityId?: number | null;
12
+ entities: number[];
13
+ components: EcsWorldComponentSnapshot[];
14
+ };
15
+ ```
16
+
17
+ Defined in: [hydration/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L46)
18
+
19
+ ## Properties
20
+
21
+ | Property | Type | Defined in |
22
+ | ------ | ------ | ------ |
23
+ | <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L47) |
24
+ | <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L48) |
25
+ | <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L49) |
@@ -0,0 +1,23 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / HydrateWorldFromSnapshotResult
6
+
7
+ # Type Alias: HydrateWorldFromSnapshotResult
8
+
9
+ ```ts
10
+ type HydrateWorldFromSnapshotResult = {
11
+ restoredCount: number;
12
+ selectedEntityId: number | null;
13
+ };
14
+ ```
15
+
16
+ Defined in: [hydration/types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L52)
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Defined in |
21
+ | ------ | ------ | ------ |
22
+ | <a id="restoredcount"></a> `restoredCount` | `number` | [hydration/types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L53) |
23
+ | <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | [hydration/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L54) |
@@ -0,0 +1,13 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / KeyboardKey
6
+
7
+ # Type Alias: KeyboardKey
8
+
9
+ ```ts
10
+ type KeyboardKey = typeof KeyboardKeys[keyof typeof KeyboardKeys];
11
+ ```
12
+
13
+ Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L92)