HUDClient

startGpsCustomRoute

START_GPS_CUSTOM_ROUTE0xDB34E8D56FC13B08

The GTA V native START_GPS_CUSTOM_ROUTE of the HUD namespace, as LS:MP client scripts call it: the global function startGpsCustomRoute, in JavaScript and in Lua.

SignatureJavaScript
startGpsCustomRoute(
  hudColor: number,
  displayOnFoot: boolean,
  followPlayer: boolean
): void
SignatureLua
startGpsCustomRoute(
  hudColor: integer,
  displayOnFoot: boolean,
  followPlayer: boolean
)

Usage

JavaScript
startGpsCustomRoute(hudColor, displayOnFoot, followPlayer);
Lua
startGpsCustomRoute(hudColor, displayOnFoot, followPlayer)

Parameters

ParameterTypeJavaScriptLua
hudColorintnumberinteger
displayOnFootBOOLbooleanboolean
followPlayerBOOLbooleanboolean

Returns

Nothing. In JavaScript the call evaluates to undefined.

Notes

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

Starts a new GPS custom-route, allowing you to plot lines on the map.
Lines are drawn directly between points.
The GPS custom route works like the GPS multi route, except it does not follow roads.
hudColor: The HUD color of the GPS path.
displayOnFoot: Draws the path regardless if the player is in a vehicle or not.
followPlayer: Draw the path partially between the previous and next point based on the players position between them. When false, the GPS appears to not disappear after the last leg is completed.

Reference

Namespace
HUD HUD
In the game
void START_GPS_CUSTOM_ROUTE(int hudColor, BOOL displayOnFoot, BOOL followPlayer)
Hash
0xDB34E8D56FC13B08

Open in the interactive natives reference