HUDClient

startGpsMultiRoute

START_GPS_MULTI_ROUTE0x3D3D15AF7BCAAF83

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

SignatureJavaScript
startGpsMultiRoute(
  hudColor: number,
  routeFromPlayer: boolean,
  displayOnFoot: boolean
): void
SignatureLua
startGpsMultiRoute(
  hudColor: integer,
  routeFromPlayer: boolean,
  displayOnFoot: boolean
)

Usage

JavaScript
startGpsMultiRoute(hudColor, routeFromPlayer, displayOnFoot);
Lua
startGpsMultiRoute(hudColor, routeFromPlayer, displayOnFoot)

Parameters

ParameterTypeJavaScriptLua
hudColorintnumberinteger
routeFromPlayerBOOLbooleanboolean
displayOnFootBOOLbooleanboolean

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 multi-route, allowing you to create custom GPS paths.
GPS functions like the waypoint, except it can contain multiple points it's forced to go through.
Once the player has passed a point, the GPS will no longer force its path through it.

Works independently from the player-placed waypoint and blip routes.
hudColor: The HUD color of the GPS path.
routeFromPlayer: Makes the GPS draw a path from the player to the next point, rather than the original path from the previous point.
displayOnFoot: Draws the GPS path regardless if the player is in a vehicle or not.

Reference

Namespace
HUD HUD
In the game
void START_GPS_MULTI_ROUTE(int hudColor, BOOL routeFromPlayer, BOOL displayOnFoot)
Hash
0x3D3D15AF7BCAAF83

Open in the interactive natives reference