@relu-interactives/spatial-ecs 0.11.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{System-BldSHxZV.d.cts → System-D8vm-Jvv.d.cts} +110 -3
- package/dist/{System-CADhPyQs.d.ts → System-ttkDQCrj.d.ts} +110 -3
- package/dist/{XRHandPose-D3Ab1Dfs.d.cts → XRHandPose-C97XVW2R.d.cts} +2 -41
- package/dist/{XRHandPose-BNSwd1y9.d.ts → XRHandPose-CxXtWF1y.d.ts} +2 -41
- package/dist/animation/index.cjs +33 -1
- package/dist/animation/index.cjs.map +1 -1
- package/dist/animation/index.js +1 -1
- package/dist/{chunk-TY3XCHOR.js → chunk-2DJBNWBB.js} +56 -15
- package/dist/chunk-2DJBNWBB.js.map +1 -0
- package/dist/{chunk-WWP46AEF.js → chunk-4FHJA6U4.js} +8 -4
- package/dist/chunk-4FHJA6U4.js.map +1 -0
- package/dist/{chunk-GSWC6LLD.js → chunk-GMSFEXUZ.js} +35 -3
- package/dist/chunk-GMSFEXUZ.js.map +1 -0
- package/dist/{chunk-JEPUCLZX.js → chunk-QAZCVCMP.js} +88 -27
- package/dist/chunk-QAZCVCMP.js.map +1 -0
- package/dist/{chunk-NXASMBDS.js → chunk-SM5KGNYX.js} +4 -4
- package/dist/{chunk-NXASMBDS.js.map → chunk-SM5KGNYX.js.map} +1 -1
- package/dist/{chunk-JNYPJB55.js → chunk-T7SRBLPJ.js} +24 -4
- package/dist/chunk-T7SRBLPJ.js.map +1 -0
- package/dist/components/index.cjs +21 -1
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +3 -3
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +187 -46
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +5 -5
- package/dist/docs/api/Component/classes/Component.md +7 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +20 -19
- package/dist/docs/api/components/classes/BoneAttachmentComponent.md +65 -0
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +3 -3
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/IKComponent.md +59 -0
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +14 -14
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +6 -6
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/NetworkIdentityComponent.md +42 -0
- package/dist/docs/api/components/classes/NetworkSpawnerComponent.md +48 -0
- package/dist/docs/api/components/classes/NetworkTransformComponent.md +51 -0
- package/dist/docs/api/components/classes/NetworkedPropsComponent.md +47 -0
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +7 -7
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +5 -5
- package/dist/docs/api/components/classes/PrefabNode.md +3 -3
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +9 -9
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/UIButtonComponent.md +18 -14
- package/dist/docs/api/components/classes/UIPanelComponent.md +13 -11
- package/dist/docs/api/components/classes/UISliderComponent.md +16 -11
- package/dist/docs/api/components/classes/UITextComponent.md +14 -12
- package/dist/docs/api/components/classes/UIToggleComponent.md +12 -9
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +6 -6
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +3 -3
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +5 -5
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +4 -4
- package/dist/docs/api/components/classes/XRInteractableComponent.md +28 -28
- package/dist/docs/api/components/classes/XRInteractorComponent.md +10 -10
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +3 -3
- package/dist/docs/api/components/classes/XRRigComponent.md +17 -17
- package/dist/docs/api/components/functions/createAttachPoint.md +1 -1
- package/dist/docs/api/components/functions/createHandPoseEntry.md +1 -1
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +1 -1
- package/dist/docs/api/components/functions/normalizeBoneHold.md +25 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +1 -1
- package/dist/docs/api/components/functions/normalizeIKChain.md +25 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +1 -1
- package/dist/docs/api/components/index.md +18 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/BoneAttachmentOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/BoneHold.md +34 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentLightingState.md +9 -9
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +6 -6
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +1 -1
- package/dist/docs/api/components/type-aliases/IKChain.md +37 -0
- package/dist/docs/api/components/type-aliases/IKLimb.md +15 -0
- package/dist/docs/api/components/type-aliases/IKOptions.md +27 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightShadowState.md +8 -8
- package/dist/docs/api/components/type-aliases/LightValueState.md +12 -12
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/ModelLoadState.md +1 -1
- package/dist/docs/api/components/type-aliases/NetValue.md +23 -0
- package/dist/docs/api/components/type-aliases/NetworkTransformOptions.md +18 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -8
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +1 -1
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/UIButtonOptions.md +21 -13
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +14 -10
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +20 -10
- package/dist/docs/api/components/type-aliases/UITextOptions.md +15 -11
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +14 -8
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +1 -1
- package/dist/docs/api/components/type-aliases/UiIconPosition.md +13 -0
- package/dist/docs/api/components/type-aliases/UiSliderVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiToggleVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +5 -5
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +1 -1
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +2 -2
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +27 -27
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +16 -16
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +13 -13
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +1 -1
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +12 -12
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +1 -1
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_CURLS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/components/variables/MODEL_NO_PATH_MESSAGE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioMixer.md +161 -0
- package/dist/docs/api/index/classes/AudioSystem.md +138 -4
- package/dist/docs/api/index/classes/BoneHoldSystem.md +54 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +6 -6
- package/dist/docs/api/index/classes/IKSystem.md +98 -0
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +269 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
- package/dist/docs/api/index/classes/ScriptObject.md +10 -10
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +6 -6
- package/dist/docs/api/index/classes/SlotChooser.md +59 -0
- package/dist/docs/api/index/classes/TeleportAimGate.md +4 -4
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +4 -4
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +3 -3
- package/dist/docs/api/index/classes/UIPanelSystem.md +4 -4
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +168 -98
- package/dist/docs/api/index/classes/XRAnchorSystem.md +4 -4
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +7 -7
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +5 -5
- package/dist/docs/api/index/classes/XRHitTestSystem.md +4 -4
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XRInputSystem.md +9 -9
- package/dist/docs/api/index/classes/XRInteractionSystem.md +18 -18
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +7 -7
- package/dist/docs/api/index/classes/XRSessionSystem.md +6 -6
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +4 -4
- package/dist/docs/api/index/functions/angularVelocityFrom.md +1 -1
- package/dist/docs/api/index/functions/applyHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +1 -1
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +1 -1
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/clearModelCache.md +1 -1
- package/dist/docs/api/index/functions/clearPrefabCache.md +1 -1
- package/dist/docs/api/index/functions/cloneHandPose.md +1 -1
- package/dist/docs/api/index/functions/collectDiffPaths.md +1 -1
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +1 -1
- package/dist/docs/api/index/functions/collectEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +1 -1
- package/dist/docs/api/index/functions/computeFingerCurl.md +1 -1
- package/dist/docs/api/index/functions/computeHandShape.md +1 -1
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +1 -1
- package/dist/docs/api/index/functions/computePalmWidth.md +1 -1
- package/dist/docs/api/index/functions/computePinch.md +1 -1
- package/dist/docs/api/index/functions/computeSpread.md +1 -1
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createBoneAttachmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createGLTFLoader.md +30 -0
- package/dist/docs/api/index/functions/createHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/createIKComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createNetworkIdentityComponent.md +24 -0
- package/dist/docs/api/index/functions/createNetworkSpawnerComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkedPropsComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIButtonComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIPanelComponent.md +1 -1
- package/dist/docs/api/index/functions/createUISliderComponent.md +1 -1
- package/dist/docs/api/index/functions/createUITextComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIToggleComponent.md +1 -1
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRRigComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/despawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/encodeOverride.md +1 -1
- package/dist/docs/api/index/functions/estimateHandScale.md +1 -1
- package/dist/docs/api/index/functions/findModelBone.md +30 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +1 -1
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +1 -1
- package/dist/docs/api/index/functions/getHandPosePreset.md +1 -1
- package/dist/docs/api/index/functions/gripQuaternion.md +36 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +1 -1
- package/dist/docs/api/index/functions/instantiateSubtree.md +1 -1
- package/dist/docs/api/index/functions/listModelBones.md +25 -0
- package/dist/docs/api/index/functions/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +1 -1
- package/dist/docs/api/index/functions/mergeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/parseOverride.md +1 -1
- package/dist/docs/api/index/functions/parsePrefabAsset.md +1 -1
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +1 -1
- package/dist/docs/api/index/functions/readXrCapabilities.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +3 -3
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/restoreComponentState.md +1 -1
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +1 -1
- package/dist/docs/api/index/functions/sampleTeleportArc.md +1 -1
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +1 -1
- package/dist/docs/api/index/functions/setWorldQuaternion.md +26 -0
- package/dist/docs/api/index/functions/soundBankFiles.md +25 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/twoBoneIK.md +41 -0
- package/dist/docs/api/index/index.md +31 -0
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +5 -5
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/NetworkHandle.md +180 -0
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +6 -6
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +5 -5
- package/dist/docs/api/index/interfaces/RenderBackend.md +8 -8
- package/dist/docs/api/index/interfaces/SoundBankAsset.md +18 -0
- package/dist/docs/api/index/interfaces/SoundSlot.md +31 -0
- package/dist/docs/api/index/interfaces/SoundTake.md +18 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +3 -3
- package/dist/docs/api/index/type-aliases/AudioBus.md +15 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -38
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +7 -1
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +1 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +5 -5
- package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +4 -4
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +3 -3
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +4 -4
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +3 -3
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModelBoneInfo.md +29 -0
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +1 -1
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +5 -5
- package/dist/docs/api/index/type-aliases/NetSpawnOptions.md +41 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- package/dist/docs/api/index/type-aliases/PlaySlotOptions.md +32 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +5 -5
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/RendererKind.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +9 -9
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +6 -6
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +4 -4
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +4 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +4 -4
- package/dist/docs/api/index/type-aliases/UiColorStop.md +37 -0
- package/dist/docs/api/index/type-aliases/UiPaint.md +81 -0
- package/dist/docs/api/index/type-aliases/UiShadow.md +27 -0
- package/dist/docs/api/index/type-aliases/UiStyle.md +43 -0
- package/dist/docs/api/index/type-aliases/UiTextStyle.md +33 -0
- package/dist/docs/api/index/type-aliases/UiTokens.md +13 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +3 -3
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +9 -9
- package/dist/docs/api/index/type-aliases/XrFinger.md +1 -1
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +4 -4
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +6 -6
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +2 -2
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +11 -11
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +5 -5
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandShape.md +13 -13
- package/dist/docs/api/index/type-aliases/XrHandedness.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHitResult.md +3 -3
- package/dist/docs/api/index/type-aliases/XrInputKind.md +1 -1
- package/dist/docs/api/index/type-aliases/XrInputState.md +18 -18
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +6 -6
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +1 -1
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +1 -1
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +1 -1
- package/dist/docs/api/index/variables/ARC_SPEED.md +1 -1
- package/dist/docs/api/index/variables/ARC_STEPS.md +1 -1
- package/dist/docs/api/index/variables/CURLED_COS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +1 -1
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +1 -1
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/MATCH_FALLOFF.md +1 -1
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +1 -1
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/PINCH_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +1 -1
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +1 -1
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +1 -1
- package/dist/docs/api/index/variables/STRAIGHT_COS.md +1 -1
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +1 -1
- package/dist/docs/api/index/variables/XR_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +1 -1
- package/dist/docs/api/index/variables/webglBackend.md +1 -1
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/bone-attachments-and-ik.md +51 -0
- package/dist/docs/guide/components/audio.md +1 -1
- package/dist/factories/index.cjs +29 -1
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +2 -2
- package/dist/factories/index.d.ts +2 -2
- package/dist/factories/index.js +4 -4
- package/dist/{index-BXjwEdNq.d.cts → index-BbrnjNXy.d.ts} +5 -3
- package/dist/{index-CVG-hREM.d.ts → index-DD7aHv0p.d.cts} +5 -3
- package/dist/{index-6pZO_gV7.d.ts → index-OgOoIpEI.d.ts} +14 -2
- package/dist/{index-BdghvXKE.d.cts → index-xyqzT0PQ.d.cts} +14 -2
- package/dist/index.cjs +174 -13
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +13 -11
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +70 -38
- package/dist/network/index.cjs.map +1 -1
- package/dist/network/index.d.cts +2 -2
- package/dist/network/index.d.ts +2 -2
- package/dist/network/index.js +4 -4
- package/dist/systems/index.cjs +171 -13
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +2 -2
- package/dist/systems/index.d.ts +2 -2
- package/dist/systems/index.js +5 -5
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/webgpu/index.d.ts +2 -2
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +2 -1
- package/dist/chunk-GSWC6LLD.js.map +0 -1
- package/dist/chunk-JEPUCLZX.js.map +0 -1
- package/dist/chunk-JNYPJB55.js.map +0 -1
- package/dist/chunk-TY3XCHOR.js.map +0 -1
- package/dist/chunk-WWP46AEF.js.map +0 -1
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / NetSpawnOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: NetSpawnOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type NetSpawnOptions = {
|
|
11
|
+
position?: {
|
|
12
|
+
x?: number;
|
|
13
|
+
y?: number;
|
|
14
|
+
z?: number;
|
|
15
|
+
};
|
|
16
|
+
rotation?: {
|
|
17
|
+
x?: number;
|
|
18
|
+
y?: number;
|
|
19
|
+
z?: number;
|
|
20
|
+
};
|
|
21
|
+
props?: Record<string, NetValue>;
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Defined in: [network/types.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L86)
|
|
26
|
+
|
|
27
|
+
Options for [NetworkHandle.spawn](../interfaces/NetworkHandle.md#spawn).
|
|
28
|
+
|
|
29
|
+
## Properties
|
|
30
|
+
|
|
31
|
+
| Property | Type | Description | Defined in |
|
|
32
|
+
| ------ | ------ | ------ | ------ |
|
|
33
|
+
| <a id="position"></a> `position?` | \{ `x?`: `number`; `y?`: `number`; `z?`: `number`; \} | - | [network/types.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L87) |
|
|
34
|
+
| `position.x?` | `number` | - | [network/types.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L87) |
|
|
35
|
+
| `position.y?` | `number` | - | [network/types.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L87) |
|
|
36
|
+
| `position.z?` | `number` | - | [network/types.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L87) |
|
|
37
|
+
| <a id="rotation"></a> `rotation?` | \{ `x?`: `number`; `y?`: `number`; `z?`: `number`; \} | Euler XYZ in radians. | [network/types.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L89) |
|
|
38
|
+
| `rotation.x?` | `number` | - | [network/types.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L89) |
|
|
39
|
+
| `rotation.y?` | `number` | - | [network/types.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L89) |
|
|
40
|
+
| `rotation.z?` | `number` | - | [network/types.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L89) |
|
|
41
|
+
| <a id="props"></a> `props?` | `Record`\<`string`, [`NetValue`](../../components/type-aliases/NetValue.md)\> | - | [network/types.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/network/types.ts#L90) |
|
|
@@ -18,13 +18,13 @@ type NodeKeyMaps = {
|
|
|
18
18
|
};
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [prefab/nodeKeys.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [prefab/nodeKeys.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L33)
|
|
22
22
|
|
|
23
23
|
## Properties
|
|
24
24
|
|
|
25
25
|
| Property | Type | Description | Defined in |
|
|
26
26
|
| ------ | ------ | ------ | ------ |
|
|
27
|
-
| <a id="idtokey"></a> `idToKey` | `Map`\<`number`, `string`\> | - | [prefab/nodeKeys.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
-
| <a id="keytoid"></a> `keyToId` | `Map`\<`string`, `number`\> | - | [prefab/nodeKeys.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
-
| <a id="rootkey"></a> `rootKey` | `string` \| `null` | nodeKey of the scope root (bare nodeId), or null when it has none. | [prefab/nodeKeys.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="boundaryids"></a> `boundaryIds` | `Map`\<`number`, \{ `url`: `string`; `instanceId`: `string`; \}\> | Entity ids of NESTED instance roots (non-scope-root PrefabInstance). | [prefab/nodeKeys.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
| <a id="idtokey"></a> `idToKey` | `Map`\<`number`, `string`\> | - | [prefab/nodeKeys.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L34) |
|
|
28
|
+
| <a id="keytoid"></a> `keyToId` | `Map`\<`string`, `number`\> | - | [prefab/nodeKeys.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L35) |
|
|
29
|
+
| <a id="rootkey"></a> `rootKey` | `string` \| `null` | nodeKey of the scope root (bare nodeId), or null when it has none. | [prefab/nodeKeys.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L37) |
|
|
30
|
+
| <a id="boundaryids"></a> `boundaryIds` | `Map`\<`number`, \{ `url`: `string`; `instanceId`: `string`; \}\> | Entity ids of NESTED instance roots (non-scope-root PrefabInstance). | [prefab/nodeKeys.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L39) |
|
|
@@ -14,12 +14,12 @@ type NodeMaps = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [prefab/overrides.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [prefab/overrides.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/overrides.ts#L43)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="idtonode"></a> `idToNode` | `Map`\<`number`, `string`\> | - | [prefab/overrides.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="nodetoid"></a> `nodeToId` | `Map`\<`string`, `number`\> | - | [prefab/overrides.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="rootnodeid"></a> `rootNodeId` | `string` \| `null` | nodeId of the subtree root (entity whose ParentId is null/absent). | [prefab/overrides.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="idtonode"></a> `idToNode` | `Map`\<`number`, `string`\> | - | [prefab/overrides.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/overrides.ts#L44) |
|
|
24
|
+
| <a id="nodetoid"></a> `nodeToId` | `Map`\<`string`, `number`\> | - | [prefab/overrides.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/overrides.ts#L45) |
|
|
25
|
+
| <a id="rootnodeid"></a> `rootNodeId` | `string` \| `null` | nodeId of the subtree root (entity whose ParentId is null/absent). | [prefab/overrides.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/overrides.ts#L47) |
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / PlaySlotOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: PlaySlotOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type PlaySlotOptions = {
|
|
11
|
+
volume?: number;
|
|
12
|
+
position?: {
|
|
13
|
+
x: number;
|
|
14
|
+
y: number;
|
|
15
|
+
z: number;
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [systems/AudioSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L39)
|
|
21
|
+
|
|
22
|
+
Options for [AudioSystem.playSlot](../classes/AudioSystem.md#playslot).
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
| Property | Type | Description | Defined in |
|
|
27
|
+
| ------ | ------ | ------ | ------ |
|
|
28
|
+
| <a id="volume"></a> `volume?` | `number` | Multiplies the slot's volume. | [systems/AudioSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L41) |
|
|
29
|
+
| <a id="position"></a> `position?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Play from this point in the world instead of everywhere. | [systems/AudioSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L43) |
|
|
30
|
+
| `position.x` | `number` | - | [systems/AudioSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L43) |
|
|
31
|
+
| `position.y` | `number` | - | [systems/AudioSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L43) |
|
|
32
|
+
| `position.z` | `number` | - | [systems/AudioSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L43) |
|
|
@@ -15,7 +15,7 @@ type PrefabAsset = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/types.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [prefab/types.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/types.ts#L21)
|
|
19
19
|
|
|
20
20
|
Envelope of a `.prefab` asset file (and, later, `.scene` assets — same
|
|
21
21
|
shape with `type: "scene"`). `snapshot` is the same columnar world-snapshot
|
|
@@ -26,7 +26,7 @@ renumbered 1..N and every entity carrying a `PrefabNode` identity.
|
|
|
26
26
|
|
|
27
27
|
| Property | Type | Defined in |
|
|
28
28
|
| ------ | ------ | ------ |
|
|
29
|
-
| <a id="version"></a> `version` | `number` | [prefab/types.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="type"></a> `type?` | `"prefab"` \| `"scene"` | [prefab/types.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="name"></a> `name?` | `string` | [prefab/types.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | [prefab/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
| <a id="version"></a> `version` | `number` | [prefab/types.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/types.ts#L22) |
|
|
30
|
+
| <a id="type"></a> `type?` | `"prefab"` \| `"scene"` | [prefab/types.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/types.ts#L23) |
|
|
31
|
+
| <a id="name"></a> `name?` | `string` | [prefab/types.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/types.ts#L24) |
|
|
32
|
+
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | [prefab/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/types.ts#L25) |
|
|
@@ -12,10 +12,10 @@ type RemapSnapshotOptions = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [prefab/snapshotIdUtils.ts:
|
|
15
|
+
Defined in: [prefab/snapshotIdUtils.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L36)
|
|
16
16
|
|
|
17
17
|
## Properties
|
|
18
18
|
|
|
19
19
|
| Property | Type | Description | Defined in |
|
|
20
20
|
| ------ | ------ | ------ | ------ |
|
|
21
|
-
| <a id="externalrefpolicy"></a> `externalRefPolicy?` | `"null"` \| `"keep"` | What to do with references to entities NOT present in the id map: - "null": replace the reference with null and record a warning (prefab-file serialization — external refs must not leak). - "keep": leave the raw id untouched and record a warning. Default: "keep". | [prefab/snapshotIdUtils.ts:
|
|
21
|
+
| <a id="externalrefpolicy"></a> `externalRefPolicy?` | `"null"` \| `"keep"` | What to do with references to entities NOT present in the id map: - "null": replace the reference with null and record a warning (prefab-file serialization — external refs must not leak). - "keep": leave the raw id untouched and record a warning. Default: "keep". | [prefab/snapshotIdUtils.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L44) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type RendererKind = "webgl" | "webgpu";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: render/RenderBackend.ts:16
|
|
13
|
+
Defined in: [render/RenderBackend.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/render/RenderBackend.ts#L16)
|
|
14
14
|
|
|
15
15
|
Which renderer family a world is drawing with.
|
|
@@ -12,7 +12,7 @@ type ScriptBehaviourSystemOptions = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [systems/ScriptBehaviourSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
Defined in: [systems/ScriptBehaviourSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L31)
|
|
16
16
|
|
|
17
17
|
Options for [ScriptBehaviourSystem](../classes/ScriptBehaviourSystem.md).
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Options for [ScriptBehaviourSystem](../classes/ScriptBehaviourSystem.md).
|
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="errorretrydelay"></a> `errorRetryDelay?` | `number` | Seconds to wait after a script error before re-initialising the script. Default [DEFAULT\_SCRIPT\_ERROR\_RETRY\_DELAY](../variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md). | [systems/ScriptBehaviourSystem.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="errorretrydelay"></a> `errorRetryDelay?` | `number` | Seconds to wait after a script error before re-initialising the script. Default [DEFAULT\_SCRIPT\_ERROR\_RETRY\_DELAY](../variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md). | [systems/ScriptBehaviourSystem.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L36) |
|
|
@@ -19,7 +19,7 @@ type ScriptErrorEvent = {
|
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: scriptErrors.ts:26
|
|
22
|
+
Defined in: [scriptErrors.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L26)
|
|
23
23
|
|
|
24
24
|
Emitted by `world.onScriptError(...)` the first time a distinct script error
|
|
25
25
|
occurs. "Distinct" is the combination of script URL, class name, phase and
|
|
@@ -29,11 +29,11 @@ message: ten enemies running the same broken script report once.
|
|
|
29
29
|
|
|
30
30
|
| Property | Type | Description | Defined in |
|
|
31
31
|
| ------ | ------ | ------ | ------ |
|
|
32
|
-
| <a id="entityid"></a> `entityId` | `number` | Entity the failing script is attached to. | scriptErrors.ts:28 |
|
|
33
|
-
| <a id="entityname"></a> `entityName` | `string` | That entity's name (`Name` component), or `"Entity <id>"`. | scriptErrors.ts:30 |
|
|
34
|
-
| <a id="scripturl"></a> `scriptUrl` | `string` | URL of the script module. Empty when unknown. | scriptErrors.ts:32 |
|
|
35
|
-
| <a id="classname"></a> `className` | `string` | Script class name. | scriptErrors.ts:34 |
|
|
36
|
-
| <a id="phase"></a> `phase` | [`ScriptErrorPhase`](ScriptErrorPhase.md) | Lifecycle phase or hook name. See [ScriptErrorPhase](ScriptErrorPhase.md). | scriptErrors.ts:36 |
|
|
37
|
-
| <a id="message"></a> `message` | `string` | Short error message, with local file paths removed. | scriptErrors.ts:38 |
|
|
38
|
-
| <a id="stack"></a> `stack?` | `string` | Stack trace when the error carried one, with local file paths removed. | scriptErrors.ts:40 |
|
|
39
|
-
| <a id="source"></a> `source` | [`ScriptErrorSource`](ScriptErrorSource.md) | Behaviour or ScriptObject. | scriptErrors.ts:42 |
|
|
32
|
+
| <a id="entityid"></a> `entityId` | `number` | Entity the failing script is attached to. | [scriptErrors.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L28) |
|
|
33
|
+
| <a id="entityname"></a> `entityName` | `string` | That entity's name (`Name` component), or `"Entity <id>"`. | [scriptErrors.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L30) |
|
|
34
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` | URL of the script module. Empty when unknown. | [scriptErrors.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L32) |
|
|
35
|
+
| <a id="classname"></a> `className` | `string` | Script class name. | [scriptErrors.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L34) |
|
|
36
|
+
| <a id="phase"></a> `phase` | [`ScriptErrorPhase`](ScriptErrorPhase.md) | Lifecycle phase or hook name. See [ScriptErrorPhase](ScriptErrorPhase.md). | [scriptErrors.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L36) |
|
|
37
|
+
| <a id="message"></a> `message` | `string` | Short error message, with local file paths removed. | [scriptErrors.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L38) |
|
|
38
|
+
| <a id="stack"></a> `stack?` | `string` | Stack trace when the error carried one, with local file paths removed. | [scriptErrors.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L40) |
|
|
39
|
+
| <a id="source"></a> `source` | [`ScriptErrorSource`](ScriptErrorSource.md) | Behaviour or ScriptObject. | [scriptErrors.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L42) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type ScriptErrorListener = (event) => void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: scriptErrors.ts:46
|
|
13
|
+
Defined in: [scriptErrors.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L46)
|
|
14
14
|
|
|
15
15
|
Listener registered with `world.onScriptError(...)`.
|
|
16
16
|
|
|
@@ -16,7 +16,7 @@ type ScriptErrorPhase =
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: scriptErrors.ts:11
|
|
19
|
+
Defined in: [scriptErrors.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L11)
|
|
20
20
|
|
|
21
21
|
Where in a script's life an error happened.
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ type ScriptErrorReport = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: scriptErrors.ts:49
|
|
19
|
+
Defined in: [scriptErrors.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L49)
|
|
20
20
|
|
|
21
21
|
What a system knows when it reports a script error.
|
|
22
22
|
|
|
@@ -24,8 +24,8 @@ What a system knows when it reports a script error.
|
|
|
24
24
|
|
|
25
25
|
| Property | Type | Defined in |
|
|
26
26
|
| ------ | ------ | ------ |
|
|
27
|
-
| <a id="entityid"></a> `entityId` | `number` | scriptErrors.ts:50 |
|
|
28
|
-
| <a id="scripturl"></a> `scriptUrl` | `string` | scriptErrors.ts:51 |
|
|
29
|
-
| <a id="classname"></a> `className` | `string` | scriptErrors.ts:52 |
|
|
30
|
-
| <a id="phase"></a> `phase` | [`ScriptErrorPhase`](ScriptErrorPhase.md) | scriptErrors.ts:53 |
|
|
31
|
-
| <a id="source"></a> `source` | [`ScriptErrorSource`](ScriptErrorSource.md) | scriptErrors.ts:54 |
|
|
27
|
+
| <a id="entityid"></a> `entityId` | `number` | [scriptErrors.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L50) |
|
|
28
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` | [scriptErrors.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L51) |
|
|
29
|
+
| <a id="classname"></a> `className` | `string` | [scriptErrors.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L52) |
|
|
30
|
+
| <a id="phase"></a> `phase` | [`ScriptErrorPhase`](ScriptErrorPhase.md) | [scriptErrors.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L53) |
|
|
31
|
+
| <a id="source"></a> `source` | [`ScriptErrorSource`](ScriptErrorSource.md) | [scriptErrors.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L54) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type ScriptErrorSource = "behaviour" | "scriptObject";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: scriptErrors.ts:19
|
|
13
|
+
Defined in: [scriptErrors.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/scriptErrors.ts#L19)
|
|
14
14
|
|
|
15
15
|
Which kind of script failed.
|
|
@@ -14,7 +14,7 @@ type SelectionContext = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [systems/ScriptBehaviourSystem.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [systems/ScriptBehaviourSystem.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L125)
|
|
18
18
|
|
|
19
19
|
Optional context that enables raycast-based onSelect / onDeselect dispatch.
|
|
20
20
|
When provided, pointer/touch taps on the canvas fire a raycast against the
|
|
@@ -26,6 +26,6 @@ selected entity's instances receive onDeselect().
|
|
|
26
26
|
|
|
27
27
|
| Property | Type | Defined in |
|
|
28
28
|
| ------ | ------ | ------ |
|
|
29
|
-
| <a id="camera"></a> `camera` | `THREE.Camera` | [systems/ScriptBehaviourSystem.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="scene"></a> `scene` | `THREE.Scene` | [systems/ScriptBehaviourSystem.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="domelement"></a> `domElement` | `HTMLElement` | [systems/ScriptBehaviourSystem.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
| <a id="camera"></a> `camera` | `THREE.Camera` | [systems/ScriptBehaviourSystem.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L126) |
|
|
30
|
+
| <a id="scene"></a> `scene` | `THREE.Scene` | [systems/ScriptBehaviourSystem.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L127) |
|
|
31
|
+
| <a id="domelement"></a> `domElement` | `HTMLElement` | [systems/ScriptBehaviourSystem.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/ScriptBehaviourSystem.ts#L128) |
|
|
@@ -14,12 +14,12 @@ type SerializeEntitySubtreeResult = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [prefab/serializeEntitySubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [prefab/serializeEntitySubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/serializeEntitySubtree.ts#L23)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | - | [prefab/serializeEntitySubtree.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="warnings"></a> `warnings` | [`ExternalRefWarning`](ExternalRefWarning.md)[] | References that pointed OUTSIDE the subtree and were nulled out (ids are LIVE world ids so callers can name the offending entities). The root's own external parent link is nulled silently — it is expected. | [prefab/serializeEntitySubtree.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="strippedcomponents"></a> `strippedComponents` | `string`[] | Component types stripped because they are scene singletons. | [prefab/serializeEntitySubtree.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="snapshot"></a> `snapshot` | [`SubtreeSnapshot`](SubtreeSnapshot.md) | - | [prefab/serializeEntitySubtree.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/serializeEntitySubtree.ts#L24) |
|
|
24
|
+
| <a id="warnings"></a> `warnings` | [`ExternalRefWarning`](ExternalRefWarning.md)[] | References that pointed OUTSIDE the subtree and were nulled out (ids are LIVE world ids so callers can name the offending entities). The root's own external parent link is nulled silently — it is expected. | [prefab/serializeEntitySubtree.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/serializeEntitySubtree.ts#L30) |
|
|
25
|
+
| <a id="strippedcomponents"></a> `strippedComponents` | `string`[] | Component types stripped because they are scene singletons. | [prefab/serializeEntitySubtree.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/serializeEntitySubtree.ts#L32) |
|
|
@@ -15,13 +15,13 @@ type SpawnPrefabOptions = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/spawnPrefab.ts:
|
|
18
|
+
Defined in: [prefab/spawnPrefab.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L113)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="parentid"></a> `parentId?` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Parent the spawned root under this entity (default: world root). | [prefab/spawnPrefab.ts:
|
|
25
|
-
| <a id="position"></a> `position?` | `Vec3Like` | Local-space spawn transform for the root (partial axes allowed). | [prefab/spawnPrefab.ts:
|
|
26
|
-
| <a id="rotation"></a> `rotation?` | `Vec3Like` | - | [prefab/spawnPrefab.ts:
|
|
27
|
-
| <a id="scale"></a> `scale?` | `Vec3Like` | - | [prefab/spawnPrefab.ts:
|
|
24
|
+
| <a id="parentid"></a> `parentId?` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Parent the spawned root under this entity (default: world root). | [prefab/spawnPrefab.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L115) |
|
|
25
|
+
| <a id="position"></a> `position?` | `Vec3Like` | Local-space spawn transform for the root (partial axes allowed). | [prefab/spawnPrefab.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L117) |
|
|
26
|
+
| <a id="rotation"></a> `rotation?` | `Vec3Like` | - | [prefab/spawnPrefab.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L118) |
|
|
27
|
+
| <a id="scale"></a> `scale?` | `Vec3Like` | - | [prefab/spawnPrefab.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L119) |
|
|
@@ -16,4 +16,4 @@ type SpawnPrefabSource =
|
|
|
16
16
|
| PrefabAsset;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [prefab/spawnPrefab.ts:
|
|
19
|
+
Defined in: [prefab/spawnPrefab.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/spawnPrefab.ts#L108)
|
|
@@ -19,7 +19,7 @@ type SubtreeSnapshot = {
|
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [prefab/snapshotIdUtils.ts:
|
|
22
|
+
Defined in: [prefab/snapshotIdUtils.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L18)
|
|
23
23
|
|
|
24
24
|
Snapshot-space entity-id walking/remapping.
|
|
25
25
|
|
|
@@ -31,6 +31,7 @@ a serialized world snapshot:
|
|
|
31
31
|
- `ScriptObjectComponent.data` EntityInput/ComponentInput (same shapes)
|
|
32
32
|
- `InstancedMeshComponent.instanceEntityIds[]`
|
|
33
33
|
- `InstanceSlotComponent.groupEntityId`
|
|
34
|
+
- `IKComponent.chains[].target` / `.pole`
|
|
34
35
|
|
|
35
36
|
Any new id-bearing component field must be added here — serialization,
|
|
36
37
|
instantiation and the override differ all route through this walker.
|
|
@@ -39,5 +40,5 @@ instantiation and the override differ all route through this walker.
|
|
|
39
40
|
|
|
40
41
|
| Property | Type | Defined in |
|
|
41
42
|
| ------ | ------ | ------ |
|
|
42
|
-
| <a id="entities"></a> `entities` | `number`[] | [prefab/snapshotIdUtils.ts:
|
|
43
|
-
| <a id="components"></a> `components` | \{ `component`: `string`; `entries`: \{ `entityId`: `number`; `value`: `unknown`; \}[]; \}[] | [prefab/snapshotIdUtils.ts:
|
|
43
|
+
| <a id="entities"></a> `entities` | `number`[] | [prefab/snapshotIdUtils.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L19) |
|
|
44
|
+
| <a id="components"></a> `components` | \{ `component`: `string`; `entries`: \{ `entityId`: `number`; `value`: `unknown`; \}[]; \}[] | [prefab/snapshotIdUtils.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/snapshotIdUtils.ts#L20) |
|
|
@@ -14,7 +14,7 @@ type UiCanvasLike = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [systems/UIPanelSystem.ts:
|
|
17
|
+
Defined in: [systems/UIPanelSystem.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L76)
|
|
18
18
|
|
|
19
19
|
Structural canvas type so tests can inject a stub with no DOM.
|
|
20
20
|
|
|
@@ -22,8 +22,8 @@ Structural canvas type so tests can inject a stub with no DOM.
|
|
|
22
22
|
|
|
23
23
|
| Property | Type | Defined in |
|
|
24
24
|
| ------ | ------ | ------ |
|
|
25
|
-
| <a id="width"></a> `width` | `number` | [systems/UIPanelSystem.ts:
|
|
26
|
-
| <a id="height"></a> `height` | `number` | [systems/UIPanelSystem.ts:
|
|
25
|
+
| <a id="width"></a> `width` | `number` | [systems/UIPanelSystem.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L77) |
|
|
26
|
+
| <a id="height"></a> `height` | `number` | [systems/UIPanelSystem.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L78) |
|
|
27
27
|
|
|
28
28
|
## Methods
|
|
29
29
|
|
|
@@ -33,7 +33,7 @@ Structural canvas type so tests can inject a stub with no DOM.
|
|
|
33
33
|
getContext(kind): CanvasRenderingContext2D | null;
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Defined in: [systems/UIPanelSystem.ts:
|
|
36
|
+
Defined in: [systems/UIPanelSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/UIPanelSystem.ts#L79)
|
|
37
37
|
|
|
38
38
|
#### Parameters
|
|
39
39
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiColorStop
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiColorStop
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiColorStop = {
|
|
11
|
+
at: number;
|
|
12
|
+
color: string;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [ui/uiStyle.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L17)
|
|
17
|
+
|
|
18
|
+
The style model for spatial UI.
|
|
19
|
+
|
|
20
|
+
Every field here is optional and stays ABSENT until authored. A defaulted
|
|
21
|
+
field would show up as a change on every instance of a prefab saved before
|
|
22
|
+
it existed, pinning those instances against later prefab edits. Old flat
|
|
23
|
+
fields (`backgroundColor`, `cornerRadius`…) stay as the fallback, so a scene
|
|
24
|
+
saved before this model renders the same.
|
|
25
|
+
|
|
26
|
+
Units are metres. Any colour or file string may be a token, `$name`, which
|
|
27
|
+
resolves through `tokens` on the nearest panel above the widget. A theme
|
|
28
|
+
therefore travels with a prefab, and editing one panel restyles a menu.
|
|
29
|
+
|
|
30
|
+
Pure and free of three.js and the DOM.
|
|
31
|
+
|
|
32
|
+
## Properties
|
|
33
|
+
|
|
34
|
+
| Property | Type | Defined in |
|
|
35
|
+
| ------ | ------ | ------ |
|
|
36
|
+
| <a id="at"></a> `at` | `number` | [ui/uiStyle.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L17) |
|
|
37
|
+
| <a id="color"></a> `color` | `string` | [ui/uiStyle.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L17) |
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiPaint
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiPaint
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiPaint =
|
|
11
|
+
| {
|
|
12
|
+
kind: "solid";
|
|
13
|
+
color: string;
|
|
14
|
+
}
|
|
15
|
+
| {
|
|
16
|
+
kind: "linear";
|
|
17
|
+
angle: number;
|
|
18
|
+
stops: UiColorStop[];
|
|
19
|
+
}
|
|
20
|
+
| {
|
|
21
|
+
kind: "radial";
|
|
22
|
+
stops: UiColorStop[];
|
|
23
|
+
}
|
|
24
|
+
| {
|
|
25
|
+
kind: "image";
|
|
26
|
+
src: string;
|
|
27
|
+
fit: "cover" | "contain" | "fill";
|
|
28
|
+
tint?: string;
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [ui/uiStyle.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L19)
|
|
33
|
+
|
|
34
|
+
## Union Members
|
|
35
|
+
|
|
36
|
+
### Type Literal
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
{
|
|
40
|
+
kind: "solid";
|
|
41
|
+
color: string;
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
47
|
+
### Type Literal
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
{
|
|
51
|
+
kind: "linear";
|
|
52
|
+
angle: number;
|
|
53
|
+
stops: UiColorStop[];
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
`angle` is in degrees and reads like CSS: 0 points up, 90 points right.
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### Type Literal
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
{
|
|
65
|
+
kind: "radial";
|
|
66
|
+
stops: UiColorStop[];
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
***
|
|
71
|
+
|
|
72
|
+
### Type Literal
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
{
|
|
76
|
+
kind: "image";
|
|
77
|
+
src: string;
|
|
78
|
+
fit: "cover" | "contain" | "fill";
|
|
79
|
+
tint?: string;
|
|
80
|
+
}
|
|
81
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiShadow
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiShadow
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiShadow = {
|
|
11
|
+
x: number;
|
|
12
|
+
y: number;
|
|
13
|
+
blur: number;
|
|
14
|
+
color: string;
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [ui/uiStyle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L31)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
| Property | Type | Defined in |
|
|
23
|
+
| ------ | ------ | ------ |
|
|
24
|
+
| <a id="x"></a> `x` | `number` | [ui/uiStyle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L31) |
|
|
25
|
+
| <a id="y"></a> `y` | `number` | [ui/uiStyle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L31) |
|
|
26
|
+
| <a id="blur"></a> `blur` | `number` | [ui/uiStyle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L31) |
|
|
27
|
+
| <a id="color"></a> `color` | `string` | [ui/uiStyle.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L31) |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiStyle
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiStyle
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiStyle = {
|
|
11
|
+
fill?: UiPaint;
|
|
12
|
+
border?: {
|
|
13
|
+
width: number;
|
|
14
|
+
paint: UiPaint;
|
|
15
|
+
};
|
|
16
|
+
radius?: number | [number, number, number, number];
|
|
17
|
+
shadows?: UiShadow[];
|
|
18
|
+
edge?: {
|
|
19
|
+
width: number;
|
|
20
|
+
color: string;
|
|
21
|
+
};
|
|
22
|
+
opacity?: number;
|
|
23
|
+
text?: UiTextStyle;
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [ui/uiStyle.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L45)
|
|
28
|
+
|
|
29
|
+
## Properties
|
|
30
|
+
|
|
31
|
+
| Property | Type | Description | Defined in |
|
|
32
|
+
| ------ | ------ | ------ | ------ |
|
|
33
|
+
| <a id="fill"></a> `fill?` | [`UiPaint`](UiPaint.md) | - | [ui/uiStyle.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L46) |
|
|
34
|
+
| <a id="border"></a> `border?` | \{ `width`: `number`; `paint`: [`UiPaint`](UiPaint.md); \} | - | [ui/uiStyle.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L47) |
|
|
35
|
+
| `border.width` | `number` | - | [ui/uiStyle.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L47) |
|
|
36
|
+
| `border.paint` | [`UiPaint`](UiPaint.md) | - | [ui/uiStyle.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L47) |
|
|
37
|
+
| <a id="radius"></a> `radius?` | `number` \| \[`number`, `number`, `number`, `number`\] | One radius, or top-left, top-right, bottom-right, bottom-left. | [ui/uiStyle.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L49) |
|
|
38
|
+
| <a id="shadows"></a> `shadows?` | [`UiShadow`](UiShadow.md)[] | - | [ui/uiStyle.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L50) |
|
|
39
|
+
| <a id="edge"></a> `edge?` | \{ `width`: `number`; `color`: `string`; \} | A thin highlight along the top inner edge. | [ui/uiStyle.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L52) |
|
|
40
|
+
| `edge.width` | `number` | - | [ui/uiStyle.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L52) |
|
|
41
|
+
| `edge.color` | `string` | - | [ui/uiStyle.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L52) |
|
|
42
|
+
| <a id="opacity"></a> `opacity?` | `number` | 0–1. Multiplies down the widget tree, so fading a panel fades its menu. | [ui/uiStyle.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L54) |
|
|
43
|
+
| <a id="text"></a> `text?` | [`UiTextStyle`](UiTextStyle.md) | - | [ui/uiStyle.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L55) |
|