PathfindingClient2 outputs

getNthClosestVehicleNodeIdWithHeading

GET_NTH_CLOSEST_VEHICLE_NODE_ID_WITH_HEADING0x6448050E9C2A7207

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

SignatureJavaScript
getNthClosestVehicleNodeIdWithHeading(
  x: number,
  y: number,
  z: number,
  nthClosest: number,
  nodeFlags: number,
  p7: number,
  p8: number
): [
  result: number,
  outPosition: { x: number, y: number, z: number },
  outHeading: number
]
SignatureLua
getNthClosestVehicleNodeIdWithHeading(
  x: number,
  y: number,
  z: number,
  nthClosest: integer,
  nodeFlags: integer,
  p7: number,
  p8: number
): integer, Vector3, number

Usage

JavaScript
const [result, outPosition, outHeading] =
  getNthClosestVehicleNodeIdWithHeading(x, y, z, nthClosest, nodeFlags, p7, p8);
Lua
local result, outPosition, outHeading =
    getNthClosestVehicleNodeIdWithHeading(x, y, z, nthClosest, nodeFlags, p7, p8)

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 [result, outPosition, outHeading] = getNthClosestVehicleNodeIdWithHeading(
  pos, nthClosest, nodeFlags, p7, p8
);
Lua · with vectors
local result, outPosition, outHeading = getNthClosestVehicleNodeIdWithHeading(
    pos, nthClosest, nodeFlags, p7, p8
)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
nthClosestintnumberinteger
nodeFlagsintnumberinteger
p7floatnumbernumber
p8floatnumbernumber

Returns

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

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

On LS:MP

⚠
Signature under review

LS:MP's table describes the parameters of this native differently from the current native database (int GET_NTH_CLOSEST_VEHICLE_NODE_ID_WITH_HEADING(float x, float y, float z, int nthClosest, float outHeading, int outNumLanes, int nodeFlags, float zMeasureMult, float zTolerance)). Until the table is refreshed, some values may be passed or returned under the wrong type.

Reference

Namespace
Pathfinding PATHFIND
In the game
int GET_NTH_CLOSEST_VEHICLE_NODE_ID_WITH_HEADING(float x, float y, float z, int nthClosest, Vector3* outPosition, float* outHeading, int nodeFlags, float p7, float p8)
Hash
0x6448050E9C2A7207

Open in the interactive natives reference