@relu-interactives/spatial-ecs 0.2.10 → 0.2.12
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-AV2_87Zr.d.cts → System-CHCucemW.d.cts} +24 -2
- package/dist/{System-AV2_87Zr.d.ts → System-CHCucemW.d.ts} +24 -2
- package/dist/{Video-D6mObK_5.d.ts → Video-ACTSfWjH.d.cts} +2 -2
- package/dist/{Video-Bn93p6XV.d.cts → Video-B9ZKmBIT.d.ts} +2 -2
- package/dist/{chunk-Y7KXYSPD.js → chunk-ON4E5E5O.js} +4 -4
- package/dist/{chunk-Y7KXYSPD.js.map → chunk-ON4E5E5O.js.map} +1 -1
- package/dist/{chunk-ODCWJHPS.js → chunk-PH43YHUT.js} +40 -4
- package/dist/chunk-PH43YHUT.js.map +1 -0
- package/dist/{chunk-AZR6SLQN.js → chunk-XPCVEXMY.js} +2 -2
- package/dist/{chunk-AZR6SLQN.js.map → chunk-XPCVEXMY.js.map} +1 -1
- package/dist/{chunk-LE6ARNYQ.js → chunk-ZCEMOTH4.js} +4 -4
- package/dist/{chunk-LE6ARNYQ.js.map → chunk-ZCEMOTH4.js.map} +1 -1
- 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 +29 -29
- package/dist/docs/api/Component/classes/Component.md +3 -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 +52 -0
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +82 -0
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +11 -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 +6 -6
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- 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/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/index.md +6 -0
- 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 +49 -0
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +15 -0
- 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 +9 -9
- 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 +15 -0
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +15 -0
- 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 +62 -0
- 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 +39 -19
- 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/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +82 -82
- 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 +30 -0
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +36 -0
- 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 +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/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/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.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/index.md +3 -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/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +3 -2
- 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/HydrateWorldFromSnapshotResult.md +3 -3
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- 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/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 +1 -1
- 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 +3 -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 +4 -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/component-catalog.md +2 -0
- package/dist/docs/guide/components/animation.md +40 -1
- package/dist/docs/guide/components/instance-slot.md +102 -0
- package/dist/docs/guide/components/instanced-mesh.md +186 -0
- package/dist/docs/guide/spawning/audio.md +29 -7
- package/dist/docs/guide/spawning/index.md +4 -0
- package/dist/docs/guide/spawning/instanced-mesh.md +267 -0
- package/dist/docs/guide/systems/_sidebar.json +4 -0
- package/dist/docs/guide/systems/instanced-mesh-system.md +32 -0
- package/dist/docs/guide/systems/object-management-system.md +9 -0
- 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 +3 -3
- package/dist/{index-BO49V8aS.d.ts → index-B5JcGMJ5.d.ts} +2 -2
- package/dist/{index-B4-ABchF.d.cts → index-kx5O2mVU.d.cts} +2 -2
- package/dist/index.cjs +37 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -5
- package/dist/index.d.ts +5 -5
- package/dist/index.js +8 -8
- package/dist/systems/index.cjs +37 -1
- 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 +3 -3
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +1 -1
- package/dist/chunk-ODCWJHPS.js.map +0 -1
|
@@ -13,7 +13,7 @@ function createAnimationComponent(
|
|
|
13
13
|
args): AnimationComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/AnimationFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -15,7 +15,7 @@ function createAudioComponent(
|
|
|
15
15
|
context?): AudioComponent;
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/AudioComponentFactory.ts#L126)
|
|
19
19
|
|
|
20
20
|
## Parameters
|
|
21
21
|
|
|
@@ -13,7 +13,7 @@ function createCameraComponent(
|
|
|
13
13
|
payload?): CameraComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/CameraFactory.ts#L7)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createEntityTypeComponent(
|
|
|
13
13
|
args): EntityType;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/EntityTypeFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -21,7 +21,7 @@ Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Rel
|
|
|
21
21
|
| ------ | ------ |
|
|
22
22
|
| `world` | [`World`](../classes/World.md) |
|
|
23
23
|
| `entityId` | `number` |
|
|
24
|
-
| ...`args` | \[ \| `"model"` \| `"image"` \| `"capsule"` \| `"
|
|
24
|
+
| ...`args` | \[ \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"editorUtility"`\] |
|
|
25
25
|
|
|
26
26
|
## Returns
|
|
27
27
|
|
|
@@ -13,7 +13,7 @@ function createEnvironmentComponent(
|
|
|
13
13
|
values?): Environment;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/EnvironmentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/EnvironmentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/EnvironmentFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createImageComponent(
|
|
|
13
13
|
args): ImageComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ImageComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ImageComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ImageComponentFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createImageTargetAnchorComponent(
|
|
|
13
13
|
args): ImageTargetAnchor;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ImageTargetAnchorFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ImageTargetAnchorFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ImageTargetAnchorFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createImageTargetComponent(
|
|
|
13
13
|
args): ImageTarget;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ImageTargetFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ImageTargetFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ImageTargetFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createInstanceSlotComponent
|
|
6
|
+
|
|
7
|
+
# Function: createInstanceSlotComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createInstanceSlotComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
groupEntityId,
|
|
14
|
+
slotIndex): InstanceSlotComponent;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [factories/components/InstanceSlotComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/InstanceSlotComponentFactory.ts#L4)
|
|
18
|
+
|
|
19
|
+
## Parameters
|
|
20
|
+
|
|
21
|
+
| Parameter | Type |
|
|
22
|
+
| ------ | ------ |
|
|
23
|
+
| `world` | [`World`](../classes/World.md) |
|
|
24
|
+
| `entityId` | `number` |
|
|
25
|
+
| `groupEntityId` | `number` |
|
|
26
|
+
| `slotIndex` | `number` |
|
|
27
|
+
|
|
28
|
+
## Returns
|
|
29
|
+
|
|
30
|
+
[`InstanceSlotComponent`](../../components/classes/InstanceSlotComponent.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createInstancedMeshComponent
|
|
6
|
+
|
|
7
|
+
# Function: createInstancedMeshComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createInstancedMeshComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
meshKind,
|
|
14
|
+
meshParameters?,
|
|
15
|
+
options?): InstancedMeshComponent;
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [factories/components/InstancedMeshComponentFactory.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/InstancedMeshComponentFactory.ts#L6)
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Type |
|
|
23
|
+
| ------ | ------ |
|
|
24
|
+
| `world` | [`World`](../classes/World.md) |
|
|
25
|
+
| `entityId` | `number` |
|
|
26
|
+
| `meshKind` | [`InstancedMeshKind`](../../components/type-aliases/InstancedMeshKind.md) |
|
|
27
|
+
| `meshParameters?` | `Partial`\<[`MeshGeometryParameters`](../../components/type-aliases/MeshGeometryParameters.md)\> |
|
|
28
|
+
| `options?` | \{ `castShadow?`: `boolean`; `receiveShadow?`: `boolean`; `instanceEntityIds?`: `number`[]; `modelPath?`: `string`; \} |
|
|
29
|
+
| `options.castShadow?` | `boolean` |
|
|
30
|
+
| `options.receiveShadow?` | `boolean` |
|
|
31
|
+
| `options.instanceEntityIds?` | `number`[] |
|
|
32
|
+
| `options.modelPath?` | `string` |
|
|
33
|
+
|
|
34
|
+
## Returns
|
|
35
|
+
|
|
36
|
+
[`InstancedMeshComponent`](../../components/classes/InstancedMeshComponent.md)
|
|
@@ -13,7 +13,7 @@ function createLightComponent(
|
|
|
13
13
|
args): LightComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/LightFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/LightFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/LightFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createMaterialComponent(
|
|
|
13
13
|
args): MaterialComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/MaterialFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/MaterialFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/MaterialFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createMeshComponent(
|
|
|
13
13
|
args): MeshComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/MeshFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/MeshFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/MeshFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createMeshGeometryComponent(
|
|
|
13
13
|
args): MeshGeometryComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/MeshGeometryFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/MeshGeometryFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/MeshGeometryFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createModelComponent(
|
|
|
13
13
|
args): ModelComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ModelFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ModelFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ModelFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createNameComponent(
|
|
|
13
13
|
args): Name;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/NameFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/NameFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/NameFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createObject3DRefComponent(
|
|
|
13
13
|
args): Object3DRef;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/Object3DRefFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/Object3DRefFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/Object3DRefFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createParentIdComponent(
|
|
|
13
13
|
args): ParentId;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ParentIdFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ParentIdFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ParentIdFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createPhysicsComponent(
|
|
|
13
13
|
values?): PhysicsComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/PhysicsFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/PhysicsFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/PhysicsFactory.ts#L8)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createPostprocessingComponent(
|
|
|
13
13
|
values?): Postprocessing;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/PostprocessingFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/PostprocessingFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/PostprocessingFactory.ts#L7)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createScriptComponent(
|
|
|
13
13
|
payload?): ScriptComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/ScriptComponentFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/ScriptComponentFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/ScriptComponentFactory.ts#L8)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createSelectableComponent(
|
|
|
13
13
|
args): Selectable;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/SelectableFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/SelectableFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/SelectableFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createSelectionTransformStateComponent(
|
|
|
13
13
|
args): SelectionTransformState;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/SelectionTransformStateFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/SelectionTransformStateFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/SelectionTransformStateFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createSpriteComponent(
|
|
|
13
13
|
args): SpriteComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/SpriteFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/SpriteFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/SpriteFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createTransformComponent(
|
|
|
13
13
|
args): TransformComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/TransformFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/TransformFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/TransformFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function createVideoComponent(
|
|
|
13
13
|
args): VideoComponent;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [factories/components/VideoFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [factories/components/VideoFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/components/VideoFactory.ts#L4)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function hydrateWorldFromSnapshot(
|
|
|
13
13
|
objectManagementSystem): number;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [hydration/hydrateWorld.ts:
|
|
16
|
+
Defined in: [hydration/hydrateWorld.ts:289](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/hydrateWorld.ts#L289)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -13,7 +13,7 @@ function hydrateWorldFromSnapshotDetailed(
|
|
|
13
13
|
objectManagementSystem): HydrateWorldFromSnapshotResult;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [hydration/hydrateWorld.ts:
|
|
16
|
+
Defined in: [hydration/hydrateWorld.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/hydrateWorld.ts#L201)
|
|
17
17
|
|
|
18
18
|
## Parameters
|
|
19
19
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function registerDefaultComponentFactories(objectManagementSystem): void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [factories/registerDefaultComponentFactories.ts:
|
|
13
|
+
Defined in: [factories/registerDefaultComponentFactories.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/registerDefaultComponentFactories.ts#L30)
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function registerDefaultFactories(objectManagementSystem): void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [factories/registerDefaultFactories.ts:
|
|
13
|
+
Defined in: [factories/registerDefaultFactories.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/factories/registerDefaultFactories.ts#L24)
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -19,6 +19,7 @@
|
|
|
19
19
|
| [CameraSyncSystem](classes/CameraSyncSystem.md) | - |
|
|
20
20
|
| [EnvironmentSyncSystem](classes/EnvironmentSyncSystem.md) | - |
|
|
21
21
|
| [InputSystem](classes/InputSystem.md) | - |
|
|
22
|
+
| [InstancedMeshSystem](classes/InstancedMeshSystem.md) | Maintains the runtime geometry for entities with an [InstancedMeshComponent](../components/classes/InstancedMeshComponent.md). |
|
|
22
23
|
| [LightSyncSystem](classes/LightSyncSystem.md) | - |
|
|
23
24
|
| [MaterialSyncSystem](classes/MaterialSyncSystem.md) | - |
|
|
24
25
|
| [MeshGeometrySystem](classes/MeshGeometrySystem.md) | - |
|
|
@@ -77,6 +78,8 @@
|
|
|
77
78
|
| [createImageComponent](functions/createImageComponent.md) | - |
|
|
78
79
|
| [createImageTargetAnchorComponent](functions/createImageTargetAnchorComponent.md) | - |
|
|
79
80
|
| [createImageTargetComponent](functions/createImageTargetComponent.md) | - |
|
|
81
|
+
| [createInstanceSlotComponent](functions/createInstanceSlotComponent.md) | - |
|
|
82
|
+
| [createInstancedMeshComponent](functions/createInstancedMeshComponent.md) | - |
|
|
80
83
|
| [createLightComponent](functions/createLightComponent.md) | - |
|
|
81
84
|
| [createMaterialComponent](functions/createMaterialComponent.md) | - |
|
|
82
85
|
| [createMeshComponent](functions/createMeshComponent.md) | - |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EcsSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/System.ts#L3)
|
|
10
10
|
|
|
11
11
|
## Methods
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [System.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-
|
|
|
16
16
|
update(world, deltaTime): void;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
+
Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/System.ts#L4)
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
@@ -37,7 +37,7 @@ Defined in: [System.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-
|
|
|
37
37
|
optional dispose(world): void;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: [System.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
+
Defined in: [System.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/System.ts#L5)
|
|
41
41
|
|
|
42
42
|
#### Parameters
|
|
43
43
|
|
|
@@ -6,21 +6,21 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StateMachine
|
|
8
8
|
|
|
9
|
-
Defined in: [AnimationStateMachine.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L3)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
13
|
| Property | Type | Defined in |
|
|
14
14
|
| ------ | ------ | ------ |
|
|
15
|
-
| <a id="name"></a> `name` | `string` | [AnimationStateMachine.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
-
| <a id="clip"></a> `clip` | `AnimationClip` | [AnimationStateMachine.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
-
| <a id="clipid"></a> `clipId` | `string` \| `null` | [AnimationStateMachine.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
-
| <a id="loop"></a> `loop` | `boolean` | [AnimationStateMachine.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
-
| <a id="isplaying"></a> `isPlaying` | `boolean` | [AnimationStateMachine.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
20
|
-
| <a id="ispaused"></a> `isPaused` | `boolean` | [AnimationStateMachine.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
-
| <a id="onstart"></a> `onStart` | () => `void` | [AnimationStateMachine.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
-
| <a id="onplaying"></a> `onPlaying` | () => `void` | [AnimationStateMachine.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="onend"></a> `onEnd` | () => `void` | [AnimationStateMachine.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="play"></a> `play` | () => `void` | [AnimationStateMachine.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="pause"></a> `pause` | () => `void` | [AnimationStateMachine.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="stop"></a> `stop` | () => `void` | [AnimationStateMachine.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
| <a id="name"></a> `name` | `string` | [AnimationStateMachine.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L4) |
|
|
16
|
+
| <a id="clip"></a> `clip` | `AnimationClip` | [AnimationStateMachine.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L5) |
|
|
17
|
+
| <a id="clipid"></a> `clipId` | `string` \| `null` | [AnimationStateMachine.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L6) |
|
|
18
|
+
| <a id="loop"></a> `loop` | `boolean` | [AnimationStateMachine.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L7) |
|
|
19
|
+
| <a id="isplaying"></a> `isPlaying` | `boolean` | [AnimationStateMachine.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L8) |
|
|
20
|
+
| <a id="ispaused"></a> `isPaused` | `boolean` | [AnimationStateMachine.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L9) |
|
|
21
|
+
| <a id="onstart"></a> `onStart` | () => `void` | [AnimationStateMachine.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L10) |
|
|
22
|
+
| <a id="onplaying"></a> `onPlaying` | () => `void` | [AnimationStateMachine.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L11) |
|
|
23
|
+
| <a id="onend"></a> `onEnd` | () => `void` | [AnimationStateMachine.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L12) |
|
|
24
|
+
| <a id="play"></a> `play` | () => `void` | [AnimationStateMachine.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L13) |
|
|
25
|
+
| <a id="pause"></a> `pause` | () => `void` | [AnimationStateMachine.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L14) |
|
|
26
|
+
| <a id="stop"></a> `stop` | () => `void` | [AnimationStateMachine.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L15) |
|
|
@@ -14,12 +14,12 @@ type AnimationStateCallbacks = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [AnimationStateMachine.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [AnimationStateMachine.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L18)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="onstart"></a> `onStart?` | () => `void` | [AnimationStateMachine.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="onplaying"></a> `onPlaying?` | () => `void` | [AnimationStateMachine.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="onend"></a> `onEnd?` | () => `void` | [AnimationStateMachine.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="onstart"></a> `onStart?` | () => `void` | [AnimationStateMachine.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L19) |
|
|
24
|
+
| <a id="onplaying"></a> `onPlaying?` | () => `void` | [AnimationStateMachine.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L20) |
|
|
25
|
+
| <a id="onend"></a> `onEnd?` | () => `void` | [AnimationStateMachine.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/AnimationStateMachine.ts#L21) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type ComponentFactory = (world, entityId, ...args) => unknown;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/ObjectManagementSystem.ts:
|
|
13
|
+
Defined in: [systems/ObjectManagementSystem.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L58)
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -31,7 +31,8 @@ type EcsComponentFactoryKind =
|
|
|
31
31
|
| "selectionTransformState"
|
|
32
32
|
| "sprite"
|
|
33
33
|
| "transform"
|
|
34
|
-
| "video"
|
|
34
|
+
| "video"
|
|
35
|
+
| "instancedMesh";
|
|
35
36
|
```
|
|
36
37
|
|
|
37
|
-
Defined in: [systems/ObjectManagementSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
Defined in: [systems/ObjectManagementSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ObjectManagementSystem.ts#L31)
|
|
@@ -16,11 +16,11 @@ type EcsWorldComponentSnapshot = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [hydration/types.ts:
|
|
19
|
+
Defined in: [hydration/types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L40)
|
|
20
20
|
|
|
21
21
|
## Properties
|
|
22
22
|
|
|
23
23
|
| Property | Type | Defined in |
|
|
24
24
|
| ------ | ------ | ------ |
|
|
25
|
-
| <a id="component"></a> `component` | `string` | [hydration/types.ts:
|
|
26
|
-
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:
|
|
25
|
+
| <a id="component"></a> `component` | `string` | [hydration/types.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L41) |
|
|
26
|
+
| <a id="entries"></a> `entries` | \{ `entityId`: `number`; `value`: `unknown`; \}[] | [hydration/types.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L42) |
|
|
@@ -14,12 +14,12 @@ type EcsWorldStateSnapshotLike = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [hydration/types.ts:
|
|
17
|
+
Defined in: [hydration/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L48)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:
|
|
24
|
-
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:
|
|
25
|
-
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:
|
|
23
|
+
| <a id="selectedentityid"></a> `selectedEntityId?` | `number` \| `null` | [hydration/types.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L49) |
|
|
24
|
+
| <a id="entities"></a> `entities` | `number`[] | [hydration/types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L50) |
|
|
25
|
+
| <a id="components"></a> `components` | [`EcsWorldComponentSnapshot`](EcsWorldComponentSnapshot.md)[] | [hydration/types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L51) |
|
|
@@ -13,11 +13,11 @@ type HydrateWorldFromSnapshotResult = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [hydration/types.ts:
|
|
16
|
+
Defined in: [hydration/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L54)
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
20
|
| Property | Type | Defined in |
|
|
21
21
|
| ------ | ------ | ------ |
|
|
22
|
-
| <a id="restoredcount"></a> `restoredCount` | `number` | [hydration/types.ts:
|
|
23
|
-
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | [hydration/types.ts:
|
|
22
|
+
| <a id="restoredcount"></a> `restoredCount` | `number` | [hydration/types.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L55) |
|
|
23
|
+
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | [hydration/types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/hydration/types.ts#L56) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type KeyboardKey = typeof KeyboardKeys[keyof typeof KeyboardKeys];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/keyboardKeys.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/keyboardKeys.ts#L92)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type MouseButton = "left" | "middle" | "right";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/InputSystem.ts#L9)
|
|
@@ -14,7 +14,7 @@ type SelectionContext = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [systems/ScriptBehaviourSystem.ts:259](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [systems/ScriptBehaviourSystem.ts:259](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L259)
|
|
18
18
|
|
|
19
19
|
Optional context that enables raycast-based onSelect / onDeselect dispatch.
|
|
20
20
|
When provided, pointer/touch taps on the canvas fire a raycast against the
|
|
@@ -26,6 +26,6 @@ selected entity's instances receive onDeselect().
|
|
|
26
26
|
|
|
27
27
|
| Property | Type | Defined in |
|
|
28
28
|
| ------ | ------ | ------ |
|
|
29
|
-
| <a id="camera"></a> `camera` | `THREE.Camera` | [systems/ScriptBehaviourSystem.ts:260](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="scene"></a> `scene` | `THREE.Scene` | [systems/ScriptBehaviourSystem.ts:261](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="domelement"></a> `domElement` | `HTMLElement` | [systems/ScriptBehaviourSystem.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
| <a id="camera"></a> `camera` | `THREE.Camera` | [systems/ScriptBehaviourSystem.ts:260](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L260) |
|
|
30
|
+
| <a id="scene"></a> `scene` | `THREE.Scene` | [systems/ScriptBehaviourSystem.ts:261](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L261) |
|
|
31
|
+
| <a id="domelement"></a> `domElement` | `HTMLElement` | [systems/ScriptBehaviourSystem.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/7fc62aaeb41923795e50fda6e082908528d5abe6/core/systems/ScriptBehaviourSystem.ts#L262) |
|