Module br.player.debuff
These functions help in retrieving information about debuffs.
Debuff functions are stored in br.player.debuff and can be utilized by `local debuff = br.player.debuff` in your profile. `spell` in the function represent the name in the debuffs list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua
Functions
| debuff.spell.exists ([thisUnit="target"[, sourceUnit="player"]]) | Checks if a debuff exists on a unit. |
| debuff.spell.duration ([thisUnit="target"[, sourceUnit="player"]]) | Gets the duration of a debuff on a unit. |
| debuff.spell.remain ([thisUnit="target"[, sourceUnit="player"]]) | Gets the remaining time of a debuff on a unit. |
| debuff.spell.remains ([thisUnit="target"[, sourceUnit="player"]]) | Gets the remaining time of a debuff on a unit. |
| debuff.spell.stack ([thisUnit="target"[, sourceUnit="player"]]) | Gets the stack count of a debuff on a unit. |
| debuff.spell.pandemic ([thisUnit="target"[, sourceUnit="player"]]) | Gets the pandemic threshold for refreshing a debuff. |
| debuff.spell.pmultiplier ([thisUnit="target"[, sourceUnit="player"]]) | Gets the multiplier for the debuff based on its remaining time and duration. |
| debuff.spell.refresh ([thisUnit="target"[, sourceUnit="player"]]) | Checks if a debuff should be refreshed based on its remaining time and pandemic threshold. |
| debuff.spell.count () | Gets the count of a specific debuff across all units. |
| debuff.spell.remainCount (remain) | Gets the count of units with a debuff remaining time less than a specified value. |
| debuff.spell.refreshCount ([range=40]) | Gets the count of units that should have their debuff refreshed. |
| debuff.spell.lowest ([range=40[, debuffType="remain"]]) | Gets the unit with the lowest remaining time for a debuff within a specified range. |
| debuff.spell.lowestPet ([range=8[, debuffType="remain"]]) | Gets the unit with the lowest remaining time for a debuff within a specified range, considering only pets. |
| debuff.spell.max ([range=40[, debuffType="remain"]]) | Gets the unit with the highest remaining time for a debuff within a specified range. |
| debuff.spell.exsang ([thisUnit="target"]) | Checks if a debuff is exsanguinated. |
| debuff.spell.calc () | Calculates the snapshot value of a debuff. |
| debuff.spell.applied ([thisUnit="target"]) | Gets the value of the debuff when it was applied. |
| debuff.spell.ticksGainedOnRefresh () | Gets the number of debuff ticks that will be gained by reapplying the debuff to the specified unit. |
Functions
- debuff.spell.exists ([thisUnit="target"[, sourceUnit="player"]])
-
Checks if a debuff exists on a unit.
Parameters:
- thisUnit string The unit to check the debuff on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
boolean
- debuff.spell.duration ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the duration of a debuff on a unit.
Parameters:
- thisUnit string The unit to check the debuff duration on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.remain ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the remaining time of a debuff on a unit.
Parameters:
- thisUnit string The unit to check the debuff remaining time on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.remains ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the remaining time of a debuff on a unit. (Duplicate of debuff.spell.remain)
Parameters:
- thisUnit string The unit to check the debuff remaining time on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.stack ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the stack count of a debuff on a unit.
Parameters:
- thisUnit string The unit to check the debuff stack count on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.pandemic ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the pandemic threshold for refreshing a debuff.
Parameters:
- thisUnit string The unit to check the pandemic threshold on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.pmultiplier ([thisUnit="target"[, sourceUnit="player"]])
-
Gets the multiplier for the debuff based on its remaining time and duration.
Parameters:
- thisUnit string The unit to check the debuff multiplier on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
number
- debuff.spell.refresh ([thisUnit="target"[, sourceUnit="player"]])
-
Checks if a debuff should be refreshed based on its remaining time and pandemic threshold.
Parameters:
- thisUnit string The unit to check if the debuff should be refreshed on. (default "target")
- sourceUnit string The unit that applied the debuff. (default "player")
Returns:
-
boolean
- debuff.spell.count ()
-
Gets the count of a specific debuff across all units.
Returns:
-
number
- debuff.spell.remainCount (remain)
-
Gets the count of units with a debuff remaining time less than a specified value.
Parameters:
- remain number The remaining time to check against.
Returns:
-
number
- debuff.spell.refreshCount ([range=40])
-
Gets the count of units that should have their debuff refreshed.
Parameters:
- range number The range to check units within. (default 40)
Returns:
-
number
- debuff.spell.lowest ([range=40[, debuffType="remain"]])
-
Gets the unit with the lowest remaining time for a debuff within a specified range.
Parameters:
- range number The range to check units within. (default 40)
- debuffType string The type of debuff check to perform (e.g., "remain"). (default "remain")
Returns:
- debuff.spell.lowestPet ([range=8[, debuffType="remain"]])
-
Gets the unit with the lowest remaining time for a debuff within a specified range, considering only pets.
Parameters:
- range number The range to check units within. (default 8)
- debuffType string The type of debuff check to perform (e.g., "remain"). (default "remain")
Returns:
- debuff.spell.max ([range=40[, debuffType="remain"]])
-
Gets the unit with the highest remaining time for a debuff within a specified range.
Parameters:
- range number The range to check units within. (default 40)
- debuffType string The type of debuff check to perform (e.g., "remain"). (default "remain")
Returns:
- debuff.spell.exsang ([thisUnit="target"])
-
Checks if a debuff is exsanguinated.
Parameters:
- thisUnit string The unit to check the debuff on. (default "target")
Returns:
-
boolean
- debuff.spell.calc ()
-
Calculates the snapshot value of a debuff.
Returns:
-
number
- debuff.spell.applied ([thisUnit="target"])
-
Gets the value of the debuff when it was applied.
Parameters:
- thisUnit string The unit to check the debuff applied value on. (default "target")
Returns:
-
number
- debuff.spell.ticksGainedOnRefresh ()
-
Gets the number of debuff ticks that will be gained by reapplying the debuff to the specified unit.
Returns:
-
number