@relu-interactives/spatial-ecs 0.2.2
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/README.md +125 -0
- package/dist/System-rXAmagXA.d.cts +659 -0
- package/dist/System-rXAmagXA.d.ts +659 -0
- package/dist/Video-CDemv74U.d.cts +1261 -0
- package/dist/Video-ChKV1UI7.d.ts +1261 -0
- package/dist/assets/draco/draco_decoder.js +34 -0
- package/dist/assets/draco/draco_decoder.wasm +0 -0
- package/dist/assets/draco/draco_wasm_wrapper.js +117 -0
- package/dist/chunk-AYEF3X2P.js +223 -0
- package/dist/chunk-AYEF3X2P.js.map +1 -0
- package/dist/chunk-MAWBTMCG.js +1722 -0
- package/dist/chunk-MAWBTMCG.js.map +1 -0
- package/dist/chunk-NFDTIYR4.js +248 -0
- package/dist/chunk-NFDTIYR4.js.map +1 -0
- package/dist/chunk-OY7ZODZP.js +16 -0
- package/dist/chunk-OY7ZODZP.js.map +1 -0
- package/dist/chunk-P2YDX5DB.js +3304 -0
- package/dist/chunk-P2YDX5DB.js.map +1 -0
- package/dist/chunk-QHILSPT4.js +3 -0
- package/dist/chunk-QHILSPT4.js.map +1 -0
- package/dist/chunk-XWIEEJ7Z.js +1315 -0
- package/dist/chunk-XWIEEJ7Z.js.map +1 -0
- package/dist/components/index.cjs +1745 -0
- package/dist/components/index.cjs.map +1 -0
- package/dist/components/index.d.cts +4 -0
- package/dist/components/index.d.ts +4 -0
- package/dist/components/index.js +4 -0
- package/dist/components/index.js.map +1 -0
- package/dist/docs/api/Behaviour/classes/Behaviour.md +554 -0
- package/dist/docs/api/Behaviour/index.md +15 -0
- package/dist/docs/api/Component/classes/Component.md +57 -0
- package/dist/docs/api/Component/index.md +15 -0
- package/dist/docs/api/components/classes/AnimationComponent.md +318 -0
- package/dist/docs/api/components/classes/AudioComponent.md +114 -0
- package/dist/docs/api/components/classes/CameraComponent.md +59 -0
- package/dist/docs/api/components/classes/EntityType.md +48 -0
- package/dist/docs/api/components/classes/Environment.md +47 -0
- package/dist/docs/api/components/classes/ImageComponent.md +57 -0
- package/dist/docs/api/components/classes/ImageTarget.md +60 -0
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +48 -0
- package/dist/docs/api/components/classes/LightComponent.md +70 -0
- package/dist/docs/api/components/classes/MaterialComponent.md +181 -0
- package/dist/docs/api/components/classes/MeshComponent.md +48 -0
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +64 -0
- package/dist/docs/api/components/classes/ModelComponent.md +49 -0
- package/dist/docs/api/components/classes/Name.md +46 -0
- package/dist/docs/api/components/classes/Object3DRef.md +54 -0
- package/dist/docs/api/components/classes/ParentId.md +47 -0
- package/dist/docs/api/components/classes/PhysicsComponent.md +82 -0
- package/dist/docs/api/components/classes/Postprocessing.md +49 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +54 -0
- package/dist/docs/api/components/classes/Selectable.md +46 -0
- package/dist/docs/api/components/classes/SelectionTransformState.md +54 -0
- package/dist/docs/api/components/classes/SpriteComponent.md +55 -0
- package/dist/docs/api/components/classes/TransformComponent.md +197 -0
- package/dist/docs/api/components/classes/VideoComponent.md +123 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +23 -0
- package/dist/docs/api/components/index.md +94 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +42 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +45 -0
- package/dist/docs/api/components/type-aliases/CameraProjection.md +15 -0
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderShape.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderState.md +62 -0
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +27 -0
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +37 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +34 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +29 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +25 -0
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +33 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +41 -0
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +75 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +13 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +33 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +25 -0
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +164 -0
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +23 -0
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +53 -0
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +19 -0
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +38 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformData.md +27 -0
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +15 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +27 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +13 -0
- package/dist/docs/api/index/classes/AnimationStateMachine.md +201 -0
- package/dist/docs/api/index/classes/AnimationStateManager.md +253 -0
- package/dist/docs/api/index/classes/AnimationSystem.md +68 -0
- package/dist/docs/api/index/classes/AudioSystem.md +98 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +75 -0
- package/dist/docs/api/index/classes/InputSystem.md +449 -0
- package/dist/docs/api/index/classes/LightSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +67 -0
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +49 -0
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +298 -0
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +49 -0
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +83 -0
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +80 -0
- package/dist/docs/api/index/classes/RenderSystem.md +64 -0
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +83 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +97 -0
- package/dist/docs/api/index/classes/World.md +1405 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +28 -0
- package/dist/docs/api/index/functions/createAudioComponent.md +32 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +28 -0
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +28 -0
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetComponent.md +28 -0
- package/dist/docs/api/index/functions/createLightComponent.md +28 -0
- package/dist/docs/api/index/functions/createMaterialComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +28 -0
- package/dist/docs/api/index/functions/createModelComponent.md +28 -0
- package/dist/docs/api/index/functions/createNameComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +28 -0
- package/dist/docs/api/index/functions/createParentIdComponent.md +28 -0
- package/dist/docs/api/index/functions/createPhysicsComponent.md +30 -0
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +28 -0
- package/dist/docs/api/index/functions/createScriptComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +28 -0
- package/dist/docs/api/index/functions/createSpriteComponent.md +28 -0
- package/dist/docs/api/index/functions/createTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +28 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +23 -0
- package/dist/docs/api/index/functions/registerDefaultFactories.md +23 -0
- package/dist/docs/api/index/index.md +249 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +50 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +26 -0
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +25 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +25 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +37 -0
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +26 -0
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +25 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +13 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +13 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +31 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +13 -0
- package/dist/docs/api/index/variables/KeyboardKeys.md +195 -0
- package/dist/docs/api/index.md +15 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -0
- package/dist/docs/api/types/index.md +34 -0
- package/dist/docs/api/types/type-aliases/AssetInput.md +23 -0
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ColorInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ComponentInput.md +52 -0
- package/dist/docs/api/types/type-aliases/ComponentKind.md +37 -0
- package/dist/docs/api/types/type-aliases/DropdownInput.md +23 -0
- package/dist/docs/api/types/type-aliases/DropdownOption.md +23 -0
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +15 -0
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +35 -0
- package/dist/docs/api/types/type-aliases/EntityId.md +16 -0
- package/dist/docs/api/types/type-aliases/EntityInput.md +23 -0
- package/dist/docs/api/types/type-aliases/FloatInput.md +13 -0
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +29 -0
- package/dist/docs/api/types/type-aliases/ParentLookup.md +26 -0
- package/dist/docs/api/types/type-aliases/SelectionListener.md +25 -0
- package/dist/docs/api/types/type-aliases/SliderInput.md +27 -0
- package/dist/docs/api/types/type-aliases/TextInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ToggleInput.md +13 -0
- package/dist/docs/api/types/type-aliases/Vec3.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector2Input.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector3Input.md +25 -0
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +17 -0
- package/dist/docs/guide/accessing-components.md +399 -0
- package/dist/docs/guide/authoring-a-behaviour.md +166 -0
- package/dist/docs/guide/behaviour-lifecycle.md +43 -0
- package/dist/docs/guide/component-catalog.md +59 -0
- package/dist/docs/guide/components/_sidebar.json +78 -0
- package/dist/docs/guide/components/animation.md +171 -0
- package/dist/docs/guide/components/audio.md +181 -0
- package/dist/docs/guide/components/camera.md +179 -0
- package/dist/docs/guide/components/entity-type.md +141 -0
- package/dist/docs/guide/components/image-target-anchor.md +103 -0
- package/dist/docs/guide/components/image-target.md +122 -0
- package/dist/docs/guide/components/image.md +146 -0
- package/dist/docs/guide/components/light.md +157 -0
- package/dist/docs/guide/components/material.md +161 -0
- package/dist/docs/guide/components/mesh-geometry.md +153 -0
- package/dist/docs/guide/components/mesh.md +151 -0
- package/dist/docs/guide/components/model.md +96 -0
- package/dist/docs/guide/components/name.md +121 -0
- package/dist/docs/guide/components/object3d-ref.md +115 -0
- package/dist/docs/guide/components/parent-id.md +108 -0
- package/dist/docs/guide/components/physics.md +163 -0
- package/dist/docs/guide/components/script.md +142 -0
- package/dist/docs/guide/components/sprite.md +155 -0
- package/dist/docs/guide/components/transform.md +155 -0
- package/dist/docs/guide/components/video.md +153 -0
- package/dist/docs/guide/concepts.md +34 -0
- package/dist/docs/guide/getting-started/creating-objects.md +50 -0
- package/dist/docs/guide/getting-started/editing-objects.md +62 -0
- package/dist/docs/guide/getting-started/editor/assets-browser.md +55 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +47 -0
- package/dist/docs/guide/getting-started/editor/index.md +16 -0
- package/dist/docs/guide/getting-started/editor/inspector.md +36 -0
- package/dist/docs/guide/getting-started/editor/modules.md +35 -0
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +64 -0
- package/dist/docs/guide/getting-started/editor/toolbar.md +39 -0
- package/dist/docs/guide/getting-started/editor/viewport.md +43 -0
- package/dist/docs/guide/getting-started/first-launch.md +17 -0
- package/dist/docs/guide/getting-started/index.md +37 -0
- package/dist/docs/guide/getting-started/installation.md +59 -0
- package/dist/docs/guide/getting-started/preview-and-test.md +55 -0
- package/dist/docs/guide/getting-started/project-types/3d.md +30 -0
- package/dist/docs/guide/getting-started/project-types/ar.md +6 -0
- package/dist/docs/guide/getting-started/project-types/face-tracking.md +6 -0
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +42 -0
- package/dist/docs/guide/getting-started/project-types/index.md +25 -0
- package/dist/docs/guide/getting-started/project-types/vr.md +6 -0
- package/dist/docs/guide/getting-started/projects.md +53 -0
- package/dist/docs/guide/getting-started/shortcuts.md +43 -0
- package/dist/docs/guide/inspector-data-binding.md +367 -0
- package/dist/docs/guide/reading-input.md +202 -0
- package/dist/docs/guide/scene/environment.md +101 -0
- package/dist/docs/guide/scene/index.md +36 -0
- package/dist/docs/guide/scene/postprocessing.md +108 -0
- package/dist/docs/guide/spawning/ambient-light.md +28 -0
- package/dist/docs/guide/spawning/area-light.md +32 -0
- package/dist/docs/guide/spawning/audio.md +42 -0
- package/dist/docs/guide/spawning/camera.md +50 -0
- package/dist/docs/guide/spawning/capsule.md +29 -0
- package/dist/docs/guide/spawning/cube.md +31 -0
- package/dist/docs/guide/spawning/cylinder.md +29 -0
- package/dist/docs/guide/spawning/directional-light.md +32 -0
- package/dist/docs/guide/spawning/empty.md +31 -0
- package/dist/docs/guide/spawning/image-target.md +48 -0
- package/dist/docs/guide/spawning/image.md +33 -0
- package/dist/docs/guide/spawning/index.md +79 -0
- package/dist/docs/guide/spawning/model.md +31 -0
- package/dist/docs/guide/spawning/plane.md +31 -0
- package/dist/docs/guide/spawning/point-light.md +32 -0
- package/dist/docs/guide/spawning/sphere.md +29 -0
- package/dist/docs/guide/spawning/spot-light.md +32 -0
- package/dist/docs/guide/spawning/sprite.md +31 -0
- package/dist/docs/guide/spawning/video.md +53 -0
- package/dist/docs/guide/system-overview.md +73 -0
- package/dist/docs/guide/systems/_sidebar.json +66 -0
- package/dist/docs/guide/systems/animation-system.md +32 -0
- package/dist/docs/guide/systems/audio-system.md +28 -0
- package/dist/docs/guide/systems/camera-sync-system.md +31 -0
- package/dist/docs/guide/systems/environment-sync-system.md +31 -0
- package/dist/docs/guide/systems/input-system.md +217 -0
- package/dist/docs/guide/systems/light-sync-system.md +29 -0
- package/dist/docs/guide/systems/material-sync-system.md +32 -0
- package/dist/docs/guide/systems/mesh-geometry-system.md +40 -0
- package/dist/docs/guide/systems/object-management-system.md +38 -0
- package/dist/docs/guide/systems/object-visibility-system.md +26 -0
- package/dist/docs/guide/systems/physics-sync-system.md +56 -0
- package/dist/docs/guide/systems/postprocessing-sync-system.md +43 -0
- package/dist/docs/guide/systems/render-system.md +22 -0
- package/dist/docs/guide/systems/script-behaviour-system.md +59 -0
- package/dist/docs/guide/systems/transform-sync-system.md +29 -0
- package/dist/docs/guide/systems/video-system.md +30 -0
- package/dist/docs/guide/world-api.md +405 -0
- package/dist/factories/index.cjs +3077 -0
- package/dist/factories/index.cjs.map +1 -0
- package/dist/factories/index.d.cts +69 -0
- package/dist/factories/index.d.ts +69 -0
- package/dist/factories/index.js +6 -0
- package/dist/factories/index.js.map +1 -0
- package/dist/index-B4-YyUNR.d.cts +73 -0
- package/dist/index-BZUOKeTO.d.ts +73 -0
- package/dist/index.cjs +8584 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +283 -0
- package/dist/index.d.ts +283 -0
- package/dist/index.js +1729 -0
- package/dist/index.js.map +1 -0
- package/dist/systems/index.cjs +5119 -0
- package/dist/systems/index.cjs.map +1 -0
- package/dist/systems/index.d.cts +200 -0
- package/dist/systems/index.d.ts +200 -0
- package/dist/systems/index.js +6 -0
- package/dist/systems/index.js.map +1 -0
- package/dist/types.cjs +4 -0
- package/dist/types.cjs.map +1 -0
- package/dist/types.d.cts +3 -0
- package/dist/types.d.ts +3 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/worldSnapshotUtils.cjs +259 -0
- package/dist/worldSnapshotUtils.cjs.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -0
- package/dist/worldSnapshotUtils.d.ts +3 -0
- package/dist/worldSnapshotUtils.js +4 -0
- package/dist/worldSnapshotUtils.js.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createAnimationComponent
|
|
6
|
+
|
|
7
|
+
# Function: createAnimationComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createAnimationComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): AnimationComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/AnimationFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[[`AnimationComponentOptions`](../../components/type-aliases/AnimationComponentOptions.md)\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`AnimationComponent`](../../components/classes/AnimationComponent.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createAudioComponent
|
|
6
|
+
|
|
7
|
+
# Function: createAudioComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createAudioComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
path?,
|
|
14
|
+
options?,
|
|
15
|
+
context?): AudioComponent;
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/AudioComponentFactory.ts#L126)
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Type | Default value |
|
|
23
|
+
| ------ | ------ | ------ |
|
|
24
|
+
| `world` | [`World`](../classes/World.md) | `undefined` |
|
|
25
|
+
| `entityId` | `number` | `undefined` |
|
|
26
|
+
| `path` | `string` | `""` |
|
|
27
|
+
| `options` | `Partial`\<[`AudioComponent`](../../components/classes/AudioComponent.md)\[`"options"`\]\> | `{}` |
|
|
28
|
+
| `context?` | `CreateAudioComponentContext` | `undefined` |
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
[`AudioComponent`](../../components/classes/AudioComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createCameraComponent
|
|
6
|
+
|
|
7
|
+
# Function: createCameraComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createCameraComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
payload?): CameraComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/CameraFactory.ts#L7)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| `payload` | [`CameraComponentOptions`](../../components/type-aliases/CameraComponentOptions.md) |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`CameraComponent`](../../components/classes/CameraComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createEntityTypeComponent
|
|
6
|
+
|
|
7
|
+
# Function: createEntityTypeComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createEntityTypeComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): EntityType;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/EntityTypeFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[ \| `"model"` \| `"image"` \| `"capsule"` \| `"cylinder"` \| `"cube"` \| `"sphere"` \| `"plane"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"editorUtility"`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`EntityType`](../../components/classes/EntityType.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createEnvironmentComponent
|
|
6
|
+
|
|
7
|
+
# Function: createEnvironmentComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createEnvironmentComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
values?): Environment;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/EnvironmentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/EnvironmentFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| `values?` | `Partial`\<[`EnvironmentState`](../../components/type-aliases/EnvironmentState.md)\> |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`Environment`](../../components/classes/Environment.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createImageComponent
|
|
6
|
+
|
|
7
|
+
# Function: createImageComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createImageComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): ImageComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ImageComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ImageComponentFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`string`, `number`, `number`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ImageComponent`](../../components/classes/ImageComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createImageTargetAnchorComponent
|
|
6
|
+
|
|
7
|
+
# Function: createImageTargetAnchorComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createImageTargetAnchorComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): ImageTargetAnchor;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ImageTargetAnchorFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ImageTargetAnchorFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[[`ImageTargetAnchorOptions`](../../components/type-aliases/ImageTargetAnchorOptions.md)\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ImageTargetAnchor`](../../components/classes/ImageTargetAnchor.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createImageTargetComponent
|
|
6
|
+
|
|
7
|
+
# Function: createImageTargetComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createImageTargetComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): ImageTarget;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ImageTargetFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ImageTargetFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[\{ `targets?`: [`ImageTargetReference`](../../components/type-aliases/ImageTargetReference.md)[]; `compiledTargetUrl?`: `string`; `compiledTargetDir?`: `string`; \}, `Texture`, `Object3D`\<`Object3DEventMap`\>\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ImageTarget`](../../components/classes/ImageTarget.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createLightComponent
|
|
6
|
+
|
|
7
|
+
# Function: createLightComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createLightComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): LightComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/LightFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/LightFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`Light`\<`LightShadow`\<`Camera`\> \| `undefined`\>\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`LightComponent`](../../components/classes/LightComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createMaterialComponent
|
|
6
|
+
|
|
7
|
+
# Function: createMaterialComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createMaterialComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): MaterialComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/MaterialFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/MaterialFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`Material` \| `Material`[]\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`MaterialComponent`](../../components/classes/MaterialComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createMeshComponent
|
|
6
|
+
|
|
7
|
+
# Function: createMeshComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createMeshComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): MeshComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/MeshFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/MeshFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`Object3D`\<`Object3DEventMap`\>\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`MeshComponent`](../../components/classes/MeshComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createMeshGeometryComponent
|
|
6
|
+
|
|
7
|
+
# Function: createMeshGeometryComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createMeshGeometryComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): MeshGeometryComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/MeshGeometryFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/MeshGeometryFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[[`EditableMeshObjectKind`](../../components/type-aliases/EditableMeshObjectKind.md), `Object3D`\<`Object3DEventMap`\> \| `null`, `Partial`\<[`MeshGeometryParameters`](../../components/type-aliases/MeshGeometryParameters.md)\>, \{ `modelName?`: `string`; `castShadow?`: `boolean`; `receiveShadow?`: `boolean`; \}\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`MeshGeometryComponent`](../../components/classes/MeshGeometryComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createModelComponent
|
|
6
|
+
|
|
7
|
+
# Function: createModelComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createModelComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): ModelComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ModelFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ModelFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`string`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ModelComponent`](../../components/classes/ModelComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createNameComponent
|
|
6
|
+
|
|
7
|
+
# Function: createNameComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createNameComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): Name;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/NameFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/NameFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`string`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`Name`](../../components/classes/Name.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createObject3DRefComponent
|
|
6
|
+
|
|
7
|
+
# Function: createObject3DRefComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createObject3DRefComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): Object3DRef;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/Object3DRefFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/Object3DRefFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`Object3D`\<`Object3DEventMap`\>, `boolean`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`Object3DRef`](../../components/classes/Object3DRef.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createParentIdComponent
|
|
6
|
+
|
|
7
|
+
# Function: createParentIdComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createParentIdComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): ParentId;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ParentIdFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ParentIdFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`number` \| `null`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ParentId`](../../components/classes/ParentId.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createPhysicsComponent
|
|
6
|
+
|
|
7
|
+
# Function: createPhysicsComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createPhysicsComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
values?): PhysicsComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/PhysicsFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/PhysicsFactory.ts#L8)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| `values?` | \{ `rigidbody?`: `Partial`\<[`RigidbodyState`](../../components/type-aliases/RigidbodyState.md)\>; `collider?`: `Partial`\<[`ColliderState`](../../components/type-aliases/ColliderState.md)\>; \} |
|
|
25
|
+
| `values.rigidbody?` | `Partial`\<[`RigidbodyState`](../../components/type-aliases/RigidbodyState.md)\> |
|
|
26
|
+
| `values.collider?` | `Partial`\<[`ColliderState`](../../components/type-aliases/ColliderState.md)\> |
|
|
27
|
+
|
|
28
|
+
## Returns
|
|
29
|
+
|
|
30
|
+
[`PhysicsComponent`](../../components/classes/PhysicsComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createPostprocessingComponent
|
|
6
|
+
|
|
7
|
+
# Function: createPostprocessingComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createPostprocessingComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
values?): Postprocessing;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/PostprocessingFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/PostprocessingFactory.ts#L7)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| `values?` | `Partial`\<[`PostprocessingState`](../../components/type-aliases/PostprocessingState.md)\> |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`Postprocessing`](../../components/classes/Postprocessing.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createScriptComponent
|
|
6
|
+
|
|
7
|
+
# Function: createScriptComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createScriptComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId,
|
|
13
|
+
payload?): ScriptComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/ScriptComponentFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/ScriptComponentFactory.ts#L8)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| `payload` | `ScriptComponentPayload` |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`ScriptComponent`](../../components/classes/ScriptComponent.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createSelectableComponent
|
|
6
|
+
|
|
7
|
+
# Function: createSelectableComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createSelectableComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): Selectable;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/SelectableFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/SelectableFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`boolean`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`Selectable`](../../components/classes/Selectable.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createSelectionTransformStateComponent
|
|
6
|
+
|
|
7
|
+
# Function: createSelectionTransformStateComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createSelectionTransformStateComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): SelectionTransformState;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/SelectionTransformStateFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/SelectionTransformStateFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[[`TransformModeValue`](../../components/type-aliases/TransformModeValue.md), [`TransformSpaceValue`](../../components/type-aliases/TransformSpaceValue.md), `number` \| `null`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`SelectionTransformState`](../../components/classes/SelectionTransformState.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createSpriteComponent
|
|
6
|
+
|
|
7
|
+
# Function: createSpriteComponent()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createSpriteComponent(
|
|
11
|
+
world,
|
|
12
|
+
entityId, ...
|
|
13
|
+
args): SpriteComponent;
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [factories/components/SpriteFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/factories/components/SpriteFactory.ts#L4)
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `world` | [`World`](../classes/World.md) |
|
|
23
|
+
| `entityId` | `number` |
|
|
24
|
+
| ...`args` | \[`string`, `number`, `number`\] |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`SpriteComponent`](../../components/classes/SpriteComponent.md)
|