WoW:API GetLFGResults: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(part of a API redesign proposal, please don't change the layout for the next few days)
 
m (Move page script moved page API GetLFGResults to API GetLFGResults without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{wowapi}}__NOTOC__
{{wowapi}}__NOTOC__ {{removedapi|3.3}}
Returns the results of a preceding LFG query
Returns the results of a preceding LFG query
  charname, level, class, guildname, race, zone, message = GetLFGResults(index)
  charname, level, class, guildname, race, zone, message = GetLFGResults(type, lfgIdx, index)


===Takes===
===Takes===
: Number type
:: Index of one of the returned values of call to [[API_GetLFGTypes|GetLFGTypes()]]
: Number lfgIdx
:: Index of one of the values returned from [[API_GetLFGTypeEntries|GetLFGTypeEntries(lfgtype)]] called with the same lfgtype value being used in this call
: Number index   
: Number index   
:: Index of result to return. Must be in range [1; [[API_GetNumLFGResults()|GetNumLFGResults()]]] to generate meaningful results.
:: Index of result to return. Must be in range [1; [[API_GetNumLFGResults()|GetNumLFGResults()]]] to generate meaningful results.
Line 27: Line 31:


===Details===
===Details===
: The details on the returned values are unreliable, as this documentation has been derived from analysis of the function and for the reasons stated below never actually has been tested.
{{User:Zelgadis/LFG_notice}}

Latest revision as of 04:46, 15 August 2023

WoW API < GetLFGResults

Returns the results of a preceding LFG query

charname, level, class, guildname, race, zone, message = GetLFGResults(type, lfgIdx, index)

Takes[edit]

Number type
Index of one of the returned values of call to GetLFGTypes()
Number lfgIdx
Index of one of the values returned from GetLFGTypeEntries(lfgtype) called with the same lfgtype value being used in this call
Number index
Index of result to return. Must be in range [1; GetNumLFGResults()] to generate meaningful results.

Returns[edit]

String charname
Name of the character
Number level
Level of the character
String class
Class of the character
String guildname
Name of the guild the character belongs to
String race
Race of the character
String zone
Zone the character was in at query time
String message
A message the player provided when flagging himself as LFG with SetLookingForGroup()

Events[edit]

Needs UPDATE_LFG

Details[edit]