Class System<T, U>

Type Parameters

T extends ((components: ComponentRecord, entities: Entity[], ...args: unknown[]) => ReturnType<T>)
U extends ParametersExceptFirstTwo<T>

Hierarchy

System

Index

Constructors

Properties

Methods

Constructors

constructor

new System<T, U>(spec: SystemSpec<T, U>): System<T, U>
Creates a new system.

Systems are the behaviours which affect components.
Type Parameters
- T extends ((components: ComponentRecord, entities: Entity[], ...args: unknown[]) => ReturnType<T>)
- U extends unknown[]
Parameters
- spec: SystemSpec<T, U>
  
  the system's specification object
Returns System<T, U>
- Defined in src/system.ts:44

Properties

query

query: Query

The query which will provide the components and entities to the system.

system

system: SystemCallback<T, U>

The core function of the system. Called when this.exec is called.

Methods

init

init(world: World): ((...args: U) => ReturnType<T>)
Initialize the system for a given world

Returns
an initialized system function
Parameters
- world: World
  
  the world to execute the system in
Returns ((...args: U) => ReturnType<T>)
- - (...args: U): ReturnType<T>
  - Initialize the system for a given world
    
    Returns
    an initialized system function
    Parameters
    - Rest ...args: U
    Returns ReturnType<T>
- Defined in src/system.ts:55

Generated using TypeDoc