Navigation menu

WoW:API GetAutoCompleteResults: Difference between revisions

Jump to navigation Jump to search

WoW:API GetAutoCompleteResults (source)

Revision as of 16:33, 8 August 2009

271 bytes removed ,  8 August 2009
no edit summary
(Create page)
 
No edit summary
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 ==
Retrieved from "https://addonstudio.org/wiki/Special:MobileDiff/19333"