PathfindingClient1 output

getPosAlongGpsTypeRoute

GET_POS_ALONG_GPS_TYPE_ROUTE0xF3162836C28F9DA5

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

SignatureJavaScript
getPosAlongGpsTypeRoute(p1: boolean, p2: number, p3: number): [
  ok: boolean,
  result: { x: number, y: number, z: number }
]
SignatureLua
getPosAlongGpsTypeRoute(
  p1: boolean,
  p2: number,
  p3: integer
): boolean, Vector3

Usage

JavaScript
const [ok, result] = getPosAlongGpsTypeRoute(p1, p2, p3);
Lua
local ok, result = getPosAlongGpsTypeRoute(p1, p2, p3)

Parameters

ParameterTypeJavaScriptLua
p1BOOLbooleanboolean
p2floatnumbernumber
p3intnumberinteger

Returns

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

#ValueTypeJavaScriptLuaDescription
1okBOOLbooleanbooleanThe native’s own return value.
2resultVector3{ x: number, y: number, z: number }Vector3output

Notes

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

p3 can be 0, 1 or 2.

Reference

Namespace
Pathfinding PATHFIND
In the game
BOOL GET_POS_ALONG_GPS_TYPE_ROUTE(Vector3* result, BOOL p1, float p2, int p3)
Hash
0xF3162836C28F9DA5
Introduced
Game build 505 legacy numbering
Formerly
GET_GPS_WAYPOINT_ROUTE_END

Open in the interactive natives reference