Refactor API functions to standardize parameter aliases and improve documentation clarity

api/CalendarSetMonth.lua

@@ -1,9 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset 1 
+---@param monthOffset monthOffset
----@param -1  
----@param 0  
----@param 1  
 ---Sets the calendar's month relative to its current month
-function CalendarSetMonth(monthOffset, -1, 0, 1) end
+function CalendarSetMonth(monthOffset) end

api/CollapseGuildTradeSkillHeader.lua

@@ -1,17 +1,19 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param professionID 773 
+---@alias professionID
----@param 164  
+---| 164 - Blacksmithing
----@param 165  
+---| 165 - Leatherworking
----@param 171  
+---| 171 - Alchemy
----@param 182  
+---| 182 - Herbalism
----@param 186  
+---| 186 - Mining
----@param 197  
+---| 197 - Tailoring
----@param 202  
+---| 202 - Engineering
----@param 333  
+---| 333 - Enchanting
----@param 393  
+---| 393 - Skinning
----@param 755  
+---| 755 - Jewelcrafting
----@param 773  
+---| 773 - Inscription
+
+---@param professionID professionID
 ---Collapses the corresponding profession in the guild window. This function is used to collapse a single profession in the guild window (professions view) based on its ID. Can also be done while window is not visible. See ExpandGuildTradeSkillHeader() for opening the view.
-function CollapseGuildTradeSkillHeader(professionID, 164, 165, 171, 182, 186, 197, 202, 333, 393, 755, 773) end
+function CollapseGuildTradeSkillHeader(professionID) end

api/ConfirmLootRoll.lua

@@ -1,10 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param id number 
+---@param id number
----@param rollType 2 
+---@param rollType rollType
----@param 0  
----@param 1  
----@param 2  
 ---Confirms the player's intent regarding an item up for loot rolling. Usable after the CONFIRM_LOOT_ROLL event fires, warning that an item binds on pickup.
-function ConfirmLootRoll(id, rollType, 0, 1, 2) end
+function ConfirmLootRoll(id, rollType) end

api/DeclineName.lua

@@ -1,16 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param name string 
+---@param name string
----@param gender 3 
+---@param gender gender
----@param 1or nil  
+---@param declensionSet number
----@param 2  
+---@return string genitive
----@param 3  
+---@return string dative
----@param declensionSet number 
+---@return string accusative
----@return string genitive 
+---@return string instrumental
----@return string dative 
+---@return string prepositional
----@return string accusative 
----@return string instrumental 
----@return string prepositional 
 ---Returns suggested declensions for a name. In the Russian language, nouns (including proper names) take different form based on their usage in a sentence. When the player enters the base name for a character or pet, the game suggests one or more sets of variations for the five additional cases; the player is asked to choose from among the suggestions and/or enter their own. (The set of declensions ultimately chosen/entered by the player are only used internally and not available to addons.) Has no effect in non-Russian-localized clients.
-function DeclineName(name, gender, 1or nil, 2, 3, declensionSet) end
+function DeclineName(name, gender, declensionSet) end

api/DestroyTotem.lua

@@ -1,10 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 4 
+---@param slot totemSlot
----@param 1  
----@param 2  
----@param 3  
----@param 4  
 ---Destroys a specific totem (or ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent).
-function DestroyTotem(slot, 1, 2, 3, 4) end
+function DestroyTotem(slot) end

api/DoTradeSkill.lua

@@ -1,7 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index number 
+---@param index number
----@param repeat number 
+---@param repeatn number
 ---Performs a trade skill recipe
-function DoTradeSkill(index, repeat) end
+function DoTradeSkill(index, repeatn) end

api/ExpandGuildTradeSkillHeader.lua

@@ -1,17 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param professionID 773 
+---@param professionID professionID
----@param 164  
----@param 165  
----@param 171  
----@param 182  
----@param 186  
----@param 197  
----@param 202  
----@param 333  
----@param 393  
----@param 755  
----@param 773  
 ---Expands the corresponding profession in the guild window. This function is used to expand a single profession in the guild window (professions view) based on its ID. Can also be done while window is not visible. See CollapseGuildTradeSkillHeader() for closing the view again.
-function ExpandGuildTradeSkillHeader(professionID, 164, 165, 171, 182, 186, 197, 202, 333, 393, 755, 773) end
+function ExpandGuildTradeSkillHeader(professionID) end

api/GetAttackPowerForStat.lua

@@ -1,13 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param statIndex 5 
+---@param statIndex statIndex
----@param 1  
+---@param effectiveStat number
----@param 2  
+---@return number attackPower
----@param 3  
----@param 4  
----@param 5  
----@param effectiveStat number 
----@return number attackPower 
 ---Returns the attack power bonus provided by one of the player's basic statistics
