https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetCityInstanceIdAPI:GetCityInstanceId - Revision history2026-10-18T04:54:00ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetCityInstanceId&diff=30362&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:22Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Scenario}}<br />
Returns the instance number of the city the player is in, wrapped in a table.<br />
<br />
<pre><br />
data = GetCityInstanceId()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;data : <code>table</code> – A table with one field:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>instanceId</code> || <code>number</code> || City instance number stored by the client.<br />
|}<br />
<br />
== Details ==<br />
* The value is a single number kept by the client; the function does not check whether the player is actually in a city instance. The stock UI only calls it while <code>GameData.Player.isInSiege</code> is true.<br />
* The result is always a table, never a plain number. Read <code>data.instanceId</code>.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_scenariosummarywindow/scenariosummarywindow.lua</code>:<br />
<pre><br />
if ( GameData.Player.isInSiege )<br />
then<br />
local cityName = GetZoneName( GameData.Player.zone )<br />
local instanceIdData = GetCityInstanceId()<br />
LabelSetText( "ScenarioSummaryWindowScenarioName", GetStringFormat( StringTables.Default.TEXT_CITY_INSTANCE_LABEL, { cityName, instanceIdData.instanceId } ) )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetCampaignCityData|GetCampaignCityData]]<br />
* [[API:GetCityRatingForCityId|GetCityRatingForCityId]]<br />
* [[API:GameData.GetScenarioPlayers|GameData.GetScenarioPlayers]]</div>Maintenance script