WoW:API GetPlayerBuff: Difference between revisions

Latest revision as of 04:46, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetPlayerBuff

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

buffIndex, untilCancelled = GetPlayerBuff(buffId, buffFilter);

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.

@@ Line 1: / Line 1: @@
+{{removedapi|3.0|Use {{api|UnitAura}} (or derived functions) to retrieve information about buffs.}}
 {{wowapi}}
-<center>'''GetPlayerBuff''' ''-Documentation by Sarf-''</center>
 Retrieve info about a certain player buff of a certain type.
@@ Line 6: / Line 6: @@
   buffIndex, untilCancelled = GetPlayerBuff(buffId, buffFilter);
-----
+==Arguments==
-;''Arguments''
+;[[buffId]] : number: The id of the buff to retrieve. Starts at 1 and goes up to 16.
-:(Number buffId)
-:;[[API TYPE buffID|buffId]] : The id of the buff to retrieve. Starts at 0 and goes up to 15 (may get higher).
-::'''Burning Crusade''' : Starts at 1 and goes up to 16.
 :(String buffFilter)
@@ Line 18: / Line 13: @@
 :;buffFilter : The "filter" to use when selecting buffs. Will affect what types of buffs are retrieved.
-: Verified buffFilters:
+:: Verified buffFilters:
-:; "HELPFUL|HARMFUL|PASSIVE"
+::: "HELPFUL|HARMFUL|PASSIVE"
-:; "HELPFUL"
+::: "HELPFUL"
-:; "HARMFUL"
+::: "HARMFUL"
-: Theoretically, buffFilters can be any combination of HELPFUL, HARMFUL, PASSIVE, CANCELABLE, NOT_CANCELABLE according to comments in the source code.
-----
-;''Returns''
-:(Number buffIndex)
+:: Theoretically, buffFilters can be any combination of HELPFUL, HARMFUL, PASSIVE, CANCELABLE, NOT_CANCELABLE according to comments in the source code.
-:;buffIndex : The index of the buff. Mainly to use for other GetPlayerBuffXYZ functions. If below zero, indicates there is no such buff.
+==Returns==
-::'''Burning Crusade''' : If zero, indicates there is no such buff.
+;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).
-:(Number untilCancelled)
+==Example==
-:;untilCancelled : If 1, this buff will last until it is cancelled (Aura, Aspect, Stealth).
-----
-;''Example''
   local buffIndex, untilCancelled = GetPlayerBuff(0, "HELPFUL|HARMFUL|PASSIVE");
-;''Result''
+;Result : Retrieves buff info about the first buff you have.
-Retrieves buff info about the first buff you have.
-----
-;''Description''
-: Retrieves info and identifier about a certain effect on the player.
-;''See Also''
+==See Also==
 :* [[API CancelPlayerBuff|CancelPlayerBuff]]
 :* [[API GetPlayerBuffApplications|GetPlayerBuffApplications]]
@@ Line 57: / Line 35: @@
 :* [[API GetPlayerBuffTimeLeft|GetPlayerBuffTimeLeft]]
 :* [[API GameTooltip SetPlayerBuff|GameTooltip:SetPlayerBuff]]
-----