@relu-interactives/spatial-ecs 0.2.25 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{System-CYWZ_Zx5.d.cts → System-vrU46Vuw.d.cts} +16 -2
- package/dist/{System-CYWZ_Zx5.d.ts → System-vrU46Vuw.d.ts} +16 -2
- package/dist/{Video-AIQYTAAr.d.cts → XRRig-CAmf04NX.d.ts} +131 -4
- package/dist/{Video-DlZ4G9ig.d.ts → XRRig-Cu-EyliG.d.cts} +131 -4
- package/dist/{chunk-XFD74BQL.js → chunk-67WGASUJ.js} +3 -3
- package/dist/{chunk-XFD74BQL.js.map → chunk-67WGASUJ.js.map} +1 -1
- package/dist/{chunk-RJ4J5UEX.js → chunk-PCOZLCXS.js} +160 -83
- package/dist/chunk-PCOZLCXS.js.map +1 -0
- package/dist/{chunk-J6736FFO.js → chunk-U3MDYKPV.js} +90 -14
- package/dist/chunk-U3MDYKPV.js.map +1 -0
- package/dist/{chunk-3P3ZBP7K.js → chunk-VXUVNC7S.js} +634 -6
- package/dist/chunk-VXUVNC7S.js.map +1 -0
- package/dist/components/index.cjs +87 -11
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +3 -3
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +98 -51
- package/dist/docs/api/Component/classes/Component.md +4 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +19 -19
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +4 -4
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +57 -11
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +4 -4
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +12 -13
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +80 -0
- package/dist/docs/api/components/classes/PrefabNode.md +54 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +55 -0
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/functions/defaultMaterialValue.md +17 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +34 -0
- package/dist/docs/api/components/index.md +8 -1
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -10
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +20 -0
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +13 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioSystem.md +4 -4
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +5 -5
- package/dist/docs/api/index/classes/ScriptObject.md +156 -0
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +129 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +183 -86
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +32 -0
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +23 -0
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +25 -0
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +23 -0
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +38 -0
- package/dist/docs/api/index/functions/clearModelCache.md +26 -0
- package/dist/docs/api/index/functions/clearPrefabCache.md +25 -0
- package/dist/docs/api/index/functions/collectDiffPaths.md +38 -0
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +27 -0
- package/dist/docs/api/index/functions/collectEntitySubtree.md +29 -0
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +26 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +44 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +2 -4
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +28 -0
- package/dist/docs/api/index/functions/despawnPrefab.md +32 -0
- package/dist/docs/api/index/functions/encodeOverride.md +28 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +25 -0
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +28 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +25 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +4 -2
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +25 -0
- package/dist/docs/api/index/functions/instantiateSubtree.md +32 -0
- package/dist/docs/api/index/functions/loadPrefab.md +28 -0
- package/dist/docs/api/index/functions/loadSharedGltf.md +29 -0
- package/dist/docs/api/index/functions/mergeComponentValue.md +32 -0
- package/dist/docs/api/index/functions/parseOverride.md +34 -0
- package/dist/docs/api/index/functions/parsePrefabAsset.md +25 -0
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +25 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +46 -0
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +17 -0
- package/dist/docs/api/index/functions/restoreComponentState.md +34 -0
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +36 -0
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +35 -0
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +30 -0
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +30 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +36 -0
- package/dist/docs/api/index/index.md +65 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +69 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +2 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +7 -5
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +25 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +27 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +30 -0
- package/dist/docs/api/index/type-aliases/NodeMaps.md +25 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +32 -0
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +21 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +25 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +19 -0
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +43 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +19 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +13 -0
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +15 -0
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +16 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +13 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +15 -0
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +15 -0
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +17 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +2 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +3 -2
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/components/_sidebar.json +4 -0
- package/dist/docs/guide/components/material.md +1 -0
- package/dist/docs/guide/components/script-object.md +32 -0
- package/dist/factories/index.cjs +271 -118
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +9 -3
- package/dist/factories/index.d.ts +9 -3
- package/dist/factories/index.js +3 -3
- package/dist/{index-Gr8aCPRM.d.cts → index-CUFd71ri.d.cts} +12 -3
- package/dist/index-D84o_UA6.d.ts +488 -0
- package/dist/index-YYypJaVw.d.cts +488 -0
- package/dist/{index-BwiRJNIT.d.ts → index-w1oqWl_M.d.ts} +12 -3
- package/dist/index.cjs +1014 -208
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -8
- package/dist/index.d.ts +42 -8
- package/dist/index.js +24 -8
- package/dist/index.js.map +1 -1
- package/dist/systems/index.cjs +717 -12
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +3 -278
- package/dist/systems/index.d.ts +3 -278
- package/dist/systems/index.js +3 -3
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +4 -4
- package/dist/chunk-3P3ZBP7K.js.map +0 -1
- package/dist/chunk-J6736FFO.js.map +0 -1
- package/dist/chunk-RJ4J5UEX.js.map +0 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: MeshComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Mesh.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Mesh.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Mesh.ts#L13)
|
|
10
10
|
|
|
11
11
|
Holds the live three.js `Object3D` for an entity that renders as a primitive
|
|
12
12
|
mesh (cube, sphere, plane, capsule, cylinder). For loaded GLTF/GLB models
|
|
@@ -25,7 +25,7 @@ see [ModelComponent](ModelComponent.md); for the editable geometry parameters se
|
|
|
25
25
|
new MeshComponent(mesh): MeshComponent;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Mesh.ts#L17)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -45,4 +45,4 @@ Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-sp
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Description | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="mesh"></a> `mesh` | `Object3D` | Underlying three.js mesh placed in the scene graph. | [components/Mesh.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
+
| <a id="mesh"></a> `mesh` | `Object3D` | Underlying three.js mesh placed in the scene graph. | [components/Mesh.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Mesh.ts#L15) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: MeshGeometryComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/MeshGeometry.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/MeshGeometry.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L88)
|
|
10
10
|
|
|
11
11
|
Editable geometry parameters for primitive meshes (cube, sphere, plane,
|
|
12
12
|
capsule, cylinder) and the placeholder for `model` entities. Holds the
|
|
@@ -29,7 +29,7 @@ new MeshGeometryComponent(
|
|
|
29
29
|
options?): MeshGeometryComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L104)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -55,10 +55,10 @@ Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactive
|
|
|
55
55
|
|
|
56
56
|
| Property | Modifier | Type | Description | Defined in |
|
|
57
57
|
| ------ | ------ | ------ | ------ | ------ |
|
|
58
|
-
| <a id="kind"></a> `kind` | `readonly` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) | Primitive kind (`cube`, `sphere`, `plane`, `capsule`, `cylinder`) or `model` for loaded assets. | [components/MeshGeometry.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="geometrytype"></a> `geometryType` | `readonly` | `string` | Three.js geometry class name (e.g. `"BoxGeometry"`, `"SphereGeometry"`). Derived from [kind](#kind). | [components/MeshGeometry.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="parameters"></a> `parameters` | `public` | [`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md) | Editable parameters whose shape depends on [kind](#kind). The mesh-geometry system rebuilds geometry when these change. | [components/MeshGeometry.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
61
|
-
| <a id="object"></a> `object` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object whose geometry is being managed. `null` until the object is built. | [components/MeshGeometry.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
62
|
-
| <a id="modelname"></a> `modelName` | `public` | `string` | Human-readable model name shown in the inspector for `model` entities; empty for primitives. | [components/MeshGeometry.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
-
| <a id="castshadow"></a> `castShadow` | `public` | `boolean` | Whether the mesh casts shadows in the renderer. | [components/MeshGeometry.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
64
|
-
| <a id="receiveshadow"></a> `receiveShadow` | `public` | `boolean` | Whether the mesh receives shadows in the renderer. | [components/MeshGeometry.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
+
| <a id="kind"></a> `kind` | `readonly` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) | Primitive kind (`cube`, `sphere`, `plane`, `capsule`, `cylinder`) or `model` for loaded assets. | [components/MeshGeometry.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L90) |
|
|
59
|
+
| <a id="geometrytype"></a> `geometryType` | `readonly` | `string` | Three.js geometry class name (e.g. `"BoxGeometry"`, `"SphereGeometry"`). Derived from [kind](#kind). | [components/MeshGeometry.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L92) |
|
|
60
|
+
| <a id="parameters"></a> `parameters` | `public` | [`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md) | Editable parameters whose shape depends on [kind](#kind). The mesh-geometry system rebuilds geometry when these change. | [components/MeshGeometry.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L94) |
|
|
61
|
+
| <a id="object"></a> `object` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object whose geometry is being managed. `null` until the object is built. | [components/MeshGeometry.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L96) |
|
|
62
|
+
| <a id="modelname"></a> `modelName` | `public` | `string` | Human-readable model name shown in the inspector for `model` entities; empty for primitives. | [components/MeshGeometry.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L98) |
|
|
63
|
+
| <a id="castshadow"></a> `castShadow` | `public` | `boolean` | Whether the mesh casts shadows in the renderer. | [components/MeshGeometry.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L100) |
|
|
64
|
+
| <a id="receiveshadow"></a> `receiveShadow` | `public` | `boolean` | Whether the mesh receives shadows in the renderer. | [components/MeshGeometry.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L102) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ModelComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Model.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Model.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Model.ts#L13)
|
|
10
10
|
|
|
11
11
|
References a GLTF/GLB asset loaded from `path`. The model loading system
|
|
12
12
|
resolves the asset asynchronously and populates [ModelComponent.object](#object)
|
|
@@ -25,7 +25,7 @@ the model finishes loading.
|
|
|
25
25
|
new ModelComponent(path): ModelComponent;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Model.ts#L19)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -45,5 +45,5 @@ Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-s
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Description | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the GLTF/GLB asset. | [components/Model.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Loaded model object, populated asynchronously by the model loader. `null` until loaded. | [components/Model.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the GLTF/GLB asset. | [components/Model.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Model.ts#L15) |
|
|
49
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Loaded model object, populated asynchronously by the model loader. `null` until loaded. | [components/Model.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Model.ts#L17) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Name
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Name.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Name.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Name.ts#L9)
|
|
10
10
|
|
|
11
11
|
Human-readable name for an entity. Shown in the editor hierarchy panel and
|
|
12
12
|
preserved across save/reload.
|
|
@@ -23,7 +23,7 @@ preserved across save/reload.
|
|
|
23
23
|
new Name(value): Name;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
+
Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Name.ts#L13)
|
|
27
27
|
|
|
28
28
|
#### Parameters
|
|
29
29
|
|
|
@@ -43,4 +43,4 @@ Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-sp
|
|
|
43
43
|
|
|
44
44
|
| Property | Type | Description | Defined in |
|
|
45
45
|
| ------ | ------ | ------ | ------ |
|
|
46
|
-
| <a id="value"></a> `value` | `string` | Display name for the entity. Shown in the editor hierarchy. | [components/Name.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
+
| <a id="value"></a> `value` | `string` | Display name for the entity. Shown in the editor hierarchy. | [components/Name.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Name.ts#L11) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Object3DRef
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Object3DRef.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Object3DRef.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Object3DRef.ts#L16)
|
|
10
10
|
|
|
11
11
|
Wraps the live `THREE.Object3D` for an entity. Almost every entity that
|
|
12
12
|
renders to the scene carries an `Object3DRef` so transform sync, selection,
|
|
@@ -29,7 +29,7 @@ fresh inside system/script hooks rather than caching it across frames.
|
|
|
29
29
|
new Object3DRef(object, visibility?): Object3DRef;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Object3DRef.ts#L22)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -50,5 +50,5 @@ Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/
|
|
|
50
50
|
|
|
51
51
|
| Property | Type | Description | Defined in |
|
|
52
52
|
| ------ | ------ | ------ | ------ |
|
|
53
|
-
| <a id="object"></a> `object` | `Object3D` | Live three.js object placed in the scene graph. May be replaced when assets finish loading. | [components/Object3DRef.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="visibility"></a> `visibility` | `boolean` | Whether the object is currently visible. Mirrors `object.visible` and is preserved across reloads. | [components/Object3DRef.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
+
| <a id="object"></a> `object` | `Object3D` | Live three.js object placed in the scene graph. May be replaced when assets finish loading. | [components/Object3DRef.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Object3DRef.ts#L18) |
|
|
54
|
+
| <a id="visibility"></a> `visibility` | `boolean` | Whether the object is currently visible. Mirrors `object.visible` and is preserved across reloads. | [components/Object3DRef.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Object3DRef.ts#L20) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ParentId
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ParentId.ts#L11)
|
|
10
10
|
|
|
11
11
|
Records the parent entity id for hierarchical scene graphs. `null` means
|
|
12
12
|
the entity is at the world root. The `ObjectManagementSystem` reconciles
|
|
@@ -24,7 +24,7 @@ scene-graph parenting from this component each frame.
|
|
|
24
24
|
new ParentId(value?): ParentId;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ParentId.ts#L15)
|
|
28
28
|
|
|
29
29
|
#### Parameters
|
|
30
30
|
|
|
@@ -44,4 +44,4 @@ Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/rel
|
|
|
44
44
|
|
|
45
45
|
| Property | Type | Description | Defined in |
|
|
46
46
|
| ------ | ------ | ------ | ------ |
|
|
47
|
-
| <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
+
| <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ParentId.ts#L13) |
|
|
@@ -6,17 +6,16 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PhysicsComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Physics.ts:
|
|
9
|
+
Defined in: [components/Physics.ts:370](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L370)
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
11
|
+
Marker base class for every ECS component. Subclass `Component` to declare
|
|
12
|
+
a typed data container that systems can query.
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
Use `values.collider` to configure collider shape, size, offset, material
|
|
16
|
-
properties, and sensor mode.
|
|
14
|
+
## Remarks
|
|
17
15
|
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
Components own state only — runtime behaviour belongs in [Behaviour](../../Behaviour/index.md)
|
|
17
|
+
subclasses for user scripts. Keep fields plain (numbers, strings, vectors,
|
|
18
|
+
asset URLs).
|
|
20
19
|
|
|
21
20
|
## Extends
|
|
22
21
|
|
|
@@ -30,7 +29,7 @@ system when the project loads and are `null` until physics is initialized.
|
|
|
30
29
|
new PhysicsComponent(values?): PhysicsComponent;
|
|
31
30
|
```
|
|
32
31
|
|
|
33
|
-
Defined in: [components/Physics.ts:
|
|
32
|
+
Defined in: [components/Physics.ts:382](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L382)
|
|
34
33
|
|
|
35
34
|
#### Parameters
|
|
36
35
|
|
|
@@ -52,9 +51,9 @@ Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/rel
|
|
|
52
51
|
|
|
53
52
|
| Property | Type | Description | Defined in |
|
|
54
53
|
| ------ | ------ | ------ | ------ |
|
|
55
|
-
| <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:
|
|
56
|
-
| <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. | [components/Physics.ts:
|
|
57
|
-
| <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. | [components/Physics.ts:
|
|
54
|
+
| <a id="values"></a> `values` | [`PhysicsState`](../type-aliases/PhysicsState.md) | Authoring state. Saved with the project. | [components/Physics.ts:372](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L372) |
|
|
55
|
+
| <a id="rigidbody"></a> `rigidBody` | `RigidBody` \| `null` | Live Rapier rigid body. `null` until physics is initialized. NON-ENUMERABLE — Rapier wrappers (and, for trimesh, their vertex buffers) must never leak into snapshots/history/debug walks. | [components/Physics.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L378) |
|
|
56
|
+
| <a id="collider"></a> `collider` | `Collider` \| `null` | Live Rapier collider. `null` until physics is initialized. NON-ENUMERABLE. | [components/Physics.ts:380](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L380) |
|
|
58
57
|
|
|
59
58
|
## Methods
|
|
60
59
|
|
|
@@ -64,7 +63,7 @@ Defined in: [components/Physics.ts:358](https://github.com/Relu-Interactives/rel
|
|
|
64
63
|
setValues(patch): void;
|
|
65
64
|
```
|
|
66
65
|
|
|
67
|
-
Defined in: [components/Physics.ts:
|
|
66
|
+
Defined in: [components/Physics.ts:393](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L393)
|
|
68
67
|
|
|
69
68
|
Patch rigidbody and/or collider state. Each sub-object is deep-merged
|
|
70
69
|
with the current values via the respective normalizer.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Postprocessing
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Postprocessing.ts:431](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L431)
|
|
10
10
|
|
|
11
11
|
Postprocessing stack settings (depth-of-field, bloom, vignette, chromatic
|
|
12
12
|
aberration, noise, pixelation, tone mapping, hue/saturation, sepia, SMAA,
|
|
@@ -30,7 +30,7 @@ style — attached to one entity per scene.
|
|
|
30
30
|
new Postprocessing(values?): Postprocessing;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
+
Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L435)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -50,4 +50,4 @@ Defined in: [components/Postprocessing.ts:435](https://github.com/Relu-Interacti
|
|
|
50
50
|
|
|
51
51
|
| Property | Type | Description | Defined in |
|
|
52
52
|
| ------ | ------ | ------ | ------ |
|
|
53
|
-
| <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:433](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
+
| <a id="values"></a> `values` | [`PostprocessingState`](../type-aliases/PostprocessingState.md) | Aggregated post-processing state. Saved with the project. | [components/Postprocessing.ts:433](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L433) |
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / PrefabInstance
|
|
6
|
+
|
|
7
|
+
# Class: PrefabInstance
|
|
8
|
+
|
|
9
|
+
Defined in: [components/PrefabInstance.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabInstance.ts#L45)
|
|
10
|
+
|
|
11
|
+
Marks the ROOT entity of a prefab instance and records its link to the
|
|
12
|
+
source `.prefab` asset plus the instance's per-property overrides.
|
|
13
|
+
|
|
14
|
+
Instances may appear in a scene OR nested inside another prefab's file
|
|
15
|
+
(nested prefabs): the nested root keeps the child prefab's `PrefabNode`
|
|
16
|
+
identity AND this link. `instanceId` is a per-placement uuid that scopes
|
|
17
|
+
node identity across nesting — two nested instances of the same prefab
|
|
18
|
+
share nodeIds but never instanceIds, so override keys stay unambiguous.
|
|
19
|
+
|
|
20
|
+
`overrides` is a flat list of encoded strings so it survives snapshot
|
|
21
|
+
serialization at any depth:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
"<nodeKey>|<ComponentName>|<slash/separated/path>"
|
|
25
|
+
"<nodeKey>|<ComponentName>|" // empty path = whole component overridden
|
|
26
|
+
"<nodeKey>|+node|" // marker: node added by the HOST document
|
|
27
|
+
// inside a nested region (never deleted by
|
|
28
|
+
// file patching)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
where `<nodeKey>` is the entity's `PrefabNode.nodeId` prefixed by the
|
|
32
|
+
`instanceId` chain of any nested instance roots between the scope root and
|
|
33
|
+
the entity (e.g. `"9f2c…"` for direct children, `"<iB>/<bNode>"` inside a
|
|
34
|
+
nested instance). Overridden paths keep their per-instance values when the
|
|
35
|
+
prefab asset is re-applied; everything else syncs from the file. The
|
|
36
|
+
instance root's Transform, Name, and ParentId are implicitly per-instance
|
|
37
|
+
and never appear here. Overrides are an editor-side concern — the runtime
|
|
38
|
+
never resolves them (scene-placed instances are fully materialized;
|
|
39
|
+
runtime spawns are fresh copies of the file).
|
|
40
|
+
|
|
41
|
+
## Extends
|
|
42
|
+
|
|
43
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
44
|
+
|
|
45
|
+
## Constructors
|
|
46
|
+
|
|
47
|
+
### Constructor
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
new PrefabInstance(
|
|
51
|
+
url,
|
|
52
|
+
overrides?,
|
|
53
|
+
instanceId?): PrefabInstance;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [components/PrefabInstance.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabInstance.ts#L57)
|
|
57
|
+
|
|
58
|
+
#### Parameters
|
|
59
|
+
|
|
60
|
+
| Parameter | Type | Default value |
|
|
61
|
+
| ------ | ------ | ------ |
|
|
62
|
+
| `url` | `string` | `undefined` |
|
|
63
|
+
| `overrides` | `string`[] | `[]` |
|
|
64
|
+
| `instanceId?` | `string` | `undefined` |
|
|
65
|
+
|
|
66
|
+
#### Returns
|
|
67
|
+
|
|
68
|
+
`PrefabInstance`
|
|
69
|
+
|
|
70
|
+
#### Overrides
|
|
71
|
+
|
|
72
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
73
|
+
|
|
74
|
+
## Properties
|
|
75
|
+
|
|
76
|
+
| Property | Type | Description | Defined in |
|
|
77
|
+
| ------ | ------ | ------ | ------ |
|
|
78
|
+
| <a id="url"></a> `url` | `string` | URL of the source `.prefab` asset (`localasset://…` inside the editor). | [components/PrefabInstance.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabInstance.ts#L47) |
|
|
79
|
+
| <a id="overrides"></a> `overrides` | `string`[] | Encoded override paths — see class docs for the format. | [components/PrefabInstance.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabInstance.ts#L49) |
|
|
80
|
+
| <a id="instanceid"></a> `instanceId` | `string` | Per-placement uuid scoping node identity across nesting. Stable for the lifetime of the placement (persisted; survives applies) so override keys referencing nested content stay valid. | [components/PrefabInstance.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabInstance.ts#L55) |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / PrefabNode
|
|
6
|
+
|
|
7
|
+
# Class: PrefabNode
|
|
8
|
+
|
|
9
|
+
Defined in: [components/PrefabNode.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabNode.ts#L17)
|
|
10
|
+
|
|
11
|
+
Stable identity for an entity that originated from a prefab asset.
|
|
12
|
+
|
|
13
|
+
Every entity serialized into a `.prefab` file carries a `PrefabNode` with a
|
|
14
|
+
uuid `nodeId`. Hydrating the prefab (editor instantiate or runtime spawn)
|
|
15
|
+
restores the component, so each instance entity can be matched back to its
|
|
16
|
+
prefab-file counterpart regardless of live entity ids. The per-property
|
|
17
|
+
override system diffs and merges in nodeId-space.
|
|
18
|
+
|
|
19
|
+
Node ids are unique within one prefab subtree — two instances of the same
|
|
20
|
+
prefab intentionally share nodeIds.
|
|
21
|
+
|
|
22
|
+
## Extends
|
|
23
|
+
|
|
24
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
25
|
+
|
|
26
|
+
## Constructors
|
|
27
|
+
|
|
28
|
+
### Constructor
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
new PrefabNode(nodeId): PrefabNode;
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Defined in: [components/PrefabNode.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabNode.ts#L21)
|
|
35
|
+
|
|
36
|
+
#### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type |
|
|
39
|
+
| ------ | ------ |
|
|
40
|
+
| `nodeId` | `string` |
|
|
41
|
+
|
|
42
|
+
#### Returns
|
|
43
|
+
|
|
44
|
+
`PrefabNode`
|
|
45
|
+
|
|
46
|
+
#### Overrides
|
|
47
|
+
|
|
48
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
49
|
+
|
|
50
|
+
## Properties
|
|
51
|
+
|
|
52
|
+
| Property | Type | Description | Defined in |
|
|
53
|
+
| ------ | ------ | ------ | ------ |
|
|
54
|
+
| <a id="nodeid"></a> `nodeId` | `string` | Stable uuid identifying this entity within its prefab definition. | [components/PrefabNode.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/PrefabNode.ts#L19) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ScriptComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ScriptComponent.ts:
|
|
9
|
+
Defined in: [components/ScriptComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L35)
|
|
10
10
|
|
|
11
11
|
Component holding the list of [scripts](../type-aliases/ScriptEntry.md) attached to an
|
|
12
12
|
entity. Loaded from the saved project; the runtime-side fields
|
|
@@ -29,7 +29,7 @@ Authored scripts subclass [Behaviour](../../Behaviour/index.md).
|
|
|
29
29
|
new ScriptComponent(entries?): ScriptComponent;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [components/ScriptComponent.ts:
|
|
32
|
+
Defined in: [components/ScriptComponent.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L43)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -49,6 +49,6 @@ Defined in: [components/ScriptComponent.ts:50](https://github.com/Relu-Interacti
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:
|
|
53
|
-
| <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:
|
|
54
|
-
| <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:
|
|
52
|
+
| <a id="entries"></a> `entries` | [`ScriptEntry`](../type-aliases/ScriptEntry.md)[] | Authored script entries attached to the entity. Each entry references a class by name plus its inspector field overrides. Saved with the project. | [components/ScriptComponent.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L37) |
|
|
53
|
+
| <a id="scriptinstance"></a> `scriptInstance` | `unknown` | First live behaviour instance after compile/load. Non-enumerable, so it does not appear in save data. `null` when no script is loaded. | [components/ScriptComponent.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L39) |
|
|
54
|
+
| <a id="scriptinstances"></a> `scriptInstances` | `Map`\<`number`, `unknown`\> | Map of `entityId` to its compiled behaviour instance (one entry per script bound to the entity). Non-enumerable, so it does not appear in save data. | [components/ScriptComponent.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L41) |
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ScriptObjectComponent
|
|
6
|
+
|
|
7
|
+
# Class: ScriptObjectComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/ScriptObjectComponent.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L30)
|
|
10
|
+
|
|
11
|
+
Component for a **script object** — a single [ScriptObject](../../index/classes/ScriptObject.md) whose
|
|
12
|
+
THREE.js visual is built by user code and runs in the editor AND at runtime.
|
|
13
|
+
Unlike [ScriptComponent](ScriptComponent.md) this holds ONE script (not an entries array).
|
|
14
|
+
The live instance ref is non-enumerable so it never leaks into save data or
|
|
15
|
+
undo history.
|
|
16
|
+
|
|
17
|
+
## Extends
|
|
18
|
+
|
|
19
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
20
|
+
|
|
21
|
+
## Constructors
|
|
22
|
+
|
|
23
|
+
### Constructor
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
new ScriptObjectComponent(input?): ScriptObjectComponent;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Defined in: [components/ScriptObjectComponent.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L40)
|
|
30
|
+
|
|
31
|
+
#### Parameters
|
|
32
|
+
|
|
33
|
+
| Parameter | Type |
|
|
34
|
+
| ------ | ------ |
|
|
35
|
+
| `input` | [`ScriptObjectComponentInput`](../type-aliases/ScriptObjectComponentInput.md) |
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
`ScriptObjectComponent`
|
|
40
|
+
|
|
41
|
+
#### Overrides
|
|
42
|
+
|
|
43
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
44
|
+
|
|
45
|
+
## Properties
|
|
46
|
+
|
|
47
|
+
| Property | Type | Description | Defined in |
|
|
48
|
+
| ------ | ------ | ------ | ------ |
|
|
49
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L31) |
|
|
50
|
+
| <a id="classname"></a> `className` | `string` \| `null` | - | [components/ScriptObjectComponent.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L32) |
|
|
51
|
+
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/ScriptObjectComponent.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L33) |
|
|
52
|
+
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | - | [components/ScriptObjectComponent.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L34) |
|
|
53
|
+
| <a id="runtimestate"></a> `runtimeState` | [`ScriptObjectRuntimeState`](../type-aliases/ScriptObjectRuntimeState.md) | - | [components/ScriptObjectComponent.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L35) |
|
|
54
|
+
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | - | [components/ScriptObjectComponent.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L36) |
|
|
55
|
+
| <a id="instance"></a> `instance` | `unknown` | Live ScriptObject instance. Non-enumerable — never enters snapshots/history. | [components/ScriptObjectComponent.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L38) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Selectable
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Selectable.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L9)
|
|
10
10
|
|
|
11
11
|
Toggles whether the editor selection system can pick this entity. When
|
|
12
12
|
`enabled` is `false`, the entity is excluded from raycast hit tests.
|
|
@@ -23,7 +23,7 @@ Toggles whether the editor selection system can pick this entity. When
|
|
|
23
23
|
new Selectable(enabled?): Selectable;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
+
Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L13)
|
|
27
27
|
|
|
28
28
|
#### Parameters
|
|
29
29
|
|
|
@@ -43,4 +43,4 @@ Defined in: [components/Selectable.ts:13](https://github.com/Relu-Interactives/r
|
|
|
43
43
|
|
|
44
44
|
| Property | Type | Description | Defined in |
|
|
45
45
|
| ------ | ------ | ------ | ------ |
|
|
46
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the editor selection raycaster ignores this entity. | [components/Selectable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Selectable.ts#L11) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SelectionTransformState
|
|
8
8
|
|
|
9
|
-
Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/SelectionTransformState.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L16)
|
|
10
10
|
|
|
11
11
|
Singleton-style component (attached once to a system entity) that mirrors
|
|
12
12
|
the editor's current transform-gizmo state into the ECS world. Persisted in
|
|
@@ -27,7 +27,7 @@ new SelectionTransformState(
|
|
|
27
27
|
selectedEntityId?): SelectionTransformState;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L24)
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
@@ -49,6 +49,6 @@ Defined in: [components/SelectionTransformState.ts:24](https://github.com/Relu-I
|
|
|
49
49
|
|
|
50
50
|
| Property | Type | Description | Defined in |
|
|
51
51
|
| ------ | ------ | ------ | ------ |
|
|
52
|
-
| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
+
| <a id="transform"></a> `transform` | [`TransformModeValue`](../type-aliases/TransformModeValue.md) | Active gizmo mode (`translate`, `rotate`, or `scale`). | [components/SelectionTransformState.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L18) |
|
|
53
|
+
| <a id="space"></a> `space` | [`TransformSpaceValue`](../type-aliases/TransformSpaceValue.md) | Reference frame for the gizmo (`world` or `local`). | [components/SelectionTransformState.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L20) |
|
|
54
|
+
| <a id="selectedentityid"></a> `selectedEntityId` | `number` \| `null` | Currently selected entity id, or `null` if nothing is selected. | [components/SelectionTransformState.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L22) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SpriteComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Sprite.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L11)
|
|
10
10
|
|
|
11
11
|
Camera-facing 2D sprite. Unlike [ImageComponent](ImageComponent.md), sprites use
|
|
12
12
|
`THREE.Sprite` and always render as billboards.
|
|
@@ -26,7 +26,7 @@ new SpriteComponent(
|
|
|
26
26
|
height?): SpriteComponent;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L23)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -48,8 +48,8 @@ Defined in: [components/Sprite.ts:23](https://github.com/Relu-Interactives/relu-
|
|
|
48
48
|
|
|
49
49
|
| Property | Type | Description | Defined in |
|
|
50
50
|
| ------ | ------ | ------ | ------ |
|
|
51
|
-
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the sprite image. | [components/Sprite.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L13) |
|
|
52
|
+
| <a id="width"></a> `width` | `number` | Width of the sprite in world units. | [components/Sprite.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L15) |
|
|
53
|
+
| <a id="height"></a> `height` | `number` | Height of the sprite in world units. | [components/Sprite.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L17) |
|
|
54
|
+
| <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously. `null` until loaded. | [components/Sprite.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L19) |
|
|
55
|
+
| <a id="object"></a> `object` | `Sprite`\<`Object3DEventMap`\> \| `null` | Live `THREE.Sprite` placed in the scene. `null` until built. | [components/Sprite.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Sprite.ts#L21) |
|