Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:48Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Ability}}
Returns the requirement texts of an ability, as shown in its tooltip.

<pre>
requirements = GetAbilityRequirements(abilityId)
</pre>

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

== Returns ==
;requirements : <code>table</code> – Array of 5 <code>wstring</code> values, indexed 1 to 5.

== Details ==
* Each entry is a text from the <code>abilityresults</code> string table. Unused requirement slots, and all slots of an unknown ability, are <code>L""</code>.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* The stock tooltip loops from 1 to <code>GameData.ABILITY_REQUIREMENT_COUNT</code>.

== 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 reqs = GetAbilityRequirements( abilityData.id )

for reqsIndex = 1, GameData.ABILITY_REQUIREMENT_COUNT
do
local reqsLabel = windowName.."Requirements"..reqsIndex

if ((reqs[reqsIndex] ~= nil) and (DoesWindowExist (reqsLabel)))
then
LabelSetText (reqsLabel, reqs[reqsIndex])
else
LabelSetText (reqsLabel, L"")
end
end
</pre>

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

API:GetAbilityRequirements - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)