WoW API: GetLFGQueueStats

From AddOn Studio
Revision as of 04:46, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API GetLFGQueueStats to API GetLFGQueueStats without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WoW API < GetLFGQueueStats

Returns the current state and wait times for being in queue.

 hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds,
   totalTanks, totalHealers, totalDPS, instanceType, instanceSubType,
   instanceName, averageWait, tankWait, healerWait, damageWait,
   myWait, queuedTime, activeID = GetLFGQueueStats(lfgType[, lfgID])

Arguments

lfgType
lfgCategoryType [LE_LFG_CATEGORY_LFD, LE_LFG_CATEGORY_LFR, LE_LFG_CATEGORY_RF, LE_LFG_CATEGORY_SCENARIO, LE_LFG_CATEGORY_FLEXRAID, LE_LFG_CATEGORY_WORLDPVP] - depending on which type of LFG you're looking for.
lfgID
(Optional) specific LFG 'forming group' ID

Returns

hasData
Boolean - indicates if you are in queue
leaderNeeds
Boolean - if group still needs a leader designated
tankNeeds
number - count of tanks still needed
healerNeeds
number - count of healers still needed
dpsNeeds
number - count of DPS still needed
totalTanks
number - count of total tanks required
totalHealers
number - count of total healers required
totalDPS
number - count of total DPS required
instanceType
number - unknown relation
instanceSubType
number - unknown relation
instanceName
string - as selected in LFD Finder
averageWait
number - average wait for an entire group to be assembled
tankWait
number - average wait time for queuing Tanks
healerWait
number - average wait time for queuing Healers
damageWait
number - average wait time for queuing DPS'ers
myWait
number - predicted wait time for you
queuedTime
number - appears to be the absolute time of when the queue began. Use against GetTime()
activeID
unknown - possibly not used, shows in UI code as a default lfgID/activeID for a given lfgCategoryType

Related Events

Changes