https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetKeepDataAPI:GetKeepData - Revision history2026-10-17T16:13:09ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetKeepData&diff=30419&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:44:18Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=RvR}}<br />
Returns the status of a keep: owner, attack and defense status, and (for the player's own realm) its siege weapon and skaven counts.<br />
<br />
<pre><br />
keepData = GetKeepData(keepId)<br />
</pre><br />
<br />
== Arguments ==<br />
;keepId : <code>number</code> – Keep id, for example the <code>id</code> of a keep map point.<br />
<br />
== Returns ==<br />
;keepData : <code>table</code> – Keep table (see below), or nothing if the id is not valid.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>attackStatus</code> || <code>number</code> || –<br />
|-<br />
| <code>defenseStatus</code> || <code>number</code> || –<br />
|-<br />
| <code>realmOwner</code> || <code>number</code> || Realm that owns the keep.<br />
|-<br />
| <code>siege</code> || <code>table</code> || Only when <code>realmOwner</code> is the player's realm. Array of 4 entries, each with <code>current</code> (<code>number</code>) and <code>max</code> (<code>number</code>).<br />
|-<br />
| <code>skaven</code> || <code>table</code> || Only when <code>realmOwner</code> is the player's realm. Array of 5 entries, each with <code>current</code> (<code>number</code>) and <code>max</code> (<code>number</code>).<br />
|}<br />
<br />
== Details ==<br />
* The <code>siege</code> and <code>skaven</code> tables are left out for keeps owned by the other realm. The stock tooltip tests for them before reading.<br />
* The stock map tooltip builds one line per <code>siege</code> entry with string ids named <code>TOOLTIP_SIEGE_PAIR_<pairing>_REALM_<realm>_TYPE_<index></code>.<br />
* The error message names the function <code>GameData.GetKeepData</code>, although it is registered as the global <code>GetKeepData</code>.<br />
* A new table is built on every call.<br />
* The function takes exactly one argument.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'GameData.GetKeepData': Keep Id %d is not valid.</code><br />
<br />
== Example ==<br />
From <code>default/easystem_tooltips/source/maptooltips.lua</code> (shortened):<br />
<pre><br />
local keepData = nil<br />
if( ptData.pointType == SystemData.MapPips.KEEP )<br />
then<br />
keepData = GetKeepData( ptData.id )<br />
end<br />
...<br />
if ( keepData.siege )<br />
then<br />
for index, siegeInfo in ipairs( keepData.siege )<br />
do<br />
local stringId = StringTables.MapSystem["TOOLTIP_SIEGE_PAIR_"..pairing.."_REALM_"..keepData.realmOwner.."_TYPE_"..index]<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetFortressStatuses|GetFortressStatuses]]<br />
* [[API:GetMapPointData|GetMapPointData]]<br />
* [[API:PurchaseKeepUpgrade|PurchaseKeepUpgrade]]</div>Maintenance script