View source for API:GetUnderdogRatings

{{LuaApi|group=RvR}}
Returns the two realms' underdog ratings.

<pre>
orderRating, destructionRating = GetUnderdogRatings()
</pre>

== Arguments ==
None.

== Returns ==
;orderRating : <code>number</code> – First rating, a whole number from -128 to 127. The stock UI uses it as Order's rating.
;destructionRating : <code>number</code> – Second rating, same range. The stock UI uses it as Destruction's rating.

== Details ==
* The two values are stored by the client and returned as they are. The function always returns two numbers.
* The stock zone control tooltip shows them as bonus points and formats positive and negative values with different strings.

== Errors ==
None.

== Example ==
From <code>default/easystem_threepartbar/source/ea_threepartbar.lua</code>:
<pre>
local orderPoints, destPoints = GetUnderdogRatings()
local orderText = GetStringFormatFromTable( "WorldControl", StringTables.WorldControl.TEXT_CONTROL_BONUS_UNDERDOG_ORDER_POINTS, GetSignParams( orderPoints ) )
local destText = GetStringFormatFromTable( "WorldControl", StringTables.WorldControl.TEXT_CONTROL_BONUS_UNDERDOG_DESTRUCTION_POINTS, GetSignParams( destPoints ) )
</pre>

== See also ==
* [[API:GetRewardPools|GetRewardPools]]
* [[API:GetCampaignZoneData|GetCampaignZoneData]]