springroll.SoundContext Class

Defined in: springroll.SoundContext:8
Module: Sound

A private class that represents a sound context.

Constructor

springroll.SoundContext

(
  • id
)
private

Defined in springroll.SoundContext:8

Parameters:

  • id String

    The name of the sound context.

id

String public

Defined in id:17

The name of the sound context.

muted

Bool public

Defined in muted:31

If all sounds in the sound context are muted or not.

sounds

Array public

Defined in sounds:38

The sound objects in this context, from Sound.instance._sounds;

subContexts

Array

Defined in subContexts:45

A list of context ids of SoundContexts that belong to this one, for example: "game-sfx" and "ui-sfx" being sub-contexts of "sfx".

volume

Number public

Defined in volume:24

The current volume to apply to all sounds in the context (0 to 1).