Class World

Constructors

constructor

new World(): World
Returns World
- Defined in packages/ecs/src/world.js:48

Methods

clear

clear(): void
This removes all of the entities and components from the manager.

Returns void
- Defined in packages/ecs/src/world.js:490

createMany

createMany<T extends {}[]>(entities: [...T[]][]): void
Type Parameters
- T extends {}[]
Parameters
- entities: [...T[]][]
Returns void
- Defined in packages/ecs/src/world.js:256

despawn

despawn(entity: EntityHandle): void
Removes an entity from the registry. Note that this doesn't destroy the entity, only removes it and its components from the manager. To destroy the entity,use Entity.destroy() method.
Parameters
- entity: EntityHandle
  The entity to remove.
Returns void
- Defined in packages/ecs/src/world.js:269

get

get<T>(entity: EntityHandle, type: Constructor<T>): T
Type Parameters
- T
Parameters
- entity: EntityHandle
- type: Constructor<T>
Returns T
- Defined in packages/ecs/src/world.js:309

getArchetypes

getArchetypes(): Archetypes
Returns Archetypes
- Defined in packages/ecs/src/world.js:356

getEntities

getEntities(): Readonly<Entities>
Returns Readonly<Entities>
- Defined in packages/ecs/src/world.js:55

getEntity

getEntity(entity: EntityHandle): EntityCell
Parameters
- entity: EntityHandle
Returns EntityCell
- Defined in packages/ecs/src/world.js:328

getResource

getResource<T>(resourceType: Constructor<T>): T
Type Parameters
- T
Parameters
- resourceType: Constructor<T>
Returns T
- Defined in packages/ecs/src/world.js:365

getResourceAliases

getResourceAliases(): ReadonlyMap<TypeId, TypeId>
Returns ReadonlyMap<TypeId, TypeId>
- Defined in packages/ecs/src/world.js:349

getResourceByTypeId

getResourceByTypeId<T>(id: TypeId): T
Type Parameters
- T
Parameters
- id: TypeId
Returns T
- Defined in packages/ecs/src/world.js:374

getResources

getResources(): ReadonlyMap<TypeId, unknown>
Returns ReadonlyMap<TypeId, unknown>
- Defined in packages/ecs/src/world.js:342

getTables

getTables(): Tables
Returns Tables
- Defined in packages/ecs/src/world.js:335

hasResource

hasResource<T>(resourceType: Constructor<T>): boolean
Type Parameters
- T
Parameters
- resourceType: Constructor<T>
Returns boolean
- Defined in packages/ecs/src/world.js:400

hasResourceByTypeId

hasResourceByTypeId<T>(id: TypeId): boolean
Type Parameters
- T
Parameters
- id: TypeId
Returns boolean
- Defined in packages/ecs/src/world.js:409

insert

insert<T extends object[]>(entity: EntityHandle, components: [...T[]]): void
Inserts components into an entity.
Type Parameters
- T extends object[]
Parameters
- entity: EntityHandle
- components: [...T[]]
  The entity to add.
Returns void
- Defined in packages/ecs/src/world.js:170

remove

remove<T extends unknown[]>(
entity: EntityHandle,
components: TupleConstructor<T>,
): void
Type Parameters
- T extends unknown[]
Parameters
- entity: EntityHandle
- components: TupleConstructor<T>
Returns void
- Defined in packages/ecs/src/world.js:216

removeResource

removeResource<T>(type: Constructor<T>): void
Type Parameters
- T
Parameters
- type: Constructor<T>
Returns void
- Defined in packages/ecs/src/world.js:453

removeResourceByTypeId

removeResourceByTypeId(typeId: TypeId): void
Parameters
- typeId: TypeId
Returns void
- Defined in packages/ecs/src/world.js:460

resolve

resolve(typeIds: TypeId[]): [TableId, Table, ArchetypeId, Archetype]
Parameters
- typeIds: TypeId[]
Returns [TableId, Table, ArchetypeId, Archetype]
- Defined in packages/ecs/src/world.js:103

setComponentHooks

setComponentHooks<T>(component: Constructor<T>, hooks: ComponentHooks): void
Type Parameters
- T
Parameters
- component: Constructor<T>
- hooks: ComponentHooks
Returns void
- Defined in packages/ecs/src/world.js:479

setResource

setResource<T extends object>(resource: T): void
Type Parameters
- T extends object
Parameters
- resource: T
Returns void
- Defined in packages/ecs/src/world.js:441

setResourceAlias

setResourceAlias<T>(id: TypeId, alias: Constructor<T>): void
Type Parameters
- T
Parameters
- id: TypeId
- alias: Constructor<T>
Returns void
- Defined in packages/ecs/src/world.js:470

setResourceByTypeId

setResourceByTypeId<T>(id: TypeId, resource: T): void
Type Parameters
- T
Parameters
- id: TypeId
- resource: T
Returns void
- Defined in packages/ecs/src/world.js:433

spawn

spawn<T extends {}[]>(components: [...T[]]): EntityHandle
Adds an entity to the registry.
Type Parameters
- T extends {}[]
Parameters
- components: [...T[]]
  The entity to add.
Returns EntityHandle
- Defined in packages/ecs/src/world.js:132