GetLFGQueueStats

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
mainline  cata  vanilla
Links
GitHub  Globe  Wowprogramming
Patch
Added in 3.3.0 / 3.4.3 / 1.15.0

Returns info for the current LFG queue.

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

Arguments

The first argument has two forms, affecting how the function behaves (see details):

category

number - Depending on which type of LFG you're looking for.

activeID

number? - Specific LFG 'forming group' ID

Returns

1. hasData

boolean - indicates if you are in queue

2. leaderNeeds

boolean - if group still needs a leader designated

3. tankNeeds

boolean - waiting for a tank

4. healerNeeds

boolean - waiting for a designated healer

5. dpsNeeds

boolean - needing more DPS'ers

6. totalTanks

number - total tanks needed for this queue

7. totalHealers

number - total healers needed for this queue

8. totalDPS

number - total DPS'ers needed for this queue

9. instanceType

number - unknown relation

10. instanceSubType

number - unknown relation

11. instanceName

string - as selected in LFD Finder

12. averageWait

number - average wait for an entire group to be assembled

13. tankWait

number - average wait time for queuing Tanks

14. healerWait

number - average wait time for queuing Healers

15. dpsWait

number - average wait time for queuing DPS'ers

16. myWait

number - predicted wait time for you

17. queuedTime

number - appears to be the absolute time of when the queue began. Use against GetTime()

18. activeID

number

Patch changes

• Patch 5.4.0 (2013-09-10): Added activeID argument/return.
  

See also

• LFG_QUEUE_STATUS_UPDATE - Indicates new data is available.