@relu-interactives/spatial-ecs 0.11.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
@@ -20,10 +20,14 @@ type UIButtonOptions = {
20
20
  cornerRadius?: number;
21
21
  borderWidth?: number;
22
22
  borderColor?: string;
23
+ pixelDensity?: number;
24
+ style?: UiStyle;
25
+ icon?: string;
26
+ iconPosition?: UiIconPosition;
23
27
  };
24
28
  ```
25
29
 
26
- Defined in: [components/UIButton.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L4)
30
+ Defined in: [components/UIButton.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L7)
27
31
 
28
32
  Optional initializer for [UIButtonComponent](../classes/UIButtonComponent.md).
29
33
 
@@ -31,15 +35,19 @@ Optional initializer for [UIButtonComponent](../classes/UIButtonComponent.md).
31
35
 
32
36
  | Property | Type | Defined in |
33
37
  | ------ | ------ | ------ |
34
- | <a id="label"></a> `label?` | `string` | [components/UIButton.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L5) |
35
- | <a id="actionid"></a> `actionId?` | `string` | [components/UIButton.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L6) |
36
- | <a id="width"></a> `width?` | `number` | [components/UIButton.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L7) |
37
- | <a id="height"></a> `height?` | `number` | [components/UIButton.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L8) |
38
- | <a id="fontsize"></a> `fontSize?` | `number` | [components/UIButton.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L9) |
39
- | <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIButton.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L10) |
40
- | <a id="textcolor"></a> `textColor?` | `string` | [components/UIButton.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L11) |
41
- | <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIButton.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L12) |
42
- | <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIButton.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L13) |
43
- | <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIButton.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L14) |
44
- | <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIButton.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L15) |
45
- | <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIButton.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L16) |
38
+ | <a id="label"></a> `label?` | `string` | [components/UIButton.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L8) |
39
+ | <a id="actionid"></a> `actionId?` | `string` | [components/UIButton.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L9) |
40
+ | <a id="width"></a> `width?` | `number` | [components/UIButton.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L10) |
41
+ | <a id="height"></a> `height?` | `number` | [components/UIButton.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L11) |
42
+ | <a id="fontsize"></a> `fontSize?` | `number` | [components/UIButton.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L12) |
43
+ | <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIButton.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L13) |
44
+ | <a id="textcolor"></a> `textColor?` | `string` | [components/UIButton.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L14) |
45
+ | <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIButton.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L15) |
46
+ | <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIButton.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L16) |
47
+ | <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIButton.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L17) |
48
+ | <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIButton.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L18) |
49
+ | <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIButton.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L19) |
50
+ | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIButton.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L20) |
51
+ | <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | [components/UIButton.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L21) |
52
+ | <a id="icon"></a> `icon?` | `string` | [components/UIButton.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L22) |
53
+ | <a id="iconposition"></a> `iconPosition?` | [`UiIconPosition`](UiIconPosition.md) | [components/UIButton.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L23) |
@@ -17,10 +17,12 @@ type UIPanelOptions = {
17
17
  borderColor?: string;
18
18
  pixelDensity?: number;
19
19
  follow?: UiFollowMode;
20
+ style?: UiStyle;
21
+ tokens?: UiTokens;
20
22
  };
21
23
  ```
22
24
 
23
- Defined in: [components/UIPanel.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L7)
25
+ Defined in: [components/UIPanel.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L13)
24
26
 
25
27
  Optional initializer for [UIPanelComponent](../classes/UIPanelComponent.md).
26
28
 
@@ -28,12 +30,14 @@ Optional initializer for [UIPanelComponent](../classes/UIPanelComponent.md).
28
30
 
29
31
  | Property | Type | Defined in |
30
32
  | ------ | ------ | ------ |
