# Class: SubSystem

Base class for sub-systems to be used with SortedSubIteratingSystem.

# Hierarchy

AbstractSystem<SubSystem>

↳ SubSystem

# Table of contents

# Constructors

constructor

# Properties

# Methods

# Constructors

# constructor

• new SubSystem(family)

# Parameters

Name	Type	Description
`family`	`Family`	The family of entities to process.

# Overrides

AbstractSystem.constructor

# Defined in

src/systems/SubSystem.ts:14 (opens new window)

# Properties

# engine

• Readonly engine: Engine

The engine of this system.

# Inherited from

AbstractSystem.engine

# Defined in

src/core/AbstractSystem.ts:14 (opens new window)

# family

• Readonly family: Family

# Defined in

src/systems/SubSystem.ts:9 (opens new window)

# Methods

# getPriority

▸ getPriority(): number

# Returns

number

The priority of the system. Do not override this!

# Inherited from

AbstractSystem.getPriority

# Defined in

src/core/AbstractSystem.ts:75 (opens new window)

# isEnabled

▸ isEnabled(): boolean

# Returns

boolean

True if the system is enabled.

# Inherited from

AbstractSystem.isEnabled

# Defined in

src/core/AbstractSystem.ts:57 (opens new window)

# onDisable

▸ Protected onDisable(): void

Called in two situations:

When the system is enabled and currently being removed from the manager
When the system is already added to the manager and is currently being disabled.

# Returns

void

# Inherited from

AbstractSystem.onDisable

# Defined in

src/core/AbstractSystem.ts:36 (opens new window)

# onEnable

▸ Protected onEnable(): void

Called in two situations:

When the system is enabled and currently being added to the manager
When the system is already added to the manager and is currently being enabled.

# Returns

void

# Inherited from

AbstractSystem.onEnable

# Defined in

src/core/AbstractSystem.ts:28 (opens new window)

# processEntity

▸ Abstract processEntity(entity, deltaTime): void

This method is called on every entity on every update call of the SubSystem. Override this to implement your system's specific processing.

# Parameters

Name	Type	Description
`entity`	`Entity`	The current Entity being processed.
`deltaTime`	`number`	The delta time between the last and current frame.

# Returns

void

# Defined in

src/systems/SubSystem.ts:26 (opens new window)

# setEnabled

▸ setEnabled(enabled): void

Enable or disable the system. A disabled system will not be processed during an update.

# Parameters

Name	Type	Description
`enabled`	`boolean`	The new state.

# Returns

void

# Inherited from

AbstractSystem.setEnabled

# Defined in

src/core/AbstractSystem.ts:43 (opens new window)

# setPriority

▸ setPriority(priority): void

Set the system priority. You can set the priority with when adding the system as well.

# Parameters

Name	Type	Description
`priority`	`number`	The priority to execute this system with (lower means higher priority).

# Returns

void

# Inherited from

AbstractSystem.setPriority

# Defined in

src/core/AbstractSystem.ts:66 (opens new window)

← SortedSubIteratingSystem SubSystemManager →