https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetCampaignCityData 2026-10-17T04:19:12Z Revision history for this page on the wiki MediaWiki 1.43.11 https://wiki.returnofreckoning.com/index.php?title=API:GetCampaignCityData&diff=30353&oldid=prev 2026-10-16T19:43:13Z

<p>UI Lua API import (WAR 1.4.8)</p> <p><b>New page</b></p><div>{{LuaApi|group=RvR}}<br /> Returns the RvR campaign state of a capital city.<br /> <br /> &lt;pre&gt;<br /> cityData = GetCampaignCityData(cityId)<br /> &lt;/pre&gt;<br /> <br /> == Arguments ==<br /> ;cityId : &lt;code&gt;number&lt;/code&gt; – City id, for example &lt;code&gt;GameData.CityId.EMPIRE&lt;/code&gt; or &lt;code&gt;GameData.CityId.CHAOS&lt;/code&gt;.<br /> <br /> == Returns ==<br /> ;cityData : &lt;code&gt;table&lt;/code&gt; – City table (see below), or nothing if the id is invalid.<br /> <br /> {| class=&quot;wikitable&quot;<br /> ! Key !! Type !! Meaning<br /> |-<br /> | &lt;code&gt;cityId&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || City id.<br /> |-<br /> | &lt;code&gt;initialRealm&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || –<br /> |-<br /> | &lt;code&gt;controllingRealm&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || –<br /> |-<br /> | &lt;code&gt;cityState&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || State of the city. The stock map code compares city states with &lt;code&gt;SystemData.CityStates&lt;/code&gt; values.<br /> |-<br /> | &lt;code&gt;numFortressesCaptured&lt;/code&gt; || &lt;code&gt;number&lt;/code&gt; || Number of captured fortresses. The stock world map shows its city locks from it.<br /> |}<br /> <br /> == Details ==<br /> * When the client has no campaign data at all, the function returns nothing without an error (and without checking the argument).<br /> * A new table is built on every call.<br /> * The function takes exactly one argument.<br /> <br /> == Errors ==<br /> * &lt;code&gt;Error in function call &#039;GetCampaignCityData&#039;: Paring %d is not a valid campaign city id.&lt;/code&gt; (sic, &quot;Paring&quot;; only the low 16 bits of the id are printed)<br /> <br /> == Example ==<br /> From &lt;code&gt;default/ea_worldmapwindow/source/campaignview.lua&lt;/code&gt;:<br /> &lt;pre&gt;<br /> if( GameDefs.ZoneCityIds[zoneId] ~= nil )<br /> then<br /> local cityData = GetCampaignCityData( GameDefs.ZoneCityIds[zoneId] )<br /> WindowSetShowing( zoneWindowName..&quot;Lock1&quot;, cityData.numFortressesCaptured &lt;= 1 )<br /> WindowSetShowing( zoneWindowName..&quot;Lock2&quot;, cityData.numFortressesCaptured == 0 )<br /> &lt;/pre&gt;<br /> <br /> == See also ==<br /> * [[API:GetCityRatingForCityId|GetCityRatingForCityId]]<br /> * [[API:GetCampaignPairingData|GetCampaignPairingData]]<br /> * [[API:GetFortressStatuses|GetFortressStatuses]]</div>

Maintenance script