Skip to main content

Class: EcsWorld

Defined in: new-ecs/ecs-world.ts:11

Represents an object that can be updated over time.

Implements

Constructors

Constructor

new EcsWorld(): EcsWorld

Defined in: new-ecs/ecs-world.ts:24

Returns

EcsWorld

Methods

addComponent()

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

Defined in: new-ecs/ecs-world.ts:48

Type Parameters

T

T

Parameters

entity

number

componentKey

ComponentKey<T>

componentData

T

Returns

T


addSystem()

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

Defined in: new-ecs/ecs-world.ts:29

Type Parameters

T

T extends unknown[]

K

K

Parameters

system

EcsSystem<T, K>

registrationOrder

number = SystemRegistrationOrder.normal

Returns

void


addTag()

addTag(entity, tagKey): void

Defined in: new-ecs/ecs-world.ts:60

Parameters

entity

number

tagKey

TagKey

Returns

void


createEntity()

createEntity(): number

Defined in: new-ecs/ecs-world.ts:94

Returns

number


getComponent()

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

Defined in: new-ecs/ecs-world.ts:66

Type Parameters

T

T

Parameters

entity

number

componentKey

ComponentKey<T>

Returns

null | T


operate()

operate(system, beforeQueryResult?): void

Defined in: new-ecs/ecs-world.ts:108

Parameters

system

EcsSystem<unknown[], unknown>

beforeQueryResult?

unknown

Returns

void


queryEntities()

queryEntities(componentNames, out): void

Defined in: new-ecs/ecs-world.ts:145

Parameters

componentNames

symbol[]

out

number[]

Returns

void


removeComponent()

removeComponent<T>(entity, componentKey): void

Defined in: new-ecs/ecs-world.ts:77

Type Parameters

T

T

Parameters

entity

number

componentKey

ComponentKey<T>

Returns

void


removeEntity()

removeEntity(entity): void

Defined in: new-ecs/ecs-world.ts:100

Parameters

entity

number

Returns

void


removeSystem()

removeSystem(system): void

Defined in: new-ecs/ecs-world.ts:36

Parameters

system

EcsSystem<unknown[], unknown>

Returns

void


update()

update(): void

Defined in: new-ecs/ecs-world.ts:40

Updates the object with the given time.

Returns

void

Implementation of

Updatable.update