Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:28Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Map}}
Returns the zone exits of the map currently shown in a map window.

<pre>
points = GetZoneTransitionPoints(mapDisplayName)
</pre>

== Arguments ==
;mapDisplayName : <code>string</code> – Name of a MapDisplay window set up with [[API:CreateMapInstance|CreateMapInstance]].

== Returns ==
;points : <code>table</code> – Array of transition points, indexed from 1. Nothing is returned if the window is not a known map window or its map has no transition data.

Each entry:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>x</code> || <code>number</code> || Horizontal position on the map. The stock UI treats it as a value from 0 (west edge) to 65535 (east edge).
|-
| <code>y</code> || <code>number</code> || Vertical position on the map, from 0 (north edge) to 65535 (south edge) in the stock UI.
|-
| <code>zone</code> || <code>number</code> || Id of the zone the exit leads to.
|}

== Details ==
* The data comes from the client's map data for the map the window is showing.
* If the client's map data is not loaded, the function returns nothing.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a string.

== Example ==
From <code>default/ea_worldmapwindow/source/zoneview.lua</code>:
<pre>
local mapDisplay = "EA_Window_WorldMapZoneViewMapDisplay"
local transitionPointData = GetZoneTransitionPoints( mapDisplay )
local mapDisplayWidth, mapDisplayHeight = WindowGetDimensions( mapDisplay )

for pointIndex, transitionPoint in ipairs(transitionPointData)
do
...
if (transitionPoint.x == 0) then
templateName = "ZoneTransitionPointWest"
anchorPoint = "topleft"
anchorX = -12
anchorY = (transitionPoint.y / 65535) * mapDisplayHeight
...
WindowSetId(transPointWindow, transitionPoint.zone)
end
</pre>

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

API:GetZoneTransitionPoints - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)