-function GetAttackPowerForStat(statIndex, 1, 2, 3, 4, 5, effectiveStat) end
+function GetAttackPowerForStat(statIndex, effectiveStat) end

api/GetAuctionInvTypes.lua

@@ -1,15 +1,15 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param classIndex number 
+---@alias subClassIndex
----@param subClassIndex 5 
+---| 1 - Miscellaneous
----@param 1  
+---| 2 - Cloth
----@param 2  
+---| 3 - Leather
----@param 3  
+---| 4 - Mail
----@param 4  
+---| 5 - Plate
----@param 5  
+
----@return string token 
+---@param classIndex number
----@return 1nil display 
+---@param subClassIndex subClassIndex
----@return list ... 
+---@return (string|boolean)[] #Pairs of token-display, try use {} to cram into table
 ---Returns a list of the inventory subtypes for a given auction house item subclass. Inventory types are the second level of hierarchy seen when browsing item classes (categories) and subclasses at the Auction House: Head, Neck, Shirt, et al for Miscellaneous; Head, Shoulder, Chest, Wrist, et al for Cloth; etc. This function still returns valid information if the player is not interacting with an auctioneer.
-function GetAuctionInvTypes(classIndex, subClassIndex, 1, 2, 3, 4, 5) end
+function GetAuctionInvTypes(classIndex, subClassIndex) end

api/GetAutoCompleteResults.lua

@@ -1,25 +1,29 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param inputString string 
+---@alias includeBitfield #One or more of the following flags (combined via bit.bor()), indicating which characters should be included in the result list: (number, bitfield)
----@param includeBitfield AUTOCOMPLETE_FLAG_ALL 
+---| 0x00000000 - AUTOCOMPLETE_FLAG_NONE: No characters
----@param 0x00000000 AUTOCOMPLETE_FLAG_NONE 
+---| 0x00000001 - AUTOCOMPLETE_FLAG_IN_GROUP: Characters in the player's party or raid
----@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP 
+---| 0x00000002 - AUTOCOMPLETE_FLAG_IN_GUILD: Characters in the player's guild
----@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD 
+---| 0x00000004 - AUTOCOMPLETE_FLAG_FRIEND: Characters from the player's friends list
----@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND 
+---| 0x00000010 - AUTOCOMPLETE_FLAG_INTERACTED_WITH: Characters with whom the player has recently interacted
----@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH 
+---| 0x00000020 - AUTOCOMPLETE_FLAG_ONLINE: Currently online friends and guildmates
----@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE 
+---| 0xffffffff - AUTOCOMPLETE_FLAG_ALL: All characters
----@param 0xffffffff AUTOCOMPLETE_FLAG_ALL 
+
----@param excludeBitfield AUTOCOMPLETE_FLAG_ALL 
+---@alias excludeBitfield #One or more of the following flags (combined via bit.bor()), indicating which characters should be excluded from the result list: (number, bitfield)
----@param 0x00000000 AUTOCOMPLETE_FLAG_NONE 
+---| 0x00000000 - AUTOCOMPLETE_FLAG_NONE: No characters
----@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP 
+---| 0x00000001 - AUTOCOMPLETE_FLAG_IN_GROUP: Characters in the player's party or raid
----@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD 
+---| 0x00000002 - AUTOCOMPLETE_FLAG_IN_GUILD: Characters in the player's guild
----@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND 
+---| 0x00000004 - AUTOCOMPLETE_FLAG_FRIEND: Characters from the player's friends list
----@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH 
+---| 0x00000010 - AUTOCOMPLETE_FLAG_INTERACTED_WITH: Characters with whom the player has recently interacted
----@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE 
+---| 0x00000020 - AUTOCOMPLETE_FLAG_ONLINE: Currently online friends and guildmates
----@param 0xffffffff AUTOCOMPLETE_FLAG_ALL 
+---| 0xffffffff - AUTOCOMPLETE_FLAG_ALL: All characters
----@param maxResults number 
+
----@param cursorPosition number 
+---@param inputString string
----@return list ... 
+---@param includeBitfield includeBitfield
+---@param excludeBitfield excludeBitfield
+---@param maxResults number
+---@param cursorPosition number
+---@return string[] results
 ---Returns a list of character names which complete a given partial name prefix
-function GetAutoCompleteResults(inputString, includeBitfield, 0x00000000, 0x00000001, 0x00000002, 0x00000004, 0x00000010, 0x00000020, 0xffffffff, excludeBitfield, 0x00000000, 0x00000001, 0x00000002, 0x00000004, 0x00000010, 0x00000020, 0xffffffff, maxResults, cursorPosition) end
+function GetAutoCompleteResults(inputString, includeBitfield, excludeBitfield, maxResults, cursorPosition) end

