Module debuff

These functions help in retrieving information about debuffs.

Debuff functions are the profile API table `debuff` (br.api.profile.debuff); profiles use it by name. `spell` in the function represent the name in the debuffs list (Spec, Shared Class, Shared Global Lists) defined in Expansions// (Global.lua, /Class.lua, /.lua)

Functions

debuff. ([thisUnit="target"]) Gets the value of the debuff when it was applied.
debuff. () Calculates the snapshot value of a debuff.
debuff. () Gets the count of a specific debuff across all units.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Gets the duration of a debuff on a unit.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Checks if a debuff exists on a unit.
debuff. ([thisUnit="target"]) Checks if a debuff is exsanguinated.
debuff. ([range=40[, debuffType="remain"]]) Gets the unit with the lowest remaining time for a debuff within a specified range.
debuff. ([range=8[, debuffType="remain"]]) Gets the unit with the lowest remaining time for a debuff within a specified range, considering only pets.
debuff. ([range=40[, debuffType="remain"]]) Gets the unit with the highest remaining time for a debuff within a specified range.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) The duration the refresh window is worked out from: the debuff's current duration on the unit (debuff.spell.refresh refreshes in its last 30%).
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Gets the multiplier for the debuff based on its remaining time and duration.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Checks if a debuff should be refreshed based on its remaining time and pandemic threshold.
debuff. ([range=40]) Gets the count of units that should have their debuff refreshed.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Gets the remaining time of a debuff on a unit.
debuff. (remain) Gets the count of units with a debuff remaining time less than a specified value.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Gets the remaining time of a debuff on a unit.
debuff. ([thisUnit="target"[, sourceUnit="player"]]) Gets the stack count of a debuff on a unit.
debuff. (thisUnit) Gets the number of debuff ticks that will be gained by reapplying the debuff to the specified unit.
debuff. (thisUnit) Gets the number of debuff ticks remaining until it expires on the specified unit.


Functions

debuff. ([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. ()
Calculates the snapshot value of a debuff.

Returns:

    number
debuff. ()
Gets the count of a specific debuff across all units.

Returns:

    number
debuff. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    boolean
debuff. ([thisUnit="target"])
Checks if a debuff is exsanguinated.

Parameters:

  • thisUnit string The unit to check the debuff on. (default "target")

Returns:

    boolean
debuff. ([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:

    string
debuff. ([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:

    string
debuff. ([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:

    string
debuff. ([thisUnit="target"[, sourceUnit="player"]])
The duration the refresh window is worked out from: the debuff's current duration on the unit (debuff.spell.refresh refreshes in its last 30%).

Parameters:

  • thisUnit string The unit to check the pandemic threshold on. (default "target")
  • sourceUnit string "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    boolean
debuff. ([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. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. (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. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. ([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 "player": applied by you; "any": by anyone (default "player")

Returns:

    number
debuff. (thisUnit)
Gets the number of debuff ticks that will be gained by reapplying the debuff to the specified unit.

Parameters:

  • thisUnit string|nil The unit to check the ticks gained by reapplying the debuff on (optional, default "target").

Returns:

    number
debuff. (thisUnit)
Gets the number of debuff ticks remaining until it expires on the specified unit.

Parameters:

  • thisUnit string|nil The unit to check the remaining ticks on (optional, default "target").

Returns:

    number
generated by LDoc 1.5.0 Last updated 2026-11-16 01:18:17