https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetMapPointDataAPI:GetMapPointData - Revision history2026-10-18T04:52:37ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetMapPointData&diff=30428&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:44:26Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Game}}<br />
Returns information about one point (pin) shown on a map display window.<br />
<br />
<pre><br />
pointData = GetMapPointData(mapDisplayName, pointIndex)<br />
</pre><br />
<br />
== Arguments ==<br />
;mapDisplayName : <code>string</code> – Name of the map display window.<br />
;pointIndex : <code>number</code> – Index of the point on that map, as supplied by the map's point events.<br />
<br />
== Returns ==<br />
;pointData : <code>table</code> – Data about the point, or nothing if the point is not found.<br />
<br />
Fields set for every point:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>pointType</code> || <code>number</code> || Type of the point, compared with <code>SystemData.MapPips</code> values.<br />
|-<br />
| <code>id</code> || <code>number</code> || Id of the thing the point stands for (for a quest point, the quest id).<br />
|-<br />
| <code>mapIcon</code> || <code>number</code> || Map icon id for [[API:GetMapIconData|GetMapIconData]].<br />
|}<br />
<br />
Further fields depend on the point type. Static points add <code>zone</code> (<code>number</code>) and <code>distance</code> (<code>number</code>, distance from the player rounded down to a whole number). The stock tooltip code also reads fields such as <code>name</code>, <code>text</code>, <code>realm</code>, <code>services</code>, <code>rewards</code>, <code>difficulty</code> and <code>glyphsRequired</code> for particular point types.<br />
<br />
== Details ==<br />
* <code>pointIndex</code> is converted to an integer.<br />
* If the map data is not loaded, or no point with that index exists on that map, the function returns nothing. The stock UI checks the result for <code>nil</code>.<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>easystem_tooltips/source/maptooltips.lua</code>:<br />
<pre><br />
for _, ptIndex in ipairs( points ) do<br />
local ptData = GetMapPointData( mapDisplay, ptIndex )<br />
if (ptData ~= nil) then<br />
ptData.pointIndex = ptIndex<br />
<br />
local sortIndex = MapPointSortOrder[ptData.pointType]<br />
</pre><br />
<br />
From <code>easystem_utils/source/maputils.lua</code>:<br />
<pre><br />
local pointData = GetMapPointData( mapDisplay, ptIndex )<br />
<br />
if( pointData.pointType == SystemData.MapPips.QUEST_AREA) then<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetQuestPointConditions|GetQuestPointConditions]]<br />
* [[API:GetMapIconData|GetMapIconData]]</div>Maintenance script