API ReferenceGE Extensionscore
Core Sounds
Manages GE-side sound system: global audio parameters, engine/exhaust sound init, cabin filter, and audio blur.
Manages GE-side sound system: global audio parameters, engine/exhaust sound init, cabin filter, and audio blur.
Overview
Extension: core_sounds - Updates global FMOD parameters every frame (camera speed, vehicle speed, time-of-day, underwater state, etc.). Also provides engine/exhaust sound initialization and cabin filter strength control.
Dependencies
core_camera, core_settings_settings, core_input_bindings
Public Functions
| Function | Description |
|---|---|
M.onPreRender(dtReal, dtSim, dtRaw) | Per-frame update of global audio params |
M.initEngineSound(vehId, engineId, jsonPath, nodeIdArray, noloadVol, loadVol) | Initializes engine sound for a vehicle |
M.initExhaustSound(vehId, engineId, jsonPath, nodeIdPairArray, noloadVol, loadVol) | Initializes exhaust sound with node pairs |
M.updateEngineSound(vehId, engineId, rpm, onLoad, engineVolume) | Updates engine sound parameters |
M.setEngineSoundParameter(vehId, engineId, paramName, paramValue) | Sets a single engine sound parameter |
M.setEngineSoundParameterList(vehId, engineId, parameters) | Sets multiple engine sound parameters |
M.setExhaustSoundNodes(vehId, engineId, nodeIdPairArray) | Updates exhaust node positions |
M.setCabinFilterStrength(objId, value) | Sets cabin filter reverb strength (0–1) for player vehicle |
M.setAudioBlur(value) | Manually sets the game audio blur value |
M.onSettingsChanged() | Refreshes AudioInsideModifier from settings |
M.onUiChangedState(toState, fromState) | Manages audio blur during mission UI transitions |
M.onMissionInfoChangedState(fromState, toState, content) | Audio blur for mission info panel |
M.onActivityAcceptGatherData(elemData, activityData) | Detects mission marker interactions for audio blur |
M.onMissionAvailabilityChanged(data) | Clears mission marker interaction flag |
M.onVehicleSwitched(oldId, newId, player) | Triggers cabin filter update on vehicle switch |
M.cabinFilterStrength | Number. Cabin audio filter strength (default 1). |
M.dependencies | Table. Required extensions: {'core_camera', 'core_settings_settings', 'core_input_bindings'} |
Global Audio Parameters Updated Per Frame
| Parameter | Description |
|---|---|
g_GameAudioBlur | Audio blur amount (0–1) |
g_CamSpeedMS | Camera movement speed (m/s) |
g_CamRotationSpeedMS | Camera rotation speed |
g_CamRotationAngle | Camera yaw angle (degrees) |
g_VehicleSpeedPlayerMS | Player vehicle speed (m/s) |
g_CamOnboard | Cockpit camera flag |
g_CamFree | Free camera flag |
g_CamUnderwater | Underwater camera flag |
g_UnderwaterDepth | Depth below water surface |
g_CamHeightToGround | Height above terrain |
g_CamHeightToSea | Height above sea level |
g_Tod | Time of day value |
c_CabinFilterReverbStrength | Cabin reverb strength |
Module State
| Variable | Type | Default |
|---|---|---|
dependencies | table | {'core_camera', 'core_settings_settings', 'core... |
cabinFilterStrength | number | 1 |
cabinFilterStrength | number | 1 |
Usage Examples
-- Init engine sound
core_sounds.initEngineSound(vehId, 0, 'art/sounds/engine.json', {nodeId})
-- Set audio blur
core_sounds.setAudioBlur(0.5)See Also
- Settings Audio - Volume controls