Class AudioManager

constructor

• new AudioManager(): AudioManager

  Returns AudioManager

Readonlyvolume

fadeOutBgm

• fadeOutBgm(duration?: number, fixed?: boolean, destroy?: boolean): void

  Fades out the current bgm over duration ms.

  Parameters

  • duration: number = 500

    (Default 500) The amount of time the fade out should take place over, in ms

  • fixed: boolean = false

    (Default false) Whether the duration should ignore game speed

  • destroy: boolean = true

    (Default true) Whether to destroy the bgm after fading out, or just pause it

  Returns void

getVolume

• getVolume(setting: VolumeSetting): number

  Get the effective volume for a given setting (the product of that volume and the main volume).

  Parameters

  • setting: VolumeSetting

    The VolumeSetting to get the volume for

  Returns number

  The effective volume for the given setting (between 0 and 1)

playBgm

• playBgm(
      bgmName?: string,
      fadeOutPrevious?: boolean,
      loop?: boolean,
      fadeDuration?: number,
  ): BackgroundMusic | null

  Plays a new bgm.

  Parameters

  • OptionalbgmName: string

    (Optional) The bgm to play.
    If not specified, will first fall back to choosing the bgm based on the current battle config, then further based on the current Biome.
    Can be overridden by a currently running event.

  • fadeOutPrevious: boolean = false

    (Default false) Whether to fade out the previously playing bgm

  • loop: boolean = true

    (Default true) Whether to loop the new bgm

  • fadeDuration: number = 500

    (Default 500) How long, in ms, the fade out of the previous bgm should take

  Returns BackgroundMusic | null

  The BackgroundMusic instance for the new bgm, or null if no valid bgm could be played or the input bgm was the same as the currently playing bgm

playSound

• playSound(
      sound: string | AnySound,
      config?: SoundConfig | SoundMarker,
  ): AnySound | null

  Plays a sound effect (such as a Pokemon cry, UI cursor sfx, etc)

  Parameters

  • sound: string | AnySound

    The sound effect to play

  • config: SoundConfig | SoundMarker = {}

    (Optional) A Phaser SoundConfig or SoundMarker object

  Returns AnySound | null

  The sound object

replaceBgmUntilEnd

• replaceBgmUntilEnd(bgmName: string): BackgroundMusic

  Replace the current BGM track with bgmName, then resume it after bgmName finishes.

  Parameters

  • bgmName: string

    The key for the replacement track

  Returns BackgroundMusic

  The newly-created BackgroundMusic object

updateSoundVolume

• updateSoundVolume(): void

  Updates the set volume for the audio/bgm with the user's saved config values.

  Returns void