api/GetBarberShopStyleInfo.lua

@@ -1,13 +1,10 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param styleIndex 3 
+---@param styleIndex barberShopStyleIndex
----@param 1  
+---@return string name
----@param 2  
+---@return string unused
----@param 3  
+---@return number cost
----@return string name 
+---@return 1nil isCurrent
----@return string unused 
----@return number cost 
----@return 1nil isCurrent 
 ---Returns information about the selected barber shop style option
-function GetBarberShopStyleInfo(styleIndex, 1, 2, 3) end
+function GetBarberShopStyleInfo(styleIndex) end

api/GetBattlefieldTeamInfo.lua

@@ -1,13 +1,15 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index 1 
+---@alias battlegroundGroup
----@param 0  
+---| 0 - Green Team/Horde
----@param 1  
+---| 1 - Gold Team/Alliance
----@return string teamName 
+
----@return number teamRating 
+---@param index battlegroundGroup
----@return number newTeamRating 
+---@return string teamName
----@return number teamMMR 
+---@return number teamRating
----@return number numPlayers 
+---@return number newTeamRating
+---@return number teamMMR
+---@return number numPlayers
 ---Returns info about teams and their rating and MMR in a rated arena match. Usable following the UPDATE_BATTLEFIELD_SCORE event.
-function GetBattlefieldTeamInfo(index, 0, 1) end
+function GetBattlefieldTeamInfo(index) end

api/GetFunctionCPUUsage.lua

@@ -1,9 +1,9 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param function function 
+---@param func function
----@param includeSubroutines boolean 
+---@param includeSubroutines boolean #True to include time spent in other functions called by the given function; false to count only time spent in the function body (boolean)
----@return number usage 
+---@return number usage #Amount of CPU time used by the function (in milliseconds) since the UI was loaded or ResetCPUUsage() was last called (number)
----@return number calls 
+---@return number calls #Number of times the function has been called (number)
 ---Returns information about CPU usage by a function. Only returns valid data if the scriptProfile CVar is set to 1; returns 0 otherwise.
-function GetFunctionCPUUsage(function, includeSubroutines) end
+function GetFunctionCPUUsage(func, includeSubroutines) end

api/GetGlyphLink.lua

@@ -1,11 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param socket number 
+---@param socket number
----@param talentGroup nil 
+---@param talentGroup talentGroup
----@param 1  
+---@return string link
----@param 2  
----@param nil  
----@return string link 
 ---Gets a hyperlink for the contents of a glyph socket. Glyph links are distinct from item and spell links: e.g. "|cff66bbff|Hglyph:21:361|h[Glyph of Hunter's Mark]|h|r".
-function GetGlyphLink(socket, talentGroup, 1, 2, nil) end
+function GetGlyphLink(socket, talentGroup) end

api/GetGlyphSocketInfo.lua

@@ -1,15 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param socket number 
+---@param socket number
----@param talentGroup nil 
+---@param talentGroup talentGroup
----@param 1  
+---@return boolean enabled
----@param 2  
+---@return number glyphType
----@param nil  
+---@return number glyphTooltipIndex
----@return boolean enabled 
+---@return number glyphSpell
----@return number glyphType 
+---@return string icon
----@return number glyphTooltipIndex 
----@return number glyphSpell 
----@return string icon 
 ---Returns information about a glyph socket and its contents. The spell ID referenced in the third return glyphSpell refers to the spell used to put the glyph in the socket -- not the Inscription spell that creates a glyph item, but the spell associated with that item's "Use:" effect.
-function GetGlyphSocketInfo(socket, talentGroup, 1, 2, nil) end
+function GetGlyphSocketInfo(socket, talentGroup) end

api/GetNumDeclensionSets.lua

@@ -1,11 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param name string 
+---@alias gender
----@param gender 3 
+---| 1 or nil - Neuter
----@param 1 or nil  
+---| 2 - Male
----@param 2  
+---| 3 - Female
----@param 3  
+
----@return number numSets 
+---@param name string
+---@param gender gender
 ---Returns the number of suggested declension sets for a name. Used in the Russian localized World of Warcraft client; see DeclineName for further details. Returns 0 in other locales.
-function GetNumDeclensionSets(name, gender, 1 or nil, 2, 3) end
+function GetNumDeclensionSets(name, gender) end

api/GetRaidBuffTrayAuraInfo.lua

