@relu-interactives/spatial-ecs 0.2.2

package/dist/docs/api/index/classes/World.md

@@ -0,0 +1,1405 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / World
+
+# Class: World
+
+Defined in: [World.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L56)
+
+## Constructors
+
+### Constructor
+
+```ts
+new World(options): World;
+```
+
+Defined in: [World.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L84)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options` | \{ `scene`: `Scene`; `camera`: `PerspectiveCamera`; `renderer`: `WebGLRenderer`; `featureFlags?`: `WorldFeatureFlags`; \} |
+| `options.scene` | `Scene` |
+| `options.camera` | `PerspectiveCamera` |
+| `options.renderer` | `WebGLRenderer` |
+| `options.featureFlags?` | `WorldFeatureFlags` |
+
+#### Returns
+
+`World`
+
+## Methods
+
+### createEntity()
+
+```ts
+createEntity(): number;
+```
+
+Defined in: [World.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L103)
+
+#### Returns
+
+`number`
+
+***
+
+### destroyEntity()
+
+```ts
+destroyEntity(entityId): void;
+```
+
+Defined in: [World.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L111)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`void`
+
+***
+
+### hasEntity()
+
+```ts
+hasEntity(entityId): boolean;
+```
+
+Defined in: [World.ts:138](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L138)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getEntities()
+
+```ts
+getEntities(): number[];
+```
+
+Defined in: [World.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L142)
+
+#### Returns
+
+`number`[]
+
+***
+
+### getEntityCount()
+
+```ts
+getEntityCount(): number;
+```
+
+Defined in: [World.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L146)
+
+#### Returns
+
+`number`
+
+***
+
+### addComponent()
+
+```ts
+addComponent<T>(entityId, component): void;
+```
+
+Defined in: [World.ts:150](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L150)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`Component`](../../Component/classes/Component.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `component` | `T` |
+
+#### Returns
+
+`void`
+
+***
+
+### addComponents()
+
+```ts
+addComponents<T>(entityId, components): void;
+```
+
+Defined in: [World.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L165)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`Component`](../../Component/classes/Component.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `components` | `T`[] |
+
+#### Returns
+
+`void`
+
+***
+
+### removeComponent()
+
+```ts
+removeComponent<T>(entityId, componentType): void;
+```
+
+Defined in: [World.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L186)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`Component`](../../Component/classes/Component.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `componentType` | `ComponentClass`\<`T`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### getComponent()
+
+```ts
+getComponent<T>(entityId, componentType): T | undefined;
+```
+
+Defined in: [World.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L194)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`Component`](../../Component/classes/Component.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `componentType` | `ComponentClass`\<`T`\> |
+
+#### Returns
+
+`T` \| `undefined`
+
+***
+
+### hasComponent()
+
+```ts
+hasComponent<T>(entityId, componentType): boolean;
+```
+
+Defined in: [World.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L201)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`Component`](../../Component/classes/Component.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `componentType` | `ComponentClass`\<`T`\> |
+
+#### Returns
+
+`boolean`
+
+***
+
+### query()
+
+```ts
+query(...componentTypes): number[];
+```
+
+Defined in: [World.ts:208](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L208)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`componentTypes` | `ComponentClass`\<[`Component`](../../Component/classes/Component.md)\>[] |
+
+#### Returns
+
+`number`[]
+
+***
+
+### isEntityVisible()
+
+```ts
+isEntityVisible(entityId): boolean;
+```
+
+Defined in: [World.ts:222](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L222)
+
+Returns `true` if the entity is currently visible (its `Object3DRef.visibility`
+is `true`), or if the entity has no `Object3DRef` component (entities without a
+scene object are always considered active). Systems use this to skip per-entity
+updates for hidden objects.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getInputSystem()
+
+```ts
+getInputSystem(): EcsSystem | null;
+```
+
+Defined in: [World.ts:227](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L227)
+
+#### Returns
+
+[`EcsSystem`](../interfaces/EcsSystem.md) \| `null`
+
+***
+
+### getKeyDown()
+
+```ts
+getKeyDown(key): boolean;
+```
+
+Defined in: [World.ts:239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L239)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | [`KeyboardKey`](../type-aliases/KeyboardKey.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getKeyUp()
+
+```ts
+getKeyUp(key): boolean;
+```
+
+Defined in: [World.ts:248](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L248)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | [`KeyboardKey`](../type-aliases/KeyboardKey.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getKey()
+
+```ts
+getKey(key): boolean;
+```
+
+Defined in: [World.ts:257](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L257)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | [`KeyboardKey`](../type-aliases/KeyboardKey.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouse()
+
+```ts
+getMouse(button): boolean;
+```
+
+Defined in: [World.ts:266](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L266)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouseDown()
+
+```ts
+getMouseDown(button): boolean;
+```
+
+Defined in: [World.ts:275](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L275)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getMouseUp()
+
+```ts
+getMouseUp(button): boolean;
+```
+
+Defined in: [World.ts:284](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L284)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `button` | `string` \| `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClick()
+
+```ts
+getScrollClick(): boolean;
+```
+
+Defined in: [World.ts:293](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L293)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClickDown()
+
+```ts
+getScrollClickDown(): boolean;
+```
+
+Defined in: [World.ts:302](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L302)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollClickUp()
+
+```ts
+getScrollClickUp(): boolean;
+```
+
+Defined in: [World.ts:311](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L311)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getScrollDelta()
+
+```ts
+getScrollDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [World.ts:320](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L320)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [World.ts:320](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L320) |
+| `y` | `number` | [World.ts:320](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L320) |
+
+***
+
+### consumeScrollDelta()
+
+```ts
+consumeScrollDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [World.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L329)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [World.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L329) |
+| `y` | `number` | [World.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L329) |
+
+***
+
+### getMousePosition()
+
+```ts
+getMousePosition(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [World.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L338)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [World.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L338) |
+| `y` | `number` | [World.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L338) |
+
+***
+
+### getMouseDelta()
+
+```ts
+getMouseDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [World.ts:347](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L347)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [World.ts:347](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L347) |
+| `y` | `number` | [World.ts:347](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L347) |
+
+***
+
+### consumeMouseDelta()
+
+```ts
+consumeMouseDelta(): {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [World.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L356)
+
+#### Returns
+
+```ts
+{
+  x: number;
+  y: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `x` | `number` | [World.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L356) |
+| `y` | `number` | [World.ts:356](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L356) |
+
+***
+
+### getRapierModule()
+
+```ts
+getRapierModule(): Promise<__module>;
+```
+
+Defined in: [World.ts:365](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L365)
+
+#### Returns
+
+`Promise`\<`__module`\>
+
+***
+
+### getPhysicsWorld()
+
+```ts
+getPhysicsWorld(): World | null;
+```
+
+Defined in: [World.ts:383](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L383)
+
+#### Returns
+
+`World` \| `null`
+
+***
+
+### setPhysicsWorld()
+
+```ts
+setPhysicsWorld(physicsWorld): void;
+```
+
+Defined in: [World.ts:387](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L387)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `physicsWorld` | `World` \| `null` |
+
+#### Returns
+
+`void`
+
+***
+
+### createPhysicsWorld()
+
+```ts
+createPhysicsWorld(options?): Promise<World | null>;
+```
+
+Defined in: [World.ts:391](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L391)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `gravity?`: \{ `x?`: `number`; `y?`: `number`; `z?`: `number`; \}; \} |
+| `options.gravity?` | \{ `x?`: `number`; `y?`: `number`; `z?`: `number`; \} |
+| `options.gravity.x?` | `number` |
+| `options.gravity.y?` | `number` |
+| `options.gravity.z?` | `number` |
+
+#### Returns
+
+`Promise`\<`World` \| `null`\>
+
+***
+
+### lockMousePointer()
+
+```ts
+lockMousePointer(): boolean;
+```
+
+Defined in: [World.ts:410](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L410)
+
+#### Returns
+
+`boolean`
+
+***
+
+### unlockMousePointer()
+
+```ts
+unlockMousePointer(): boolean;
+```
+
+Defined in: [World.ts:441](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L441)
+
+#### Returns
+
+`boolean`
+
+***
+
+### isMousePointerLocked()
+
+```ts
+isMousePointerLocked(): boolean;
+```
+
+Defined in: [World.ts:462](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L462)
+
+#### Returns
+
+`boolean`
+
+***
+
+### getSystem()
+
+```ts
+getSystem<T>(system): T;
+```
+
+Defined in: [World.ts:478](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L478)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`EcsSystem`](../interfaces/EcsSystem.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `system` | `T` |
+
+#### Returns
+
+`T`
+
+***
+
+### hasSystem()
+
+```ts
+hasSystem<T>(system): boolean;
+```
+
+Defined in: [World.ts:495](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L495)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`EcsSystem`](../interfaces/EcsSystem.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `system` | `T` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### addSystem()
+
+```ts
+addSystem(system): void;
+```
+
+Defined in: [World.ts:504](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L504)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `system` | [`EcsSystem`](../interfaces/EcsSystem.md) |
+
+#### Returns
+
+`void`
+
+***
+
+### addSystems()
+
+```ts
+addSystems(systems): void;
+```
+
+Defined in: [World.ts:508](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L508)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `systems` | [`EcsSystem`](../interfaces/EcsSystem.md)[] |
+
+#### Returns
+
+`void`
+
+***
+
+### setup()
+
+```ts
+setup(__namedParameters): {
+  objectManagementSystem: ObjectManagementSystem;
+  transformSyncSystem: TransformSyncSystem;
+  renderSystem: RenderSystem;
+};
+```
+
+Defined in: [World.ts:514](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L514)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | \{ `systems`: [`EcsSystem`](../interfaces/EcsSystem.md)[]; `isEditor?`: `boolean`; \} |
+| `__namedParameters.systems` | [`EcsSystem`](../interfaces/EcsSystem.md)[] |
+| `__namedParameters.isEditor?` | `boolean` |
+
+#### Returns
+
+```ts
+{
+  objectManagementSystem: ObjectManagementSystem;
+  transformSyncSystem: TransformSyncSystem;
+  renderSystem: RenderSystem;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `objectManagementSystem` | [`ObjectManagementSystem`](ObjectManagementSystem.md) | [World.ts:515](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L515) |
+| `transformSyncSystem` | [`TransformSyncSystem`](TransformSyncSystem.md) | [World.ts:516](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L516) |
+| `renderSystem` | [`RenderSystem`](RenderSystem.md) | [World.ts:517](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L517) |
+
+***
+
+### isEditorMode()
+
+```ts
+isEditorMode(): boolean;
+```
+
+Defined in: [World.ts:596](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L596)
+
+#### Returns
+
+`boolean`
+
+***
+
+### pause()
+
+```ts
+pause(): void;
+```
+
+Defined in: [World.ts:607](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L607)
+
+Pauses world simulation. While paused, `update()` skips all system ticks so
+physics, animation, scripts, and rendering stop advancing. The last rendered
+frame remains frozen on-screen.
+
+Call [resume](#resume) to continue.
+
+#### Returns
+
+`void`
+
+***
+
+### resume()
+
+```ts
+resume(): void;
+```
+
+Defined in: [World.ts:615](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L615)
+
+Resumes world simulation after a previous [pause](#pause) call.
+Has no effect if the world is not paused.
+
+#### Returns
+
+`void`
+
+***
+
+### isPaused()
+
+```ts
+isPaused(): boolean;
+```
+
+Defined in: [World.ts:629](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L629)
+
+Returns `true` if the world is currently paused.
+
+#### Returns
+
+`boolean`
+
+#### Example
+
+```ts
+if (this.world.isPaused()) {
+  this.world.resume();
+}
+```
+
+***
+
+### getScene()
+
+```ts
+getScene(): Scene;
+```
+
+Defined in: [World.ts:633](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L633)
+
+#### Returns
+
+`Scene`
+
+***
+
+### getCamera()
+
+```ts
+getCamera(): PerspectiveCamera;
+```
+
+Defined in: [World.ts:637](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L637)
+
+#### Returns
+
+`PerspectiveCamera`
+
+***
+
+### getRenderer()
+
+```ts
+getRenderer(): WebGLRenderer;
+```
+
+Defined in: [World.ts:641](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L641)
+
+#### Returns
+
+`WebGLRenderer`
+
+***
+
+### update()
+
+```ts
+update(deltaTime): void;
+```
+
+Defined in: [World.ts:645](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L645)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [World.ts:652](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L652)
+
+#### Returns
+
+`void`
+
+***
+
+### setSelectedEntity()
+
+```ts
+setSelectedEntity(entityId): void;
+```
+
+Defined in: [World.ts:664](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L664)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` \| `null` |
+
+#### Returns
+
+`void`
+
+***
+
+### getSelectedEntity()
+
+```ts
+getSelectedEntity(): number | null;
+```
+
+Defined in: [World.ts:686](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L686)
+
+#### Returns
+
+`number` \| `null`
+
+***
+
+### getEntitiesByComponent()
+
+```ts
+getEntitiesByComponent(component): WorldEntityView[];
+```
+
+Defined in: [World.ts:746](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L746)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `component` | [`Component`](../../Component/classes/Component.md) |
+
+#### Returns
+
+`WorldEntityView`[]
+
+***
+
+### getEntitiesByName()
+
+```ts
+getEntitiesByName(name): WorldEntityView[];
+```
+
+Defined in: [World.ts:760](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L760)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+
+#### Returns
+
+`WorldEntityView`[]
+
+***
+
+### getEntityByName()
+
+```ts
+getEntityByName(name): WorldEntityView | null;
+```
+
+Defined in: [World.ts:769](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L769)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+
+#### Returns
+
+`WorldEntityView` \| `null`
+
+***
+
+### getEntityById()
+
+```ts
+getEntityById(entityId): WorldEntityView | null;
+```
+
+Defined in: [World.ts:774](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L774)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`WorldEntityView` \| `null`
+
+***
+
+### raycast()
+
+```ts
+raycast(
+   origin, 
+   direction, 
+   near?, 
+   far?): IntersectionResult[];
+```
+
+Defined in: [World.ts:806](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L806)
+
+Cast a ray from `origin` along `direction` and return every intersected
+entity-bound mesh, sorted by distance. Each result is a standard
+`THREE.Intersection` augmented with the owning `entityId` (or `null` if
+the hit object is not part of any tracked entity).
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `origin` | [`Vec3`](../../types/type-aliases/Vec3.md) | `undefined` | World-space origin of the ray (`THREE.Vector3` or `{ x, y, z }`). |
+| `direction` | [`Vec3`](../../types/type-aliases/Vec3.md) | `undefined` | World-space direction of the ray. Will be normalized internally; magnitude is ignored. |
+| `near` | `number` | `0` | Minimum hit distance from the origin. Defaults to `0`. |
+| `far` | `number` | `Infinity` | Maximum hit distance from the origin. Defaults to `Infinity`. |
+
+#### Returns
+
+[`IntersectionResult`](../../types/type-aliases/IntersectionResult.md)[]
+
+#### Example
+
+```ts
+const hits = world.raycast(
+  { x: 0, y: 1, z: 0 },
+  { x: 0, y: 0, z: -1 },
+);
+if (hits[0]?.entityId !== null) {
+  console.log("hit entity", hits[0].entityId, "at", hits[0].point);
+}
+```
+
+***
+
+### raycastFrom()
+
+```ts
+raycastFrom(
+   entityId, 
+   near?, 
+   far?): IntersectionResult[];
+```
+
+Defined in: [World.ts:857](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L857)
+
+Cast a ray from an entity's world-space position along its forward
+direction (the +Z axis of its world matrix). Returns intersected
+entity-bound meshes sorted by distance, with the source entity itself
+filtered out so the ray does not hit the caster.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `entityId` | `number` | `undefined` | Entity to cast the ray from. Must have an `Object3DRef`. |
+| `near` | `number` | `0` | Minimum hit distance from the origin. Defaults to `0`. |
+| `far` | `number` | `Infinity` | Maximum hit distance from the origin. Defaults to `Infinity`. |
+
+#### Returns
+
+[`IntersectionResult`](../../types/type-aliases/IntersectionResult.md)[]
+
+#### Example
+
+```ts
+const hits = world.raycastFrom(this.entityId, 0, 50);
+const closest = hits[0];
+if (closest && closest.entityId !== null) {
+  console.log("looking at", closest.entityId);
+}
+```
+
+***
+
+### getEntityScript()
+
+```ts
+getEntityScript<T>(entityId): T | null;
+```
+
+Defined in: [World.ts:940](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L940)
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`T` \| `null`
+
+***
+
+### getScripts()
+
+```ts
+getScripts<T>(className): T[];
+```
+
+Defined in: [World.ts:953](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L953)
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `className` | `string` |
+
+#### Returns
+
+`T`[]
+
+***
+
+### getScript()
+
+```ts
+getScript<T>(className): T | null;
+```
+
+Defined in: [World.ts:994](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L994)
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `className` | `string` |
+
+#### Returns
+
+`T` \| `null`
+
+***
+
+### getAllEntities()
+
+```ts
+getAllEntities(): WorldEntityView[];
+```
+
+Defined in: [World.ts:999](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L999)
+
+#### Returns
+
+`WorldEntityView`[]
+
+***
+
+### onSelectionChanged()
+
+```ts
+onSelectionChanged(listener): () => void;
+```
+
+Defined in: [World.ts:1005](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1005)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `listener` | [`SelectionListener`](../../types/type-aliases/SelectionListener.md) |
+
+#### Returns
+
+() => `void`
+
+***
+
+### subscribe()
+
+```ts
+subscribe(listener): () => void;
+```
+
+Defined in: [World.ts:1013](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1013)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `listener` | `StoreListener` |
+
+#### Returns
+
+() => `void`
+
+***
+
+### getDebugSnapshot()
+
+```ts
+getDebugSnapshot(maxDepth?): unknown;
+```
+
+Defined in: [World.ts:1021](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1021)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `maxDepth` | `number` | `3` |
+
+#### Returns
+
+`unknown`
+
+***
+
+### getDebugSignature()
+
+```ts
+getDebugSignature(maxDepth?): string;
+```
+
+Defined in: [World.ts:1071](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1071)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `maxDepth` | `number` | `3` |
+
+#### Returns
+
+`string`
+
+***
+
+### createHistorySnapshot()
+
+```ts
+createHistorySnapshot(): WorldHistorySnapshot;
+```
+
+Defined in: [World.ts:1075](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1075)
+
+#### Returns
+
+`WorldHistorySnapshot`
+
+***
+
+### applyHistorySnapshot()
+
+```ts
+applyHistorySnapshot(snapshot): void;
+```
+
+Defined in: [World.ts:1096](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/World.ts#L1096)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `snapshot` | `WorldHistorySnapshot` |
+
+#### Returns
+
+`void`