https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetMapTextPointsAPI:GetMapTextPoints - Revision history2026-10-19T18:02:16ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetMapTextPoints&diff=30429&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:44:27Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Map}}<br />
Returns the text labels (place names) to draw on the map currently shown in a map window.<br />
<br />
<pre><br />
points = GetMapTextPoints(mapDisplayName)<br />
</pre><br />
<br />
== Arguments ==<br />
;mapDisplayName : <code>string</code> – Name of a MapDisplay window set up with [[API:CreateMapInstance|CreateMapInstance]].<br />
<br />
== Returns ==<br />
;points : <code>table</code> – Array of text points, indexed from 1. Nothing is returned if the window is not a known map window or its map has no text data.<br />
<br />
Each entry:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Id of the label text. The stock UI looks it up with <code>GetStringFromTable("MapTextPoints", id)</code>.<br />
|-<br />
| <code>font</code> || <code>string</code> || Font name; the stock UI passes it to <code>LabelSetFont</code>.<br />
|-<br />
| <code>red</code>, <code>green</code>, <code>blue</code> || <code>number</code> || Text colour.<br />
|-<br />
| <code>align</code> || <code>string</code> || Alignment. The stock UI checks for <code>"center"</code> and <code>"right"</code> and treats anything else as left.<br />
|-<br />
| <code>x</code>, <code>y</code> || <code>number</code> || Map coordinates of the label. Convert them with [[API:MapGetPointForCoordinates|MapGetPointForCoordinates]].<br />
|}<br />
<br />
== Details ==<br />
* The data comes from the client's map data for the map the window is showing.<br />
* If the client's map data is not loaded, the function returns nothing.<br />
* Exactly one argument must be passed.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a string.<br />
<br />
== Example ==<br />
From <code>default/ea_worldmapwindow/source/zoneview.lua</code>:<br />
<pre><br />
local mapDisplay = "EA_Window_WorldMapZoneViewMapDisplay"<br />
local textPointData = GetMapTextPoints( mapDisplay )<br />
<br />
for pointIndex, textPoint in ipairs(textPointData)<br />
do<br />
local textPointWindow = "TextPoint_"..currentZoneId.."_"..pointIndex<br />
local x, y = MapGetPointForCoordinates(mapDisplay, textPoint.x, textPoint.y)<br />
...<br />
CreateWindowFromTemplate(textPointWindow, "MapTextPoint", mapDisplay)<br />
WindowAddAnchor(textPointWindow, "topleft", mapDisplay, relPoint, x, y)<br />
LabelSetFont(textPointWindow, textPoint.font, WindowUtils.FONT_DEFAULT_TEXT_LINESPACING)<br />
LabelSetTextColor(textPointWindow, textPoint.red, textPoint.green, textPoint.blue)<br />
LabelSetTextAlign(textPointWindow, align)<br />
LabelSetText(textPointWindow, GetStringFromTable("MapTextPoints", textPoint.id))<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:MapGetPointForCoordinates|MapGetPointForCoordinates]]<br />
* [[API:GetZoneTransitionPoints|GetZoneTransitionPoints]]<br />
* [[API:CreateMapInstance|CreateMapInstance]]</div>Maintenance script