Engine Audio Debug
Editor window for real-time tweaking of engine sound parameters including gain, EQ, muffling, and frequency settings with live preview and clipboard export.
Editor window for real-time tweaking of engine sound parameters including gain, EQ, muffling, and frequency settings with live preview and clipboard export.
Overview
editor_engineAudioDebug provides an ImGui window that queries engine sound data from the player vehicle and exposes all audio parameters (gain, EQ bands, shelving filters, muffling, fundamental frequency) as draggable sliders. Changes are applied in real-time to the vehicle's FMOD sound engine. Includes export-to-clipboard and reset functionality.
Module Fields
| Field | Type | Description |
|---|
Public Functions
| Function | Description |
|---|---|
M.open() | Show the Engine Audio Debug window |
M.onExtensionLoaded() | Queries vehicle for initial audio data |
M.onEditorInitialized() | Registers window and menu item under Audio group |
M.onEditorGui(dt) | Draws the full parameter editing UI |
M.onVehicleSwitched(old, new, player) | Re-queries audio data when vehicle changes |
M.onEditorDeactivated() | Hides exhaust direction indicator |
M.onEditorActivated() | Refreshes vehicle audio data |
M.onDebugDrawActive() | Debug draw callback for visual overlays |
Key Internal Functions
| Function | Description |
|---|---|
hzToFMODHz(hzValue) | Converts real Hz to FMOD's 0-1000 scale |
FMODHzToHz(fmodHzValue) | Converts FMOD scale back to real Hz |
updateVehicleData() | Queues Lua command to vehicle to fetch sound data |
Audio Parameters Exposed
| Parameter | Range | Description |
|---|---|---|
mainGain | -30 to 10 | Overall volume gain (dB) |
muffling | 0 to 1 | Exhaust muffling amount |
onLoadGain / offLoadGain | 0 to 1 | Throttle load volume balance |
lowShelfFreq/Gain | 20-20kHz / ±30dB | Low shelf EQ |
highShelfFreq/Gain | 20-20kHz / ±30dB | High shelf EQ |
eqLowGain/Freq/Width | Various | Parametric EQ low band |
eqHighGain/Freq/Width | Various | Parametric EQ high band |
eqFundamentalGain | ±30dB | Fundamental frequency boost |
fundamentalFreqCylCount | 0-32 | Cylinder count for RPM coefficient |
Usage Example
-- Open the engine audio debug window
extensions.editor_engineAudioDebug.open()
-- Data is populated asynchronously via vehicle Lua queue
-- Access current sound data:
local data = editor_engineAudioDebug.engine.engineSoundDataSee Also
- Editor AI Tests - Related reference
- Editor AI Visualization - Related reference
- Editor – Assembly Spline Tool - Related reference
- World Editor Guide - Guide
Dynamic Decals Tool (Vehicle Livery Creator)
Editor extension providing the Vehicle Livery Creator - a comprehensive tool for painting decals, brush strokes, paths, and fills onto vehicle surfaces in real-time.
Extensions Debug
Editor window that displays all loaded extensions as an expandable tree, showing their functions, values, and internal structure for debugging purposes.