Refactor API functions to improve parameter aliasing and enhance documentation clarity
This commit is contained in:
@@ -1,17 +1,21 @@
|
||||
---@diagnostic disable: missing-return, lowercase-global
|
||||
---@meta
|
||||
|
||||
---@param slot 6
|
||||
---@param 1
|
||||
---@param 2
|
||||
---@param 3
|
||||
---@param 4
|
||||
---@param 5
|
||||
---@param 6
|
||||
---@return 4 runeType
|
||||
---@return 1
|
||||
---@return 2
|
||||
---@return 3
|
||||
---@return 4
|
||||
---@alias runeSlot
|
||||
---| 1 - Leftmost
|
||||
---| 2 - Second from left
|
||||
---| 3 - Fifth from left (second from right)
|
||||
---| 4 - Sixth from left (rightmost)
|
||||
---| 5 - Third from left
|
||||
---| 6 - Fourth from left
|
||||
|
||||
---@alias runeType
|
||||
---| 1 - Blood rune
|
||||
---| 2 - Unholy rune
|
||||
---| 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
|
||||
|
||||
Reference in New Issue
Block a user