UI Audio

Plays UI sound effects from a JSON-defined sound class registry.

Overview

ui_audio loads sound class definitions from ui/soundClasses.json on first update, then provides a simple function to play named UI sounds.

Extension path: lua/ge/extensions/ui/audio.lua

Exports (M)

Internals

Sound Classes JSON

The JSON file maps class names to event names to SFX paths:

{
  "button": {
    "click": { "sfx": "event:>UI>Button>Click" },
    "hover": { "sfx": "event:>UI>Button>Hover" }
  },
  "notification": {
    "popup": { "sfx": "event:>UI>Notification>Popup" }
  }
}

Playing Sounds

local function playEventSound(className, eventName)
  local sound_class = M.ui_sound_classes[className] or {}
  local event = sound_class[eventName]
  if event then
    Engine.Audio.playOnce('AudioGui', event.sfx)
  end
end

Sounds play on the 'AudioGui' audio source group.

How It Works

1. On first update, ui/soundClasses.json is loaded into memory
2. UI code calls ui_audio.playEventSound("button", "click") to play sounds
3. The SFX path is looked up and played as a one-shot via Engine.Audio.playOnce
4. Invalid class/event combinations silently do nothing

Additional Exports

The following exports are available but not yet documented in detail:

• M.onFirstUpdate
• M.playEventSound

See Also

• ui/ambientSound - Ambient Sound Stream Player - Related reference
• UI Apps Manager - Related reference
• Bindings Legend - Related reference
• UI System Guide - Guide