@@ -1,13 +1,23 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param nil number 
+---@param index number
----@return string name 
+---@return string name
----@return string rank 
+---@return string rank
----@return string texture 
+---@return string texture
----@return number duration 
+---@return number duration
----@return number expiration 
+---@return number expiration
----@return number spellId 
+---@return number spellId
----@return number slot 
+---@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.
+--- 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:
-function GetRaidBuffTrayAuraInfo(nil) end
+--  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

api/GetRuneCooldown.lua

@@ -1,15 +1,9 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 6 
+---@param slot runeSlot
----@param 1  
+---@return number start
----@param 2  
+---@return number duration
----@param 3  
+---@return boolean runeReady
----@param 4  
----@param 5  
----@param 6  
----@return number start 
----@return number duration 
----@return boolean runeReady 
 ---Returns cooldown information about one of the player's rune resources. Note the placement of runes 3-4 (normally Unholy) and 5-6 (normally Frost) are reversed in the default UI. Also note the behavior of returned values differs slightly from most other GetXYZCooldown-style functions.
-function GetRuneCooldown(slot, 1, 2, 3, 4, 5, 6) end
+function GetRuneCooldown(slot) end

api/GetRuneCount.lua

@@ -1,13 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 6 
+---@param slot runeSlot
----@param 1  
+---@return number count
----@param 2  
----@param 3  
----@param 4  
----@param 5  
----@param 6  
----@return number count 
 ---Returns the number of available rune resources in one of the player's rune slots. Returns 1 if a rune is ready and 0 if a rune is on cooldown.
-function GetRuneCount(slot, 1, 2, 3, 4, 5, 6) end
+function GetRuneCount(slot) end

api/GetRuneType.lua

@@ -1,17 +1,21 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 6 
+---@alias runeSlot
----@param 1  
+---| 1 - Leftmost
----@param 2  
+---| 2 - Second from left
----@param 3  
+---| 3 - Fifth from left (second from right)
----@param 4  
+---| 4 - Sixth from left (rightmost)
----@param 5  
+---| 5 - Third from left
----@param 6  
+---| 6 - Fourth from left
----@return 4 runeType 
+
----@return  1 
+---@alias runeType
----@return  2 
+---| 1 - Blood rune
----@return  3 
+---| 2 - Unholy rune
----@return  4 
+---| 3 - Frost rune
+---| 4 - Death rune
+
+---@param slot runeSlot
+---@return runeType runeType
 ---Returns the type of one of the player's rune resources. Note the placement of runes 3-4 (normally Unholy) and 5-6 (normally Frost) are reversed in the default UI.
-function GetRuneType(slot, 1, 2, 3, 4, 5, 6) end
+function GetRuneType(slot) end

api/GetSpellBonusDamage.lua

@@ -1,14 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param school 7 
+---@param school spellSchool
----@param 1  
+---@return number minModifier
----@param 2  
----@param 3  
----@param 4  
----@param 5  
----@param 6  
----@param 7  
----@return number minModifier 
 ---Returns the player's spell damage bonus for a spell school
-function GetSpellBonusDamage(school, 1, 2, 3, 4, 5, 6, 7) end
+function GetSpellBonusDamage(school) end

api/GetSpellCritChance.lua

@@ -1,14 +1,16 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param school 7 
+---@alias spellSchool
----@param 1  
+---| 1 - Physical
----@param 2  
+---| 2 - Holy
----@param 3  
+---| 3 - Fire
----@param 4  
+---| 4 - Nature
----@param 5  
+---| 5 - Frost
----@param 6  
+---| 6 - Shadow
----@param 7  
+---| 7 - Arcane
----@return number minCrit 
+
+---@param school spellSchool
+---@return number minCrit
 ---Returns the player's spell critical strike chance for a spell school
-function GetSpellCritChance(school, 1, 2, 3, 4, 5, 6, 7) end
+function GetSpellCritChance(school) end

api/GetStablePetFoodTypes.lua

@@ -1,9 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index 1 to NUM_PET_STABLE_SLOTS 
+---@param index number
----@param 0  
+---@return string[] foodTypes
----@param 1 to NUM_PET_STABLE_SLOTS  
----@return list ... 
 ---Returns the types of food that a stabled pet will eat
-function GetStablePetFoodTypes(index, 0, 1 to NUM_PET_STABLE_SLOTS) end
+function GetStablePetFoodTypes(index) end

api/GetStablePetInfo.lua

@@ -1,13 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index 1 to NUM_PET_STABLE_SLOTS 
+---@param index number
----@param 0  
+---@return string icon
----@param 1 to NUM_PET_STABLE_SLOTS  
+---@return string name
----@return string icon 
+---@return number level
----@return string name 
+---@return string family
----@return number level 
+---@return string talent
----@return string family 
----@return string talent 
 ---Returns information about a stabled pet
