Class World

Index

Constructors

Methods

clear createMany despawn get getEntities getResource getResourceByTypeId getTable insert registerType setComponentHooks setResource setResourceAlias setResourceByTypeId spawn

Constructors

constructor

new World(): World
Returns World
- Defined in src/ecs/registry.js:41

Methods

clear

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

Returns void
- Defined in src/ecs/registry.js:362

createMany

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

despawn

despawn(entity: Entity): 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: Entity
  The entity to remove.
Returns void
- Defined in src/ecs/registry.js:219

get

get<T>(entity: Entity, type: new (...args: any[]) => T): T
Type Parameters
- T
Parameters
- entity: Entity
- type: new (...args: any[]) => T
Returns T
- Defined in src/ecs/registry.js:258

getEntities

getEntities(): Readonly<Entities>
Returns Readonly<Entities>
- Defined in src/ecs/registry.js:48

getResource

getResource<T>(resourceType: new (...args: any[]) => T): T
Type Parameters
- T
Parameters
- resourceType: new (...args: any[]) => T
Returns T
- Defined in src/ecs/registry.js:280

getResourceByTypeId

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

getTable

getTable(): ArchetypeTable
Returns ArchetypeTable
- Defined in src/ecs/registry.js:271

insert

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

registerType

registerType<T>(type: Constructor<T>): void
Type Parameters
- T
Parameters
- type: Constructor<T>
Returns void
- Defined in src/ecs/registry.js:342

setComponentHooks

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

setResource

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

setResourceAlias

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

setResourceByTypeId

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

spawn

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