@relu-interactives/spatial-ecs 0.5.2 → 0.8.0
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-V_mv07le.d.cts → System-8D-XBDKZ.d.cts} +734 -8
- package/dist/{System-V_mv07le.d.ts → System-DPMAW30g.d.ts} +734 -8
- package/dist/{XRHandPose-CU3vNFuS.d.ts → XRHandPose-G0Dl-F0w.d.ts} +93 -3
- package/dist/{XRHandPose-CQTLGxFC.d.cts → XRHandPose-VQMT1WXj.d.cts} +93 -3
- package/dist/animation/index.cjs +252 -0
- package/dist/animation/index.cjs.map +1 -0
- package/dist/animation/index.d.cts +100 -0
- package/dist/animation/index.d.ts +100 -0
- package/dist/animation/index.js +4 -0
- package/dist/animation/index.js.map +1 -0
- package/dist/chunk-CKTHDXPS.js +11 -0
- package/dist/chunk-CKTHDXPS.js.map +1 -0
- package/dist/chunk-G4XJ53LS.js +1237 -0
- package/dist/chunk-G4XJ53LS.js.map +1 -0
- package/dist/chunk-GSWC6LLD.js +241 -0
- package/dist/chunk-GSWC6LLD.js.map +1 -0
- package/dist/{chunk-DF5SSRN6.js → chunk-JIJQFW6P.js} +1216 -2920
- package/dist/chunk-JIJQFW6P.js.map +1 -0
- package/dist/{chunk-BUEKOSR5.js → chunk-NNDUOQ7O.js} +188 -14
- package/dist/chunk-NNDUOQ7O.js.map +1 -0
- package/dist/chunk-OHCNPPMX.js +334 -0
- package/dist/chunk-OHCNPPMX.js.map +1 -0
- package/dist/{chunk-RXBLOO5B.js → chunk-SGF73YTF.js} +105 -715
- package/dist/chunk-SGF73YTF.js.map +1 -0
- package/dist/chunk-U727NTWQ.js +2856 -0
- package/dist/chunk-U727NTWQ.js.map +1 -0
- package/dist/{chunk-OY7ZODZP.js → chunk-XE4OXN2W.js} +3 -9
- package/dist/chunk-XE4OXN2W.js.map +1 -0
- package/dist/{chunk-OWQSESTO.js → chunk-XU2DVWCP.js} +4 -3
- package/dist/chunk-XU2DVWCP.js.map +1 -0
- package/dist/components/index.cjs +183 -10
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +5 -3
- package/dist/components/index.d.ts +5 -3
- package/dist/components/index.js +3 -2
- package/dist/docs/api/Behaviour/classes/Behaviour.md +366 -79
- package/dist/docs/api/Behaviour/index.md +7 -3
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +35 -0
- package/dist/docs/api/Component/classes/Component.md +14 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +19 -19
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +4 -4
- package/dist/docs/api/components/classes/Environment.md +5 -4
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +8 -8
- 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 +16 -16
- 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 +8 -5
- package/dist/docs/api/components/classes/Name.md +3 -3
- 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 -6
- 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 +63 -0
- package/dist/docs/api/components/classes/UIPanelComponent.md +62 -0
- package/dist/docs/api/components/classes/UISliderComponent.md +59 -0
- package/dist/docs/api/components/classes/UITextComponent.md +59 -0
- package/dist/docs/api/components/classes/UIToggleComponent.md +56 -0
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +53 -0
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +64 -0
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +64 -0
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +50 -0
- package/dist/docs/api/components/classes/XRInteractableComponent.md +74 -0
- package/dist/docs/api/components/classes/XRInteractorComponent.md +57 -0
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +50 -0
- package/dist/docs/api/components/classes/XRRigComponent.md +68 -0
- package/dist/docs/api/components/functions/createAttachPoint.md +25 -0
- package/dist/docs/api/components/functions/createHandPoseEntry.md +25 -0
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +33 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +30 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +33 -0
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +3 -9
- package/dist/docs/api/components/index.md +61 -4
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- 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 +5 -3
- 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 +40 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +22 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +9 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +7 -5
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +16 -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 +37 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +13 -11
- 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 +15 -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 +45 -0
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UITextOptions.md +41 -0
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +15 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +29 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +15 -0
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +75 -0
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +37 -0
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +51 -0
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +53 -0
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +19 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +25 -0
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +19 -0
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +20 -0
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +20 -0
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +49 -0
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +19 -0
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +15 -0
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +13 -0
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +15 -0
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +24 -0
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +15 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +15 -0
- 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 +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +13 -0
- 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 +15 -0
- 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/AudioSystem.md +4 -4
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +19 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +114 -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 +14 -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 +34 -10
- package/dist/docs/api/index/classes/RenderSystem.md +13 -4
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +9 -5
- 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/TeleportAimGate.md +114 -0
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +89 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +60 -0
- package/dist/docs/api/index/classes/UIPanelSystem.md +79 -0
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +8 -6
- package/dist/docs/api/index/classes/World.md +282 -100
- package/dist/docs/api/index/classes/XRAnchorSystem.md +90 -0
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +77 -0
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +137 -0
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +107 -0
- package/dist/docs/api/index/classes/XRHitTestSystem.md +93 -0
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +76 -0
- package/dist/docs/api/index/classes/XRInputSystem.md +189 -0
- package/dist/docs/api/index/classes/XRInteractionSystem.md +323 -0
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +128 -0
- package/dist/docs/api/index/classes/XRSessionSystem.md +116 -0
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +75 -0
- package/dist/docs/api/index/functions/angularVelocityFrom.md +33 -0
- package/dist/docs/api/index/functions/applyHandMaterial.md +26 -0
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +30 -0
- 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 +23 -0
- 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 +29 -0
- package/dist/docs/api/index/functions/computeHandShape.md +29 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +30 -0
- package/dist/docs/api/index/functions/computePalmWidth.md +25 -0
- package/dist/docs/api/index/functions/computePinch.md +29 -0
- package/dist/docs/api/index/functions/computeSpread.md +33 -0
- 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/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createHandMaterial.md +30 -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 +2 -2
- 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 +2 -2
- package/dist/docs/api/index/functions/createMaterialComponent.md +2 -2
- 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/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 +28 -0
- package/dist/docs/api/index/functions/createUIPanelComponent.md +28 -0
- package/dist/docs/api/index/functions/createUISliderComponent.md +28 -0
- package/dist/docs/api/index/functions/createUITextComponent.md +28 -0
- package/dist/docs/api/index/functions/createUIToggleComponent.md +28 -0
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRRigComponent.md +28 -0
- 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 +28 -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 +31 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +42 -0
- 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/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +34 -0
- 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 +30 -0
- 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 +40 -0
- 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/spawnPrefab.md +1 -1
- package/dist/docs/api/index/index.md +116 -4
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +20 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +21 -0
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +84 -0
- package/dist/docs/api/index/interfaces/RenderBackend.md +168 -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/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -26
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +14 -2
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +17 -0
- 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 +32 -0
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +27 -0
- 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/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/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- 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 +15 -0
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +23 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +39 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +25 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +28 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +31 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +15 -0
- 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 +3 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +46 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +23 -0
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +41 -0
- package/dist/docs/api/index/type-aliases/XrFinger.md +13 -0
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +27 -0
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +31 -0
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +40 -0
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +18 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +23 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +47 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +21 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +13 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +27 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandShape.md +46 -0
- package/dist/docs/api/index/type-aliases/XrHandedness.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHitResult.md +25 -0
- package/dist/docs/api/index/type-aliases/XrInputKind.md +19 -0
- package/dist/docs/api/index/type-aliases/XrInputState.md +60 -0
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +31 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +2 -2
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +15 -0
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +15 -0
- package/dist/docs/api/index/variables/ARC_SPEED.md +15 -0
- package/dist/docs/api/index/variables/ARC_STEPS.md +15 -0
- package/dist/docs/api/index/variables/CURLED_COS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +15 -0
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +17 -0
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +15 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +19 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +15 -0
- 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 +15 -0
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +25 -0
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +18 -0
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +15 -0
- 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 +15 -0
- 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 +19 -0
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +15 -0
- package/dist/docs/api/index/variables/XR_FINGERS.md +13 -0
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +15 -0
- package/dist/docs/api/index/variables/webglBackend.md +16 -0
- 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 +10 -2
- 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/audio-mixing-and-sound-banks.md +71 -0
- package/dist/docs/guide/authoring-a-behaviour.md +3 -3
- package/dist/docs/guide/authoring-a-script-object.md +12 -9
- package/dist/docs/guide/behaviour-data-binding/index.md +11 -11
- package/dist/docs/guide/behaviour-lifecycle.md +9 -0
- package/dist/docs/guide/bone-attachments-and-ik.md +128 -0
- package/dist/docs/guide/component-catalog.md +10 -2
- package/dist/docs/guide/components/light.md +42 -0
- package/dist/docs/guide/components/model.md +32 -3
- package/dist/docs/guide/concepts.md +2 -2
- package/dist/docs/guide/getting-started/creating-objects.md +2 -2
- package/dist/docs/guide/getting-started/editing-objects.md +2 -2
- package/dist/docs/guide/getting-started/editor/ai-agent.md +227 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +2 -2
- package/dist/docs/guide/getting-started/editor/index.md +3 -2
- package/dist/docs/guide/getting-started/editor/inspector.md +2 -2
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +3 -3
- package/dist/docs/guide/getting-started/editor/toolbar.md +11 -11
- package/dist/docs/guide/getting-started/editor/viewport.md +17 -9
- package/dist/docs/guide/getting-started/index.md +1 -1
- package/dist/docs/guide/getting-started/installation.md +1 -1
- package/dist/docs/guide/getting-started/preview-and-test.md +7 -7
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +23 -11
- package/dist/docs/guide/getting-started/project-types/index.md +4 -4
- package/dist/docs/guide/getting-started/project-types/vr.md +270 -2
- package/dist/docs/guide/getting-started/projects.md +4 -5
- package/dist/docs/guide/getting-started/shortcuts.md +5 -4
- package/dist/docs/guide/multiplayer.md +92 -0
- package/dist/docs/guide/scene/environment.md +101 -4
- package/dist/docs/guide/scene/index.md +4 -4
- package/dist/docs/guide/scene/postprocessing.md +67 -5
- package/dist/docs/guide/spawning/area-light.md +2 -0
- package/dist/docs/guide/systems/environment-sync-system.md +11 -6
- package/dist/docs/guide/systems/light-sync-system.md +5 -3
- package/dist/docs/guide/systems/postprocessing-sync-system.md +16 -6
- package/dist/docs/guide/systems/render-system.md +7 -6
- package/dist/docs/guide/systems/script-behaviour-system.md +7 -5
- package/dist/docs/guide/systems/script-object-system.md +3 -1
- package/dist/docs/guide/systems/video-system.md +1 -1
- package/dist/docs/guide/webgpu-and-tsl.md +415 -0
- package/dist/docs/guide/world-api.md +52 -2
- package/dist/factories/index.cjs +770 -283
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +14 -3
- package/dist/factories/index.d.ts +14 -3
- package/dist/factories/index.js +7 -4
- package/dist/{index-D2Jt_JzH.d.ts → index-C61n65PE.d.ts} +135 -42
- package/dist/{index-DaG03vyN.d.cts → index-C70N4BYG.d.cts} +135 -42
- package/dist/{index-C3ik3sA1.d.ts → index-D9DjrUn3.d.cts} +25 -3
- package/dist/{index-Dlr-7-4m.d.cts → index-DppafVu4.d.ts} +25 -3
- package/dist/index.cjs +3642 -1263
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +113 -11
- package/dist/index.d.ts +113 -11
- package/dist/index.js +187 -12
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +4896 -0
- package/dist/network/index.cjs.map +1 -0
- package/dist/network/index.d.cts +98 -0
- package/dist/network/index.d.ts +98 -0
- package/dist/network/index.js +493 -0
- package/dist/network/index.js.map +1 -0
- package/dist/systems/index.cjs +3958 -1762
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +4 -2
- package/dist/systems/index.d.ts +4 -2
- package/dist/systems/index.js +8 -4
- package/dist/types.d.cts +3 -1
- package/dist/types.d.ts +3 -1
- package/dist/webgpu/index.d.ts +113 -0
- package/dist/webgpu/index.js +302 -0
- package/dist/webgpu/index.js.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -1
- package/dist/worldSnapshotUtils.d.ts +3 -1
- package/dist/worldSnapshotUtils.js +3 -2
- package/package.json +19 -3
- package/dist/chunk-BUEKOSR5.js.map +0 -1
- package/dist/chunk-DF5SSRN6.js.map +0 -1
- package/dist/chunk-OWQSESTO.js.map +0 -1
- package/dist/chunk-OY7ZODZP.js.map +0 -1
- package/dist/chunk-RXBLOO5B.js.map +0 -1
- package/dist/chunk-WJD2VKEH.js +0 -315
- package/dist/chunk-WJD2VKEH.js.map +0 -1
|
@@ -93,7 +93,7 @@ type PostprocessingState = {
|
|
|
93
93
|
};
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
96
|
+
Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L4)
|
|
97
97
|
|
|
98
98
|
Aggregated post-processing effect chain authored on the scene environment. Each sub-effect has its own `enabled` flag plus per-effect parameters.
|
|
99
99
|
|
|
@@ -101,64 +101,64 @@ Aggregated post-processing effect chain authored on the scene environment. Each
|
|
|
101
101
|
|
|
102
102
|
| Property | Type | Description | Defined in |
|
|
103
103
|
| ------ | ------ | ------ | ------ |
|
|
104
|
-
| <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
105
|
-
| <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
106
|
-
| `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
107
|
-
| `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
108
|
-
| `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
109
|
-
| `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
110
|
-
| <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
111
|
-
| `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
112
|
-
| `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
113
|
-
| `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
114
|
-
| `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
115
|
-
| <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
116
|
-
| `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
117
|
-
| `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
118
|
-
| `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
119
|
-
| <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
120
|
-
| `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
121
|
-
| `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
122
|
-
| `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
123
|
-
| <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
124
|
-
| `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
125
|
-
| `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
126
|
-
| <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
127
|
-
| `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
128
|
-
| `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
129
|
-
| <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
130
|
-
| `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
131
|
-
| `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
132
|
-
| <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
133
|
-
| `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
134
|
-
| `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
135
|
-
| `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
136
|
-
| <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
137
|
-
| `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
138
|
-
| `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
139
|
-
| <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
140
|
-
| `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
141
|
-
| <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
142
|
-
| `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
143
|
-
| `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
144
|
-
| `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
145
|
-
| <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
146
|
-
| `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
147
|
-
| `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
148
|
-
| `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
149
|
-
| `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
150
|
-
| `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
151
|
-
| `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
152
|
-
| `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
153
|
-
| <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
154
|
-
| `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
155
|
-
| `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
156
|
-
| `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
157
|
-
| `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
158
|
-
| `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
159
|
-
| `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
160
|
-
| `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
161
|
-
| `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
162
|
-
| `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
163
|
-
| `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
164
|
-
| `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
104
|
+
| <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L6) |
|
|
105
|
+
| <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L8) |
|
|
106
|
+
| `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L10) |
|
|
107
|
+
| `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L12) |
|
|
108
|
+
| `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L14) |
|
|
109
|
+
| `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L16) |
|
|
110
|
+
| <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L19) |
|
|
111
|
+
| `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L21) |
|
|
112
|
+
| `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L23) |
|
|
113
|
+
| `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L25) |
|
|
114
|
+
| `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L27) |
|
|
115
|
+
| <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L30) |
|
|
116
|
+
| `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L32) |
|
|
117
|
+
| `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L34) |
|
|
118
|
+
| `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L36) |
|
|
119
|
+
| <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L39) |
|
|
120
|
+
| `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L41) |
|
|
121
|
+
| `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L43) |
|
|
122
|
+
| `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L45) |
|
|
123
|
+
| <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L48) |
|
|
124
|
+
| `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L50) |
|
|
125
|
+
| `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L52) |
|
|
126
|
+
| <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L55) |
|
|
127
|
+
| `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L57) |
|
|
128
|
+
| `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L59) |
|
|
129
|
+
| <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L62) |
|
|
130
|
+
| `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L64) |
|
|
131
|
+
| `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L66) |
|
|
132
|
+
| <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L69) |
|
|
133
|
+
| `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L71) |
|
|
134
|
+
| `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L73) |
|
|
135
|
+
| `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L75) |
|
|
136
|
+
| <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L78) |
|
|
137
|
+
| `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L80) |
|
|
138
|
+
| `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L82) |
|
|
139
|
+
| <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L85) |
|
|
140
|
+
| `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L87) |
|
|
141
|
+
| <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L90) |
|
|
142
|
+
| `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L92) |
|
|
143
|
+
| `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L94) |
|
|
144
|
+
| `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L96) |
|
|
145
|
+
| <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L99) |
|
|
146
|
+
| `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L101) |
|
|
147
|
+
| `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L103) |
|
|
148
|
+
| `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L105) |
|
|
149
|
+
| `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L107) |
|
|
150
|
+
| `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L109) |
|
|
151
|
+
| `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L111) |
|
|
152
|
+
| `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L113) |
|
|
153
|
+
| <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L116) |
|
|
154
|
+
| `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L118) |
|
|
155
|
+
| `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L120) |
|
|
156
|
+
| `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L122) |
|
|
157
|
+
| `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L124) |
|
|
158
|
+
| `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L126) |
|
|
159
|
+
| `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L128) |
|
|
160
|
+
| `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L130) |
|
|
161
|
+
| `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L132) |
|
|
162
|
+
| `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L134) |
|
|
163
|
+
| `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L136) |
|
|
164
|
+
| `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L138) |
|
|
@@ -13,7 +13,7 @@ type RadiusHeightMeshParameters = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L39)
|
|
17
17
|
|
|
18
18
|
Radius + height primitive parameters (capsule, cylinder).
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Radius + height primitive parameters (capsule, cylinder).
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L41) |
|
|
25
|
+
| <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L43) |
|
|
@@ -12,7 +12,7 @@ type RadiusMeshParameters = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [components/MeshGeometry.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
Defined in: [components/MeshGeometry.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L33)
|
|
16
16
|
|
|
17
17
|
Radius-only primitive parameters (sphere).
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Radius-only primitive parameters (sphere).
|
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="radius"></a> `radius` | `number` | Sphere radius in world units. | [components/MeshGeometry.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="radius"></a> `radius` | `number` | Sphere radius in world units. | [components/MeshGeometry.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L35) |
|
|
@@ -27,7 +27,7 @@ type RigidbodyState = {
|
|
|
27
27
|
};
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [components/Physics.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
Defined in: [components/Physics.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L24)
|
|
31
31
|
|
|
32
32
|
Authoring state for the rigidbody half of [PhysicsComponent](../classes/PhysicsComponent.md). Saved with the project.
|
|
33
33
|
|
|
@@ -35,19 +35,19 @@ Authoring state for the rigidbody half of [PhysicsComponent](../classes/PhysicsC
|
|
|
35
35
|
|
|
36
36
|
| Property | Type | Description | Defined in |
|
|
37
37
|
| ------ | ------ | ------ | ------ |
|
|
38
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the body is removed from physics simulation but kept in state. | [components/Physics.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="type"></a> `type` | [`RigidbodyType`](RigidbodyType.md) | Body type. See [RigidbodyType](RigidbodyType.md). | [components/Physics.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="mass"></a> `mass` | `number` | Mass in kilograms. Only meaningful for `dynamic` bodies. | [components/Physics.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="lineardamping"></a> `linearDamping` | `number` | Damping applied to linear velocity each step (`0` = none). | [components/Physics.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| <a id="angulardamping"></a> `angularDamping` | `number` | Damping applied to angular velocity each step (`0` = none). | [components/Physics.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="gravityscale"></a> `gravityScale` | `number` | Scale factor applied to world gravity for this body (`1` = full gravity, `0` = floating). | [components/Physics.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="cansleep"></a> `canSleep` | `boolean` | Allow the body to sleep when at rest to save simulation cost. | [components/Physics.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="ccdenabled"></a> `ccdEnabled` | `boolean` | Enable continuous collision detection to prevent tunneling for fast bodies. | [components/Physics.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="locktranslations"></a> `lockTranslations` | `boolean` | Master toggle: when `true`, all linear motion is locked. | [components/Physics.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="locktranslationx"></a> `lockTranslationX` | `boolean` | Lock translation along world X. | [components/Physics.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="locktranslationy"></a> `lockTranslationY` | `boolean` | Lock translation along world Y. | [components/Physics.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="locktranslationz"></a> `lockTranslationZ` | `boolean` | Lock translation along world Z. | [components/Physics.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="lockrotations"></a> `lockRotations` | `boolean` | Master toggle: when `true`, all rotation is locked. | [components/Physics.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="lockrotationx"></a> `lockRotationX` | `boolean` | Lock rotation around world X. | [components/Physics.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="lockrotationy"></a> `lockRotationY` | `boolean` | Lock rotation around world Y. | [components/Physics.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="lockrotationz"></a> `lockRotationZ` | `boolean` | Lock rotation around world Z. | [components/Physics.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the body is removed from physics simulation but kept in state. | [components/Physics.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L26) |
|
|
39
|
+
| <a id="type"></a> `type` | [`RigidbodyType`](RigidbodyType.md) | Body type. See [RigidbodyType](RigidbodyType.md). | [components/Physics.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L28) |
|
|
40
|
+
| <a id="mass"></a> `mass` | `number` | Mass in kilograms. Only meaningful for `dynamic` bodies. | [components/Physics.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L30) |
|
|
41
|
+
| <a id="lineardamping"></a> `linearDamping` | `number` | Damping applied to linear velocity each step (`0` = none). | [components/Physics.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L32) |
|
|
42
|
+
| <a id="angulardamping"></a> `angularDamping` | `number` | Damping applied to angular velocity each step (`0` = none). | [components/Physics.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L34) |
|
|
43
|
+
| <a id="gravityscale"></a> `gravityScale` | `number` | Scale factor applied to world gravity for this body (`1` = full gravity, `0` = floating). | [components/Physics.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L36) |
|
|
44
|
+
| <a id="cansleep"></a> `canSleep` | `boolean` | Allow the body to sleep when at rest to save simulation cost. | [components/Physics.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L38) |
|
|
45
|
+
| <a id="ccdenabled"></a> `ccdEnabled` | `boolean` | Enable continuous collision detection to prevent tunneling for fast bodies. | [components/Physics.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L40) |
|
|
46
|
+
| <a id="locktranslations"></a> `lockTranslations` | `boolean` | Master toggle: when `true`, all linear motion is locked. | [components/Physics.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L42) |
|
|
47
|
+
| <a id="locktranslationx"></a> `lockTranslationX` | `boolean` | Lock translation along world X. | [components/Physics.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L44) |
|
|
48
|
+
| <a id="locktranslationy"></a> `lockTranslationY` | `boolean` | Lock translation along world Y. | [components/Physics.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L46) |
|
|
49
|
+
| <a id="locktranslationz"></a> `lockTranslationZ` | `boolean` | Lock translation along world Z. | [components/Physics.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L48) |
|
|
50
|
+
| <a id="lockrotations"></a> `lockRotations` | `boolean` | Master toggle: when `true`, all rotation is locked. | [components/Physics.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L50) |
|
|
51
|
+
| <a id="lockrotationx"></a> `lockRotationX` | `boolean` | Lock rotation around world X. | [components/Physics.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L52) |
|
|
52
|
+
| <a id="lockrotationy"></a> `lockRotationY` | `boolean` | Lock rotation around world Y. | [components/Physics.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L54) |
|
|
53
|
+
| <a id="lockrotationz"></a> `lockRotationZ` | `boolean` | Lock rotation around world Z. | [components/Physics.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L56) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type RigidbodyType = "dynamic" | "fixed" | "kinematicPosition" | "kinematicVelocity";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L17)
|
|
14
14
|
|
|
15
15
|
Rigidbody body type:
|
|
16
16
|
- `dynamic`: simulated by physics; affected by forces and gravity.
|
|
@@ -18,7 +18,7 @@ type ScriptEntry = {
|
|
|
18
18
|
};
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [components/ScriptComponent.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [components/ScriptComponent.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L7)
|
|
22
22
|
|
|
23
23
|
One script attached to an entity. Multiple entries may target a single
|
|
24
24
|
entity (different classes from the same or different files).
|
|
@@ -27,10 +27,10 @@ entity (different classes from the same or different files).
|
|
|
27
27
|
|
|
28
28
|
| Property | Type | Description | Defined in |
|
|
29
29
|
| ------ | ------ | ------ | ------ |
|
|
30
|
-
| <a id="entityid"></a> `entityId` | `number` | Owning entity id. | [components/ScriptComponent.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="classname"></a> `className` | `string` | Class name exported by the script module (default export class name). | [components/ScriptComponent.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="scripturl"></a> `scriptUrl` | `string` | Compiled script URL (e.g. `localasset://.../scripts/foo.js`). | [components/ScriptComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the script is skipped each frame. | [components/ScriptComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
-
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | Inspector-bound payload exposed to the script as `this.data`. | [components/ScriptComponent.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
-
| <a id="runtimestate"></a> `runtimeState?` | `"idle"` \| `"loading"` \| `"ready"` \| `"error"` | Last load/runtime status reported by `ScriptBehaviourSystem`. | [components/ScriptComponent.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
36
|
-
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | Optional human-readable status message (e.g. compile/load error). | [components/ScriptComponent.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
| <a id="entityid"></a> `entityId` | `number` | Owning entity id. | [components/ScriptComponent.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L9) |
|
|
31
|
+
| <a id="classname"></a> `className` | `string` | Class name exported by the script module (default export class name). | [components/ScriptComponent.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L11) |
|
|
32
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` | Compiled script URL (e.g. `localasset://.../scripts/foo.js`). | [components/ScriptComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L13) |
|
|
33
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the script is skipped each frame. | [components/ScriptComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L15) |
|
|
34
|
+
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | Inspector-bound payload exposed to the script as `this.data`. | [components/ScriptComponent.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L17) |
|
|
35
|
+
| <a id="runtimestate"></a> `runtimeState?` | `"idle"` \| `"loading"` \| `"ready"` \| `"error"` | Last load/runtime status reported by `ScriptBehaviourSystem`. | [components/ScriptComponent.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L19) |
|
|
36
|
+
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | Optional human-readable status message (e.g. compile/load error). | [components/ScriptComponent.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptComponent.ts#L21) |
|
|
@@ -17,4 +17,4 @@ type ScriptObjectComponentInput = Partial<{
|
|
|
17
17
|
}>;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [components/ScriptObjectComponent.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
20
|
+
Defined in: [components/ScriptObjectComponent.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L6)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type ScriptObjectRuntimeState = "idle" | "loading" | "ready" | "error";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/ScriptObjectComponent.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/ScriptObjectComponent.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ScriptObjectComponent.ts#L4)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TextureFilteringValue = "smooth" | "sharp";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Material.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Material.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Material.ts#L8)
|
|
14
14
|
|
|
15
15
|
Texture sampling mode. `smooth` uses linear filtering; `sharp` uses nearest filtering for pixel-art look.
|
|
@@ -14,7 +14,7 @@ type TransformData = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [components/Transform.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [components/Transform.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L20)
|
|
18
18
|
|
|
19
19
|
Optional initial values passed to [TransformComponent](../classes/TransformComponent.md). Missing axes default to `0` for position/rotation and `1` for scale.
|
|
20
20
|
|
|
@@ -22,6 +22,6 @@ Optional initial values passed to [TransformComponent](../classes/TransformCompo
|
|
|
22
22
|
|
|
23
23
|
| Property | Type | Description | Defined in |
|
|
24
24
|
| ------ | ------ | ------ | ------ |
|
|
25
|
-
| <a id="position"></a> `position?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial position (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="rotation"></a> `rotation?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial rotation in **radians** (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="scale"></a> `scale?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial scale (defaults to `{ 1, 1, 1 }`). | [components/Transform.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
| <a id="position"></a> `position?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial position (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L22) |
|
|
26
|
+
| <a id="rotation"></a> `rotation?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial rotation in **radians** (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L24) |
|
|
27
|
+
| <a id="scale"></a> `scale?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial scale (defaults to `{ 1, 1, 1 }`). | [components/Transform.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L26) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TransformModeValue = "translate" | "rotate" | "scale";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/SelectionTransformState.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L5)
|
|
14
14
|
|
|
15
15
|
Active gizmo mode in the editor.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TransformSpaceValue = "world" | "local";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/SelectionTransformState.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/SelectionTransformState.ts#L7)
|
|
14
14
|
|
|
15
15
|
Reference frame for the active gizmo.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIButtonOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: UIButtonOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UIButtonOptions = {
|
|
11
|
+
label?: string;
|
|
12
|
+
actionId?: string;
|
|
13
|
+
width?: number;
|
|
14
|
+
height?: number;
|
|
15
|
+
fontSize?: number;
|
|
16
|
+
fontWeight?: number;
|
|
17
|
+
textColor?: string;
|
|
18
|
+
backgroundColor?: string;
|
|
19
|
+
backgroundOpacity?: number;
|
|
20
|
+
cornerRadius?: number;
|
|
21
|
+
borderWidth?: number;
|
|
22
|
+
borderColor?: string;
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: [components/UIButton.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L4)
|
|
27
|
+
|
|
28
|
+
Optional initializer for [UIButtonComponent](../classes/UIButtonComponent.md).
|
|
29
|
+
|
|
30
|
+
## Properties
|
|
31
|
+
|
|
32
|
+
| Property | Type | Defined in |
|
|
33
|
+
| ------ | ------ | ------ |
|
|
34
|
+
| <a id="label"></a> `label?` | `string` | [components/UIButton.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L5) |
|
|
35
|
+
| <a id="actionid"></a> `actionId?` | `string` | [components/UIButton.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L6) |
|
|
36
|
+
| <a id="width"></a> `width?` | `number` | [components/UIButton.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L7) |
|
|
37
|
+
| <a id="height"></a> `height?` | `number` | [components/UIButton.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L8) |
|
|
38
|
+
| <a id="fontsize"></a> `fontSize?` | `number` | [components/UIButton.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L9) |
|
|
39
|
+
| <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIButton.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L10) |
|
|
40
|
+
| <a id="textcolor"></a> `textColor?` | `string` | [components/UIButton.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L11) |
|
|
41
|
+
| <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIButton.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L12) |
|
|
42
|
+
| <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIButton.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L13) |
|
|
43
|
+
| <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIButton.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L14) |
|
|
44
|
+
| <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIButton.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L15) |
|
|
45
|
+
| <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIButton.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIButton.ts#L16) |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIPanelOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: UIPanelOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UIPanelOptions = {
|
|
11
|
+
width?: number;
|
|
12
|
+
height?: number;
|
|
13
|
+
backgroundColor?: string;
|
|
14
|
+
backgroundOpacity?: number;
|
|
15
|
+
cornerRadius?: number;
|
|
16
|
+
borderWidth?: number;
|
|
17
|
+
borderColor?: string;
|
|
18
|
+
pixelDensity?: number;
|
|
19
|
+
follow?: UiFollowMode;
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [components/UIPanel.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L7)
|
|
24
|
+
|
|
25
|
+
Optional initializer for [UIPanelComponent](../classes/UIPanelComponent.md).
|
|
26
|
+
|
|
27
|
+
## Properties
|
|
28
|
+
|
|
29
|
+
| Property | Type | Defined in |
|
|
30
|
+
| ------ | ------ | ------ |
|
|
31
|
+
| <a id="width"></a> `width?` | `number` | [components/UIPanel.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L8) |
|
|
32
|
+
| <a id="height"></a> `height?` | `number` | [components/UIPanel.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L9) |
|
|
33
|
+
| <a id="backgroundcolor"></a> `backgroundColor?` | `string` | [components/UIPanel.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L10) |
|
|
34
|
+
| <a id="backgroundopacity"></a> `backgroundOpacity?` | `number` | [components/UIPanel.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L11) |
|
|
35
|
+
| <a id="cornerradius"></a> `cornerRadius?` | `number` | [components/UIPanel.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L12) |
|
|
36
|
+
| <a id="borderwidth"></a> `borderWidth?` | `number` | [components/UIPanel.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L13) |
|
|
37
|
+
| <a id="bordercolor"></a> `borderColor?` | `string` | [components/UIPanel.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L14) |
|
|
38
|
+
| <a id="pixeldensity"></a> `pixelDensity?` | `number` | [components/UIPanel.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L15) |
|
|
39
|
+
| <a id="follow"></a> `follow?` | [`UiFollowMode`](UiFollowMode.md) | [components/UIPanel.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L16) |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UISliderOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: UISliderOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UISliderOptions = {
|
|
11
|
+
value?: number;
|
|
12
|
+
min?: number;
|
|
13
|
+
max?: number;
|
|
14
|
+
actionId?: string;
|
|
15
|
+
width?: number;
|
|
16
|
+
height?: number;
|
|
17
|
+
trackColor?: string;
|
|
18
|
+
accentColor?: string;
|
|
19
|
+
knobColor?: string;
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [components/UISlider.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L4)
|
|
24
|
+
|
|
25
|
+
Optional initializer for [UISliderComponent](../classes/UISliderComponent.md).
|
|
26
|
+
|
|
27
|
+
## Properties
|
|
28
|
+
|
|
29
|
+
| Property | Type | Defined in |
|
|
30
|
+
| ------ | ------ | ------ |
|
|
31
|
+
| <a id="value"></a> `value?` | `number` | [components/UISlider.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L5) |
|
|
32
|
+
| <a id="min"></a> `min?` | `number` | [components/UISlider.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L6) |
|
|
33
|
+
| <a id="max"></a> `max?` | `number` | [components/UISlider.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L7) |
|
|
34
|
+
| <a id="actionid"></a> `actionId?` | `string` | [components/UISlider.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L8) |
|
|
35
|
+
| <a id="width"></a> `width?` | `number` | [components/UISlider.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L9) |
|
|
36
|
+
| <a id="height"></a> `height?` | `number` | [components/UISlider.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L10) |
|
|
37
|
+
| <a id="trackcolor"></a> `trackColor?` | `string` | [components/UISlider.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L11) |
|
|
38
|
+
| <a id="accentcolor"></a> `accentColor?` | `string` | [components/UISlider.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L12) |
|
|
39
|
+
| <a id="knobcolor"></a> `knobColor?` | `string` | [components/UISlider.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UISlider.ts#L13) |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UITextOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: UITextOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UITextOptions = {
|
|
11
|
+
text?: string;
|
|
12
|
+
width?: number;
|
|
13
|
+
height?: number;
|
|
14
|
+
fontSize?: number;
|
|
15
|
+
fontWeight?: number;
|
|
16
|
+
color?: string;
|
|
17
|
+
align?: UiTextAlign;
|
|
18
|
+
valign?: UiTextVAlign;
|
|
19
|
+
lineHeight?: number;
|
|
20
|
+
padding?: number;
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [components/UIText.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L7)
|
|
25
|
+
|
|
26
|
+
Optional initializer for [UITextComponent](../classes/UITextComponent.md).
|
|
27
|
+
|
|
28
|
+
## Properties
|
|
29
|
+
|
|
30
|
+
| Property | Type | Defined in |
|
|
31
|
+
| ------ | ------ | ------ |
|
|
32
|
+
| <a id="text"></a> `text?` | `string` | [components/UIText.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L8) |
|
|
33
|
+
| <a id="width"></a> `width?` | `number` | [components/UIText.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L9) |
|
|
34
|
+
| <a id="height"></a> `height?` | `number` | [components/UIText.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L10) |
|
|
35
|
+
| <a id="fontsize"></a> `fontSize?` | `number` | [components/UIText.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L11) |
|
|
36
|
+
| <a id="fontweight"></a> `fontWeight?` | `number` | [components/UIText.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L12) |
|
|
37
|
+
| <a id="color"></a> `color?` | `string` | [components/UIText.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L13) |
|
|
38
|
+
| <a id="align"></a> `align?` | [`UiTextAlign`](UiTextAlign.md) | [components/UIText.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L14) |
|
|
39
|
+
| <a id="valign"></a> `valign?` | [`UiTextVAlign`](UiTextVAlign.md) | [components/UIText.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L15) |
|
|
40
|
+
| <a id="lineheight"></a> `lineHeight?` | `number` | [components/UIText.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L16) |
|
|
41
|
+
| <a id="padding"></a> `padding?` | `number` | [components/UIText.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L17) |
|