WoW:API GetLFGQueueStats: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(OnPageCreate)
 
No edit summary
Line 3: Line 3:
Returns the current state and wait times for being in queue.
Returns the current state and wait times for being in queue.


     hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait,  
     hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait,
           tankWait, healerWait, damageWait, myWait = GetLFGQueueStats()
           tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats()


== Returns ==
== Returns ==
Line 19: Line 19:
;damageWait : number - average wait time for queuing DPS'ers
;damageWait : number - average wait time for queuing DPS'ers
;myWait : number - predicted wait time for you
;myWait : number - predicted wait time for you
;queuedTime : number - appears to be the absolute time of when the queue began.  Use against [[API GetTime|GetTime]]()


== Related Events ==
== Related Events ==
<!-- If this function triggers an event, name it here. If not, remove the entire section. -->
<!-- If this function triggers an event, name it here. If not, remove the entire section. -->
* "[[Events/L#WLFG_QUEUE_STATUS_UPDATE|LFG_QUEUE_STATUS_UPDATE]]", new data available with this event
* "[[Events/L#WLFG_QUEUE_STATUS_UPDATE|LFG_QUEUE_STATUS_UPDATE]]", new data available with this event

Revision as of 22:57, 26 May 2010

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()

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