Class: AudioSystem
Defined in: audio/systems/audio-system.ts:7
System to manage and play sounds for entities with a SoundComponent.
Extends
Constructors
Constructor
new AudioSystem():
AudioSystem
Defined in: audio/systems/audio-system.ts:11
Creates an instance of AudioSystem.
Returns
AudioSystem
Overrides
Properties
isEnabled
isEnabled:
boolean=true
Defined in: ecs/types/System.ts:24
Indicates whether the system is enabled.
Inherited from
name
name:
string
Defined in: ecs/types/System.ts:14
The name of the system.
Inherited from
query
query:
Query
Defined in: ecs/types/System.ts:19
The components that this system operates on.
Inherited from
Methods
beforeAll()
beforeAll(
entities):Entity[]
Defined in: ecs/types/System.ts:70
Hook method that is called before running the system on all entities. Can be overridden by subclasses to modify the entities before processing.
Parameters
entities
Entity[]
The entities to be processed.
Returns
Entity[]
The modified entities.
Inherited from
run()
run(
entity):void
Defined in: audio/systems/audio-system.ts:20
Runs the audio system for a given entity.
Parameters
entity
The entity to update and play sounds for.
Returns
void
A promise.
Overrides
runSystem()
runSystem(
entities):void
Defined in: ecs/types/System.ts:40
Runs the system on the provided entities.
Parameters
entities
Entity[]
The entities to run the system on.
Returns
void
Inherited from
stop()
stop():
void
Defined in: ecs/types/System.ts:77
Stops the system. This method can be overridden by subclasses.
Returns
void