# Class: IntervalSystem
A simple EntitySystem that does not run its update logic every call to update, but after a given interval. The actual logic should be placed in updateInterval.
# Hierarchy
-
↳
IntervalSystem
# Table of contents
# Constructors
# Properties
# Methods
- getInterval
- getPriority
- isEnabled
- onDisable
- onEnable
- setEnabled
- setInterval
- setPriority
- update
- updateInterval
# Constructors
# constructor
• new IntervalSystem(interval
)
# Parameters
Name | Type | Description |
---|---|---|
interval | number | The time in seconds between calls to updateInterval. |
# Overrides
# Defined in
src/systems/IntervalSystem.ts:15 (opens new window)
# Properties
# engine
• Readonly
engine: Engine
The engine of this system.
# Inherited from
# Defined in
src/core/AbstractSystem.ts:14 (opens new window)
# Methods
# getInterval
▸ getInterval(): number
# Returns
number
The time in seconds between calls to updateInterval.
# Defined in
src/systems/IntervalSystem.ts:32 (opens new window)
# getPriority
▸ getPriority(): number
# Returns
number
The priority of the system. Do not override this!
# Inherited from
# Defined in
src/core/AbstractSystem.ts:75 (opens new window)
# isEnabled
▸ isEnabled(): boolean
# Returns
boolean
True if the system is enabled.
# Inherited from
# 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
# 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
# Defined in
src/core/AbstractSystem.ts:28 (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
# Defined in
src/core/AbstractSystem.ts:43 (opens new window)
# setInterval
▸ setInterval(interval
): void
Update the interval.
# Parameters
Name | Type | Description |
---|---|---|
interval | number | The time in seconds between calls to updateInterval. |
# Returns
void
# Defined in
src/systems/IntervalSystem.ts:25 (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
# Defined in
src/core/AbstractSystem.ts:66 (opens new window)
# update
▸ update(deltaTime
): void
The update method called every tick.
# Parameters
Name | Type |
---|---|
deltaTime | number |
# Returns
void
# Overrides
# Defined in
src/systems/IntervalSystem.ts:36 (opens new window)
# updateInterval
▸ Protected
Abstract
updateInterval(): void
The processing logic of the system should be placed here. Will be called once every defined interval.
# Returns
void