PathfindingClient1 output

getRoadBoundaryUsingHeading

GET_ROAD_BOUNDARY_USING_HEADING0xA0F8A7517A273C05

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

SignatureJavaScript
getRoadBoundaryUsingHeading(
  x: number,
  y: number,
  z: number,
  heading: number
): [ok: boolean, outPosition: { x: number, y: number, z: number }]
SignatureLua
getRoadBoundaryUsingHeading(
  x: number,
  y: number,
  z: number,
  heading: number
): boolean, Vector3

Usage

JavaScript
const [ok, outPosition] = getRoadBoundaryUsingHeading(x, y, z, heading);
Lua
local ok, outPosition = getRoadBoundaryUsingHeading(x, y, z, heading)

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] = getRoadBoundaryUsingHeading(pos, heading);
Lua · with vectors
local ok, outPosition = getRoadBoundaryUsingHeading(pos, heading)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
headingfloatnumbernumber

Returns

2 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

Reference

Namespace
Pathfinding PATHFIND
In the game
BOOL GET_ROAD_BOUNDARY_USING_HEADING(float x, float y, float z, float heading, Vector3* outPosition)
Hash
0xA0F8A7517A273C05
Introduced
Game build 463 legacy numbering
Formerly
_GET_ROAD_SIDE_POINT_WITH_HEADING

Open in the interactive natives reference