PathfindingClient2 outputs

getNthClosestVehicleNodeFavourDirection

GET_NTH_CLOSEST_VEHICLE_NODE_FAVOUR_DIRECTION0x45905BE8654AE067

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

SignatureJavaScript
getNthClosestVehicleNodeFavourDirection(
  x: number,
  y: number,
  z: number,
  desiredX: number,
  desiredY: number,
  desiredZ: number,
  nthClosest: number,
  nodeFlags: number,
  p10: number,
  p11: number
): [
  ok: boolean,
  outPosition: { x: number, y: number, z: number },
  outHeading: number
]
SignatureLua
getNthClosestVehicleNodeFavourDirection(
  x: number,
  y: number,
  z: number,
  desiredX: number,
  desiredY: number,
  desiredZ: number,
  nthClosest: integer,
  nodeFlags: integer,
  p10: number,
  p11: number
): boolean, Vector3, number

Usage

JavaScript
const [ok, outPosition, outHeading] =
  getNthClosestVehicleNodeFavourDirection(
    x, y, z, desiredX, desiredY, desiredZ, nthClosest, nodeFlags, p10, p11
  );
Lua
local ok, outPosition, outHeading =
    getNthClosestVehicleNodeFavourDirection(
        x, y, z, desiredX, desiredY, desiredZ, nthClosest, nodeFlags, p10, p11
    )

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] = getNthClosestVehicleNodeFavourDirection(
  pos, desired, nthClosest, nodeFlags, p10, p11
);
Lua · with vectors
local ok, outPosition, outHeading = getNthClosestVehicleNodeFavourDirection(
    pos, desired, nthClosest, nodeFlags, p10, p11
)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
desiredXfloatnumbernumber
desiredYfloatnumbernumber
desiredZfloatnumbernumber
nthClosestintnumberinteger
nodeFlagsintnumberinteger
p10floatnumbernumber
p11floatnumbernumber

Returns

3 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

Notes

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

See https://gtaforums.com/topic/843561-pathfind-node-types for node type info. 0 = paved road only, 1 = any road, 3 = water

p10 always equals 3.0
p11 always equals 0

Reference

Namespace
Pathfinding PATHFIND
In the game
BOOL GET_NTH_CLOSEST_VEHICLE_NODE_FAVOUR_DIRECTION(float x, float y, float z, float desiredX, float desiredY, float desiredZ, int nthClosest, Vector3* outPosition, float* outHeading, int nodeFlags, float p10, float p11)
Hash
0x45905BE8654AE067

Open in the interactive natives reference