SA:O APISynchronized NPCs and road traffic

Returns focused lease, task, and per-member diagnostics for one native couple token.

Syntax

Copy signature

table|false getPedNativeCoupleDiagnostic(int token)

Arguments

tokenint

Couple token owned by the calling resource.

Returns

A table with active, reason, nativeCoupleId, resourceLeasePresent, gameLeasePresent, aLeader and two per-member tables; false when no resource context exists.

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

• reason names the exact failure: resource-lease-missing, resource-element-not-ped, resource-ped-not-syncing, game-lease-missing, lease-member-mismatch, primary-task-missing, primary-task-replaced, partner-mismatch, role-mismatch, or active.
• Each member table reports reciprocalPartner and leaderRoleMatches, which is how a pair that looks visually broken is diagnosed.
• This is a debugging surface, not gameplay state to synchronize.

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.

← Previous in categoryisPedNativeCoupleActive Next in category →acquirePedNativeCouplePresentation

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