Interface Audio

play

• play(name: string): Promise<void>

  Plays a game sound event, the way the game plays its UI sounds.

  Sound event names are listed in the game's audio data. These are tested: ui_menu_onpress, ui_menu_hover, ui_loot_take_all. The Overlay apps guide lists more.

  Parameters

  • name: string

    The sound event name.

  Returns Promise<void>

  Example

  await game.audio.play("ui_menu_onpress");
  Copy