@relu-interactives/spatial-ecs 0.5.3 → 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
|
@@ -29,6 +29,18 @@ type ComponentValueMaps = {
|
|
|
29
29
|
imageTargetAnchorValues: Map<number, unknown>;
|
|
30
30
|
scriptValues: Map<number, unknown>;
|
|
31
31
|
scriptObjectValues: Map<number, unknown>;
|
|
32
|
+
xrRigValues: Map<number, unknown>;
|
|
33
|
+
vrTeleportAreaValues: Map<number, unknown>;
|
|
34
|
+
xrInteractableValues: Map<number, unknown>;
|
|
35
|
+
xrInteractorValues: Map<number, unknown>;
|
|
36
|
+
xrHandPoseValues: Map<number, unknown>;
|
|
37
|
+
xrAnchorValues: Map<number, unknown>;
|
|
38
|
+
uiPanelValues: Map<number, unknown>;
|
|
39
|
+
uiTextValues: Map<number, unknown>;
|
|
40
|
+
uiButtonValues: Map<number, unknown>;
|
|
41
|
+
uiToggleValues: Map<number, unknown>;
|
|
42
|
+
uiSliderValues: Map<number, unknown>;
|
|
43
|
+
xrInteractorSideValues: Map<number, unknown>;
|
|
32
44
|
instancedMeshValues: Map<number, unknown>;
|
|
33
45
|
instanceSlotValues: Map<number, unknown>;
|
|
34
46
|
prefabNodeValues: Map<number, unknown>;
|
|
@@ -36,34 +48,46 @@ type ComponentValueMaps = {
|
|
|
36
48
|
};
|
|
37
49
|
```
|
|
38
50
|
|
|
39
|
-
Defined in: [hydration/types.ts:
|
|
51
|
+
Defined in: [hydration/types.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L21)
|
|
40
52
|
|
|
41
53
|
## Properties
|
|
42
54
|
|
|
43
55
|
| Property | Type | Defined in |
|
|
44
56
|
| ------ | ------ | ------ |
|
|
45
|
-
| <a id="object3drefvalues"></a> `object3DRefValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
46
|
-
| <a id="namevalues"></a> `nameValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
47
|
-
| <a id="transformvalues"></a> `transformValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
48
|
-
| <a id="modelvalues"></a> `modelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
49
|
-
| <a id="imagevalues"></a> `imageValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
50
|
-
| <a id="spritevalues"></a> `spriteValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
51
|
-
| <a id="videovalues"></a> `videoValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
52
|
-
| <a id="cameravalues"></a> `cameraValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
53
|
-
| <a id="environmentvalues"></a> `environmentValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
54
|
-
| <a id="postprocessingvalues"></a> `postprocessingValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
55
|
-
| <a id="audiovalues"></a> `audioValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
56
|
-
| <a id="imagetargetvalues"></a> `imageTargetValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
57
|
-
| <a id="lightvalues"></a> `lightValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
58
|
-
| <a id="materialvalues"></a> `materialValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
59
|
-
| <a id="meshgeometryvalues"></a> `meshGeometryValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
60
|
-
| <a id="selectablevalues"></a> `selectableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
61
|
-
| <a id="physicsvalues"></a> `physicsValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
62
|
-
| <a id="animationvalues"></a> `animationValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
63
|
-
| <a id="imagetargetanchorvalues"></a> `imageTargetAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
64
|
-
| <a id="scriptvalues"></a> `scriptValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
65
|
-
| <a id="scriptobjectvalues"></a> `scriptObjectValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:
|
|
66
|
-
| <a id="
|
|
67
|
-
| <a id="
|
|
68
|
-
| <a id="
|
|
69
|
-
| <a id="
|
|
57
|
+
| <a id="object3drefvalues"></a> `object3DRefValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L22) |
|
|
58
|
+
| <a id="namevalues"></a> `nameValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L23) |
|
|
59
|
+
| <a id="transformvalues"></a> `transformValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L24) |
|
|
60
|
+
| <a id="modelvalues"></a> `modelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L25) |
|
|
61
|
+
| <a id="imagevalues"></a> `imageValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L26) |
|
|
62
|
+
| <a id="spritevalues"></a> `spriteValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L27) |
|
|
63
|
+
| <a id="videovalues"></a> `videoValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L28) |
|
|
64
|
+
| <a id="cameravalues"></a> `cameraValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L29) |
|
|
65
|
+
| <a id="environmentvalues"></a> `environmentValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L30) |
|
|
66
|
+
| <a id="postprocessingvalues"></a> `postprocessingValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L31) |
|
|
67
|
+
| <a id="audiovalues"></a> `audioValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L32) |
|
|
68
|
+
| <a id="imagetargetvalues"></a> `imageTargetValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L33) |
|
|
69
|
+
| <a id="lightvalues"></a> `lightValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L34) |
|
|
70
|
+
| <a id="materialvalues"></a> `materialValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L35) |
|
|
71
|
+
| <a id="meshgeometryvalues"></a> `meshGeometryValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L36) |
|
|
72
|
+
| <a id="selectablevalues"></a> `selectableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L37) |
|
|
73
|
+
| <a id="physicsvalues"></a> `physicsValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L38) |
|
|
74
|
+
| <a id="animationvalues"></a> `animationValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L39) |
|
|
75
|
+
| <a id="imagetargetanchorvalues"></a> `imageTargetAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L40) |
|
|
76
|
+
| <a id="scriptvalues"></a> `scriptValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L41) |
|
|
77
|
+
| <a id="scriptobjectvalues"></a> `scriptObjectValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L42) |
|
|
78
|
+
| <a id="xrrigvalues"></a> `xrRigValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L43) |
|
|
79
|
+
| <a id="vrteleportareavalues"></a> `vrTeleportAreaValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L44) |
|
|
80
|
+
| <a id="xrinteractablevalues"></a> `xrInteractableValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L45) |
|
|
81
|
+
| <a id="xrinteractorvalues"></a> `xrInteractorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L46) |
|
|
82
|
+
| <a id="xrhandposevalues"></a> `xrHandPoseValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L47) |
|
|
83
|
+
| <a id="xranchorvalues"></a> `xrAnchorValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L48) |
|
|
84
|
+
| <a id="uipanelvalues"></a> `uiPanelValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L49) |
|
|
85
|
+
| <a id="uitextvalues"></a> `uiTextValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L50) |
|
|
86
|
+
| <a id="uibuttonvalues"></a> `uiButtonValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L51) |
|
|
87
|
+
| <a id="uitogglevalues"></a> `uiToggleValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L52) |
|
|
88
|
+
| <a id="uislidervalues"></a> `uiSliderValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L53) |
|
|
89
|
+
| <a id="xrinteractorsidevalues"></a> `xrInteractorSideValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L54) |
|
|
90
|
+
| <a id="instancedmeshvalues"></a> `instancedMeshValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L55) |
|
|
91
|
+
| <a id="instanceslotvalues"></a> `instanceSlotValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L56) |
|
|
92
|
+
| <a id="prefabnodevalues"></a> `prefabNodeValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L57) |
|
|
93
|
+
| <a id="prefabinstancevalues"></a> `prefabInstanceValues` | `Map`\<`number`, `unknown`\> | [hydration/types.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L58) |
|
|
@@ -33,7 +33,19 @@ type EcsComponentFactoryKind =
|
|
|
33
33
|
| "sprite"
|
|
34
34
|
| "transform"
|
|
35
35
|
| "video"
|
|
36
|
-
| "instancedMesh"
|
|
36
|
+
| "instancedMesh"
|
|
37
|
+
| "xrRig"
|
|
38
|
+
| "vrTeleportArea"
|
|
39
|
+
| "xrHandPose"
|
|
40
|
+
| "xrAnchor"
|
|
41
|
+
| "uiPanel"
|
|
42
|
+
| "uiText"
|
|
43
|
+
| "uiButton"
|
|
44
|
+
| "uiToggle"
|
|
45
|
+
| "uiSlider"
|
|
46
|
+
| "xrInteractable"
|
|
47
|
+
| "xrInteractor"
|
|
48
|
+
| "xrInteractorSide";
|
|
37
49
|
```
|
|
38
50
|
|
|
39
|
-
Defined in: [systems/ObjectManagementSystem.ts:
|
|
51
|
+
Defined in: [systems/ObjectManagementSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ObjectManagementSystem.ts#L39)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / EcsRenderer
|
|
6
|
+
|
|
7
|
+
# Type Alias: EcsRenderer
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EcsRenderer = THREE.WebGLRenderer | WebGPURenderer;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: render/RenderBackend.ts:13
|
|
14
|
+
|
|
15
|
+
A renderer a [World](../classes/World.md) can run on: three's classic `WebGLRenderer`, or
|
|
16
|
+
`WebGPURenderer` from `three/webgpu` (which falls back to WebGL 2 on its own
|
|
17
|
+
when the browser has no WebGPU).
|
|
@@ -16,11 +16,11 @@ type EcsWorldComponentSnapshot = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [hydration/types.ts:
|
|
19
|
+
Defined in: [hydration/types.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L61)
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
23
23
|
| Property | Type | Defined in |
|
|
24
24
|
| ------ | ------ | ------ |
|
|
25
|
-
| <a id="component"></a> `component` | `string` | [hydration/types.ts:
|
|
26
|
-
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:
|
|
25
|
+
| <a id="component"></a> `component` | `string` | [hydration/types.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L62) |
|
|
26
|
+
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L63) |
|
|
@@ -14,12 +14,12 @@ type EcsWorldStateSnapshotLike = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [hydration/types.ts:
|
|
17
|
+
Defined in: [hydration/types.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L69)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:
|
|
24
|
-
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:
|
|
25
|
-
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:
|
|
23
|
+
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L70) |
|
|
24
|
+
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L71) |
|
|
25
|
+
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L72) |
|
|
@@ -15,13 +15,13 @@ type ExternalRefWarning = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/snapshotIdUtils.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [prefab/snapshotIdUtils.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L25)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="entityid"></a> `entityId` | `number` | Entity id (in the INPUT snapshot's id space) holding the reference. | [prefab/snapshotIdUtils.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="component"></a> `component` | `string` | - | [prefab/snapshotIdUtils.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="path"></a> `path` | `string` | Slash-separated path of the reference inside the component value. | [prefab/snapshotIdUtils.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="targetid"></a> `targetId` | `number` | The referenced entity id that falls outside the id map. | [prefab/snapshotIdUtils.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="entityid"></a> `entityId` | `number` | Entity id (in the INPUT snapshot's id space) holding the reference. | [prefab/snapshotIdUtils.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L27) |
|
|
25
|
+
| <a id="component"></a> `component` | `string` | - | [prefab/snapshotIdUtils.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L28) |
|
|
26
|
+
| <a id="path"></a> `path` | `string` | Slash-separated path of the reference inside the component value. | [prefab/snapshotIdUtils.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L30) |
|
|
27
|
+
| <a id="targetid"></a> `targetId` | `number` | The referenced entity id that falls outside the id map. | [prefab/snapshotIdUtils.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L32) |
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / HandMaterialOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: HandMaterialOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type HandMaterialOptions = {
|
|
11
|
+
color: string;
|
|
12
|
+
opacity: number;
|
|
13
|
+
emissiveIntensity: number;
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [xr/handPresets.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPresets.ts#L13)
|
|
18
|
+
|
|
19
|
+
Materials for tracked-hand meshes.
|
|
20
|
+
|
|
21
|
+
three's `XRHandModelFactory` builds the joint geometry but gives it a plain
|
|
22
|
+
default material, so hands look identical in every experience. These presets
|
|
23
|
+
let an author pick a look in one click, with `custom` deferring entirely to
|
|
24
|
+
the colour/opacity/emissive fields.
|
|
25
|
+
|
|
26
|
+
## Properties
|
|
27
|
+
|
|
28
|
+
| Property | Type | Defined in |
|
|
29
|
+
| ------ | ------ | ------ |
|
|
30
|
+
| <a id="color"></a> `color` | `string` | [xr/handPresets.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPresets.ts#L14) |
|
|
31
|
+
| <a id="opacity"></a> `opacity` | `number` | [xr/handPresets.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPresets.ts#L15) |
|
|
32
|
+
| <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | [xr/handPresets.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPresets.ts#L16) |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / HandPoseTrackerOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: HandPoseTrackerOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type HandPoseTrackerOptions = {
|
|
11
|
+
enterConfidence?: number;
|
|
12
|
+
exitConfidence?: number;
|
|
13
|
+
minHoldSeconds?: number;
|
|
14
|
+
lostGraceSeconds?: number;
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [xr/handPose.ts:742](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L742)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
| Property | Type | Description | Defined in |
|
|
23
|
+
| ------ | ------ | ------ | ------ |
|
|
24
|
+
| <a id="enterconfidence"></a> `enterConfidence?` | `number` | Confidence needed to begin holding. | [xr/handPose.ts:744](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L744) |
|
|
25
|
+
| <a id="exitconfidence"></a> `exitConfidence?` | `number` | Confidence below which an active pose ends. Must be < enter. | [xr/handPose.ts:746](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L746) |
|
|
26
|
+
| <a id="minholdseconds"></a> `minHoldSeconds?` | `number` | Seconds the pose must be held before it fires. | [xr/handPose.ts:748](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L748) |
|
|
27
|
+
| <a id="lostgraceseconds"></a> `lostGraceSeconds?` | `number` | Grace period before tracking loss ends an active pose. | [xr/handPose.ts:750](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L750) |
|
|
@@ -13,7 +13,7 @@ type HydrateOptions = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [hydration/types.ts:
|
|
16
|
+
Defined in: [hydration/types.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L87)
|
|
17
17
|
|
|
18
18
|
Optional behavior tweaks for [hydrateWorldFromSnapshotDetailed](../functions/hydrateWorldFromSnapshotDetailed.md).
|
|
19
19
|
Defaults preserve the historical full-world-load behavior; prefab/subtree
|
|
@@ -23,5 +23,5 @@ instantiation passes stricter options.
|
|
|
23
23
|
|
|
24
24
|
| Property | Type | Description | Defined in |
|
|
25
25
|
| ------ | ------ | ------ | ------ |
|
|
26
|
-
| <a id="assignprimarycamera"></a> `assignPrimaryCamera?` | `boolean` | When false, no camera in the snapshot is promoted to the world camera. Defaults to true (full scene loads want their default camera active); prefab spawns pass false so a spawned camera never hijacks the view. | [hydration/types.ts:
|
|
27
|
-
| <a id="applytransformsscope"></a> `applyTransformsScope?` | `"world"` \| `"created"` | "world" (default) re-applies local transforms for every entity in the world after parent links restore — correct for full scene loads. "created" limits the pass to entities created by THIS hydrate call, so mid-session spawns don't touch unrelated live entities. | [hydration/types.ts:
|
|
26
|
+
| <a id="assignprimarycamera"></a> `assignPrimaryCamera?` | `boolean` | When false, no camera in the snapshot is promoted to the world camera. Defaults to true (full scene loads want their default camera active); prefab spawns pass false so a spawned camera never hijacks the view. | [hydration/types.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L93) |
|
|
27
|
+
| <a id="applytransformsscope"></a> `applyTransformsScope?` | `"world"` \| `"created"` | "world" (default) re-applies local transforms for every entity in the world after parent links restore — correct for full scene loads. "created" limits the pass to entities created by THIS hydrate call, so mid-session spawns don't touch unrelated live entities. | [hydration/types.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L100) |
|
|
@@ -14,12 +14,12 @@ type HydrateWorldFromSnapshotResult = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [hydration/types.ts:
|
|
17
|
+
Defined in: [hydration/types.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L75)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="restoredcount"></a> `restoredCount` | `number` | - | [hydration/types.ts:
|
|
24
|
-
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | - | [hydration/types.ts:
|
|
25
|
-
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → created live entity id for every hydrated entity. | [hydration/types.ts:
|
|
23
|
+
| <a id="restoredcount"></a> `restoredCount` | `number` | - | [hydration/types.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L76) |
|
|
24
|
+
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | - | [hydration/types.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L77) |
|
|
25
|
+
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → created live entity id for every hydrated entity. | [hydration/types.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/types.ts#L79) |
|
|
@@ -13,11 +13,11 @@ type InstantiateSubtreeResult = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [prefab/instantiateSubtree.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [prefab/instantiateSubtree.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/instantiateSubtree.ts#L21)
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
20
|
| Property | Type | Description | Defined in |
|
|
21
21
|
| ------ | ------ | ------ | ------ |
|
|
22
|
-
| <a id="rootid"></a> `rootId` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Live entity id of the subtree root, or null when nothing hydrated. | [prefab/instantiateSubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → live entity id. | [prefab/instantiateSubtree.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
| <a id="rootid"></a> `rootId` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Live entity id of the subtree root, or null when nothing hydrated. | [prefab/instantiateSubtree.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/instantiateSubtree.ts#L23) |
|
|
23
|
+
| <a id="idmap"></a> `idMap` | `Map`\<`number`, `number`\> | Snapshot entity id → live entity id. | [prefab/instantiateSubtree.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/instantiateSubtree.ts#L25) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type KeyboardKey = typeof KeyboardKeys[keyof typeof KeyboardKeys];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/keyboardKeys.ts#L92)
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type ModuleLoader = (scriptUrl) => Promise<Record<string, unknown>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/scriptShared.ts:
|
|
13
|
+
Defined in: [systems/scriptShared.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/scriptShared.ts#L17)
|
|
14
14
|
|
|
15
15
|
Resolves a script URL to its ES module namespace.
|
|
16
16
|
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type MouseButton = "left" | "middle" | "right";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/InputSystem.ts#L9)
|
|
@@ -15,13 +15,13 @@ type NestedRegion = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [prefab/nodeKeys.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [prefab/nodeKeys.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L194)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Defined in |
|
|
23
23
|
| ------ | ------ | ------ |
|
|
24
|
-
| <a id="rootentityid"></a> `rootEntityId` | `number` | [prefab/nodeKeys.ts:195](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="url"></a> `url` | `string` | [prefab/nodeKeys.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="instanceid"></a> `instanceId` | `string` | [prefab/nodeKeys.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="overrides"></a> `overrides` | `string`[] | [prefab/nodeKeys.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="rootentityid"></a> `rootEntityId` | `number` | [prefab/nodeKeys.ts:195](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L195) |
|
|
25
|
+
| <a id="url"></a> `url` | `string` | [prefab/nodeKeys.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L196) |
|
|
26
|
+
| <a id="instanceid"></a> `instanceId` | `string` | [prefab/nodeKeys.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L197) |
|
|
27
|
+
| <a id="overrides"></a> `overrides` | `string`[] | [prefab/nodeKeys.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L198) |
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/overrides.ts#L47) |
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/types.ts#L25) |
|
|
@@ -12,10 +12,10 @@ type RemapSnapshotOptions = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [prefab/snapshotIdUtils.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
Defined in: [prefab/snapshotIdUtils.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L35)
|
|
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:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
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:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/snapshotIdUtils.ts#L43) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / RendererKind
|
|
6
|
+
|
|
7
|
+
# Type Alias: RendererKind
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type RendererKind = "webgl" | "webgpu";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: render/RenderBackend.ts:16
|
|
14
|
+
|
|
15
|
+
Which renderer family a world is drawing with.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ScriptBehaviourSystemOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: ScriptBehaviourSystemOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ScriptBehaviourSystemOptions = {
|
|
11
|
+
errorRetryDelay?: number;
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Defined in: [systems/ScriptBehaviourSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L31)
|
|
16
|
+
|
|
17
|
+
Options for [ScriptBehaviourSystem](../classes/ScriptBehaviourSystem.md).
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
| Property | Type | Description | Defined in |
|
|
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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/ScriptBehaviourSystem.ts#L36) |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ScriptErrorEvent
|
|
6
|
+
|
|
7
|
+
# Type Alias: ScriptErrorEvent
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ScriptErrorEvent = {
|
|
11
|
+
entityId: number;
|
|
12
|
+
entityName: string;
|
|
13
|
+
scriptUrl: string;
|
|
14
|
+
className: string;
|
|
15
|
+
phase: ScriptErrorPhase;
|
|
16
|
+
message: string;
|
|
17
|
+
stack?: string;
|
|
18
|
+
source: ScriptErrorSource;
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Defined in: scriptErrors.ts:26
|
|
23
|
+
|
|
24
|
+
Emitted by `world.onScriptError(...)` the first time a distinct script error
|
|
25
|
+
occurs. "Distinct" is the combination of script URL, class name, phase and
|
|
26
|
+
message: ten enemies running the same broken script report once.
|
|
27
|
+
|
|
28
|
+
## Properties
|
|
29
|
+
|
|
30
|
+
| Property | Type | Description | Defined in |
|
|
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 |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / ScriptErrorListener
|
|
6
|
+
|
|
7
|
+
# Type Alias: ScriptErrorListener
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ScriptErrorListener = (event) => void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: scriptErrors.ts:46
|
|
14
|
+
|
|
15
|
+
Listener registered with `world.onScriptError(...)`.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type |
|
|
20
|
+
| ------ | ------ |
|
|
21
|
+
| `event` | [`ScriptErrorEvent`](ScriptErrorEvent.md) |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`void`
|