Module br.player.buff
These functions help in retrieving information about buffs.
Buff functions are stored in br.player.buff and can be utilized by `local buff = br.player.buff` in your profile. `spell` in the function represent the name in the buffs list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua
Functions
| buff.spell.cancel ([thisUnit="player"[, sourceUnit="player"]]) | Cancel a buff. |
| buff.spell.count () | Get the count of a buff. |
| buff.spell.duration ([thisUnit="player"[, sourceUnit="player"]]) | Get the duration of a buff. |
| buff.spell.exists ([thisUnit="player"[, sourceUnit="player"]]) | Check if a buff exists. |
| buff.spell.react ([thisUnit="player"[, sourceUnit="player"]]) | Check if a buff can be reacted to. |
| buff.spell.remain ([thisUnit="player"[, sourceUnit="player"]]) | Get the remaining time of a buff. |
| buff.spell.remains ([thisUnit="player"[, sourceUnit="player"]]) | Get the remaining time of a buff. |
| buff.spell.refresh ([thisUnit="player"[, sourceUnit="player"]]) | Check if a buff should be refreshed. |
| buff.spell.stack ([thisUnit="player"[, sourceUnit="player"]]) | Get the stack count of a buff. |
| buff.spell.stackMax ([thisUnit="player"[, sourceUnit="player"]]) | Get the maximum stack count of a buff. |
Functions
- buff.spell.cancel ([thisUnit="player"[, sourceUnit="player"]])
-
Cancel a buff.
Parameters:
- buff.spell.count ()
-
Get the count of a buff.
Returns:
-
number
- buff.spell.duration ([thisUnit="player"[, sourceUnit="player"]])
-
Get the duration of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
number
- buff.spell.exists ([thisUnit="player"[, sourceUnit="player"]])
-
Check if a buff exists.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
boolean
- buff.spell.react ([thisUnit="player"[, sourceUnit="player"]])
-
Check if a buff can be reacted to.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
boolean
- buff.spell.remain ([thisUnit="player"[, sourceUnit="player"]])
-
Get the remaining time of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
number
- buff.spell.remains ([thisUnit="player"[, sourceUnit="player"]])
-
Get the remaining time of a buff. (Duplicate of br.player.buff.spell.remain)
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
number
- buff.spell.refresh ([thisUnit="player"[, sourceUnit="player"]])
-
Check if a buff should be refreshed.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
boolean
- buff.spell.stack ([thisUnit="player"[, sourceUnit="player"]])
-
Get the stack count of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
number
- buff.spell.stackMax ([thisUnit="player"[, sourceUnit="player"]])
-
Get the maximum stack count of a buff.
Parameters:
- thisUnit string The unit to check. (default "player")
- sourceUnit string The source of the buff. (default "player")
Returns:
-
number