-function GetStablePetInfo(index, 0, 1 to NUM_PET_STABLE_SLOTS) end
+function GetStablePetInfo(index) end

api/GetTalentLink.lua

@@ -1,14 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param tabIndex number 
+---@param tabIndex number
----@param talentIndex number 
+---@param talentIndex number
----@param inspect boolean 
+---@param inspect boolean
----@param pet boolean 
+---@param pet boolean
----@param talentGroup nil 
+---@param talentGroup talentGroup
----@param 1  
+---@return string link
----@param 2  
----@param nil  
----@return string link 
 ---Returns a hyperlink for a talent
-function GetTalentLink(tabIndex, talentIndex, inspect, pet, talentGroup, 1, 2, nil) end
+function GetTalentLink(tabIndex, talentIndex, inspect, pet, talentGroup) end

api/GetTotemInfo.lua

@@ -1,15 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 4 
+---@param slot totemSlot
----@param 1  
+---@return boolean haveTotem
----@param 2  
+---@return string name
----@param 3  
+---@return number startTime
----@param 4  
+---@return number duration
----@return boolean haveTotem 
+---@return string icon
----@return string name 
----@return number startTime 
----@return number duration 
----@return string icon 
 ---Returns information on a currently active totem (or ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent), for druids' wild mushrooms, and Affliction Warlock's Soul Effigy.
-function GetTotemInfo(slot, 1, 2, 3, 4) end
+function GetTotemInfo(slot) end

api/GetTotemTimeLeft.lua

@@ -1,11 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 4 
+---@param slot totemSlot
----@param 1  
+---@return number seconds
----@param 2  
----@param 3  
----@param 4  
----@return number seconds 
 ---Returns the time remaining before a totem (or ghoul) automatically disappears. Using GetTime() and the third and fourth returns (startTime and duration) of GetTotemInfo() instead of this function is recommended if frequent updates are needed. Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent).
-function GetTotemTimeLeft(slot, 1, 2, 3, 4) end
+function GetTotemTimeLeft(slot) end

api/GetWorldPVPAreaInfo.lua

@@ -1,14 +1,16 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param pvpMapID 2 
+---@alias pvpMapID
----@param 1  
+---| 1 - Wintergrasp
----@param 2  
+---| 2 - Tol Barad
----@return number pvpID 
+
----@return string localizedName 
+---@param pvpMapID pvpMapID
----@return boolean isActive 
+---@return number pvpID
----@return boolean canQueue 
+---@return string localizedName
----@return number waitTime 
+---@return boolean isActive
----@return boolean canEnter 
+---@return boolean canQueue
+---@return number waitTime
+---@return boolean canEnter
 ---Returns information about a given world PvP zone
-function GetWorldPVPAreaInfo(pvpMapID, 1, 2) end
+function GetWorldPVPAreaInfo(pvpMapID) end

api/GuildControlSetRankFlag.lua

@@ -1,23 +1,25 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index 17 
+---@alias guildControlRankFlag
----@param 1  
+---| 1 - Guildchat listen
----@param 2  
+---| 2 - Guildchat speak
----@param 3  
+---| 3 - Officerchat listen
----@param 4  
+---| 4 - Officerchat speak
----@param 5  
+---| 5 - Promote
----@param 6  
+---| 6 - Demote
----@param 7  
+---| 7 - Invite Member
----@param 8  
+---| 8 - Remove Member
----@param 9  
+---| 9 - Set MOTD
----@param 10  
+---| 10 - Edit Public Notes
----@param 11  
+---| 11 - View Officer Note
----@param 12  
+---| 12 - Edit Officer Note
----@param 13  
+---| 13 - Modify Guild Info
----@param 15  
+---| 15 - Use guild funds for repairs
----@param 16  
+---| 16 - Withdraw gold from the guild bank
----@param 17  
+---| 17 - Create Guild Event
----@param enabled boolean 
+
+---@param index guildControlRankFlag
+---@param enabled boolean
 ---Enables or disables a privilege for the guild rank being edited. Changes are not saved until a call is made to GuildControlSaveRank().
-function GuildControlSetRankFlag(index, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, enabled) end
+function GuildControlSetRankFlag(index, enabled) end

api/IsMouseButtonDown.lua

