Refactor UnitBuff function parameters to make rank and filter optional

This commit is contained in:
2025-05-17 18:19:52 +02:00
parent 4450597653
commit 35487ec611

View File

@@ -14,9 +14,8 @@
---@param unit string The unit to query (e.g., "player", "target"). ---@param unit string The unit to query (e.g., "player", "target").
---@param index number The index of the aura to query (1-based). ---@param index number The index of the aura to query (1-based).
---@param name string The name of the aura to query. ---@param rank string? The rank of the aura (e.g., "Rank 7").
---@param rank string The rank of the aura (e.g., "Rank 7"). ---@param filter BuffFilter? A filter to specify which auras to return (e.g., "PLAYER|RAID").
---@param filter BuffFilter A filter to specify which auras to return (e.g., "PLAYER|RAID").
---@return string #name The name of the aura. ---@return string #name The name of the aura.
---@return string #rank The rank of the aura, if applicable. ---@return string #rank The rank of the aura, if applicable.
---@return string #icon The path to the icon texture for the aura. ---@return string #icon The path to the icon texture for the aura.
@@ -36,5 +35,6 @@
---@return number value1 Value of variable effect 1 of the aura. ---@return number value1 Value of variable effect 1 of the aura.
---@return number value2 Value of variable effect 2 of the aura. ---@return number value2 Value of variable effect 2 of the aura.
---@return number value3 Value of variable effect 3 of the aura. ---@return number value3 Value of variable effect 3 of the aura.
---@overload fun(unit: string, name: string)
--- Returns information about a buff on a unit. This function is an alias for UnitAura() with a built-in HELPFUL filter. --- Returns information about a buff on a unit. This function is an alias for UnitAura() with a built-in HELPFUL filter.
function UnitBuff(unit, index, name, rank, filter) end function UnitBuff(unit, index, rank, filter) end