31
- | <a id="width"></a> `width?` | `number` | [components/UIPanel.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L8) |
32
- | <a id="height"></a> `height?` | `number` | [components/UIPanel.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L9) |
33
- | <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIPanel.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L10) |
34
- | <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIPanel.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L11) |
35
- | <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIPanel.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L12) |
36
- | <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIPanel.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L13) |
37
- | <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIPanel.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L14) |
38
- | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIPanel.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L15) |
39
- | <a id="follow"></a> `follow?` | [`UiFollowMode`](UiFollowMode.md) | [components/UIPanel.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L16) |
33
+ | <a id="width"></a> `width?` | `number` | [components/UIPanel.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L14) |
34
+ | <a id="height"></a> `height?` | `number` | [components/UIPanel.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L15) |
35
+ | <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIPanel.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L16) |
36
+ | <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIPanel.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L17) |
37
+ | <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIPanel.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L18) |
38
+ | <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIPanel.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L19) |
39
+ | <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIPanel.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L20) |
40
+ | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIPanel.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L21) |
41
+ | <a id="follow"></a> `follow?` | [`UiFollowMode`](UiFollowMode.md) | [components/UIPanel.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L22) |
42
+ | <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | [components/UIPanel.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L23) |
43
+ | <a id="tokens"></a> `tokens?` | [`UiTokens`](../../index/type-aliases/UiTokens.md) | [components/UIPanel.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L24) |
@@ -17,10 +17,15 @@ type UISliderOptions = {
17
17
  trackColor?: string;
18
18
  accentColor?: string;
19
19
  knobColor?: string;
20
+ pixelDensity?: number;
21
+ style?: UiStyle;
22
+ variant?: UiSliderVariant;
23
+ step?: number;
24
+ readOnly?: boolean;
20
25
  };
21
26
  ```
22
27
 
23
- Defined in: [components/UISlider.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L4)
28
+ Defined in: [components/UISlider.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L7)
24
29
 
25
30
  Optional initializer for [UISliderComponent](../classes/UISliderComponent.md).
26
31
 
@@ -28,12 +33,17 @@ Optional initializer for [UISliderComponent](../classes/UISliderComponent.md).
28
33
 
29
34
  | Property | Type | Defined in |
30
35
  | ------ | ------ | ------ |
31
- | <a id="value"></a> `value?` | `number` | [components/UISlider.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L5) |
32
- | <a id="min"></a> `min?` | `number` | [components/UISlider.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L6) |
33
- | <a id="max"></a> `max?` | `number` | [components/UISlider.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L7) |
34
- | <a id="actionid"></a> `actionId?` | `string` | [components/UISlider.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L8) |
35
- | <a id="width"></a> `width?` | `number` | [components/UISlider.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L9) |
36
- | <a id="height"></a> `height?` | `number` | [components/UISlider.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L10) |
37
- | <a id="trackcolor"></a> `trackColor?` | `string` | [components/UISlider.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L11) |
38
- | <a id="accentcolor"></a> `accentColor?` | `string` | [components/UISlider.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L12) |
39
- | <a id="knobcolor"></a> `knobColor?` | `string` | [components/UISlider.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L13) |
36
+ | <a id="value"></a> `value?` | `number` | [components/UISlider.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L8) |
37
+ | <a id="min"></a> `min?` | `number` | [components/UISlider.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L9) |
38
+ | <a id="max"></a> `max?` | `number` | [components/UISlider.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L10) |
39
+ | <a id="actionid"></a> `actionId?` | `string` | [components/UISlider.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L11) |
40
+ | <a id="width"></a> `width?` | `number` | [components/UISlider.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L12) |
41
+ | <a id="height"></a> `height?` | `number` | [components/UISlider.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L13) |
42
+ | <a id="trackcolor"></a> `trackColor?` | `string` | [components/UISlider.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L14) |
43
+ | <a id="accentcolor"></a> `accentColor?` | `string` | [components/UISlider.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L15) |
44
+ | <a id="knobcolor"></a> `knobColor?` | `string` | [components/UISlider.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L16) |
45
+ | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UISlider.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L17) |
46
+ | <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | [components/UISlider.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L18) |
47
+ | <a id="variant"></a> `variant?` | [`UiSliderVariant`](UiSliderVariant.md) | [components/UISlider.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L19) |
48
+ | <a id="step"></a> `step?` | `number` | [components/UISlider.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L20) |
49
+ | <a id="readonly"></a> `readOnly?` | `boolean` | [components/UISlider.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L21) |
@@ -18,10 +18,12 @@ type UITextOptions = {
18
18
  valign?: UiTextVAlign;
19
19
  lineHeight?: number;
20
20
  padding?: number;
21
+ pixelDensity?: number;
22
+ style?: UiStyle;
21
23
  };
22
24
  ```
