SA:O APISynchronized NPCs and road traffic

Asks GTA for a native ambient gang-group placement with two to four proposed members.

Syntax

Copy signature

table|false, string? getAmbientPedGangGroupCandidate(Vector3 origin, int gangId [, int maxMembers = 4])

Arguments

originVector3

Finite population origin.

gangIdint

Supported native gang ID from 0 through 7.

maxMembersintoptional · default 4

Maximum proposed group size from 2 through 4.

Returns

An array of member candidates with model, pedType, position, heading and gang metadata; or false plus a bounded miss reason.

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

• This is a placement oracle only. The server must validate and create the real group elements.

Where this comes from

SOURCECLuaWorldDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaWorldDefs.cpp INTRODUCED / EXTENDED39f782fd9Read 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.

← Previous in categoryisAmbientPedSphereVisible Next in category →getAmbientPedCivilianCoupleCandidate

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