five-on-it / apps/client/src/renderer/audio / AudioSystem
Interface: AudioSystem
Defined in: apps/client/src/renderer/audio.ts:49
The audio system.
Properties
played
readonlyplayed:Readonly<Partial<Record<SoundId,number>>>
Defined in: apps/client/src/renderer/audio.ts:59
How many times each sound has played, for the end-to-end tests.
Methods
bark()
bark(
volume):void
Defined in: apps/client/src/renderer/audio.ts:67
A dog's bark heard, volume loud (0 out of earshot to 1 beside it); no two barks quite alike.
Parameters
volume
number
Returns
void
boom()
boom(
volume):void
Defined in: apps/client/src/renderer/audio.ts:63
An explosion's boom, volume loud (0 to 1: by its size and how far it is).
Parameters
volume
number
Returns
void
dispose()
dispose():
void
Defined in: apps/client/src/renderer/audio.ts:73
Stops everything.
Returns
void
hold()
hold(
on):void
Defined in: apps/client/src/renderer/audio.ts:71
Holds every sound while the game is paused (true), and lets them go on again.
Parameters
on
boolean
Returns
void
honk()
honk():
void
Defined in: apps/client/src/renderer/audio.ts:61
Sounds the horn once.
Returns
void
play()
play(
id,options?):void
Defined in: apps/client/src/renderer/audio.ts:57
Plays any sound of the bank once.
Parameters
id
"vehicle.engine" | "vehicle.tyre.scrub" | "vehicle.horn" | "vehicle.siren" | "vehicle.ice-cream.jingle" | "vehicle.carjack" | "weapon.fists.swing" | "weapon.pistol.shot" | "weapon.shotgun.shot" | "weapon.rifle.shot" | "weapon.rocket.launch" | "weapon.grenade.throw" | "weapon.tranquilizer.shot" | "vehicle.knock" | "weapon.hit" | "world.explosion" | "world.thunder" | "world.fire" | "weather.rain" | "weather.wind" | "animal.dog.bark" | "music.theme" | "radio.tune" | "ui.menu.move" | "ui.menu.select" | "ui.menu.back" | "ui.menu.start" | "ui.pause"
options?
Returns
void
quietMusic()
quietMusic(
on):void
Defined in: apps/client/src/renderer/audio.ts:55
Quiets the music while the radio plays (true), and lets it play again.
Parameters
on
boolean
Returns
void
setVolumes()
setVolumes(
volumes):void
Defined in: apps/client/src/renderer/audio.ts:69
Sets the volumes, each 0..1: of everything, of the music and of the effects.
Parameters
volumes
effects
number
master
number
music
number
Returns
void
thunder()
thunder(
volume):void
Defined in: apps/client/src/renderer/audio.ts:65
A thunderclap heard, 0 (far off) to 1 (overhead): the boom, a deep rumble.
Parameters
volume
number
Returns
void
toggleMusic()
toggleMusic():
boolean
Defined in: apps/client/src/renderer/audio.ts:53
Starts or stops the music; returns whether it now plays.
Returns
boolean
update()
update(
state):void
Defined in: apps/client/src/renderer/audio.ts:51
Follows the car; call every frame.
Parameters
state
AudioState
Returns
void