@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.
- 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
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / SoundSlot
|
|
6
|
+
|
|
7
|
+
# Interface: SoundSlot
|
|
8
|
+
|
|
9
|
+
Defined in: [audio/soundBank.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L22)
|
|
10
|
+
|
|
11
|
+
A named sound the game asks for ("hit", "footstep"), played as a random take.
|
|
12
|
+
|
|
13
|
+
| Field | Default | Description |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| `takes` | | The recordings to choose between. |
|
|
16
|
+
| `bus` | `"sfx"` | Which volume group it plays through. |
|
|
17
|
+
| `chance` | `1` | Probability it plays at all when asked, `0` to `1`. |
|
|
18
|
+
| `cooldownMs` | `0` | Asks within this long of the last play are ignored. |
|
|
19
|
+
| `volume` | `1` | Linear gain. |
|
|
20
|
+
| `priority` | `0` | On the voice bus: lower priorities wait, higher ones cut in. |
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Type | Defined in |
|
|
25
|
+
| ------ | ------ | ------ |
|
|
26
|
+
| <a id="takes"></a> `takes` | [`SoundTake`](SoundTake.md)[] | [audio/soundBank.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L23) |
|
|
27
|
+
| <a id="bus"></a> `bus?` | [`AudioBus`](../type-aliases/AudioBus.md) | [audio/soundBank.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L24) |
|
|
28
|
+
| <a id="chance"></a> `chance?` | `number` | [audio/soundBank.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L25) |
|
|
29
|
+
| <a id="cooldownms"></a> `cooldownMs?` | `number` | [audio/soundBank.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L26) |
|
|
30
|
+
| <a id="volume"></a> `volume?` | `number` | [audio/soundBank.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L27) |
|
|
31
|
+
| <a id="priority"></a> `priority?` | `number` | [audio/soundBank.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L28) |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / SoundTake
|
|
6
|
+
|
|
7
|
+
# Interface: SoundTake
|
|
8
|
+
|
|
9
|
+
Defined in: [audio/soundBank.ts:2](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L2)
|
|
10
|
+
|
|
11
|
+
One recording of a slot. `file` is an asset path; `volume` multiplies the slot's.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Type | Defined in |
|
|
16
|
+
| ------ | ------ | ------ |
|
|
17
|
+
| <a id="file"></a> `file` | `string` | [audio/soundBank.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L3) |
|
|
18
|
+
| <a id="volume"></a> `volume?` | `number` | [audio/soundBank.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L4) |
|
|
@@ -6,21 +6,21 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StateMachine
|
|
8
8
|
|
|
9
|
-
Defined in: [AnimationStateMachine.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L3)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
13
|
| Property | Type | Defined in |
|
|
14
14
|
| ------ | ------ | ------ |
|
|
15
|
-
| <a id="name"></a> `name` | `string` | [AnimationStateMachine.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
-
| <a id="clip"></a> `clip` | `AnimationClip` | [AnimationStateMachine.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
-
| <a id="clipid"></a> `clipId` | `string` \| `null` | [AnimationStateMachine.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
-
| <a id="loop"></a> `loop` | `boolean` | [AnimationStateMachine.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
-
| <a id="isplaying"></a> `isPlaying` | `boolean` | [AnimationStateMachine.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
20
|
-
| <a id="ispaused"></a> `isPaused` | `boolean` | [AnimationStateMachine.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
-
| <a id="onstart"></a> `onStart` | () => `void` | [AnimationStateMachine.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
-
| <a id="onplaying"></a> `onPlaying` | () => `void` | [AnimationStateMachine.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="onend"></a> `onEnd` | () => `void` | [AnimationStateMachine.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="play"></a> `play` | () => `void` | [AnimationStateMachine.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="pause"></a> `pause` | () => `void` | [AnimationStateMachine.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="stop"></a> `stop` | () => `void` | [AnimationStateMachine.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
| <a id="name"></a> `name` | `string` | [AnimationStateMachine.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L4) |
|
|
16
|
+
| <a id="clip"></a> `clip` | `AnimationClip` | [AnimationStateMachine.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L5) |
|
|
17
|
+
| <a id="clipid"></a> `clipId` | `string` \| `null` | [AnimationStateMachine.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L6) |
|
|
18
|
+
| <a id="loop"></a> `loop` | `boolean` | [AnimationStateMachine.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L7) |
|
|
19
|
+
| <a id="isplaying"></a> `isPlaying` | `boolean` | [AnimationStateMachine.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L8) |
|
|
20
|
+
| <a id="ispaused"></a> `isPaused` | `boolean` | [AnimationStateMachine.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L9) |
|
|
21
|
+
| <a id="onstart"></a> `onStart` | () => `void` | [AnimationStateMachine.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L10) |
|
|
22
|
+
| <a id="onplaying"></a> `onPlaying` | () => `void` | [AnimationStateMachine.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L11) |
|
|
23
|
+
| <a id="onend"></a> `onEnd` | () => `void` | [AnimationStateMachine.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L12) |
|
|
24
|
+
| <a id="play"></a> `play` | () => `void` | [AnimationStateMachine.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L13) |
|
|
25
|
+
| <a id="pause"></a> `pause` | () => `void` | [AnimationStateMachine.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L14) |
|
|
26
|
+
| <a id="stop"></a> `stop` | () => `void` | [AnimationStateMachine.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L15) |
|
|
@@ -14,12 +14,12 @@ type AnimationStateCallbacks = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [AnimationStateMachine.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [AnimationStateMachine.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L18)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="onstart"></a> `onStart?` | () => `void` | [AnimationStateMachine.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="onplaying"></a> `onPlaying?` | () => `void` | [AnimationStateMachine.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="onend"></a> `onEnd?` | () => `void` | [AnimationStateMachine.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="onstart"></a> `onStart?` | () => `void` | [AnimationStateMachine.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L19) |
|
|
24
|
+
| <a id="onplaying"></a> `onPlaying?` | () => `void` | [AnimationStateMachine.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L20) |
|
|
25
|
+
| <a id="onend"></a> `onEnd?` | () => `void` | [AnimationStateMachine.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L21) |
|
|
@@ -13,11 +13,11 @@ type ApplyPrefabToSnapshotResult = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [prefab/applyPrefabToSnapshot.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [prefab/applyPrefabToSnapshot.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/applyPrefabToSnapshot.ts#L112)
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
20
|
| Property | Type | Defined in |
|
|
21
21
|
| ------ | ------ | ------ |
|
|
22
|
-
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | [prefab/applyPrefabToSnapshot.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="changed"></a> `changed` | `boolean` | [prefab/applyPrefabToSnapshot.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | [prefab/applyPrefabToSnapshot.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/applyPrefabToSnapshot.ts#L113) |
|
|
23
|
+
| <a id="changed"></a> `changed` | `boolean` | [prefab/applyPrefabToSnapshot.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/applyPrefabToSnapshot.ts#L114) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AudioBus
|
|
6
|
+
|
|
7
|
+
# Type Alias: AudioBus
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type AudioBus = "sfx" | "voice" | "music";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [audio/soundBank.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/soundBank.ts#L8)
|
|
14
|
+
|
|
15
|
+
The mixer's groups. Music dips while a voice plays.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type ComponentFactory = (world, entityId, ...args) => unknown;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/ObjectManagementSystem.ts:
|
|
13
|
+
Defined in: [systems/ObjectManagementSystem.ts:114](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L114)
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -35,6 +35,12 @@ type ComponentValueMaps = {
|
|
|
35
35
|
xrInteractorValues: Map<number, unknown>;
|
|
36
36
|
xrHandPoseValues: Map<number, unknown>;
|
|
37
37
|
xrAnchorValues: Map<number, unknown>;
|
|
38
|
+
boneAttachmentValues: Map<number, unknown>;
|
|
39
|
+
ikValues: Map<number, unknown>;
|
|
40
|
+
networkIdentityValues: Map<number, unknown>;
|
|
41
|
+
networkTransformValues: Map<number, unknown>;
|
|
42
|
+
networkedPropsValues: Map<number, unknown>;
|
|
43
|
+
networkSpawnerValues: Map<number, unknown>;
|
|
38
44
|
uiPanelValues: Map<number, unknown>;
|
|
39
45
|
uiTextValues: Map<number, unknown>;
|
|
40
46
|
uiButtonValues: Map<number, unknown>;
|
|
@@ -48,46 +54,52 @@ type ComponentValueMaps = {
|
|
|
48
54
|
};
|
|
49
55
|
```
|
|
50
56
|
|
|
51
|
-
Defined in: [hydration/types.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
+
Defined in: [hydration/types.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L21)
|
|
52
58
|
|
|
53
59
|
## Properties
|
|
54
60
|
|
|
55
61
|
| Property | Type | Defined in |
|
|
56
62
|
| ------ | ------ | ------ |
|
|
57
|
-
| <a id="object3drefvalues"></a> `object3DRefValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| <a id="namevalues"></a> `nameValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="transformvalues"></a> `transformValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="modelvalues"></a> `modelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
61
|
-
| <a id="imagevalues"></a> `imageValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
62
|
-
| <a id="spritevalues"></a> `spriteValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
-
| <a id="videovalues"></a> `videoValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
64
|
-
| <a id="cameravalues"></a> `cameraValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
65
|
-
| <a id="environmentvalues"></a> `environmentValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
66
|
-
| <a id="postprocessingvalues"></a> `postprocessingValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
67
|
-
| <a id="audiovalues"></a> `audioValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
68
|
-
| <a id="imagetargetvalues"></a> `imageTargetValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
69
|
-
| <a id="lightvalues"></a> `lightValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
70
|
-
| <a id="materialvalues"></a> `materialValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
71
|
-
| <a id="meshgeometryvalues"></a> `meshGeometryValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
72
|
-
| <a id="selectablevalues"></a> `selectableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
73
|
-
| <a id="physicsvalues"></a> `physicsValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
74
|
-
| <a id="animationvalues"></a> `animationValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
75
|
-
| <a id="imagetargetanchorvalues"></a> `imageTargetAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
76
|
-
| <a id="scriptvalues"></a> `scriptValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
77
|
-
| <a id="scriptobjectvalues"></a> `scriptObjectValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
78
|
-
| <a id="xrrigvalues"></a> `xrRigValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
79
|
-
| <a id="vrteleportareavalues"></a> `vrTeleportAreaValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
80
|
-
| <a id="xrinteractablevalues"></a> `xrInteractableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
81
|
-
| <a id="xrinteractorvalues"></a> `xrInteractorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
82
|
-
| <a id="xrhandposevalues"></a> `xrHandPoseValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
83
|
-
| <a id="xranchorvalues"></a> `xrAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
84
|
-
| <a id="
|
|
85
|
-
| <a id="
|
|
86
|
-
| <a id="
|
|
87
|
-
| <a id="
|
|
88
|
-
| <a id="
|
|
89
|
-
| <a id="
|
|
90
|
-
| <a id="
|
|
91
|
-
| <a id="
|
|
92
|
-
| <a id="
|
|
93
|
-
| <a id="
|
|
63
|
+
| <a id="object3drefvalues"></a> `object3DRefValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L22) |
|
|
64
|
+
| <a id="namevalues"></a> `nameValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L23) |
|
|
65
|
+
| <a id="transformvalues"></a> `transformValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L24) |
|
|
66
|
+
| <a id="modelvalues"></a> `modelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L25) |
|
|
67
|
+
| <a id="imagevalues"></a> `imageValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L26) |
|
|
68
|
+
| <a id="spritevalues"></a> `spriteValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L27) |
|
|
69
|
+
| <a id="videovalues"></a> `videoValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L28) |
|
|
70
|
+
| <a id="cameravalues"></a> `cameraValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L29) |
|
|
71
|
+
| <a id="environmentvalues"></a> `environmentValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L30) |
|
|
72
|
+
| <a id="postprocessingvalues"></a> `postprocessingValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L31) |
|
|
73
|
+
| <a id="audiovalues"></a> `audioValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L32) |
|
|
74
|
+
| <a id="imagetargetvalues"></a> `imageTargetValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L33) |
|
|
75
|
+
| <a id="lightvalues"></a> `lightValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L34) |
|
|
76
|
+
| <a id="materialvalues"></a> `materialValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L35) |
|
|
77
|
+
| <a id="meshgeometryvalues"></a> `meshGeometryValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L36) |
|
|
78
|
+
| <a id="selectablevalues"></a> `selectableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L37) |
|
|
79
|
+
| <a id="physicsvalues"></a> `physicsValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L38) |
|
|
80
|
+
| <a id="animationvalues"></a> `animationValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L39) |
|
|
81
|
+
| <a id="imagetargetanchorvalues"></a> `imageTargetAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L40) |
|
|
82
|
+
| <a id="scriptvalues"></a> `scriptValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L41) |
|
|
83
|
+
| <a id="scriptobjectvalues"></a> `scriptObjectValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L42) |
|
|
84
|
+
| <a id="xrrigvalues"></a> `xrRigValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L43) |
|
|
85
|
+
| <a id="vrteleportareavalues"></a> `vrTeleportAreaValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L44) |
|
|
86
|
+
| <a id="xrinteractablevalues"></a> `xrInteractableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L45) |
|
|
87
|
+
| <a id="xrinteractorvalues"></a> `xrInteractorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L46) |
|
|
88
|
+
| <a id="xrhandposevalues"></a> `xrHandPoseValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L47) |
|
|
89
|
+
| <a id="xranchorvalues"></a> `xrAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L48) |
|
|
90
|
+
| <a id="boneattachmentvalues"></a> `boneAttachmentValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L49) |
|
|
91
|
+
| <a id="ikvalues"></a> `ikValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L50) |
|
|
92
|
+
| <a id="networkidentityvalues"></a> `networkIdentityValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L51) |
|
|
93
|
+
| <a id="networktransformvalues"></a> `networkTransformValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L52) |
|
|
94
|
+
| <a id="networkedpropsvalues"></a> `networkedPropsValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L53) |
|
|
95
|
+
| <a id="networkspawnervalues"></a> `networkSpawnerValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L54) |
|
|
96
|
+
| <a id="uipanelvalues"></a> `uiPanelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L55) |
|
|
97
|
+
| <a id="uitextvalues"></a> `uiTextValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L56) |
|
|
98
|
+
| <a id="uibuttonvalues"></a> `uiButtonValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L57) |
|
|
99
|
+
| <a id="uitogglevalues"></a> `uiToggleValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L58) |
|
|
100
|
+
| <a id="uislidervalues"></a> `uiSliderValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L59) |
|
|
101
|
+
| <a id="xrinteractorsidevalues"></a> `xrInteractorSideValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L60) |
|
|
102
|
+
| <a id="instancedmeshvalues"></a> `instancedMeshValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L61) |
|
|
103
|
+
| <a id="instanceslotvalues"></a> `instanceSlotValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L62) |
|
|
104
|
+
| <a id="prefabnodevalues"></a> `prefabNodeValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L63) |
|
|
105
|
+
| <a id="prefabinstancevalues"></a> `prefabInstanceValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L64) |
|
|
@@ -38,6 +38,12 @@ type EcsComponentFactoryKind =
|
|
|
38
38
|
| "vrTeleportArea"
|
|
39
39
|
| "xrHandPose"
|
|
40
40
|
| "xrAnchor"
|
|
41
|
+
| "boneAttachment"
|
|
42
|
+
| "ik"
|
|
43
|
+
| "networkIdentity"
|
|
44
|
+
| "networkTransform"
|
|
45
|
+
| "networkedProps"
|
|
46
|
+
| "networkSpawner"
|
|
41
47
|
| "uiPanel"
|
|
42
48
|
| "uiText"
|
|
43
49
|
| "uiButton"
|
|
@@ -48,4 +54,4 @@ type EcsComponentFactoryKind =
|
|
|
48
54
|
| "xrInteractorSide";
|
|
49
55
|
```
|
|
50
56
|
|
|
51
|
-
Defined in: [systems/ObjectManagementSystem.ts:
|
|
57
|
+
Defined in: [systems/ObjectManagementSystem.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ObjectManagementSystem.ts#L68)
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type EcsRenderer = THREE.WebGLRenderer | WebGPURenderer;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: render/RenderBackend.ts:13
|
|
13
|
+
Defined in: [render/RenderBackend.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L13)
|
|
14
14
|
|
|
15
15
|
A renderer a [World](../classes/World.md) can run on: three's classic `WebGLRenderer`, or
|
|
16
16
|
`WebGPURenderer` from `three/webgpu` (which falls back to WebGL 2 on its own
|
|
@@ -16,11 +16,11 @@ type EcsWorldComponentSnapshot = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [hydration/types.ts:
|
|
19
|
+
Defined in: [hydration/types.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L67)
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
23
23
|
| Property | Type | Defined in |
|
|
24
24
|
| ------ | ------ | ------ |
|
|
25
|
-
| <a id="component"></a> `component` | `string` | [hydration/types.ts:
|
|
26
|
-
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:
|
|
25
|
+
| <a id="component"></a> `component` | `string` | [hydration/types.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L68) |
|
|
26
|
+
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L69) |
|
|
@@ -14,12 +14,12 @@ type EcsWorldStateSnapshotLike = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [hydration/types.ts:
|
|
17
|
+
Defined in: [hydration/types.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L75)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:
|
|
24
|
-
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:
|
|
25
|
-
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:
|
|
23
|
+
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L76) |
|
|
24
|
+
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L77) |
|
|
25
|
+
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L78) |
|
|
@@ -15,13 +15,13 @@ type ExternalRefWarning = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/snapshotIdUtils.ts:
|
|
18
|
+
Defined in: [prefab/snapshotIdUtils.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L26)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="entityid"></a> `entityId` | `number` | Entity id (in the INPUT snapshot's id space) holding the reference. | [prefab/snapshotIdUtils.ts:
|
|
25
|
-
| <a id="component"></a> `component` | `string` | - | [prefab/snapshotIdUtils.ts:
|
|
26
|
-
| <a id="path"></a> `path` | `string` | Slash-separated path of the reference inside the component value. | [prefab/snapshotIdUtils.ts:
|
|
27
|
-
| <a id="targetid"></a> `targetId` | `number` | The referenced entity id that falls outside the id map. | [prefab/snapshotIdUtils.ts:
|
|
24
|
+
| <a id="entityid"></a> `entityId` | `number` | Entity id (in the INPUT snapshot's id space) holding the reference. | [prefab/snapshotIdUtils.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L28) |
|
|
25
|
+
| <a id="component"></a> `component` | `string` | - | [prefab/snapshotIdUtils.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L29) |
|
|
26
|
+
| <a id="path"></a> `path` | `string` | Slash-separated path of the reference inside the component value. | [prefab/snapshotIdUtils.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L31) |
|
|
27
|
+
| <a id="targetid"></a> `targetId` | `number` | The referenced entity id that falls outside the id map. | [prefab/snapshotIdUtils.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L33) |
|
|
@@ -14,7 +14,7 @@ type HandMaterialOptions = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [xr/handPresets.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [xr/handPresets.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPresets.ts#L13)
|
|
18
18
|
|
|
19
19
|
Materials for tracked-hand meshes.
|
|
20
20
|
|
|
@@ -27,6 +27,6 @@ the colour/opacity/emissive fields.
|
|
|
27
27
|
|
|
28
28
|
| Property | Type | Defined in |
|
|
29
29
|
| ------ | ------ | ------ |
|
|
30
|
-
| <a id="color"></a> `color` | `string` | [xr/handPresets.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="opacity"></a> `opacity` | `number` | [xr/handPresets.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | [xr/handPresets.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
| <a id="color"></a> `color` | `string` | [xr/handPresets.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPresets.ts#L14) |
|
|
31
|
+
| <a id="opacity"></a> `opacity` | `number` | [xr/handPresets.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPresets.ts#L15) |
|
|
32
|
+
| <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | [xr/handPresets.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPresets.ts#L16) |
|
|
@@ -15,13 +15,13 @@ type HandPoseTrackerOptions = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [xr/handPose.ts:742](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [xr/handPose.ts:742](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L742)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="enterconfidence"></a> `enterConfidence?` | `number` | Confidence needed to begin holding. | [xr/handPose.ts:744](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="exitconfidence"></a> `exitConfidence?` | `number` | Confidence below which an active pose ends. Must be < enter. | [xr/handPose.ts:746](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="minholdseconds"></a> `minHoldSeconds?` | `number` | Seconds the pose must be held before it fires. | [xr/handPose.ts:748](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="lostgraceseconds"></a> `lostGraceSeconds?` | `number` | Grace period before tracking loss ends an active pose. | [xr/handPose.ts:750](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="enterconfidence"></a> `enterConfidence?` | `number` | Confidence needed to begin holding. | [xr/handPose.ts:744](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L744) |
|
|
25
|
+
| <a id="exitconfidence"></a> `exitConfidence?` | `number` | Confidence below which an active pose ends. Must be < enter. | [xr/handPose.ts:746](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L746) |
|
|
26
|
+
| <a id="minholdseconds"></a> `minHoldSeconds?` | `number` | Seconds the pose must be held before it fires. | [xr/handPose.ts:748](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L748) |
|
|
27
|
+
| <a id="lostgraceseconds"></a> `lostGraceSeconds?` | `number` | Grace period before tracking loss ends an active pose. | [xr/handPose.ts:750](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L750) |
|
|
@@ -13,7 +13,7 @@ type HydrateOptions = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [hydration/types.ts:
|
|
16
|
+
Defined in: [hydration/types.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L93)
|
|
17
17
|
|
|
18
18
|
Optional behavior tweaks for [hydrateWorldFromSnapshotDetailed](../functions/hydrateWorldFromSnapshotDetailed.md).
|
|
19
19
|
Defaults preserve the historical full-world-load behavior; prefab/subtree
|
|
@@ -23,5 +23,5 @@ instantiation passes stricter options.
|
|
|
23
23
|
|
|
24
24
|
| Property | Type | Description | Defined in |
|
|
25
25
|
| ------ | ------ | ------ | ------ |
|
|
26
|
-
| <a id="assignprimarycamera"></a> `assignPrimaryCamera?` | `boolean` | When false, no camera in the snapshot is promoted to the world camera. Defaults to true (full scene loads want their default camera active); prefab spawns pass false so a spawned camera never hijacks the view. | [hydration/types.ts:
|
|
27
|
-
| <a id="applytransformsscope"></a> `applyTransformsScope?` | `"world"` \| `"created"` | "world" (default) re-applies local transforms for every entity in the world after parent links restore — correct for full scene loads. "created" limits the pass to entities created by THIS hydrate call, so mid-session spawns don't touch unrelated live entities. | [hydration/types.ts:
|
|
26
|
+
| <a id="assignprimarycamera"></a> `assignPrimaryCamera?` | `boolean` | When false, no camera in the snapshot is promoted to the world camera. Defaults to true (full scene loads want their default camera active); prefab spawns pass false so a spawned camera never hijacks the view. | [hydration/types.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L99) |
|
|
27
|
+
| <a id="applytransformsscope"></a> `applyTransformsScope?` | `"world"` \| `"created"` | "world" (default) re-applies local transforms for every entity in the world after parent links restore — correct for full scene loads. "created" limits the pass to entities created by THIS hydrate call, so mid-session spawns don't touch unrelated live entities. | [hydration/types.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L106) |
|
|
@@ -14,12 +14,12 @@ type HydrateWorldFromSnapshotResult = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [hydration/types.ts:
|
|
17
|
+
Defined in: [hydration/types.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L81)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="restoredcount"></a> `restoredCount` | `number` | - | [hydration/types.ts:
|
|
24
|
-
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | - | [hydration/types.ts:
|
|
25
|
-
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → created live entity id for every hydrated entity. | [hydration/types.ts:
|
|
23
|
+
| <a id="restoredcount"></a> `restoredCount` | `number` | - | [hydration/types.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L82) |
|
|
24
|
+
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | - | [hydration/types.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L83) |
|
|
25
|
+
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → created live entity id for every hydrated entity. | [hydration/types.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/hydration/types.ts#L85) |
|
|
@@ -13,11 +13,11 @@ type InstantiateSubtreeResult = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [prefab/instantiateSubtree.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [prefab/instantiateSubtree.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/instantiateSubtree.ts#L21)
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
20
|
| Property | Type | Description | Defined in |
|
|
21
21
|
| ------ | ------ | ------ | ------ |
|
|
22
|
-
| <a id="rootid"></a> `rootId` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Live entity id of the subtree root, or null when nothing hydrated. | [prefab/instantiateSubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → live entity id. | [prefab/instantiateSubtree.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
| <a id="rootid"></a> `rootId` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Live entity id of the subtree root, or null when nothing hydrated. | [prefab/instantiateSubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/instantiateSubtree.ts#L23) |
|
|
23
|
+
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → live entity id. | [prefab/instantiateSubtree.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/instantiateSubtree.ts#L25) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type KeyboardKey = typeof KeyboardKeys[keyof typeof KeyboardKeys];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/keyboardKeys.ts#L92)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ModelBoneInfo
|
|
6
|
+
|
|
7
|
+
# Type Alias: ModelBoneInfo
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ModelBoneInfo = {
|
|
11
|
+
name: string;
|
|
12
|
+
humanoid: HumanoidBone | null;
|
|
13
|
+
parent: string | null;
|
|
14
|
+
depth: number;
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [animation/bones.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/bones.ts#L6)
|
|
19
|
+
|
|
20
|
+
A bone of a loaded model, for bone pickers and attachment.
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Type | Description | Defined in |
|
|
25
|
+
| ------ | ------ | ------ | ------ |
|
|
26
|
+
| <a id="name"></a> `name` | `string` | Node name as three.js has it (glTF names are sanitized: `mixamorig:Hips` → `mixamorigHips`). | [animation/bones.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/bones.ts#L8) |
|
|
27
|
+
| <a id="humanoid"></a> `humanoid` | `HumanoidBone` \| `null` | Humanoid name when the rig is a recognisable humanoid, else `null`. | [animation/bones.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/bones.ts#L10) |
|
|
28
|
+
| <a id="parent"></a> `parent` | `string` \| `null` | Parent bone's name, or `null` for a root bone. | [animation/bones.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/bones.ts#L12) |
|
|
29
|
+
| <a id="depth"></a> `depth` | `number` | Depth below the topmost bone (for indenting a tree). | [animation/bones.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/animation/bones.ts#L14) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type ModuleLoader = (scriptUrl) => Promise<Record<string, unknown>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/scriptShared.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/scriptShared.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/scriptShared.ts#L17)
|
|
14
14
|
|
|
15
15
|
Resolves a script URL to its ES module namespace.
|
|
16
16
|
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type MouseButton = "left" | "middle" | "right";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/InputSystem.ts#L9)
|
|
@@ -15,13 +15,13 @@ type NestedRegion = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/nodeKeys.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [prefab/nodeKeys.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L194)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Defined in |
|
|
23
23
|
| ------ | ------ | ------ |
|
|
24
|
-
| <a id="rootentityid"></a> `rootEntityId` | `number` | [prefab/nodeKeys.ts:195](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="url"></a> `url` | `string` | [prefab/nodeKeys.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="instanceid"></a> `instanceId` | `string` | [prefab/nodeKeys.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="overrides"></a> `overrides` | `string`[] | [prefab/nodeKeys.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="rootentityid"></a> `rootEntityId` | `number` | [prefab/nodeKeys.ts:195](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L195) |
|
|
25
|
+
| <a id="url"></a> `url` | `string` | [prefab/nodeKeys.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L196) |
|
|
26
|
+
| <a id="instanceid"></a> `instanceId` | `string` | [prefab/nodeKeys.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L197) |
|
|
27
|
+
| <a id="overrides"></a> `overrides` | `string`[] | [prefab/nodeKeys.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L198) |
|