Gaming
 

API GetPlayerBuff

From WoWWiki

Main Menu


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

buffIndex, untilCancelled = GetPlayerBuff(buffId, buffFilter);

Contents

Arguments

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

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

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

See Also