Skip to content
San Andreas Online Docs

validatePedNativeCouple

Client-side
SA:O APISynchronized NPCs and road traffic

Pre-flight check that reports whether two peds can form a native GTA couple and which one should lead.

Syntax

table|false validatePedNativeCouple(ped a, ped b)

Arguments

aped

First candidate ped simulated by this client.

bped

Second candidate ped simulated by this client.

Returns

A table with compatible, aLeader, leaderIndex, walkSpeedA and walkSpeedB; false without resource context or when the pair cannot be evaluated.

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
  • Leadership is derived from the two native walk speeds. A pair with incompatible speeds would immediately exceed its own give-up distance.
  • Pass the returned leaderIndex straight into acquirePedNativeCouple; that is the intended flow.
  • This creates nothing and leases nothing.

Example

local check = validatePedNativeCouple(pedA, pedB)
if check and check.compatible then
    local token = acquirePedNativeCouple(pedA, pedB, check.leaderIndex)
end

Where this comes from

SOURCECLuaPedDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaPedDefs.cpp INTRODUCED / EXTENDEDd709fa696Read 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 →
acquirePedNativeGroup Put several NPCs into one group so GTA treats them as a single walking group and manages their shared movement. releasePedNativeGroup Releases a native ambient group token owned by the calling resource. isPedNativeGroupActive Reports whether the calling resource still owns a live native ambient group.

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