Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:44Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns a table describing one ability.

<pre>
abilityData = GetAbilityData(abilityId)
</pre>

== Arguments ==
;abilityId : <code>number</code> – Id of the ability.

== Returns ==
;abilityData : <code>table</code> – An ability data table (see below), plus the field <code>isActive</code>.

=== Ability data table ===
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Ability id.
|-
| <code>name</code> || <code>wstring</code> || Ability name from the <code>AbilityNames</code> string table. <code>L""</code> if that table is not available.
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|-
| <code>abilityType</code> || <code>number</code> || Ability type, compared with <code>GameData.AbilityType</code> values.
|-
| <code>targetType</code> || <code>number</code> || —
|-
| <code>tacticType</code> || <code>number</code> || Tactic type; indexes the result of [[API:GetNumTacticsSlots|GetNumTacticsSlots]].
|-
| <code>numTacticSlots</code> || <code>number</code> || Non-zero for tactics. The stock UI uses it to recognise a tactic.
|-
| <code>moraleLevel</code> || <code>number</code> || Morale level of a morale ability; 0 for other abilities.
|-
| <code>moraleCost</code> || <code>number</code> || —
|-
| <code>hasAPCostPerSecond</code> || <code>boolean</code> || —
|-
| <code>abilityCost</code> || <code>number</code> || —
|-
| <code>reuseTimer</code> || <code>number</code> || Reuse timer, in seconds.
|-
| <code>reuseTimerMax</code> || <code>number</code> || Maximum reuse timer, in seconds.
|-
| <code>cooldown</code> || <code>number</code> || Same value as <code>reuseTimerMax</code>.
|-
| <code>specialization</code> || <code>number</code> || —
|-
| <code>stanceOrder</code> || <code>number</code> || —
|-
| <code>careerID</code> || <code>number</code> || —
|-
| <code>abilityImprovementThreshold</code> || <code>number</code> || —
|-
| <code>abilityImprovementCap</code> || <code>number</code> || —
|-
| <code>requiresPet</code> || <code>boolean</code> || —
|-
| <code>isBuff</code>, <code>isDebuff</code>, <code>isDamaging</code>, <code>isHealing</code>, <code>isDefensive</code>, <code>isOffensive</code>, <code>isStatsBuff</code>, <code>isGranted</code>, <code>isPassive</code> || <code>boolean</code> || Flags of the ability. Always present.
|-
| <code>isHex</code>, <code>isCurse</code>, <code>isCripple</code>, <code>isAilment</code>, <code>isBolster</code>, <code>isAugmentation</code>, <code>isBlessing</code>, <code>isEnchantment</code> || <code>boolean</code> || Effect type flags. Only set (to <code>true</code>) when one of the ability's effects has that type; otherwise the key is absent.
|-
| <code>typeColorRed</code>, <code>typeColorGreen</code>, <code>typeColorBlue</code> || <code>number</code> || Colour of an effect type, 0–255. Only present when an effect type has a colour.
|}

== Details ==
* <code>abilityId</code> is converted to an integer.
* <code>isActive</code> is <code>true</code> only for ability 2490 while a particular player state flag is set. For every other ability it is <code>false</code>.
* The client always returns a table. The stock wrapper <code>Player.GetAbilityData</code> (<code>easystem_utils/source/player.lua</code>) treats a result whose <code>id</code> is <code>nil</code> or 0 as "not found".
* If there is no player object, or the Lua state is not available, the function returns nothing.
* The same ability data table is used for the entries of [[API:GetAbilityTable|GetAbilityTable]].

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/player.lua</code>:
<pre>
local abilityData = GetAbilityData (abilityId)

if (abilityData == nil or abilityData.id == nil or abilityData.id == 0) then
return nil
end

return abilityData
</pre>

Building a tooltip, from <code>ea_abilitieswindow/source/abilitieswindow.lua</code>:
<pre>
Tooltips.CreateAbilityTooltip( GetAbilityData(data.id), SystemData.ActiveWindow.name, AbilitiesWindow.TOOLTIP_ANCHOR)
</pre>

== See also ==
* [[API:GetAbilityTable|GetAbilityTable]]
* [[API:GetIconData|GetIconData]]

API:GetAbilityData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)