23
25
 
24
- Defined in: [components/UIText.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L7)
26
+ Defined in: [components/UIText.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L8)
25
27
 
26
28
  Optional initializer for [UITextComponent](../classes/UITextComponent.md).
27
29
 
@@ -29,13 +31,15 @@ Optional initializer for [UITextComponent](../classes/UITextComponent.md).
29
31
 
30
32
  | Property | Type | Defined in |
31
33
  | ------ | ------ | ------ |
32
- | <a id="text"></a> `text?` | `string` | [components/UIText.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L8) |
33
- | <a id="width"></a> `width?` | `number` | [components/UIText.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L9) |
34
- | <a id="height"></a> `height?` | `number` | [components/UIText.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L10) |
35
- | <a id="fontsize"></a> `fontSize?` | `number` | [components/UIText.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L11) |
36
- | <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIText.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L12) |
37
- | <a id="color"></a> `color?` | `string` | [components/UIText.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L13) |
38
- | <a id="align"></a> `align?` | [`UiTextAlign`](UiTextAlign.md) | [components/UIText.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L14) |
39
- | <a id="valign"></a> `valign?` | [`UiTextVAlign`](UiTextVAlign.md) | [components/UIText.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L15) |
40
- | <a id="lineheight"></a> `lineHeight?` | `number` | [components/UIText.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L16) |
41
- | <a id="padding"></a> `padding?` | `number` | [components/UIText.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L17) |
34
+ | <a id="text"></a> `text?` | `string` | [components/UIText.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L9) |
35
+ | <a id="width"></a> `width?` | `number` | [components/UIText.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L10) |
36
+ | <a id="height"></a> `height?` | `number` | [components/UIText.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L11) |
37
+ | <a id="fontsize"></a> `fontSize?` | `number` | [components/UIText.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L12) |
38
+ | <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIText.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L13) |
39
+ | <a id="color"></a> `color?` | `string` | [components/UIText.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L14) |
40
+ | <a id="align"></a> `align?` | [`UiTextAlign`](UiTextAlign.md) | [components/UIText.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L15) |
41
+ | <a id="valign"></a> `valign?` | [`UiTextVAlign`](UiTextVAlign.md) | [components/UIText.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L16) |
42
+ | <a id="lineheight"></a> `lineHeight?` | `number` | [components/UIText.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L17) |
43
+ | <a id="padding"></a> `padding?` | `number` | [components/UIText.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L18) |
44
+ | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIText.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L19) |
45
+ | <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | [components/UIText.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L20) |
@@ -15,10 +15,13 @@ type UIToggleOptions = {
15
15
  trackColor?: string;
16
16
  accentColor?: string;
17
17
  knobColor?: string;
18
+ pixelDensity?: number;
19
+ style?: UiStyle;
20
+ variant?: UiToggleVariant;
18
21
  };
