StartGpsCustomRoute - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: HUDAPI set: clientGame: gta5editImprove

START_GPS_CUSTOM_ROUTE

0xDB34E8D56FC13B08

0x7F93799B

// StartGpsCustomRoute
void START_GPS_CUSTOM_ROUTE(int hudColor, BOOL displayOnFoot, BOOL followPlayer);

Parameters:

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.

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.

Example result:

Examples:

Lua

-- Clear any old route first
ClearGpsCustomRoute()

-- Start a new route
StartGpsCustomRoute(6, false, true)

-- Add the points
AddPointToGpsCustomRoute(1638.2155761719, -2344.685546875, 95.610511779785)
AddPointToGpsCustomRoute(1653.0858154297, -2068.8654785156, 96.737915039063)
AddPointToGpsCustomRoute(1451.9561767578, -2113.5344238281, 56.082130432129)
AddPointToGpsCustomRoute(1540.6088867188, -2514.4519042969, 58.842422485352)
AddPointToGpsCustomRoute(1638.2155761719, -2344.685546875, 95.610511779785)

-- Set the route to render
SetGpsCustomRouteRender(true, 16, 16)

SET_TEXT_WRAP(float start, float end)

SET_USE_ISLAND_MAP(BOOL toggle)

_SET_USE_WAYPOINT_AS_DESTINATION(BOOL toggle)

SET_WARNING_MESSAGE(char* entryLine1, int instructionalKey, char* entryLine2, BOOL p3, int p4, char* background, char* p6, BOOL showBg, int errorCode)

_SET_WARNING_MESSAGE_LIST_ROW(int index, char* name, int cash, int rp, int lvl, int colour)

_SET_WARNING_MESSAGE_WITH_ALERT(char* labelTitle, char* labelMsg, int p2, int p3, char* labelMsg2, BOOL p5, int p6, int p7, char* p8, char* p9, BOOL background, int errorCode)

SET_WARNING_MESSAGE_WITH_HEADER(char* titleMsg, char* entryLine1, int flags, char* promptMsg, BOOL p4, Any p5, BOOL background, Any* p7, BOOL showBg)

SET_WARNING_MESSAGE_WITH_HEADER_AND_SUBSTRING_FLAGS(char* entryHeader, char* entryLine1, Any instructionalKey, char* entryLine2, BOOL p4, Any p5, Any p6, Any* p7, Any* p8, BOOL p9)

SET_WARNING_MESSAGE_WITH_HEADER_EXTENDED(char* headerTextLabel, char* line1TextLabel, int buttonsBitField, int buttonsBitFieldUpper, char* line2TextLabel, BOOL addNumber, int numberToAdd, char* firstSubstring, char* secondSubstring, BOOL showBackground, int errorCode)

SET_WAYPOINT_OFF

SET_WIDESCREEN_FORMAT(Any p0)

SHOW_CONTACT_INSTRUCTIONAL_BUTTON(BOOL toggle)

SHOW_CREW_INDICATOR_ON_BLIP(Blip blip, BOOL toggle)

SHOW_FRIEND_INDICATOR_ON_BLIP(Blip blip, BOOL toggle)

_SHOW_HAS_COMPLETED_INDICATOR_ON_BLIP(Blip blip, BOOL toggle)

SHOW_HEADING_INDICATOR_ON_BLIP(Blip blip, BOOL toggle)

SHOW_HEIGHT_ON_BLIP(Blip blip, BOOL toggle)

SHOW_HUD_COMPONENT_THIS_FRAME(int id)

SHOW_NUMBER_ON_BLIP(Blip blip, int number)

SHOW_OUTLINE_INDICATOR_ON_BLIP(Blip blip, BOOL toggle)

_SHOW_SCRIPTED_HUD_COMPONENT_THIS_FRAME(int id)

_SHOW_SIGNIN_UI

SHOW_START_MISSION_INSTRUCTIONAL_BUTTON(BOOL p0)

SHOW_TICK_ON_BLIP(Blip blip, BOOL toggle)

START_GPS_CUSTOM_ROUTE(int hudColor, BOOL displayOnFoot, BOOL followPlayer)

START_GPS_MULTI_ROUTE(int hudColor, BOOL routeFromPlayer, BOOL displayOnFoot)

SUPPRESS_FRONTEND_RENDERING_THIS_FRAME

TAKE_CONTROL_OF_FRONTEND

THEFEED_CLEAR_FROZEN_POST

THEFEED_COMMENT_TELEPORT_POOL_OFF

THEFEED_COMMENT_TELEPORT_POOL_ON

_THEFEED_DISABLE_LOADING_SCREEN_TIPS

_THEFEED_DISPLAY_LOADING_SCREEN_TIPS

THEFEED_FLUSH_QUEUE

THEFEED_FORCE_RENDER_OFF