five-on-it / apps/client/src/audio/sound-player / SoundPlayer
Interface: SoundPlayer
Defined in: apps/client/src/audio/sound-player.ts:65
The sound bank's player.
Properties
played
readonlyplayed:Readonly<Partial<Record<SoundId,number>>>
Defined in: apps/client/src/audio/sound-player.ts:77
How many times each sound has played (a loop counts each start), for the end-to-end tests.
Methods
dispose()
dispose():
void
Defined in: apps/client/src/audio/sound-player.ts:81
Stops everything and lets the sounds go.
Returns
void
hold()
hold(
on):void
Defined in: apps/client/src/audio/sound-player.ts:75
Holds every sound but the ui bus's while the game is paused (true), and lets them go on again.
Parameters
on
boolean
Returns
void
loop()
loop(
id):Loop
Defined in: apps/client/src/audio/sound-player.ts:69
The loop of a sound (one per sound: asked again, the same).
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"
Returns
play()
play(
id,options?):void
Defined in: apps/client/src/audio/sound-player.ts:67
Plays a sound 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
preload()
preload(
ids):void
Defined in: apps/client/src/audio/sound-player.ts:71
Loads sounds now, so their first play is not late.
Parameters
ids
readonly ("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")[]
Returns
void
setVolumes()
setVolumes(
volumes):void
Defined in: apps/client/src/audio/sound-player.ts:73
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
sourceOf()
sourceOf(
id):SoundSource
Defined in: apps/client/src/audio/sound-player.ts:79
Where a sound comes from.
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"
Returns
SoundSource