worldmap

Returns the world map: whether it is open (up), where the party is (at, an area tag), and its pins. Each pin has an index, name, tag, the area it leads to, and a state: active, not active, greyed, unlockable, completed or destroyed. Only active pins can be traveled to.

To go to a pin, call travel with to (the pin’s name, tag or index), either with the map open or together with the area’s world map exit, which opens it. If the map has never been opened this game, there may be no pins yet.

In a city, the open map may be the city’s own: shown names the map on screen and other the one its toggle button switches to. To switch, call input with {“message”: “WorldMap.WorldMapSwapMaps”}; travel with to switches by itself when the pin is on the other map. To close the map, call input with {“message”: “GUI.HideFullScreenGUI”}, as its Close button does. (WorldMap.WorldMapClosed only reports that the map closed; it does not close it.)

With all: true, it returns every map’s pins instead, cities included, from the game’s map files (maps: each map’s tag, file and pins with name, tag and area). This works from anywhere and tells you which map a pin is on, but shows each pin’s starting state, not its current one.

Read-only: it changes nothing in the game.

Arguments

Name	Type	Required	What
all	boolean		Return every map’s pins, cities included, from the game’s files (starting states) instead of the open map. Default false.

Call it as worldmap over MCP, or POST /api/tool/worldmap with the arguments as JSON.