Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:10Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Effect}}
Returns the effects (buffs and debuffs) on the player, a target or a group member.

<pre>
effects = GetBuffs(buffTargetType)
</pre>

== Arguments ==
;buffTargetType : <code>number</code> – Whose effects to return, a <code>GameData.BuffTargetType</code> value (for example <code>SELF</code>, <code>TARGET_HOSTILE</code>, <code>TARGET_FRIENDLY</code>, or a group member between <code>GROUP_MEMBER_START</code> and <code>GROUP_MEMBER_END</code>).

== Returns ==
;effects : <code>table</code> – Table of effect tables keyed by effect index. Nothing is returned if there is no player object or no effect holder for that value.

Each effect table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>effectIndex</code> || <code>number</code> || Index of the effect; also the key of the entry.
|-
| <code>name</code> || <code>wstring</code> || Name of the ability that applied the effect, from the <code>AbilityNames</code> string table.
|-
| <code>abilityId</code> || <code>number</code> || Id of the ability that applied the effect.
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|-
| <code>duration</code> || <code>number</code> || Duration in whole seconds.
|-
| <code>effectText</code> || <code>wstring</code> || Description of the effect.
|-
| <code>stackCount</code> || <code>number</code> || Number of stacks.
|-
| <code>permanentUntilDispelled</code> || <code>boolean</code> || –
|-
| <code>isCasterDispellable</code> || <code>boolean</code> || –
|-
| <code>castByPlayer</code> || <code>boolean</code> || <code>true</code> if the player applied the effect.
|-
| <code>trackerPriority</code> || <code>number</code> || Sort priority. The stock buff tracker shows effects with a higher priority first.
|-
| <code>isBuff</code>, <code>isDebuff</code>, … || <code>boolean</code> || The effect type flags described for the [[API:GetAbilityData#Ability data table|ability data table]] (<code>isHex</code>, <code>isCurse</code>, …, and the <code>typeColor</code> fields).
|}

== Details ==
* Effects are left out when their ability has no effect entry or has a particular ability flag set. An effect without a duration is only listed when <code>permanentUntilDispelled</code> is <code>true</code>.
* The effect type flags are filled by the same code as for the ability data table, from the ability that applied the effect.
* The table is keyed by effect index, not an array; use <code>pairs()</code>.
* Pass only <code>GameData.BuffTargetType</code> values; the value is used as an index into the client's list of effect holders.

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

== Example ==
From <code>eatemplate_unitframes/source/bufftracker.lua</code>:
<pre>
function BuffTracker:Refresh()
-- Get the full list of buffs from native code.
local allBuffs = GetBuffs( self.m_targetType )
if ( allBuffs ~= nil )
then
self.m_buffData = allBuffs
else
self.m_buffData = {}
end
self:OnBuffsChanged()
end
</pre>

== See also ==
* [[API:RemoveEffect|RemoveEffect]]
* [[API:RemoveTargetEffect|RemoveTargetEffect]]
* [[API:GetAbilityData|GetAbilityData]]

API:GetBuffs - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)