@relu-interactives/spatial-ecs 0.2.24 → 0.3.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/{Video-ppAXaKt0.d.cts → Video-AIQYTAAr.d.cts} +15 -3
- package/dist/{Video-C1IOat7L.d.ts → Video-DlZ4G9ig.d.ts} +15 -3
- package/dist/{chunk-JHCPRVBC.js → chunk-7BPHZWQ6.js} +59 -17
- package/dist/chunk-7BPHZWQ6.js.map +1 -0
- package/dist/{chunk-CCE5K2TU.js → chunk-7JFSEV7A.js} +18 -13
- package/dist/chunk-7JFSEV7A.js.map +1 -0
- package/dist/{chunk-52CHDPRQ.js → chunk-AT5SPSPM.js} +4 -4
- package/dist/{chunk-52CHDPRQ.js.map → chunk-AT5SPSPM.js.map} +1 -1
- package/dist/{chunk-ZXGHKX7N.js → chunk-OWQSESTO.js} +12 -2
- package/dist/chunk-OWQSESTO.js.map +1 -0
- package/dist/{chunk-WKGCC7YL.js → chunk-PZ4CAALA.js} +3 -3
- package/dist/{chunk-WKGCC7YL.js.map → chunk-PZ4CAALA.js.map} +1 -1
- package/dist/components/index.cjs +55 -13
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +2 -2
- package/dist/components/index.d.ts +2 -2
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +98 -51
- package/dist/docs/api/Component/classes/Component.md +4 -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 +3 -3
- 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 +57 -11
- 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 +4 -4
- 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 +12 -13
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +80 -0
- package/dist/docs/api/components/classes/PrefabNode.md +54 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +55 -0
- 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/VideoComponent.md +28 -28
- package/dist/docs/api/components/functions/defaultMaterialValue.md +17 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +34 -0
- package/dist/docs/api/components/index.md +8 -1
- 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 +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/EnvironmentSkyboxState.md +7 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
- 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/LightValueState.md +11 -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/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 -10
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +20 -0
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +13 -0
- 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/Vec3.md +4 -4
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.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_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.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/AudioSystem.md +4 -4
- 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/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 +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +5 -5
- package/dist/docs/api/index/classes/ScriptObject.md +156 -0
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +129 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +183 -86
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +32 -0
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +23 -0
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +25 -0
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +23 -0
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +38 -0
- package/dist/docs/api/index/functions/clearModelCache.md +26 -0
- package/dist/docs/api/index/functions/clearPrefabCache.md +25 -0
- package/dist/docs/api/index/functions/collectDiffPaths.md +38 -0
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +27 -0
- package/dist/docs/api/index/functions/collectEntitySubtree.md +29 -0
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +26 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +44 -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/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/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +2 -4
- 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 +28 -0
- 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/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +28 -0
- package/dist/docs/api/index/functions/despawnPrefab.md +32 -0
- package/dist/docs/api/index/functions/encodeOverride.md +28 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +25 -0
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +28 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +25 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +4 -2
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +25 -0
- package/dist/docs/api/index/functions/instantiateSubtree.md +32 -0
- package/dist/docs/api/index/functions/loadPrefab.md +28 -0
- package/dist/docs/api/index/functions/loadSharedGltf.md +29 -0
- package/dist/docs/api/index/functions/mergeComponentValue.md +32 -0
- package/dist/docs/api/index/functions/parseOverride.md +34 -0
- package/dist/docs/api/index/functions/parsePrefabAsset.md +25 -0
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +25 -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 +46 -0
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +17 -0
- package/dist/docs/api/index/functions/restoreComponentState.md +34 -0
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +36 -0
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +35 -0
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +30 -0
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +30 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +36 -0
- package/dist/docs/api/index/index.md +65 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- 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 +23 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +69 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +2 -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 +27 -0
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +7 -5
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +25 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +27 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +30 -0
- package/dist/docs/api/index/type-aliases/NodeMaps.md +25 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +32 -0
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +21 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +25 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +19 -0
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +43 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +19 -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/NODE_KEY_SEPARATOR.md +13 -0
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +15 -0
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +16 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +13 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +15 -0
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +15 -0
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +17 -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 +2 -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 +3 -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/components/_sidebar.json +4 -0
- package/dist/docs/guide/components/material.md +1 -0
- package/dist/docs/guide/components/script-object.md +32 -0
- package/dist/factories/index.cjs +54 -13
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +1 -1
- package/dist/factories/index.d.ts +1 -1
- package/dist/factories/index.js +3 -3
- package/dist/{index-DdiWu1b6.d.ts → index-BwiRJNIT.d.ts} +3 -2
- package/dist/{index-Cu2Pt7wN.d.cts → index-Gr8aCPRM.d.cts} +3 -2
- package/dist/index.cjs +80 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +9 -9
- package/dist/systems/index.cjs +68 -22
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.js +3 -3
- package/dist/worldSnapshotUtils.cjs +10 -0
- package/dist/worldSnapshotUtils.cjs.map +1 -1
- package/dist/worldSnapshotUtils.js +1 -1
- package/package.json +4 -4
- package/dist/chunk-CCE5K2TU.js.map +0 -1
- package/dist/chunk-JHCPRVBC.js.map +0 -1
- package/dist/chunk-ZXGHKX7N.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:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L66)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [World.ts:60](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:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L97)
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
@@ -40,7 +40,7 @@ Defined in: [World.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-
|
|
|
40
40
|
createEntity(): number;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [World.ts:
|
|
43
|
+
Defined in: [World.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L116)
|
|
44
44
|
|
|
45
45
|
#### Returns
|
|
46
46
|
|
|
@@ -54,7 +54,7 @@ Defined in: [World.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
54
54
|
destroyEntity(entityId): void;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [World.ts:
|
|
57
|
+
Defined in: [World.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L124)
|
|
58
58
|
|
|
59
59
|
#### Parameters
|
|
60
60
|
|
|
@@ -74,7 +74,7 @@ Defined in: [World.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
74
74
|
hasEntity(entityId): boolean;
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
Defined in: [World.ts:
|
|
77
|
+
Defined in: [World.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L151)
|
|
78
78
|
|
|
79
79
|
#### Parameters
|
|
80
80
|
|
|
@@ -94,7 +94,7 @@ Defined in: [World.ts:145](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
94
94
|
getEntities(): number[];
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
Defined in: [World.ts:
|
|
97
|
+
Defined in: [World.ts:155](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L155)
|
|
98
98
|
|
|
99
99
|
#### Returns
|
|
100
100
|
|
|
@@ -108,7 +108,7 @@ Defined in: [World.ts:149](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
108
108
|
getEntityCount(): number;
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
Defined in: [World.ts:
|
|
111
|
+
Defined in: [World.ts:159](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L159)
|
|
112
112
|
|
|
113
113
|
#### Returns
|
|
114
114
|
|
|
@@ -122,7 +122,7 @@ Defined in: [World.ts:153](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
122
122
|
addComponent<T>(entityId, component): void;
|
|
123
123
|
```
|
|
124
124
|
|
|
125
|
-
Defined in: [World.ts:
|
|
125
|
+
Defined in: [World.ts:163](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L163)
|
|
126
126
|
|
|
127
127
|
#### Type Parameters
|
|
128
128
|
|
|
@@ -149,7 +149,7 @@ Defined in: [World.ts:157](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
149
149
|
addComponents<T>(entityId, components): void;
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
Defined in: [World.ts:
|
|
152
|
+
Defined in: [World.ts:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L178)
|
|
153
153
|
|
|
154
154
|
#### Type Parameters
|
|
155
155
|
|
|
@@ -176,7 +176,7 @@ Defined in: [World.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
176
176
|
removeComponent<T>(entityId, componentType): void;
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
Defined in: [World.ts:
|
|
179
|
+
Defined in: [World.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L199)
|
|
180
180
|
|
|
181
181
|
#### Type Parameters
|
|
182
182
|
|
|
@@ -203,7 +203,7 @@ Defined in: [World.ts:193](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
203
203
|
getComponent<T>(entityId, componentType): T | undefined;
|
|
204
204
|
```
|
|
205
205
|
|
|
206
|
-
Defined in: [World.ts:
|
|
206
|
+
Defined in: [World.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L207)
|
|
207
207
|
|
|
208
208
|
#### Type Parameters
|
|
209
209
|
|
|
@@ -230,7 +230,7 @@ Defined in: [World.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
230
230
|
hasComponent<T>(entityId, componentType): boolean;
|
|
231
231
|
```
|
|
232
232
|
|
|
233
|
-
Defined in: [World.ts:
|
|
233
|
+
Defined in: [World.ts:214](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L214)
|
|
234
234
|
|
|
235
235
|
#### Type Parameters
|
|
236
236
|
|
|
@@ -257,7 +257,7 @@ Defined in: [World.ts:208](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
257
257
|
query(...componentTypes): number[];
|
|
258
258
|
```
|
|
259
259
|
|
|
260
|
-
Defined in: [World.ts:
|
|
260
|
+
Defined in: [World.ts:221](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L221)
|
|
261
261
|
|
|
262
262
|
#### Parameters
|
|
263
263
|
|
|
@@ -277,7 +277,7 @@ Defined in: [World.ts:215](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
277
277
|
isEntityVisible(entityId): boolean;
|
|
278
278
|
```
|
|
279
279
|
|
|
280
|
-
Defined in: [World.ts:
|
|
280
|
+
Defined in: [World.ts:235](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L235)
|
|
281
281
|
|
|
282
282
|
Returns `true` if the entity is currently visible (its `Object3DRef.visibility`
|
|
283
283
|
is `true`), or if the entity has no `Object3DRef` component (entities without a
|
|
@@ -302,7 +302,7 @@ updates for hidden objects.
|
|
|
302
302
|
getInputSystem(): EcsSystem | null;
|
|
303
303
|
```
|
|
304
304
|
|
|
305
|
-
Defined in: [World.ts:
|
|
305
|
+
Defined in: [World.ts:240](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L240)
|
|
306
306
|
|
|
307
307
|
#### Returns
|
|
308
308
|
|
|
@@ -316,7 +316,7 @@ Defined in: [World.ts:234](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
316
316
|
getKeyDown(key): boolean;
|
|
317
317
|
```
|
|
318
318
|
|
|
319
|
-
Defined in: [World.ts:
|
|
319
|
+
Defined in: [World.ts:252](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L252)
|
|
320
320
|
|
|
321
321
|
#### Parameters
|
|
322
322
|
|
|
@@ -336,7 +336,7 @@ Defined in: [World.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
336
336
|
getKeyUp(key): boolean;
|
|
337
337
|
```
|
|
338
338
|
|
|
339
|
-
Defined in: [World.ts:
|
|
339
|
+
Defined in: [World.ts:261](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L261)
|
|
340
340
|
|
|
341
341
|
#### Parameters
|
|
342
342
|
|
|
@@ -356,7 +356,7 @@ Defined in: [World.ts:255](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
356
356
|
getKey(key): boolean;
|
|
357
357
|
```
|
|
358
358
|
|
|
359
|
-
Defined in: [World.ts:
|
|
359
|
+
Defined in: [World.ts:270](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L270)
|
|
360
360
|
|
|
361
361
|
#### Parameters
|
|
362
362
|
|
|
@@ -376,7 +376,7 @@ Defined in: [World.ts:264](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
376
376
|
getMouse(button): boolean;
|
|
377
377
|
```
|
|
378
378
|
|
|
379
|
-
Defined in: [World.ts:
|
|
379
|
+
Defined in: [World.ts:279](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L279)
|
|
380
380
|
|
|
381
381
|
#### Parameters
|
|
382
382
|
|
|
@@ -396,7 +396,7 @@ Defined in: [World.ts:273](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
396
396
|
getMouseDown(button): boolean;
|
|
397
397
|
```
|
|
398
398
|
|
|
399
|
-
Defined in: [World.ts:
|
|
399
|
+
Defined in: [World.ts:288](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L288)
|
|
400
400
|
|
|
401
401
|
#### Parameters
|
|
402
402
|
|
|
@@ -416,7 +416,7 @@ Defined in: [World.ts:282](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
416
416
|
getMouseUp(button): boolean;
|
|
417
417
|
```
|
|
418
418
|
|
|
419
|
-
Defined in: [World.ts:
|
|
419
|
+
Defined in: [World.ts:297](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L297)
|
|
420
420
|
|
|
421
421
|
#### Parameters
|
|
422
422
|
|
|
@@ -436,7 +436,7 @@ Defined in: [World.ts:291](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
436
436
|
getScrollClick(): boolean;
|
|
437
437
|
```
|
|
438
438
|
|
|
439
|
-
Defined in: [World.ts:
|
|
439
|
+
Defined in: [World.ts:306](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L306)
|
|
440
440
|
|
|
441
441
|
#### Returns
|
|
442
442
|
|
|
@@ -450,7 +450,7 @@ Defined in: [World.ts:300](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
450
450
|
getScrollClickDown(): boolean;
|
|
451
451
|
```
|
|
452
452
|
|
|
453
|
-
Defined in: [World.ts:
|
|
453
|
+
Defined in: [World.ts:315](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L315)
|
|
454
454
|
|
|
455
455
|
#### Returns
|
|
456
456
|
|
|
@@ -464,7 +464,7 @@ Defined in: [World.ts:309](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
464
464
|
getScrollClickUp(): boolean;
|
|
465
465
|
```
|
|
466
466
|
|
|
467
|
-
Defined in: [World.ts:
|
|
467
|
+
Defined in: [World.ts:324](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L324)
|
|
468
468
|
|
|
469
469
|
#### Returns
|
|
470
470
|
|
|
@@ -481,7 +481,7 @@ getScrollDelta(): {
|
|
|
481
481
|
};
|
|
482
482
|
```
|
|
483
483
|
|
|
484
|
-
Defined in: [World.ts:
|
|
484
|
+
Defined in: [World.ts:333](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L333)
|
|
485
485
|
|
|
486
486
|
#### Returns
|
|
487
487
|
|
|
@@ -494,8 +494,8 @@ Defined in: [World.ts:327](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
494
494
|
|
|
495
495
|
| Name | Type | Defined in |
|
|
496
496
|
| ------ | ------ | ------ |
|
|
497
|
-
| `x` | `number` | [World.ts:
|
|
498
|
-
| `y` | `number` | [World.ts:
|
|
497
|
+
| `x` | `number` | [World.ts:333](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L333) |
|
|
498
|
+
| `y` | `number` | [World.ts:333](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L333) |
|
|
499
499
|
|
|
500
500
|
***
|
|
501
501
|
|
|
@@ -508,7 +508,7 @@ consumeScrollDelta(): {
|
|
|
508
508
|
};
|
|
509
509
|
```
|
|
510
510
|
|
|
511
|
-
Defined in: [World.ts:
|
|
511
|
+
Defined in: [World.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L342)
|
|
512
512
|
|
|
513
513
|
#### Returns
|
|
514
514
|
|
|
@@ -521,8 +521,8 @@ Defined in: [World.ts:336](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
521
521
|
|
|
522
522
|
| Name | Type | Defined in |
|
|
523
523
|
| ------ | ------ | ------ |
|
|
524
|
-
| `x` | `number` | [World.ts:
|
|
525
|
-
| `y` | `number` | [World.ts:
|
|
524
|
+
| `x` | `number` | [World.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L342) |
|
|
525
|
+
| `y` | `number` | [World.ts:342](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L342) |
|
|
526
526
|
|
|
527
527
|
***
|
|
528
528
|
|
|
@@ -535,7 +535,7 @@ getMousePosition(): {
|
|
|
535
535
|
};
|
|
536
536
|
```
|
|
537
537
|
|
|
538
|
-
Defined in: [World.ts:
|
|
538
|
+
Defined in: [World.ts:351](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L351)
|
|
539
539
|
|
|
540
540
|
#### Returns
|
|
541
541
|
|
|
@@ -548,8 +548,8 @@ Defined in: [World.ts:345](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
548
548
|
|
|
549
549
|
| Name | Type | Defined in |
|
|
550
550
|
| ------ | ------ | ------ |
|
|
551
|
-
| `x` | `number` | [World.ts:
|
|
552
|
-
| `y` | `number` | [World.ts:
|
|
551
|
+
| `x` | `number` | [World.ts:351](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L351) |
|
|
552
|
+
| `y` | `number` | [World.ts:351](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L351) |
|
|
553
553
|
|
|
554
554
|
***
|
|
555
555
|
|
|
@@ -562,7 +562,7 @@ getMouseDelta(): {
|
|
|
562
562
|
};
|
|
563
563
|
```
|
|
564
564
|
|
|
565
|
-
Defined in: [World.ts:
|
|
565
|
+
Defined in: [World.ts:360](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L360)
|
|
566
566
|
|
|
567
567
|
#### Returns
|
|
568
568
|
|
|
@@ -575,8 +575,8 @@ Defined in: [World.ts:354](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
575
575
|
|
|
576
576
|
| Name | Type | Defined in |
|
|
577
577
|
| ------ | ------ | ------ |
|
|
578
|
-
| `x` | `number` | [World.ts:
|
|
579
|
-
| `y` | `number` | [World.ts:
|
|
578
|
+
| `x` | `number` | [World.ts:360](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L360) |
|
|
579
|
+
| `y` | `number` | [World.ts:360](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L360) |
|
|
580
580
|
|
|
581
581
|
***
|
|
582
582
|
|
|
@@ -589,7 +589,7 @@ consumeMouseDelta(): {
|
|
|
589
589
|
};
|
|
590
590
|
```
|
|
591
591
|
|
|
592
|
-
Defined in: [World.ts:
|
|
592
|
+
Defined in: [World.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L369)
|
|
593
593
|
|
|
594
594
|
#### Returns
|
|
595
595
|
|
|
@@ -602,8 +602,8 @@ Defined in: [World.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
602
602
|
|
|
603
603
|
| Name | Type | Defined in |
|
|
604
604
|
| ------ | ------ | ------ |
|
|
605
|
-
| `x` | `number` | [World.ts:
|
|
606
|
-
| `y` | `number` | [World.ts:
|
|
605
|
+
| `x` | `number` | [World.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L369) |
|
|
606
|
+
| `y` | `number` | [World.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L369) |
|
|
607
607
|
|
|
608
608
|
***
|
|
609
609
|
|
|
@@ -613,7 +613,7 @@ Defined in: [World.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
613
613
|
getRapierModule(): Promise<__module>;
|
|
614
614
|
```
|
|
615
615
|
|
|
616
|
-
Defined in: [World.ts:
|
|
616
|
+
Defined in: [World.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L378)
|
|
617
617
|
|
|
618
618
|
#### Returns
|
|
619
619
|
|
|
@@ -627,7 +627,7 @@ Defined in: [World.ts:372](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
627
627
|
getPhysicsWorld(): World | null;
|
|
628
628
|
```
|
|
629
629
|
|
|
630
|
-
Defined in: [World.ts:
|
|
630
|
+
Defined in: [World.ts:396](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L396)
|
|
631
631
|
|
|
632
632
|
#### Returns
|
|
633
633
|
|
|
@@ -641,7 +641,7 @@ Defined in: [World.ts:390](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
641
641
|
setPhysicsWorld(physicsWorld): void;
|
|
642
642
|
```
|
|
643
643
|
|
|
644
|
-
Defined in: [World.ts:
|
|
644
|
+
Defined in: [World.ts:400](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L400)
|
|
645
645
|
|
|
646
646
|
#### Parameters
|
|
647
647
|
|
|
@@ -661,7 +661,7 @@ Defined in: [World.ts:394](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
661
661
|
createPhysicsWorld(options?): Promise<World | null>;
|
|
662
662
|
```
|
|
663
663
|
|
|
664
|
-
Defined in: [World.ts:
|
|
664
|
+
Defined in: [World.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L404)
|
|
665
665
|
|
|
666
666
|
#### Parameters
|
|
667
667
|
|
|
@@ -685,7 +685,7 @@ Defined in: [World.ts:398](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
685
685
|
lockMousePointer(): boolean;
|
|
686
686
|
```
|
|
687
687
|
|
|
688
|
-
Defined in: [World.ts:
|
|
688
|
+
Defined in: [World.ts:423](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L423)
|
|
689
689
|
|
|
690
690
|
#### Returns
|
|
691
691
|
|
|
@@ -699,7 +699,7 @@ Defined in: [World.ts:417](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
699
699
|
unlockMousePointer(): boolean;
|
|
700
700
|
```
|
|
701
701
|
|
|
702
|
-
Defined in: [World.ts:
|
|
702
|
+
Defined in: [World.ts:454](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L454)
|
|
703
703
|
|
|
704
704
|
#### Returns
|
|
705
705
|
|
|
@@ -713,7 +713,7 @@ Defined in: [World.ts:448](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
713
713
|
isMousePointerLocked(): boolean;
|
|
714
714
|
```
|
|
715
715
|
|
|
716
|
-
Defined in: [World.ts:
|
|
716
|
+
Defined in: [World.ts:475](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L475)
|
|
717
717
|
|
|
718
718
|
#### Returns
|
|
719
719
|
|
|
@@ -727,7 +727,7 @@ Defined in: [World.ts:469](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
727
727
|
getSystem<T>(system): T;
|
|
728
728
|
```
|
|
729
729
|
|
|
730
|
-
Defined in: [World.ts:
|
|
730
|
+
Defined in: [World.ts:491](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L491)
|
|
731
731
|
|
|
732
732
|
#### Type Parameters
|
|
733
733
|
|
|
@@ -753,7 +753,7 @@ Defined in: [World.ts:485](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
753
753
|
hasSystem<T>(system): boolean;
|
|
754
754
|
```
|
|
755
755
|
|
|
756
|
-
Defined in: [World.ts:
|
|
756
|
+
Defined in: [World.ts:508](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L508)
|
|
757
757
|
|
|
758
758
|
#### Type Parameters
|
|
759
759
|
|
|
@@ -779,7 +779,7 @@ Defined in: [World.ts:502](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
779
779
|
addSystem(system): void;
|
|
780
780
|
```
|
|
781
781
|
|
|
782
|
-
Defined in: [World.ts:
|
|
782
|
+
Defined in: [World.ts:517](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L517)
|
|
783
783
|
|
|
784
784
|
#### Parameters
|
|
785
785
|
|
|
@@ -799,7 +799,7 @@ Defined in: [World.ts:511](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
799
799
|
addSystems(systems): void;
|
|
800
800
|
```
|
|
801
801
|
|
|
802
|
-
Defined in: [World.ts:
|
|
802
|
+
Defined in: [World.ts:521](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L521)
|
|
803
803
|
|
|
804
804
|
#### Parameters
|
|
805
805
|
|
|
@@ -823,7 +823,7 @@ setup(__namedParameters): {
|
|
|
823
823
|
};
|
|
824
824
|
```
|
|
825
825
|
|
|
826
|
-
Defined in: [World.ts:
|
|
826
|
+
Defined in: [World.ts:527](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L527)
|
|
827
827
|
|
|
828
828
|
#### Parameters
|
|
829
829
|
|
|
@@ -845,9 +845,9 @@ Defined in: [World.ts:521](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
845
845
|
|
|
846
846
|
| Name | Type | Defined in |
|
|
847
847
|
| ------ | ------ | ------ |
|
|
848
|
-
| `objectManagementSystem` | [`ObjectManagementSystem`](ObjectManagementSystem.md) | [World.ts:
|
|
849
|
-
| `transformSyncSystem` | [`TransformSyncSystem`](TransformSyncSystem.md) | [World.ts:
|
|
850
|
-
| `renderSystem` | [`RenderSystem`](RenderSystem.md) | [World.ts:
|
|
848
|
+
| `objectManagementSystem` | [`ObjectManagementSystem`](ObjectManagementSystem.md) | [World.ts:528](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L528) |
|
|
849
|
+
| `transformSyncSystem` | [`TransformSyncSystem`](TransformSyncSystem.md) | [World.ts:529](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L529) |
|
|
850
|
+
| `renderSystem` | [`RenderSystem`](RenderSystem.md) | [World.ts:530](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L530) |
|
|
851
851
|
|
|
852
852
|
***
|
|
853
853
|
|
|
@@ -857,7 +857,7 @@ Defined in: [World.ts:521](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
857
857
|
isEditorMode(): boolean;
|
|
858
858
|
```
|
|
859
859
|
|
|
860
|
-
Defined in: [World.ts:
|
|
860
|
+
Defined in: [World.ts:615](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L615)
|
|
861
861
|
|
|
862
862
|
#### Returns
|
|
863
863
|
|
|
@@ -871,7 +871,7 @@ Defined in: [World.ts:609](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
871
871
|
pause(): void;
|
|
872
872
|
```
|
|
873
873
|
|
|
874
|
-
Defined in: [World.ts:
|
|
874
|
+
Defined in: [World.ts:626](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L626)
|
|
875
875
|
|
|
876
876
|
Pauses world simulation. While paused, `update()` skips all system ticks so
|
|
877
877
|
physics, animation, scripts, and rendering stop advancing. The last rendered
|
|
@@ -891,7 +891,7 @@ Call [resume](#resume) to continue.
|
|
|
891
891
|
resume(): void;
|
|
892
892
|
```
|
|
893
893
|
|
|
894
|
-
Defined in: [World.ts:
|
|
894
|
+
Defined in: [World.ts:634](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L634)
|
|
895
895
|
|
|
896
896
|
Resumes world simulation after a previous [pause](#pause) call.
|
|
897
897
|
Has no effect if the world is not paused.
|
|
@@ -908,7 +908,7 @@ Has no effect if the world is not paused.
|
|
|
908
908
|
isPaused(): boolean;
|
|
909
909
|
```
|
|
910
910
|
|
|
911
|
-
Defined in: [World.ts:
|
|
911
|
+
Defined in: [World.ts:648](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L648)
|
|
912
912
|
|
|
913
913
|
Returns `true` if the world is currently paused.
|
|
914
914
|
|
|
@@ -932,7 +932,7 @@ if (this.world.isPaused()) {
|
|
|
932
932
|
getScene(): Scene;
|
|
933
933
|
```
|
|
934
934
|
|
|
935
|
-
Defined in: [World.ts:
|
|
935
|
+
Defined in: [World.ts:652](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L652)
|
|
936
936
|
|
|
937
937
|
#### Returns
|
|
938
938
|
|
|
@@ -946,7 +946,7 @@ Defined in: [World.ts:646](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
946
946
|
getCamera(): PerspectiveCamera;
|
|
947
947
|
```
|
|
948
948
|
|
|
949
|
-
Defined in: [World.ts:
|
|
949
|
+
Defined in: [World.ts:656](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L656)
|
|
950
950
|
|
|
951
951
|
#### Returns
|
|
952
952
|
|
|
@@ -960,7 +960,7 @@ Defined in: [World.ts:650](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
960
960
|
getRenderer(): WebGLRenderer;
|
|
961
961
|
```
|
|
962
962
|
|
|
963
|
-
Defined in: [World.ts:
|
|
963
|
+
Defined in: [World.ts:660](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L660)
|
|
964
964
|
|
|
965
965
|
#### Returns
|
|
966
966
|
|
|
@@ -974,7 +974,7 @@ Defined in: [World.ts:654](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
974
974
|
update(deltaTime): void;
|
|
975
975
|
```
|
|
976
976
|
|
|
977
|
-
Defined in: [World.ts:
|
|
977
|
+
Defined in: [World.ts:664](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L664)
|
|
978
978
|
|
|
979
979
|
#### Parameters
|
|
980
980
|
|
|
@@ -994,7 +994,7 @@ Defined in: [World.ts:658](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
994
994
|
dispose(): void;
|
|
995
995
|
```
|
|
996
996
|
|
|
997
|
-
Defined in: [World.ts:
|
|
997
|
+
Defined in: [World.ts:671](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L671)
|
|
998
998
|
|
|
999
999
|
#### Returns
|
|
1000
1000
|
|
|
@@ -1008,7 +1008,7 @@ Defined in: [World.ts:665](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1008
1008
|
setSelectedEntity(entityId): void;
|
|
1009
1009
|
```
|
|
1010
1010
|
|
|
1011
|
-
Defined in: [World.ts:
|
|
1011
|
+
Defined in: [World.ts:683](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L683)
|
|
1012
1012
|
|
|
1013
1013
|
#### Parameters
|
|
1014
1014
|
|
|
@@ -1028,7 +1028,7 @@ Defined in: [World.ts:677](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1028
1028
|
getSelectedEntity(): number | null;
|
|
1029
1029
|
```
|
|
1030
1030
|
|
|
1031
|
-
Defined in: [World.ts:
|
|
1031
|
+
Defined in: [World.ts:705](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L705)
|
|
1032
1032
|
|
|
1033
1033
|
#### Returns
|
|
1034
1034
|
|
|
@@ -1042,7 +1042,7 @@ Defined in: [World.ts:699](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1042
1042
|
getEntitiesByComponent(component): WorldEntityView[];
|
|
1043
1043
|
```
|
|
1044
1044
|
|
|
1045
|
-
Defined in: [World.ts:
|
|
1045
|
+
Defined in: [World.ts:765](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L765)
|
|
1046
1046
|
|
|
1047
1047
|
#### Parameters
|
|
1048
1048
|
|
|
@@ -1062,7 +1062,7 @@ Defined in: [World.ts:759](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1062
1062
|
getEntitiesByName(name): WorldEntityView[];
|
|
1063
1063
|
```
|
|
1064
1064
|
|
|
1065
|
-
Defined in: [World.ts:
|
|
1065
|
+
Defined in: [World.ts:779](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L779)
|
|
1066
1066
|
|
|
1067
1067
|
#### Parameters
|
|
1068
1068
|
|
|
@@ -1082,7 +1082,7 @@ Defined in: [World.ts:773](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1082
1082
|
getEntityByName(name): WorldEntityView | null;
|
|
1083
1083
|
```
|
|
1084
1084
|
|
|
1085
|
-
Defined in: [World.ts:
|
|
1085
|
+
Defined in: [World.ts:788](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L788)
|
|
1086
1086
|
|
|
1087
1087
|
#### Parameters
|
|
1088
1088
|
|
|
@@ -1102,7 +1102,7 @@ Defined in: [World.ts:782](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1102
1102
|
getEntityById(entityId): WorldEntityView | null;
|
|
1103
1103
|
```
|
|
1104
1104
|
|
|
1105
|
-
Defined in: [World.ts:
|
|
1105
|
+
Defined in: [World.ts:793](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L793)
|
|
1106
1106
|
|
|
1107
1107
|
#### Parameters
|
|
1108
1108
|
|
|
@@ -1122,7 +1122,7 @@ Defined in: [World.ts:787](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1122
1122
|
getEntitiesChildren(entityId): WorldEntityView[];
|
|
1123
1123
|
```
|
|
1124
1124
|
|
|
1125
|
-
Defined in: [World.ts:
|
|
1125
|
+
Defined in: [World.ts:801](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L801)
|
|
1126
1126
|
|
|
1127
1127
|
#### Parameters
|
|
1128
1128
|
|
|
@@ -1142,7 +1142,7 @@ Defined in: [World.ts:795](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1142
1142
|
getEntitiesParent(entityId): WorldEntityView | null;
|
|
1143
1143
|
```
|
|
1144
1144
|
|
|
1145
|
-
Defined in: [World.ts:
|
|
1145
|
+
Defined in: [World.ts:815](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L815)
|
|
1146
1146
|
|
|
1147
1147
|
#### Parameters
|
|
1148
1148
|
|
|
@@ -1156,13 +1156,60 @@ Defined in: [World.ts:809](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1156
1156
|
|
|
1157
1157
|
***
|
|
1158
1158
|
|
|
1159
|
+
### spawnPrefab()
|
|
1160
|
+
|
|
1161
|
+
```ts
|
|
1162
|
+
spawnPrefab(source, options?): Promise<number>;
|
|
1163
|
+
```
|
|
1164
|
+
|
|
1165
|
+
Defined in: [World.ts:830](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L830)
|
|
1166
|
+
|
|
1167
|
+
Instantiate a prefab asset into this world at runtime — see
|
|
1168
|
+
[spawnPrefab](../functions/spawnPrefab.md). Convenience wrapper so scripts and embedding apps
|
|
1169
|
+
can spawn without reaching for the object management system.
|
|
1170
|
+
|
|
1171
|
+
#### Parameters
|
|
1172
|
+
|
|
1173
|
+
| Parameter | Type |
|
|
1174
|
+
| ------ | ------ |
|
|
1175
|
+
| `source` | [`SpawnPrefabSource`](../type-aliases/SpawnPrefabSource.md) |
|
|
1176
|
+
| `options?` | [`SpawnPrefabOptions`](../type-aliases/SpawnPrefabOptions.md) |
|
|
1177
|
+
|
|
1178
|
+
#### Returns
|
|
1179
|
+
|
|
1180
|
+
`Promise`\<`number`\>
|
|
1181
|
+
|
|
1182
|
+
***
|
|
1183
|
+
|
|
1184
|
+
### despawnPrefab()
|
|
1185
|
+
|
|
1186
|
+
```ts
|
|
1187
|
+
despawnPrefab(rootEntityId): number;
|
|
1188
|
+
```
|
|
1189
|
+
|
|
1190
|
+
Defined in: [World.ts:838](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L838)
|
|
1191
|
+
|
|
1192
|
+
Remove a spawned prefab instance (root + descendants).
|
|
1193
|
+
|
|
1194
|
+
#### Parameters
|
|
1195
|
+
|
|
1196
|
+
| Parameter | Type |
|
|
1197
|
+
| ------ | ------ |
|
|
1198
|
+
| `rootEntityId` | `number` |
|
|
1199
|
+
|
|
1200
|
+
#### Returns
|
|
1201
|
+
|
|
1202
|
+
`number`
|
|
1203
|
+
|
|
1204
|
+
***
|
|
1205
|
+
|
|
1159
1206
|
### getObjectManagementSystem()
|
|
1160
1207
|
|
|
1161
1208
|
```ts
|
|
1162
1209
|
getObjectManagementSystem(): ObjectManagementSystem;
|
|
1163
1210
|
```
|
|
1164
1211
|
|
|
1165
|
-
Defined in: [World.ts:
|
|
1212
|
+
Defined in: [World.ts:842](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L842)
|
|
1166
1213
|
|
|
1167
1214
|
#### Returns
|
|
1168
1215
|
|
|
@@ -1176,7 +1223,7 @@ Defined in: [World.ts:819](https://github.com/Relu-Interactives/relu-spatial-ecs
|
|
|
1176
1223
|
getEnvironmentComponent(): Environment | undefined;
|
|
1177
1224
|
```
|
|
1178
1225
|
|
|
1179
|
-
Defined in: [World.ts:
|
|
1226
|
+
Defined in: [World.ts:870](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L870)
|
|
1180
1227
|
|
|
1181
1228
|
Returns the singleton [Environment](../../components/classes/Environment.md) component for the scene, or
|
|
1182
1229
|
`undefined` if no environment entity exists yet.
|
|
@@ -1208,7 +1255,7 @@ getPostprocessingComponent():
|
|
|
1208
1255
|
| undefined;
|
|
1209
1256
|
```
|
|
1210
1257
|
|
|
1211
|
-
Defined in: [World.ts:
|
|
1258
|
+
Defined in: [World.ts:893](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L893)
|
|
1212
1259
|
|
|
1213
1260
|
Returns the singleton [Postprocessing](../../components/classes/Postprocessing.md) component for the scene, or
|
|
1214
1261
|
`undefined` if no postprocessing entity exists yet.
|
|
@@ -1244,7 +1291,7 @@ raycast(
|
|
|
1244
1291
|
far?): IntersectionResult[];
|
|
1245
1292
|
```
|
|
1246
1293
|
|
|
1247
|
-
Defined in: [World.ts:
|
|
1294
|
+
Defined in: [World.ts:923](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L923)
|
|
1248
1295
|
|
|
1249
1296
|
Cast a ray from `origin` along `direction` and return every intersected
|
|
1250
1297
|
entity-bound mesh, sorted by distance. Each result is a standard
|
|
@@ -1287,7 +1334,7 @@ raycastFrom(
|
|
|
1287
1334
|
far?): IntersectionResult[];
|
|
1288
1335
|
```
|
|
1289
1336
|
|
|
1290
|
-
Defined in: [World.ts:
|
|
1337
|
+
Defined in: [World.ts:974](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L974)
|
|
1291
1338
|
|
|
1292
1339
|
Cast a ray from an entity's world-space position along its forward
|
|
1293
1340
|
direction (the +Z axis of its world matrix). Returns intersected
|
|
@@ -1324,7 +1371,7 @@ if (closest && closest.entityId !== null) {
|
|
|
1324
1371
|
getEntityScript<T>(entityId): T | null;
|
|
1325
1372
|
```
|
|
1326
1373
|
|
|
1327
|
-
Defined in: [World.ts:
|
|
1374
|
+
Defined in: [World.ts:1057](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1057)
|
|
1328
1375
|
|
|
1329
1376
|
#### Type Parameters
|
|
1330
1377
|
|
|
@@ -1350,7 +1397,7 @@ Defined in: [World.ts:1034](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1350
1397
|
getScripts<T>(className): T[];
|
|
1351
1398
|
```
|
|
1352
1399
|
|
|
1353
|
-
Defined in: [World.ts:
|
|
1400
|
+
Defined in: [World.ts:1070](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1070)
|
|
1354
1401
|
|
|
1355
1402
|
#### Type Parameters
|
|
1356
1403
|
|
|
@@ -1376,7 +1423,7 @@ Defined in: [World.ts:1047](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1376
1423
|
getScript<T>(className): T | null;
|
|
1377
1424
|
```
|
|
1378
1425
|
|
|
1379
|
-
Defined in: [World.ts:
|
|
1426
|
+
Defined in: [World.ts:1111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1111)
|
|
1380
1427
|
|
|
1381
1428
|
#### Type Parameters
|
|
1382
1429
|
|
|
@@ -1402,7 +1449,7 @@ Defined in: [World.ts:1088](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1402
1449
|
getAllEntities(): WorldEntityView[];
|
|
1403
1450
|
```
|
|
1404
1451
|
|
|
1405
|
-
Defined in: [World.ts:
|
|
1452
|
+
Defined in: [World.ts:1116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1116)
|
|
1406
1453
|
|
|
1407
1454
|
#### Returns
|
|
1408
1455
|
|
|
@@ -1416,7 +1463,7 @@ Defined in: [World.ts:1093](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1416
1463
|
onSelectionChanged(listener): () => void;
|
|
1417
1464
|
```
|
|
1418
1465
|
|
|
1419
|
-
Defined in: [World.ts:
|
|
1466
|
+
Defined in: [World.ts:1122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1122)
|
|
1420
1467
|
|
|
1421
1468
|
#### Parameters
|
|
1422
1469
|
|
|
@@ -1436,7 +1483,7 @@ Defined in: [World.ts:1099](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1436
1483
|
subscribe(listener): () => void;
|
|
1437
1484
|
```
|
|
1438
1485
|
|
|
1439
|
-
Defined in: [World.ts:
|
|
1486
|
+
Defined in: [World.ts:1130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1130)
|
|
1440
1487
|
|
|
1441
1488
|
#### Parameters
|
|
1442
1489
|
|
|
@@ -1456,7 +1503,7 @@ Defined in: [World.ts:1107](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1456
1503
|
getDebugSnapshot(maxDepth?): unknown;
|
|
1457
1504
|
```
|
|
1458
1505
|
|
|
1459
|
-
Defined in: [World.ts:
|
|
1506
|
+
Defined in: [World.ts:1138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1138)
|
|
1460
1507
|
|
|
1461
1508
|
#### Parameters
|
|
1462
1509
|
|
|
@@ -1476,7 +1523,7 @@ Defined in: [World.ts:1115](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1476
1523
|
getDebugSignature(maxDepth?): string;
|
|
1477
1524
|
```
|
|
1478
1525
|
|
|
1479
|
-
Defined in: [World.ts:
|
|
1526
|
+
Defined in: [World.ts:1188](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1188)
|
|
1480
1527
|
|
|
1481
1528
|
#### Parameters
|
|
1482
1529
|
|
|
@@ -1490,13 +1537,63 @@ Defined in: [World.ts:1165](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1490
1537
|
|
|
1491
1538
|
***
|
|
1492
1539
|
|
|
1540
|
+
### getEntitiesSnapshot()
|
|
1541
|
+
|
|
1542
|
+
```ts
|
|
1543
|
+
getEntitiesSnapshot(entityIds, maxDepth?): {
|
|
1544
|
+
entities: number[];
|
|
1545
|
+
components: {
|
|
1546
|
+
component: string;
|
|
1547
|
+
entries: {
|
|
1548
|
+
entityId: number;
|
|
1549
|
+
value: unknown;
|
|
1550
|
+
}[];
|
|
1551
|
+
}[];
|
|
1552
|
+
};
|
|
1553
|
+
```
|
|
1554
|
+
|
|
1555
|
+
Defined in: [World.ts:1197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1197)
|
|
1556
|
+
|
|
1557
|
+
Serialize ONLY the given entities into the same columnar
|
|
1558
|
+
`{entities, components}` shape as [getDebugSnapshot](#getdebugsnapshot) (no systems,
|
|
1559
|
+
no selection). Used by prefab/scene subtree serialization.
|
|
1560
|
+
|
|
1561
|
+
#### Parameters
|
|
1562
|
+
|
|
1563
|
+
| Parameter | Type | Default value |
|
|
1564
|
+
| ------ | ------ | ------ |
|
|
1565
|
+
| `entityIds` | `number`[] | `undefined` |
|
|
1566
|
+
| `maxDepth` | `number` | `10` |
|
|
1567
|
+
|
|
1568
|
+
#### Returns
|
|
1569
|
+
|
|
1570
|
+
```ts
|
|
1571
|
+
{
|
|
1572
|
+
entities: number[];
|
|
1573
|
+
components: {
|
|
1574
|
+
component: string;
|
|
1575
|
+
entries: {
|
|
1576
|
+
entityId: number;
|
|
1577
|
+
value: unknown;
|
|
1578
|
+
}[];
|
|
1579
|
+
}[];
|
|
1580
|
+
}
|
|
1581
|
+
```
|
|
1582
|
+
|
|
1583
|
+
| Name | Type | Defined in |
|
|
1584
|
+
| ------ | ------ | ------ |
|
|
1585
|
+
| `entities` | `number`[] | [World.ts:1201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1201) |
|
|
1586
|
+
| `components` | \{ `component`: `string`; `entries`: \{ `entityId`: `number`; `value`: `unknown`; \}[]; \}[] | [World.ts:1202](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1202) |
|
|
1587
|
+
|
|
1588
|
+
***
|
|
1589
|
+
|
|
1493
1590
|
### createHistorySnapshot()
|
|
1494
1591
|
|
|
1495
1592
|
```ts
|
|
1496
1593
|
createHistorySnapshot(): WorldHistorySnapshot;
|
|
1497
1594
|
```
|
|
1498
1595
|
|
|
1499
|
-
Defined in: [World.ts:
|
|
1596
|
+
Defined in: [World.ts:1239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1239)
|
|
1500
1597
|
|
|
1501
1598
|
#### Returns
|
|
1502
1599
|
|
|
@@ -1510,7 +1607,7 @@ Defined in: [World.ts:1169](https://github.com/Relu-Interactives/relu-spatial-ec
|
|
|
1510
1607
|
applyHistorySnapshot(snapshot): void;
|
|
1511
1608
|
```
|
|
1512
1609
|
|
|
1513
|
-
Defined in: [World.ts:
|
|
1610
|
+
Defined in: [World.ts:1260](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/World.ts#L1260)
|
|
1514
1611
|
|
|
1515
1612
|
#### Parameters
|
|
1516
1613
|
|