Skip to main content

Class: EcsWorld

Defined in: ecs/ecs-world.ts:12

Represents an object that can be updated over time.

Implements​

Constructors​

Constructor​

new EcsWorld(): EcsWorld

Defined in: ecs/ecs-world.ts:27

Returns​

EcsWorld

Properties​

onEntityRemoved​

readonly onEntityRemoved: ParameterizedForgeEvent<number>

Defined in: ecs/ecs-world.ts:13

Methods​

addComponent()​

addComponent<T>(entity, componentKey, componentData): T

Defined in: ecs/ecs-world.ts:71

Type Parameters​

T​

T

Parameters​

entity​

number

componentKey​

ComponentKey<T>

componentData​

T

Returns​

T

addSystem()​

addSystem<T, K, A>(system, registrationOrder?): void

Defined in: ecs/ecs-world.ts:42

Type Parameters​

T​

T extends unknown[]

K​

K = null

A​

A = void

Parameters​

system​

EcsSystem<T, K, A>

registrationOrder?​

number = SystemRegistrationOrder.normal

Returns​

void

addTag()​

addTag(entity, tagKey): void

Defined in: ecs/ecs-world.ts:83

Parameters​

entity​

number

tagKey​

TagKey

Returns​

void

createEntity()​

createEntity(): number

Defined in: ecs/ecs-world.ts:117

Returns​

number

getComponent()​

getComponent<T>(entity, componentKey): T | null

Defined in: ecs/ecs-world.ts:89

Type Parameters​

T​

T

Parameters​

entity​

number

componentKey​

ComponentKey<T>

Returns​

T | null

operate()​

operate(system, callback): void

Defined in: ecs/ecs-world.ts:132

Parameters​

system​

EcsSystem<unknown[], unknown>

callback​

(queryResult) => void

Returns​

void

queryEntities()​

queryEntities(componentNames, out): void

Defined in: ecs/ecs-world.ts:169

Parameters​

componentNames​

symbol[]

out​

number[]

Returns​

void

removeComponent()​

removeComponent<T>(entity, componentKey): void

Defined in: ecs/ecs-world.ts:99

Type Parameters​

T​

T

Parameters​

entity​

number

componentKey​

ComponentKey<T>

Returns​

void

removeEntity()​

removeEntity(entity): void

Defined in: ecs/ecs-world.ts:123

Parameters​

entity​

number

Returns​

void

removeSystem()​

removeSystem<T, K, A>(system): void

Defined in: ecs/ecs-world.ts:51

Type Parameters​

T​

T extends unknown[]

K​

K

A​

A

Parameters​

system​

EcsSystem<T, K, A>

Returns​

void

stop()​

stop(): void

Defined in: ecs/ecs-world.ts:34

Returns​

void

Implementation of​

Stoppable.stop

update()​

update(): void

Defined in: ecs/ecs-world.ts:58

Updates the object with the given time.

Returns​

void

Implementation of​

Updatable.update