Audio Ribbon Editor
Editor tool for placing dynamic audio emitter ribbons in the 3D world. Ribbons define spatial zones where audio events play directionally (quad emitters) or as single ambient sources. Supports surface
Editor tool for placing dynamic audio emitter ribbons in the 3D world. Ribbons define spatial zones where audio events play directionally (quad emitters) or as single ambient sources. Supports surface conforming, undo/redo, mute/solo mixing, and per-emitter event path configuration.
Public Functions
| Function | Description |
|---|---|
M.onInit() | Initialize ribbon state if not already present |
M.onEditorGui() | Main per-frame UI and 3D rendering callback |
M.onEditorInitialized() | Registers edit mode and tool window |
Key Features
- Ribbon Drawing - Place left/right node pairs with mouse to define ribbon shape
- Emitter Types - Quad (4 directional emitters) or Ambient (single emitter)
- Surface Modes - Top surface only, bottom surface only, or full 3D volume
- Conform to Surface - Snap ribbon nodes to terrain, river surfaces, or water planes
- Lock Shape - Toggle rigid translation vs individual node movement
- Mute/Solo - Per-direction mute toggles (front, rear, left, right)
- Event Paths - Configure FMOD event paths per emitter direction
- Speed/Depth - Master controls for ribbon playback speed and depth
- Undo/Redo - Full history support for all ribbon operations
Emitter Type Strings
| Type | Description |
|---|---|
Four Emitters - 2D (Over Top Surface Only) | Quad emitters on top face |
Four Emitters - 2D (Over Bottom Surface Only) | Quad emitters on bottom face |
Four Emitters - 3D (Over Whole Volume) | Quad emitters over full volume |
Single Emitter Only | Ambient single-source emitter |
Usage Example
-- Access ribbon data from the audio ribbon module
local audioRibbon = require('core/audioRibbon')
local ribbons = audioRibbon.getRibbons()
for i, ribbon in ipairs(ribbons) do
print(ribbon.name, ribbon.speed, #ribbon.nodes)
endSee Also
- audioEventsList - Browse and preview audio events
SFX Previewer (Audio Events List)
Editor window for browsing and previewing sound effects (SFX events). Provides a folder-based hierarchical view of all registered audio events, text search, and one-click playback.
AutoSave
Editor extension that periodically auto-saves the level scene tree and provides a restore dialog on unclean exits. Saves to `/settings/editor/autosaves/<levelName>/`.