WoW:API GetAutoCompleteResults - Revision history

Move page script: Move page script moved page API GetAutoCompleteResults to WoW:API GetAutoCompleteResults without leaving a redirect

2023-08-15T04:45:43Z

Move page script moved page API GetAutoCompleteResults to API GetAutoCompleteResults without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Speeddymon at 16:59, 8 August 2009

2009-08-08T16:59:49Z

← Older revision		Revision as of 16:59, 8 August 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	Returns possible player names matching a given prefix string and specified requirements.		Returns possible player names matching a given prefix string and specified requirements.
	nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults, cursorPosition);		nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults[, cursorPosition]);

	== Arguments ==		== Arguments ==

WoWWiki>Starlightblunder: /* Returns */

2009-08-08T16:50:56Z

Returns

← Older revision		Revision as of 16:50, 8 August 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	~~Gets the results of the built-in autocomplete, based on the text currently entered into an editbox~~.		Returns possible player names matching a given prefix string and specified requirements.
	nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults, cursorPosition);		nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults, cursorPosition);

	== Arguments ==		== Arguments ==
	;text: String - first characters of the possible names to be autocompleted		;text: String - first characters of the possible names to be autocompleted
	;include: ~~Numeric~~ - ~~arbitrary value assigned by Blizzard based on~~ the ~~type~~ of ~~editbox, as to what type of names to include~~		;include: Number - bit mask of [[#Filter values\|filters]] that the results '''must''' match at least one of.
	;exclude: ~~Numeric~~ - ~~arbitrary value assigned by Blizzard based on~~ the ~~type~~ of ~~editbox, as to what type of names to exclude~~		;exclude: Number - bit mask of [[#Filter values\|filters]] that the results '''must not''' match any of.
	;maxResults: - ~~Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown.~~		;maxResults: Number - number of results desired.
	~~Note: Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown~~.		;cursorPosition: Number - position of the cursor within the editbox (i.e. how much of the text string should be matching).
	;cursorPosition: ~~- Numeric~~ - position of the cursor within the editbox.
	~~Note~~: ~~Can usually be obtained by [[API EditBox GetCursorPosition~~\|~~EditBox~~:~~GetCursorPosition]]()~~		=== Filter values ===
			The two bit mask parameters can be composed from the following components:
			{\| class="darktable" style="margin-left: 3em"
			! 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 ==		== Returns ==
	; nick1, nick2, ... : String - a ~~list of names matching~~ the ~~autocompletion request~~.		; nick1, nick2, ... : String - auto-completed name of a player that satisfies the requirements.

	== Example ==		== Example ==

WoWWiki>Speeddymon: /* Arguments */

2009-08-08T16:34:32Z

Arguments

← Older revision		Revision as of 16:34, 8 August 2009
Line 7:		Line 7:
	;include: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to include		;include: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to include
	;exclude: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to exclude		;exclude: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to exclude
	;maxResults: - Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown. Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown.		;maxResults: - Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown.
	;cursorPosition: - Numeric - position of the cursor within the editbox. Can usually be obtained by [[API EditBox GetCursorPosition\|EditBox:GetCursorPosition]]()		Note: Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown.
			;cursorPosition: - Numeric - position of the cursor within the editbox.
			Note: Can usually be obtained by [[API EditBox GetCursorPosition\|EditBox:GetCursorPosition]]()

	== Returns ==		== Returns ==

WoWWiki>Starlightblunder at 16:33, 8 August 2009

2009-08-08T16:33:23Z

← Older revision		Revision as of 16:33, 8 August 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}

	Gets the results of the built-in autocomplete, based on the text currently entered into an editbox.		Gets the results of the built-in autocomplete, based on the text currently entered into an editbox.
	GetAutoCompleteResults("text",		nick1, nick2, ... = GetAutoCompleteResults("text", include, exclude, maxResults, cursorPosition);
	~~parent.autoCompleteParams.~~include,
	~~parent.autoCompleteParams.~~exclude,
	~~AUTOCOMPLETE_MAX_BUTTONS+1~~,
	cursorPosition);

	~~== Parameters ==~~

	~~<big>'''~~Arguments~~'''</big>~~		== Arguments ==
	:~~("text"~~, ~~parent.autoCompleteParams.~~include, ~~parent~~.~~autoCompleteParams~~.~~exclude, AUTOCOMPLETE_MAX_BUTTONS+1,~~ cursorPosition)		;text: String - first characters of the possible names to be autocompleted
			;include: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to include
			;exclude: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to exclude
			;maxResults: - Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown. Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown.
			;cursorPosition: - Numeric - position of the cursor within the editbox. Can usually be obtained by [[API EditBox GetCursorPosition\|EditBox:GetCursorPosition]]()

	~~:;text: String - first characters of the possible names to be autocompleted~~		== Returns ==
	:;~~parent.autoCompleteParams~~.~~include: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to include~~		; nick1, nick2, ... : String - a list of names matching the autocompletion request.
	~~:;parent~~.~~autoCompleteParams~~.~~exclude~~: ~~Numeric~~ - ~~arbitrary value assigned by Blizzard based on the type of editbox, as to what type~~ of names ~~to exclude~~
	:;AUTOCOMPLETE_MAX_BUTTONS: - Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown. Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown.
	~~:;cursorPosition: - Numeric - position of~~ the ~~cursor within the editbox~~. ~~Can usually be obtained by [[API EditBox GetCursorPosition\|EditBox:GetCursorPosition]]()~~

	== Example ==		== Example ==

WoWWiki>Speeddymon: Create page

2009-08-08T16:25:31Z

Create page

New page

{{wowapi}}

Gets the results of the built-in autocomplete, based on the text currently entered into an editbox.
GetAutoCompleteResults("text",
parent.autoCompleteParams.include,
parent.autoCompleteParams.exclude,
AUTOCOMPLETE_MAX_BUTTONS+1,
cursorPosition);

== Parameters ==

<big>'''Arguments'''</big>
:("text", parent.autoCompleteParams.include, parent.autoCompleteParams.exclude, AUTOCOMPLETE_MAX_BUTTONS+1, cursorPosition)

:;text: String - first characters of the possible names to be autocompleted
:;parent.autoCompleteParams.include: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to include
:;parent.autoCompleteParams.exclude: Numeric - arbitrary value assigned by Blizzard based on the type of editbox, as to what type of names to exclude
:;AUTOCOMPLETE_MAX_BUTTONS: - Numeric - arbitrary value assigned by Blizzard to determine how many buttons to include in the AutoComplete dropdown. Add 1 to allow for a disabled button that indicates there are more names than can be shown by the default AutoComplete dropdown.
:;cursorPosition: - Numeric - position of the cursor within the editbox. Can usually be obtained by [[API EditBox GetCursorPosition|EditBox:GetCursorPosition]]()

== 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())