getClosestVehicleNodeWithHeading
GET_CLOSEST_VEHICLE_NODE_WITH_HEADING0xFF071FB798B803B0The GTA V native GET_CLOSEST_VEHICLE_NODE_WITH_HEADING of the PATHFIND namespace, as LS:MP client scripts call it: the global function getClosestVehicleNodeWithHeading, in JavaScript and in Lua.
getClosestVehicleNodeWithHeading(
x: number,
y: number,
z: number,
nodeType: number,
p6: number,
p7: number
): [
ok: boolean,
outPosition: { x: number, y: number, z: number },
outHeading: number
]getClosestVehicleNodeWithHeading(
x: number,
y: number,
z: number,
nodeType: integer,
p6: number,
p7: number
): boolean, Vector3, numberUsage
const [ok, outPosition, outHeading] = getClosestVehicleNodeWithHeading(
x, y, z, nodeType, p6, p7
);local ok, outPosition, outHeading = getClosestVehicleNodeWithHeading(x, y, z, nodeType, p6, p7)Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.
const [ok, outPosition, outHeading] = getClosestVehicleNodeWithHeading(pos, nodeType, p6, p7);local ok, outPosition, outHeading = getClosestVehicleNodeWithHeading(pos, nodeType, p6, p7)Parameters
| Parameter | Type | JavaScript | Lua |
|---|---|---|---|
x | float | number | number |
y | float | number | number |
z | float | number | number |
nodeType | int | number | integer |
p6 | float | number | number |
p7 | float | number | number |
Returns
3 values, in this order: an array in JavaScript, multiple return values in Lua.
| # | Value | Type | JavaScript | Lua | Description |
|---|---|---|---|---|---|
| 1 | ok | BOOL | boolean | boolean | The native’s own return value. |
| 2 | outPosition | Vector3 | { x: number, y: number, z: number } | Vector3 | output |
| 3 | outHeading | float | number | number | output |
Notes
From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.
p5, p6 and p7 seems to be about the same as p4, p5 and p6 for getClosestVehicleNode. p6 and/or p7 has something to do with finding a node on the same path/road and same direction(at least for this native, something to do with the heading maybe). Edit this when you find out more.
nodeType: 0 = main roads, 1 = any dry path, 3 = water
p6 is always 3.0
p7 is always 0
https://gtaforums.com/topic/843561-pathfind-node-types
Example of usage, moving vehicle to closest path/road:
Vector3 coords = getEntityCoords(playerVeh, true);
Vector3 closestVehicleNodeCoords;
float roadHeading;
getClosestVehicleNodeWithHeading(coords.x, coords.y, coords.z, &closestVehicleNodeCoords, &roadHeading, 1, 3, 0);
setEntityHeading(playerVeh, roadHeading);
setEntityCoords(playerVeh, closestVehicleNodeCoords.x, closestVehicleNodeCoords.y, closestVehicleNodeCoords.z, 1, 0, 0, 1);
setVehicleOnGroundProperly(playerVeh);C# Example (ins1de) : https://pastebin.com/fxtMWAHD
Reference
- Namespace
- Pathfinding PATHFIND
- In the game
BOOL GET_CLOSEST_VEHICLE_NODE_WITH_HEADING(float x, float y, float z, Vector3* outPosition, float* outHeading, int nodeType, float p6, float p7)- Hash
0xFF071FB798B803B0