WoW API: GetPlayerBuff

From AddOn Studio
Revision as of 04:46, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API GetPlayerBuff to API GetPlayerBuff without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Icon-remove-48x48.png This is no longer a part of the World of Warcraft API.
  • Use UnitAura (or derived functions) to retrieve information about buffs.
  • It was removed in patch 3.0.

← WoW API < GetPlayerBuff

Retrieve info about a certain player buff of a certain type. 

buffIndex, untilCancelled = GetPlayerBuff(buffId, buffFilter);

Arguments[edit]

buffId
number: The id of the buff to retrieve. Starts at 1 and goes up to 16.
(String buffFilter)
buffFilter
The "filter" to use when selecting buffs. Will affect what types of buffs are retrieved.
Verified buffFilters:
"HELPFUL|HARMFUL|PASSIVE"
"HELPFUL"
"HARMFUL"
Theoretically, buffFilters can be any combination of HELPFUL, HARMFUL, PASSIVE, CANCELABLE, NOT_CANCELABLE according to comments in the source code.

Returns[edit]

buffIndex
The index of the buff. Mainly to use for other GetPlayerBuffXYZ functions. If zero, there is no such buff.
untilCancelled
If 1, this buff will last until it is cancelled (Aura, Aspect, Stealth).

Example[edit]

local buffIndex, untilCancelled = GetPlayerBuff(0, "HELPFUL|HARMFUL|PASSIVE");
Result
Retrieves buff info about the first buff you have.

See Also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetPlayerBuff&oldid=19224"