NEON APIResource-owned vehicle audio

Available in Neon, not standard MTA

Acquires the client-wide vehicle-audio lease and loads Soundize-compatible model definitions from the calling resource.

Syntax

Copy signature

bool engineLoadVehicleAudioConfig(string path)

Arguments

pathstring

Non-empty path to a configuration file inside the calling resource.

Returns

true when the caller acquired the lease and the configuration contained at least one valid vehicle definition; false for an invalid or cross-resource path, another owner, a missing manager, or parse failure.

Ownership and lifecycle

One client resource owns the global vehicle-audio lease. Reloading replaces its definitions and restarts the lazy bank state; unloading, resource shutdown, or client teardown stops active audio, restores GTA's vehicle sound, and releases the lease.

Important behavior

• FMOD and banks initialize lazily during the client pulse, so true does not prove that the runtime or every referenced bank can play.
• The expected content root contains base/common.bank, base/common.strings.bank, and recursively indexed banks/*.bank files with same-stem .ini metadata.

Example

assert(engineLoadVehicleAudioConfig('vehicle-audio.conf'))

Where this comes from

SOURCECLuaEngineDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp INTRODUCED / EXTENDED0418bcea7Read the commit and why the change was made

RELATED NEON APIS

Continue exploring

Read the system guide →

engineReloadVehicleAudioConfig Reparses the current owner's definitions and schedules a clean lazy restart of the vehicle-audio banks. engineUnloadVehicleAudioConfig Stops the calling resource's custom vehicle audio, restores GTA audio, and releases the global lease. enginePlayVehicleAudioBackfire Plays a normal or high custom backfire on a vehicle already active in the owned audio system.

Next in category →engineReloadVehicleAudioConfig

← Back to the Neon Lua API · How Resource-owned vehicle audio works →