Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:23Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=RvR}}
Returns the rating (rank) of a capital city.

<pre>
rating = GetCityRatingForCityId(cityId)
</pre>

== Arguments ==
;cityId : <code>number</code> – City id, for example <code>GameData.CityId.EMPIRE</code>, <code>GameData.CityId.CHAOS</code> or <code>GameData.Player.City.id</code>.

== Returns ==
;rating : <code>number</code> – The stored rating of the city. Nothing if the rating is 0 or the client has no rating for that city.

== Details ==
* '''A rating of 0 returns nothing''', not <code>0</code>. Code that compares the result directly with a number, as <code>MapUtils</code> does (<code>rating <= cityRating</code>), raises a Lua error in that case. Use <code>local rating = GetCityRatingForCityId(id) or 0</code>.
* The value is read from a table the client keeps; nothing is requested from the server.
* The function takes exactly one argument.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>default/easystem_utils/source/maputils.lua</code>: one star per city rank:
<pre>
local cityRating = GetCityRatingForCityId( cityId )

for rating = 1, GameDefs.NUM_CITY_RANKS
do
local showStar = rating <= cityRating
WindowSetShowing( windowName.."Star"..rating, showStar )
</pre>

== See also ==
* [[API:GetCampaignCityData|GetCampaignCityData]]
* [[API:GetCityInstanceId|GetCityInstanceId]]

API:GetCityRatingForCityId - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)