@relu-interactives/spatial-ecs 0.10.0 → 0.11.1

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 (503) hide show
  1. package/dist/{System-BldSHxZV.d.cts → System-D8vm-Jvv.d.cts} +110 -3
  2. package/dist/{System-CADhPyQs.d.ts → System-ttkDQCrj.d.ts} +110 -3
  3. package/dist/{XRHandPose-D3Ab1Dfs.d.cts → XRHandPose-C97XVW2R.d.cts} +2 -41
  4. package/dist/{XRHandPose-BNSwd1y9.d.ts → XRHandPose-CxXtWF1y.d.ts} +2 -41
  5. package/dist/animation/index.cjs +33 -1
  6. package/dist/animation/index.cjs.map +1 -1
  7. package/dist/animation/index.js +1 -1
  8. package/dist/{chunk-TY3XCHOR.js → chunk-2DJBNWBB.js} +56 -15
  9. package/dist/chunk-2DJBNWBB.js.map +1 -0
  10. package/dist/{chunk-WWP46AEF.js → chunk-4FHJA6U4.js} +8 -4
  11. package/dist/chunk-4FHJA6U4.js.map +1 -0
  12. package/dist/{chunk-GSWC6LLD.js → chunk-GMSFEXUZ.js} +35 -3
  13. package/dist/chunk-GMSFEXUZ.js.map +1 -0
  14. package/dist/{chunk-JEPUCLZX.js → chunk-QAZCVCMP.js} +88 -27
  15. package/dist/chunk-QAZCVCMP.js.map +1 -0
  16. package/dist/{chunk-NXASMBDS.js → chunk-SM5KGNYX.js} +4 -4
  17. package/dist/{chunk-NXASMBDS.js.map → chunk-SM5KGNYX.js.map} +1 -1
  18. package/dist/{chunk-JNYPJB55.js → chunk-T7SRBLPJ.js} +24 -4
  19. package/dist/chunk-T7SRBLPJ.js.map +1 -0
  20. package/dist/components/index.cjs +21 -1
  21. package/dist/components/index.cjs.map +1 -1
  22. package/dist/components/index.d.cts +3 -3
  23. package/dist/components/index.d.ts +3 -3
  24. package/dist/components/index.js +1 -1
  25. package/dist/docs/api/Behaviour/classes/Behaviour.md +187 -46
  26. package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +5 -5
  27. package/dist/docs/api/Component/classes/Component.md +7 -1
  28. package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
  29. package/dist/docs/api/components/classes/AudioComponent.md +20 -19
  30. package/dist/docs/api/components/classes/BoneAttachmentComponent.md +65 -0
  31. package/dist/docs/api/components/classes/CameraComponent.md +14 -14
  32. package/dist/docs/api/components/classes/EntityType.md +3 -3
  33. package/dist/docs/api/components/classes/Environment.md +3 -3
  34. package/dist/docs/api/components/classes/IKComponent.md +59 -0
  35. package/dist/docs/api/components/classes/ImageComponent.md +7 -7
  36. package/dist/docs/api/components/classes/ImageTarget.md +7 -7
  37. package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
  38. package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
  39. package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
  40. package/dist/docs/api/components/classes/LightComponent.md +6 -6
  41. package/dist/docs/api/components/classes/MaterialComponent.md +14 -14
  42. package/dist/docs/api/components/classes/MeshComponent.md +3 -3
  43. package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
  44. package/dist/docs/api/components/classes/ModelComponent.md +6 -6
  45. package/dist/docs/api/components/classes/Name.md +3 -3
  46. package/dist/docs/api/components/classes/NetworkIdentityComponent.md +42 -0
  47. package/dist/docs/api/components/classes/NetworkSpawnerComponent.md +48 -0
  48. package/dist/docs/api/components/classes/NetworkTransformComponent.md +51 -0
  49. package/dist/docs/api/components/classes/NetworkedPropsComponent.md +47 -0
  50. package/dist/docs/api/components/classes/Object3DRef.md +4 -4
  51. package/dist/docs/api/components/classes/ParentId.md +3 -3
  52. package/dist/docs/api/components/classes/PhysicsComponent.md +7 -7
  53. package/dist/docs/api/components/classes/Postprocessing.md +3 -3
  54. package/dist/docs/api/components/classes/PrefabInstance.md +5 -5
  55. package/dist/docs/api/components/classes/PrefabNode.md +3 -3
  56. package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
  57. package/dist/docs/api/components/classes/ScriptObjectComponent.md +9 -9
  58. package/dist/docs/api/components/classes/Selectable.md +3 -3
  59. package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
  60. package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
  61. package/dist/docs/api/components/classes/TransformComponent.md +12 -12
  62. package/dist/docs/api/components/classes/UIButtonComponent.md +18 -14
  63. package/dist/docs/api/components/classes/UIPanelComponent.md +13 -11
  64. package/dist/docs/api/components/classes/UISliderComponent.md +16 -11
  65. package/dist/docs/api/components/classes/UITextComponent.md +14 -12
  66. package/dist/docs/api/components/classes/UIToggleComponent.md +12 -9
  67. package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +6 -6
  68. package/dist/docs/api/components/classes/VideoComponent.md +28 -28
  69. package/dist/docs/api/components/classes/XRAnchorComponent.md +3 -3
  70. package/dist/docs/api/components/classes/XREnvironmentComponent.md +5 -5
  71. package/dist/docs/api/components/classes/XRHandPoseComponent.md +4 -4
  72. package/dist/docs/api/components/classes/XRInteractableComponent.md +28 -28
  73. package/dist/docs/api/components/classes/XRInteractorComponent.md +10 -10
  74. package/dist/docs/api/components/classes/XRInteractorSideComponent.md +3 -3
  75. package/dist/docs/api/components/classes/XRRigComponent.md +17 -17
  76. package/dist/docs/api/components/functions/createAttachPoint.md +1 -1
  77. package/dist/docs/api/components/functions/createHandPoseEntry.md +1 -1
  78. package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
  79. package/dist/docs/api/components/functions/handPoseDefinitionFor.md +1 -1
  80. package/dist/docs/api/components/functions/normalizeBoneHold.md +25 -0
  81. package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +1 -1
  82. package/dist/docs/api/components/functions/normalizeIKChain.md +25 -0
  83. package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
  84. package/dist/docs/api/components/functions/setModelLoadState.md +1 -1
  85. package/dist/docs/api/components/functions/setPhysicsLiveRef.md +1 -1
  86. package/dist/docs/api/components/index.md +18 -0
  87. package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
  88. package/dist/docs/api/components/type-aliases/BoneAttachmentOptions.md +35 -0
  89. package/dist/docs/api/components/type-aliases/BoneHold.md +34 -0
  90. package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
  91. package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
  92. package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
  93. package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
  94. package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
  95. package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
  96. package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
  97. package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
  98. package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
  99. package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
  100. package/dist/docs/api/components/type-aliases/EnvironmentLightingState.md +9 -9
  101. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +1 -1
  102. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +8 -8
  103. package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
  104. package/dist/docs/api/components/type-aliases/EnvironmentState.md +6 -6
  105. package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +1 -1
  106. package/dist/docs/api/components/type-aliases/IKChain.md +37 -0
  107. package/dist/docs/api/components/type-aliases/IKLimb.md +15 -0
  108. package/dist/docs/api/components/type-aliases/IKOptions.md +27 -0
  109. package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
  110. package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
  111. package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
  112. package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
  113. package/dist/docs/api/components/type-aliases/LightShadowState.md +8 -8
  114. package/dist/docs/api/components/type-aliases/LightValueState.md +12 -12
  115. package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
  116. package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
  117. package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
  118. package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
  119. package/dist/docs/api/components/type-aliases/ModelLoadState.md +1 -1
  120. package/dist/docs/api/components/type-aliases/NetValue.md +23 -0
  121. package/dist/docs/api/components/type-aliases/NetworkTransformOptions.md +18 -0
  122. package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
  123. package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
  124. package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
  125. package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
  126. package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
  127. package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
  128. package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
  129. package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -8
  130. package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +1 -1
  131. package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +1 -1
  132. package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
  133. package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
  134. package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
  135. package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
  136. package/dist/docs/api/components/type-aliases/UIButtonOptions.md +21 -13
  137. package/dist/docs/api/components/type-aliases/UIPanelOptions.md +14 -10
  138. package/dist/docs/api/components/type-aliases/UISliderOptions.md +20 -10
  139. package/dist/docs/api/components/type-aliases/UITextOptions.md +15 -11
  140. package/dist/docs/api/components/type-aliases/UIToggleOptions.md +14 -8
  141. package/dist/docs/api/components/type-aliases/UiFollowMode.md +1 -1
  142. package/dist/docs/api/components/type-aliases/UiIconPosition.md +13 -0
  143. package/dist/docs/api/components/type-aliases/UiSliderVariant.md +13 -0
  144. package/dist/docs/api/components/type-aliases/UiTextAlign.md +1 -1
  145. package/dist/docs/api/components/type-aliases/UiTextVAlign.md +1 -1
  146. package/dist/docs/api/components/type-aliases/UiToggleVariant.md +13 -0
  147. package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +5 -5
  148. package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
  149. package/dist/docs/api/components/type-aliases/VrTeleportShape.md +1 -1
  150. package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +2 -2
  151. package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +3 -3
  152. package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +27 -27
  153. package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +9 -9
  154. package/dist/docs/api/components/type-aliases/XRRigOptions.md +16 -16
  155. package/dist/docs/api/components/type-aliases/XrAttachPoint.md +13 -13
  156. package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +1 -1
  157. package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +1 -1
  158. package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +1 -1
  159. package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +1 -1
  160. package/dist/docs/api/components/type-aliases/XrGrabGesture.md +1 -1
  161. package/dist/docs/api/components/type-aliases/XrGrabHands.md +1 -1
  162. package/dist/docs/api/components/type-aliases/XrGrabReach.md +1 -1
  163. package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +12 -12
  164. package/dist/docs/api/components/type-aliases/XrHandPreset.md +1 -1
  165. package/dist/docs/api/components/type-aliases/XrInteractorSide.md +1 -1
  166. package/dist/docs/api/components/type-aliases/XrInteractorType.md +1 -1
  167. package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +1 -1
  168. package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +1 -1
  169. package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +1 -1
  170. package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
  171. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +1 -1
  172. package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
  173. package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
  174. package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
  175. package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
  176. package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
  177. package/dist/docs/api/components/variables/DEFAULT_POSE_CURLS.md +1 -1
  178. package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +1 -1
  179. package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
  180. package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
  181. package/dist/docs/api/components/variables/MODEL_NO_PATH_MESSAGE.md +1 -1
  182. package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
  183. package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
  184. package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
  185. package/dist/docs/api/index/classes/AudioMixer.md +161 -0
  186. package/dist/docs/api/index/classes/AudioSystem.md +138 -4
  187. package/dist/docs/api/index/classes/BoneHoldSystem.md +54 -0
  188. package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
  189. package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
  190. package/dist/docs/api/index/classes/HandPoseTracker.md +6 -6
  191. package/dist/docs/api/index/classes/IKSystem.md +98 -0
  192. package/dist/docs/api/index/classes/InputSystem.md +33 -33
  193. package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
  194. package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
  195. package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
  196. package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
  197. package/dist/docs/api/index/classes/ObjectManagementSystem.md +269 -14
  198. package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
  199. package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
  200. package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
  201. package/dist/docs/api/index/classes/RenderSystem.md +3 -3
  202. package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
  203. package/dist/docs/api/index/classes/ScriptObject.md +10 -10
  204. package/dist/docs/api/index/classes/ScriptObjectSystem.md +6 -6
  205. package/dist/docs/api/index/classes/SlotChooser.md +59 -0
  206. package/dist/docs/api/index/classes/TeleportAimGate.md +4 -4
  207. package/dist/docs/api/index/classes/ThrowVelocityTracker.md +4 -4
  208. package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
  209. package/dist/docs/api/index/classes/UIInteractionSystem.md +3 -3
  210. package/dist/docs/api/index/classes/UIPanelSystem.md +4 -4
  211. package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +2 -2
  212. package/dist/docs/api/index/classes/VideoSystem.md +4 -4
  213. package/dist/docs/api/index/classes/World.md +168 -98
  214. package/dist/docs/api/index/classes/XRAnchorSystem.md +4 -4
  215. package/dist/docs/api/index/classes/XRControllerVisualSystem.md +4 -4
  216. package/dist/docs/api/index/classes/XREnvironmentSystem.md +7 -7
  217. package/dist/docs/api/index/classes/XRHandPoseSystem.md +5 -5
  218. package/dist/docs/api/index/classes/XRHitTestSystem.md +4 -4
  219. package/dist/docs/api/index/classes/XRHoverVisualSystem.md +4 -4
  220. package/dist/docs/api/index/classes/XRInputSystem.md +9 -9
  221. package/dist/docs/api/index/classes/XRInteractionSystem.md +18 -18
  222. package/dist/docs/api/index/classes/XRLocomotionSystem.md +7 -7
  223. package/dist/docs/api/index/classes/XRSessionSystem.md +6 -6
  224. package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +4 -4
  225. package/dist/docs/api/index/functions/angularVelocityFrom.md +1 -1
  226. package/dist/docs/api/index/functions/applyHandMaterial.md +1 -1
  227. package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
  228. package/dist/docs/api/index/functions/arcGroundCrossing.md +1 -1
  229. package/dist/docs/api/index/functions/buildComponentValueMaps.md +1 -1
  230. package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +1 -1
  231. package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +1 -1
  232. package/dist/docs/api/index/functions/canonicalizeComponentValue.md +1 -1
  233. package/dist/docs/api/index/functions/clearModelCache.md +1 -1
  234. package/dist/docs/api/index/functions/clearPrefabCache.md +1 -1
  235. package/dist/docs/api/index/functions/cloneHandPose.md +1 -1
  236. package/dist/docs/api/index/functions/collectDiffPaths.md +1 -1
  237. package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +1 -1
  238. package/dist/docs/api/index/functions/collectEntitySubtree.md +1 -1
  239. package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +1 -1
  240. package/dist/docs/api/index/functions/computeFingerCurl.md +1 -1
  241. package/dist/docs/api/index/functions/computeHandShape.md +1 -1
  242. package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
  243. package/dist/docs/api/index/functions/computePalmPose.md +1 -1
  244. package/dist/docs/api/index/functions/computePalmWidth.md +1 -1
  245. package/dist/docs/api/index/functions/computePinch.md +1 -1
  246. package/dist/docs/api/index/functions/computeSpread.md +1 -1
  247. package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
  248. package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
  249. package/dist/docs/api/index/functions/createBoneAttachmentComponent.md +28 -0
  250. package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
  251. package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
  252. package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
  253. package/dist/docs/api/index/functions/createGLTFLoader.md +30 -0
  254. package/dist/docs/api/index/functions/createHandMaterial.md +1 -1
  255. package/dist/docs/api/index/functions/createIKComponent.md +28 -0
  256. package/dist/docs/api/index/functions/createImageComponent.md +1 -1
  257. package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
  258. package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
  259. package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
  260. package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
  261. package/dist/docs/api/index/functions/createLightComponent.md +1 -1
  262. package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
  263. package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
  264. package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
  265. package/dist/docs/api/index/functions/createModelComponent.md +1 -1
  266. package/dist/docs/api/index/functions/createNameComponent.md +1 -1
  267. package/dist/docs/api/index/functions/createNetworkIdentityComponent.md +24 -0
  268. package/dist/docs/api/index/functions/createNetworkSpawnerComponent.md +28 -0
  269. package/dist/docs/api/index/functions/createNetworkTransformComponent.md +28 -0
  270. package/dist/docs/api/index/functions/createNetworkedPropsComponent.md +28 -0
  271. package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
  272. package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
  273. package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
  274. package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
  275. package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
  276. package/dist/docs/api/index/functions/createScriptObjectComponent.md +1 -1
  277. package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
  278. package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
  279. package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
  280. package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
  281. package/dist/docs/api/index/functions/createUIButtonComponent.md +1 -1
  282. package/dist/docs/api/index/functions/createUIPanelComponent.md +1 -1
  283. package/dist/docs/api/index/functions/createUISliderComponent.md +1 -1
  284. package/dist/docs/api/index/functions/createUITextComponent.md +1 -1
  285. package/dist/docs/api/index/functions/createUIToggleComponent.md +1 -1
  286. package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +1 -1
  287. package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
  288. package/dist/docs/api/index/functions/createXRAnchorComponent.md +1 -1
  289. package/dist/docs/api/index/functions/createXRHandPoseComponent.md +1 -1
  290. package/dist/docs/api/index/functions/createXRInteractableComponent.md +1 -1
  291. package/dist/docs/api/index/functions/createXRInteractorComponent.md +1 -1
  292. package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +1 -1
  293. package/dist/docs/api/index/functions/createXRRigComponent.md +1 -1
  294. package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +1 -1
  295. package/dist/docs/api/index/functions/despawnPrefab.md +1 -1
  296. package/dist/docs/api/index/functions/encodeOverride.md +1 -1
  297. package/dist/docs/api/index/functions/estimateHandScale.md +1 -1
  298. package/dist/docs/api/index/functions/findModelBone.md +30 -0
  299. package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +1 -1
  300. package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +1 -1
  301. package/dist/docs/api/index/functions/getHandPosePreset.md +1 -1
  302. package/dist/docs/api/index/functions/gripQuaternion.md +36 -0
  303. package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
  304. package/dist/docs/api/index/functions/handPoseFromCurls.md +1 -1
  305. package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
  306. package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
  307. package/dist/docs/api/index/functions/indexSnapshotByEntity.md +1 -1
  308. package/dist/docs/api/index/functions/instantiateSubtree.md +1 -1
  309. package/dist/docs/api/index/functions/listModelBones.md +25 -0
  310. package/dist/docs/api/index/functions/loadPrefab.md +1 -1
  311. package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
  312. package/dist/docs/api/index/functions/matchHandPose.md +1 -1
  313. package/dist/docs/api/index/functions/mergeComponentValue.md +1 -1
  314. package/dist/docs/api/index/functions/parseOverride.md +1 -1
  315. package/dist/docs/api/index/functions/parsePrefabAsset.md +1 -1
  316. package/dist/docs/api/index/functions/prefabFileVersionFor.md +1 -1
  317. package/dist/docs/api/index/functions/readXrCapabilities.md +1 -1
  318. package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
  319. package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
  320. package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +3 -3
  321. package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +1 -1
  322. package/dist/docs/api/index/functions/restoreComponentState.md +1 -1
  323. package/dist/docs/api/index/functions/restorePostCreateComponents.md +1 -1
  324. package/dist/docs/api/index/functions/sampleTeleportArc.md +1 -1
  325. package/dist/docs/api/index/functions/serializeEntitySubtree.md +1 -1
  326. package/dist/docs/api/index/functions/setDracoDecoderPath.md +1 -1
  327. package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +1 -1
  328. package/dist/docs/api/index/functions/setWorldQuaternion.md +26 -0
  329. package/dist/docs/api/index/functions/soundBankFiles.md +25 -0
  330. package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
  331. package/dist/docs/api/index/functions/twoBoneIK.md +41 -0
  332. package/dist/docs/api/index/index.md +31 -0
  333. package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +5 -5
  334. package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
  335. package/dist/docs/api/index/interfaces/NetworkHandle.md +180 -0
  336. package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +6 -6
  337. package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +5 -5
  338. package/dist/docs/api/index/interfaces/RenderBackend.md +8 -8
  339. package/dist/docs/api/index/interfaces/SoundBankAsset.md +18 -0
  340. package/dist/docs/api/index/interfaces/SoundSlot.md +31 -0
  341. package/dist/docs/api/index/interfaces/SoundTake.md +18 -0
  342. package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
  343. package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
  344. package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +3 -3
  345. package/dist/docs/api/index/type-aliases/AudioBus.md +15 -0
  346. package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
  347. package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -38
  348. package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +7 -1
  349. package/dist/docs/api/index/type-aliases/EcsRenderer.md +1 -1
  350. package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
  351. package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
  352. package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +5 -5
  353. package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +4 -4
  354. package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +5 -5
  355. package/dist/docs/api/index/type-aliases/HydrateOptions.md +3 -3
  356. package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +4 -4
  357. package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +3 -3
  358. package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
  359. package/dist/docs/api/index/type-aliases/ModelBoneInfo.md +29 -0
  360. package/dist/docs/api/index/type-aliases/ModuleLoader.md +1 -1
  361. package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
  362. package/dist/docs/api/index/type-aliases/NestedRegion.md +5 -5
  363. package/dist/docs/api/index/type-aliases/NetSpawnOptions.md +41 -0
  364. package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +5 -5
  365. package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
  366. package/dist/docs/api/index/type-aliases/PlaySlotOptions.md +32 -0
  367. package/dist/docs/api/index/type-aliases/PrefabAsset.md +5 -5
  368. package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +2 -2
  369. package/dist/docs/api/index/type-aliases/RendererKind.md +1 -1
  370. package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +2 -2
  371. package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +9 -9
  372. package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +1 -1
  373. package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +1 -1
  374. package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +6 -6
  375. package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +1 -1
  376. package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
  377. package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +4 -4
  378. package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +5 -5
  379. package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +1 -1
  380. package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +4 -3
  381. package/dist/docs/api/index/type-aliases/UiCanvasLike.md +4 -4
  382. package/dist/docs/api/index/type-aliases/UiColorStop.md +37 -0
  383. package/dist/docs/api/index/type-aliases/UiPaint.md +81 -0
  384. package/dist/docs/api/index/type-aliases/UiShadow.md +27 -0
  385. package/dist/docs/api/index/type-aliases/UiStyle.md +43 -0
  386. package/dist/docs/api/index/type-aliases/UiTextStyle.md +33 -0
  387. package/dist/docs/api/index/type-aliases/UiTokens.md +13 -0
  388. package/dist/docs/api/index/type-aliases/VelocitySample.md +3 -3
  389. package/dist/docs/api/index/type-aliases/XrCapabilities.md +9 -9
  390. package/dist/docs/api/index/type-aliases/XrFinger.md +1 -1
  391. package/dist/docs/api/index/type-aliases/XrFingerCurl.md +4 -4
  392. package/dist/docs/api/index/type-aliases/XrFingerTarget.md +6 -6
  393. package/dist/docs/api/index/type-aliases/XrHandJointName.md +1 -1
  394. package/dist/docs/api/index/type-aliases/XrHandJoints.md +1 -1
  395. package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +1 -1
  396. package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +2 -2
  397. package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +11 -11
  398. package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +1 -1
  399. package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +1 -1
  400. package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +5 -5
  401. package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +4 -4
  402. package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +4 -4
  403. package/dist/docs/api/index/type-aliases/XrHandShape.md +13 -13
  404. package/dist/docs/api/index/type-aliases/XrHandedness.md +1 -1
  405. package/dist/docs/api/index/type-aliases/XrHitResult.md +3 -3
  406. package/dist/docs/api/index/type-aliases/XrInputKind.md +1 -1
  407. package/dist/docs/api/index/type-aliases/XrInputState.md +18 -18
  408. package/dist/docs/api/index/type-aliases/XrPalmPose.md +6 -6
  409. package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +1 -1
  410. package/dist/docs/api/index/variables/ARC_GRAVITY.md +1 -1
  411. package/dist/docs/api/index/variables/ARC_MAX_TIME.md +1 -1
  412. package/dist/docs/api/index/variables/ARC_SPEED.md +1 -1
  413. package/dist/docs/api/index/variables/ARC_STEPS.md +1 -1
  414. package/dist/docs/api/index/variables/CURLED_COS.md +1 -1
  415. package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +1 -1
  416. package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +1 -1
  417. package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +1 -1
  418. package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +1 -1
  419. package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +1 -1
  420. package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +1 -1
  421. package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +1 -1
  422. package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +1 -1
  423. package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +1 -1
  424. package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
  425. package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
  426. package/dist/docs/api/index/variables/MATCH_FALLOFF.md +1 -1
  427. package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +1 -1
  428. package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +1 -1
  429. package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
  430. package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +1 -1
  431. package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +1 -1
  432. package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +1 -1
  433. package/dist/docs/api/index/variables/PINCH_FINGERS.md +1 -1
  434. package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +1 -1
  435. package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +1 -1
  436. package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +1 -1
  437. package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +1 -1
  438. package/dist/docs/api/index/variables/STRAIGHT_COS.md +1 -1
  439. package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +1 -1
  440. package/dist/docs/api/index/variables/XR_FINGERS.md +1 -1
  441. package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +1 -1
  442. package/dist/docs/api/index/variables/webglBackend.md +1 -1
  443. package/dist/docs/api/typedoc-sidebar.json +1 -1
  444. package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
  445. package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
  446. package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
  447. package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
  448. package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
  449. package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
  450. package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
  451. package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
  452. package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
  453. package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
  454. package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
  455. package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
  456. package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
  457. package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
  458. package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
  459. package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
  460. package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
  461. package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
  462. package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
  463. package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
  464. package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
  465. package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
  466. package/dist/docs/guide/bone-attachments-and-ik.md +51 -0
  467. package/dist/docs/guide/components/audio.md +1 -1
  468. package/dist/factories/index.cjs +29 -1
  469. package/dist/factories/index.cjs.map +1 -1
  470. package/dist/factories/index.d.cts +2 -2
  471. package/dist/factories/index.d.ts +2 -2
  472. package/dist/factories/index.js +4 -4
  473. package/dist/{index-BXjwEdNq.d.cts → index-BbrnjNXy.d.ts} +5 -3
  474. package/dist/{index-CVG-hREM.d.ts → index-DD7aHv0p.d.cts} +5 -3
  475. package/dist/{index-6pZO_gV7.d.ts → index-OgOoIpEI.d.ts} +14 -2
  476. package/dist/{index-BdghvXKE.d.cts → index-xyqzT0PQ.d.cts} +14 -2
  477. package/dist/index.cjs +174 -13
  478. package/dist/index.cjs.map +1 -1
  479. package/dist/index.d.cts +10 -9
  480. package/dist/index.d.ts +10 -9
  481. package/dist/index.js +13 -11
  482. package/dist/index.js.map +1 -1
  483. package/dist/network/index.cjs +70 -38
  484. package/dist/network/index.cjs.map +1 -1
  485. package/dist/network/index.d.cts +2 -2
  486. package/dist/network/index.d.ts +2 -2
  487. package/dist/network/index.js +4 -4
  488. package/dist/systems/index.cjs +171 -13
  489. package/dist/systems/index.cjs.map +1 -1
  490. package/dist/systems/index.d.cts +2 -2
  491. package/dist/systems/index.d.ts +2 -2
  492. package/dist/systems/index.js +5 -5
  493. package/dist/types.d.cts +1 -1
  494. package/dist/types.d.ts +1 -1
  495. package/dist/webgpu/index.d.ts +2 -2
  496. package/dist/worldSnapshotUtils.d.cts +1 -1
  497. package/dist/worldSnapshotUtils.d.ts +1 -1
  498. package/package.json +2 -1
  499. package/dist/chunk-GSWC6LLD.js.map +0 -1
  500. package/dist/chunk-JEPUCLZX.js.map +0 -1
  501. package/dist/chunk-JNYPJB55.js.map +0 -1
  502. package/dist/chunk-TY3XCHOR.js.map +0 -1
  503. package/dist/chunk-WWP46AEF.js.map +0 -1
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ObjectManagementSystem
8
8
 
