PathfindingClient3 outputs

getNthClosestVehicleNodeWithHeading

GET_NTH_CLOSEST_VEHICLE_NODE_WITH_HEADING0x80CA6A8B6C094CC4

The GTA V native GET_NTH_CLOSEST_VEHICLE_NODE_WITH_HEADING of the PATHFIND namespace, as LS:MP client scripts call it: the global function getNthClosestVehicleNodeWithHeading, in JavaScript and in Lua.

SignatureJavaScript
getNthClosestVehicleNodeWithHeading(
  x: number,
  y: number,
  z: number,
  nthClosest: number,
  nodeFlags: number,
  unknown3: number,
  unknown4: number
): [
  ok: boolean,
  outPosition: { x: number, y: number, z: number },
  outHeading: number,
  outNumLanes: number
]
SignatureLua
getNthClosestVehicleNodeWithHeading(
  x: number,
  y: number,
  z: number,
  nthClosest: integer,
  nodeFlags: integer,
  unknown3: number,
  unknown4: number
): boolean, Vector3, number, integer

Usage

JavaScript
const [ok, outPosition, outHeading, outNumLanes] =
  getNthClosestVehicleNodeWithHeading(x, y, z, nthClosest, nodeFlags, unknown3, unknown4);
Lua
local ok, outPosition, outHeading, outNumLanes =
    getNthClosestVehicleNodeWithHeading(x, y, z, nthClosest, nodeFlags, unknown3, unknown4)

Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.

JavaScript · with vectors
const [ok, outPosition, outHeading, outNumLanes] = getNthClosestVehicleNodeWithHeading(
  pos, nthClosest, nodeFlags, unknown3, unknown4
);
Lua · with vectors
local ok, outPosition, outHeading, outNumLanes = getNthClosestVehicleNodeWithHeading(
    pos, nthClosest, nodeFlags, unknown3, unknown4
)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
nthClosestintnumberinteger
nodeFlagsintnumberinteger
unknown3floatnumbernumber
unknown4floatnumbernumber

Returns

4 values, in this order: an array in JavaScript, multiple return values in Lua.

#ValueTypeJavaScriptLuaDescription
1okBOOLbooleanbooleanThe native’s own return value.
2outPositionVector3{ x: number, y: number, z: number }Vector3output
3outHeadingfloatnumbernumberoutput
4outNumLanesintnumberintegeroutput

Notes

From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.

Get the nth closest vehicle node and its heading.

Reference

Namespace
Pathfinding PATHFIND
In the game
BOOL GET_NTH_CLOSEST_VEHICLE_NODE_WITH_HEADING(float x, float y, float z, int nthClosest, Vector3* outPosition, float* outHeading, int* outNumLanes, int nodeFlags, float unknown3, float unknown4)
Hash
0x80CA6A8B6C094CC4

Open in the interactive natives reference