19
22
  ```
20
23
 
21
- Defined in: [components/UIToggle.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L4)
24
+ Defined in: [components/UIToggle.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L7)
22
25
 
23
26
  Optional initializer for [UIToggleComponent](../classes/UIToggleComponent.md).
24
27
 
@@ -26,10 +29,13 @@ Optional initializer for [UIToggleComponent](../classes/UIToggleComponent.md).
26
29
 
27
30
  | Property | Type | Defined in |
28
31
  | ------ | ------ | ------ |
29
- | <a id="value"></a> `value?` | `boolean` | [components/UIToggle.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L5) |
30
- | <a id="actionid"></a> `actionId?` | `string` | [components/UIToggle.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L6) |
31
- | <a id="width"></a> `width?` | `number` | [components/UIToggle.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L7) |
32
- | <a id="height"></a> `height?` | `number` | [components/UIToggle.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L8) |
33
- | <a id="trackcolor"></a> `trackColor?` | `string` | [components/UIToggle.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L9) |
34
- | <a id="accentcolor"></a> `accentColor?` | `string` | [components/UIToggle.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L10) |
35
- | <a id="knobcolor"></a> `knobColor?` | `string` | [components/UIToggle.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L11) |
32
+ | <a id="value"></a> `value?` | `boolean` | [components/UIToggle.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L8) |
33
+ | <a id="actionid"></a> `actionId?` | `string` | [components/UIToggle.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L9) |
34
+ | <a id="width"></a> `width?` | `number` | [components/UIToggle.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L10) |
35
+ | <a id="height"></a> `height?` | `number` | [components/UIToggle.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L11) |
36
+ | <a id="trackcolor"></a> `trackColor?` | `string` | [components/UIToggle.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L12) |
37
+ | <a id="accentcolor"></a> `accentColor?` | `string` | [components/UIToggle.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L13) |
38
+ | <a id="knobcolor"></a> `knobColor?` | `string` | [components/UIToggle.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L14) |
39
+ | <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIToggle.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L15) |
40
+ | <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | [components/UIToggle.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L16) |
41
+ | <a id="variant"></a> `variant?` | [`UiToggleVariant`](UiToggleVariant.md) | [components/UIToggle.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L17) |
@@ -10,6 +10,6 @@
10
10
  type UiFollowMode = "world" | "billboard";
11
11
  ```
12
12
 
13
- Defined in: [components/UIPanel.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L4)
13
+ Defined in: [components/UIPanel.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L10)
14
14
 
15
15
  How a panel orients itself while the experience runs.
@@ -0,0 +1,13 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiIconPosition
6
+
7
+ # Type Alias: UiIconPosition
8
+
9
+ ```ts
10
+ type UiIconPosition = "left" | "right";
11
+ ```
12
+
13
+ Defined in: [components/UIButton.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L4)
@@ -0,0 +1,13 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiSliderVariant
6
+
7
+ # Type Alias: UiSliderVariant
8
+
9
+ ```ts
10
+ type UiSliderVariant = "slider" | "progress" | "ring";
11
+ ```
12
+
13
+ Defined in: [components/UISlider.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L4)
@@ -10,4 +10,4 @@
10
10
  type UiTextAlign = "left" | "center" | "right";
11
11
  ```
12
12
 
13
- Defined in: [components/UIText.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L3)
13
+ Defined in: [components/UIText.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L4)
@@ -10,4 +10,4 @@
10
10
  type UiTextVAlign = "top" | "middle" | "bottom";
11
11
  ```
12
12
 
