Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ClassicUO/classicuo-web/llms.txt
Use this file to discover all available pages before exploring further.
The WorldMap class controls the in-game World Map gump and its custom marker layer. It is available globally as worldMap. Use it to open or close the map, jump the view to any coordinate, and manage named map markers that persist across your session.
// Mark your current position on the map and open it
worldMap.open();
worldMap.addMarker({ name: 'Start', x: player.x, y: player.y, color: 'green' });
worldMap.goTo({ x: player.x, y: player.y });
Interfaces
WorldMapMarker
A fully-populated marker object as stored in the markers list.
| Property | Type | Description |
|---|
name | string | Display name of the marker. |
x | number | X coordinate on the map. |
y | number | Y coordinate on the map. |
color | string | Marker colour, e.g. 'blue', 'red', 'green'. |
mapId | number | Map/facet index the marker belongs to. |
zoomLevel | number | Minimum zoom level at which the marker is visible. |
WorldMapMarkerPartial
A partial version used when adding new markers. Only name, x, and y are required — the rest use defaults.
| Property | Type | Required |
|---|
name | string | ✅ |
x | number | ✅ |
y | number | ✅ |
color | string | Optional |
mapId | number | Optional |
zoomLevel | number | Optional |
Properties
markers
readonly markers: WorldMapMarker[];
addMarker() and removeMarker() rather than mutating this array directly.
console.log(`You have ${worldMap.markers.length} map markers.`);
Methods
open()
Opens the World Map gump.
close()
Closes the World Map gump.
goTo()
goTo(coords: { x: number; y: number }): void
An object with x and y coordinates.
worldMap.goTo({ x: player.x, y: player.y });
addMarker()
addMarker(marker: WorldMapMarker | WorldMapMarkerPartial): WorldMapMarker
WorldMapMarker object (with defaults applied for any omitted fields).
marker
WorldMapMarker | WorldMapMarkerPartial
required
The marker definition to add. Must include at least name, x, and y.
const marker = worldMap.addMarker({
name: 'Here',
x: player.x,
y: player.y,
color: 'green'
});
removeMarker()
removeMarker(marker: string | object): boolean
true if the marker was found and removed.
The marker name or marker object to remove.
worldMap.removeMarker('Here');
removeAllMarkers()
Removes every marker from the World Map.
worldMap.removeAllMarkers();
parseLocation()
parseLocation(input: string): undefined | object
undefined if the string cannot be parsed.
A location string to parse. Currently supports sextant format, e.g. 100o25'S,40o04'E.
const marker = worldMap.addMarker({
name: 'Sextant Loc',
color: 'green',
...worldMap.parseLocation("100o25'S,40o04'E")
});
parseLocation currently only supports sextant coordinate strings in the format DDDoMM'N/S,DDDoMM'E/W.
Examples
Track a farming route
worldMap.removeAllMarkers();
const stops = [
{ name: 'Stop 1', x: 1234, y: 2345 },
{ name: 'Stop 2', x: 1240, y: 2350 },
{ name: 'Stop 3', x: 1250, y: 2360 },
];
for (const stop of stops) {
worldMap.addMarker({ ...stop, color: 'blue' });
}
worldMap.open();
worldMap.goTo(stops[0]);
Mark a sextant location from chat
const sextantStr = "135o25'N,32o04'W";
const coords = worldMap.parseLocation(sextantStr);
if (coords) {
worldMap.addMarker({ name: 'Sextant Mark', color: 'red', ...coords });
worldMap.goTo(coords);
} else {
client.sysMsg('Could not parse sextant location.');
}
Clean up markers on script exit
// Add a temporary marker
const tempMarker = worldMap.addMarker({
name: 'Temp',
x: player.x,
y: player.y,
color: 'yellow'
});
// ... do some work ...
// Remove just this one marker when done
worldMap.removeMarker(tempMarker);
