WoW API: GetAutoCompleteResults

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetAutoCompleteResults

Returns possible player names matching a given prefix string and specified requirements.

nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults[, cursorPosition]);

Arguments

text

String - first characters of the possible names to be autocompleted

include

Number - bit mask of filters that the results must match at least one of.

exclude

Number - bit mask of filters that the results must not match any of.

maxResults

Number - number of results desired.

cursorPosition

Number - position of the cursor within the editbox (i.e. how much of the text string should be matching).

Filter values

The two bit mask parameters can be composed from the following components:

Global constant name	Value	Matches
AUTOCOMPLETE_FLAG_NONE	0x00000000	No one
AUTOCOMPLETE_FLAG_IN_GROUP	0x00000001	?
AUTOCOMPLETE_FLAG_IN_GUILD	0x00000002	?
AUTOCOMPLETE_FLAG_FRIEND	0x00000004	Players on your friends list
AUTOCOMPLETE_FLAG_INTERACTED_WITH	0x00000010	?
AUTOCOMPLETE_FLAG_ONLINE	0x00000020	Currently online players
AUTOCOMPLETE_FLAG_ALL	0xffffffff	Anyone

Returns

nick1, nick2, ...

String - auto-completed name of a player that satisfies the requirements.

Example

Assuming you are sending a mail to someone whose name starts with "a", and that the Send Mail window is open

GetAutoCompleteResults("a",
                       SendMailNameEditBox.autoCompleteParams.include,
                       SendMailNameEditBox.autoCompleteParams.exclude,
                       AUTOCOMPLETE_MAX_BUTTONS+1,
                       SendMailNameEditBox:GetCursorPosition())