@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
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ParentId
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ParentId.ts#L11)
|
|
10
10
|
|
|
11
11
|
Records the parent entity id for hierarchical scene graphs. `null` means
|
|
12
12
|
the entity is at the world root. The `ObjectManagementSystem` reconciles
|
|
@@ -24,7 +24,7 @@ scene-graph parenting from this component each frame.
|
|
|
24
24
|
new ParentId(value?): ParentId;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ParentId.ts#L15)
|
|
28
28
|
|
|
29
29
|
#### Parameters
|
|
30
30
|
|
|
@@ -44,4 +44,4 @@ Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/rel
|
|
|
44
44
|
|
|
45
45
|
| Property | Type | Description | Defined in |
|
|
46
46
|
| ------ | ------ | ------ | ------ |
|
|
47
|
-
| <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
+
| <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ParentId.ts#L13) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PhysicsComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Physics.ts:387](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Physics.ts:387](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L387)
|
|
10
10
|
|
|
11
11
|
Marker base class for every ECS component. Subclass `Component` to declare
|
|
12
12
|
a typed data container that systems can query.
|
|
@@ -29,7 +29,7 @@ asset URLs).
|
|
|
29
29
|
new PhysicsComponent(values?): PhysicsComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/Physics.ts:405](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
Defined in: [components/Physics.ts:405](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L405)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -51,10 +51,10 @@ Defined in: [components/Physics.ts:405](https://github.com/Relu-Interactives/rel
|
|
|
51
51
|
|
|
52
52
|
| Property | Type | Description | Defined in |
|
|
53
53
|
| ------ | ------ | ------ | ------ |
|
|
54
|
-
| <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="pendingvelocity"></a> `pendingVelocity?` | `PendingBodyVelocity` \| `null` | Velocity to apply the moment this body becomes dynamic again. Non-enumerable, like the Rapier refs — never serialized. | [components/Physics.ts:395](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. NON-ENUMERABLE — Rapier wrappers (and, for trimesh, their vertex buffers) must never leak into snapshots/history/debug walks. | [components/Physics.ts:401](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. NON-ENUMERABLE. | [components/Physics.ts:403](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
+
| <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L389) |
|
|
55
|
+
| <a id="pendingvelocity"></a> `pendingVelocity?` | `PendingBodyVelocity` \| `null` | Velocity to apply the moment this body becomes dynamic again. Non-enumerable, like the Rapier refs — never serialized. | [components/Physics.ts:395](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L395) |
|
|
56
|
+
| <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. NON-ENUMERABLE — Rapier wrappers (and, for trimesh, their vertex buffers) must never leak into snapshots/history/debug walks. | [components/Physics.ts:401](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L401) |
|
|
57
|
+
| <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. NON-ENUMERABLE. | [components/Physics.ts:403](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L403) |
|
|
58
58
|
|
|
59
59
|
## Methods
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Defined in: [components/Physics.ts:405](https://github.com/Relu-Interactives/rel
|
|
|
64
64
|
setValues(patch): void;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [components/Physics.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
67
|
+
Defined in: [components/Physics.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L416)
|
|
68
68
|
|
|
69
69
|
Patch rigidbody and/or collider state. Each sub-object is deep-merged
|
|
70
70
|
with the current values via the respective normalizer.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Postprocessing
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Postprocessing.ts#L431)
|
|
10
10
|
|
|
11
11
|
Postprocessing stack settings (depth-of-field, bloom, vignette, chromatic
|
|
12
12
|
aberration, noise, pixelation, tone mapping, hue/saturation, sepia, SMAA,
|
|
@@ -30,7 +30,7 @@ style — attached to one entity per scene.
|
|
|
30
30
|
new Postprocessing(values?): Postprocessing;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
+
Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Postprocessing.ts#L435)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -50,4 +50,4 @@ Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interacti
|
|
|
50
50
|
|
|
51
51
|
| Property | Type | Description | Defined in |
|
|
52
52
|
| ------ | ------ | ------ | ------ |
|
|
53
|
-
| <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:433](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
+
| <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:433](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Postprocessing.ts#L433) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PrefabInstance
|
|
8
8
|
|
|
9
|
-
Defined in: [components/PrefabInstance.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/PrefabInstance.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabInstance.ts#L45)
|
|
10
10
|
|
|
11
11
|
Marks the ROOT entity of a prefab instance and records its link to the
|
|
12
12
|
source `.prefab` asset plus the instance's per-property overrides.
|
|
@@ -53,7 +53,7 @@ new PrefabInstance(
|
|
|
53
53
|
instanceId?): PrefabInstance;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [components/PrefabInstance.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
+
Defined in: [components/PrefabInstance.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabInstance.ts#L57)
|
|
57
57
|
|
|
58
58
|
#### Parameters
|
|
59
59
|
|
|
@@ -75,6 +75,6 @@ Defined in: [components/PrefabInstance.ts:57](https://github.com/Relu-Interactiv
|
|
|
75
75
|
|
|
76
76
|
| Property | Type | Description | Defined in |
|
|
77
77
|
| ------ | ------ | ------ | ------ |
|
|
78
|
-
| <a id="url"></a> `url` | `string` | URL of the source `.prefab` asset (`localasset://…` inside the editor). | [components/PrefabInstance.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
79
|
-
| <a id="overrides"></a> `overrides` | `string`[] | Encoded override paths — see class docs for the format. | [components/PrefabInstance.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
80
|
-
| <a id="instanceid"></a> `instanceId` | `string` | Per-placement uuid scoping node identity across nesting. Stable for the lifetime of the placement (persisted; survives applies) so override keys referencing nested content stay valid. | [components/PrefabInstance.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
78
|
+
| <a id="url"></a> `url` | `string` | URL of the source `.prefab` asset (`localasset://…` inside the editor). | [components/PrefabInstance.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabInstance.ts#L47) |
|
|
79
|
+
| <a id="overrides"></a> `overrides` | `string`[] | Encoded override paths — see class docs for the format. | [components/PrefabInstance.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabInstance.ts#L49) |
|
|
80
|
+
| <a id="instanceid"></a> `instanceId` | `string` | Per-placement uuid scoping node identity across nesting. Stable for the lifetime of the placement (persisted; survives applies) so override keys referencing nested content stay valid. | [components/PrefabInstance.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabInstance.ts#L55) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PrefabNode
|
|
8
8
|
|
|
9
|
-
Defined in: [components/PrefabNode.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/PrefabNode.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabNode.ts#L17)
|
|
10
10
|
|
|
11
11
|
Stable identity for an entity that originated from a prefab asset.
|
|
12
12
|
|
|
@@ -31,7 +31,7 @@ prefab intentionally share nodeIds.
|
|
|
31
31
|
new PrefabNode(nodeId): PrefabNode;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [components/PrefabNode.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
+
Defined in: [components/PrefabNode.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabNode.ts#L21)
|
|
35
35
|
|
|
36
36
|
#### Parameters
|
|
37
37
|
|
|
@@ -51,4 +51,4 @@ Defined in: [components/PrefabNode.ts:21](https://github.com/Relu-Interactives/r
|
|
|
51
51
|
|
|
52
52
|
| Property | Type | Description | Defined in |
|
|
53
53
|
| ------ | ------ | ------ | ------ |
|
|
54
|
-
| <a id="nodeid"></a> `nodeId` | `string` | Stable uuid identifying this entity within its prefab definition. | [components/PrefabNode.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
+
| <a id="nodeid"></a> `nodeId` | `string` | Stable uuid identifying this entity within its prefab definition. | [components/PrefabNode.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/PrefabNode.ts#L19) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ScriptComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ScriptComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ScriptComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptComponent.ts#L35)
|
|
10
10
|
|
|
11
11
|
Component holding the list of [scripts](../type-aliases/ScriptEntry.md) attached to an
|
|
12
12
|
entity. Loaded from the saved project; the runtime-side fields
|
|
@@ -29,7 +29,7 @@ Authored scripts subclass [Behaviour](../../Behaviour/index.md).
|
|
|
29
29
|
new ScriptComponent(entries?): ScriptComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/ScriptComponent.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
Defined in: [components/ScriptComponent.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptComponent.ts#L43)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -49,6 +49,6 @@ Defined in: [components/ScriptComponent.ts:43](https://github.com/Relu-Interacti
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
+
| <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptComponent.ts#L37) |
|
|
53
|
+
| <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptComponent.ts#L39) |
|
|
54
|
+
| <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptComponent.ts#L41) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ScriptObjectComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ScriptObjectComponent.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ScriptObjectComponent.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L30)
|
|
10
10
|
|
|
11
11
|
Component for a **script object** — a single [ScriptObject](../../index/classes/ScriptObject.md) whose
|
|
12
12
|
THREE.js visual is built by user code and runs in the editor AND at runtime.
|
|
@@ -26,7 +26,7 @@ undo history.
|
|
|
26
26
|
new ScriptObjectComponent(input?): ScriptObjectComponent;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L40)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -46,10 +46,10 @@ Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Int
|
|
|
46
46
|
|
|
47
47
|
| Property | Type | Description | Defined in |
|
|
48
48
|
| ------ | ------ | ------ | ------ |
|
|
49
|
-
| <a id="scripturl"></a> `scriptUrl` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="classname"></a> `className` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/ScriptObjectComponent.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | - | [components/ScriptObjectComponent.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="runtimestate"></a> `runtimeState` | [`ScriptObjectRuntimeState`](../type-aliases/ScriptObjectRuntimeState.md) | - | [components/ScriptObjectComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | - | [components/ScriptObjectComponent.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="instance"></a> `instance` | `unknown` | Live ScriptObject instance. Non-enumerable — never enters snapshots/history. | [components/ScriptObjectComponent.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L31) |
|
|
50
|
+
| <a id="classname"></a> `className` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L32) |
|
|
51
|
+
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/ScriptObjectComponent.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L33) |
|
|
52
|
+
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | - | [components/ScriptObjectComponent.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L34) |
|
|
53
|
+
| <a id="runtimestate"></a> `runtimeState` | [`ScriptObjectRuntimeState`](../type-aliases/ScriptObjectRuntimeState.md) | - | [components/ScriptObjectComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L35) |
|
|
54
|
+
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | - | [components/ScriptObjectComponent.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L36) |
|
|
55
|
+
| <a id="instance"></a> `instance` | `unknown` | Live ScriptObject instance. Non-enumerable — never enters snapshots/history. | [components/ScriptObjectComponent.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/ScriptObjectComponent.ts#L38) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Selectable
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Selectable.ts#L9)
|
|
10
10
|
|
|
11
11
|
Toggles whether the editor selection system can pick this entity. When
|
|
12
12
|
`enabled` is `false`, the entity is excluded from raycast hit tests.
|
|
@@ -23,7 +23,7 @@ Toggles whether the editor selection system can pick this entity. When
|
|
|
23
23
|
new Selectable(enabled?): Selectable;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
+
Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Selectable.ts#L13)
|
|
27
27
|
|
|
28
28
|
#### Parameters
|
|
29
29
|
|
|
@@ -43,4 +43,4 @@ Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/r
|
|
|
43
43
|
|
|
44
44
|
| Property | Type | Description | Defined in |
|
|
45
45
|
| ------ | ------ | ------ | ------ |
|
|
46
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Selectable.ts#L11) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SelectionTransformState
|
|
8
8
|
|
|
9
|
-
Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/SelectionTransformState.ts#L16)
|
|
10
10
|
|
|
11
11
|
Singleton-style component (attached once to a system entity) that mirrors
|
|
12
12
|
the editor's current transform-gizmo state into the ECS world. Persisted in
|
|
@@ -27,7 +27,7 @@ new SelectionTransformState(
|
|
|
27
27
|
selectedEntityId?): SelectionTransformState;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/SelectionTransformState.ts#L24)
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
@@ -49,6 +49,6 @@ Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-I
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
+
| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/SelectionTransformState.ts#L18) |
|
|
53
|
+
| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/SelectionTransformState.ts#L20) |
|
|
54
|
+
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/SelectionTransformState.ts#L22) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SpriteComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L11)
|
|
10
10
|
|
|
11
11
|
Camera-facing 2D sprite. Unlike [ImageComponent](ImageComponent.md), sprites use
|
|
12
12
|
`THREE.Sprite` and always render as billboards.
|
|
@@ -26,7 +26,7 @@ new SpriteComponent(
|
|
|
26
26
|
height?): SpriteComponent;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L23)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -48,8 +48,8 @@ Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-
|
|
|
48
48
|
|
|
49
49
|
| Property | Type | Description | Defined in |
|
|
50
50
|
| ------ | ------ | ------ | ------ |
|
|
51
|
-
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="texture"></a> `texture` | `Texture`\<`unknown`, `TextureEventMap`\> \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L13) |
|
|
52
|
+
| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L15) |
|
|
53
|
+
| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L17) |
|
|
54
|
+
| <a id="texture"></a> `texture` | `Texture`\<`unknown`, `TextureEventMap`\> \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L19) |
|
|
55
|
+
| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Sprite.ts#L21) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: TransformComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Transform.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Transform.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L50)
|
|
10
10
|
|
|
11
11
|
Position, rotation, and scale of an entity in its parent's local space.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ helpers so dependent systems pick up the change.
|
|
|
29
29
|
new TransformComponent(data?): TransformComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L58)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -49,9 +49,9 @@ Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/re
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="position"></a> `position` | [`Vec3`](../type-aliases/Vec3.md) | Local position relative to the parent (or world if no parent). | [components/Transform.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="rotation"></a> `rotation` | [`Vec3`](../type-aliases/Vec3.md) | Local rotation as Euler XYZ in **radians**. | [components/Transform.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="scale"></a> `scale` | [`Vec3`](../type-aliases/Vec3.md) | Local scale factors per axis (`1` = identity). | [components/Transform.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
+
| <a id="position"></a> `position` | [`Vec3`](../type-aliases/Vec3.md) | Local position relative to the parent (or world if no parent). | [components/Transform.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L52) |
|
|
53
|
+
| <a id="rotation"></a> `rotation` | [`Vec3`](../type-aliases/Vec3.md) | Local rotation as Euler XYZ in **radians**. | [components/Transform.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L54) |
|
|
54
|
+
| <a id="scale"></a> `scale` | [`Vec3`](../type-aliases/Vec3.md) | Local scale factors per axis (`1` = identity). | [components/Transform.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L56) |
|
|
55
55
|
|
|
56
56
|
## Methods
|
|
57
57
|
|
|
@@ -61,7 +61,7 @@ Defined in: [components/Transform.ts:58](https://github.com/Relu-Interactives/re
|
|
|
61
61
|
toPositionVector3(target?): Vector3;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
64
|
+
Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L84)
|
|
65
65
|
|
|
66
66
|
#### Parameters
|
|
67
67
|
|
|
@@ -81,7 +81,7 @@ Defined in: [components/Transform.ts:84](https://github.com/Relu-Interactives/re
|
|
|
81
81
|
toRotationEuler(target?, order?): Euler;
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
84
|
+
Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L88)
|
|
85
85
|
|
|
86
86
|
#### Parameters
|
|
87
87
|
|
|
@@ -102,7 +102,7 @@ Defined in: [components/Transform.ts:88](https://github.com/Relu-Interactives/re
|
|
|
102
102
|
toRotationQuaternion(target?, order?): Quaternion;
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
-
Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
105
|
+
Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L95)
|
|
106
106
|
|
|
107
107
|
#### Parameters
|
|
108
108
|
|
|
@@ -123,7 +123,7 @@ Defined in: [components/Transform.ts:95](https://github.com/Relu-Interactives/re
|
|
|
123
123
|
toScaleVector3(target?): Vector3;
|
|
124
124
|
```
|
|
125
125
|
|
|
126
|
-
Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
126
|
+
Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L108)
|
|
127
127
|
|
|
128
128
|
#### Parameters
|
|
129
129
|
|
|
@@ -143,7 +143,7 @@ Defined in: [components/Transform.ts:108](https://github.com/Relu-Interactives/r
|
|
|
143
143
|
setPosition(input): this;
|
|
144
144
|
```
|
|
145
145
|
|
|
146
|
-
Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
146
|
+
Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L112)
|
|
147
147
|
|
|
148
148
|
#### Parameters
|
|
149
149
|
|
|
@@ -163,7 +163,7 @@ Defined in: [components/Transform.ts:112](https://github.com/Relu-Interactives/r
|
|
|
163
163
|
setScale(input): this;
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
166
|
+
Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L120)
|
|
167
167
|
|
|
168
168
|
#### Parameters
|
|
169
169
|
|
|
@@ -183,7 +183,7 @@ Defined in: [components/Transform.ts:120](https://github.com/Relu-Interactives/r
|
|
|
183
183
|
setRotation(input, order?): this;
|
|
184
184
|
```
|
|
185
185
|
|
|
186
|
-
Defined in: [components/Transform.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
186
|
+
Defined in: [components/Transform.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Transform.ts#L128)
|
|
187
187
|
|
|
188
188
|
#### Parameters
|
|
189
189
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: UIButtonComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/UIButton.ts:
|
|
9
|
+
Defined in: [components/UIButton.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L38)
|
|
10
10
|
|
|
11
11
|
A pressable control.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ one panel script can handle all of its buttons.
|
|
|
29
29
|
new UIButtonComponent(options?): UIButtonComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/UIButton.ts:
|
|
32
|
+
Defined in: [components/UIButton.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L67)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -49,15 +49,19 @@ Defined in: [components/UIButton.ts:49](https://github.com/Relu-Interactives/rel
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="label"></a> `label` | `string` | - | [components/UIButton.ts:
|
|
53
|
-
| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UIButton.ts:
|
|
54
|
-
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIButton.ts:
|
|
55
|
-
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIButton.ts:
|
|
56
|
-
| <a id="fontsize"></a> `fontSize` | `number` | Label glyph height in metres. | [components/UIButton.ts:
|
|
57
|
-
| <a id="fontweight"></a> `fontWeight` | `number` | - | [components/UIButton.ts:
|
|
58
|
-
| <a id="textcolor"></a> `textColor` | `string` | - | [components/UIButton.ts:
|
|
59
|
-
| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIButton.ts:
|
|
60
|
-
| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | - | [components/UIButton.ts:
|
|
61
|
-
| <a id="cornerradius"></a> `cornerRadius` | `number` | - | [components/UIButton.ts:
|
|
62
|
-
| <a id="borderwidth"></a> `borderWidth` | `number` | - | [components/UIButton.ts:
|
|
63
|
-
| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIButton.ts:
|
|
52
|
+
| <a id="label"></a> `label` | `string` | - | [components/UIButton.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L39) |
|
|
53
|
+
| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UIButton.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L41) |
|
|
54
|
+
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIButton.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L43) |
|
|
55
|
+
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIButton.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L45) |
|
|
56
|
+
| <a id="fontsize"></a> `fontSize` | `number` | Label glyph height in metres. | [components/UIButton.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L47) |
|
|
57
|
+
| <a id="fontweight"></a> `fontWeight` | `number` | - | [components/UIButton.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L48) |
|
|
58
|
+
| <a id="textcolor"></a> `textColor` | `string` | - | [components/UIButton.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L49) |
|
|
59
|
+
| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIButton.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L50) |
|
|
60
|
+
| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | - | [components/UIButton.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L51) |
|
|
61
|
+
| <a id="cornerradius"></a> `cornerRadius` | `number` | - | [components/UIButton.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L52) |
|
|
62
|
+
| <a id="borderwidth"></a> `borderWidth` | `number` | - | [components/UIButton.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L53) |
|
|
63
|
+
| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIButton.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L54) |
|
|
64
|
+
| <a id="pixeldensity"></a> `pixelDensity?` | `number` | Texture density in px/metre, clamped 256–2048 at render time. Absent means the default: a defaulted field would count as a change on every instance of a prefab saved before it existed. | [components/UIButton.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L60) |
|
|
65
|
+
| <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | Modern styling; wins over the flat fields above. Absent until authored. | [components/UIButton.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L62) |
|
|
66
|
+
| <a id="icon"></a> `icon?` | `string` | An image or SVG file drawn beside the label, tinted to the text colour. | [components/UIButton.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L64) |
|
|
67
|
+
| <a id="iconposition"></a> `iconPosition?` | [`UiIconPosition`](../type-aliases/UiIconPosition.md) | - | [components/UIButton.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIButton.ts#L65) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: UIPanelComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/UIPanel.ts:
|
|
9
|
+
Defined in: [components/UIPanel.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L41)
|
|
10
10
|
|
|
11
11
|
A flat UI surface in the world — the backdrop menus and HUDs are built on.
|
|
12
12
|
|
|
@@ -31,7 +31,7 @@ parent the panel under an XR Interactor's Left/Right slot entity instead.
|
|
|
31
31
|
new UIPanelComponent(options?): UIPanelComponent;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [components/UIPanel.ts:
|
|
34
|
+
Defined in: [components/UIPanel.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L65)
|
|
35
35
|
|
|
36
36
|
#### Parameters
|
|
37
37
|
|
|
@@ -51,12 +51,14 @@ Defined in: [components/UIPanel.ts:50](https://github.com/Relu-Interactives/relu
|
|
|
51
51
|
|
|
52
52
|
| Property | Type | Description | Defined in |
|
|
53
53
|
| ------ | ------ | ------ | ------ |
|
|
54
|
-
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIPanel.ts:
|
|
55
|
-
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIPanel.ts:
|
|
56
|
-
| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIPanel.ts:
|
|
57
|
-
| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | 0–1. Panels are usually slightly translucent in XR. | [components/UIPanel.ts:
|
|
58
|
-
| <a id="cornerradius"></a> `cornerRadius` | `number` | Corner radius in metres. | [components/UIPanel.ts:
|
|
59
|
-
| <a id="borderwidth"></a> `borderWidth` | `number` | Border thickness in metres; 0 disables the border. | [components/UIPanel.ts:
|
|
60
|
-
| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIPanel.ts:
|
|
61
|
-
| <a id="pixeldensity"></a> `pixelDensity` | `number` | Texture density in px/metre, clamped 256–2048 at render time. | [components/UIPanel.ts:
|
|
62
|
-
| <a id="follow"></a> `follow` | [`UiFollowMode`](../type-aliases/UiFollowMode.md) | - | [components/UIPanel.ts:
|
|
54
|
+
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UIPanel.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L43) |
|
|
55
|
+
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UIPanel.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L45) |
|
|
56
|
+
| <a id="backgroundcolor"></a> `backgroundColor` | `string` | - | [components/UIPanel.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L46) |
|
|
57
|
+
| <a id="backgroundopacity"></a> `backgroundOpacity` | `number` | 0–1. Panels are usually slightly translucent in XR. | [components/UIPanel.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L48) |
|
|
58
|
+
| <a id="cornerradius"></a> `cornerRadius` | `number` | Corner radius in metres. | [components/UIPanel.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L50) |
|
|
59
|
+
| <a id="borderwidth"></a> `borderWidth` | `number` | Border thickness in metres; 0 disables the border. | [components/UIPanel.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L52) |
|
|
60
|
+
| <a id="bordercolor"></a> `borderColor` | `string` | - | [components/UIPanel.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L53) |
|
|
61
|
+
| <a id="pixeldensity"></a> `pixelDensity` | `number` | Texture density in px/metre, clamped 256–2048 at render time. | [components/UIPanel.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L55) |
|
|
62
|
+
| <a id="follow"></a> `follow` | [`UiFollowMode`](../type-aliases/UiFollowMode.md) | - | [components/UIPanel.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L56) |
|
|
63
|
+
| <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | Modern styling; wins over the flat fields above. Absent until authored. | [components/UIPanel.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L58) |
|
|
64
|
+
| <a id="tokens"></a> `tokens?` | [`UiTokens`](../../index/type-aliases/UiTokens.md) | Named values widgets under this panel use as `$name`. The nearest panel wins, so a theme travels with the panel and one edit restyles the menu. | [components/UIPanel.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UIPanel.ts#L63) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: UISliderComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/UISlider.ts:
|
|
9
|
+
Defined in: [components/UISlider.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L35)
|
|
10
10
|
|
|
11
11
|
A draggable value control.
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ redraws the canvas. Scripts hear changes via `Behaviour.onUiChange`
|
|
|
28
28
|
new UISliderComponent(options?): UISliderComponent;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [components/UISlider.ts:
|
|
31
|
+
Defined in: [components/UISlider.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L65)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -48,12 +48,17 @@ Defined in: [components/UISlider.ts:43](https://github.com/Relu-Interactives/rel
|
|
|
48
48
|
|
|
49
49
|
| Property | Type | Description | Defined in |
|
|
50
50
|
| ------ | ------ | ------ | ------ |
|
|
51
|
-
| <a id="value"></a> `value` | `number` | Current value, clamped to [min, max]. | [components/UISlider.ts:
|
|
52
|
-
| <a id="min"></a> `min` | `number` | - | [components/UISlider.ts:
|
|
53
|
-
| <a id="max"></a> `max` | `number` | - | [components/UISlider.ts:
|
|
54
|
-
| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UISlider.ts:
|
|
55
|
-
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UISlider.ts:
|
|
56
|
-
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UISlider.ts:
|
|
57
|
-
| <a id="trackcolor"></a> `trackColor` | `string` | - | [components/UISlider.ts:
|
|
58
|
-
| <a id="accentcolor"></a> `accentColor` | `string` | Fill colour between min and the current value. | [components/UISlider.ts:
|
|
59
|
-
| <a id="knobcolor"></a> `knobColor` | `string` | - | [components/UISlider.ts:
|
|
51
|
+
| <a id="value"></a> `value` | `number` | Current value, clamped to [min, max]. | [components/UISlider.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L37) |
|
|
52
|
+
| <a id="min"></a> `min` | `number` | - | [components/UISlider.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L38) |
|
|
53
|
+
| <a id="max"></a> `max` | `number` | - | [components/UISlider.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L39) |
|
|
54
|
+
| <a id="actionid"></a> `actionId` | `string` | Dispatch identifier; empty string means "use the entity name". | [components/UISlider.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L41) |
|
|
55
|
+
| <a id="width"></a> `width` | `number` | Full width in metres. | [components/UISlider.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L43) |
|
|
56
|
+
| <a id="height"></a> `height` | `number` | Full height in metres. | [components/UISlider.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L45) |
|
|
57
|
+
| <a id="trackcolor"></a> `trackColor` | `string` | - | [components/UISlider.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L46) |
|
|
58
|
+
| <a id="accentcolor"></a> `accentColor` | `string` | Fill colour between min and the current value. | [components/UISlider.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L48) |
|
|
59
|
+
| <a id="knobcolor"></a> `knobColor` | `string` | - | [components/UISlider.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L49) |
|
|
60
|
+
| <a id="pixeldensity"></a> `pixelDensity?` | `number` | Texture density in px/metre, clamped 256–2048 at render time. Absent means the default: a defaulted field would count as a change on every instance of a prefab saved before it existed. | [components/UISlider.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L55) |
|
|
61
|
+
| <a id="style"></a> `style?` | [`UiStyle`](../../index/type-aliases/UiStyle.md) | Modern styling; wins over the flat fields above. Absent until authored. | [components/UISlider.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L57) |
|
|
62
|
+
| <a id="variant"></a> `variant?` | [`UiSliderVariant`](../type-aliases/UiSliderVariant.md) | How the value is drawn. `progress` and `ring` are read-only. | [components/UISlider.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L59) |
|
|
63
|
+
| <a id="step"></a> `step?` | `number` | Snap to multiples of this, measured from `min`. | [components/UISlider.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L61) |
|
|
64
|
+
| <a id="readonly"></a> `readOnly?` | `boolean` | Shows the value but takes no input. | [components/UISlider.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/UISlider.ts#L63) |
|