Refactor API functions to improve parameter aliasing and enhance documentation clarity

This commit is contained in:
2025-05-18 15:12:37 +02:00
parent cbed6108ef
commit b5cba11bd3
10 changed files with 95 additions and 99 deletions

View File

@@ -1,13 +1,23 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param nil number
---@return string name
---@return string rank
---@return string texture
---@return number duration
---@return number expiration
---@return number spellId
---@return number slot
---Returns the active buff for a given raid buff category. As of 5.0, the default BuffFrames aggregate standard raid buffs. GetRaidBuffTrayAuraInfo is used to determine which buff category is active. Current raid buff categories are: RAID_BUFF_1 Stats RAID_BUFF_2 Stamina RAID_BUFF_3 Attack Power RAID_BUFF_4 Haste RAID_BUFF_5 Spell Power RAID_BUFF_6 Critical Strike RAID_BUFF_7 Mastery RAID_BUFF_8 Multistrike RAID_BUFF_9 Versatility The highest raid buff category number is indicated by NUM_LE_RAID_BUFF_TYPES.
function GetRaidBuffTrayAuraInfo(nil) end
---@param index number
---@return string name
---@return string rank
---@return string texture
---@return number duration
---@return number expiration
---@return number spellId
---@return number slot
--- Returns the active buff for a given raid buff category. As of 5.0, the default BuffFrames aggregate standard raid buffs. GetRaidBuffTrayAuraInfo is used to determine which buff category is active. Current raid buff categories are:
-- RAID_BUFF_1 Stats
-- RAID_BUFF_2 Stamina
-- RAID_BUFF_3 Attack Power
-- RAID_BUFF_4 Haste
-- RAID_BUFF_5 Spell Power
-- RAID_BUFF_6 Critical Strike
-- RAID_BUFF_7 Mastery
-- RAID_BUFF_8 Multistrike
-- RAID_BUFF_9 Versatility
-- The highest raid buff category number is indicated by NUM_LE_RAID_BUFF_TYPES.
function GetRaidBuffTrayAuraInfo(index) end