@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,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / MouseButton
|
|
6
|
+
|
|
7
|
+
# Type Alias: MouseButton
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type MouseButton = "left" | "middle" | "right";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [systems/InputSystem.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/InputSystem.ts#L9)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / SelectionContext
|
|
6
|
+
|
|
7
|
+
# Type Alias: SelectionContext
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type SelectionContext = {
|
|
11
|
+
camera: THREE.Camera;
|
|
12
|
+
scene: THREE.Scene;
|
|
13
|
+
domElement: HTMLElement;
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [systems/ScriptBehaviourSystem.ts:259](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/ScriptBehaviourSystem.ts#L259)
|
|
18
|
+
|
|
19
|
+
Optional context that enables raycast-based onSelect / onDeselect dispatch.
|
|
20
|
+
When provided, pointer/touch taps on the canvas fire a raycast against the
|
|
21
|
+
scene. If the hit object (or any ancestor) carries userData.entityId, every
|
|
22
|
+
Behaviour instance for that entity receives onSelect(); the previously
|
|
23
|
+
selected entity's instances receive onDeselect().
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
| Property | Type | Defined in |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| <a id="camera"></a> `camera` | `THREE.Camera` | [systems/ScriptBehaviourSystem.ts:260](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/ScriptBehaviourSystem.ts#L262) |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / HYDRATABLE\_ENTITY\_KINDS
|
|
6
|
+
|
|
7
|
+
# Variable: HYDRATABLE\_ENTITY\_KINDS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const HYDRATABLE_ENTITY_KINDS: Set<EcsEntityKind>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [hydration/types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/hydration/types.ts#L57)
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / KeyboardKeys
|
|
6
|
+
|
|
7
|
+
# Variable: KeyboardKeys
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const KeyboardKeys: {
|
|
11
|
+
A: "a";
|
|
12
|
+
B: "b";
|
|
13
|
+
C: "c";
|
|
14
|
+
D: "d";
|
|
15
|
+
E: "e";
|
|
16
|
+
F: "f";
|
|
17
|
+
G: "g";
|
|
18
|
+
H: "h";
|
|
19
|
+
I: "i";
|
|
20
|
+
J: "j";
|
|
21
|
+
K: "k";
|
|
22
|
+
L: "l";
|
|
23
|
+
M: "m";
|
|
24
|
+
N: "n";
|
|
25
|
+
O: "o";
|
|
26
|
+
P: "p";
|
|
27
|
+
Q: "q";
|
|
28
|
+
R: "r";
|
|
29
|
+
S: "s";
|
|
30
|
+
T: "t";
|
|
31
|
+
U: "u";
|
|
32
|
+
V: "v";
|
|
33
|
+
W: "w";
|
|
34
|
+
X: "x";
|
|
35
|
+
Y: "y";
|
|
36
|
+
Z: "z";
|
|
37
|
+
Digit0: "0";
|
|
38
|
+
Digit1: "1";
|
|
39
|
+
Digit2: "2";
|
|
40
|
+
Digit3: "3";
|
|
41
|
+
Digit4: "4";
|
|
42
|
+
Digit5: "5";
|
|
43
|
+
Digit6: "6";
|
|
44
|
+
Digit7: "7";
|
|
45
|
+
Digit8: "8";
|
|
46
|
+
Digit9: "9";
|
|
47
|
+
Space: " ";
|
|
48
|
+
Enter: "enter";
|
|
49
|
+
Escape: "escape";
|
|
50
|
+
Tab: "tab";
|
|
51
|
+
Backspace: "backspace";
|
|
52
|
+
Delete: "delete";
|
|
53
|
+
Insert: "insert";
|
|
54
|
+
Home: "home";
|
|
55
|
+
End: "end";
|
|
56
|
+
PageUp: "pageup";
|
|
57
|
+
PageDown: "pagedown";
|
|
58
|
+
ArrowUp: "arrowup";
|
|
59
|
+
ArrowDown: "arrowdown";
|
|
60
|
+
ArrowLeft: "arrowleft";
|
|
61
|
+
ArrowRight: "arrowright";
|
|
62
|
+
Shift: "shift";
|
|
63
|
+
ShiftLeft: "shiftleft";
|
|
64
|
+
ShiftRight: "shiftright";
|
|
65
|
+
Control: "control";
|
|
66
|
+
ControlLeft: "controlleft";
|
|
67
|
+
ControlRight: "controlright";
|
|
68
|
+
Alt: "alt";
|
|
69
|
+
Meta: "meta";
|
|
70
|
+
CapsLock: "capslock";
|
|
71
|
+
NumLock: "numlock";
|
|
72
|
+
ScrollLock: "scrolllock";
|
|
73
|
+
Pause: "pause";
|
|
74
|
+
PrintScreen: "printscreen";
|
|
75
|
+
ContextMenu: "contextmenu";
|
|
76
|
+
Minus: "-";
|
|
77
|
+
Equal: "=";
|
|
78
|
+
BracketLeft: "[";
|
|
79
|
+
BracketRight: "]";
|
|
80
|
+
Backslash: "\";
|
|
81
|
+
Semicolon: ";";
|
|
82
|
+
Quote: "'";
|
|
83
|
+
Backquote: "`";
|
|
84
|
+
Comma: ",";
|
|
85
|
+
Period: ".";
|
|
86
|
+
Slash: "/";
|
|
87
|
+
F1: "f1";
|
|
88
|
+
F2: "f2";
|
|
89
|
+
F3: "f3";
|
|
90
|
+
F4: "f4";
|
|
91
|
+
F5: "f5";
|
|
92
|
+
F6: "f6";
|
|
93
|
+
F7: "f7";
|
|
94
|
+
F8: "f8";
|
|
95
|
+
F9: "f9";
|
|
96
|
+
F10: "f10";
|
|
97
|
+
F11: "f11";
|
|
98
|
+
F12: "f12";
|
|
99
|
+
};
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Defined in: [systems/keyboardKeys.ts:1](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L1)
|
|
103
|
+
|
|
104
|
+
## Type Declaration
|
|
105
|
+
|
|
106
|
+
| Name | Type | Default value | Defined in |
|
|
107
|
+
| ------ | ------ | ------ | ------ |
|
|
108
|
+
| <a id="property-a"></a> `A` | `"a"` | `"a"` | [systems/keyboardKeys.ts:2](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L2) |
|
|
109
|
+
| <a id="property-b"></a> `B` | `"b"` | `"b"` | [systems/keyboardKeys.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L3) |
|
|
110
|
+
| <a id="property-c"></a> `C` | `"c"` | `"c"` | [systems/keyboardKeys.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L4) |
|
|
111
|
+
| <a id="property-d"></a> `D` | `"d"` | `"d"` | [systems/keyboardKeys.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L5) |
|
|
112
|
+
| <a id="property-e"></a> `E` | `"e"` | `"e"` | [systems/keyboardKeys.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L6) |
|
|
113
|
+
| <a id="property-f"></a> `F` | `"f"` | `"f"` | [systems/keyboardKeys.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L7) |
|
|
114
|
+
| <a id="property-g"></a> `G` | `"g"` | `"g"` | [systems/keyboardKeys.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L8) |
|
|
115
|
+
| <a id="property-h"></a> `H` | `"h"` | `"h"` | [systems/keyboardKeys.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L9) |
|
|
116
|
+
| <a id="property-i"></a> `I` | `"i"` | `"i"` | [systems/keyboardKeys.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L10) |
|
|
117
|
+
| <a id="property-j"></a> `J` | `"j"` | `"j"` | [systems/keyboardKeys.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L11) |
|
|
118
|
+
| <a id="property-k"></a> `K` | `"k"` | `"k"` | [systems/keyboardKeys.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L12) |
|
|
119
|
+
| <a id="property-l"></a> `L` | `"l"` | `"l"` | [systems/keyboardKeys.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L13) |
|
|
120
|
+
| <a id="property-m"></a> `M` | `"m"` | `"m"` | [systems/keyboardKeys.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L14) |
|
|
121
|
+
| <a id="property-n"></a> `N` | `"n"` | `"n"` | [systems/keyboardKeys.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L15) |
|
|
122
|
+
| <a id="property-o"></a> `O` | `"o"` | `"o"` | [systems/keyboardKeys.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L16) |
|
|
123
|
+
| <a id="property-p"></a> `P` | `"p"` | `"p"` | [systems/keyboardKeys.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L17) |
|
|
124
|
+
| <a id="property-q"></a> `Q` | `"q"` | `"q"` | [systems/keyboardKeys.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L18) |
|
|
125
|
+
| <a id="property-r"></a> `R` | `"r"` | `"r"` | [systems/keyboardKeys.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L19) |
|
|
126
|
+
| <a id="property-s"></a> `S` | `"s"` | `"s"` | [systems/keyboardKeys.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L20) |
|
|
127
|
+
| <a id="property-t"></a> `T` | `"t"` | `"t"` | [systems/keyboardKeys.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L21) |
|
|
128
|
+
| <a id="property-u"></a> `U` | `"u"` | `"u"` | [systems/keyboardKeys.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L22) |
|
|
129
|
+
| <a id="property-v"></a> `V` | `"v"` | `"v"` | [systems/keyboardKeys.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L23) |
|
|
130
|
+
| <a id="property-w"></a> `W` | `"w"` | `"w"` | [systems/keyboardKeys.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L24) |
|
|
131
|
+
| <a id="property-x"></a> `X` | `"x"` | `"x"` | [systems/keyboardKeys.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L25) |
|
|
132
|
+
| <a id="property-y"></a> `Y` | `"y"` | `"y"` | [systems/keyboardKeys.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L26) |
|
|
133
|
+
| <a id="property-z"></a> `Z` | `"z"` | `"z"` | [systems/keyboardKeys.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L27) |
|
|
134
|
+
| <a id="property-digit0"></a> `Digit0` | `"0"` | `"0"` | [systems/keyboardKeys.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L28) |
|
|
135
|
+
| <a id="property-digit1"></a> `Digit1` | `"1"` | `"1"` | [systems/keyboardKeys.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L29) |
|
|
136
|
+
| <a id="property-digit2"></a> `Digit2` | `"2"` | `"2"` | [systems/keyboardKeys.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L30) |
|
|
137
|
+
| <a id="property-digit3"></a> `Digit3` | `"3"` | `"3"` | [systems/keyboardKeys.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L31) |
|
|
138
|
+
| <a id="property-digit4"></a> `Digit4` | `"4"` | `"4"` | [systems/keyboardKeys.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L32) |
|
|
139
|
+
| <a id="property-digit5"></a> `Digit5` | `"5"` | `"5"` | [systems/keyboardKeys.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L33) |
|
|
140
|
+
| <a id="property-digit6"></a> `Digit6` | `"6"` | `"6"` | [systems/keyboardKeys.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L34) |
|
|
141
|
+
| <a id="property-digit7"></a> `Digit7` | `"7"` | `"7"` | [systems/keyboardKeys.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L35) |
|
|
142
|
+
| <a id="property-digit8"></a> `Digit8` | `"8"` | `"8"` | [systems/keyboardKeys.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L36) |
|
|
143
|
+
| <a id="property-digit9"></a> `Digit9` | `"9"` | `"9"` | [systems/keyboardKeys.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L37) |
|
|
144
|
+
| <a id="property-space"></a> `Space` | `" "` | `" "` | [systems/keyboardKeys.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L38) |
|
|
145
|
+
| <a id="property-enter"></a> `Enter` | `"enter"` | `"enter"` | [systems/keyboardKeys.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L39) |
|
|
146
|
+
| <a id="property-escape"></a> `Escape` | `"escape"` | `"escape"` | [systems/keyboardKeys.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L40) |
|
|
147
|
+
| <a id="property-tab"></a> `Tab` | `"tab"` | `"tab"` | [systems/keyboardKeys.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L41) |
|
|
148
|
+
| <a id="property-backspace"></a> `Backspace` | `"backspace"` | `"backspace"` | [systems/keyboardKeys.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L42) |
|
|
149
|
+
| <a id="property-delete"></a> `Delete` | `"delete"` | `"delete"` | [systems/keyboardKeys.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L43) |
|
|
150
|
+
| <a id="property-insert"></a> `Insert` | `"insert"` | `"insert"` | [systems/keyboardKeys.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L44) |
|
|
151
|
+
| <a id="property-home"></a> `Home` | `"home"` | `"home"` | [systems/keyboardKeys.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L45) |
|
|
152
|
+
| <a id="property-end"></a> `End` | `"end"` | `"end"` | [systems/keyboardKeys.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L46) |
|
|
153
|
+
| <a id="property-pageup"></a> `PageUp` | `"pageup"` | `"pageup"` | [systems/keyboardKeys.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L47) |
|
|
154
|
+
| <a id="property-pagedown"></a> `PageDown` | `"pagedown"` | `"pagedown"` | [systems/keyboardKeys.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L48) |
|
|
155
|
+
| <a id="property-arrowup"></a> `ArrowUp` | `"arrowup"` | `"arrowup"` | [systems/keyboardKeys.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L49) |
|
|
156
|
+
| <a id="property-arrowdown"></a> `ArrowDown` | `"arrowdown"` | `"arrowdown"` | [systems/keyboardKeys.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L50) |
|
|
157
|
+
| <a id="property-arrowleft"></a> `ArrowLeft` | `"arrowleft"` | `"arrowleft"` | [systems/keyboardKeys.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L51) |
|
|
158
|
+
| <a id="property-arrowright"></a> `ArrowRight` | `"arrowright"` | `"arrowright"` | [systems/keyboardKeys.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L52) |
|
|
159
|
+
| <a id="property-shift"></a> `Shift` | `"shift"` | `"shift"` | [systems/keyboardKeys.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L53) |
|
|
160
|
+
| <a id="property-shiftleft"></a> `ShiftLeft` | `"shiftleft"` | `"shiftleft"` | [systems/keyboardKeys.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L54) |
|
|
161
|
+
| <a id="property-shiftright"></a> `ShiftRight` | `"shiftright"` | `"shiftright"` | [systems/keyboardKeys.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L55) |
|
|
162
|
+
| <a id="property-control"></a> `Control` | `"control"` | `"control"` | [systems/keyboardKeys.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L56) |
|
|
163
|
+
| <a id="property-controlleft"></a> `ControlLeft` | `"controlleft"` | `"controlleft"` | [systems/keyboardKeys.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L57) |
|
|
164
|
+
| <a id="property-controlright"></a> `ControlRight` | `"controlright"` | `"controlright"` | [systems/keyboardKeys.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L58) |
|
|
165
|
+
| <a id="property-alt"></a> `Alt` | `"alt"` | `"alt"` | [systems/keyboardKeys.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L59) |
|
|
166
|
+
| <a id="property-meta"></a> `Meta` | `"meta"` | `"meta"` | [systems/keyboardKeys.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L60) |
|
|
167
|
+
| <a id="property-capslock"></a> `CapsLock` | `"capslock"` | `"capslock"` | [systems/keyboardKeys.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L61) |
|
|
168
|
+
| <a id="property-numlock"></a> `NumLock` | `"numlock"` | `"numlock"` | [systems/keyboardKeys.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L62) |
|
|
169
|
+
| <a id="property-scrolllock"></a> `ScrollLock` | `"scrolllock"` | `"scrolllock"` | [systems/keyboardKeys.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L63) |
|
|
170
|
+
| <a id="property-pause"></a> `Pause` | `"pause"` | `"pause"` | [systems/keyboardKeys.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L64) |
|
|
171
|
+
| <a id="property-printscreen"></a> `PrintScreen` | `"printscreen"` | `"printscreen"` | [systems/keyboardKeys.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L65) |
|
|
172
|
+
| <a id="property-contextmenu"></a> `ContextMenu` | `"contextmenu"` | `"contextmenu"` | [systems/keyboardKeys.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L66) |
|
|
173
|
+
| <a id="property-minus"></a> `Minus` | `"-"` | `"-"` | [systems/keyboardKeys.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L67) |
|
|
174
|
+
| <a id="property-equal"></a> `Equal` | `"="` | `"="` | [systems/keyboardKeys.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L68) |
|
|
175
|
+
| <a id="property-bracketleft"></a> `BracketLeft` | `"["` | `"["` | [systems/keyboardKeys.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L69) |
|
|
176
|
+
| <a id="property-bracketright"></a> `BracketRight` | `"]"` | `"]"` | [systems/keyboardKeys.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L70) |
|
|
177
|
+
| <a id="property-backslash"></a> `Backslash` | "\\" | "\\" | [systems/keyboardKeys.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L71) |
|
|
178
|
+
| <a id="property-semicolon"></a> `Semicolon` | `";"` | `";"` | [systems/keyboardKeys.ts:72](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L72) |
|
|
179
|
+
| <a id="property-quote"></a> `Quote` | `"'"` | `"'"` | [systems/keyboardKeys.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L73) |
|
|
180
|
+
| <a id="property-backquote"></a> `Backquote` | `` "`" `` | `` "`" `` | [systems/keyboardKeys.ts:74](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L74) |
|
|
181
|
+
| <a id="property-comma"></a> `Comma` | `","` | `","` | [systems/keyboardKeys.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L75) |
|
|
182
|
+
| <a id="property-period"></a> `Period` | `"."` | `"."` | [systems/keyboardKeys.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L76) |
|
|
183
|
+
| <a id="property-slash"></a> `Slash` | `"/"` | `"/"` | [systems/keyboardKeys.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L77) |
|
|
184
|
+
| <a id="property-f1"></a> `F1` | `"f1"` | `"f1"` | [systems/keyboardKeys.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L78) |
|
|
185
|
+
| <a id="property-f2"></a> `F2` | `"f2"` | `"f2"` | [systems/keyboardKeys.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L79) |
|
|
186
|
+
| <a id="property-f3"></a> `F3` | `"f3"` | `"f3"` | [systems/keyboardKeys.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L80) |
|
|
187
|
+
| <a id="property-f4"></a> `F4` | `"f4"` | `"f4"` | [systems/keyboardKeys.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L81) |
|
|
188
|
+
| <a id="property-f5"></a> `F5` | `"f5"` | `"f5"` | [systems/keyboardKeys.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L82) |
|
|
189
|
+
| <a id="property-f6"></a> `F6` | `"f6"` | `"f6"` | [systems/keyboardKeys.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L83) |
|
|
190
|
+
| <a id="property-f7"></a> `F7` | `"f7"` | `"f7"` | [systems/keyboardKeys.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L84) |
|
|
191
|
+
| <a id="property-f8"></a> `F8` | `"f8"` | `"f8"` | [systems/keyboardKeys.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L85) |
|
|
192
|
+
| <a id="property-f9"></a> `F9` | `"f9"` | `"f9"` | [systems/keyboardKeys.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L86) |
|
|
193
|
+
| <a id="property-f10"></a> `F10` | `"f10"` | `"f10"` | [systems/keyboardKeys.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L87) |
|
|
194
|
+
| <a id="property-f11"></a> `F11` | `"f11"` | `"f11"` | [systems/keyboardKeys.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L88) |
|
|
195
|
+
| <a id="property-f12"></a> `F12` | `"f12"` | `"f12"` | [systems/keyboardKeys.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/keyboardKeys.ts#L89) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
**@relu-interactives/spatial-ecs**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# @relu-interactives/spatial-ecs
|
|
6
|
+
|
|
7
|
+
## Modules
|
|
8
|
+
|
|
9
|
+
| Module | Description |
|
|
10
|
+
| ------ | ------ |
|
|
11
|
+
| [Behaviour](Behaviour/index.md) | - |
|
|
12
|
+
| [Component](Component/index.md) | - |
|
|
13
|
+
| [components](components/index.md) | - |
|
|
14
|
+
| [index](index/index.md) | - |
|
|
15
|
+
| [types](types/index.md) | - |
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
[{"text":"Behaviour","link":"/api/Behaviour/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"Scripting","collapsed":true,"items":[{"text":"Behaviour","link":"/api/Behaviour/classes/Behaviour.md"}]}]}]},{"text":"Component","link":"/api/Component/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"Components","collapsed":true,"items":[{"text":"Component","link":"/api/Component/classes/Component.md"}]}]}]},{"text":"components","link":"/api/components/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"Components","collapsed":true,"items":[{"text":"AnimationComponent","link":"/api/components/classes/AnimationComponent.md"},{"text":"AudioComponent","link":"/api/components/classes/AudioComponent.md"},{"text":"CameraComponent","link":"/api/components/classes/CameraComponent.md"},{"text":"EntityType","link":"/api/components/classes/EntityType.md"},{"text":"Environment","link":"/api/components/classes/Environment.md"},{"text":"ImageComponent","link":"/api/components/classes/ImageComponent.md"},{"text":"ImageTarget","link":"/api/components/classes/ImageTarget.md"},{"text":"ImageTargetAnchor","link":"/api/components/classes/ImageTargetAnchor.md"},{"text":"LightComponent","link":"/api/components/classes/LightComponent.md"},{"text":"MaterialComponent","link":"/api/components/classes/MaterialComponent.md"},{"text":"MeshComponent","link":"/api/components/classes/MeshComponent.md"},{"text":"MeshGeometryComponent","link":"/api/components/classes/MeshGeometryComponent.md"},{"text":"ModelComponent","link":"/api/components/classes/ModelComponent.md"},{"text":"Name","link":"/api/components/classes/Name.md"},{"text":"Object3DRef","link":"/api/components/classes/Object3DRef.md"},{"text":"ParentId","link":"/api/components/classes/ParentId.md"},{"text":"PhysicsComponent","link":"/api/components/classes/PhysicsComponent.md"},{"text":"Postprocessing","link":"/api/components/classes/Postprocessing.md"},{"text":"ScriptComponent","link":"/api/components/classes/ScriptComponent.md"},{"text":"Selectable","link":"/api/components/classes/Selectable.md"},{"text":"SelectionTransformState","link":"/api/components/classes/SelectionTransformState.md"},{"text":"SpriteComponent","link":"/api/components/classes/SpriteComponent.md"},{"text":"TransformComponent","link":"/api/components/classes/TransformComponent.md"},{"text":"VideoComponent","link":"/api/components/classes/VideoComponent.md"}]}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AnimationComponentOptions","link":"/api/components/type-aliases/AnimationComponentOptions.md"},{"text":"CameraRuntimeType","link":"/api/components/type-aliases/CameraRuntimeType.md"},{"text":"CameraProjection","link":"/api/components/type-aliases/CameraProjection.md"},{"text":"CameraComponentOptions","link":"/api/components/type-aliases/CameraComponentOptions.md"},{"text":"EnvironmentSkyboxType","link":"/api/components/type-aliases/EnvironmentSkyboxType.md"},{"text":"EnvironmentGradientEffect","link":"/api/components/type-aliases/EnvironmentGradientEffect.md"},{"text":"EnvironmentFogType","link":"/api/components/type-aliases/EnvironmentFogType.md"},{"text":"EnvironmentSkyboxState","link":"/api/components/type-aliases/EnvironmentSkyboxState.md"},{"text":"EnvironmentFogState","link":"/api/components/type-aliases/EnvironmentFogState.md"},{"text":"EnvironmentState","link":"/api/components/type-aliases/EnvironmentState.md"},{"text":"ImageTargetReference","link":"/api/components/type-aliases/ImageTargetReference.md"},{"text":"ImageTargetAnchorOptions","link":"/api/components/type-aliases/ImageTargetAnchorOptions.md"},{"text":"LightValueState","link":"/api/components/type-aliases/LightValueState.md"},{"text":"MaterialTypeValue","link":"/api/components/type-aliases/MaterialTypeValue.md"},{"text":"TextureFilteringValue","link":"/api/components/type-aliases/TextureFilteringValue.md"},{"text":"MaterialValueState","link":"/api/components/type-aliases/MaterialValueState.md"},{"text":"EditableMeshObjectKind","link":"/api/components/type-aliases/EditableMeshObjectKind.md"},{"text":"CubeMeshParameters","link":"/api/components/type-aliases/CubeMeshParameters.md"},{"text":"PlaneMeshParameters","link":"/api/components/type-aliases/PlaneMeshParameters.md"},{"text":"RadiusMeshParameters","link":"/api/components/type-aliases/RadiusMeshParameters.md"},{"text":"RadiusHeightMeshParameters","link":"/api/components/type-aliases/RadiusHeightMeshParameters.md"},{"text":"MeshGeometryParametersByKind","link":"/api/components/type-aliases/MeshGeometryParametersByKind.md"},{"text":"MeshGeometryParameters","link":"/api/components/type-aliases/MeshGeometryParameters.md"},{"text":"RigidbodyType","link":"/api/components/type-aliases/RigidbodyType.md"},{"text":"RigidbodyState","link":"/api/components/type-aliases/RigidbodyState.md"},{"text":"ColliderShape","link":"/api/components/type-aliases/ColliderShape.md"},{"text":"ColliderState","link":"/api/components/type-aliases/ColliderState.md"},{"text":"PhysicsState","link":"/api/components/type-aliases/PhysicsState.md"},{"text":"PostprocessingState","link":"/api/components/type-aliases/PostprocessingState.md"},{"text":"ScriptEntry","link":"/api/components/type-aliases/ScriptEntry.md"},{"text":"TransformModeValue","link":"/api/components/type-aliases/TransformModeValue.md"},{"text":"TransformSpaceValue","link":"/api/components/type-aliases/TransformSpaceValue.md"},{"text":"Vec3","link":"/api/components/type-aliases/Vec3.md"},{"text":"TransformData","link":"/api/components/type-aliases/TransformData.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"DEFAULT_ENVIRONMENT_STATE","link":"/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md"},{"text":"DEFAULT_MESH_GEOMETRY_PARAMETERS","link":"/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md"},{"text":"DEFAULT_RIGIDBODY_STATE","link":"/api/components/variables/DEFAULT_RIGIDBODY_STATE.md"},{"text":"DEFAULT_COLLIDER_STATE","link":"/api/components/variables/DEFAULT_COLLIDER_STATE.md"},{"text":"DEFAULT_PHYSICS_STATE","link":"/api/components/variables/DEFAULT_PHYSICS_STATE.md"},{"text":"DEFAULT_POSTPROCESSING_STATE","link":"/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"normalizePhysicsState","link":"/api/components/functions/normalizePhysicsState.md"}]}]},{"text":"index","link":"/api/index/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"Other","collapsed":true,"items":[{"text":"AnimationStateMachine","link":"/api/index/classes/AnimationStateMachine.md"},{"text":"AnimationStateManager","link":"/api/index/classes/AnimationStateManager.md"},{"text":"World","link":"/api/index/classes/World.md"},{"text":"AnimationSystem","link":"/api/index/classes/AnimationSystem.md"},{"text":"CameraSyncSystem","link":"/api/index/classes/CameraSyncSystem.md"},{"text":"EnvironmentSyncSystem","link":"/api/index/classes/EnvironmentSyncSystem.md"},{"text":"InputSystem","link":"/api/index/classes/InputSystem.md"},{"text":"LightSyncSystem","link":"/api/index/classes/LightSyncSystem.md"},{"text":"MaterialSyncSystem","link":"/api/index/classes/MaterialSyncSystem.md"},{"text":"MeshGeometrySystem","link":"/api/index/classes/MeshGeometrySystem.md"},{"text":"ObjectManagementSystem","link":"/api/index/classes/ObjectManagementSystem.md"},{"text":"ObjectVisibilitySystem","link":"/api/index/classes/ObjectVisibilitySystem.md"},{"text":"PhysicsSyncSystem","link":"/api/index/classes/PhysicsSyncSystem.md"},{"text":"PostprocessingSyncSystem","link":"/api/index/classes/PostprocessingSyncSystem.md"},{"text":"RenderSystem","link":"/api/index/classes/RenderSystem.md"},{"text":"ScriptBehaviourSystem","link":"/api/index/classes/ScriptBehaviourSystem.md"},{"text":"TransformSyncSystem","link":"/api/index/classes/TransformSyncSystem.md"}]},{"text":"Systems","collapsed":true,"items":[{"text":"AudioSystem","link":"/api/index/classes/AudioSystem.md"},{"text":"VideoSystem","link":"/api/index/classes/VideoSystem.md"}]}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"StateMachine","link":"/api/index/interfaces/StateMachine.md"},{"text":"EcsSystem","link":"/api/index/interfaces/EcsSystem.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AnimationStateCallbacks","link":"/api/index/type-aliases/AnimationStateCallbacks.md"},{"text":"EcsWorldComponentSnapshot","link":"/api/index/type-aliases/EcsWorldComponentSnapshot.md"},{"text":"EcsWorldStateSnapshotLike","link":"/api/index/type-aliases/EcsWorldStateSnapshotLike.md"},{"text":"HydrateWorldFromSnapshotResult","link":"/api/index/type-aliases/HydrateWorldFromSnapshotResult.md"},{"text":"MouseButton","link":"/api/index/type-aliases/MouseButton.md"},{"text":"EcsComponentFactoryKind","link":"/api/index/type-aliases/EcsComponentFactoryKind.md"},{"text":"ComponentFactory","link":"/api/index/type-aliases/ComponentFactory.md"},{"text":"SelectionContext","link":"/api/index/type-aliases/SelectionContext.md"},{"text":"KeyboardKey","link":"/api/index/type-aliases/KeyboardKey.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"HYDRATABLE_ENTITY_KINDS","link":"/api/index/variables/HYDRATABLE_ENTITY_KINDS.md"},{"text":"KeyboardKeys","link":"/api/index/variables/KeyboardKeys.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createAnimationComponent","link":"/api/index/functions/createAnimationComponent.md"},{"text":"createAudioComponent","link":"/api/index/functions/createAudioComponent.md"},{"text":"createCameraComponent","link":"/api/index/functions/createCameraComponent.md"},{"text":"createEntityTypeComponent","link":"/api/index/functions/createEntityTypeComponent.md"},{"text":"createEnvironmentComponent","link":"/api/index/functions/createEnvironmentComponent.md"},{"text":"createImageComponent","link":"/api/index/functions/createImageComponent.md"},{"text":"createImageTargetAnchorComponent","link":"/api/index/functions/createImageTargetAnchorComponent.md"},{"text":"createImageTargetComponent","link":"/api/index/functions/createImageTargetComponent.md"},{"text":"createLightComponent","link":"/api/index/functions/createLightComponent.md"},{"text":"createMaterialComponent","link":"/api/index/functions/createMaterialComponent.md"},{"text":"createMeshComponent","link":"/api/index/functions/createMeshComponent.md"},{"text":"createMeshGeometryComponent","link":"/api/index/functions/createMeshGeometryComponent.md"},{"text":"createModelComponent","link":"/api/index/functions/createModelComponent.md"},{"text":"createNameComponent","link":"/api/index/functions/createNameComponent.md"},{"text":"createObject3DRefComponent","link":"/api/index/functions/createObject3DRefComponent.md"},{"text":"createParentIdComponent","link":"/api/index/functions/createParentIdComponent.md"},{"text":"createPhysicsComponent","link":"/api/index/functions/createPhysicsComponent.md"},{"text":"createPostprocessingComponent","link":"/api/index/functions/createPostprocessingComponent.md"},{"text":"createScriptComponent","link":"/api/index/functions/createScriptComponent.md"},{"text":"createSelectableComponent","link":"/api/index/functions/createSelectableComponent.md"},{"text":"createSelectionTransformStateComponent","link":"/api/index/functions/createSelectionTransformStateComponent.md"},{"text":"createSpriteComponent","link":"/api/index/functions/createSpriteComponent.md"},{"text":"createTransformComponent","link":"/api/index/functions/createTransformComponent.md"},{"text":"createVideoComponent","link":"/api/index/functions/createVideoComponent.md"},{"text":"registerDefaultComponentFactories","link":"/api/index/functions/registerDefaultComponentFactories.md"},{"text":"registerDefaultFactories","link":"/api/index/functions/registerDefaultFactories.md"},{"text":"hydrateWorldFromSnapshotDetailed","link":"/api/index/functions/hydrateWorldFromSnapshotDetailed.md"},{"text":"hydrateWorldFromSnapshot","link":"/api/index/functions/hydrateWorldFromSnapshot.md"}]}]},{"text":"types","link":"/api/types/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"EntityId","link":"/api/types/type-aliases/EntityId.md"},{"text":"EcsEntityKind","link":"/api/types/type-aliases/EcsEntityKind.md"},{"text":"EcsEntityEditorKind","link":"/api/types/type-aliases/EcsEntityEditorKind.md"},{"text":"SelectionListener","link":"/api/types/type-aliases/SelectionListener.md"},{"text":"TextInput","link":"/api/types/type-aliases/TextInput.md"},{"text":"FloatInput","link":"/api/types/type-aliases/FloatInput.md"},{"text":"ColorInput","link":"/api/types/type-aliases/ColorInput.md"},{"text":"Vector2Input","link":"/api/types/type-aliases/Vector2Input.md"},{"text":"Vector3Input","link":"/api/types/type-aliases/Vector3Input.md"},{"text":"SliderInput","link":"/api/types/type-aliases/SliderInput.md"},{"text":"DropdownOption","link":"/api/types/type-aliases/DropdownOption.md"},{"text":"DropdownInput","link":"/api/types/type-aliases/DropdownInput.md"},{"text":"CheckboxInput","link":"/api/types/type-aliases/CheckboxInput.md"},{"text":"ToggleInput","link":"/api/types/type-aliases/ToggleInput.md"},{"text":"AssetInput","link":"/api/types/type-aliases/AssetInput.md"},{"text":"EntityInput","link":"/api/types/type-aliases/EntityInput.md"},{"text":"ComponentKind","link":"/api/types/type-aliases/ComponentKind.md"},{"text":"ComponentInput","link":"/api/types/type-aliases/ComponentInput.md"},{"text":"WorldEntityView","link":"/api/types/type-aliases/WorldEntityView.md"},{"text":"ParentLookup","link":"/api/types/type-aliases/ParentLookup.md"},{"text":"Vec3","link":"/api/types/type-aliases/Vec3.md"},{"text":"IntersectionResult","link":"/api/types/type-aliases/IntersectionResult.md"}]}]}]
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../index.md) / types
|
|
6
|
+
|
|
7
|
+
# types
|
|
8
|
+
|
|
9
|
+
## Type Aliases
|
|
10
|
+
|
|
11
|
+
| Type Alias | Description |
|
|
12
|
+
| ------ | ------ |
|
|
13
|
+
| [EntityId](type-aliases/EntityId.md) | Numeric identifier for an entity. Entities are pure ids — all data lives in components attached to the entity. |
|
|
14
|
+
| [EcsEntityKind](type-aliases/EcsEntityKind.md) | Built-in entity kinds recognized by the ECS factory registry. Each kind maps to an object factory in `core/factories/objects/*` that creates the baseline component set. |
|
|
15
|
+
| [EcsEntityEditorKind](type-aliases/EcsEntityEditorKind.md) | [EcsEntityKind](type-aliases/EcsEntityKind.md) extended with editor-only utility entities (gizmos, helpers). |
|
|
16
|
+
| [SelectionListener](type-aliases/SelectionListener.md) | Callback invoked when the selected entity changes. `null` indicates a deselection. |
|
|
17
|
+
| [TextInput](type-aliases/TextInput.md) | - |
|
|
18
|
+
| [FloatInput](type-aliases/FloatInput.md) | - |
|
|
19
|
+
| [ColorInput](type-aliases/ColorInput.md) | - |
|
|
20
|
+
| [Vector2Input](type-aliases/Vector2Input.md) | - |
|
|
21
|
+
| [Vector3Input](type-aliases/Vector3Input.md) | - |
|
|
22
|
+
| [SliderInput](type-aliases/SliderInput.md) | - |
|
|
23
|
+
| [DropdownOption](type-aliases/DropdownOption.md) | - |
|
|
24
|
+
| [DropdownInput](type-aliases/DropdownInput.md) | - |
|
|
25
|
+
| [CheckboxInput](type-aliases/CheckboxInput.md) | - |
|
|
26
|
+
| [ToggleInput](type-aliases/ToggleInput.md) | - |
|
|
27
|
+
| [AssetInput](type-aliases/AssetInput.md) | - |
|
|
28
|
+
| [EntityInput](type-aliases/EntityInput.md) | - |
|
|
29
|
+
| [ComponentKind](type-aliases/ComponentKind.md) | - |
|
|
30
|
+
| [ComponentInput](type-aliases/ComponentInput.md) | Inspector field that lets the user drag an entity and optionally pick a component from it. |
|
|
31
|
+
| [WorldEntityView](type-aliases/WorldEntityView.md) | Lightweight, read-only view of an entity returned by `World.getEntityById`. Contains the entity id and its current component list at the moment of the lookup. Re-query each frame rather than caching across ticks. |
|
|
32
|
+
| [ParentLookup](type-aliases/ParentLookup.md) | Result of a parent lookup. `parent` is `null` for entities at the root or for entities without a [ParentId](../components/classes/ParentId.md) component. |
|
|
33
|
+
| [Vec3](type-aliases/Vec3.md) | Loose 3D vector accepted by raycast and other spatial helpers. Either a live `THREE.Vector3` or a plain `{ x, y, z }` object — both are normalized internally before use. |
|
|
34
|
+
| [IntersectionResult](type-aliases/IntersectionResult.md) | Single hit returned by `World.raycast` / `World.raycastFrom`. Pairs the standard `THREE.Intersection` (`threeResult`) with the owning entity id (when the hit traces back to a registered ECS entity). `entityId` is `null` if the hit object is not part of any tracked entity (e.g. an editor helper). |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / AssetInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: AssetInput
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type AssetInput = {
|
|
11
|
+
path: string;
|
|
12
|
+
type: string;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [types.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L63)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Type | Defined in |
|
|
21
|
+
| ------ | ------ | ------ |
|
|
22
|
+
| <a id="path"></a> `path` | `string` | [types.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L63) |
|
|
23
|
+
| <a id="type"></a> `type` | `string` | [types.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L63) |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / CheckboxInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: CheckboxInput
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CheckboxInput = boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [types.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L61)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / ColorInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: ColorInput
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ColorInput = string;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L50)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / ComponentInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: ComponentInput\<T\>
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ComponentInput<T> = {
|
|
11
|
+
type: "component";
|
|
12
|
+
componentKind?: ComponentKind;
|
|
13
|
+
value: | {
|
|
14
|
+
entityId: EntityId;
|
|
15
|
+
componentKind: ComponentKind;
|
|
16
|
+
}
|
|
17
|
+
| null;
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [types.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L105)
|
|
22
|
+
|
|
23
|
+
Inspector field that lets the user drag an entity and optionally pick a
|
|
24
|
+
component from it.
|
|
25
|
+
|
|
26
|
+
The optional `componentKind` property narrows which component the inspector
|
|
27
|
+
should auto-resolve or pre-filter to. When set, dropping an entity will
|
|
28
|
+
immediately commit that component kind — skipping the dropdown entirely.
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
// Unconstrained — shows a component-kind dropdown after entity drop
|
|
34
|
+
anyRef: { type: "component", value: null } as ComponentInput
|
|
35
|
+
|
|
36
|
+
// Constrained — auto-resolves to "Transform", no dropdown
|
|
37
|
+
transform: { type: "component", componentKind: "Transform", value: null } as ComponentInput<Transform>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Type Parameters
|
|
41
|
+
|
|
42
|
+
| Type Parameter | Default type |
|
|
43
|
+
| ------ | ------ |
|
|
44
|
+
| `T` *extends* [`Component`](../../Component/classes/Component.md) | [`Component`](../../Component/classes/Component.md) |
|
|
45
|
+
|
|
46
|
+
## Properties
|
|
47
|
+
|
|
48
|
+
| Property | Type | Description | Defined in |
|
|
49
|
+
| ------ | ------ | ------ | ------ |
|
|
50
|
+
| <a id="type"></a> `type` | `"component"` | - | [types.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L106) |
|
|
51
|
+
| <a id="componentkind"></a> `componentKind?` | [`ComponentKind`](ComponentKind.md) | Optional component-kind constraint. When provided, the inspector skips the dropdown and resolves directly to this kind. | [types.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L109) |
|
|
52
|
+
| <a id="value"></a> `value` | \| \{ `entityId`: [`EntityId`](EntityId.md); `componentKind`: [`ComponentKind`](ComponentKind.md); \} \| `null` | - | [types.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L110) |
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / ComponentKind
|
|
6
|
+
|
|
7
|
+
# Type Alias: ComponentKind
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ComponentKind =
|
|
11
|
+
| "Animation"
|
|
12
|
+
| "Audio"
|
|
13
|
+
| "Camera"
|
|
14
|
+
| "Environment"
|
|
15
|
+
| "EntityType"
|
|
16
|
+
| "Image"
|
|
17
|
+
| "ImageTarget"
|
|
18
|
+
| "ImageTargetAnchor"
|
|
19
|
+
| "Light"
|
|
20
|
+
| "Material"
|
|
21
|
+
| "Mesh"
|
|
22
|
+
| "MeshGeometry"
|
|
23
|
+
| "Model"
|
|
24
|
+
| "Name"
|
|
25
|
+
| "Object3DRef"
|
|
26
|
+
| "ParentId"
|
|
27
|
+
| "Physics"
|
|
28
|
+
| "Postprocessing"
|
|
29
|
+
| "Script"
|
|
30
|
+
| "Selectable"
|
|
31
|
+
| "SelectionTransformState"
|
|
32
|
+
| "Sprite"
|
|
33
|
+
| "Transform"
|
|
34
|
+
| "Video";
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Defined in: [types.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L65)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / DropdownInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: DropdownInput
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type DropdownInput = {
|
|
11
|
+
options: DropdownOption[];
|
|
12
|
+
value: string | any;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L60)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Type | Defined in |
|
|
21
|
+
| ------ | ------ | ------ |
|
|
22
|
+
| <a id="options"></a> `options` | [`DropdownOption`](DropdownOption.md)[] | [types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L60) |
|
|
23
|
+
| <a id="value"></a> `value` | `string` \| `any` | [types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L60) |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / DropdownOption
|
|
6
|
+
|
|
7
|
+
# Type Alias: DropdownOption
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type DropdownOption = {
|
|
11
|
+
label: string;
|
|
12
|
+
value: string | any;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [types.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L59)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Type | Defined in |
|
|
21
|
+
| ------ | ------ | ------ |
|
|
22
|
+
| <a id="label"></a> `label` | `string` | [types.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L59) |
|
|
23
|
+
| <a id="value"></a> `value` | `string` \| `any` | [types.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L59) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / EcsEntityEditorKind
|
|
6
|
+
|
|
7
|
+
# Type Alias: EcsEntityEditorKind
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EcsEntityEditorKind = EcsEntityKind | "editorUtility";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [types.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L40)
|
|
14
|
+
|
|
15
|
+
[EcsEntityKind](EcsEntityKind.md) extended with editor-only utility entities (gizmos, helpers).
|