Refactor API functions to standardize parameter aliases and improve documentation clarity

This commit is contained in:
2025-05-18 15:16:22 +02:00
parent b5cba11bd3
commit e0b57e39fc
7 changed files with 34 additions and 60 deletions

View File

@@ -1,15 +1,15 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param classIndex number
---@param subClassIndex 5
---@param 1
---@param 2
---@param 3
---@param 4
---@param 5
---@return string token
---@return 1nil display
---@return list ...
---@alias subClassIndex
---| 1 - Miscellaneous
---| 2 - Cloth
---| 3 - Leather
---| 4 - Mail
---| 5 - Plate
---@param classIndex number
---@param subClassIndex subClassIndex
---@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