Skip to main content

Class: AudioSystem

Defined in: audio/systems/audio-system.ts:7

System to manage and play audio for entities with a AudioComponent.

Extends​

Constructors​

Constructor​

new AudioSystem(world): AudioSystem

Defined in: audio/systems/audio-system.ts:13

Creates an instance of AudioSystem.

Parameters​

world​

World

Returns​

AudioSystem

Overrides​

System.constructor

Properties​

isEnabled​

isEnabled: boolean = true

Defined in: ecs/types/System.ts:24

Indicates whether the system is enabled.

Inherited from​

System.isEnabled

name​

name: string

Defined in: ecs/types/System.ts:14

The name of the system.

Inherited from​

System.name

query​

query: Query

Defined in: ecs/types/System.ts:19

The components that this system operates on.

Inherited from​

System.query

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​

System.beforeAll

run()​

run(entity): void

Defined in: audio/systems/audio-system.ts:24

Runs the audio system for a given entity.

Parameters​

entity​

Entity

The entity to update and play sounds for.

Returns​

void

A promise.

Overrides​

System.run

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​

System.runSystem

stop()​

stop(): void

Defined in: audio/systems/audio-system.ts:38

Stops the audio system and unloads all sounds.

Returns​

void

Overrides​

System.stop