13
- Defined in: [components/UIText.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L4)
13
+ Defined in: [components/UIText.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIText.ts#L5)
@@ -0,0 +1,13 @@
1
+ [**@relu-interactives/spatial-ecs**](../../index.md)
2
+
3
+ ***
4
+
5
+ [@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiToggleVariant
6
+
7
+ # Type Alias: UiToggleVariant
8
+
9
+ ```ts
10
+ type UiToggleVariant = "switch" | "checkbox" | "radio";
11
+ ```
12
+
13
+ Defined in: [components/UIToggle.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIToggle.ts#L4)
@@ -15,7 +15,7 @@ type VRTeleportAreaOptions = {
15
15
  };
16
16
  ```
17
17
 
18
- Defined in: [components/VRTeleportArea.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L7)
18
+ Defined in: [components/VRTeleportArea.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L7)
19
19
 
20
20
  Optional initializer for [VRTeleportAreaComponent](../classes/VRTeleportAreaComponent.md).
21
21
 
@@ -23,7 +23,7 @@ Optional initializer for [VRTeleportAreaComponent](../classes/VRTeleportAreaComp
23
23
 
24
24
  | Property | Type | Description | Defined in |
25
25
  | ------ | ------ | ------ | ------ |
26
- | <a id="enabled"></a> `enabled?` | `boolean` | Disable to keep the area authored but inert. | [components/VRTeleportArea.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L9) |
27
- | <a id="shape"></a> `shape?` | [`VrTeleportShape`](VrTeleportShape.md) | Footprint shape. | [components/VRTeleportArea.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L11) |
28
- | <a id="width"></a> `width?` | `number` | Full width in metres (`plane`), or diameter (`circle`). | [components/VRTeleportArea.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L13) |
29
- | <a id="depth"></a> `depth?` | `number` | Full depth in metres. Ignored for `circle`, which uses `width`. | [components/VRTeleportArea.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L15) |
26
+ | <a id="enabled"></a> `enabled?` | `boolean` | Disable to keep the area authored but inert. | [components/VRTeleportArea.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L9) |
27
+ | <a id="shape"></a> `shape?` | [`VrTeleportShape`](VrTeleportShape.md) | Footprint shape. | [components/VRTeleportArea.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L11) |
28
+ | <a id="width"></a> `width?` | `number` | Full width in metres (`plane`), or diameter (`circle`). | [components/VRTeleportArea.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L13) |
29
+ | <a id="depth"></a> `depth?` | `number` | Full depth in metres. Ignored for `circle`, which uses `width`. | [components/VRTeleportArea.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L15) |
@@ -14,7 +14,7 @@ type Vec3 = {
14
14
  };
15
15
  ```
16
16
 
17
- Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L10)
17
+ Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L10)
18
18
 
19
19
  Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vector3` so they save cleanly with the project.
20
20
 
@@ -22,6 +22,6 @@ Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vec
22
22
 
23
23
  | Property | Type | Description | Defined in |
24
24
  | ------ | ------ | ------ | ------ |
25
- | <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L12) |
26
- | <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L14) |
27
- | <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L16) |
25
+ | <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L12) |
26
+ | <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L14) |
27
+ | <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L16) |
@@ -10,6 +10,6 @@
10
10
  type VrTeleportShape = "plane" | "circle";
11
11
  ```
12
12
 
13
- Defined in: [components/VRTeleportArea.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L4)
13
+ Defined in: [components/VRTeleportArea.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/VRTeleportArea.ts#L4)
14
14
 
15
15
  Footprint of a teleport destination.
@@ -12,7 +12,7 @@ type XRAnchorOptions = {
12
12
  };
13
13
  ```
14
14
 
15
- Defined in: [components/XRAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L4)
15
+ Defined in: [components/XRAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRAnchor.ts#L4)
16
16
 
17
17
  Optional initializer for [XRAnchorComponent](../classes/XRAnchorComponent.md).
18
18
 
@@ -20,4 +20,4 @@ Optional initializer for [XRAnchorComponent](../classes/XRAnchorComponent.md).
20
20
 
21
21
  | Property | Type | Description | Defined in |
22
22
  | ------ | ------ | ------ | ------ |
23
- | <a id="enabled"></a> `enabled?` | `boolean` | Whether the entity should anchor at all. Defaults to `true`. | [components/XRAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L6) |
23
+ | <a id="enabled"></a> `enabled?` | `boolean` | Whether the entity should anchor at all. Defaults to `true`. | [components/XRAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRAnchor.ts#L6) |
@@ -13,11 +13,11 @@ type XRHandPoseOptions = {
13
13
  };
14
14
  ```
15
15
 
16
- Defined in: [components/XRHandPose.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L47)
16
+ Defined in: [components/XRHandPose.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L47)
17
17
 
18
18
  ## Properties
19
19
 
20
20
  | Property | Type | Defined in |
21
21
  | ------ | ------ | ------ |
22
- | <a id="enabled"></a> `enabled?` | `boolean` | [components/XRHandPose.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L48) |
23
- | <a id="poses"></a> `poses?` | [`XrHandPoseEntry`](XrHandPoseEntry.md)[] | [components/XRHandPose.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L49) |
22
+ | <a id="enabled"></a> `enabled?` | `boolean` | [components/XRHandPose.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L48) |
23
+ | <a id="poses"></a> `poses?` | [`XrHandPoseEntry`](XrHandPoseEntry.md)[] | [components/XRHandPose.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L49) |
@@ -39,7 +39,7 @@ type XRInteractableOptions = {
39
39
  };
40
40
  ```
41
41
 
42
- Defined in: [components/XRInteractable.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L77)
42
+ Defined in: [components/XRInteractable.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L77)
43
43
 
44
44
  Optional initializer for [XRInteractableComponent](../classes/XRInteractableComponent.md).
45
45
 
@@ -47,29 +47,29 @@ Optional initializer for [XRInteractableComponent](../classes/XRInteractableComp
47
47
 
48
48
  | Property | Type | Description | Defined in |
49
49
  | ------ | ------ | ------ | ------ |
50
- | <a id="enabled"></a> `enabled?` | `boolean` | - | [components/XRInteractable.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L78) |
51
- | <a id="grabbable"></a> `grabbable?` | `boolean` | - | [components/XRInteractable.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L79) |
52
- | <a id="pointable"></a> `pointable?` | `boolean` | - | [components/XRInteractable.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L80) |
53
- | <a id="grabreach"></a> `grabReach?` | [`XrGrabReach`](XrGrabReach.md) | - | [components/XRInteractable.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L81) |
54
- | <a id="distancebehavior"></a> `distanceBehavior?` | [`XrDistanceGrabBehavior`](XrDistanceGrabBehavior.md) | - | [components/XRInteractable.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L82) |
55
- | <a id="grabgesture"></a> `grabGesture?` | [`XrGrabGesture`](XrGrabGesture.md) | - | [components/XRInteractable.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L83) |
56
- | <a id="grabradius"></a> `grabRadius?` | `number` | Metres within which a `physical` grab registers. | [components/XRInteractable.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L85) |
57
- | <a id="graboffsetposition"></a> `grabOffsetPosition?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Where the object sits relative to the hand once held. | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
58
- | `grabOffsetPosition.x` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
59
- | `grabOffsetPosition.y` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
60
- | `grabOffsetPosition.z` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
61
- | <a id="graboffsetrotation"></a> `grabOffsetRotation?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Orientation offset, in radians. | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
62
- | `grabOffsetRotation.x` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
63
- | `grabOffsetRotation.y` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
64
- | `grabOffsetRotation.z` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
65
- | <a id="grabhands"></a> `grabHands?` | [`XrGrabHands`](XrGrabHands.md) | How many hands may hold it, and whether a second grab transfers it. | [components/XRInteractable.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L91) |
66
- | <a id="twohandrotation"></a> `twoHandRotation?` | [`XrTwoHandRotation`](XrTwoHandRotation.md) | Whether the second hand aims the object or only scales it. | [components/XRInteractable.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L93) |
67
- | <a id="allowtwohandscale"></a> `allowTwoHandScale?` | `boolean` | Let a two-hand grab resize the object by moving the hands apart. | [components/XRInteractable.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L95) |
68
- | <a id="minscale"></a> `minScale?` | `number` | Smallest fraction of its size a single scaling gesture may reach. | [components/XRInteractable.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L97) |
69
- | <a id="maxscale"></a> `maxScale?` | `number` | Largest multiple of its size a single scaling gesture may reach. | [components/XRInteractable.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L99) |
70
- | <a id="attachpoints"></a> `attachPoints?` | [`XrAttachPoint`](XrAttachPoint.md)[] | Authored hand-holds. Empty means grab anywhere. | [components/XRInteractable.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L101) |
71
- | <a id="applyvelocityonrelease"></a> `applyVelocityOnRelease?` | `boolean` | Hand the object the velocity it was moving with when released. | [components/XRInteractable.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L103) |
72
- | <a id="velocityscale"></a> `velocityScale?` | `number` | Scales released velocity; >1 makes throws feel stronger than real life. | [components/XRInteractable.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L105) |
73
- | <a id="hoverbehavior"></a> `hoverBehavior?` | `XrHoverBehavior` | Feedback shown while a pointer is on the object. | [components/XRInteractable.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L107) |
74
- | <a id="hovercolor"></a> `hoverColor?` | `string` | Outline colour used by the `color` and `both` behaviours. | [components/XRInteractable.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L109) |
75
- | <a id="hoverscale"></a> `hoverScale?` | `number` | Size multiplier used by the `scale` and `both` behaviours. | [components/XRInteractable.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L111) |
50
+ | <a id="enabled"></a> `enabled?` | `boolean` | - | [components/XRInteractable.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L78) |
51
+ | <a id="grabbable"></a> `grabbable?` | `boolean` | - | [components/XRInteractable.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L79) |
52
+ | <a id="pointable"></a> `pointable?` | `boolean` | - | [components/XRInteractable.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L80) |
53
+ | <a id="grabreach"></a> `grabReach?` | [`XrGrabReach`](XrGrabReach.md) | - | [components/XRInteractable.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L81) |
54
+ | <a id="distancebehavior"></a> `distanceBehavior?` | [`XrDistanceGrabBehavior`](XrDistanceGrabBehavior.md) | - | [components/XRInteractable.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L82) |
55
+ | <a id="grabgesture"></a> `grabGesture?` | [`XrGrabGesture`](XrGrabGesture.md) | - | [components/XRInteractable.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L83) |
56
+ | <a id="grabradius"></a> `grabRadius?` | `number` | Metres within which a `physical` grab registers. | [components/XRInteractable.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L85) |
57
+ | <a id="graboffsetposition"></a> `grabOffsetPosition?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Where the object sits relative to the hand once held. | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L87) |
58
+ | `grabOffsetPosition.x` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L87) |
59
+ | `grabOffsetPosition.y` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L87) |
60
+ | `grabOffsetPosition.z` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L87) |
61
+ | <a id="graboffsetrotation"></a> `grabOffsetRotation?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Orientation offset, in radians. | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L89) |
62
+ | `grabOffsetRotation.x` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L89) |
63
+ | `grabOffsetRotation.y` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L89) |
64
+ | `grabOffsetRotation.z` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L89) |
65
+ | <a id="grabhands"></a> `grabHands?` | [`XrGrabHands`](XrGrabHands.md) | How many hands may hold it, and whether a second grab transfers it. | [components/XRInteractable.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L91) |
66
+ | <a id="twohandrotation"></a> `twoHandRotation?` | [`XrTwoHandRotation`](XrTwoHandRotation.md) | Whether the second hand aims the object or only scales it. | [components/XRInteractable.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L93) |
67
+ | <a id="allowtwohandscale"></a> `allowTwoHandScale?` | `boolean` | Let a two-hand grab resize the object by moving the hands apart. | [components/XRInteractable.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L95) |
68
+ | <a id="minscale"></a> `minScale?` | `number` | Smallest fraction of its size a single scaling gesture may reach. | [components/XRInteractable.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L97) |
69
+ | <a id="maxscale"></a> `maxScale?` | `number` | Largest multiple of its size a single scaling gesture may reach. | [components/XRInteractable.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L99) |
70
+ | <a id="attachpoints"></a> `attachPoints?` | [`XrAttachPoint`](XrAttachPoint.md)[] | Authored hand-holds. Empty means grab anywhere. | [components/XRInteractable.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L101) |
71
+ | <a id="applyvelocityonrelease"></a> `applyVelocityOnRelease?` | `boolean` | Hand the object the velocity it was moving with when released. | [components/XRInteractable.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L103) |
72
+ | <a id="velocityscale"></a> `velocityScale?` | `number` | Scales released velocity; >1 makes throws feel stronger than real life. | [components/XRInteractable.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L105) |
73
+ | <a id="hoverbehavior"></a> `hoverBehavior?` | `XrHoverBehavior` | Feedback shown while a pointer is on the object. | [components/XRInteractable.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L107) |
74
+ | <a id="hovercolor"></a> `hoverColor?` | `string` | Outline colour used by the `color` and `both` behaviours. | [components/XRInteractable.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L109) |
75
+ | <a id="hoverscale"></a> `hoverScale?` | `number` | Size multiplier used by the `scale` and `both` behaviours. | [components/XRInteractable.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L111) |
@@ -19,7 +19,7 @@ type XRInteractorOptions = {
19
19
  };
20
20
  ```
