Refactor API functions to standardize parameter aliases and improve documentation clarity
This commit is contained in:
@@ -2,9 +2,6 @@
|
|||||||
---@meta
|
---@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.
|
---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
|
||||||
|
@@ -2,10 +2,7 @@
|
|||||||
---@meta
|
---@meta
|
||||||
|
|
||||||
---@param name string
|
---@param name string
|
||||||
---@param gender 3
|
---@param gender gender
|
||||||
---@param 1or nil
|
|
||||||
---@param 2
|
|
||||||
---@param 3
|
|
||||||
---@param declensionSet number
|
---@param declensionSet number
|
||||||
---@return string genitive
|
---@return string genitive
|
||||||
---@return string dative
|
---@return string dative
|
||||||
@@ -13,4 +10,4 @@
|
|||||||
---@return string instrumental
|
---@return string instrumental
|
||||||
---@return string prepositional
|
---@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.
|
---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
|
||||||
|
@@ -1,10 +1,6 @@
|
|||||||
---@diagnostic disable: missing-return, lowercase-global
|
---@diagnostic disable: missing-return, lowercase-global
|
||||||
---@meta
|
---@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).
|
---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
|
||||||
|
@@ -2,6 +2,6 @@
|
|||||||
---@meta
|
---@meta
|
||||||
|
|
||||||
---@param index number
|
---@param index number
|
||||||
---@param repeat number
|
---@param repeatn number
|
||||||
---Performs a trade skill recipe
|
---Performs a trade skill recipe
|
||||||
function DoTradeSkill(index, repeat) end
|
function DoTradeSkill(index, repeatn) end
|
||||||
|
@@ -1,17 +1,6 @@
|
|||||||
---@diagnostic disable: missing-return, lowercase-global
|
---@diagnostic disable: missing-return, lowercase-global
|
||||||
---@meta
|
---@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.
|
---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
|
||||||
|
@@ -1,13 +1,8 @@
|
|||||||
---@diagnostic disable: missing-return, lowercase-global
|
---@diagnostic disable: missing-return, lowercase-global
|
||||||
---@meta
|
---@meta
|
||||||
|
|
||||||
---@param statIndex 5
|
---@param statIndex statIndex
|
||||||
---@param 1
|
|
||||||
---@param 2
|
|
||||||
---@param 3
|
|
||||||
---@param 4
|
|
||||||
---@param 5
|
|
||||||
---@param effectiveStat number
|
---@param effectiveStat number
|
||||||
---@return number attackPower
|
---@return number attackPower
|
||||||
---Returns the attack power bonus provided by one of the player's basic statistics
|
---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
|
||||||
|
@@ -1,15 +1,15 @@
|
|||||||
---@diagnostic disable: missing-return, lowercase-global
|
---@diagnostic disable: missing-return, lowercase-global
|
||||||
---@meta
|
---@meta
|
||||||
|
|
||||||
|
---@alias subClassIndex
|
||||||
|
---| 1 - Miscellaneous
|
||||||
|
---| 2 - Cloth
|
||||||
|
---| 3 - Leather
|
||||||
|
---| 4 - Mail
|
||||||
|
---| 5 - Plate
|
||||||
|
|
||||||
---@param classIndex number
|
---@param classIndex number
|
||||||
---@param subClassIndex 5
|
---@param subClassIndex subClassIndex
|
||||||
---@param 1
|
---@return (string|boolean)[] #Pairs of token-display, try use {} to cram into table
|
||||||
---@param 2
|
|
||||||
---@param 3
|
|
||||||
---@param 4
|
|
||||||
---@param 5
|
|
||||||
---@return string token
|
|
||||||
---@return 1nil display
|
|
||||||
---@return list ...
|
|
||||||
---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.
|
---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
|
||||||
|
Reference in New Issue
Block a user