Class SystemInstanceProvider<TSystem>

This System provider always returns the same instance of the component. The system is passed to the provider at initialisation.

Type Parameters

TSystem extends System

Hierarchy

SystemInstanceProvider

Implements

SystemProvider<TSystem>

Index

Constructors

Accessors

identifier priority

Methods

Constructors

constructor

new SystemInstanceProvider<TSystem>(instance): SystemInstanceProvider<TSystem>
Constructor
Type Parameters
- TSystem extends System
Parameters
- instance: TSystem
  
  The instance to return whenever a System is requested.
Returns SystemInstanceProvider<TSystem>
- Defined in fsm/src/SystemInstanceProvider.ts:18

Accessors

identifier

get identifier(): any
Used to compare this provider with others. Any provider that returns the same component instance will be regarded as equivalent.

Returns any
The instance
Implementation of SystemProvider.identifier
- Defined in fsm/src/SystemInstanceProvider.ts:37

priority

get priority(): number
The priority at which the System should be added to the Engine

Returns number
Implementation of SystemProvider.priority
- Defined in fsm/src/SystemInstanceProvider.ts:44

Methods

getSystem

getSystem(): TSystem
Used to request a component from this provider

Returns TSystem
The instance of the System
Implementation of SystemProvider.getSystem
- Defined in fsm/src/SystemInstanceProvider.ts:27

Generated using TypeDoc