WoW:API LFGQuery: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Removed really out of date commentary)
({{removedapi|3.3}})
Line 1: Line 1:
{{wowapi}}__NOTOC__
{{wowapi}}__NOTOC__ {{removedapi|3.3}}
Find all players who are looking for a group for a specified objective
Find all players who are looking for a group for a specified objective
  LFGQuery(category, objective[, class])
  LFGQuery(category, objective[, class])

Revision as of 00:19, 21 March 2010

WoW API < LFGQuery

Find all players who are looking for a group for a specified objective

LFGQuery(category, objective[, class])

Takes

Number category
Must be the index of one of the values retrieved with GetLFGTypes()
Number objective
Must be the index of one of the values retrieved with GetLFGTypeEntries(category)
Number class (optional)
You can probably specify which character class you are searching for (priest, warrior, druid, etc.), but exact usage is unknown

Returns

Nothing

Events

Triggers UPDATE_LFG_LIST
Triggered as soon as query results become available (works, tested on Live client - Dec 27, 2006)

Details

Use GetNumLFGResults() to retrieve the number of results and then iterate over them with GetLFGResults(index).
Reqires a hardware event for each call to the API, so it should be called from related script handlers such as OnClick. (tested on Live client - Dec 28, 2008)