WoW:API CancelPlayerBuff: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(→Notes) |
||
| Line 27: | Line 27: | ||
* This function uses a zero-based index, while UnitBuff() does not. | * This function uses a zero-based index, while UnitBuff() does not. | ||
** '''The Burning Crusades:''' [[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. | ** '''The Burning Crusades:''' [[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. | ||
* In 3.0, this function is either removed and/or buff-removing is a protected action. It may also require a unit as the first argument. | |||
Revision as of 21:55, 18 October 2008
Removes a specific buff from the player.
CancelPlayerBuff(buffIndex);
- Arguments
- buffIndex
- The index of the buff to remove. Can be obtained with GetPlayerBuff. Can also use buff name since the 2.3 patch.
- Example
CancelPlayerBuff(GetPlayerBuff(0,"HELPFUL"))
- Result
Removes the first (right-most in the default UI) buff from the player.
- See Also
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.
(tested on live servers 2.0)
- This function uses a zero-based index, while UnitBuff() does not.
- The Burning Crusades: GetPlayerBuff() returns 0 if the buff doesn't exist. It stands to reason that this function would then be 1-based in TBC.
- In 3.0, this function is either removed and/or buff-removing is a protected action. It may also require a unit as the first argument.