21
21
 
22
- Defined in: [components/XRInteractor.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L41)
22
+ Defined in: [components/XRInteractor.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L41)
23
23
 
24
24
  Optional initializer for [XRInteractorComponent](../classes/XRInteractorComponent.md).
25
25
 
@@ -27,11 +27,11 @@ Optional initializer for [XRInteractorComponent](../classes/XRInteractorComponen
27
27
 
28
28
  | Property | Type | Description | Defined in |
29
29
  | ------ | ------ | ------ | ------ |
30
- | <a id="interactortype"></a> `interactorType?` | [`XrInteractorType`](XrInteractorType.md) | What to render at the hands. | [components/XRInteractor.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L43) |
31
- | <a id="handpreset"></a> `handPreset?` | [`XrHandPreset`](XrHandPreset.md) | Look for tracked-hand meshes. | [components/XRInteractor.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L45) |
32
- | <a id="handcolor"></a> `handColor?` | `string` | Tint applied by the preset (and by `custom`). | [components/XRInteractor.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L47) |
33
- | <a id="handopacity"></a> `handOpacity?` | `number` | 0-1; `ghost` leans on this. | [components/XRInteractor.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L49) |
34
- | <a id="handemissiveintensity"></a> `handEmissiveIntensity?` | `number` | Emissive strength, used by `neon`. | [components/XRInteractor.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L51) |
35
- | <a id="rayvisibility"></a> `rayVisibility?` | `XrRayVisibility` | When the pointer ray is drawn. | [components/XRInteractor.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L54) |
36
- | <a id="raycolor"></a> `rayColor?` | `string` | Pointer ray colour. | [components/XRInteractor.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L56) |
37
- | <a id="raythickness"></a> `rayThickness?` | `number` | Pointer ray thickness (diameter), metres. | [components/XRInteractor.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L58) |
30
+ | <a id="interactortype"></a> `interactorType?` | [`XrInteractorType`](XrInteractorType.md) | What to render at the hands. | [components/XRInteractor.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L43) |
31
+ | <a id="handpreset"></a> `handPreset?` | [`XrHandPreset`](XrHandPreset.md) | Look for tracked-hand meshes. | [components/XRInteractor.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L45) |
32
+ | <a id="handcolor"></a> `handColor?` | `string` | Tint applied by the preset (and by `custom`). | [components/XRInteractor.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L47) |
33
+ | <a id="handopacity"></a> `handOpacity?` | `number` | 0-1; `ghost` leans on this. | [components/XRInteractor.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L49) |
34
+ | <a id="handemissiveintensity"></a> `handEmissiveIntensity?` | `number` | Emissive strength, used by `neon`. | [components/XRInteractor.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L51) |
35
+ | <a id="rayvisibility"></a> `rayVisibility?` | `XrRayVisibility` | When the pointer ray is drawn. | [components/XRInteractor.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L54) |
36
+ | <a id="raycolor"></a> `rayColor?` | `string` | Pointer ray colour. | [components/XRInteractor.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L56) |
37
+ | <a id="raythickness"></a> `rayThickness?` | `number` | Pointer ray thickness (diameter), metres. | [components/XRInteractor.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L58) |