Skip to main content

Audio

Audio tools handle speech, sound effects, and background music.

play_sound

Play a sound effect asset.

ParameterTypeDefaultDescription
soundstringrequiredSound asset ID (e.g. se:open)
volumenumber0.8Volume level (range: 0.0–1.0)

control_bgm

Control background music playback.

ParameterTypeDefaultDescription
action"play" | "stop" | "pause" | "resume" | "status"requiredAction to perform
assetstringMOD asset ID — required when action is "play"
volumenumberVolume level (range: 0.0–1.0)

The "status" action returns the current playback state as JSON.