SA:O APISynchronized NPCs and road traffic

Ask GTA which civilian road vehicle naturally fits the current area and population settings—without creating it.

Syntax

Copy signature

table|false, string? getAmbientVehicleModelCandidate()

Returns

A table with model, carGroup, and vehicleClass; or false plus a reason when GTA cannot select a road vehicle.

Ownership and lifecycle

Candidate queries create nothing. A multiplayer resource must validate each proposal, create and own the real NPCs and vehicles, assign one current syncer, handle ownership changes, and clean up every element. Native AI and event tokens belong to the calling resource and are revoked when that resource stops.

Important behavior

• The choice comes from GTA's current population and car-group state.
• The server still decides whether to accept the proposal and create the vehicle.

Where this comes from

SOURCECLuaWorldDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaWorldDefs.cpp INTRODUCED / EXTENDEDb23f57d74Read the commit and why the change was made TEST RESOURCE native-vehicle-traffic test-resources/native-vehicle-traffic

RELATED SA:O APIS

Continue exploring

Read the system guide →

updateAmbientPedPopulationModels Runs GTA's ped-only zone-model residency pass around an origin without enabling unmanaged population creation. resetAmbientPedPopulationModels Releases the stock population-model residency established by the ambient-ped update pass. addPedNativeGunAimedAtEvent Inserts GTA's real aimed-at event on the authoritative ambient-ped owner.

← Previous in categorygetAmbientVehicleSpawnCandidate Next in category →getAmbientVehicleOccupantModelCandidate

← Back to the SA:O Lua API · How Synchronized NPCs and road traffic works →