Files
wow_Meta/api/GetAutoCompleteResults.lua

30 lines
1.9 KiB
Lua

---@diagnostic disable: missing-return, lowercase-global
---@meta
---@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, excludeBitfield, maxResults, cursorPosition) end