@@ -1,12 +1,14 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param button 5 or Button5 
+---@alias mouseButton
----@param 1 or LeftButton  
+---| 1 or "LeftButton" - Primary mouse button
----@param 2 or RightButton  
+---| 2 or "RightButton" - Secondary mouse button
----@param 3 or MiddleButton  
+---| 3 or "MiddleButton" - Third mouse button (or clickable scroll control)
----@param 4 or Button4  
+---| 4 or "Button4" - Fourth mouse button
----@param 5 or Button5  
+---| 5 or "Button5" - Fifth mouse button
----@return 1nil isDown 
+
+---@param button mouseButton
+---@return boolean isDown
 ---Returns whether a given mouse button is held down. If no button is specified, returns 1 if any mouse button is held down.
-function IsMouseButtonDown(button, 1 or LeftButton, 2 or RightButton, 3 or MiddleButton, 4 or Button4, 5 or Button5) end
+function IsMouseButtonDown(button) end

api/KBArticle_BeginLoading.lua

@@ -1,9 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param articleId number 
+---@alias searchType
----@param searchType 2 
+---| 1 - Default "top issues" search
----@param 1  
+---| 2 - Search for specific text
----@param 2  
+
+---@param articleId number
+---@param searchType searchType
 ---Requests a specific knowledge base article from the server
-function KBArticle_BeginLoading(articleId, searchType, 1, 2) end
+function KBArticle_BeginLoading(articleId, searchType) end

api/LearnTalent.lua

@@ -1,12 +1,14 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param tabIndex number 
+---@alias talentGroup
----@param talentIndex number 
+---| 1 - Primary Talents
----@param isPet boolean 
+---| 2 - Secondary Talents
----@param talentGroup nil 
+---| nil - Currently active talents
----@param 1  
+
----@param 2  
+---@param tabIndex number
----@param nil  
+---@param talentIndex number
+---@param isPet boolean
+---@param talentGroup talentGroup
 ---Learns a talent, spending one talent point
-function LearnTalent(tabIndex, talentIndex, isPet, talentGroup, 1, 2, nil) end
+function LearnTalent(tabIndex, talentIndex, isPet, talentGroup) end

api/LoadBindings.lua

@@ -1,9 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param set 2 
+---@alias bindingSet
----@param 0  
+---| 0 - Default key bindings
----@param 1  
+---| 1 - Account-wide key bindings
----@param 2  
+---| 2 - Character-specific key bindings
+
+---@param set bindingSet
 ---Loads a set of key bindings. The UPDATE_BINDINGS event fires when the new bindings have taken effect.
-function LoadBindings(set, 0, 1, 2) end
+function LoadBindings(set) end

api/MovieRecording_IsCodecSupported.lua

@@ -1,11 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param codecID 1836070006 
+---@alias codecID
----@param 1635148593  
+---| 1635148593 - H.264 - supported natively by Apple devices like the iPod, iPhone and AppleTV; best ratio quality/size but slowest to compress
----@param 1768124260  
+---| 1768124260 - Apple Intermediate Codec - fastest to compress, but exclusive to Mac OS X
----@param 1835692129  
+---| 1835692129 - Motion JPEG - faster to compress than H.264 but it will generate a bigger file
----@param 1836070006  
+---| 1836070006 - MPEG-4 - supported by many digital cameras and iMovie
----@return boolean isSupported 
+
+---@param codecID codecID
+---@return boolean isSupported
 ---Returns whether a video codec is supported on the current system
-function MovieRecording_IsCodecSupported(codecID, 1635148593, 1768124260, 1835692129, 1836070006) end
+function MovieRecording_IsCodecSupported(codecID) end

api/PickupStablePet.lua

@@ -1,8 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index 1 to NUM_PET_STABLE_SLOTS 
+---@param index number #0 for active pet otherwise 1 to NUM_PET_STABLE_SLOTS
----@param 0  
----@param 1 to NUM_PET_STABLE_SLOTS  
 ---Puts a pet from the stables onto the cursor. Use with ClickStablePet to move pets between stabled and active status.
-function PickupStablePet(index, 0, 1 to NUM_PET_STABLE_SLOTS) end
+function PickupStablePet(index) end

api/RespondInstanceLock.lua

@@ -1,8 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param response true 
+---@param response boolean
----@param false  
+---Allows leaving a recently entered instance to which the player would otherwise be saved. Applies when the player enters an instance to which other members of her group are saved; if the player leaves the within the time limit (see GetInstanceLockTimeRemaining()) she will not be saved to the instance.
----@param true  
+function RespondInstanceLock(response) end
----Allows leaving a recently entered instance to which the player would otherwise be saved.    Applies when the player enters an instance to which other members of her group are saved; if the player leaves the within the time limit (see GetInstanceLockTimeRemaining()) she will not be saved to the instance.
-function RespondInstanceLock(response, false, true) end

api/RollOnLoot.lua