9
- Defined in: [systems/ObjectManagementSystem.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L112)
9
+ Defined in: [systems/ObjectManagementSystem.ts:147](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L147)
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:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L123)
26
+ Defined in: [systems/ObjectManagementSystem.ts:163](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L163)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -45,7 +45,7 @@ Defined in: [systems/ObjectManagementSystem.ts:123](https://github.com/Relu-Inte
45
45
  register(kind, factory): void;
46
46
  ```
47
47
 
48
- Defined in: [systems/ObjectManagementSystem.ts:133](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L133)
48
+ Defined in: [systems/ObjectManagementSystem.ts:173](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L173)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -66,7 +66,7 @@ Defined in: [systems/ObjectManagementSystem.ts:133](https://github.com/Relu-Inte
66
66
  registerComponentFactory(kind, factory): void;
67
67
  ```
68
68
 
69
- Defined in: [systems/ObjectManagementSystem.ts:137](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L137)
69
+ Defined in: [systems/ObjectManagementSystem.ts:177](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L177)
70
70
 
71
71
  #### Parameters
72
72
 
@@ -87,7 +87,7 @@ Defined in: [systems/ObjectManagementSystem.ts:137](https://github.com/Relu-Inte
87
87
  getOrCreateAudioListener(): AudioListener;
88
88
  ```
89
89
 
90
- Defined in: [systems/ObjectManagementSystem.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L144)
90
+ Defined in: [systems/ObjectManagementSystem.ts:184](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L184)
91
91
 
92
92
  #### Returns
93
93
 
@@ -101,7 +101,7 @@ Defined in: [systems/ObjectManagementSystem.ts:144](https://github.com/Relu-Inte
101
101
  isEditorMode(): boolean;
102
102
  ```
103
103
 
104
- Defined in: [systems/ObjectManagementSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L156)
104
+ Defined in: [systems/ObjectManagementSystem.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L196)
105
105
 
106
106
  #### Returns
107
107
 
@@ -115,7 +115,7 @@ Defined in: [systems/ObjectManagementSystem.ts:156](https://github.com/Relu-Inte
115
115
  getComponentFactory(kind): ComponentFactory | null;
116
116
  ```
117
117
 
118
- Defined in: [systems/ObjectManagementSystem.ts:160](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L160)
118
+ Defined in: [systems/ObjectManagementSystem.ts:200](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L200)
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:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L164)
142
+ Defined in: [systems/ObjectManagementSystem.ts:204](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L204)
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:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L178)
168
+ Defined in: [systems/ObjectManagementSystem.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L218)
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:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L186)
193
+ Defined in: [systems/ObjectManagementSystem.ts:226](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L226)
194
194
 
195
195
  #### Parameters
196
196
 
@@ -215,7 +215,7 @@ deleteEntity(
215
215
  dispose?): boolean;
216
216
  ```
217
217
 
218
- Defined in: [systems/ObjectManagementSystem.ts:238](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L238)
218
+ Defined in: [systems/ObjectManagementSystem.ts:278](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L278)
219
219
 
220
220
  Removes an entity from the ECS world and its associated `Object3D` from the
221
221
  THREE.js scene graph.
@@ -257,7 +257,7 @@ setParent(
257
257
  options?): boolean;
258
258
  ```
259
259
 
260
- Defined in: [systems/ObjectManagementSystem.ts:272](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L272)
260
+ Defined in: [systems/ObjectManagementSystem.ts:312](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L312)
261
261
 
262
262
  #### Parameters
263
263
 
@@ -281,7 +281,7 @@ Defined in: [systems/ObjectManagementSystem.ts:272](https://github.com/Relu-Inte
281
281
  reconcileSceneFromWorld(world): void;
282
282
  ```
283
283
 
284
- Defined in: [systems/ObjectManagementSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L362)
284
+ Defined in: [systems/ObjectManagementSystem.ts:406](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L406)
285
285
 
286
286
  #### Parameters
287
287
 
@@ -295,13 +295,268 @@ Defined in: [systems/ObjectManagementSystem.ts:362](https://github.com/Relu-Inte
295
295
 
296
296
  ***
297
297
 
298
+ ### hasBoneHold()
299
+
300
+ ```ts
301
+ hasBoneHold(entityId): boolean;
302
+ ```
303
+
304
+ Defined in: [systems/ObjectManagementSystem.ts:551](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L551)
305
+
306
+ Whether [applyBoneHold](#applybonehold) is managing this attachment.
307
+
308
+ #### Parameters
309
+
310
+ | Parameter | Type |
311
+ | ------ | ------ |
312
+ | `entityId` | `number` |
313
+
314
+ #### Returns
315
+
316
+ `boolean`
317
+
318
+ ***
319
+
320
+ ### applyBoneHold()
321
+
322
+ ```ts
323
+ applyBoneHold(
324
+ world,
325
+ entityId,
326
+ hold,
327
+ hidden): void;
328
+ ```
329
+
330
+ Defined in: [systems/ObjectManagementSystem.ts:560](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L560)
331
+
332
+ Put an attachment in a hold for the clip now playing (`hold` null: the
333
+ attachment's own bone and Transform), moving it to the hold's bone if that
334
+ changed. Called each frame, since a socket can be rebuilt under it.
335
+
336
+ #### Parameters
337
+
338
+ | Parameter | Type |
339
+ | ------ | ------ |
340
+ | `world` | [`World`](World.md) |
341
+ | `entityId` | `number` |
342
+ | `hold` | [`BoneHold`](../../components/type-aliases/BoneHold.md) \| `null` |
343
+ | `hidden` | `boolean` |
344
+
345
+ #### Returns
346
+
347
+ `void`
348
+
349
+ ***
350
+
351
+ ### releaseBoneHold()
352
+
353
+ ```ts
354
+ releaseBoneHold(world, entityId): void;
355
+ ```
356
+
357
+ Defined in: [systems/ObjectManagementSystem.ts:597](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L597)
358
+
359
+ Stop managing an attachment that no longer has holds, and put it back.
360
+
361
+ #### Parameters
362
+
363
+ | Parameter | Type |
364
+ | ------ | ------ |
365
+ | `world` | [`World`](World.md) |
366
+ | `entityId` | `number` |
367
+
368
+ #### Returns
369
+
370
+ `void`
371
+
372
+ ***
373
+
374
+ ### reloadModel()
375
+
376
+ ```ts
377
+ reloadModel(world, entityId): boolean;
378
+ ```
379
+
380
+ Defined in: [systems/ObjectManagementSystem.ts:606](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L606)
381
+
382
+ Load a model entity's file again and swap it in (the file was rewritten);
383
+ the entity, its components and children stay, attachments re-home.
384
+
385
+ #### Parameters
386
+
387
+ | Parameter | Type |
388
+ | ------ | ------ |
389
+ | `world` | [`World`](World.md) |
390
+ | `entityId` | `number` |
391
+
392
+ #### Returns
393
+
394
+ `boolean`
395
+
396
+ ***
397
+
398
+ ### reloadModelsAt()
399
+
400
+ ```ts
401
+ reloadModelsAt(world, matches): number;
402
+ ```
403
+
404
+ Defined in: [systems/ObjectManagementSystem.ts:611](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L611)
405
+
406
+ Reload every model entity whose path `matches` (returns how many).
407
+
408
+ #### Parameters
409
+
410
+ | Parameter | Type |
411
+ | ------ | ------ |
412
+ | `world` | [`World`](World.md) |
413
+ | `matches` | (`path`) => `boolean` |
414
+
415
+ #### Returns
416
+
417
+ `number`
418
+
419
+ ***
420
+
421
+ ### listModelBones()
422
+
423
+ ```ts
424
+ listModelBones(world, entityId): ModelBoneInfo[];
425
+ ```
426
+
427
+ Defined in: [systems/ObjectManagementSystem.ts:621](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L621)
428
+
429
+ The bones of an entity's loaded model (empty until it loads, or for a model without a skeleton).
430
+
431
+ #### Parameters
432
+
433
+ | Parameter | Type |
434
+ | ------ | ------ |
435
+ | `world` | [`World`](World.md) |
436
+ | `entityId` | `number` |
437
+
438
+ #### Returns
439
+
440
+ [`ModelBoneInfo`](../type-aliases/ModelBoneInfo.md)[]
441
+
442
+ ***
443
+
444
+ ### getBoneSocket()
445
+
446
+ ```ts
447
+ getBoneSocket(entityId): Object3D<Object3DEventMap> | null;
448
+ ```
449
+
450
+ Defined in: [systems/ObjectManagementSystem.ts:627](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L627)
451
+
452
+ The socket object an attached entity currently hangs under, if resolved.
453
+
454
+ #### Parameters
455
+
456
+ | Parameter | Type |
457
+ | ------ | ------ |
458
+ | `entityId` | `number` |
459
+
460
+ #### Returns
461
+
462
+ `Object3D`\<`Object3DEventMap`\> \| `null`
463
+
464
+ ***
465
+
466
+ ### attachToBone()
467
+
468
+ ```ts
469
+ attachToBone(
470
+ world,
471
+ entityId,
472
+ parentEntityId,
473
+ ref,
474
+ options?): {
475
+ ok: boolean;
476
+ resolved: boolean;
477
+ bone: string | null;
478
+ };
479
+ ```
480
+
481
+ Defined in: [systems/ObjectManagementSystem.ts:639](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L639)
482
+
483
+ Fix `entityId` to a bone of `parentEntityId`'s model (making it the
484
+ parent if it isn't). With `preserveWorldTransform` (default) it stays
485
+ where it is and its Transform becomes the offset from the bone; without,
486
+ it snaps onto the bone (zero offset). Returns whether the bone was found
487
+ (when the model is still loading, the attachment is stored and resolves
488
+ once it loads, without preserving the pose).
489
+
490
+ #### Parameters
491
+
492
+ | Parameter | Type |
493
+ | ------ | ------ |
494
+ | `world` | [`World`](World.md) |
495
+ | `entityId` | `number` |
496
+ | `parentEntityId` | `number` |
497
+ | `ref` | \{ `bone?`: `string`; `humanoid?`: `string` \| `null`; \} |
498
+ | `ref.bone?` | `string` |
499
+ | `ref.humanoid?` | `string` \| `null` |
500
+ | `options?` | \{ `preserveWorldTransform?`: `boolean`; `compensateScale?`: `boolean`; \} |
501
+ | `options.preserveWorldTransform?` | `boolean` |
502
+ | `options.compensateScale?` | `boolean` |
503
+
504
+ #### Returns
505
+
506
+ ```ts
507
+ {
508
+ ok: boolean;
509
+ resolved: boolean;
510
+ bone: string | null;
511
+ }
512
+ ```
513
+
514
+ | Name | Type | Defined in |
515
+ | ------ | ------ | ------ |
516
+ | `ok` | `boolean` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
517
+ | `resolved` | `boolean` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
518
+ | `bone` | `string` \| `null` | [systems/ObjectManagementSystem.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L645) |
519
+
520
+ ***
521
+
522
+ ### detachFromBone()
523
+
524
+ ```ts
525
+ detachFromBone(
526
+ world,
527
+ entityId,
528
+ options?): boolean;
529
+ ```
530
+
531
+ Defined in: [systems/ObjectManagementSystem.ts:703](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L703)
532
+
533
+ Release a bone attachment. The entity stays a child of the character
534
+ (or moves to the root with `toRoot`), and by default keeps its place in
535
+ the world.
536
+
537
+ #### Parameters
538
+
539
+ | Parameter | Type |
540
+ | ------ | ------ |
541
+ | `world` | [`World`](World.md) |
542
+ | `entityId` | `number` |
543
+ | `options?` | \{ `preserveWorldTransform?`: `boolean`; `toRoot?`: `boolean`; \} |
544
+ | `options.preserveWorldTransform?` | `boolean` |
545
+ | `options.toRoot?` | `boolean` |
546
+
547
+ #### Returns
548
+
549
+ `boolean`
550
+
551
+ ***
552
+
298
553
  ### update()
299
554
 
300
555
  ```ts
301
556
  update(world): void;
302
557
  ```
303
558
 
304
- Defined in: [systems/ObjectManagementSystem.ts:406](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L406)
559
+ Defined in: [systems/ObjectManagementSystem.ts:734](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L734)
305
560
 
306
561
  #### Parameters
307
562
 
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectVisibilitySystem.ts#L5)
9
+ Defined in: [systems/ObjectVisibilitySystem.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectVisibilitySystem.ts#L6)
35
+ Defined in: [systems/ObjectVisibilitySystem.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/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:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L352)
9
+ Defined in: [systems/PhysicsSyncSystem.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PhysicsSyncSystem.ts#L352)
10
10
 
11
11
  ## Implements
12
12
 
@@ -20,7 +20,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:352](https://github.com/Relu-Interacti
20
20
  new PhysicsSyncSystem(options?): PhysicsSyncSystem;
21
21
  ```
22
22
 
23
- Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L362)
23
+ Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PhysicsSyncSystem.ts#L362)
24
24
 
25
25
  #### Parameters
26
26
 
@@ -41,7 +41,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:362](https://github.com/Relu-Interacti
41
41
  update(world, deltaTime): void;
42
42
  ```
43
43
 
44
- Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L416)
44
+ Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PhysicsSyncSystem.ts#L416)
45
45
 
46
46
  #### Parameters
47
47
 
@@ -66,7 +66,7 @@ Defined in: [systems/PhysicsSyncSystem.ts:416](https://github.com/Relu-Interacti
66
66
  dispose(world): void;
67
67
  ```
68
68
 
69
- Defined in: [systems/PhysicsSyncSystem.ts:681](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PhysicsSyncSystem.ts#L681)
69
+ Defined in: [systems/PhysicsSyncSystem.ts:681](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PhysicsSyncSystem.ts#L681)
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:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L39)
9
+ Defined in: [systems/PostprocessingSyncSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L39)
10
10
 
11
11
  Builds the post-processing chain from the scene's [Postprocessing](../../components/classes/Postprocessing.md)
12
12
  component and hands it to `RenderSystem` through `scene.userData`:
@@ -46,7 +46,7 @@ new PostprocessingSyncSystem(
46
46
  backend?): PostprocessingSyncSystem;
47
47
  ```
48
48
 
49
- Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L54)
49
+ Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L54)
50
50
 
51
51
  #### Parameters
52
52
 
@@ -69,7 +69,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:54](https://github.com/Relu-Int
69
69
  update(world): void;
70
70
  ```
71
71
 
72
- Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L156)
72
+ Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L156)
73
73
 
74
74
  #### Parameters
75
75
 
@@ -93,7 +93,7 @@ Defined in: [systems/PostprocessingSyncSystem.ts:156](https://github.com/Relu-In
93
93
  dispose(): void;
94
94
  ```
95
95
 
96
- Defined in: [systems/PostprocessingSyncSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/PostprocessingSyncSystem.ts#L186)
96
+ Defined in: [systems/PostprocessingSyncSystem.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/PostprocessingSyncSystem.ts#L186)
97
97
 
98
98
  #### Returns
99
99
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: RenderSystem
8
8
 
9
- Defined in: [systems/RenderSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L31)
9
+ Defined in: [systems/RenderSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L31)
10
10
 
11
11
  Draws the frame: through the post-processing chain in
12
12
  `scene.userData.ecsPostprocessingComposer` while
@@ -33,7 +33,7 @@ new RenderSystem(
33
33
  afterRender?): RenderSystem;
34
34
  ```
35
35
 
36
- Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L43)
36
+ Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L43)
37
37
 
38
38
  #### Parameters
39
39
 
@@ -56,7 +56,7 @@ Defined in: [systems/RenderSystem.ts:43](https://github.com/Relu-Interactives/re
56
56
  update(_world): void;
57
57
  ```
58
58
 
59
- Defined in: [systems/RenderSystem.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/RenderSystem.ts#L119)
59
+ Defined in: [systems/RenderSystem.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/RenderSystem.ts#L119)
60
60
 
61
61
  #### Parameters
62
62
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ScriptBehaviourSystem
8
8
 
9
- Defined in: [systems/ScriptBehaviourSystem.ts:131](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L131)
9
+ Defined in: [systems/ScriptBehaviourSystem.ts:131](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L131)
10
10
 
11
11
  ## Implements
12
12
 
@@ -23,7 +23,7 @@ new ScriptBehaviourSystem(
23
23
  options?): ScriptBehaviourSystem;
24
24
  ```
25
25
 
26
- Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L151)
26
+ Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L151)
27
27
 
28
28
  #### Parameters
29
29
 
@@ -45,7 +45,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:151](https://github.com/Relu-Inter
45
45
  update(world, deltaTime): void;
46
46
  ```
47
47
 
48
- Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L286)
48
+ Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L286)
49
49
 
50
50
  #### Parameters
51
51
 
@@ -70,7 +70,7 @@ Defined in: [systems/ScriptBehaviourSystem.ts:286](https://github.com/Relu-Inter
70
70
  dispose(world): void;
71
71
  ```
72
72
 
73
- Defined in: [systems/ScriptBehaviourSystem.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L512)
73
+ Defined in: [systems/ScriptBehaviourSystem.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L512)
74
74
 
75
75
  #### Parameters
76
76
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ScriptObject
8
8
 
9
- Defined in: [ScriptObject.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L51)
9
+ Defined in: [ScriptObject.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L51)
10
10
 
11
11
  Base class for **script objects** — entities whose THREE.js visual is built
12
12
  entirely by user code (procedural geometry, shaders, particle systems,
@@ -64,7 +64,7 @@ new ScriptObject(
64
64
  data?): ScriptObject;
65
65
  ```
66
66
 
67
- Defined in: [ScriptObject.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L84)
67
+ Defined in: [ScriptObject.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L84)
68
68
 
69
69
  Engine-managed constructor. `ScriptObjectSystem` instantiates subclasses
70
70
  with the owning world, the entity id, and the component's `data`. User code
@@ -86,11 +86,11 @@ should not call this directly.
86
86
 
87
87
  | Property | Modifier | Type | Default value | Description | Defined in |
88
88
  | ------ | ------ | ------ | ------ | ------ | ------ |
89
- | <a id="__reluscriptobjectclass"></a> `__reluScriptObjectClass` | `readonly` | `true` | `undefined` | Static marker used by `ScriptObjectSystem` to detect `ScriptObject` subclasses even when a bundler ships a second copy of the package into the script blob (breaking `instanceof`). Do NOT override. | [ScriptObject.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L57) |
90
- | <a id="data"></a> `data` | `public` | `Record`\<`string`, `unknown`\> | `{}` | The script's data payload (the `ScriptObjectComponent.data`). Declare a concrete shape on subclasses with `declare data: MyShape` for type safety. Use the same typed input envelopes as Behaviours (`ColorInput`, `SliderInput`, `EntityInput`, …) to get inspector fields. | [ScriptObject.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L65) |
91
- | <a id="world"></a> `world` | `public` | [`World`](World.md) | `undefined` | The owning ECS world. | [ScriptObject.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L68) |
92
- | <a id="entityid"></a> `entityId` | `public` | `number` | `undefined` | The entity this script object is bound to. | [ScriptObject.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L71) |
93
- | <a id="root"></a> `root` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | `null` | The Object3D returned by [ScriptObject.build](#build). Assigned by `ScriptObjectSystem` after `build()` runs; `null` until then. | [ScriptObject.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L77) |
89
+ | <a id="__reluscriptobjectclass"></a> `__reluScriptObjectClass` | `readonly` | `true` | `undefined` | Static marker used by `ScriptObjectSystem` to detect `ScriptObject` subclasses even when a bundler ships a second copy of the package into the script blob (breaking `instanceof`). Do NOT override. | [ScriptObject.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L57) |
90
+ | <a id="data"></a> `data` | `public` | `Record`\<`string`, `unknown`\> | `{}` | The script's data payload (the `ScriptObjectComponent.data`). Declare a concrete shape on subclasses with `declare data: MyShape` for type safety. Use the same typed input envelopes as Behaviours (`ColorInput`, `SliderInput`, `EntityInput`, …) to get inspector fields. | [ScriptObject.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L65) |
91
+ | <a id="world"></a> `world` | `public` | [`World`](World.md) | `undefined` | The owning ECS world. | [ScriptObject.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L68) |
92
+ | <a id="entityid"></a> `entityId` | `public` | `number` | `undefined` | The entity this script object is bound to. | [ScriptObject.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L71) |
93
+ | <a id="root"></a> `root` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | `null` | The Object3D returned by [ScriptObject.build](#build). Assigned by `ScriptObjectSystem` after `build()` runs; `null` until then. | [ScriptObject.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L77) |
94
94
 
95
95
  ## Methods
96
96
 
@@ -100,7 +100,7 @@ should not call this directly.
100
100
  build(): Object3D;
101
101
  ```
102
102
 
103
- Defined in: [ScriptObject.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L96)
103
+ Defined in: [ScriptObject.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L96)
104
104
 
105
105
  REQUIRED — build and return the visual root. Called once by
106
106
  `ScriptObjectSystem` after construction. The returned object is attached
@@ -119,7 +119,7 @@ and visibility). Subclasses MUST override.
119
119
  optional update(deltaTime): void;
120
120
  ```
121
121
 
122
- Defined in: [ScriptObject.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L106)
122
+ Defined in: [ScriptObject.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L106)
123
123
 
124
124
  OPTIONAL — per-frame hook. Runs in the editor AND at runtime (e.g. advance
125
125
  a shader time uniform, procedural animation). Keep per-frame work on local
@@ -144,7 +144,7 @@ churns the editor's undo history).
144
144
  optional dispose(): void;
145
145
  ```
146
146
 
147
- Defined in: [ScriptObject.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/ScriptObject.ts#L114)
147
+ Defined in: [ScriptObject.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ScriptObject.ts#L114)
148
148
 
149
149
  OPTIONAL — free any GPU resources this script created (geometries,
150
150
  materials, textures, render targets). Called by `ScriptObjectSystem` when
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ScriptObjectSystem
8
8
 
9
- Defined in: [systems/ScriptObjectSystem.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L101)
9
+ Defined in: [systems/ScriptObjectSystem.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L101)
10
10
 
11
11
  Builds, ticks, and disposes [ScriptObject](ScriptObject.md) scripts. Unlike
12
12
  `ScriptBehaviourSystem`, this runs in the editor AND at runtime — there is NO
@@ -29,7 +29,7 @@ Construct it and pass it to `World.setup({ systems })`.
29
29
  new ScriptObjectSystem(moduleLoader?): ScriptObjectSystem;
30
30
  ```
31
31
 
32
- Defined in: [systems/ScriptObjectSystem.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L110)
32
+ Defined in: [systems/ScriptObjectSystem.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L110)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -49,7 +49,7 @@ Defined in: [systems/ScriptObjectSystem.ts:110](https://github.com/Relu-Interact
49
49
  update(world, deltaTime): void;
50
50
  ```
51
51
 
52
- Defined in: [systems/ScriptObjectSystem.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L114)
52
+ Defined in: [systems/ScriptObjectSystem.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L114)
53
53
 
54
54
  #### Parameters
55
55
 
@@ -74,7 +74,7 @@ Defined in: [systems/ScriptObjectSystem.ts:114](https://github.com/Relu-Interact
74
74
  invalidateAll(): void;
75
75
  ```
76
76
 
77
- Defined in: [systems/ScriptObjectSystem.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L441)
77
+ Defined in: [systems/ScriptObjectSystem.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L441)
78
78
 
79
79
  Dispose all live instances so the next update() reloads with fresh modules.
80
80
 
@@ -90,7 +90,7 @@ Dispose all live instances so the next update() reloads with fresh modules.
90
90
  invalidate(scriptUrl): void;
91
91
  ```
92
92
 
93
- Defined in: [systems/ScriptObjectSystem.ts:458](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L458)
93
+ Defined in: [systems/ScriptObjectSystem.ts:458](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L458)
94
94
 
95
95
  Invalidate only the entities whose script matches `scriptUrl`.
96
96
 
@@ -112,7 +112,7 @@ Invalidate only the entities whose script matches `scriptUrl`.
112
112
  dispose(world): void;
113
113
  ```
114
114
 
115
- Defined in: [systems/ScriptObjectSystem.ts:476](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptObjectSystem.ts#L476)
115
+ Defined in: [systems/ScriptObjectSystem.ts:476](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptObjectSystem.ts#L476)
116
116
 
117
117
  #### Parameters
118
118