Skip to content
San Andreas Online Docs

setAmbientPedPopulationZoneState

Client-side
SA:O APISynchronized NPCs and road traffic

Overrides selected native population fields for one GTA navigation zone inside the reversible population world state.

Syntax

bool setAmbientPedPopulationZoneState(string zoneLabel, table state)

Arguments

zoneLabelstring

GTA navigation-zone label.

statetable

Optional populationType, races, dealerStrength, noCops and gangStrengths fields.

Table keys

populationTypeintoptional

Native population type for the zone.

racestableoptional

Race weighting for the zone.

dealerStrengthintoptional

Native dealer strength.

noCopsbooloptional

Flags the zone as no-cops, which suppresses the ambient cop target.

gangStrengthstableoptional

Per-gang strength values.

Returns

true when the named zone and supplied fields were accepted; false otherwise.

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
  • Only fields present in the table are changed.
  • Use resetAmbientPedPopulationZonesToBootstrap to return to the stock campaign bootstrap.

Where this comes from

SOURCECLuaWorldDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaWorldDefs.cpp INTRODUCED / EXTENDED1004257b9Read the commit and why the change was made TEST RESOURCE native-ped-traffic test-resources/native-ped-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.

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