@relu-interactives/spatial-ecs 0.2.25 → 0.3.0

package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md

@@ -0,0 +1,32 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / applyPrefabToSnapshotInstances
+
+# Function: applyPrefabToSnapshotInstances()
+
+```ts
+function applyPrefabToSnapshotInstances(
+   hostSnapshot, 
+   nestedUrl, 
+   newNestedSnapshot): ApplyPrefabToSnapshotResult;
+```
+
+Defined in: [prefab/applyPrefabToSnapshot.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/applyPrefabToSnapshot.ts#L122)
+
+Patch every top-level-relative nested instance of `nestedUrl` inside
+`hostSnapshot` with `newNestedSnapshot`. Deeper nesting (B inside C inside
+A) is NOT touched here — it cascades through C's own file.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `hostSnapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+| `nestedUrl` | `string` |
+| `newNestedSnapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+
+## Returns
+
+[`ApplyPrefabToSnapshotResult`](../type-aliases/ApplyPrefabToSnapshotResult.md)

package/dist/docs/api/index/functions/buildComponentValueMaps.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / buildComponentValueMaps
+
+# Function: buildComponentValueMaps()
+
+```ts
+function buildComponentValueMaps(snapshot): ComponentValueMaps;
+```
+
+Defined in: [hydration/componentValues.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/componentValues.ts#L4)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | [`EcsWorldStateSnapshotLike`](../type-aliases/EcsWorldStateSnapshotLike.md) |
+
+## Returns
+
+[`ComponentValueMaps`](../type-aliases/ComponentValueMaps.md)

package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / buildNodeKeyMapsFromSnapshot
+
+# Function: buildNodeKeyMapsFromSnapshot()
+
+```ts
+function buildNodeKeyMapsFromSnapshot(snapshot, options?): NodeKeyMaps;
+```
+
+Defined in: [prefab/nodeKeys.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/nodeKeys.ts#L70)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+| `options?` | \{ `scopeRootEntityId?`: `number`; \} |
+| `options.scopeRootEntityId?` | `number` |
+
+## Returns
+
+[`NodeKeyMaps`](../type-aliases/NodeKeyMaps.md)

package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / buildNodeMapsFromSnapshot
+
+# Function: buildNodeMapsFromSnapshot()
+
+```ts
+function buildNodeMapsFromSnapshot(snapshot): NodeMaps;
+```
+
+Defined in: [prefab/overrides.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L86)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+
+## Returns
+
+[`NodeMaps`](../type-aliases/NodeMaps.md)

package/dist/docs/api/index/functions/canonicalizeComponentValue.md

@@ -0,0 +1,38 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / canonicalizeComponentValue
+
+# Function: canonicalizeComponentValue()
+
+```ts
+function canonicalizeComponentValue(
+   componentName, 
+   value, 
+   idToNode): unknown;
+```
+
+Defined in: [prefab/overrides.ts:177](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L177)
+
+Canonicalize a serialized component value into nodeId-space:
+- entity-id fields → `{$node}` (internal) or raw id (external)
+- ScriptComponent entries keep only `{className, scriptUrl, enabled, data}`
+  (entityId/runtimeState/runtimeMessage are per-instance transients)
+- ScriptObjectComponent keeps only `{scriptUrl, className, enabled, data}`
+  (runtimeState/runtimeMessage are per-instance transients)
+- Object3DRef keeps only `{visibility}` (the rest is a live object ref)
+
+Keep the id-bearing field list in sync with `snapshotIdUtils.ts`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `componentName` | `string` |
+| `value` | `unknown` |
+| `idToNode` | `Map`\<`number`, `string`\> |
+
+## Returns
+
+`unknown`

package/dist/docs/api/index/functions/clearModelCache.md

@@ -0,0 +1,26 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / clearModelCache
+
+# Function: clearModelCache()
+
+```ts
+function clearModelCache(url?): void;
+```
+
+Defined in: [utils/modelCache.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/utils/modelCache.ts#L71)
+
+Forget cached models (one URL, or everything). Subsequent loads fetch and
+parse anew. Does not dispose GPU resources — live clones may still use them.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `url?` | `string` |
+
+## Returns
+
+`void`

package/dist/docs/api/index/functions/clearPrefabCache.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / clearPrefabCache
+
+# Function: clearPrefabCache()
+
+```ts
+function clearPrefabCache(url?): void;
+```
+
+Defined in: [prefab/spawnPrefab.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/spawnPrefab.ts#L98)
+
+Drop one cached prefab (or all when no url is given).
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `url?` | `string` |
+
+## Returns
+
+`void`

package/dist/docs/api/index/functions/collectDiffPaths.md

@@ -0,0 +1,38 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / collectDiffPaths
+
+# Function: collectDiffPaths()
+
+```ts
+function collectDiffPaths(
+   base, 
+   current, 
+   prefix?, 
+   out?): string[];
+```
+
+Defined in: [prefab/overrides.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L338)
+
+Collect leaf paths where two canonical values differ. Semantics:
+- `{$node}` refs compare atomically by nodeId
+- arrays of differing length are ONE atomic override (the array path);
+  equal lengths recurse per index
+- object key present on one side only marks that key's path
+- type mismatches mark the current path
+An empty-string path means the values differ at the top level.
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `base` | `unknown` | `undefined` |
+| `current` | `unknown` | `undefined` |
+| `prefix` | `string` | `""` |
+| `out` | `string`[] | `[]` |
+
+## Returns
+
+`string`[]

package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md

@@ -0,0 +1,27 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / collectDirectPrefabDependencies
+
+# Function: collectDirectPrefabDependencies()
+
+```ts
+function collectDirectPrefabDependencies(snapshot): string[];
+```
+
+Defined in: [prefab/dependencies.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/dependencies.ts#L9)
+
+Direct (top-level-relative) prefab urls a document depends on — the edges
+of the nesting graph. Deeper nesting is reached transitively through each
+dependency's own file, never directly.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+
+## Returns
+
+`string`[]

package/dist/docs/api/index/functions/collectEntitySubtree.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / collectEntitySubtree
+
+# Function: collectEntitySubtree()
+
+```ts
+function collectEntitySubtree(world, rootIds): number[];
+```
+
+Defined in: [prefab/collectEntitySubtree.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/collectEntitySubtree.ts#L11)
+
+Collect the given roots plus every descendant, BFS parent-first, using the
+`ParentId` component edges. Parent-first ordering matters: serialization
+renumbers ids in this order and instantiation creates entities in file
+order, so parents always exist before their children are linked.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](../classes/World.md) |
+| `rootIds` | `number`[] |
+
+## Returns
+
+`number`[]

package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md

@@ -0,0 +1,26 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / collectSnapshotSubtreeIds
+
+# Function: collectSnapshotSubtreeIds()
+
+```ts
+function collectSnapshotSubtreeIds(snapshot, rootEntityId): number[];
+```
+
+Defined in: [prefab/nodeKeys.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/nodeKeys.ts#L166)
+
+JSON-space subtree ids (root first, BFS) via ParentId edges.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+| `rootEntityId` | `number` |
+
+## Returns
+
+`number`[]

package/dist/docs/api/index/functions/computeInstanceOverrides.md

@@ -0,0 +1,44 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computeInstanceOverrides
+
+# Function: computeInstanceOverrides()
+
+```ts
+function computeInstanceOverrides(
+   baseSnapshot, 
+   instanceSnapshot, 
+   options?): string[];
+```
+
+Defined in: [prefab/overrides.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L416)
+
+Diff a live instance subtree against its prefab base (both as serialized
+subtree snapshots carrying PrefabNode identity) and return the encoded
+override list: every path where the instance deviates from the base.
+
+Identity is nodeKey-scoped ([buildNodeKeyMapsFromSnapshot](buildNodeKeyMapsFromSnapshot.md)), so
+nested instance regions diff correctly; for nested-free documents the
+keys degenerate to bare nodeIds (v1 behavior unchanged).
+
+Policies: components missing on the instance produce no override (apply
+re-adds them); components/nodes only on the instance are local additions
+and produce no override — EXCEPT when `emitAdditionMarkers` is set
+(file-space callers), which records `"<key>|+node|"` for instance nodes
+absent from the base so pure-JSON patching never deletes host-authored
+nodes inside nested regions.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `baseSnapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+| `instanceSnapshot` | [`SubtreeSnapshot`](../type-aliases/SubtreeSnapshot.md) |
+| `options?` | \{ `emitAdditionMarkers?`: `boolean`; \} |
+| `options.emitAdditionMarkers?` | `boolean` |
+
+## Returns
+
+`string`[]

package/dist/docs/api/index/functions/createAnimationComponent.md

@@ -13,7 +13,7 @@ function createAnimationComponent(
    args): AnimationComponent;
 ```
 
-Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/AnimationFactory.ts#L4)
+Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/AnimationFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createAudioComponent.md

@@ -15,7 +15,7 @@ function createAudioComponent(
    context?): AudioComponent;
 ```
 
-Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/AudioComponentFactory.ts#L126)
+Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/AudioComponentFactory.ts#L126)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createCameraComponent.md

@@ -13,7 +13,7 @@ function createCameraComponent(
    payload?): CameraComponent;
 ```
 
-Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/CameraFactory.ts#L7)
+Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/CameraFactory.ts#L7)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createEntityTypeComponent.md

@@ -13,7 +13,7 @@ function createEntityTypeComponent(
    args): EntityType;
 ```
 
-Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/EntityTypeFactory.ts#L4)
+Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/EntityTypeFactory.ts#L4)
 
 ## Parameters
 
@@ -21,7 +21,7 @@ Defined in: [factories/components/EntityTypeFactory.ts:4](https://github.com/Rel
 | ------ | ------ |
 | `world` | [`World`](../classes/World.md) |
 | `entityId` | `number` |
-| ...`args` | \[ \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"editorUtility"`\] |
+| ...`args` | \[ \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"scriptObject"` \| `"editorUtility"`\] |
 
 ## Returns
 

package/dist/docs/api/index/functions/createEnvironmentComponent.md

@@ -13,7 +13,7 @@ function createEnvironmentComponent(
    values?): Environment;
 ```
 
-Defined in: [factories/components/EnvironmentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/EnvironmentFactory.ts#L4)
+Defined in: [factories/components/EnvironmentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/EnvironmentFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createImageComponent.md

@@ -13,7 +13,7 @@ function createImageComponent(
    args): ImageComponent;
 ```
 
-Defined in: [factories/components/ImageComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ImageComponentFactory.ts#L4)
+Defined in: [factories/components/ImageComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ImageComponentFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md

@@ -13,7 +13,7 @@ function createImageTargetAnchorComponent(
    args): ImageTargetAnchor;
 ```
 
-Defined in: [factories/components/ImageTargetAnchorFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ImageTargetAnchorFactory.ts#L4)
+Defined in: [factories/components/ImageTargetAnchorFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ImageTargetAnchorFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createImageTargetComponent.md

@@ -13,7 +13,7 @@ function createImageTargetComponent(
    args): ImageTarget;
 ```
 
-Defined in: [factories/components/ImageTargetFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ImageTargetFactory.ts#L4)
+Defined in: [factories/components/ImageTargetFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ImageTargetFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createInstanceSlotComponent.md

@@ -14,7 +14,7 @@ function createInstanceSlotComponent(
    slotIndex): InstanceSlotComponent;
 ```
 
-Defined in: [factories/components/InstanceSlotComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/InstanceSlotComponentFactory.ts#L4)
+Defined in: [factories/components/InstanceSlotComponentFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/InstanceSlotComponentFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createInstancedMeshComponent.md

@@ -15,7 +15,7 @@ function createInstancedMeshComponent(
    options?): InstancedMeshComponent;
 ```
 
-Defined in: [factories/components/InstancedMeshComponentFactory.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/InstancedMeshComponentFactory.ts#L6)
+Defined in: [factories/components/InstancedMeshComponentFactory.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/InstancedMeshComponentFactory.ts#L6)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createLightComponent.md

@@ -13,7 +13,7 @@ function createLightComponent(
    args): LightComponent;
 ```
 
-Defined in: [factories/components/LightFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/LightFactory.ts#L4)
+Defined in: [factories/components/LightFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/LightFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createMaterialComponent.md

@@ -13,7 +13,7 @@ function createMaterialComponent(
    args): MaterialComponent;
 ```
 
-Defined in: [factories/components/MaterialFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/MaterialFactory.ts#L4)
+Defined in: [factories/components/MaterialFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/MaterialFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createMeshComponent.md

@@ -13,7 +13,7 @@ function createMeshComponent(
    args): MeshComponent;
 ```
 
-Defined in: [factories/components/MeshFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/MeshFactory.ts#L4)
+Defined in: [factories/components/MeshFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/MeshFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createMeshGeometryComponent.md

@@ -13,7 +13,7 @@ function createMeshGeometryComponent(
    args): MeshGeometryComponent;
 ```
 
-Defined in: [factories/components/MeshGeometryFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/MeshGeometryFactory.ts#L4)
+Defined in: [factories/components/MeshGeometryFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/MeshGeometryFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createModelComponent.md

@@ -13,7 +13,7 @@ function createModelComponent(
    args): ModelComponent;
 ```
 
-Defined in: [factories/components/ModelFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ModelFactory.ts#L4)
+Defined in: [factories/components/ModelFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ModelFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createNameComponent.md

@@ -13,7 +13,7 @@ function createNameComponent(
    args): Name;
 ```
 
-Defined in: [factories/components/NameFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/NameFactory.ts#L4)
+Defined in: [factories/components/NameFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/NameFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createObject3DRefComponent.md

@@ -13,7 +13,7 @@ function createObject3DRefComponent(
    args): Object3DRef;
 ```
 
-Defined in: [factories/components/Object3DRefFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/Object3DRefFactory.ts#L4)
+Defined in: [factories/components/Object3DRefFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/Object3DRefFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createParentIdComponent.md

@@ -13,7 +13,7 @@ function createParentIdComponent(
    args): ParentId;
 ```
 
-Defined in: [factories/components/ParentIdFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ParentIdFactory.ts#L4)
+Defined in: [factories/components/ParentIdFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ParentIdFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createPhysicsComponent.md

@@ -13,7 +13,7 @@ function createPhysicsComponent(
    values?): PhysicsComponent;
 ```
 
-Defined in: [factories/components/PhysicsFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/PhysicsFactory.ts#L8)
+Defined in: [factories/components/PhysicsFactory.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/PhysicsFactory.ts#L95)
 
 ## Parameters
 
@@ -21,9 +21,7 @@ Defined in: [factories/components/PhysicsFactory.ts:8](https://github.com/Relu-I
 | ------ | ------ |
 | `world` | [`World`](../classes/World.md) |
 | `entityId` | `number` |
-| `values?` | \{ `rigidbody?`: `Partial`\<[`RigidbodyState`](../../components/type-aliases/RigidbodyState.md)\>; `collider?`: `Partial`\<[`ColliderState`](../../components/type-aliases/ColliderState.md)\>; \} |
-| `values.rigidbody?` | `Partial`\<[`RigidbodyState`](../../components/type-aliases/RigidbodyState.md)\> |
-| `values.collider?` | `Partial`\<[`ColliderState`](../../components/type-aliases/ColliderState.md)\> |
+| `values?` | `PhysicsFactoryValues` |
 
 ## Returns
 

package/dist/docs/api/index/functions/createPostprocessingComponent.md

@@ -13,7 +13,7 @@ function createPostprocessingComponent(
    values?): Postprocessing;
 ```
 
-Defined in: [factories/components/PostprocessingFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/PostprocessingFactory.ts#L7)
+Defined in: [factories/components/PostprocessingFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/PostprocessingFactory.ts#L7)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createScriptComponent.md

@@ -13,7 +13,7 @@ function createScriptComponent(
    payload?): ScriptComponent;
 ```
 
-Defined in: [factories/components/ScriptComponentFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/f4080487315dc2ea88332b3160fc071e7828b385/core/factories/components/ScriptComponentFactory.ts#L8)
+Defined in: [factories/components/ScriptComponentFactory.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ScriptComponentFactory.ts#L8)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createScriptObjectComponent.md

@@ -0,0 +1,28 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / createScriptObjectComponent
+
+# Function: createScriptObjectComponent()
+
+```ts
+function createScriptObjectComponent(
+   world, 
+   entityId, 
+   payload?): ScriptObjectComponent;
+```
+
+Defined in: [factories/components/ScriptObjectComponentFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/ScriptObjectComponentFactory.ts#L7)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](../classes/World.md) |
+| `entityId` | `number` |
+| `payload` | [`ScriptObjectComponentInput`](../../components/type-aliases/ScriptObjectComponentInput.md) |
+
+## Returns
+
+[`ScriptObjectComponent`](../../components/classes/ScriptObjectComponent.md)