Skip to content
San Andreas Online Docs

engineUnloadVehicleAudioConfig

Client-side
SA:O APIResource-owned vehicle audio

Stops the calling resource's custom vehicle audio, restores GTA audio, and releases the global lease.

Syntax

bool engineUnloadVehicleAudioConfig()

Returns

true when the calling resource owned and unloaded the configuration; false otherwise.

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
  • Resource shutdown and client teardown run the same cleanup automatically. Commit fd9045ae added teardown guards for this path.

Where this comes from

SOURCECLuaEngineDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp INTRODUCED / EXTENDED0418bcea7Read the commit and why the change was made
RELATED SA:O APIS

Continue exploring

Read the system guide →
engineLoadVehicleAudioConfig Acquires the client-wide vehicle-audio lease and loads Soundize-compatible model definitions from the calling resource. engineReloadVehicleAudioConfig Reparses the current owner's definitions and schedules a clean lazy restart of the vehicle-audio banks. enginePlayVehicleAudioBackfire Make an active custom-audio vehicle backfire on demand. San Andreas Online plays the configured pop and, in full/flames mode, fires a normal or stronger burst from the exhaust.

← Back to the SA:O Lua API · How Resource-owned vehicle audio works →