Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:49Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Ability}}
Returns the player's upgrade rank of an ability.

<pre>
rank = GetAbilityUpgradeRank(abilityId)
</pre>

== Arguments ==
;abilityId : <code>number</code> – Id of the ability. It is converted to a 16-bit integer.

== Returns ==
;rank : <code>number</code> – Upgrade rank, 0 to 255.

== Details ==
* The stock ability tooltip shows "no rank" when the value is 0.
* If there is no player object, or the Lua state is not available, the function returns nothing.

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

== Example ==
From <code>easystem_tooltips/source/abilitytooltips.lua</code>:
<pre>
local upgradeRank = GetAbilityUpgradeRank (abilityData.id)

if (upgradeRank > 0)
then
return (GetStringFormat (StringTables.Default.LABEL_ABILITY_TOOLTIP_ABILITY_RANK, {upgradeRank}))
end

return (GetString (StringTables.Default.LABEL_ABILITY_TOOLTIP_ABILITY_NO_RANK))
</pre>

== See also ==
* [[API:GetAbilityDescription|GetAbilityDescription]]
* [[API:GetAbilityData|GetAbilityData]]

API:GetAbilityUpgradeRank - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)