@@ -1,11 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param id number 
+---@alias rollType number
----@param rollType 3 
+---| 0 - Pass (declines the loot)
----@param 0  
+---| 1 - Roll "need" (wins if highest roll)
----@param 1  
+---| 2 - Roll "greed" (wins if highest roll and no other member rolls "need")
----@param 2  
+---| 3 - Disenchant
----@param 3  
+
+---@param id number
+---@param rollType rollType
 ---Register the player's intent regarding an item up for loot rolling. Rolls are not actually performed until all eligible group members have registered their intent or the time period for rolling expires. If the item binds on pickup, the CONFIRM_LOOT_ROLL event fires, indicating that ConfirmLootRoll(id) must be called in order to actually roll on the item.
-function RollOnLoot(id, rollType, 0, 1, 2, 3) end
+function RollOnLoot(id, rollType) end

api/RunMacro.lua

@@ -1,8 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index number 
+---@param index number
----@param name string 
+---@param name string
----@param "button" string 
+---@param button string
 ---Runs a macro
-function RunMacro(index, name, "button") end
+function RunMacro(index, name, button) end

api/RunMacroText.lua

@@ -1,7 +1,7 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param "text" string 
+---@param text string
----@param "button" string 
+---@param button string
 ---Runs arbitrary text as a macro
-function RunMacroText("text", "button") end
+function RunMacroText(text, button) end

api/SetBattlefieldScoreFaction.lua

@@ -1,9 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param faction nil 
+---@alias battlegroundFaction
----@param 0  
+---| 0 - Horde
----@param 1  
+---| 1 - Alliance
----@param nil  
+---| nil - All
+
+---@param faction battlegroundFaction
 ---Filters the battleground scoreboard by faction/team
-function SetBattlefieldScoreFaction(faction, 0, 1, nil) end
+function SetBattlefieldScoreFaction(faction) end

api/SetGuildBankTabPermissions.lua

@@ -1,10 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param tab number 
+---@alias guildBankTab
----@param permission 2 
+---| 1 - View tab
----@param 1  
+---| 2 - Deposit items
----@param 2  
+
----@param enabled boolean 
+---@param tab guildBankTab
+---@param permission guildBankTab
+---@param enabled boolean
 ---Changes guild bank tab permissions for the guild rank being edited
-function SetGuildBankTabPermissions(tab, permission, 1, 2, enabled) end
+function SetGuildBankTabPermissions(tab, permission, enabled) end

api/SetMapZoom.lua

@@ -1,16 +1,18 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param continentIndex 7 
+---@alias continentIndex
----@param -1  
+---| -1 - Cosmic map
----@param 0  
+---| 0 - Entire Azeroth map
----@param 1  
+---| 1 - Kalimdor
----@param 2  
+---| 2 - Eastern Kingdoms
----@param 3  
+---| 3 - Outland
----@param 4  
+---| 4 - Northrend
----@param 5  
+---| 5 - The Maelstrom
----@param 6  
+---| 6 - Pandaria
----@param 7  
+---| 7 - Draenor
----@param zoneIndex number 
+
+---@param continentIndex continentIndex
+---@param zoneIndex number
 ---Sets the world map to show a specific zone or continent
-function SetMapZoom(continentIndex, -1, 0, 1, 2, 3, 4, 5, 6, 7, zoneIndex) end
+function SetMapZoom(continentIndex, zoneIndex) end

api/SetNextBarberShopStyle.lua

@@ -1,10 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param styleIndex 3 
+---@alias barberShopStyleIndex
----@param 1  
+---| 1 - Hair (or Horn) Style
----@param 2  
+---| 2 - Hair (or Horn) Color
----@param 3  
+---| 3 - Varies by race and gender: Facial Hair, Earrings, Features, Hair, Horns, Markings, Normal, Piercings, or Tusks
----@param reverse boolean 
+
+---@param styleIndex barberShopStyleIndex
+---@param reverse boolean
 ---Selects the next style for a barber shop style option. Changes the underlying data (and thus the character's appearance) only; the default barbershop UI does not update.
-function SetNextBarberShopStyle(styleIndex, 1, 2, 3, reverse) end
+function SetNextBarberShopStyle(styleIndex, reverse) end

api/SetRaidTarget.lua

@@ -1,17 +1,19 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param unit string 
+---@alias raidTargetIndex
----@param name string 
+---| 0 - Clear any raid target markers
----@param index 8 
+---| 1 - Star
----@param 0  
+---| 2 - Circle
----@param 1  
+---| 3 - Diamond
----@param 2  
+---| 4 - Triangle
----@param 3  
+---| 5 - Moon
----@param 4  
+---| 6 - Square
----@param 5  
+---| 7 - Cross
----@param 6  
+---| 8 - Skull
----@param 7  
+
----@param 8  
+---@param unit string
+---@param name string
+---@param index raidTargetIndex
 ---Puts a raid target marker on a unit
-function SetRaidTarget(unit, name, index, 0, 1, 2, 3, 4, 5, 6, 7, 8) end
+function SetRaidTarget(unit, name, index) end

api/StartAuction.lua

@@ -1,13 +1,10 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param minBid number 
+---@param minBid number
----@param buyoutPrice number 
+---@param buyoutPrice number
----@param runTime 3 
+---@param runTime auctionRunTime
----@param 1  
+---@param stackSize number
----@param 2  
+---@param numStacks number
----@param 3  
----@param stackSize number 
----@param numStacks number 
 ---Creates an auction for the item currently in the "auction item" slot. Has no effect unless an item has been placed in the Create Auction UI's "auction item" slot (see ClickAuctionSellItemButton()). With patch 3.3.3 the runTime arg was changed from minutes to an index and the stackSize/numStacks args were added for batch posting.
-function StartAuction(minBid, buyoutPrice, runTime, 1, 2, 3, stackSize, numStacks) end
+function StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks) end

