API:GetUnderdogRatings

UI Lua API · RvR functions
Version: WAR 1.4.8

Returns the two realms' underdog ratings.

orderRating, destructionRating = GetUnderdogRatings()

Arguments

None.

Returns

orderRating

number – First rating, a whole number from -128 to 127. The stock UI uses it as Order's rating.

destructionRating

number – 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 default/easystem_threepartbar/source/ea_threepartbar.lua:

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 ) )

See also

• GetRewardPools
• GetCampaignZoneData