dave/wow_Meta
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor API functions to improve parameter aliasing and enhance documentation clarity

Browse Source
This commit is contained in:
PhatPhuckDave
2025-05-18 15:12:37 +02:00
parent cbed6108ef
commit b5cba11bd3
10 changed files with 95 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
api/GetAutoCompleteResults.lua
View File

@@ -1,25 +1,29 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param inputString string
---@param includeBitfield AUTOCOMPLETE_FLAG_ALL
---@param 0x00000000 AUTOCOMPLETE_FLAG_NONE
---@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP
---@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD
---@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND
---@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH
---@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE
---@param 0xffffffff AUTOCOMPLETE_FLAG_ALL
---@param excludeBitfield AUTOCOMPLETE_FLAG_ALL
---@param 0x00000000 AUTOCOMPLETE_FLAG_NONE
---@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP
---@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD
---@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND
---@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH
---@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE
---@param 0xffffffff AUTOCOMPLETE_FLAG_ALL
---@param maxResults number
---@param cursorPosition number
---@return list ...
---@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)
---| 0x00000000 - AUTOCOMPLETE_FLAG_NONE: No characters
---| 0x00000001 - AUTOCOMPLETE_FLAG_IN_GROUP: Characters in the player's party or raid
---| 0x00000002 - AUTOCOMPLETE_FLAG_IN_GUILD: Characters in the player's guild
---| 0x00000004 - AUTOCOMPLETE_FLAG_FRIEND: Characters from the player's friends list
---| 0x00000010 - AUTOCOMPLETE_FLAG_INTERACTED_WITH: Characters with whom the player has recently interacted
---| 0x00000020 - AUTOCOMPLETE_FLAG_ONLINE: Currently online friends and guildmates
---| 0xffffffff - AUTOCOMPLETE_FLAG_ALL: All characters
---@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)
---| 0x00000000 - AUTOCOMPLETE_FLAG_NONE: No characters
---| 0x00000001 - AUTOCOMPLETE_FLAG_IN_GROUP: Characters in the player's party or raid
---| 0x00000002 - AUTOCOMPLETE_FLAG_IN_GUILD: Characters in the player's guild
---| 0x00000004 - AUTOCOMPLETE_FLAG_FRIEND: Characters from the player's friends list
---| 0x00000010 - AUTOCOMPLETE_FLAG_INTERACTED_WITH: Characters with whom the player has recently interacted
---| 0x00000020 - AUTOCOMPLETE_FLAG_ONLINE: Currently online friends and guildmates
---| 0xffffffff - AUTOCOMPLETE_FLAG_ALL: All characters
---@param inputString string
---@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