Module buff
These functions help in retrieving information about buffs.
Buff functions are the profile API table `buff` (br.api.profile.buff); profiles use it by name.
`spell` in the function represent the name in the buffs list (Spec, Shared Class, Shared Global Lists) defined in Expansions/
Functions
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Cancel a buff. |
| buff. () | Get the count of a buff. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Get the duration of a buff. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Check if a buff exists. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Check if a buff can be reacted to. |
| buff. ([thisUnit="player"[, sourceUnit="player"[, share=0.3]]]) | Check if a buff should be refreshed. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Get the remaining time of a buff. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Get the remaining time of a buff. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Get the stack count of a buff. |
| buff. ([thisUnit="player"[, sourceUnit="player"]]) | Get the maximum stack count of a buff. |
Functions
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Cancel a buff.
Parameters:
- buff. ()
-
Get the count of a buff.
Returns:
-
number
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Get the duration of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
number
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Check if a buff exists.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
boolean
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Check if a buff can be reacted to.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
boolean
- buff. ([thisUnit="player"[, sourceUnit="player"[, share=0.3]]])
-
Check if a buff should be refreshed.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
- share number Due once this share of its duration or less is left (a wider share renews early) (default 0.3)
Returns:
-
boolean
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Get the remaining time of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
number
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Get the remaining time of a buff. (Duplicate of buff.spell.remain)
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
number
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Get the stack count of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
number
- buff. ([thisUnit="player"[, sourceUnit="player"]])
-
Get the maximum stack count of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string "player": your own (on the player, a copy anyone cast on you counts, so a buff isn't recast over someone else's); "any": from anyone (default "player")
Returns:
-
number