@relu-interactives/spatial-ecs 0.11.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{System-BldSHxZV.d.cts → System-D8vm-Jvv.d.cts} +110 -3
- package/dist/{System-CADhPyQs.d.ts → System-ttkDQCrj.d.ts} +110 -3
- package/dist/{XRHandPose-D3Ab1Dfs.d.cts → XRHandPose-C97XVW2R.d.cts} +2 -41
- package/dist/{XRHandPose-BNSwd1y9.d.ts → XRHandPose-CxXtWF1y.d.ts} +2 -41
- package/dist/animation/index.cjs +33 -1
- package/dist/animation/index.cjs.map +1 -1
- package/dist/animation/index.js +1 -1
- package/dist/{chunk-TY3XCHOR.js → chunk-2DJBNWBB.js} +56 -15
- package/dist/chunk-2DJBNWBB.js.map +1 -0
- package/dist/{chunk-WWP46AEF.js → chunk-4FHJA6U4.js} +8 -4
- package/dist/chunk-4FHJA6U4.js.map +1 -0
- package/dist/{chunk-GSWC6LLD.js → chunk-GMSFEXUZ.js} +35 -3
- package/dist/chunk-GMSFEXUZ.js.map +1 -0
- package/dist/{chunk-JEPUCLZX.js → chunk-QAZCVCMP.js} +88 -27
- package/dist/chunk-QAZCVCMP.js.map +1 -0
- package/dist/{chunk-NXASMBDS.js → chunk-SM5KGNYX.js} +4 -4
- package/dist/{chunk-NXASMBDS.js.map → chunk-SM5KGNYX.js.map} +1 -1
- package/dist/{chunk-JNYPJB55.js → chunk-T7SRBLPJ.js} +24 -4
- package/dist/chunk-T7SRBLPJ.js.map +1 -0
- package/dist/components/index.cjs +21 -1
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +3 -3
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +187 -46
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +5 -5
- package/dist/docs/api/Component/classes/Component.md +7 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +20 -19
- package/dist/docs/api/components/classes/BoneAttachmentComponent.md +65 -0
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +3 -3
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/IKComponent.md +59 -0
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +14 -14
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +6 -6
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/NetworkIdentityComponent.md +42 -0
- package/dist/docs/api/components/classes/NetworkSpawnerComponent.md +48 -0
- package/dist/docs/api/components/classes/NetworkTransformComponent.md +51 -0
- package/dist/docs/api/components/classes/NetworkedPropsComponent.md +47 -0
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +7 -7
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +5 -5
- package/dist/docs/api/components/classes/PrefabNode.md +3 -3
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +9 -9
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/UIButtonComponent.md +18 -14
- package/dist/docs/api/components/classes/UIPanelComponent.md +13 -11
- package/dist/docs/api/components/classes/UISliderComponent.md +16 -11
- package/dist/docs/api/components/classes/UITextComponent.md +14 -12
- package/dist/docs/api/components/classes/UIToggleComponent.md +12 -9
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +6 -6
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +3 -3
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +5 -5
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +4 -4
- package/dist/docs/api/components/classes/XRInteractableComponent.md +28 -28
- package/dist/docs/api/components/classes/XRInteractorComponent.md +10 -10
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +3 -3
- package/dist/docs/api/components/classes/XRRigComponent.md +17 -17
- package/dist/docs/api/components/functions/createAttachPoint.md +1 -1
- package/dist/docs/api/components/functions/createHandPoseEntry.md +1 -1
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +1 -1
- package/dist/docs/api/components/functions/normalizeBoneHold.md +25 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +1 -1
- package/dist/docs/api/components/functions/normalizeIKChain.md +25 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +1 -1
- package/dist/docs/api/components/index.md +18 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/BoneAttachmentOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/BoneHold.md +34 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentLightingState.md +9 -9
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +6 -6
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +1 -1
- package/dist/docs/api/components/type-aliases/IKChain.md +37 -0
- package/dist/docs/api/components/type-aliases/IKLimb.md +15 -0
- package/dist/docs/api/components/type-aliases/IKOptions.md +27 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightShadowState.md +8 -8
- package/dist/docs/api/components/type-aliases/LightValueState.md +12 -12
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/ModelLoadState.md +1 -1
- package/dist/docs/api/components/type-aliases/NetValue.md +23 -0
- package/dist/docs/api/components/type-aliases/NetworkTransformOptions.md +18 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -8
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +1 -1
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/UIButtonOptions.md +21 -13
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +14 -10
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +20 -10
- package/dist/docs/api/components/type-aliases/UITextOptions.md +15 -11
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +14 -8
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +1 -1
- package/dist/docs/api/components/type-aliases/UiIconPosition.md +13 -0
- package/dist/docs/api/components/type-aliases/UiSliderVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiToggleVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +5 -5
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +1 -1
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +2 -2
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +27 -27
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +16 -16
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +13 -13
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +1 -1
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +12 -12
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +1 -1
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_CURLS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/components/variables/MODEL_NO_PATH_MESSAGE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioMixer.md +161 -0
- package/dist/docs/api/index/classes/AudioSystem.md +138 -4
- package/dist/docs/api/index/classes/BoneHoldSystem.md +54 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +6 -6
- package/dist/docs/api/index/classes/IKSystem.md +98 -0
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +269 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +4 -4
- package/dist/docs/api/index/classes/ScriptObject.md +10 -10
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +6 -6
- package/dist/docs/api/index/classes/SlotChooser.md +59 -0
- package/dist/docs/api/index/classes/TeleportAimGate.md +4 -4
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +4 -4
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +3 -3
- package/dist/docs/api/index/classes/UIPanelSystem.md +4 -4
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +168 -98
- package/dist/docs/api/index/classes/XRAnchorSystem.md +4 -4
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +7 -7
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +5 -5
- package/dist/docs/api/index/classes/XRHitTestSystem.md +4 -4
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XRInputSystem.md +9 -9
- package/dist/docs/api/index/classes/XRInteractionSystem.md +18 -18
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +7 -7
- package/dist/docs/api/index/classes/XRSessionSystem.md +6 -6
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +4 -4
- package/dist/docs/api/index/functions/angularVelocityFrom.md +1 -1
- package/dist/docs/api/index/functions/applyHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +1 -1
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +1 -1
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/clearModelCache.md +1 -1
- package/dist/docs/api/index/functions/clearPrefabCache.md +1 -1
- package/dist/docs/api/index/functions/cloneHandPose.md +1 -1
- package/dist/docs/api/index/functions/collectDiffPaths.md +1 -1
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +1 -1
- package/dist/docs/api/index/functions/collectEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +1 -1
- package/dist/docs/api/index/functions/computeFingerCurl.md +1 -1
- package/dist/docs/api/index/functions/computeHandShape.md +1 -1
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +1 -1
- package/dist/docs/api/index/functions/computePalmWidth.md +1 -1
- package/dist/docs/api/index/functions/computePinch.md +1 -1
- package/dist/docs/api/index/functions/computeSpread.md +1 -1
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createBoneAttachmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createGLTFLoader.md +30 -0
- package/dist/docs/api/index/functions/createHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/createIKComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createNetworkIdentityComponent.md +24 -0
- package/dist/docs/api/index/functions/createNetworkSpawnerComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkedPropsComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +1 -1
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIButtonComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIPanelComponent.md +1 -1
- package/dist/docs/api/index/functions/createUISliderComponent.md +1 -1
- package/dist/docs/api/index/functions/createUITextComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIToggleComponent.md +1 -1
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRRigComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/despawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/encodeOverride.md +1 -1
- package/dist/docs/api/index/functions/estimateHandScale.md +1 -1
- package/dist/docs/api/index/functions/findModelBone.md +30 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +1 -1
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +1 -1
- package/dist/docs/api/index/functions/getHandPosePreset.md +1 -1
- package/dist/docs/api/index/functions/gripQuaternion.md +36 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +1 -1
- package/dist/docs/api/index/functions/instantiateSubtree.md +1 -1
- package/dist/docs/api/index/functions/listModelBones.md +25 -0
- package/dist/docs/api/index/functions/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +1 -1
- package/dist/docs/api/index/functions/mergeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/parseOverride.md +1 -1
- package/dist/docs/api/index/functions/parsePrefabAsset.md +1 -1
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +1 -1
- package/dist/docs/api/index/functions/readXrCapabilities.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +3 -3
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/restoreComponentState.md +1 -1
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +1 -1
- package/dist/docs/api/index/functions/sampleTeleportArc.md +1 -1
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +1 -1
- package/dist/docs/api/index/functions/setWorldQuaternion.md +26 -0
- package/dist/docs/api/index/functions/soundBankFiles.md +25 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/twoBoneIK.md +41 -0
- package/dist/docs/api/index/index.md +31 -0
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +5 -5
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/NetworkHandle.md +180 -0
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +6 -6
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +5 -5
- package/dist/docs/api/index/interfaces/RenderBackend.md +8 -8
- package/dist/docs/api/index/interfaces/SoundBankAsset.md +18 -0
- package/dist/docs/api/index/interfaces/SoundSlot.md +31 -0
- package/dist/docs/api/index/interfaces/SoundTake.md +18 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +3 -3
- package/dist/docs/api/index/type-aliases/AudioBus.md +15 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -38
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +7 -1
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +1 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +5 -5
- package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +4 -4
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +3 -3
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +4 -4
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +3 -3
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModelBoneInfo.md +29 -0
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +1 -1
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +5 -5
- package/dist/docs/api/index/type-aliases/NetSpawnOptions.md +41 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- package/dist/docs/api/index/type-aliases/PlaySlotOptions.md +32 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +5 -5
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/RendererKind.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +9 -9
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +6 -6
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +4 -4
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +4 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +4 -4
- package/dist/docs/api/index/type-aliases/UiColorStop.md +37 -0
- package/dist/docs/api/index/type-aliases/UiPaint.md +81 -0
- package/dist/docs/api/index/type-aliases/UiShadow.md +27 -0
- package/dist/docs/api/index/type-aliases/UiStyle.md +43 -0
- package/dist/docs/api/index/type-aliases/UiTextStyle.md +33 -0
- package/dist/docs/api/index/type-aliases/UiTokens.md +13 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +3 -3
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +9 -9
- package/dist/docs/api/index/type-aliases/XrFinger.md +1 -1
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +4 -4
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +6 -6
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +2 -2
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +11 -11
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +5 -5
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandShape.md +13 -13
- package/dist/docs/api/index/type-aliases/XrHandedness.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHitResult.md +3 -3
- package/dist/docs/api/index/type-aliases/XrInputKind.md +1 -1
- package/dist/docs/api/index/type-aliases/XrInputState.md +18 -18
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +6 -6
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +1 -1
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +1 -1
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +1 -1
- package/dist/docs/api/index/variables/ARC_SPEED.md +1 -1
- package/dist/docs/api/index/variables/ARC_STEPS.md +1 -1
- package/dist/docs/api/index/variables/CURLED_COS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +1 -1
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +1 -1
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/MATCH_FALLOFF.md +1 -1
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +1 -1
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/PINCH_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +1 -1
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +1 -1
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +1 -1
- package/dist/docs/api/index/variables/STRAIGHT_COS.md +1 -1
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +1 -1
- package/dist/docs/api/index/variables/XR_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +1 -1
- package/dist/docs/api/index/variables/webglBackend.md +1 -1
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +1 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/bone-attachments-and-ik.md +51 -0
- package/dist/docs/guide/components/audio.md +1 -1
- package/dist/factories/index.cjs +29 -1
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +2 -2
- package/dist/factories/index.d.ts +2 -2
- package/dist/factories/index.js +4 -4
- package/dist/{index-BXjwEdNq.d.cts → index-BbrnjNXy.d.ts} +5 -3
- package/dist/{index-CVG-hREM.d.ts → index-DD7aHv0p.d.cts} +5 -3
- package/dist/{index-6pZO_gV7.d.ts → index-OgOoIpEI.d.ts} +14 -2
- package/dist/{index-BdghvXKE.d.cts → index-xyqzT0PQ.d.cts} +14 -2
- package/dist/index.cjs +174 -13
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +13 -11
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +70 -38
- package/dist/network/index.cjs.map +1 -1
- package/dist/network/index.d.cts +2 -2
- package/dist/network/index.d.ts +2 -2
- package/dist/network/index.js +4 -4
- package/dist/systems/index.cjs +171 -13
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +2 -2
- package/dist/systems/index.d.ts +2 -2
- package/dist/systems/index.js +5 -5
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/webgpu/index.d.ts +2 -2
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +2 -1
- package/dist/chunk-GSWC6LLD.js.map +0 -1
- package/dist/chunk-JEPUCLZX.js.map +0 -1
- package/dist/chunk-JNYPJB55.js.map +0 -1
- package/dist/chunk-TY3XCHOR.js.map +0 -1
- package/dist/chunk-WWP46AEF.js.map +0 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: World
|
|
8
8
|
|
|
9
|
-
Defined in: [World.ts:
|
|
9
|
+
Defined in: [World.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L91)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [World.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-
|
|
|
16
16
|
new World(options): World;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [World.ts:
|
|
19
|
+
Defined in: [World.ts:139](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L139)
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
@@ -41,7 +41,7 @@ Defined in: [World.ts:133](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
41
41
|
createEntity(): number;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [World.ts:
|
|
44
|
+
Defined in: [World.ts:163](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L163)
|
|
45
45
|
|
|
46
46
|
#### Returns
|
|
47
47
|
|
|
@@ -55,7 +55,7 @@ Defined in: [World.ts:157](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
55
55
|
destroyEntity(entityId): void;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [World.ts:
|
|
58
|
+
Defined in: [World.ts:171](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L171)
|
|
59
59
|
|
|
60
60
|
#### Parameters
|
|
61
61
|
|
|
@@ -75,7 +75,7 @@ Defined in: [World.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
75
75
|
hasEntity(entityId): boolean;
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Defined in: [World.ts:
|
|
78
|
+
Defined in: [World.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L198)
|
|
79
79
|
|
|
80
80
|
#### Parameters
|
|
81
81
|
|
|
@@ -95,7 +95,7 @@ Defined in: [World.ts:192](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
95
95
|
getEntities(): number[];
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Defined in: [World.ts:
|
|
98
|
+
Defined in: [World.ts:202](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L202)
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -109,7 +109,7 @@ Defined in: [World.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
109
109
|
getEntityCount(): number;
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
Defined in: [World.ts:
|
|
112
|
+
Defined in: [World.ts:206](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L206)
|
|
113
113
|
|
|
114
114
|
#### Returns
|
|
115
115
|
|
|
@@ -123,7 +123,7 @@ Defined in: [World.ts:200](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
123
123
|
addComponent<T>(entityId, component): void;
|
|
124
124
|
```
|
|
125
125
|
|
|
126
|
-
Defined in: [World.ts:
|
|
126
|
+
Defined in: [World.ts:210](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L210)
|
|
127
127
|
|
|
128
128
|
#### Type Parameters
|
|
129
129
|
|
|
@@ -150,7 +150,7 @@ Defined in: [World.ts:204](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
150
150
|
addComponents<T>(entityId, components): void;
|
|
151
151
|
```
|
|
152
152
|
|
|
153
|
-
Defined in: [World.ts:
|
|
153
|
+
Defined in: [World.ts:225](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L225)
|
|
154
154
|
|
|
155
155
|
#### Type Parameters
|
|
156
156
|
|
|
@@ -177,7 +177,7 @@ Defined in: [World.ts:219](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
177
177
|
removeComponent<T>(entityId, componentType): void;
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
Defined in: [World.ts:
|
|
180
|
+
Defined in: [World.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L246)
|
|
181
181
|
|
|
182
182
|
#### Type Parameters
|
|
183
183
|
|
|
@@ -204,7 +204,7 @@ Defined in: [World.ts:240](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
204
204
|
getComponent<T>(entityId, componentType): T | undefined;
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
Defined in: [World.ts:
|
|
207
|
+
Defined in: [World.ts:254](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L254)
|
|
208
208
|
|
|
209
209
|
#### Type Parameters
|
|
210
210
|
|
|
@@ -231,7 +231,7 @@ Defined in: [World.ts:248](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
231
231
|
hasComponent<T>(entityId, componentType): boolean;
|
|
232
232
|
```
|
|
233
233
|
|
|
234
|
-
Defined in: [World.ts:
|
|
234
|
+
Defined in: [World.ts:261](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L261)
|
|
235
235
|
|
|
236
236
|
#### Type Parameters
|
|
237
237
|
|
|
@@ -258,7 +258,7 @@ Defined in: [World.ts:255](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
258
258
|
query(...componentTypes): number[];
|
|
259
259
|
```
|
|
260
260
|
|
|
261
|
-
Defined in: [World.ts:
|
|
261
|
+
Defined in: [World.ts:268](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L268)
|
|
262
262
|
|
|
263
263
|
#### Parameters
|
|
264
264
|
|
|
@@ -278,7 +278,7 @@ Defined in: [World.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
278
278
|
isEntityVisible(entityId): boolean;
|
|
279
279
|
```
|
|
280
280
|
|
|
281
|
-
Defined in: [World.ts:
|
|
281
|
+
Defined in: [World.ts:282](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L282)
|
|
282
282
|
|
|
283
283
|
Returns `true` if the entity is currently visible (its `Object3DRef.visibility`
|
|
284
284
|
is `true`), or if the entity has no `Object3DRef` component (entities without a
|
|
@@ -303,7 +303,7 @@ updates for hidden objects.
|
|
|
303
303
|
getInputSystem(): EcsSystem | null;
|
|
304
304
|
```
|
|
305
305
|
|
|
306
|
-
Defined in: [World.ts:
|
|
306
|
+
Defined in: [World.ts:287](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L287)
|
|
307
307
|
|
|
308
308
|
#### Returns
|
|
309
309
|
|
|
@@ -317,7 +317,7 @@ Defined in: [World.ts:281](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
317
317
|
getKeyDown(key): boolean;
|
|
318
318
|
```
|
|
319
319
|
|
|
320
|
-
Defined in: [World.ts:
|
|
320
|
+
Defined in: [World.ts:299](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L299)
|
|
321
321
|
|
|
322
322
|
#### Parameters
|
|
323
323
|
|
|
@@ -337,7 +337,7 @@ Defined in: [World.ts:293](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
337
337
|
getKeyUp(key): boolean;
|
|
338
338
|
```
|
|
339
339
|
|
|
340
|
-
Defined in: [World.ts:
|
|
340
|
+
Defined in: [World.ts:308](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L308)
|
|
341
341
|
|
|
342
342
|
#### Parameters
|
|
343
343
|
|
|
@@ -357,7 +357,7 @@ Defined in: [World.ts:302](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
357
357
|
getKey(key): boolean;
|
|
358
358
|
```
|
|
359
359
|
|
|
360
|
-
Defined in: [World.ts:
|
|
360
|
+
Defined in: [World.ts:317](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L317)
|
|
361
361
|
|
|
362
362
|
#### Parameters
|
|
363
363
|
|
|
@@ -377,7 +377,7 @@ Defined in: [World.ts:311](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
377
377
|
getMouse(button): boolean;
|
|
378
378
|
```
|
|
379
379
|
|
|
380
|
-
Defined in: [World.ts:
|
|
380
|
+
Defined in: [World.ts:326](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L326)
|
|
381
381
|
|
|
382
382
|
#### Parameters
|
|
383
383
|
|
|
@@ -397,7 +397,7 @@ Defined in: [World.ts:320](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
397
397
|
getMouseDown(button): boolean;
|
|
398
398
|
```
|
|
399
399
|
|
|
400
|
-
Defined in: [World.ts:
|
|
400
|
+
Defined in: [World.ts:335](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L335)
|
|
401
401
|
|
|
402
402
|
#### Parameters
|
|
403
403
|
|
|
@@ -417,7 +417,7 @@ Defined in: [World.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
417
417
|
getMouseUp(button): boolean;
|
|
418
418
|
```
|
|
419
419
|
|
|
420
|
-
Defined in: [World.ts:
|
|
420
|
+
Defined in: [World.ts:344](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L344)
|
|
421
421
|
|
|
422
422
|
#### Parameters
|
|
423
423
|
|
|
@@ -437,7 +437,7 @@ Defined in: [World.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
437
437
|
getScrollClick(): boolean;
|
|
438
438
|
```
|
|
439
439
|
|
|
440
|
-
Defined in: [World.ts:
|
|
440
|
+
Defined in: [World.ts:353](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L353)
|
|
441
441
|
|
|
442
442
|
#### Returns
|
|
443
443
|
|
|
@@ -451,7 +451,7 @@ Defined in: [World.ts:347](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
451
451
|
getScrollClickDown(): boolean;
|
|
452
452
|
```
|
|
453
453
|
|
|
454
|
-
Defined in: [World.ts:
|
|
454
|
+
Defined in: [World.ts:362](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L362)
|
|
455
455
|
|
|
456
456
|
#### Returns
|
|
457
457
|
|
|
@@ -465,7 +465,7 @@ Defined in: [World.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
465
465
|
getScrollClickUp(): boolean;
|
|
466
466
|
```
|
|
467
467
|
|
|
468
|
-
Defined in: [World.ts:
|
|
468
|
+
Defined in: [World.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L371)
|
|
469
469
|
|
|
470
470
|
#### Returns
|
|
471
471
|
|
|
@@ -482,7 +482,7 @@ getScrollDelta(): {
|
|
|
482
482
|
};
|
|
483
483
|
```
|
|
484
484
|
|
|
485
|
-
Defined in: [World.ts:
|
|
485
|
+
Defined in: [World.ts:380](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L380)
|
|
486
486
|
|
|
487
487
|
#### Returns
|
|
488
488
|
|
|
@@ -495,8 +495,8 @@ Defined in: [World.ts:374](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
495
495
|
|
|
496
496
|
| Name | Type | Defined in |
|
|
497
497
|
| ------ | ------ | ------ |
|
|
498
|
-
| `x` | `number` | [World.ts:
|
|
499
|
-
| `y` | `number` | [World.ts:
|
|
498
|
+
| `x` | `number` | [World.ts:380](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L380) |
|
|
499
|
+
| `y` | `number` | [World.ts:380](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L380) |
|
|
500
500
|
|
|
501
501
|
***
|
|
502
502
|
|
|
@@ -509,7 +509,7 @@ consumeScrollDelta(): {
|
|
|
509
509
|
};
|
|
510
510
|
```
|
|
511
511
|
|
|
512
|
-
Defined in: [World.ts:
|
|
512
|
+
Defined in: [World.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L389)
|
|
513
513
|
|
|
514
514
|
#### Returns
|
|
515
515
|
|
|
@@ -522,8 +522,8 @@ Defined in: [World.ts:383](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
522
522
|
|
|
523
523
|
| Name | Type | Defined in |
|
|
524
524
|
| ------ | ------ | ------ |
|
|
525
|
-
| `x` | `number` | [World.ts:
|
|
526
|
-
| `y` | `number` | [World.ts:
|
|
525
|
+
| `x` | `number` | [World.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L389) |
|
|
526
|
+
| `y` | `number` | [World.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L389) |
|
|
527
527
|
|
|
528
528
|
***
|
|
529
529
|
|
|
@@ -536,7 +536,7 @@ getMousePosition(): {
|
|
|
536
536
|
};
|
|
537
537
|
```
|
|
538
538
|
|
|
539
|
-
Defined in: [World.ts:
|
|
539
|
+
Defined in: [World.ts:398](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L398)
|
|
540
540
|
|
|
541
541
|
#### Returns
|
|
542
542
|
|
|
@@ -549,8 +549,8 @@ Defined in: [World.ts:392](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
549
549
|
|
|
550
550
|
| Name | Type | Defined in |
|
|
551
551
|
| ------ | ------ | ------ |
|
|
552
|
-
| `x` | `number` | [World.ts:
|
|
553
|
-
| `y` | `number` | [World.ts:
|
|
552
|
+
| `x` | `number` | [World.ts:398](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L398) |
|
|
553
|
+
| `y` | `number` | [World.ts:398](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L398) |
|
|
554
554
|
|
|
555
555
|
***
|
|
556
556
|
|
|
@@ -563,7 +563,7 @@ getMouseDelta(): {
|
|
|
563
563
|
};
|
|
564
564
|
```
|
|
565
565
|
|
|
566
|
-
Defined in: [World.ts:
|
|
566
|
+
Defined in: [World.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L407)
|
|
567
567
|
|
|
568
568
|
#### Returns
|
|
569
569
|
|
|
@@ -576,8 +576,8 @@ Defined in: [World.ts:401](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
576
576
|
|
|
577
577
|
| Name | Type | Defined in |
|
|
578
578
|
| ------ | ------ | ------ |
|
|
579
|
-
| `x` | `number` | [World.ts:
|
|
580
|
-
| `y` | `number` | [World.ts:
|
|
579
|
+
| `x` | `number` | [World.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L407) |
|
|
580
|
+
| `y` | `number` | [World.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L407) |
|
|
581
581
|
|
|
582
582
|
***
|
|
583
583
|
|
|
@@ -590,7 +590,7 @@ consumeMouseDelta(): {
|
|
|
590
590
|
};
|
|
591
591
|
```
|
|
592
592
|
|
|
593
|
-
Defined in: [World.ts:
|
|
593
|
+
Defined in: [World.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L416)
|
|
594
594
|
|
|
595
595
|
#### Returns
|
|
596
596
|
|
|
@@ -603,8 +603,8 @@ Defined in: [World.ts:410](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
603
603
|
|
|
604
604
|
| Name | Type | Defined in |
|
|
605
605
|
| ------ | ------ | ------ |
|
|
606
|
-
| `x` | `number` | [World.ts:
|
|
607
|
-
| `y` | `number` | [World.ts:
|
|
606
|
+
| `x` | `number` | [World.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L416) |
|
|
607
|
+
| `y` | `number` | [World.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L416) |
|
|
608
608
|
|
|
609
609
|
***
|
|
610
610
|
|
|
@@ -614,7 +614,7 @@ Defined in: [World.ts:410](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
614
614
|
getRapierModule(): Promise<__module>;
|
|
615
615
|
```
|
|
616
616
|
|
|
617
|
-
Defined in: [World.ts:
|
|
617
|
+
Defined in: [World.ts:425](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L425)
|
|
618
618
|
|
|
619
619
|
#### Returns
|
|
620
620
|
|
|
@@ -628,7 +628,7 @@ Defined in: [World.ts:419](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
628
628
|
getPhysicsWorld(): World | null;
|
|
629
629
|
```
|
|
630
630
|
|
|
631
|
-
Defined in: [World.ts:
|
|
631
|
+
Defined in: [World.ts:443](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L443)
|
|
632
632
|
|
|
633
633
|
#### Returns
|
|
634
634
|
|
|
@@ -642,7 +642,7 @@ Defined in: [World.ts:437](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
642
642
|
setPhysicsWorld(physicsWorld): void;
|
|
643
643
|
```
|
|
644
644
|
|
|
645
|
-
Defined in: [World.ts:
|
|
645
|
+
Defined in: [World.ts:447](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L447)
|
|
646
646
|
|
|
647
647
|
#### Parameters
|
|
648
648
|
|
|
@@ -662,7 +662,7 @@ Defined in: [World.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
662
662
|
createPhysicsWorld(options?): Promise<World | null>;
|
|
663
663
|
```
|
|
664
664
|
|
|
665
|
-
Defined in: [World.ts:
|
|
665
|
+
Defined in: [World.ts:451](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L451)
|
|
666
666
|
|
|
667
667
|
#### Parameters
|
|
668
668
|
|
|
@@ -686,7 +686,7 @@ Defined in: [World.ts:445](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
686
686
|
lockMousePointer(): boolean;
|
|
687
687
|
```
|
|
688
688
|
|
|
689
|
-
Defined in: [World.ts:
|
|
689
|
+
Defined in: [World.ts:470](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L470)
|
|
690
690
|
|
|
691
691
|
#### Returns
|
|
692
692
|
|
|
@@ -700,7 +700,7 @@ Defined in: [World.ts:464](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
700
700
|
unlockMousePointer(): boolean;
|
|
701
701
|
```
|
|
702
702
|
|
|
703
|
-
Defined in: [World.ts:
|
|
703
|
+
Defined in: [World.ts:501](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L501)
|
|
704
704
|
|
|
705
705
|
#### Returns
|
|
706
706
|
|
|
@@ -714,7 +714,7 @@ Defined in: [World.ts:495](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
714
714
|
isMousePointerLocked(): boolean;
|
|
715
715
|
```
|
|
716
716
|
|
|
717
|
-
Defined in: [World.ts:
|
|
717
|
+
Defined in: [World.ts:522](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L522)
|
|
718
718
|
|
|
719
719
|
#### Returns
|
|
720
720
|
|
|
@@ -728,7 +728,7 @@ Defined in: [World.ts:516](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
728
728
|
getSystem<T>(system): T;
|
|
729
729
|
```
|
|
730
730
|
|
|
731
|
-
Defined in: [World.ts:
|
|
731
|
+
Defined in: [World.ts:538](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L538)
|
|
732
732
|
|
|
733
733
|
#### Type Parameters
|
|
734
734
|
|
|
@@ -754,7 +754,7 @@ Defined in: [World.ts:532](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
754
754
|
hasSystem<T>(system): boolean;
|
|
755
755
|
```
|
|
756
756
|
|
|
757
|
-
Defined in: [World.ts:
|
|
757
|
+
Defined in: [World.ts:555](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L555)
|
|
758
758
|
|
|
759
759
|
#### Type Parameters
|
|
760
760
|
|
|
@@ -780,7 +780,7 @@ Defined in: [World.ts:549](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
780
780
|
addSystem(system): void;
|
|
781
781
|
```
|
|
782
782
|
|
|
783
|
-
Defined in: [World.ts:
|
|
783
|
+
Defined in: [World.ts:564](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L564)
|
|
784
784
|
|
|
785
785
|
#### Parameters
|
|
786
786
|
|
|
@@ -800,7 +800,7 @@ Defined in: [World.ts:558](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
800
800
|
addSystems(systems): void;
|
|
801
801
|
```
|
|
802
802
|
|
|
803
|
-
Defined in: [World.ts:
|
|
803
|
+
Defined in: [World.ts:568](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L568)
|
|
804
804
|
|
|
805
805
|
#### Parameters
|
|
806
806
|
|
|
@@ -824,7 +824,7 @@ setup(__namedParameters): {
|
|
|
824
824
|
};
|
|
825
825
|
```
|
|
826
826
|
|
|
827
|
-
Defined in: [World.ts:
|
|
827
|
+
Defined in: [World.ts:574](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L574)
|
|
828
828
|
|
|
829
829
|
#### Parameters
|
|
830
830
|
|
|
@@ -846,9 +846,9 @@ Defined in: [World.ts:568](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
846
846
|
|
|
847
847
|
| Name | Type | Defined in |
|
|
848
848
|
| ------ | ------ | ------ |
|
|
849
|
-
| `objectManagementSystem` | [`ObjectManagementSystem`](ObjectManagementSystem.md) | [World.ts:
|
|
850
|
-
| `transformSyncSystem` | [`TransformSyncSystem`](TransformSyncSystem.md) | [World.ts:
|
|
851
|
-
| `renderSystem` | [`RenderSystem`](RenderSystem.md) | [World.ts:
|
|
849
|
+
| `objectManagementSystem` | [`ObjectManagementSystem`](ObjectManagementSystem.md) | [World.ts:575](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L575) |
|
|
850
|
+
| `transformSyncSystem` | [`TransformSyncSystem`](TransformSyncSystem.md) | [World.ts:576](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L576) |
|
|
851
|
+
| `renderSystem` | [`RenderSystem`](RenderSystem.md) | [World.ts:577](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L577) |
|
|
852
852
|
|
|
853
853
|
***
|
|
854
854
|
|
|
@@ -858,7 +858,7 @@ Defined in: [World.ts:568](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
858
858
|
isEditorMode(): boolean;
|
|
859
859
|
```
|
|
860
860
|
|
|
861
|
-
Defined in: [World.ts:
|
|
861
|
+
Defined in: [World.ts:686](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L686)
|
|
862
862
|
|
|
863
863
|
#### Returns
|
|
864
864
|
|
|
@@ -872,7 +872,7 @@ Defined in: [World.ts:671](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
872
872
|
isXrPresenting(): boolean;
|
|
873
873
|
```
|
|
874
874
|
|
|
875
|
-
Defined in: [World.ts:
|
|
875
|
+
Defined in: [World.ts:703](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L703)
|
|
876
876
|
|
|
877
877
|
`true` while an immersive WebXR session is actively presenting.
|
|
878
878
|
|
|
@@ -898,7 +898,7 @@ the head pose as `parent.matrixWorld × headPose`.
|
|
|
898
898
|
isXrPassthrough(): boolean;
|
|
899
899
|
```
|
|
900
900
|
|
|
901
|
-
Defined in: [World.ts:
|
|
901
|
+
Defined in: [World.ts:720](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L720)
|
|
902
902
|
|
|
903
903
|
`true` while the session is compositing over the real world (passthrough).
|
|
904
904
|
|
|
@@ -924,7 +924,7 @@ looks exactly like passthrough having failed.
|
|
|
924
924
|
pause(): void;
|
|
925
925
|
```
|
|
926
926
|
|
|
927
|
-
Defined in: [World.ts:
|
|
927
|
+
Defined in: [World.ts:733](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L733)
|
|
928
928
|
|
|
929
929
|
Pauses world simulation. While paused, `update()` skips all system ticks so
|
|
930
930
|
physics, animation, scripts, and rendering stop advancing. The last rendered
|
|
@@ -944,7 +944,7 @@ Call [resume](#resume) to continue.
|
|
|
944
944
|
resume(): void;
|
|
945
945
|
```
|
|
946
946
|
|
|
947
|
-
Defined in: [World.ts:
|
|
947
|
+
Defined in: [World.ts:741](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L741)
|
|
948
948
|
|
|
949
949
|
Resumes world simulation after a previous [pause](#pause) call.
|
|
950
950
|
Has no effect if the world is not paused.
|
|
@@ -961,7 +961,7 @@ Has no effect if the world is not paused.
|
|
|
961
961
|
isPaused(): boolean;
|
|
962
962
|
```
|
|
963
963
|
|
|
964
|
-
Defined in: [World.ts:
|
|
964
|
+
Defined in: [World.ts:755](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L755)
|
|
965
965
|
|
|
966
966
|
Returns `true` if the world is currently paused.
|
|
967
967
|
|
|
@@ -985,7 +985,7 @@ if (this.world.isPaused()) {
|
|
|
985
985
|
getScene(): Scene;
|
|
986
986
|
```
|
|
987
987
|
|
|
988
|
-
Defined in: [World.ts:
|
|
988
|
+
Defined in: [World.ts:759](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L759)
|
|
989
989
|
|
|
990
990
|
#### Returns
|
|
991
991
|
|
|
@@ -999,7 +999,7 @@ Defined in: [World.ts:744](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
999
999
|
getCamera(): PerspectiveCamera;
|
|
1000
1000
|
```
|
|
1001
1001
|
|
|
1002
|
-
Defined in: [World.ts:
|
|
1002
|
+
Defined in: [World.ts:763](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L763)
|
|
1003
1003
|
|
|
1004
1004
|
#### Returns
|
|
1005
1005
|
|
|
@@ -1013,7 +1013,7 @@ Defined in: [World.ts:748](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1013
1013
|
getRenderer(): EcsRenderer;
|
|
1014
1014
|
```
|
|
1015
1015
|
|
|
1016
|
-
Defined in: [World.ts:
|
|
1016
|
+
Defined in: [World.ts:773](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L773)
|
|
1017
1017
|
|
|
1018
1018
|
The renderer this world draws with: a `THREE.WebGLRenderer`, or a
|
|
1019
1019
|
`WebGPURenderer` from `three/webgpu`. Check [getRendererKind](#getrendererkind) before
|
|
@@ -1032,7 +1032,7 @@ WebGL only).
|
|
|
1032
1032
|
getRendererKind(): RendererKind;
|
|
1033
1033
|
```
|
|
1034
1034
|
|
|
1035
|
-
Defined in: [World.ts:
|
|
1035
|
+
Defined in: [World.ts:778](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L778)
|
|
1036
1036
|
|
|
1037
1037
|
`"webgpu"` when the world renders with a `WebGPURenderer`, else `"webgl"`.
|
|
1038
1038
|
|
|
@@ -1048,7 +1048,7 @@ Defined in: [World.ts:763](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1048
1048
|
getRenderBackend(): RenderBackend;
|
|
1049
1049
|
```
|
|
1050
1050
|
|
|
1051
|
-
Defined in: [World.ts:
|
|
1051
|
+
Defined in: [World.ts:786](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L786)
|
|
1052
1052
|
|
|
1053
1053
|
The renderer-specific backend in use (post-processing, green-screen
|
|
1054
1054
|
video, area lights). See `RenderBackend`.
|
|
@@ -1065,7 +1065,7 @@ video, area lights). See `RenderBackend`.
|
|
|
1065
1065
|
update(deltaTime): void;
|
|
1066
1066
|
```
|
|
1067
1067
|
|
|
1068
|
-
Defined in: [World.ts:
|
|
1068
|
+
Defined in: [World.ts:790](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L790)
|
|
1069
1069
|
|
|
1070
1070
|
#### Parameters
|
|
1071
1071
|
|
|
@@ -1085,7 +1085,7 @@ Defined in: [World.ts:775](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1085
1085
|
dispose(): void;
|
|
1086
1086
|
```
|
|
1087
1087
|
|
|
1088
|
-
Defined in: [World.ts:
|
|
1088
|
+
Defined in: [World.ts:797](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L797)
|
|
1089
1089
|
|
|
1090
1090
|
#### Returns
|
|
1091
1091
|
|
|
@@ -1099,7 +1099,7 @@ Defined in: [World.ts:782](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1099
1099
|
setSelectedEntity(entityId): void;
|
|
1100
1100
|
```
|
|
1101
1101
|
|
|
1102
|
-
Defined in: [World.ts:
|
|
1102
|
+
Defined in: [World.ts:811](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L811)
|
|
1103
1103
|
|
|
1104
1104
|
#### Parameters
|
|
1105
1105
|
|
|
@@ -1119,7 +1119,7 @@ Defined in: [World.ts:796](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1119
1119
|
getSelectedEntity(): number | null;
|
|
1120
1120
|
```
|
|
1121
1121
|
|
|
1122
|
-
Defined in: [World.ts:
|
|
1122
|
+
Defined in: [World.ts:833](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L833)
|
|
1123
1123
|
|
|
1124
1124
|
#### Returns
|
|
1125
1125
|
|
|
@@ -1133,7 +1133,7 @@ Defined in: [World.ts:818](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1133
1133
|
getEntitiesByComponent(component): WorldEntityView[];
|
|
1134
1134
|
```
|
|
1135
1135
|
|
|
1136
|
-
Defined in: [World.ts:
|
|
1136
|
+
Defined in: [World.ts:893](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L893)
|
|
1137
1137
|
|
|
1138
1138
|
#### Parameters
|
|
1139
1139
|
|
|
@@ -1153,7 +1153,7 @@ Defined in: [World.ts:878](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1153
1153
|
getEntitiesByName(name): WorldEntityView[];
|
|
1154
1154
|
```
|
|
1155
1155
|
|
|
1156
|
-
Defined in: [World.ts:
|
|
1156
|
+
Defined in: [World.ts:907](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L907)
|
|
1157
1157
|
|
|
1158
1158
|
#### Parameters
|
|
1159
1159
|
|
|
@@ -1173,7 +1173,7 @@ Defined in: [World.ts:892](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1173
1173
|
getEntityByName(name): WorldEntityView | null;
|
|
1174
1174
|
```
|
|
1175
1175
|
|
|
1176
|
-
Defined in: [World.ts:
|
|
1176
|
+
Defined in: [World.ts:916](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L916)
|
|
1177
1177
|
|
|
1178
1178
|
#### Parameters
|
|
1179
1179
|
|
|
@@ -1193,7 +1193,7 @@ Defined in: [World.ts:901](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1193
1193
|
getEntityById(entityId): WorldEntityView | null;
|
|
1194
1194
|
```
|
|
1195
1195
|
|
|
1196
|
-
Defined in: [World.ts:
|
|
1196
|
+
Defined in: [World.ts:921](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L921)
|
|
1197
1197
|
|
|
1198
1198
|
#### Parameters
|
|
1199
1199
|
|
|
@@ -1213,7 +1213,7 @@ Defined in: [World.ts:906](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1213
1213
|
getEntitiesChildren(entityId): WorldEntityView[];
|
|
1214
1214
|
```
|
|
1215
1215
|
|
|
1216
|
-
Defined in: [World.ts:
|
|
1216
|
+
Defined in: [World.ts:929](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L929)
|
|
1217
1217
|
|
|
1218
1218
|
#### Parameters
|
|
1219
1219
|
|
|
@@ -1233,7 +1233,7 @@ Defined in: [World.ts:914](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1233
1233
|
getEntitiesParent(entityId): WorldEntityView | null;
|
|
1234
1234
|
```
|
|
1235
1235
|
|
|
1236
|
-
Defined in: [World.ts:
|
|
1236
|
+
Defined in: [World.ts:943](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L943)
|
|
1237
1237
|
|
|
1238
1238
|
#### Parameters
|
|
1239
1239
|
|
|
@@ -1253,7 +1253,7 @@ Defined in: [World.ts:928](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1253
1253
|
spawnPrefab(source, options?): Promise<number>;
|
|
1254
1254
|
```
|
|
1255
1255
|
|
|
1256
|
-
Defined in: [World.ts:
|
|
1256
|
+
Defined in: [World.ts:958](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L958)
|
|
1257
1257
|
|
|
1258
1258
|
Instantiate a prefab asset into this world at runtime — see
|
|
1259
1259
|
[spawnPrefab](../functions/spawnPrefab.md). Convenience wrapper so scripts and embedding apps
|
|
@@ -1278,7 +1278,7 @@ can spawn without reaching for the object management system.
|
|
|
1278
1278
|
despawnPrefab(rootEntityId): number;
|
|
1279
1279
|
```
|
|
1280
1280
|
|
|
1281
|
-
Defined in: [World.ts:
|
|
1281
|
+
Defined in: [World.ts:966](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L966)
|
|
1282
1282
|
|
|
1283
1283
|
Remove a spawned prefab instance (root + descendants).
|
|
1284
1284
|
|
|
@@ -1294,13 +1294,83 @@ Remove a spawned prefab instance (root + descendants).
|
|
|
1294
1294
|
|
|
1295
1295
|
***
|
|
1296
1296
|
|
|
1297
|
+
### getNetwork()
|
|
1298
|
+
|
|
1299
|
+
```ts
|
|
1300
|
+
getNetwork(): NetworkService | null;
|
|
1301
|
+
```
|
|
1302
|
+
|
|
1303
|
+
Defined in: [World.ts:971](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L971)
|
|
1304
|
+
|
|
1305
|
+
The shared-world connection, or `null` in a single-player run.
|
|
1306
|
+
|
|
1307
|
+
#### Returns
|
|
1308
|
+
|
|
1309
|
+
`NetworkService` \| `null`
|
|
1310
|
+
|
|
1311
|
+
***
|
|
1312
|
+
|
|
1313
|
+
### setNetwork()
|
|
1314
|
+
|
|
1315
|
+
```ts
|
|
1316
|
+
setNetwork(network): void;
|
|
1317
|
+
```
|
|
1318
|
+
|
|
1319
|
+
Defined in: [World.ts:976](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L976)
|
|
1320
|
+
|
|
1321
|
+
Set by `NetworkSystem` when it connects and clears.
|
|
1322
|
+
|
|
1323
|
+
#### Parameters
|
|
1324
|
+
|
|
1325
|
+
| Parameter | Type |
|
|
1326
|
+
| ------ | ------ |
|
|
1327
|
+
| `network` | `NetworkService` \| `null` |
|
|
1328
|
+
|
|
1329
|
+
#### Returns
|
|
1330
|
+
|
|
1331
|
+
`void`
|
|
1332
|
+
|
|
1333
|
+
***
|
|
1334
|
+
|
|
1335
|
+
### getAudioSystem()
|
|
1336
|
+
|
|
1337
|
+
```ts
|
|
1338
|
+
getAudioSystem(): AudioSystem | null;
|
|
1339
|
+
```
|
|
1340
|
+
|
|
1341
|
+
Defined in: [World.ts:981](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L981)
|
|
1342
|
+
|
|
1343
|
+
The audio system (mixer buses, sound banks), or `null` before `setup`.
|
|
1344
|
+
|
|
1345
|
+
#### Returns
|
|
1346
|
+
|
|
1347
|
+
[`AudioSystem`](AudioSystem.md) \| `null`
|
|
1348
|
+
|
|
1349
|
+
***
|
|
1350
|
+
|
|
1351
|
+
### getIKSystem()
|
|
1352
|
+
|
|
1353
|
+
```ts
|
|
1354
|
+
getIKSystem(): IKSystem | null;
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
Defined in: [World.ts:986](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L986)
|
|
1358
|
+
|
|
1359
|
+
The IK system (reach errors per limb), or `null` before `setup`.
|
|
1360
|
+
|
|
1361
|
+
#### Returns
|
|
1362
|
+
|
|
1363
|
+
[`IKSystem`](IKSystem.md) \| `null`
|
|
1364
|
+
|
|
1365
|
+
***
|
|
1366
|
+
|
|
1297
1367
|
### getObjectManagementSystem()
|
|
1298
1368
|
|
|
1299
1369
|
```ts
|
|
1300
1370
|
getObjectManagementSystem(): ObjectManagementSystem;
|
|
1301
1371
|
```
|
|
1302
1372
|
|
|
1303
|
-
Defined in: [World.ts:
|
|
1373
|
+
Defined in: [World.ts:990](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L990)
|
|
1304
1374
|
|
|
1305
1375
|
#### Returns
|
|
1306
1376
|
|
|
@@ -1314,7 +1384,7 @@ Defined in: [World.ts:955](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1314
1384
|
getEnvironmentComponent(): Environment | undefined;
|
|
1315
1385
|
```
|
|
1316
1386
|
|
|
1317
|
-
Defined in: [World.ts:
|
|
1387
|
+
Defined in: [World.ts:1018](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1018)
|
|
1318
1388
|
|
|
1319
1389
|
Returns the singleton [Environment](../../components/classes/Environment.md) component for the scene, or
|
|
1320
1390
|
`undefined` if no environment entity exists yet.
|
|
@@ -1346,7 +1416,7 @@ getPostprocessingComponent():
|
|
|
1346
1416
|
| undefined;
|
|
1347
1417
|
```
|
|
1348
1418
|
|
|
1349
|
-
Defined in: [World.ts:
|
|
1419
|
+
Defined in: [World.ts:1041](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1041)
|
|
1350
1420
|
|
|
1351
1421
|
Returns the singleton [Postprocessing](../../components/classes/Postprocessing.md) component for the scene, or
|
|
1352
1422
|
`undefined` if no postprocessing entity exists yet.
|
|
@@ -1382,7 +1452,7 @@ raycast(
|
|
|
1382
1452
|
far?): IntersectionResult[];
|
|
1383
1453
|
```
|
|
1384
1454
|
|
|
1385
|
-
Defined in: [World.ts:
|
|
1455
|
+
Defined in: [World.ts:1071](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1071)
|
|
1386
1456
|
|
|
1387
1457
|
Cast a ray from `origin` along `direction` and return every intersected
|
|
1388
1458
|
entity-bound mesh, sorted by distance. Each result is a standard
|
|
@@ -1425,7 +1495,7 @@ raycastFrom(
|
|
|
1425
1495
|
far?): IntersectionResult[];
|
|
1426
1496
|
```
|
|
1427
1497
|
|
|
1428
|
-
Defined in: [World.ts:
|
|
1498
|
+
Defined in: [World.ts:1122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1122)
|
|
1429
1499
|
|
|
1430
1500
|
Cast a ray from an entity's world-space position along its forward
|
|
1431
1501
|
direction (the +Z axis of its world matrix). Returns intersected
|
|
@@ -1462,7 +1532,7 @@ if (closest && closest.entityId !== null) {
|
|
|
1462
1532
|
getEntityScript<T>(entityId): T | null;
|
|
1463
1533
|
```
|
|
1464
1534
|
|
|
1465
|
-
Defined in: [World.ts:
|
|
1535
|
+
Defined in: [World.ts:1205](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1205)
|
|
1466
1536
|
|
|
1467
1537
|
#### Type Parameters
|
|
1468
1538
|
|
|
@@ -1488,7 +1558,7 @@ Defined in: [World.ts:1170](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1488
1558
|
getScripts<T>(className): T[];
|
|
1489
1559
|
```
|
|
1490
1560
|
|
|
1491
|
-
Defined in: [World.ts:
|
|
1561
|
+
Defined in: [World.ts:1218](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1218)
|
|
1492
1562
|
|
|
1493
1563
|
#### Type Parameters
|
|
1494
1564
|
|
|
@@ -1514,7 +1584,7 @@ Defined in: [World.ts:1183](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1514
1584
|
getScript<T>(className): T | null;
|
|
1515
1585
|
```
|
|
1516
1586
|
|
|
1517
|
-
Defined in: [World.ts:
|
|
1587
|
+
Defined in: [World.ts:1259](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1259)
|
|
1518
1588
|
|
|
1519
1589
|
#### Type Parameters
|
|
1520
1590
|
|
|
@@ -1540,7 +1610,7 @@ Defined in: [World.ts:1224](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1540
1610
|
getAllEntities(): WorldEntityView[];
|
|
1541
1611
|
```
|
|
1542
1612
|
|
|
1543
|
-
Defined in: [World.ts:
|
|
1613
|
+
Defined in: [World.ts:1264](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1264)
|
|
1544
1614
|
|
|
1545
1615
|
#### Returns
|
|
1546
1616
|
|
|
@@ -1554,7 +1624,7 @@ Defined in: [World.ts:1229](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1554
1624
|
onSelectionChanged(listener): () => void;
|
|
1555
1625
|
```
|
|
1556
1626
|
|
|
1557
|
-
Defined in: [World.ts:
|
|
1627
|
+
Defined in: [World.ts:1270](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1270)
|
|
1558
1628
|
|
|
1559
1629
|
#### Parameters
|
|
1560
1630
|
|
|
@@ -1574,7 +1644,7 @@ Defined in: [World.ts:1235](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1574
1644
|
subscribe(listener): () => void;
|
|
1575
1645
|
```
|
|
1576
1646
|
|
|
1577
|
-
Defined in: [World.ts:
|
|
1647
|
+
Defined in: [World.ts:1278](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1278)
|
|
1578
1648
|
|
|
1579
1649
|
#### Parameters
|
|
1580
1650
|
|
|
@@ -1594,7 +1664,7 @@ Defined in: [World.ts:1243](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1594
1664
|
onScriptError(listener): () => void;
|
|
1595
1665
|
```
|
|
1596
1666
|
|
|
1597
|
-
Defined in: [World.ts:
|
|
1667
|
+
Defined in: [World.ts:1304](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1304)
|
|
1598
1668
|
|
|
1599
1669
|
Listen for script errors from Behaviours and ScriptObjects: load
|
|
1600
1670
|
failures, `init()` / `build()` / `update()` exceptions, and exceptions
|
|
@@ -1632,7 +1702,7 @@ stop();
|
|
|
1632
1702
|
reportScriptError(report, error): boolean;
|
|
1633
1703
|
```
|
|
1634
1704
|
|
|
1635
|
-
Defined in: [World.ts:
|
|
1705
|
+
Defined in: [World.ts:1321](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1321)
|
|
1636
1706
|
|
|
1637
1707
|
Report a script error. Used by the script systems and by any system that
|
|
1638
1708
|
calls into Behaviour hooks; scripts themselves do not need to call it.
|
|
@@ -1661,7 +1731,7 @@ the error was new.
|
|
|
1661
1731
|
clearScriptErrors(scriptUrl?): void;
|
|
1662
1732
|
```
|
|
1663
1733
|
|
|
1664
|
-
Defined in: [World.ts:
|
|
1734
|
+
Defined in: [World.ts:1373](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1373)
|
|
1665
1735
|
|
|
1666
1736
|
Forget which script errors were already reported, so their next
|
|
1667
1737
|
occurrence is logged and delivered again. Pass a script URL to forget only
|
|
@@ -1685,7 +1755,7 @@ that script's errors (for example after hot-reloading it).
|
|
|
1685
1755
|
getDebugSnapshot(maxDepth?): unknown;
|
|
1686
1756
|
```
|
|
1687
1757
|
|
|
1688
|
-
Defined in: [World.ts:
|
|
1758
|
+
Defined in: [World.ts:1385](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1385)
|
|
1689
1759
|
|
|
1690
1760
|
#### Parameters
|
|
1691
1761
|
|
|
@@ -1705,7 +1775,7 @@ Defined in: [World.ts:1350](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1705
1775
|
getDebugSignature(maxDepth?): string;
|
|
1706
1776
|
```
|
|
1707
1777
|
|
|
1708
|
-
Defined in: [World.ts:
|
|
1778
|
+
Defined in: [World.ts:1435](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1435)
|
|
1709
1779
|
|
|
1710
1780
|
#### Parameters
|
|
1711
1781
|
|
|
@@ -1734,7 +1804,7 @@ getEntitiesSnapshot(entityIds, maxDepth?): {
|
|
|
1734
1804
|
};
|
|
1735
1805
|
```
|
|
1736
1806
|
|
|
1737
|
-
Defined in: [World.ts:
|
|
1807
|
+
Defined in: [World.ts:1444](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1444)
|
|
1738
1808
|
|
|
1739
1809
|
Serialize ONLY the given entities into the same columnar
|
|
1740
1810
|
`{entities, components}` shape as [getDebugSnapshot](#getdebugsnapshot) (no systems,
|
|
@@ -1764,8 +1834,8 @@ no selection). Used by prefab/scene subtree serialization.
|
|
|
1764
1834
|
|
|
1765
1835
|
| Name | Type | Defined in |
|
|
1766
1836
|
| ------ | ------ | ------ |
|
|
1767
|
-
| `entities` | `number`[] | [World.ts:
|
|
1768
|
-
| `components` | \{ `component`: `string`; `entries`: \{ `entityId`: `number`; `value`: `unknown`; \}[]; \}[] | [World.ts:
|
|
1837
|
+
| `entities` | `number`[] | [World.ts:1448](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1448) |
|
|
1838
|
+
| `components` | \{ `component`: `string`; `entries`: \{ `entityId`: `number`; `value`: `unknown`; \}[]; \}[] | [World.ts:1449](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1449) |
|
|
1769
1839
|
|
|
1770
1840
|
***
|
|
1771
1841
|
|
|
@@ -1775,7 +1845,7 @@ no selection). Used by prefab/scene subtree serialization.
|
|
|
1775
1845
|
createHistorySnapshot(): WorldHistorySnapshot;
|
|
1776
1846
|
```
|
|
1777
1847
|
|
|
1778
|
-
Defined in: [World.ts:
|
|
1848
|
+
Defined in: [World.ts:1486](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1486)
|
|
1779
1849
|
|
|
1780
1850
|
#### Returns
|
|
1781
1851
|
|
|
@@ -1789,7 +1859,7 @@ Defined in: [World.ts:1451](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1789
1859
|
applyHistorySnapshot(snapshot): void;
|
|
1790
1860
|
```
|
|
1791
1861
|
|
|
1792
|
-
Defined in: [World.ts:
|
|
1862
|
+
Defined in: [World.ts:1507](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/World.ts#L1507)
|
|
1793
1863
|
|
|
1794
1864
|
#### Parameters
|
|
1795
1865
|
|