Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:11Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Map}}
Converts map coordinates into a position inside a map window, for placing markers on the map.

<pre>
pointX, pointY = MapGetPointForCoordinates(mapDisplayName, x, y)
</pre>

== Arguments ==
;mapDisplayName : <code>string</code> – Name of a MapDisplay window set up with [[API:CreateMapInstance|CreateMapInstance]].
;x, y : <code>number</code> – Coordinates on the map shown in the window, for example the <code>x</code>/<code>y</code> fields from [[API:GetMapTextPoints|GetMapTextPoints]] or objective positions.

== Returns ==
;pointX, pointY : <code>number</code> – Position inside the window, relative to its top-left corner. Nothing is returned if either value would be 0 or less.

== Details ==
* This is the reverse of [[API:MapGetCoordinatesForPoint|MapGetCoordinatesForPoint]].
* The stock UI passes the result straight to <code>WindowAddAnchor</code> with a <code>"topleft"</code> anchor on the map window.
* If the window does not exist or is not a MapDisplay, an error is logged, and the conversion is still attempted with the given name. With an empty name, the window check is skipped.
* If the client's map data is not loaded, the function returns nothing.
* The function needs at least three arguments and only reads the last three.

== Errors ==
These are written to the UI log; the call continues.
* <code>Error in function call 'MapGetPointForCoordinates': Display Window %s does not exist</code>
* <code>Error in function call 'MapGetPointForCoordinates': Display Window %s is not a MapDisplay</code>

== Example ==
From <code>default/ea_rvrtracker/source/rvrtracker.lua</code>:
<pre>
local x, y = MapGetPointForCoordinates(mapDisplay, objectivePoint.objPositionX, objectivePoint.objPositionY)

CreateWindowFromTemplate(objectiveTimerWindow, "ObjectiveRvRTrackerTimer", mapDisplay)
WindowAddAnchor(objectiveTimerWindow, "topleft", mapDisplay, "topleft", x, y)
</pre>

== See also ==
* [[API:MapGetCoordinatesForPoint|MapGetCoordinatesForPoint]]
* [[API:GetMapTextPoints|GetMapTextPoints]]
* [[API:CreateMapInstance|CreateMapInstance]]

API:MapGetPointForCoordinates - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)