Class BaseSystem<T>`Abstract`

Type Parameters

T extends IComponent

Hierarchy (View Summary)

BaseSystem

Implements

ISystem

Index

Constructors

Accessors

components isRunning

Methods

internalUpdate pause registerComponent resume unregisterComponent update

Constructors

constructor

new BaseSystem<T extends IComponent>(): BaseSystem<T>
Type Parameters
- T extends IComponent
Returns BaseSystem<T>

Accessors

components

get components(): T[]
Returns T[]
- Defined in ecs/systems/BaseSystem.ts:13

isRunning

get isRunning(): boolean
Returns boolean
- Defined in ecs/systems/BaseSystem.ts:9

Methods

`Protected` `Abstract`internalUpdate

internalUpdate(deltaTime?: number): void
The internal status update to use when implementing system. Prefer overridding this method when having to change the update logic
Parameters
- OptionaldeltaTime: number
  the elapesd time since last update
Returns void
- Defined in ecs/systems/BaseSystem.ts:60

pause

pause(): void
Pauses the system update cycle

Returns void
Implementation of ISystem.pause
- Defined in ecs/systems/BaseSystem.ts:43

registerComponent

registerComponent(component: T): void
Adds the component to the system's component list The compoonent is added only once
Parameters
- component: T
  The component to be added
Returns void
Implementation of ISystem.registerComponent
- Defined in ecs/systems/BaseSystem.ts:24

resume

resume(): void
Resumes the system update cycle

Returns void
Implementation of ISystem.resume
- Defined in ecs/systems/BaseSystem.ts:50

unregisterComponent

unregisterComponent(uuid: string): void
Removes the component from the system's component list
Parameters
- uuid: string
Returns void
Implementation of ISystem.unregisterComponent
- Defined in ecs/systems/BaseSystem.ts:34

update

update(deltaTime?: number): void
Triggers an update cycle
Parameters
- OptionaldeltaTime: number
  the elapesd time since last update
Returns void
Implementation of ISystem.update
- Defined in ecs/systems/BaseSystem.ts:67