Class World<ContextType>

The World is a self-contained entity component system for a particular context.

Type Parameters

ContextType

Hierarchy

World

Index

Constructors

Properties

context entityManager queryManager systemManager

Methods

add clearEntities clearSystems remove update

Constructors

constructor

new World<ContextType>(context: ContextType): World<ContextType>
The context type is passed to the system updates
Type Parameters
- ContextType
Parameters
- context: ContextType
Returns World<ContextType>
- Defined in EntityComponentSystem/World.ts:19

Properties

context

context: ContextType

entityManager

entityManager: EntityManager<ContextType> = ...

queryManager

queryManager: QueryManager = ...

systemManager

systemManager: SystemManager<ContextType> = ...

Methods

add

add(entity: Entity): void
Add an entity to the ECS world
Parameters
- entity: Entity
Returns void
- Defined in EntityComponentSystem/World.ts:38
add(system: System<any, ContextType>): void
Add a system to the ECS world
Parameters
- system: System<any, ContextType>
Returns void
- Defined in EntityComponentSystem/World.ts:43

clearEntities

clearEntities(): void
Returns void
- Defined in EntityComponentSystem/World.ts:74

clearSystems

clearSystems(): void
Returns void
- Defined in EntityComponentSystem/World.ts:78

remove

remove(entity: Entity, deferred?: boolean): void
Remove an entity from the ECS world
Parameters
- entity: Entity
- Optional deferred: boolean
Returns void
- Defined in EntityComponentSystem/World.ts:58
remove(system: System<any, ContextType>): void
Remove a system from the ECS world
Parameters
- system: System<any, ContextType>
Returns void
- Defined in EntityComponentSystem/World.ts:63

update

update(type: SystemType, delta: number): void
Update systems by type and time elapsed in milliseconds
Parameters
- type: SystemType
- delta: number
Returns void
- Defined in EntityComponentSystem/World.ts:24