For Addon Authors

The public API for companion addons.

Building something on top of AzerothGPS? It publishes a global table, AzerothGPS, for companion addons like AzerothGPS-StreetView:

• Geometry: the player's world position and facing, and the map's view.
• Roads: the nearest road and the road network's data.
• Drawing: overlays on the map (with icons), and showing the road network when you ask.
• Taking over the map: holding it for a game or tool of your own (in a map style of your choosing), and pointing it at a spot.
• Popups: windows in AzerothGPS's own style, so yours match.
• Your options: pages of your own in AzerothGPS's options window (checkboxes, sliders, choices, dropdowns), and its Save Now button for your data.
• Looks: the player's arrow, the route's color and the window frame's tint.
• The title bar: a place for a widget of yours on the map window's title bar.
• An import inbox: a tool on the player's PC can leave map data (herbs, ore, NPCs, pins, roads, walls) for AzerothGPS to offer the player at login.

Every function, its arguments and what it returns are in the repository: docs/api.md. Check AzerothGPS.version before you use a newer one.