WorldMap
constWorldMap:object
Defined in: client/api.d.ts:755
Client controls for the in-game world map and its GPS waypoint.
Type Declaration
Section titled “Type Declaration”clearWaypoint()
Section titled “clearWaypoint()”clearWaypoint():
void
Removes the active GPS waypoint and its route.
Returns
Section titled “Returns”void
close()
Section titled “close()”close():
boolean
Closes the in-game world map.
Returns
Section titled “Returns”boolean
True when the close request succeeded.
isOpen()
Section titled “isOpen()”isOpen():
boolean
Checks whether the in-game world map is currently open.
Returns
Section titled “Returns”boolean
True while the map screen is active.
open()
Section titled “open()”open():
boolean
Opens the in-game world map.
Returns
Section titled “Returns”boolean
True when the map was opened successfully.
setWaypoint()
Section titled “setWaypoint()”setWaypoint(
x,y):void
Sets or replaces the local GPS waypoint and computes its route. Routing uses the map’s two-dimensional road graph, so there is no Z coordinate. Placing one this way does not raise a manual placement to the server.
Parameters
Section titled “Parameters”number
World-space X coordinate of the destination.
number
World-space Y coordinate of the destination.
Returns
Section titled “Returns”void