PathfindingClient2 outputs

getVehicleNodeProperties

GET_VEHICLE_NODE_PROPERTIES0x0568566ACBB5DEDC

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

SignatureJavaScript
getVehicleNodeProperties(x: number, y: number, z: number): [
  ok: boolean,
  density: number,
  flags: number
]
SignatureLua
getVehicleNodeProperties(
  x: number,
  y: number,
  z: number
): boolean, integer, integer

Usage

JavaScript
const [ok, density, flags] = getVehicleNodeProperties(x, y, z);
Lua
local ok, density, flags = getVehicleNodeProperties(x, y, z)

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, density, flags] = getVehicleNodeProperties(pos);
Lua · with vectors
local ok, density, flags = getVehicleNodeProperties(pos)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber

Returns

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

#ValueTypeJavaScriptLuaDescription
1okBOOLbooleanbooleanThe native’s own return value.
2densityintnumberintegeroutput
3flagsintnumberintegeroutput

Notes

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

Gets the density and flags of the closest node to the specified position.
Density is a value between 0 and 15, indicating how busy the road is.
Flags is a bit field.

Reference

Namespace
Pathfinding PATHFIND
In the game
BOOL GET_VEHICLE_NODE_PROPERTIES(float x, float y, float z, int* density, int* flags)
Hash
0x0568566ACBB5DEDC

Open in the interactive natives reference