Class default

Hierarchy

Host<IAudioEvents>
- default

Index

Constructors

Properties

Methods

getMusicHandler playMusic playUiSoundEffect processGameSounds queueGameSoundEffect resetMusicHandler resumeSoundEffects setMusicHandler stopMusic suspendSoundEffects updateMusicSpeed updatePosition updateVolume

Constructors

constructor

new default(): default
Returns default
Overrides Host.constructor
- Defined in src/game/audio/Audio.ts:113

Properties

`Readonly` event

event: IEventEmitter<default, IAudioEvents> = ...

Methods

getMusicHandler

getMusicHandler(): default<Music, string>
Returns the current music handler, an instance of EnumCursor<Music>

Returns default<Music, string>
- Defined in src/game/audio/Audio.ts:121

playMusic

playMusic(): Promise<void>
Sets the current track to the first in the current music handler.

Returns Promise<void>
- Defined in src/game/audio/Audio.ts:159

playUiSoundEffect

playUiSoundEffect(sfxType: SfxType, speed?: number): Promise<void>
Plays a ui sound effect (a sound effect with no position)
Parameters
- sfxType: SfxType
- speed: number = 1
Returns Promise<void>
- Defined in src/game/audio/Audio.ts:223

processGameSounds

processGameSounds(): void
Returns void
- Defined in src/game/audio/Audio.ts:296

queueGameSoundEffect

queueGameSoundEffect(type: SfxType, position: IVector4, delay?: number, speed?: number): void
Plays a sound effect (game / location based)
Parameters
- type: SfxType
- position: IVector4
- delay: number = 0
- speed: number = 1
Returns void
- Defined in src/game/audio/Audio.ts:243

resetMusicHandler

resetMusicHandler(): Promise<void>
Resets the music handler to its original state.

Returns Promise<void>
- Defined in src/game/audio/Audio.ts:144

resumeSoundEffects

resumeSoundEffects(): void
Returns void
- Defined in src/game/audio/Audio.ts:152

setMusicHandler

setMusicHandler(musicHandler: default<Music, string>): Promise<void>
Sets the music handler to the provided instance of EnumCursor<Music>. Causes any playing music to stop.
Parameters
- musicHandler: default<Music, string>
Returns Promise<void>
- Defined in src/game/audio/Audio.ts:132

stopMusic

stopMusic(): void
Returns void
- Defined in src/game/audio/Audio.ts:166

suspendSoundEffects

suspendSoundEffects(): void
Returns void
- Defined in src/game/audio/Audio.ts:148

updateMusicSpeed

updateMusicSpeed(speed: number): Promise<void>
Parameters
- speed: number
Returns Promise<void>
- Defined in src/game/audio/Audio.ts:170

updatePosition

updatePosition(): Promise<void>
Returns Promise<void>
- Defined in src/game/audio/Audio.ts:205

updateVolume

updateVolume(): void
Returns void
- Defined in src/game/audio/Audio.ts:185

Generated using TypeDoc