System

Classes

System

Members

componentClass

Functions

computeSystemName(system) ⇒ string

System

Kind: global class

• System
  • instance
    • .entityManager : EntityManager
    • .state : ObservedValue.<SystemState>
    • .dependencies : Array
    • .components_used : Array.<ResourceAccessSpecification>
    • .referenced_components ⇒ Array
    • .isSystem : boolean
    • .fixedUpdate
    • .update
    • .getAccessForComponent(Klass) ⇒ number
  • static
    • .State

system.entityManager : EntityManager

Kind: instance property of System
Access: protected

system.state : ObservedValue.<SystemState>

Kind: instance property of System
Read only: true

system.dependencies : Array

Other components which have to be present before the system links component

Kind: instance property of System

system.components_used : Array.<ResourceAccessSpecification>

Component types that are used internally by the system and how they are used Main benefit of doing so is twofold:

 - Helps the engine figure out the best execution order for system to make sure that updates propagate as quickly as possible
 - Declaring this helps EntityManager to ensure that all relevant component types are properly registered for the system

NOTE: specifying this is optional. The engine will still work.

Kind: instance property of System

system.referenced_components ⇒ Array

Kind: instance property of System
Returns: Array - Component classes

system.isSystem : boolean

Kind: instance property of System
Read only: true

system.fixedUpdate

Fixed update function, every step happens with the same exact time increment useful for systems that must have a fixed time step to be predictable and stable, such as physics

Kind: instance property of System

Param	Type	Description
timeDelta	number	in seconds

system.update

This update is generally synchronized with the render loop

Kind: instance property of System

Param	Type	Description
timeDelta	number	Time in seconds

system.getAccessForComponent(Klass) ⇒ number

Kind: instance method of System

Param	Type
Klass	T

System.State

Deprecated

Kind: static property of System
Read only: true

componentClass

Deprecated

Kind: global variable

componentClass.get() ⇒ Class.<C>

Deprecated

Kind: static method of componentClass

SystemState : enum

Kind: global enum
Read only: true

computeSystemName(system) ⇒ string

Kind: global function

Param	Type
system	System