WoW:API CancelPlayerBuff: Difference between revisions

Latest revision as of 04:45, 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

Removes a specific buff from the player.

CancelPlayerBuff(buffIndex);

buffIndex: The index of the buff to remove. Can be obtained with GetPlayerBuff. Can also use buff name since the 2.3 patch.

CancelPlayerBuff(GetPlayerBuff(0,"HELPFUL"))

Result: Removes the first (right-most in the default UI) buff from the player.

This function is not protected nor limited in any way to hardware event restriction Blizzard used so far. This function can be called freely from an AddOn to auto-remove a given buff.

(tested on live servers 2.0)

This function uses a zero-based index, while UnitBuff() does not.
The Burning Crusade: GetPlayerBuff() returns 0 if the buff doesn't exist. It stands to reason that this function would then be 1-based in TBC.

@@ Line 1: / Line 1: @@
- <center>'''CancelPlayerBuff''' ''-Documentation by Voratus-''</center>
+{{removedapi|3.0|Replaced by {{api|CancelUnitBuff}}("unit", buffIndex[, filter]) or ("unit", "spell"[, "rank"])}}
+{{wowapi}}
 Removes a specific buff from the player.
@@ Line 5: / Line 6: @@
   CancelPlayerBuff(buffIndex);
-----
+==Arguments==
-;''Arguments''
+;buffIndex : The index of the buff to remove. Can be obtained with [[API GetPlayerBuff|GetPlayerBuff]]. Can also use buff name since the 2.3 patch.
-:;buffIndex : The id of the buff to remove. Starts at 0 and goes up to 15..
+==Example==
+ CancelPlayerBuff(GetPlayerBuff(0,"HELPFUL"))
-----
+;Result : Removes the first (right-most in the default UI) buff from the player.
-;''Example''
- CancelPlayerBuff(0);
-;''Result''
+====Notes====
+* This function is not protected nor limited in any way to hardware event restriction Blizzard used so far. This function can be called freely from an AddOn to auto-remove a given buff.
-Removes the first (right-most in the default UI) buff from the player.
+(tested on live servers 2.0)
+* This function uses a zero-based index, while UnitBuff() does not.
+* '''The Burning Crusade:''' [[API GetPlayerBuff|GetPlayerBuff]]() returns 0 if the buff doesn't exist. It stands to reason that this function would then be 1-based in TBC.
-;''See Also''
-:* [[API UnitBuff|UnitBuff]]
-----
-{{WoW API}}