api/TargetTotem.lua

@@ -1,10 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param slot 4 
+---@alias totemSlot
----@param 1  
+---| 1 - Fire (or Death Knight's ghoul)
----@param 2  
+---| 2 - Earth
----@param 3  
+---| 3 - Water
----@param 4  
+---| 4 - Air
+
+---@param slot totemSlot
 ---Targets one of the player's totems (or a Death Knight's ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent).
-function TargetTotem(slot, 1, 2, 3, 4) end
+function TargetTotem(slot) end

api/UnitResistance.lua

@@ -1,16 +1,18 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param unit string 
+---@alias resistanceIndex
----@param resistanceIndex 5 
+---| 1 - Fire
----@param 1  
+---| 2 - Nature
----@param 2  
+---| 3 - Frost
----@param 3  
+---| 4 - Shadow
----@param 4  
+---| 5 - Arcane
----@param 5  
+
----@return number base 
+---@param unit string
----@return number resistance 
+---@param resistanceIndex resistanceIndex
----@return number positive 
+---@return number base
----@return number negative 
+---@return number resistance
+---@return number positive
+---@return number negative
 ---Returns information about the player's or pet's magic resistance
-function UnitResistance(unit, resistanceIndex, 1, 2, 3, 4, 5) end
+function UnitResistance(unit, resistanceIndex) end

api/UnitStat.lua

@@ -1,16 +1,18 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param unit string 
+---@alias statIndex
----@param statIndex 5 
+---| 1 - Strength
----@param 1  
+---| 2 - Agility
----@param 2  
+---| 3 - Stamina
----@param 3  
+---| 4 - Intellect
----@param 4  
+---| 5 - Spirit
----@param 5  
+
----@return number stat 
+---@param unit string
----@return number effectiveStat 
+---@param statIndex statIndex
----@return number posBuff 
+---@return number stat
----@return number negBuff 
+---@return number effectiveStat
+---@return number posBuff
+---@return number negBuff
 ---Returns information about a basic character statistic for the player or pet
-function UnitStat(unit, statIndex, 1, 2, 3, 4, 5) end
+function UnitStat(unit, statIndex) end

api/securecall.lua

@@ -1,8 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param function function 
+---@param func function
----@param ... list 
+---@param ... any
----@return list ... 
+---@return ... any
 ---Calls a function without tainting the execution path. Meaningless when called from outside of the secure environment. Used in Blizzard code to call functions which may be tainted or operate on potentially tainted variables. For example, consider the function CloseSpecialWindows, which iterates through the table UISpecialFrames and hides any frames named therein. Addon authors may put the names of their frames in that table to make them automatically close when the user presses the ESC key, but this taints UISpecialFrames. Were the default UI to then call CloseSpecialWindows normally, every frame in UISpecialFrames would become tainted, which could later lead to errors when handlers on those frames call protected functions. Instead, the default UI uses securecall(CloseSpecialWindows): within CloseSpecialWindows the execution path may become tainted, but afterward the environment remains secure.
-function securecall(function, ...) end
+function securecall(func, ...) end

api/select.lua

@@ -1,9 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param index number 
+---@param index number|"#"
----@param # string 
+---@param ... any
----@param ... list 
+---@return ... any
----@return list ... 
+---Returns one or more values from a list (...) (if using index), or the number of values in a list (if using #)
----Returns one or more values from a list (...), or the number of values in a list
+function select(index, ...) end
-function select(index, #, ...) end