@relu-interactives/spatial-ecs 0.2.24 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{Video-ppAXaKt0.d.cts → Video-AIQYTAAr.d.cts} +15 -3
- package/dist/{Video-C1IOat7L.d.ts → Video-DlZ4G9ig.d.ts} +15 -3
- package/dist/{chunk-JHCPRVBC.js → chunk-7BPHZWQ6.js} +59 -17
- package/dist/chunk-7BPHZWQ6.js.map +1 -0
- package/dist/{chunk-CCE5K2TU.js → chunk-7JFSEV7A.js} +18 -13
- package/dist/chunk-7JFSEV7A.js.map +1 -0
- package/dist/{chunk-52CHDPRQ.js → chunk-AT5SPSPM.js} +4 -4
- package/dist/{chunk-52CHDPRQ.js.map → chunk-AT5SPSPM.js.map} +1 -1
- package/dist/{chunk-ZXGHKX7N.js → chunk-OWQSESTO.js} +12 -2
- package/dist/chunk-OWQSESTO.js.map +1 -0
- package/dist/{chunk-WKGCC7YL.js → chunk-PZ4CAALA.js} +3 -3
- package/dist/{chunk-WKGCC7YL.js.map → chunk-PZ4CAALA.js.map} +1 -1
- package/dist/components/index.cjs +55 -13
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +2 -2
- package/dist/components/index.d.ts +2 -2
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +98 -51
- package/dist/docs/api/Component/classes/Component.md +4 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +19 -19
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +4 -4
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +57 -11
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +4 -4
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +12 -13
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +80 -0
- package/dist/docs/api/components/classes/PrefabNode.md +54 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +55 -0
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/functions/defaultMaterialValue.md +17 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +34 -0
- package/dist/docs/api/components/index.md +8 -1
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -10
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +20 -0
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +13 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioSystem.md +4 -4
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +5 -5
- package/dist/docs/api/index/classes/ScriptObject.md +156 -0
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +129 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +183 -86
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +32 -0
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +23 -0
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +25 -0
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +23 -0
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +38 -0
- package/dist/docs/api/index/functions/clearModelCache.md +26 -0
- package/dist/docs/api/index/functions/clearPrefabCache.md +25 -0
- package/dist/docs/api/index/functions/collectDiffPaths.md +38 -0
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +27 -0
- package/dist/docs/api/index/functions/collectEntitySubtree.md +29 -0
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +26 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +44 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +2 -4
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +28 -0
- package/dist/docs/api/index/functions/despawnPrefab.md +32 -0
- package/dist/docs/api/index/functions/encodeOverride.md +28 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +25 -0
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +28 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +25 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +4 -2
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +25 -0
- package/dist/docs/api/index/functions/instantiateSubtree.md +32 -0
- package/dist/docs/api/index/functions/loadPrefab.md +28 -0
- package/dist/docs/api/index/functions/loadSharedGltf.md +29 -0
- package/dist/docs/api/index/functions/mergeComponentValue.md +32 -0
- package/dist/docs/api/index/functions/parseOverride.md +34 -0
- package/dist/docs/api/index/functions/parsePrefabAsset.md +25 -0
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +25 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +46 -0
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +17 -0
- package/dist/docs/api/index/functions/restoreComponentState.md +34 -0
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +36 -0
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +35 -0
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +30 -0
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +30 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +36 -0
- package/dist/docs/api/index/index.md +65 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +69 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +2 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +7 -5
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +25 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +27 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +30 -0
- package/dist/docs/api/index/type-aliases/NodeMaps.md +25 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +32 -0
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +21 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +25 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +19 -0
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +43 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +19 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +13 -0
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +15 -0
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +16 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +13 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +15 -0
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +15 -0
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +17 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +2 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +3 -2
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/components/_sidebar.json +4 -0
- package/dist/docs/guide/components/material.md +1 -0
- package/dist/docs/guide/components/script-object.md +32 -0
- package/dist/factories/index.cjs +54 -13
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +1 -1
- package/dist/factories/index.d.ts +1 -1
- package/dist/factories/index.js +3 -3
- package/dist/{index-DdiWu1b6.d.ts → index-BwiRJNIT.d.ts} +3 -2
- package/dist/{index-Cu2Pt7wN.d.cts → index-Gr8aCPRM.d.cts} +3 -2
- package/dist/index.cjs +80 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +9 -9
- package/dist/systems/index.cjs +68 -22
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.js +3 -3
- package/dist/worldSnapshotUtils.cjs +10 -0
- package/dist/worldSnapshotUtils.cjs.map +1 -1
- package/dist/worldSnapshotUtils.js +1 -1
- package/package.json +4 -4
- package/dist/chunk-CCE5K2TU.js.map +0 -1
- package/dist/chunk-JHCPRVBC.js.map +0 -1
- package/dist/chunk-ZXGHKX7N.js.map +0 -1
|
@@ -93,7 +93,7 @@ type PostprocessingState = {
|
|
|
93
93
|
};
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
96
|
+
Defined in: [components/Postprocessing.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L4)
|
|
97
97
|
|
|
98
98
|
Aggregated post-processing effect chain authored on the scene environment. Each sub-effect has its own `enabled` flag plus per-effect parameters.
|
|
99
99
|
|
|
@@ -101,64 +101,64 @@ Aggregated post-processing effect chain authored on the scene environment. Each
|
|
|
101
101
|
|
|
102
102
|
| Property | Type | Description | Defined in |
|
|
103
103
|
| ------ | ------ | ------ | ------ |
|
|
104
|
-
| <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
105
|
-
| <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
106
|
-
| `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
107
|
-
| `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
108
|
-
| `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
109
|
-
| `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
110
|
-
| <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
111
|
-
| `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
112
|
-
| `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
113
|
-
| `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
114
|
-
| `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
115
|
-
| <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
116
|
-
| `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
117
|
-
| `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
118
|
-
| `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
119
|
-
| <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
120
|
-
| `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
121
|
-
| `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
122
|
-
| `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
123
|
-
| <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
124
|
-
| `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
125
|
-
| `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
126
|
-
| <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
127
|
-
| `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
128
|
-
| `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
129
|
-
| <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
130
|
-
| `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
131
|
-
| `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
132
|
-
| <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
133
|
-
| `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
134
|
-
| `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
135
|
-
| `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
136
|
-
| <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
137
|
-
| `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
138
|
-
| `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
139
|
-
| <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
140
|
-
| `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
141
|
-
| <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
142
|
-
| `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
143
|
-
| `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
144
|
-
| `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
145
|
-
| <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
146
|
-
| `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
147
|
-
| `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
148
|
-
| `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
149
|
-
| `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
150
|
-
| `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
151
|
-
| `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
152
|
-
| `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
153
|
-
| <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
154
|
-
| `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
155
|
-
| `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
156
|
-
| `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
157
|
-
| `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
158
|
-
| `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
159
|
-
| `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
160
|
-
| `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
161
|
-
| `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
162
|
-
| `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
163
|
-
| `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
164
|
-
| `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
104
|
+
| <a id="postenabled"></a> `postEnabled` | `boolean` | Master toggle. When `false` no post-processing is applied even if individual effects are enabled. | [components/Postprocessing.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L6) |
|
|
105
|
+
| <a id="dof"></a> `dof` | \{ `enabled`: `boolean`; `focusDistance`: `number`; `focalLength`: `number`; `bokehScale`: `number`; \} | Depth-of-field (bokeh) effect. | [components/Postprocessing.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L8) |
|
|
106
|
+
| `dof.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L10) |
|
|
107
|
+
| `dof.focusDistance` | `number` | Distance to the focal plane in world units. | [components/Postprocessing.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L12) |
|
|
108
|
+
| `dof.focalLength` | `number` | Lens focal length controlling depth-of-field strength. | [components/Postprocessing.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L14) |
|
|
109
|
+
| `dof.bokehScale` | `number` | Bokeh blur kernel scale. | [components/Postprocessing.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L16) |
|
|
110
|
+
| <a id="bloom"></a> `bloom` | \{ `enabled`: `boolean`; `intensity`: `number`; `threshold`: `number`; `radius`: `number`; \} | Bloom (HDR glow) effect. | [components/Postprocessing.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L19) |
|
|
111
|
+
| `bloom.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L21) |
|
|
112
|
+
| `bloom.intensity` | `number` | Strength of the bloom contribution. | [components/Postprocessing.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L23) |
|
|
113
|
+
| `bloom.threshold` | `number` | Luminance threshold above which pixels bloom. | [components/Postprocessing.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L25) |
|
|
114
|
+
| `bloom.radius` | `number` | Blur radius applied to the bloom buffer. | [components/Postprocessing.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L27) |
|
|
115
|
+
| <a id="vignette"></a> `vignette` | \{ `enabled`: `boolean`; `offset`: `number`; `darkness`: `number`; \} | Vignette (corner darkening) effect. | [components/Postprocessing.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L30) |
|
|
116
|
+
| `vignette.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L32) |
|
|
117
|
+
| `vignette.offset` | `number` | Distance from screen center where the vignette begins. | [components/Postprocessing.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L34) |
|
|
118
|
+
| `vignette.darkness` | `number` | Maximum darkness applied at screen edges. | [components/Postprocessing.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L36) |
|
|
119
|
+
| <a id="chromaberration"></a> `chromAberration` | \{ `enabled`: `boolean`; `offsetX`: `number`; `offsetY`: `number`; \} | Chromatic aberration (RGB channel offset) effect. | [components/Postprocessing.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L39) |
|
|
120
|
+
| `chromAberration.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L41) |
|
|
121
|
+
| `chromAberration.offsetX` | `number` | Horizontal channel offset. | [components/Postprocessing.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L43) |
|
|
122
|
+
| `chromAberration.offsetY` | `number` | Vertical channel offset. | [components/Postprocessing.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L45) |
|
|
123
|
+
| <a id="noise"></a> `noise` | \{ `enabled`: `boolean`; `opacity`: `number`; \} | Film-noise overlay. | [components/Postprocessing.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L48) |
|
|
124
|
+
| `noise.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L50) |
|
|
125
|
+
| `noise.opacity` | `number` | Opacity of the noise layer in `[0, 1]`. | [components/Postprocessing.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L52) |
|
|
126
|
+
| <a id="pixelation"></a> `pixelation` | \{ `enabled`: `boolean`; `granularity`: `number`; \} | Pixelation (mosaic) effect. | [components/Postprocessing.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L55) |
|
|
127
|
+
| `pixelation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L57) |
|
|
128
|
+
| `pixelation.granularity` | `number` | Pixel block size in screen pixels. | [components/Postprocessing.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L59) |
|
|
129
|
+
| <a id="tonemapping"></a> `toneMapping` | \{ `enabled`: `boolean`; `exposure`: `number`; \} | Tone-mapping exposure control. | [components/Postprocessing.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L62) |
|
|
130
|
+
| `toneMapping.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L64) |
|
|
131
|
+
| `toneMapping.exposure` | `number` | Exposure multiplier applied before tone-mapping. | [components/Postprocessing.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L66) |
|
|
132
|
+
| <a id="huesaturation"></a> `hueSaturation` | \{ `enabled`: `boolean`; `hue`: `number`; `saturation`: `number`; \} | Hue/saturation color grading. | [components/Postprocessing.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L69) |
|
|
133
|
+
| `hueSaturation.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L71) |
|
|
134
|
+
| `hueSaturation.hue` | `number` | Hue rotation in radians. | [components/Postprocessing.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L73) |
|
|
135
|
+
| `hueSaturation.saturation` | `number` | Saturation offset (`0` = unchanged, `>0` = more saturated). | [components/Postprocessing.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L75) |
|
|
136
|
+
| <a id="sepia"></a> `sepia` | \{ `enabled`: `boolean`; `intensity`: `number`; \} | Sepia color grade. | [components/Postprocessing.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L78) |
|
|
137
|
+
| `sepia.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L80) |
|
|
138
|
+
| `sepia.intensity` | `number` | Blend strength between original and sepia in `[0, 1]`. | [components/Postprocessing.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L82) |
|
|
139
|
+
| <a id="smaa"></a> `smaa` | \{ `enabled`: `boolean`; \} | SMAA antialiasing pass. | [components/Postprocessing.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L85) |
|
|
140
|
+
| `smaa.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L87) |
|
|
141
|
+
| <a id="ssao"></a> `ssao` | \{ `enabled`: `boolean`; `intensity`: `number`; `radius`: `number`; \} | Screen-space ambient occlusion. | [components/Postprocessing.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L90) |
|
|
142
|
+
| `ssao.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L92) |
|
|
143
|
+
| `ssao.intensity` | `number` | Strength of the AO contribution. | [components/Postprocessing.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L94) |
|
|
144
|
+
| `ssao.radius` | `number` | Sampling radius in world units. | [components/Postprocessing.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L96) |
|
|
145
|
+
| <a id="dotscreen"></a> `dotScreen` | \{ `enabled`: `boolean`; `dotScreenScale`: `number`; `dotScreenAngle`: `number`; `angle?`: `number`; `scale?`: `number`; `blendFunction?`: `number`; `opacity?`: `number`; \} | Dot-screen (halftone) effect. | [components/Postprocessing.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L99) |
|
|
146
|
+
| `dotScreen.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L101) |
|
|
147
|
+
| `dotScreen.dotScreenScale` | `number` | Pattern scale (legacy field; use [scale](#dotscreen) where available). | [components/Postprocessing.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L103) |
|
|
148
|
+
| `dotScreen.dotScreenAngle` | `number` | Pattern rotation in radians (legacy field; use [angle](#dotscreen) where available). | [components/Postprocessing.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L105) |
|
|
149
|
+
| `dotScreen.angle?` | `number` | Pattern rotation in radians. | [components/Postprocessing.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L107) |
|
|
150
|
+
| `dotScreen.scale?` | `number` | Pattern scale. | [components/Postprocessing.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L109) |
|
|
151
|
+
| `dotScreen.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L111) |
|
|
152
|
+
| `dotScreen.opacity?` | `number` | Effect opacity in `[0, 1]`. | [components/Postprocessing.ts:113](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L113) |
|
|
153
|
+
| <a id="glitch"></a> `glitch` | \{ `enabled`: `boolean`; `blendFunction?`: `number`; `chromaticAberrationOffset?`: \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\]; `delay?`: \[`number`, `number`\]; `duration?`: \[`number`, `number`\]; `strength?`: \| `number` \| \{ `x`: `number`; `y`: `number`; \}; `dtSize?`: `number`; `columns?`: `number`; `ratio?`: `number`; `mode?`: `string`; `active?`: `boolean`; \} | Glitch effect (digital corruption simulation). | [components/Postprocessing.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L116) |
|
|
154
|
+
| `glitch.enabled` | `boolean` | Enable the effect. | [components/Postprocessing.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L118) |
|
|
155
|
+
| `glitch.blendFunction?` | `number` | Three.js blend function override. | [components/Postprocessing.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L120) |
|
|
156
|
+
| `glitch.chromaticAberrationOffset?` | \| \{ `x`: `number`; `y`: `number`; \} \| \[`number`, `number`\] | RGB channel offset applied during a glitch burst. | [components/Postprocessing.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L122) |
|
|
157
|
+
| `glitch.delay?` | \[`number`, `number`\] | `[min, max]` delay (seconds) between glitch bursts. | [components/Postprocessing.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L124) |
|
|
158
|
+
| `glitch.duration?` | \[`number`, `number`\] | `[min, max]` duration (seconds) of each glitch burst. | [components/Postprocessing.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L126) |
|
|
159
|
+
| `glitch.strength?` | \| `number` \| \{ `x`: `number`; `y`: `number`; \} | Glitch displacement strength (scalar or per-axis). | [components/Postprocessing.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L128) |
|
|
160
|
+
| `glitch.dtSize?` | `number` | Size of the displacement texture sampled by the glitch shader. | [components/Postprocessing.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L130) |
|
|
161
|
+
| `glitch.columns?` | `number` | Fraction of columns affected during a glitch burst. | [components/Postprocessing.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L132) |
|
|
162
|
+
| `glitch.ratio?` | `number` | Ratio between weak and strong glitch bursts. | [components/Postprocessing.ts:134](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L134) |
|
|
163
|
+
| `glitch.mode?` | `string` | Glitch mode label (matches the postprocessing library's mode enum). | [components/Postprocessing.ts:136](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L136) |
|
|
164
|
+
| `glitch.active?` | `boolean` | Force the glitch to remain active. | [components/Postprocessing.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L138) |
|
|
@@ -13,7 +13,7 @@ type RadiusHeightMeshParameters = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [components/MeshGeometry.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L39)
|
|
17
17
|
|
|
18
18
|
Radius + height primitive parameters (capsule, cylinder).
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Radius + height primitive parameters (capsule, cylinder).
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="radius"></a> `radius` | `number` | Radius of the cap/cylinder cross-section. | [components/MeshGeometry.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L41) |
|
|
25
|
+
| <a id="height"></a> `height` | `number` | Length of the straight section between caps (capsule) or full height (cylinder). | [components/MeshGeometry.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L43) |
|
|
@@ -12,7 +12,7 @@ type RadiusMeshParameters = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [components/MeshGeometry.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
Defined in: [components/MeshGeometry.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L33)
|
|
16
16
|
|
|
17
17
|
Radius-only primitive parameters (sphere).
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Radius-only primitive parameters (sphere).
|
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="radius"></a> `radius` | `number` | Sphere radius in world units. | [components/MeshGeometry.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="radius"></a> `radius` | `number` | Sphere radius in world units. | [components/MeshGeometry.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L35) |
|
|
@@ -27,7 +27,7 @@ type RigidbodyState = {
|
|
|
27
27
|
};
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [components/Physics.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
Defined in: [components/Physics.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L24)
|
|
31
31
|
|
|
32
32
|
Authoring state for the rigidbody half of [PhysicsComponent](../classes/PhysicsComponent.md). Saved with the project.
|
|
33
33
|
|
|
@@ -35,19 +35,19 @@ Authoring state for the rigidbody half of [PhysicsComponent](../classes/PhysicsC
|
|
|
35
35
|
|
|
36
36
|
| Property | Type | Description | Defined in |
|
|
37
37
|
| ------ | ------ | ------ | ------ |
|
|
38
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the body is removed from physics simulation but kept in state. | [components/Physics.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="type"></a> `type` | [`RigidbodyType`](RigidbodyType.md) | Body type. See [RigidbodyType](RigidbodyType.md). | [components/Physics.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="mass"></a> `mass` | `number` | Mass in kilograms. Only meaningful for `dynamic` bodies. | [components/Physics.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="lineardamping"></a> `linearDamping` | `number` | Damping applied to linear velocity each step (`0` = none). | [components/Physics.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| <a id="angulardamping"></a> `angularDamping` | `number` | Damping applied to angular velocity each step (`0` = none). | [components/Physics.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="gravityscale"></a> `gravityScale` | `number` | Scale factor applied to world gravity for this body (`1` = full gravity, `0` = floating). | [components/Physics.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="cansleep"></a> `canSleep` | `boolean` | Allow the body to sleep when at rest to save simulation cost. | [components/Physics.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="ccdenabled"></a> `ccdEnabled` | `boolean` | Enable continuous collision detection to prevent tunneling for fast bodies. | [components/Physics.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="locktranslations"></a> `lockTranslations` | `boolean` | Master toggle: when `true`, all linear motion is locked. | [components/Physics.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="locktranslationx"></a> `lockTranslationX` | `boolean` | Lock translation along world X. | [components/Physics.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="locktranslationy"></a> `lockTranslationY` | `boolean` | Lock translation along world Y. | [components/Physics.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="locktranslationz"></a> `lockTranslationZ` | `boolean` | Lock translation along world Z. | [components/Physics.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="lockrotations"></a> `lockRotations` | `boolean` | Master toggle: when `true`, all rotation is locked. | [components/Physics.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="lockrotationx"></a> `lockRotationX` | `boolean` | Lock rotation around world X. | [components/Physics.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="lockrotationy"></a> `lockRotationY` | `boolean` | Lock rotation around world Y. | [components/Physics.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="lockrotationz"></a> `lockRotationZ` | `boolean` | Lock rotation around world Z. | [components/Physics.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the body is removed from physics simulation but kept in state. | [components/Physics.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L26) |
|
|
39
|
+
| <a id="type"></a> `type` | [`RigidbodyType`](RigidbodyType.md) | Body type. See [RigidbodyType](RigidbodyType.md). | [components/Physics.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L28) |
|
|
40
|
+
| <a id="mass"></a> `mass` | `number` | Mass in kilograms. Only meaningful for `dynamic` bodies. | [components/Physics.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L30) |
|
|
41
|
+
| <a id="lineardamping"></a> `linearDamping` | `number` | Damping applied to linear velocity each step (`0` = none). | [components/Physics.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L32) |
|
|
42
|
+
| <a id="angulardamping"></a> `angularDamping` | `number` | Damping applied to angular velocity each step (`0` = none). | [components/Physics.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L34) |
|
|
43
|
+
| <a id="gravityscale"></a> `gravityScale` | `number` | Scale factor applied to world gravity for this body (`1` = full gravity, `0` = floating). | [components/Physics.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L36) |
|
|
44
|
+
| <a id="cansleep"></a> `canSleep` | `boolean` | Allow the body to sleep when at rest to save simulation cost. | [components/Physics.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L38) |
|
|
45
|
+
| <a id="ccdenabled"></a> `ccdEnabled` | `boolean` | Enable continuous collision detection to prevent tunneling for fast bodies. | [components/Physics.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L40) |
|
|
46
|
+
| <a id="locktranslations"></a> `lockTranslations` | `boolean` | Master toggle: when `true`, all linear motion is locked. | [components/Physics.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L42) |
|
|
47
|
+
| <a id="locktranslationx"></a> `lockTranslationX` | `boolean` | Lock translation along world X. | [components/Physics.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L44) |
|
|
48
|
+
| <a id="locktranslationy"></a> `lockTranslationY` | `boolean` | Lock translation along world Y. | [components/Physics.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L46) |
|
|
49
|
+
| <a id="locktranslationz"></a> `lockTranslationZ` | `boolean` | Lock translation along world Z. | [components/Physics.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L48) |
|
|
50
|
+
| <a id="lockrotations"></a> `lockRotations` | `boolean` | Master toggle: when `true`, all rotation is locked. | [components/Physics.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L50) |
|
|
51
|
+
| <a id="lockrotationx"></a> `lockRotationX` | `boolean` | Lock rotation around world X. | [components/Physics.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L52) |
|
|
52
|
+
| <a id="lockrotationy"></a> `lockRotationY` | `boolean` | Lock rotation around world Y. | [components/Physics.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L54) |
|
|
53
|
+
| <a id="lockrotationz"></a> `lockRotationZ` | `boolean` | Lock rotation around world Z. | [components/Physics.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L56) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type RigidbodyType = "dynamic" | "fixed" | "kinematicPosition" | "kinematicVelocity";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L17)
|
|
14
14
|
|
|
15
15
|
Rigidbody body type:
|
|
16
16
|
- `dynamic`: simulated by physics; affected by forces and gravity.
|
|
@@ -12,14 +12,13 @@ type ScriptEntry = {
|
|
|
12
12
|
className: string;
|
|
13
13
|
scriptUrl: string;
|
|
14
14
|
enabled: boolean;
|
|
15
|
-
executeInEditor?: boolean;
|
|
16
15
|
data: Record<string, unknown>;
|
|
17
16
|
runtimeState?: "idle" | "loading" | "ready" | "error";
|
|
18
17
|
runtimeMessage?: string;
|
|
19
18
|
};
|
|
20
19
|
```
|
|
21
20
|
|
|
22
|
-
Defined in: [components/ScriptComponent.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [components/ScriptComponent.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L7)
|
|
23
22
|
|
|
24
23
|
One script attached to an entity. Multiple entries may target a single
|
|
25
24
|
entity (different classes from the same or different files).
|
|
@@ -28,11 +27,10 @@ entity (different classes from the same or different files).
|
|
|
28
27
|
|
|
29
28
|
| Property | Type | Description | Defined in |
|
|
30
29
|
| ------ | ------ | ------ | ------ |
|
|
31
|
-
| <a id="entityid"></a> `entityId` | `number` | Owning entity id. | [components/ScriptComponent.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="classname"></a> `className` | `string` | Class name exported by the script module (default export class name). | [components/ScriptComponent.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
-
| <a id="scripturl"></a> `scriptUrl` | `string` | Compiled script URL (e.g. `localasset://.../scripts/foo.js`). | [components/ScriptComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
-
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the script is skipped each frame. | [components/ScriptComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
-
| <a id="
|
|
36
|
-
| <a id="
|
|
37
|
-
| <a id="
|
|
38
|
-
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | Optional human-readable status message (e.g. compile/load error). | [components/ScriptComponent.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/components/ScriptComponent.ts#L28) |
|
|
30
|
+
| <a id="entityid"></a> `entityId` | `number` | Owning entity id. | [components/ScriptComponent.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L9) |
|
|
31
|
+
| <a id="classname"></a> `className` | `string` | Class name exported by the script module (default export class name). | [components/ScriptComponent.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L11) |
|
|
32
|
+
| <a id="scripturl"></a> `scriptUrl` | `string` | Compiled script URL (e.g. `localasset://.../scripts/foo.js`). | [components/ScriptComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L13) |
|
|
33
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the script is skipped each frame. | [components/ScriptComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L15) |
|
|
34
|
+
| <a id="data"></a> `data` | `Record`\<`string`, `unknown`\> | Inspector-bound payload exposed to the script as `this.data`. | [components/ScriptComponent.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L17) |
|
|
35
|
+
| <a id="runtimestate"></a> `runtimeState?` | `"idle"` \| `"loading"` \| `"ready"` \| `"error"` | Last load/runtime status reported by `ScriptBehaviourSystem`. | [components/ScriptComponent.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L19) |
|
|
36
|
+
| <a id="runtimemessage"></a> `runtimeMessage?` | `string` | Optional human-readable status message (e.g. compile/load error). | [components/ScriptComponent.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptComponent.ts#L21) |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ScriptObjectComponentInput
|
|
6
|
+
|
|
7
|
+
# Type Alias: ScriptObjectComponentInput
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ScriptObjectComponentInput = Partial<{
|
|
11
|
+
scriptUrl: string | null;
|
|
12
|
+
className: string | null;
|
|
13
|
+
enabled: boolean;
|
|
14
|
+
data: Record<string, unknown>;
|
|
15
|
+
runtimeState: ScriptObjectRuntimeState;
|
|
16
|
+
runtimeMessage: string;
|
|
17
|
+
}>;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [components/ScriptObjectComponent.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L6)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ScriptObjectRuntimeState
|
|
6
|
+
|
|
7
|
+
# Type Alias: ScriptObjectRuntimeState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ScriptObjectRuntimeState = "idle" | "loading" | "ready" | "error";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/ScriptObjectComponent.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ScriptObjectComponent.ts#L4)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TextureFilteringValue = "smooth" | "sharp";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Material.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Material.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L8)
|
|
14
14
|
|
|
15
15
|
Texture sampling mode. `smooth` uses linear filtering; `sharp` uses nearest filtering for pixel-art look.
|
|
@@ -14,7 +14,7 @@ type TransformData = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [components/Transform.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [components/Transform.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L20)
|
|
18
18
|
|
|
19
19
|
Optional initial values passed to [TransformComponent](../classes/TransformComponent.md). Missing axes default to `0` for position/rotation and `1` for scale.
|
|
20
20
|
|
|
@@ -22,6 +22,6 @@ Optional initial values passed to [TransformComponent](../classes/TransformCompo
|
|
|
22
22
|
|
|
23
23
|
| Property | Type | Description | Defined in |
|
|
24
24
|
| ------ | ------ | ------ | ------ |
|
|
25
|
-
| <a id="position"></a> `position?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial position (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="rotation"></a> `rotation?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial rotation in **radians** (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="scale"></a> `scale?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial scale (defaults to `{ 1, 1, 1 }`). | [components/Transform.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
| <a id="position"></a> `position?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial position (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L22) |
|
|
26
|
+
| <a id="rotation"></a> `rotation?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial rotation in **radians** (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L24) |
|
|
27
|
+
| <a id="scale"></a> `scale?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial scale (defaults to `{ 1, 1, 1 }`). | [components/Transform.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L26) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TransformModeValue = "translate" | "rotate" | "scale";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/SelectionTransformState.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L5)
|
|
14
14
|
|
|
15
15
|
Active gizmo mode in the editor.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type TransformSpaceValue = "world" | "local";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/SelectionTransformState.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/SelectionTransformState.ts#L7)
|
|
14
14
|
|
|
15
15
|
Reference frame for the active gizmo.
|
|
@@ -14,7 +14,7 @@ type Vec3 = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L10)
|
|
18
18
|
|
|
19
19
|
Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vector3` so they save cleanly with the project.
|
|
20
20
|
|
|
@@ -22,6 +22,6 @@ Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vec
|
|
|
22
22
|
|
|
23
23
|
| Property | Type | Description | Defined in |
|
|
24
24
|
| ------ | ------ | ------ | ------ |
|
|
25
|
-
| <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
| <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L12) |
|
|
26
|
+
| <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L14) |
|
|
27
|
+
| <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L16) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_COLLIDER_STATE: ColliderState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L135)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_ENVIRONMENT_STATE: EnvironmentState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L73)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCED_MESH_PARAMETERS: Record<InstancedMeshKind, MeshGeometryParameters>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L41)
|
|
14
14
|
|
|
15
15
|
Default geometry parameters per instanced mesh kind. For "model" kind, cube params are stored as a placeholder (unused).
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCE_TRANSFORM: InstanceTransform;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L34)
|
|
14
14
|
|
|
15
15
|
Default identity instance transform.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_MESH_GEOMETRY_PARAMETERS: MeshGeometryParametersByKind;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L62)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_PHYSICS_STATE: PhysicsState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L172)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_POSTPROCESSING_STATE: PostprocessingState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Postprocessing.ts#L142)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_RIGIDBODY_STATE: RigidbodyState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L59)
|