Classes

WorldMap

Properties

markers

markers: readonly WorldMapMarker[];

Gets list of World Map markers.

Note: this list is readonly, use addMarker or removeMarker to manage the World Map markers.

Methods

addMarker()

addMarker(marker: WorldMapMarker | WorldMapMarkerPartial): WorldMapMarker

Adds a marker to the World Map.

Parameters

Parameter	Type	Description
marker	WorldMapMarker | WorldMapMarkerPartial

Returns

WorldMapMarker

Example

const marker = worldMap.addMarker({ name: 'Here', x: player.x, y: player.y, color: 'green' });

---

close()

close(): void

Closes the World Map gump.

Example

worldMap.close();

---

goTo()

goTo(coords: object): void

Changes the current location of the World Map, which also enables Free View.

Parameters

Parameter	Type	Description
coords	object
coords.x	number	-
coords.y	number	-

Example

worldMap.goTo({ x: player.x, y: player.y });

---

open()

open(): void

Opens the World Map gump.

Example

worldMap.open();

---

parseLocation()

parseLocation(input: string): undefined | object

Attempts to parse a location string and convert into map coordinates.

Note: Currently only supports Sextant coordinates, e.g. 100o25'S,40o04'E

Parameters

Parameter	Type	Description
input	string

Returns

undefined | object

Example

const marker = worldMap.addMarker({
  name: 'Sextant Loc',
  color: 'green',
  ...worldMap.parseLocation("100o25'S,40o04'E")
});

---

removeAllMarkers()

removeAllMarkers(): void

Removes all World Map markers.

---

removeMarker()

removeMarker(marker: string | object): boolean

Remove a marker from the World Map.

Parameters

Parameter	Type	Description
marker	string | object

Returns

boolean

Example

worldMap.removeMarker('Here');

Interfaces

WorldMapMarker

Properties

color

color: string;

Color of the marker, e.g. "blue"

---

mapId

mapId: number;

Map Index/Id to place the marker on

---

name

name: string;

Name of the marker

---

x

x: number;

X coordinate

---

y

y: number;

Y coordinate

---

zoomLevel

zoomLevel: number;

ZoomLevel at which the marker appears

---

WorldMapMarkerPartial

Properties

color?

optional color: string;

---

mapId?

optional mapId: number;

---

name

name: string;

---

x

x: number;

---

y

y: number;

---

zoomLevel?

optional zoomLevel: number;