Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:08Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Map}}
Converts a position inside a map window into map coordinates (the coordinates of the place shown at that point).

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

== Arguments ==
;mapDisplayName : <code>string</code> – Name of a MapDisplay window set up with [[API:CreateMapInstance|CreateMapInstance]].
;pointX, pointY : <code>number</code> – Position inside the window, relative to its top-left corner, in unscaled interface units.

== Returns ==
;x, y : <code>number</code> – Coordinates of that point on the map shown in the window. Nothing is returned if either coordinate would be 0 or less, for example when the point is outside the map.

== Details ==
* This is the reverse of [[API:MapGetPointForCoordinates|MapGetPointForCoordinates]].
* 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 stock world map divides the mouse offset by <code>InterfaceCore.GetResolutionScale()</code> before calling it, and shows <code>-</code> when nothing is returned.
* 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 'MapGetCoordinatesForPoint': Display Window %s does not exist</code>
* <code>Error in function call 'MapGetCoordinatesForPoint': Display Window %s is not a MapDisplay</code>

== Example ==
From <code>default/ea_worldmapwindow/source/zoneview.lua</code>:
<pre>
function EA_Window_WorldMap.UpdateCoordinates()
local mapPositionX, mapPositionY = WindowGetScreenPosition("EA_Window_WorldMapZoneViewMapDisplay")
local resolutionScale = InterfaceCore.GetResolutionScale()
local x, y = MapGetCoordinatesForPoint("EA_Window_WorldMapZoneViewMapDisplay",
(SystemData.MousePosition.x - mapPositionX) / resolutionScale,
(SystemData.MousePosition.y - mapPositionY) / resolutionScale)

if (x == nil) then
x = L"-"
end
...
</pre>

== See also ==
* [[API:MapGetPointForCoordinates|MapGetPointForCoordinates]]
* [[API:CreateMapInstance|CreateMapInstance]]
* [[API:MapSetMapView|MapSetMapView]]

API:MapGetCoordinatesForPoint - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)