WoW API: GetLFGQueueStats

From AddOn Studio
Revision as of 15:53, 24 February 2014 by 111.69.78.231 (talk) (Added the new required argument. Someone experienced please look this over.)
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, instanceType, instanceName, averageWait,
         tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats(LE_LFG_CATEGORY[, lfgID])

Arguments

LE_LFG_CATEGORY
Any of LE_LFG_CATEGORY_LFD, LE_LFG_CATEGORY_LFR, LE_LFG_CATEGORY_RF depending on which type of LFG you're looking for.
lfgID
Unknown. Hope someone can fill this in.

Returns

hasData
Boolean - indicates if you are in queue
leaderNeeds
Boolean - if group still needs a leader designated
tankNeeds
Boolean - waiting for a tank
healerNeeds
Boolean - waiting for a designated healer
dpsNeeds
Boolean - needing more DPS'ers
instanceType
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()

Related Events

Changes

5.4.?: Now requires LE_LFG_CATEGORY argument.