@relu-interactives/spatial-ecs 0.10.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{System-BldSHxZV.d.cts → System-D8vm-Jvv.d.cts} +110 -3
- package/dist/{System-CADhPyQs.d.ts → System-ttkDQCrj.d.ts} +110 -3
- package/dist/{XRHandPose-D3Ab1Dfs.d.cts → XRHandPose-C97XVW2R.d.cts} +2 -41
- package/dist/{XRHandPose-BNSwd1y9.d.ts → XRHandPose-CxXtWF1y.d.ts} +2 -41
- package/dist/animation/index.cjs +33 -1
- package/dist/animation/index.cjs.map +1 -1
- package/dist/animation/index.js +1 -1
- package/dist/{chunk-TY3XCHOR.js → chunk-2DJBNWBB.js} +56 -15
- package/dist/chunk-2DJBNWBB.js.map +1 -0
- package/dist/{chunk-WWP46AEF.js → chunk-4FHJA6U4.js} +8 -4
- package/dist/chunk-4FHJA6U4.js.map +1 -0
- package/dist/{chunk-GSWC6LLD.js → chunk-GMSFEXUZ.js} +35 -3
- package/dist/chunk-GMSFEXUZ.js.map +1 -0
- package/dist/{chunk-JEPUCLZX.js → chunk-QAZCVCMP.js} +88 -27
- package/dist/chunk-QAZCVCMP.js.map +1 -0
- package/dist/{chunk-NXASMBDS.js → chunk-SM5KGNYX.js} +4 -4
- package/dist/{chunk-NXASMBDS.js.map → chunk-SM5KGNYX.js.map} +1 -1
- package/dist/{chunk-JNYPJB55.js → chunk-T7SRBLPJ.js} +24 -4
- package/dist/chunk-T7SRBLPJ.js.map +1 -0
- package/dist/components/index.cjs +21 -1
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +3 -3
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +187 -46
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +5 -5
- package/dist/docs/api/Component/classes/Component.md +7 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +20 -19
- package/dist/docs/api/components/classes/BoneAttachmentComponent.md +65 -0
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +3 -3
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/IKComponent.md +59 -0
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +14 -14
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +6 -6
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/NetworkIdentityComponent.md +42 -0
- package/dist/docs/api/components/classes/NetworkSpawnerComponent.md +48 -0
- package/dist/docs/api/components/classes/NetworkTransformComponent.md +51 -0
- package/dist/docs/api/components/classes/NetworkedPropsComponent.md +47 -0
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +7 -7
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +5 -5
- package/dist/docs/api/components/classes/PrefabNode.md +3 -3
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +9 -9
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/UIButtonComponent.md +18 -14
- package/dist/docs/api/components/classes/UIPanelComponent.md +13 -11
- package/dist/docs/api/components/classes/UISliderComponent.md +16 -11
- package/dist/docs/api/components/classes/UITextComponent.md +14 -12
- package/dist/docs/api/components/classes/UIToggleComponent.md +12 -9
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +6 -6
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +3 -3
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +5 -5
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +4 -4
- package/dist/docs/api/components/classes/XRInteractableComponent.md +28 -28
- package/dist/docs/api/components/classes/XRInteractorComponent.md +10 -10
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +3 -3
- package/dist/docs/api/components/classes/XRRigComponent.md +17 -17
- package/dist/docs/api/components/functions/createAttachPoint.md +1 -1
- package/dist/docs/api/components/functions/createHandPoseEntry.md +1 -1
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +1 -1
- package/dist/docs/api/components/functions/normalizeBoneHold.md +25 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +1 -1
- package/dist/docs/api/components/functions/normalizeIKChain.md +25 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +1 -1
- package/dist/docs/api/components/index.md +18 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/BoneAttachmentOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/BoneHold.md +34 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentLightingState.md +9 -9
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +6 -6
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +1 -1
- package/dist/docs/api/components/type-aliases/IKChain.md +37 -0
- package/dist/docs/api/components/type-aliases/IKLimb.md +15 -0
- package/dist/docs/api/components/type-aliases/IKOptions.md +27 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightShadowState.md +8 -8
- package/dist/docs/api/components/type-aliases/LightValueState.md +12 -12
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/ModelLoadState.md +1 -1
- package/dist/docs/api/components/type-aliases/NetValue.md +23 -0
- package/dist/docs/api/components/type-aliases/NetworkTransformOptions.md +18 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -8
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +1 -1
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/UIButtonOptions.md +21 -13
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +14 -10
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +20 -10
- package/dist/docs/api/components/type-aliases/UITextOptions.md +15 -11
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +14 -8
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +1 -1
- package/dist/docs/api/components/type-aliases/UiIconPosition.md +13 -0
- package/dist/docs/api/components/type-aliases/UiSliderVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiToggleVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +5 -5
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +1 -1
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +2 -2
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +27 -27
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +16 -16
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +13 -13
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +1 -1
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +12 -12
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +1 -1
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_CURLS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/components/variables/MODEL_NO_PATH_MESSAGE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioMixer.md +161 -0
- package/dist/docs/api/index/classes/AudioSystem.md +138 -4
- package/dist/docs/api/index/classes/BoneHoldSystem.md +54 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +6 -6
- package/dist/docs/api/index/classes/IKSystem.md +98 -0
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +269 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
- package/dist/docs/api/index/classes/ScriptObject.md +10 -10
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +6 -6
- package/dist/docs/api/index/classes/SlotChooser.md +59 -0
- package/dist/docs/api/index/classes/TeleportAimGate.md +4 -4
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +4 -4
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +3 -3
- package/dist/docs/api/index/classes/UIPanelSystem.md +4 -4
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +168 -98
- package/dist/docs/api/index/classes/XRAnchorSystem.md +4 -4
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +7 -7
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +5 -5
- package/dist/docs/api/index/classes/XRHitTestSystem.md +4 -4
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XRInputSystem.md +9 -9
- package/dist/docs/api/index/classes/XRInteractionSystem.md +18 -18
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +7 -7
- package/dist/docs/api/index/classes/XRSessionSystem.md +6 -6
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +4 -4
- package/dist/docs/api/index/functions/angularVelocityFrom.md +1 -1
- package/dist/docs/api/index/functions/applyHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +1 -1
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +1 -1
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/clearModelCache.md +1 -1
- package/dist/docs/api/index/functions/clearPrefabCache.md +1 -1
- package/dist/docs/api/index/functions/cloneHandPose.md +1 -1
- package/dist/docs/api/index/functions/collectDiffPaths.md +1 -1
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +1 -1
- package/dist/docs/api/index/functions/collectEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +1 -1
- package/dist/docs/api/index/functions/computeFingerCurl.md +1 -1
- package/dist/docs/api/index/functions/computeHandShape.md +1 -1
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +1 -1
- package/dist/docs/api/index/functions/computePalmWidth.md +1 -1
- package/dist/docs/api/index/functions/computePinch.md +1 -1
- package/dist/docs/api/index/functions/computeSpread.md +1 -1
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createBoneAttachmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createGLTFLoader.md +30 -0
- package/dist/docs/api/index/functions/createHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/createIKComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createNetworkIdentityComponent.md +24 -0
- package/dist/docs/api/index/functions/createNetworkSpawnerComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkedPropsComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIButtonComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIPanelComponent.md +1 -1
- package/dist/docs/api/index/functions/createUISliderComponent.md +1 -1
- package/dist/docs/api/index/functions/createUITextComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIToggleComponent.md +1 -1
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRRigComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/despawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/encodeOverride.md +1 -1
- package/dist/docs/api/index/functions/estimateHandScale.md +1 -1
- package/dist/docs/api/index/functions/findModelBone.md +30 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +1 -1
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +1 -1
- package/dist/docs/api/index/functions/getHandPosePreset.md +1 -1
- package/dist/docs/api/index/functions/gripQuaternion.md +36 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +1 -1
- package/dist/docs/api/index/functions/instantiateSubtree.md +1 -1
- package/dist/docs/api/index/functions/listModelBones.md +25 -0
- package/dist/docs/api/index/functions/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +1 -1
- package/dist/docs/api/index/functions/mergeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/parseOverride.md +1 -1
- package/dist/docs/api/index/functions/parsePrefabAsset.md +1 -1
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +1 -1
- package/dist/docs/api/index/functions/readXrCapabilities.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +3 -3
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/restoreComponentState.md +1 -1
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +1 -1
- package/dist/docs/api/index/functions/sampleTeleportArc.md +1 -1
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +1 -1
- package/dist/docs/api/index/functions/setWorldQuaternion.md +26 -0
- package/dist/docs/api/index/functions/soundBankFiles.md +25 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/twoBoneIK.md +41 -0
- package/dist/docs/api/index/index.md +31 -0
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +5 -5
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/NetworkHandle.md +180 -0
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +6 -6
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +5 -5
- package/dist/docs/api/index/interfaces/RenderBackend.md +8 -8
- package/dist/docs/api/index/interfaces/SoundBankAsset.md +18 -0
- package/dist/docs/api/index/interfaces/SoundSlot.md +31 -0
- package/dist/docs/api/index/interfaces/SoundTake.md +18 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +3 -3
- package/dist/docs/api/index/type-aliases/AudioBus.md +15 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -38
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +7 -1
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +1 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +5 -5
- package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +4 -4
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +3 -3
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +4 -4
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +3 -3
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModelBoneInfo.md +29 -0
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +1 -1
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +5 -5
- package/dist/docs/api/index/type-aliases/NetSpawnOptions.md +41 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- package/dist/docs/api/index/type-aliases/PlaySlotOptions.md +32 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +5 -5
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/RendererKind.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +9 -9
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +6 -6
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +4 -4
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +4 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +4 -4
- package/dist/docs/api/index/type-aliases/UiColorStop.md +37 -0
- package/dist/docs/api/index/type-aliases/UiPaint.md +81 -0
- package/dist/docs/api/index/type-aliases/UiShadow.md +27 -0
- package/dist/docs/api/index/type-aliases/UiStyle.md +43 -0
- package/dist/docs/api/index/type-aliases/UiTextStyle.md +33 -0
- package/dist/docs/api/index/type-aliases/UiTokens.md +13 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +3 -3
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +9 -9
- package/dist/docs/api/index/type-aliases/XrFinger.md +1 -1
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +4 -4
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +6 -6
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +2 -2
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +11 -11
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +5 -5
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandShape.md +13 -13
- package/dist/docs/api/index/type-aliases/XrHandedness.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHitResult.md +3 -3
- package/dist/docs/api/index/type-aliases/XrInputKind.md +1 -1
- package/dist/docs/api/index/type-aliases/XrInputState.md +18 -18
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +6 -6
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +1 -1
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +1 -1
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +1 -1
- package/dist/docs/api/index/variables/ARC_SPEED.md +1 -1
- package/dist/docs/api/index/variables/ARC_STEPS.md +1 -1
- package/dist/docs/api/index/variables/CURLED_COS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +1 -1
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +1 -1
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/MATCH_FALLOFF.md +1 -1
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +1 -1
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/PINCH_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +1 -1
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +1 -1
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +1 -1
- package/dist/docs/api/index/variables/STRAIGHT_COS.md +1 -1
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +1 -1
- package/dist/docs/api/index/variables/XR_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +1 -1
- package/dist/docs/api/index/variables/webglBackend.md +1 -1
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/bone-attachments-and-ik.md +51 -0
- package/dist/docs/guide/components/audio.md +1 -1
- package/dist/factories/index.cjs +29 -1
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +2 -2
- package/dist/factories/index.d.ts +2 -2
- package/dist/factories/index.js +4 -4
- package/dist/{index-BXjwEdNq.d.cts → index-BbrnjNXy.d.ts} +5 -3
- package/dist/{index-CVG-hREM.d.ts → index-DD7aHv0p.d.cts} +5 -3
- package/dist/{index-6pZO_gV7.d.ts → index-OgOoIpEI.d.ts} +14 -2
- package/dist/{index-BdghvXKE.d.cts → index-xyqzT0PQ.d.cts} +14 -2
- package/dist/index.cjs +174 -13
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +13 -11
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +70 -38
- package/dist/network/index.cjs.map +1 -1
- package/dist/network/index.d.cts +2 -2
- package/dist/network/index.d.ts +2 -2
- package/dist/network/index.js +4 -4
- package/dist/systems/index.cjs +171 -13
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +2 -2
- package/dist/systems/index.d.ts +2 -2
- package/dist/systems/index.js +5 -5
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/webgpu/index.d.ts +2 -2
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +2 -1
- package/dist/chunk-GSWC6LLD.js.map +0 -1
- package/dist/chunk-JEPUCLZX.js.map +0 -1
- package/dist/chunk-JNYPJB55.js.map +0 -1
- package/dist/chunk-TY3XCHOR.js.map +0 -1
- package/dist/chunk-WWP46AEF.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent,
|
|
2
|
-
export { D as DEFAULT_ENVIRONMENT_LIGHTING,
|
|
3
|
-
export { P as PrefabInstance, a as PrefabNode, X as XREnvironmentComponent, b as XrEnvironmentKind, c as XrEnvironmentOrientation } from '../index-
|
|
1
|
+
export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_POSE_CURLS, n as DEFAULT_POSE_DIRECTIONS, o as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, p as EntityType, I as ImageComponent, q as ImageTarget, r as ImageTargetAnchor, s as ImageTargetAnchorOptions, t as ImageTargetReference, u as InstanceSlotComponent, v as InstanceTransform, w as InstancedMeshComponent, x as InstancedMeshKind, L as LightComponent, y as LightShadowState, z as LightValueState, M as MODEL_NO_PATH_MESSAGE, B as MaterialComponent, F as MaterialTypeValue, G as MaterialValueState, H as MeshComponent, J as MeshGeometryComponent, K as MeshGeometryParameters, N as MeshGeometryParametersByKind, O as ModelComponent, P as ModelLoadState, Q as Name, R as Object3DRef, S as PhysicsComponent, T as PhysicsState, U as PlaneMeshParameters, V as RadiusHeightMeshParameters, W as RadiusMeshParameters, X as RigidbodyState, Y as RigidbodyType, Z as ScriptComponent, _ as ScriptEntry, $ as ScriptObjectComponent, a0 as ScriptObjectComponentInput, a1 as ScriptObjectRuntimeState, a2 as Selectable, a3 as SelectionTransformState, a4 as SpriteComponent, a5 as TextureFilteringValue, a6 as TransformModeValue, a7 as TransformSpaceValue, a8 as UIButtonComponent, a9 as UIButtonOptions, aa as UIPanelComponent, ab as UIPanelOptions, ac as UISliderComponent, ad as UISliderOptions, ae as UITextComponent, af as UITextOptions, ag as UIToggleComponent, ah as UIToggleOptions, ai as UiFollowMode, aj as UiIconPosition, ak as UiSliderVariant, al as UiTextAlign, am as UiTextVAlign, an as UiToggleVariant, ao as VRTeleportAreaComponent, ap as VRTeleportAreaOptions, aq as VideoComponent, ar as VrTeleportShape, as as XRAnchorComponent, at as XRAnchorOptions, au as XRHandPoseComponent, av as XRHandPoseOptions, aw as XRInteractableComponent, ax as XRInteractableOptions, ay as XRInteractorComponent, az as XRInteractorOptions, aA as XRInteractorSideComponent, aB as XRRigComponent, aC as XRRigOptions, aD as XrAttachPoint, aE as XrDistanceGrabBehavior, aF as XrEnvironmentPhysics, aG as XrGrabGesture, aH as XrGrabHands, aI as XrGrabReach, aJ as XrHandPoseEntry, aK as XrHandPreset, aL as XrInteractorSide, aM as XrInteractorType, aN as XrLocomotionMode, aO as XrTrackingOrigin, aP as XrTwoHandRotation, aQ as createAttachPoint, aR as createHandPoseEntry, aS as defaultMaterialValue, aT as handPoseDefinitionFor, aU as normalizePhysicsState, aV as setModelLoadState, aW as setPhysicsLiveRef } from '../XRHandPose-C97XVW2R.cjs';
|
|
2
|
+
export { B as BoneAttachmentComponent, a as BoneAttachmentOptions, b as BoneHold, D as DEFAULT_ENVIRONMENT_LIGHTING, c as DEFAULT_ENVIRONMENT_STATE, d as DEFAULT_POSTPROCESSING_STATE, E as Environment, e as EnvironmentFogState, f as EnvironmentFogType, g as EnvironmentGradientEffect, h as EnvironmentLightingState, i as EnvironmentSkyboxImageProjection, j as EnvironmentSkyboxState, k as EnvironmentSkyboxType, l as EnvironmentState, m as EnvironmentToneMapping, I as IKChain, n as IKComponent, o as IKLimb, p as IKOptions, N as NetValue, q as NetworkIdentityComponent, r as NetworkSpawnerComponent, s as NetworkTransformComponent, t as NetworkTransformOptions, u as NetworkedPropsComponent, P as ParentId, v as Postprocessing, w as PostprocessingState, T as TransformComponent, x as TransformData, V as Vec3, y as normalizeBoneHold, z as normalizeEnvironmentLighting, A as normalizeIKChain } from '../System-D8vm-Jvv.cjs';
|
|
3
|
+
export { P as PrefabInstance, a as PrefabNode, X as XREnvironmentComponent, b as XrEnvironmentKind, c as XrEnvironmentOrientation } from '../index-DD7aHv0p.cjs';
|
|
4
4
|
import 'three';
|
|
5
5
|
import '@dimforge/rapier3d-compat';
|
|
6
6
|
import '../handPose-DlcTtqgx.cjs';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent,
|
|
2
|
-
export { D as DEFAULT_ENVIRONMENT_LIGHTING,
|
|
3
|
-
export { P as PrefabInstance, a as PrefabNode, X as XREnvironmentComponent, b as XrEnvironmentKind, c as XrEnvironmentOrientation } from '../index-
|
|
1
|
+
export { A as AnimationComponent, a as AnimationComponentOptions, b as AudioComponent, C as CameraComponent, c as CameraComponentOptions, d as CameraProjection, e as CameraRuntimeType, f as ColliderShape, g as ColliderState, h as CubeMeshParameters, D as DEFAULT_COLLIDER_STATE, i as DEFAULT_INSTANCED_MESH_PARAMETERS, j as DEFAULT_INSTANCE_TRANSFORM, k as DEFAULT_MESH_GEOMETRY_PARAMETERS, l as DEFAULT_PHYSICS_STATE, m as DEFAULT_POSE_CURLS, n as DEFAULT_POSE_DIRECTIONS, o as DEFAULT_RIGIDBODY_STATE, E as EditableMeshObjectKind, p as EntityType, I as ImageComponent, q as ImageTarget, r as ImageTargetAnchor, s as ImageTargetAnchorOptions, t as ImageTargetReference, u as InstanceSlotComponent, v as InstanceTransform, w as InstancedMeshComponent, x as InstancedMeshKind, L as LightComponent, y as LightShadowState, z as LightValueState, M as MODEL_NO_PATH_MESSAGE, B as MaterialComponent, F as MaterialTypeValue, G as MaterialValueState, H as MeshComponent, J as MeshGeometryComponent, K as MeshGeometryParameters, N as MeshGeometryParametersByKind, O as ModelComponent, P as ModelLoadState, Q as Name, R as Object3DRef, S as PhysicsComponent, T as PhysicsState, U as PlaneMeshParameters, V as RadiusHeightMeshParameters, W as RadiusMeshParameters, X as RigidbodyState, Y as RigidbodyType, Z as ScriptComponent, _ as ScriptEntry, $ as ScriptObjectComponent, a0 as ScriptObjectComponentInput, a1 as ScriptObjectRuntimeState, a2 as Selectable, a3 as SelectionTransformState, a4 as SpriteComponent, a5 as TextureFilteringValue, a6 as TransformModeValue, a7 as TransformSpaceValue, a8 as UIButtonComponent, a9 as UIButtonOptions, aa as UIPanelComponent, ab as UIPanelOptions, ac as UISliderComponent, ad as UISliderOptions, ae as UITextComponent, af as UITextOptions, ag as UIToggleComponent, ah as UIToggleOptions, ai as UiFollowMode, aj as UiIconPosition, ak as UiSliderVariant, al as UiTextAlign, am as UiTextVAlign, an as UiToggleVariant, ao as VRTeleportAreaComponent, ap as VRTeleportAreaOptions, aq as VideoComponent, ar as VrTeleportShape, as as XRAnchorComponent, at as XRAnchorOptions, au as XRHandPoseComponent, av as XRHandPoseOptions, aw as XRInteractableComponent, ax as XRInteractableOptions, ay as XRInteractorComponent, az as XRInteractorOptions, aA as XRInteractorSideComponent, aB as XRRigComponent, aC as XRRigOptions, aD as XrAttachPoint, aE as XrDistanceGrabBehavior, aF as XrEnvironmentPhysics, aG as XrGrabGesture, aH as XrGrabHands, aI as XrGrabReach, aJ as XrHandPoseEntry, aK as XrHandPreset, aL as XrInteractorSide, aM as XrInteractorType, aN as XrLocomotionMode, aO as XrTrackingOrigin, aP as XrTwoHandRotation, aQ as createAttachPoint, aR as createHandPoseEntry, aS as defaultMaterialValue, aT as handPoseDefinitionFor, aU as normalizePhysicsState, aV as setModelLoadState, aW as setPhysicsLiveRef } from '../XRHandPose-CxXtWF1y.js';
|
|
2
|
+
export { B as BoneAttachmentComponent, e as BoneAttachmentOptions, f as BoneHold, D as DEFAULT_ENVIRONMENT_LIGHTING, g as DEFAULT_ENVIRONMENT_STATE, h as DEFAULT_POSTPROCESSING_STATE, i as Environment, j as EnvironmentFogState, k as EnvironmentFogType, l as EnvironmentGradientEffect, m as EnvironmentLightingState, n as EnvironmentSkyboxImageProjection, o as EnvironmentSkyboxState, p as EnvironmentSkyboxType, q as EnvironmentState, r as EnvironmentToneMapping, I as IKChain, s as IKComponent, t as IKLimb, u as IKOptions, N as NetValue, v as NetworkIdentityComponent, w as NetworkSpawnerComponent, x as NetworkTransformComponent, y as NetworkTransformOptions, z as NetworkedPropsComponent, A as ParentId, F as Postprocessing, b as PostprocessingState, T as TransformComponent, G as TransformData, V as Vec3, H as normalizeBoneHold, J as normalizeEnvironmentLighting, K as normalizeIKChain } from '../System-ttkDQCrj.js';
|
|
3
|
+
export { P as PrefabInstance, a as PrefabNode, X as XREnvironmentComponent, b as XrEnvironmentKind, c as XrEnvironmentOrientation } from '../index-BbrnjNXy.js';
|
|
4
4
|
import 'three';
|
|
5
5
|
import '@dimforge/rapier3d-compat';
|
|
6
6
|
import '../handPose-DlcTtqgx.js';
|
package/dist/components/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { AnimationComponent, AudioComponent, BoneAttachmentComponent, CameraComponent, DEFAULT_COLLIDER_STATE, DEFAULT_ENVIRONMENT_LIGHTING, DEFAULT_ENVIRONMENT_STATE, DEFAULT_INSTANCED_MESH_PARAMETERS, DEFAULT_INSTANCE_TRANSFORM, DEFAULT_MESH_GEOMETRY_PARAMETERS, DEFAULT_PHYSICS_STATE, DEFAULT_POSE_CURLS, DEFAULT_POSE_DIRECTIONS, DEFAULT_POSTPROCESSING_STATE, DEFAULT_RIGIDBODY_STATE, EntityType, Environment, IKComponent, ImageComponent, ImageTarget, ImageTargetAnchor, InstanceSlotComponent, InstancedMeshComponent, LightComponent, MODEL_NO_PATH_MESSAGE, MaterialComponent, MeshComponent, MeshGeometryComponent, ModelComponent, Name, NetworkIdentityComponent, NetworkSpawnerComponent, NetworkTransformComponent, NetworkedPropsComponent, Object3DRef, ParentId, PhysicsComponent, Postprocessing, PrefabInstance, PrefabNode, ScriptComponent, ScriptObjectComponent, Selectable, SelectionTransformState, SpriteComponent, TransformComponent, UIButtonComponent, UIPanelComponent, UISliderComponent, UITextComponent, UIToggleComponent, VRTeleportAreaComponent, VideoComponent, XRAnchorComponent, XREnvironmentComponent, XRHandPoseComponent, XRInteractableComponent, XRInteractorComponent, XRInteractorSideComponent, XRRigComponent, createAttachPoint, createHandPoseEntry, defaultMaterialValue, handPoseDefinitionFor, normalizeEnvironmentLighting, normalizeIKChain, normalizePhysicsState, setModelLoadState, setPhysicsLiveRef } from '../chunk-
|
|
1
|
+
export { AnimationComponent, AudioComponent, BoneAttachmentComponent, CameraComponent, DEFAULT_COLLIDER_STATE, DEFAULT_ENVIRONMENT_LIGHTING, DEFAULT_ENVIRONMENT_STATE, DEFAULT_INSTANCED_MESH_PARAMETERS, DEFAULT_INSTANCE_TRANSFORM, DEFAULT_MESH_GEOMETRY_PARAMETERS, DEFAULT_PHYSICS_STATE, DEFAULT_POSE_CURLS, DEFAULT_POSE_DIRECTIONS, DEFAULT_POSTPROCESSING_STATE, DEFAULT_RIGIDBODY_STATE, EntityType, Environment, IKComponent, ImageComponent, ImageTarget, ImageTargetAnchor, InstanceSlotComponent, InstancedMeshComponent, LightComponent, MODEL_NO_PATH_MESSAGE, MaterialComponent, MeshComponent, MeshGeometryComponent, ModelComponent, Name, NetworkIdentityComponent, NetworkSpawnerComponent, NetworkTransformComponent, NetworkedPropsComponent, Object3DRef, ParentId, PhysicsComponent, Postprocessing, PrefabInstance, PrefabNode, ScriptComponent, ScriptObjectComponent, Selectable, SelectionTransformState, SpriteComponent, TransformComponent, UIButtonComponent, UIPanelComponent, UISliderComponent, UITextComponent, UIToggleComponent, VRTeleportAreaComponent, VideoComponent, XRAnchorComponent, XREnvironmentComponent, XRHandPoseComponent, XRInteractableComponent, XRInteractorComponent, XRInteractorSideComponent, XRRigComponent, createAttachPoint, createHandPoseEntry, defaultMaterialValue, handPoseDefinitionFor, normalizeBoneHold, normalizeEnvironmentLighting, normalizeIKChain, normalizePhysicsState, setModelLoadState, setPhysicsLiveRef } from '../chunk-T7SRBLPJ.js';
|
|
2
2
|
import '../chunk-CKTHDXPS.js';
|
|
3
3
|
import '../chunk-XE4OXN2W.js';
|
|
4
4
|
//# sourceMappingURL=index.js.map
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Behaviour
|
|
8
8
|
|
|
9
|
-
Defined in: [Behaviour.ts:
|
|
9
|
+
Defined in: [Behaviour.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L86)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -23,7 +23,7 @@ new Behaviour(
|
|
|
23
23
|
component): Behaviour;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [Behaviour.ts:
|
|
26
|
+
Defined in: [Behaviour.ts:144](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L144)
|
|
27
27
|
|
|
28
28
|
Engine-managed constructor. Hosts (`ScriptBehaviourSystem`) instantiate
|
|
29
29
|
subclasses with the owning world, the entity id, and the script's `data`
|
|
@@ -45,13 +45,36 @@ payload. User code should not call this directly.
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Default value | Description | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="data"></a> `data` | \| [`Component`](../../Component/classes/Component.md) \| `Record`\<`string`, `unknown`\> | `undefined` | Inspector-bound payload from the entity's `ScriptComponent`. Override the type on subclasses with `declare data: MyDataShape` to get type safety inside hooks. Saved with the project so values persist across reloads. | [Behaviour.ts:
|
|
49
|
-
| <a id="entityid"></a> `entityId` | `number` | `undefined` | Numeric id of the entity this script is attached to. | [Behaviour.ts:
|
|
50
|
-
| <a id="entity"></a> `entity` | `WorldEntityView` | `undefined` | View of the owning entity (id + components) at construction time. | [Behaviour.ts:
|
|
51
|
-
| <a id="threeref"></a> `threeRef` | [`Object3DRef`](../../components/classes/Object3DRef.md) | `undefined` | Live three.js object wrapper for the entity. May be `null` for entities with no scene presence; helpers on this class return `null` in that case. | [Behaviour.ts:
|
|
52
|
-
| <a id="transform"></a> `transform` | [`TransformComponent`](../../components/classes/TransformComponent.md) | `undefined` | The entity's [TransformComponent](../../components/classes/TransformComponent.md). Mutating `position`, `rotation`, or `scale` here is picked up the same frame by `TransformSyncSystem`. | [Behaviour.ts:
|
|
53
|
-
| <a id="world"></a> `world` | [`World`](../../index/classes/World.md) | `undefined` | The owning [World](../../index/classes/World.md). Refreshed each frame in [Behaviour.update](#update). Use it to query other entities or components. | [Behaviour.ts:
|
|
54
|
-
| <a id="deltatime"></a> `deltaTime` | `number` | `0` | Seconds elapsed since the last frame. Set by the engine before each [Behaviour.onUpdate](#onupdate). | [Behaviour.ts:
|
|
48
|
+
| <a id="data"></a> `data` | \| [`Component`](../../Component/classes/Component.md) \| `Record`\<`string`, `unknown`\> | `undefined` | Inspector-bound payload from the entity's `ScriptComponent`. Override the type on subclasses with `declare data: MyDataShape` to get type safety inside hooks. Saved with the project so values persist across reloads. | [Behaviour.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L102) |
|
|
49
|
+
| <a id="entityid"></a> `entityId` | `number` | `undefined` | Numeric id of the entity this script is attached to. | [Behaviour.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L105) |
|
|
50
|
+
| <a id="entity"></a> `entity` | `WorldEntityView` | `undefined` | View of the owning entity (id + components) at construction time. | [Behaviour.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L108) |
|
|
51
|
+
| <a id="threeref"></a> `threeRef` | [`Object3DRef`](../../components/classes/Object3DRef.md) | `undefined` | Live three.js object wrapper for the entity. May be `null` for entities with no scene presence; helpers on this class return `null` in that case. | [Behaviour.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L114) |
|
|
52
|
+
| <a id="transform"></a> `transform` | [`TransformComponent`](../../components/classes/TransformComponent.md) | `undefined` | The entity's [TransformComponent](../../components/classes/TransformComponent.md). Mutating `position`, `rotation`, or `scale` here is picked up the same frame by `TransformSyncSystem`. | [Behaviour.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L120) |
|
|
53
|
+
| <a id="world"></a> `world` | [`World`](../../index/classes/World.md) | `undefined` | The owning [World](../../index/classes/World.md). Refreshed each frame in [Behaviour.update](#update). Use it to query other entities or components. | [Behaviour.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L126) |
|
|
54
|
+
| <a id="deltatime"></a> `deltaTime` | `number` | `0` | Seconds elapsed since the last frame. Set by the engine before each [Behaviour.onUpdate](#onupdate). | [Behaviour.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L132) |
|
|
55
|
+
|
|
56
|
+
## Accessors
|
|
57
|
+
|
|
58
|
+
### network
|
|
59
|
+
|
|
60
|
+
#### Get Signature
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
get network(): NetworkHandle | null;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Defined in: [Behaviour.ts:218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L218)
|
|
67
|
+
|
|
68
|
+
The shared world, or `null` in a single-player run, so a script can work
|
|
69
|
+
both ways:
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
if (this.network && !this.network.isOwner) return; // someone else moves this
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
##### Returns
|
|
76
|
+
|
|
77
|
+
[`NetworkHandle`](../../index/interfaces/NetworkHandle.md) \| `null`
|
|
55
78
|
|
|
56
79
|
## Methods
|
|
57
80
|
|
|
@@ -61,7 +84,7 @@ payload. User code should not call this directly.
|
|
|
61
84
|
update(world, deltaTime): void;
|
|
62
85
|
```
|
|
63
86
|
|
|
64
|
-
Defined in: [Behaviour.ts:
|
|
87
|
+
Defined in: [Behaviour.ts:168](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L168)
|
|
65
88
|
|
|
66
89
|
Engine-managed per-frame entry point. Refreshes [Behaviour.deltaTime](#deltatime)
|
|
67
90
|
and delegates to [Behaviour.onUpdate](#onupdate).
|
|
@@ -96,7 +119,7 @@ CustomEcsSystem.update
|
|
|
96
119
|
optional dispose(world): void;
|
|
97
120
|
```
|
|
98
121
|
|
|
99
|
-
Defined in: [Behaviour.ts:
|
|
122
|
+
Defined in: [Behaviour.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L180)
|
|
100
123
|
|
|
101
124
|
Optional cleanup hook invoked when the script is detached or the entity
|
|
102
125
|
is destroyed. Override to release timers, listeners, or other resources.
|
|
@@ -125,7 +148,7 @@ CustomEcsSystem.dispose
|
|
|
125
148
|
spawnPrefab(source, options?): Promise<number>;
|
|
126
149
|
```
|
|
127
150
|
|
|
128
|
-
Defined in: [Behaviour.ts:
|
|
151
|
+
Defined in: [Behaviour.ts:203](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L203)
|
|
129
152
|
|
|
130
153
|
Instantiate a prefab asset into the world at runtime.
|
|
131
154
|
|
|
@@ -158,13 +181,131 @@ async onUpdate() {
|
|
|
158
181
|
|
|
159
182
|
***
|
|
160
183
|
|
|
184
|
+
### onPlayerJoin()
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
onPlayerJoin(_playerId): void;
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
Defined in: [Behaviour.ts:223](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L223)
|
|
191
|
+
|
|
192
|
+
Someone joined the room. `playerId` is their session id.
|
|
193
|
+
|
|
194
|
+
#### Parameters
|
|
195
|
+
|
|
196
|
+
| Parameter | Type |
|
|
197
|
+
| ------ | ------ |
|
|
198
|
+
| `_playerId` | `string` |
|
|
199
|
+
|
|
200
|
+
#### Returns
|
|
201
|
+
|
|
202
|
+
`void`
|
|
203
|
+
|
|
204
|
+
***
|
|
205
|
+
|
|
206
|
+
### onPlayerLeave()
|
|
207
|
+
|
|
208
|
+
```ts
|
|
209
|
+
onPlayerLeave(_playerId): void;
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Defined in: [Behaviour.ts:226](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L226)
|
|
213
|
+
|
|
214
|
+
Someone left the room.
|
|
215
|
+
|
|
216
|
+
#### Parameters
|
|
217
|
+
|
|
218
|
+
| Parameter | Type |
|
|
219
|
+
| ------ | ------ |
|
|
220
|
+
| `_playerId` | `string` |
|
|
221
|
+
|
|
222
|
+
#### Returns
|
|
223
|
+
|
|
224
|
+
`void`
|
|
225
|
+
|
|
226
|
+
***
|
|
227
|
+
|
|
228
|
+
### onNetworkProp()
|
|
229
|
+
|
|
230
|
+
```ts
|
|
231
|
+
onNetworkProp(_key, _value): void;
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Defined in: [Behaviour.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L229)
|
|
235
|
+
|
|
236
|
+
A shared value on this entity changed.
|
|
237
|
+
|
|
238
|
+
#### Parameters
|
|
239
|
+
|
|
240
|
+
| Parameter | Type |
|
|
241
|
+
| ------ | ------ |
|
|
242
|
+
| `_key` | `string` |
|
|
243
|
+
| `_value` | [`NetValue`](../../components/type-aliases/NetValue.md) |
|
|
244
|
+
|
|
245
|
+
#### Returns
|
|
246
|
+
|
|
247
|
+
`void`
|
|
248
|
+
|
|
249
|
+
***
|
|
250
|
+
|
|
251
|
+
### loadSoundBank()
|
|
252
|
+
|
|
253
|
+
```ts
|
|
254
|
+
loadSoundBank(source): Promise<void>;
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Defined in: [Behaviour.ts:235](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L235)
|
|
258
|
+
|
|
259
|
+
Load a `.soundbank.json` asset so [Behaviour.playSlot](#playslot) can play it.
|
|
260
|
+
`source` is an asset path or an `AssetInput` field.
|
|
261
|
+
|
|
262
|
+
#### Parameters
|
|
263
|
+
|
|
264
|
+
| Parameter | Type |
|
|
265
|
+
| ------ | ------ |
|
|
266
|
+
| `source` | \| `string` \| \{ `path`: `string`; \} |
|
|
267
|
+
|
|
268
|
+
#### Returns
|
|
269
|
+
|
|
270
|
+
`Promise`\<`void`\>
|
|
271
|
+
|
|
272
|
+
***
|
|
273
|
+
|
|
274
|
+
### playSlot()
|
|
275
|
+
|
|
276
|
+
```ts
|
|
277
|
+
playSlot(id, options?): boolean;
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
Defined in: [Behaviour.ts:247](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L247)
|
|
281
|
+
|
|
282
|
+
Play a named sound from a loaded bank, as a random take. Returns whether it
|
|
283
|
+
sounded: its chance, cooldown or priority may keep it quiet.
|
|
284
|
+
|
|
285
|
+
```ts
|
|
286
|
+
this.playSlot("hit", { position: this.transform.position });
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
#### Parameters
|
|
290
|
+
|
|
291
|
+
| Parameter | Type |
|
|
292
|
+
| ------ | ------ |
|
|
293
|
+
| `id` | `string` |
|
|
294
|
+
| `options?` | [`PlaySlotOptions`](../../index/type-aliases/PlaySlotOptions.md) |
|
|
295
|
+
|
|
296
|
+
#### Returns
|
|
297
|
+
|
|
298
|
+
`boolean`
|
|
299
|
+
|
|
300
|
+
***
|
|
301
|
+
|
|
161
302
|
### despawn()
|
|
162
303
|
|
|
163
304
|
```ts
|
|
164
305
|
despawn(rootEntityId): number;
|
|
165
306
|
```
|
|
166
307
|
|
|
167
|
-
Defined in: [Behaviour.ts:
|
|
308
|
+
Defined in: [Behaviour.ts:255](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L255)
|
|
168
309
|
|
|
169
310
|
Remove a spawned prefab instance (the root entity and all descendants).
|
|
170
311
|
Returns the number of entities removed.
|
|
@@ -187,7 +328,7 @@ Returns the number of entities removed.
|
|
|
187
328
|
getWorldPosition(): Vector3 | null;
|
|
188
329
|
```
|
|
189
330
|
|
|
190
|
-
Defined in: [Behaviour.ts:
|
|
331
|
+
Defined in: [Behaviour.ts:263](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L263)
|
|
191
332
|
|
|
192
333
|
Returns the entity's world-space position as a new `THREE.Vector3`, or
|
|
193
334
|
`null` if the entity has no scene presence.
|
|
@@ -204,7 +345,7 @@ Returns the entity's world-space position as a new `THREE.Vector3`, or
|
|
|
204
345
|
getWorldDirection(): Vector3 | null;
|
|
205
346
|
```
|
|
206
347
|
|
|
207
|
-
Defined in: [Behaviour.ts:
|
|
348
|
+
Defined in: [Behaviour.ts:278](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L278)
|
|
208
349
|
|
|
209
350
|
Returns the entity's forward direction in world space (the +Z axis of its
|
|
210
351
|
world matrix), or `null` if the entity has no scene presence.
|
|
@@ -221,7 +362,7 @@ world matrix), or `null` if the entity has no scene presence.
|
|
|
221
362
|
directionTo(targetPosition): Vector3 | null;
|
|
222
363
|
```
|
|
223
364
|
|
|
224
|
-
Defined in: [Behaviour.ts:
|
|
365
|
+
Defined in: [Behaviour.ts:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L295)
|
|
225
366
|
|
|
226
367
|
Returns a unit vector pointing from this entity toward the given world
|
|
227
368
|
position, or `null` if the entity has no scene presence.
|
|
@@ -244,7 +385,7 @@ position, or `null` if the entity has no scene presence.
|
|
|
244
385
|
distanceTo(targetPosition): number | null;
|
|
245
386
|
```
|
|
246
387
|
|
|
247
|
-
Defined in: [Behaviour.ts:
|
|
388
|
+
Defined in: [Behaviour.ts:310](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L310)
|
|
248
389
|
|
|
249
390
|
Returns the world-space distance from this entity to the given position,
|
|
250
391
|
or `null` if the entity has no scene presence.
|
|
@@ -267,7 +408,7 @@ or `null` if the entity has no scene presence.
|
|
|
267
408
|
lerpTo(targetPosition, alpha): void;
|
|
268
409
|
```
|
|
269
410
|
|
|
270
|
-
Defined in: [Behaviour.ts:
|
|
411
|
+
Defined in: [Behaviour.ts:328](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L328)
|
|
271
412
|
|
|
272
413
|
Linearly interpolates the entity's position toward `targetPosition` and
|
|
273
414
|
writes the result back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if the
|
|
@@ -292,7 +433,7 @@ entity has no scene presence.
|
|
|
292
433
|
slerpTo(targetRotation, alpha): void;
|
|
293
434
|
```
|
|
294
435
|
|
|
295
|
-
Defined in: [Behaviour.ts:
|
|
436
|
+
Defined in: [Behaviour.ts:350](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L350)
|
|
296
437
|
|
|
297
438
|
Spherically interpolates the entity's rotation toward `targetRotation`
|
|
298
439
|
and writes the result back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if
|
|
@@ -317,7 +458,7 @@ the entity has no scene presence.
|
|
|
317
458
|
lookAt(targetPosition): void;
|
|
318
459
|
```
|
|
319
460
|
|
|
320
|
-
Defined in: [Behaviour.ts:
|
|
461
|
+
Defined in: [Behaviour.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L369)
|
|
321
462
|
|
|
322
463
|
Rotates the entity to face `targetPosition` in world space and writes the
|
|
323
464
|
resulting orientation back through [TransformComponent](../../components/classes/TransformComponent.md). No-op if
|
|
@@ -341,7 +482,7 @@ the entity has no scene presence.
|
|
|
341
482
|
getComponents(): Component[];
|
|
342
483
|
```
|
|
343
484
|
|
|
344
|
-
Defined in: [Behaviour.ts:
|
|
485
|
+
Defined in: [Behaviour.ts:383](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L383)
|
|
345
486
|
|
|
346
487
|
Returns every component currently attached to this entity.
|
|
347
488
|
|
|
@@ -357,7 +498,7 @@ Returns every component currently attached to this entity.
|
|
|
357
498
|
getComponent<T>(componentClass): T | null;
|
|
358
499
|
```
|
|
359
500
|
|
|
360
|
-
Defined in: [Behaviour.ts:
|
|
501
|
+
Defined in: [Behaviour.ts:400](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L400)
|
|
361
502
|
|
|
362
503
|
Returns the entity's component of the given class, or `null` if it has
|
|
363
504
|
no such component.
|
|
@@ -393,7 +534,7 @@ if (mesh) console.log(mesh.geometryRef);
|
|
|
393
534
|
getEntity(): WorldEntityView | null;
|
|
394
535
|
```
|
|
395
536
|
|
|
396
|
-
Defined in: [Behaviour.ts:
|
|
537
|
+
Defined in: [Behaviour.ts:410](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L410)
|
|
397
538
|
|
|
398
539
|
Returns the latest [WorldEntityView](../../types/type-aliases/WorldEntityView.md) snapshot for this entity, or
|
|
399
540
|
`null` if it was destroyed.
|
|
@@ -410,7 +551,7 @@ Returns the latest [WorldEntityView](../../types/type-aliases/WorldEntityView.md
|
|
|
410
551
|
getParent(): ParentLookup;
|
|
411
552
|
```
|
|
412
553
|
|
|
413
|
-
Defined in: [Behaviour.ts:
|
|
554
|
+
Defined in: [Behaviour.ts:420](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L420)
|
|
414
555
|
|
|
415
556
|
Resolves the entity's parent from the [ParentId](../../components/classes/ParentId.md) component, if any.
|
|
416
557
|
|
|
@@ -429,7 +570,7 @@ A [ParentLookup](../../types/type-aliases/ParentLookup.md) with the parent compo
|
|
|
429
570
|
getChildren(): WorldEntityView[];
|
|
430
571
|
```
|
|
431
572
|
|
|
432
|
-
Defined in: [Behaviour.ts:
|
|
573
|
+
Defined in: [Behaviour.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L441)
|
|
433
574
|
|
|
434
575
|
Returns every direct child entity of this one (entities whose
|
|
435
576
|
[ParentId](../../components/classes/ParentId.md) matches `entityId`).
|
|
@@ -446,7 +587,7 @@ Returns every direct child entity of this one (entities whose
|
|
|
446
587
|
protected init(): void;
|
|
447
588
|
```
|
|
448
589
|
|
|
449
|
-
Defined in: [Behaviour.ts:
|
|
590
|
+
Defined in: [Behaviour.ts:456](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L456)
|
|
450
591
|
|
|
451
592
|
Called once before the first [Behaviour.onUpdate](#onupdate). Override to
|
|
452
593
|
default and validate [Behaviour.data](#data), cache references, or set
|
|
@@ -464,7 +605,7 @@ initial state. Runs at preview/runtime only — never in the editor.
|
|
|
464
605
|
protected onUpdate(): void;
|
|
465
606
|
```
|
|
466
607
|
|
|
467
|
-
Defined in: [Behaviour.ts:
|
|
608
|
+
Defined in: [Behaviour.ts:465](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L465)
|
|
468
609
|
|
|
469
610
|
Called every frame while the script is enabled. Override with the
|
|
470
611
|
script's main per-frame logic. Runs at preview/runtime only — never in the
|
|
@@ -482,7 +623,7 @@ editor (use [ScriptObject](../../index/classes/ScriptObject.md) for editor-visib
|
|
|
482
623
|
onSelect(): void;
|
|
483
624
|
```
|
|
484
625
|
|
|
485
|
-
Defined in: [Behaviour.ts:
|
|
626
|
+
Defined in: [Behaviour.ts:470](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L470)
|
|
486
627
|
|
|
487
628
|
Called when the editor selects this entity. Optional UX hook.
|
|
488
629
|
|
|
@@ -498,7 +639,7 @@ Called when the editor selects this entity. Optional UX hook.
|
|
|
498
639
|
onDeselect(): void;
|
|
499
640
|
```
|
|
500
641
|
|
|
501
|
-
Defined in: [Behaviour.ts:
|
|
642
|
+
Defined in: [Behaviour.ts:475](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L475)
|
|
502
643
|
|
|
503
644
|
Called when the editor deselects this entity. Optional UX hook.
|
|
504
645
|
|
|
@@ -514,7 +655,7 @@ Called when the editor deselects this entity. Optional UX hook.
|
|
|
514
655
|
onTargetFound(target): void;
|
|
515
656
|
```
|
|
516
657
|
|
|
517
|
-
Defined in: [Behaviour.ts:
|
|
658
|
+
Defined in: [Behaviour.ts:485](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L485)
|
|
518
659
|
|
|
519
660
|
Called when an image-tracking target this entity depends on becomes
|
|
520
661
|
visible. Optional AR hook.
|
|
@@ -537,7 +678,7 @@ visible. Optional AR hook.
|
|
|
537
678
|
onTargetLost(target): void;
|
|
538
679
|
```
|
|
539
680
|
|
|
540
|
-
Defined in: [Behaviour.ts:
|
|
681
|
+
Defined in: [Behaviour.ts:495](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L495)
|
|
541
682
|
|
|
542
683
|
Called when an image-tracking target this entity depends on is lost.
|
|
543
684
|
Optional AR hook.
|
|
@@ -560,7 +701,7 @@ Optional AR hook.
|
|
|
560
701
|
onXRSessionStart(capabilities): void;
|
|
561
702
|
```
|
|
562
703
|
|
|
563
|
-
Defined in: [Behaviour.ts:
|
|
704
|
+
Defined in: [Behaviour.ts:514](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L514)
|
|
564
705
|
|
|
565
706
|
Called once when an immersive session starts. Optional XR hook.
|
|
566
707
|
|
|
@@ -586,7 +727,7 @@ Pro grants no passthrough on the web today).
|
|
|
586
727
|
onXRSessionEnd(): void;
|
|
587
728
|
```
|
|
588
729
|
|
|
589
|
-
Defined in: [Behaviour.ts:
|
|
730
|
+
Defined in: [Behaviour.ts:519](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L519)
|
|
590
731
|
|
|
591
732
|
Called once when the immersive session ends. Optional XR hook.
|
|
592
733
|
|
|
@@ -602,7 +743,7 @@ Called once when the immersive session ends. Optional XR hook.
|
|
|
602
743
|
onSelectStart(input): void;
|
|
603
744
|
```
|
|
604
745
|
|
|
605
|
-
Defined in: [Behaviour.ts:
|
|
746
|
+
Defined in: [Behaviour.ts:529](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L529)
|
|
606
747
|
|
|
607
748
|
Called when a primary action begins — controller trigger, hand pinch, or
|
|
608
749
|
Vision Pro gaze-pinch. Optional XR hook.
|
|
@@ -625,7 +766,7 @@ Vision Pro gaze-pinch. Optional XR hook.
|
|
|
625
766
|
onSelectEnd(input): void;
|
|
626
767
|
```
|
|
627
768
|
|
|
628
|
-
Defined in: [Behaviour.ts:
|
|
769
|
+
Defined in: [Behaviour.ts:534](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L534)
|
|
629
770
|
|
|
630
771
|
Called when the primary action ends. Optional XR hook.
|
|
631
772
|
|
|
@@ -647,7 +788,7 @@ Called when the primary action ends. Optional XR hook.
|
|
|
647
788
|
onSecondaryGrab(_input): void;
|
|
648
789
|
```
|
|
649
790
|
|
|
650
|
-
Defined in: [Behaviour.ts:
|
|
791
|
+
Defined in: [Behaviour.ts:552](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L552)
|
|
651
792
|
|
|
652
793
|
A SECOND hand joined a two-hand grab on this entity.
|
|
653
794
|
|
|
@@ -672,7 +813,7 @@ hand that came second — the foregrip on a rifle, say.
|
|
|
672
813
|
onSecondaryRelease(_input): void;
|
|
673
814
|
```
|
|
674
815
|
|
|
675
|
-
Defined in: [Behaviour.ts:
|
|
816
|
+
Defined in: [Behaviour.ts:557](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L557)
|
|
676
817
|
|
|
677
818
|
The second hand let go, leaving the object in the first hand alone.
|
|
678
819
|
|
|
@@ -694,7 +835,7 @@ The second hand let go, leaving the object in the first hand alone.
|
|
|
694
835
|
onHandPoseStart(_event): void;
|
|
695
836
|
```
|
|
696
837
|
|
|
697
|
-
Defined in: [Behaviour.ts:
|
|
838
|
+
Defined in: [Behaviour.ts:567](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L567)
|
|
698
839
|
|
|
699
840
|
A hand pose declared on this entity started being held.
|
|
700
841
|
|
|
@@ -719,7 +860,7 @@ the fingers pass through it.
|
|
|
719
860
|
onHandPoseEnd(_event): void;
|
|
720
861
|
```
|
|
721
862
|
|
|
722
|
-
Defined in: [Behaviour.ts:
|
|
863
|
+
Defined in: [Behaviour.ts:572](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L572)
|
|
723
864
|
|
|
724
865
|
A held hand pose ended, or its hand stopped being tracked.
|
|
725
866
|
|
|
@@ -741,7 +882,7 @@ A held hand pose ended, or its hand stopped being tracked.
|
|
|
741
882
|
onGrab(input): void;
|
|
742
883
|
```
|
|
743
884
|
|
|
744
|
-
Defined in: [Behaviour.ts:
|
|
885
|
+
Defined in: [Behaviour.ts:576](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L576)
|
|
745
886
|
|
|
746
887
|
#### Parameters
|
|
747
888
|
|
|
@@ -761,7 +902,7 @@ Defined in: [Behaviour.ts:532](https://github.com/Relu-Interactives/relu-spatial
|
|
|
761
902
|
onRelease(input): void;
|
|
762
903
|
```
|
|
763
904
|
|
|
764
|
-
Defined in: [Behaviour.ts:
|
|
905
|
+
Defined in: [Behaviour.ts:581](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L581)
|
|
765
906
|
|
|
766
907
|
Called when this entity is released. Optional XR hook.
|
|
767
908
|
|
|
@@ -783,7 +924,7 @@ Called when this entity is released. Optional XR hook.
|
|
|
783
924
|
onUiPress(_event): void;
|
|
784
925
|
```
|
|
785
926
|
|
|
786
|
-
Defined in: [Behaviour.ts:
|
|
927
|
+
Defined in: [Behaviour.ts:587](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L587)
|
|
787
928
|
|
|
788
929
|
A UI button on this entity (or a descendant) was clicked. Clicks fire on
|
|
789
930
|
RELEASE while still pointing at the widget — sliding off cancels.
|
|
@@ -806,7 +947,7 @@ RELEASE while still pointing at the widget — sliding off cancels.
|
|
|
806
947
|
onUiHoverStart(_event): void;
|
|
807
948
|
```
|
|
808
949
|
|
|
809
|
-
Defined in: [Behaviour.ts:
|
|
950
|
+
Defined in: [Behaviour.ts:592](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L592)
|
|
810
951
|
|
|
811
952
|
A pointer began hovering a UI widget on this entity (or a descendant).
|
|
812
953
|
|
|
@@ -828,7 +969,7 @@ A pointer began hovering a UI widget on this entity (or a descendant).
|
|
|
828
969
|
onUiHoverEnd(_event): void;
|
|
829
970
|
```
|
|
830
971
|
|
|
831
|
-
Defined in: [Behaviour.ts:
|
|
972
|
+
Defined in: [Behaviour.ts:597](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L597)
|
|
832
973
|
|
|
833
974
|
The pointer left the widget.
|
|
834
975
|
|
|
@@ -850,7 +991,7 @@ The pointer left the widget.
|
|
|
850
991
|
onUiToggle(_event): void;
|
|
851
992
|
```
|
|
852
993
|
|
|
853
|
-
Defined in: [Behaviour.ts:
|
|
994
|
+
Defined in: [Behaviour.ts:602](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L602)
|
|
854
995
|
|
|
855
996
|
A UI toggle flipped; `event.value` is the new boolean.
|
|
856
997
|
|
|
@@ -872,7 +1013,7 @@ A UI toggle flipped; `event.value` is the new boolean.
|
|
|
872
1013
|
onUiChange(_event): void;
|
|
873
1014
|
```
|
|
874
1015
|
|
|
875
|
-
Defined in: [Behaviour.ts:
|
|
1016
|
+
Defined in: [Behaviour.ts:608](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L608)
|
|
876
1017
|
|
|
877
1018
|
A UI slider moved; `event.value` is the new number. Fires on real value
|
|
878
1019
|
changes during the drag and once more on release.
|
|
@@ -15,7 +15,7 @@ type UiInteractionEvent = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [Behaviour.ts:
|
|
18
|
+
Defined in: [Behaviour.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L78)
|
|
19
19
|
|
|
20
20
|
Payload for spatial-UI hooks.
|
|
21
21
|
|
|
@@ -29,7 +29,7 @@ preview rather than an XR pointer.
|
|
|
29
29
|
|
|
30
30
|
| Property | Type | Description | Defined in |
|
|
31
31
|
| ------ | ------ | ------ | ------ |
|
|
32
|
-
| <a id="targetentityid"></a> `targetEntityId` | `number` | - | [Behaviour.ts:
|
|
33
|
-
| <a id="actionid"></a> `actionId` | `string` | - | [Behaviour.ts:
|
|
34
|
-
| <a id="input"></a> `input` | [`XrInputState`](../../index/type-aliases/XrInputState.md) \| `null` | - | [Behaviour.ts:
|
|
35
|
-
| <a id="value"></a> `value?` | `boolean` \| `number` | Toggle: the new boolean. Slider: the new number. Absent for presses. | [Behaviour.ts:
|
|
32
|
+
| <a id="targetentityid"></a> `targetEntityId` | `number` | - | [Behaviour.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L79) |
|
|
33
|
+
| <a id="actionid"></a> `actionId` | `string` | - | [Behaviour.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L80) |
|
|
34
|
+
| <a id="input"></a> `input` | [`XrInputState`](../../index/type-aliases/XrInputState.md) \| `null` | - | [Behaviour.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L81) |
|
|
35
|
+
| <a id="value"></a> `value?` | `boolean` \| `number` | Toggle: the new boolean. Slider: the new number. Absent for presses. | [Behaviour.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/Behaviour.ts#L83) |
|