WoW:API GetLFGQueueStats: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Added the new required argument. Someone experienced please look this over.) |
||
| Line 4: | Line 4: | ||
hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait, | hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait, | ||
tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats() | 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 == | == Returns == | ||
;hasData : Boolean | ;hasData | ||
;leaderNeeds : Boolean - if group still needs a leader designated | : Boolean - indicates if you are in queue | ||
;tankNeeds : Boolean - waiting for a tank | ;leaderNeeds | ||
;healerNeeds : Boolean - waiting for a designated healer | : Boolean - if group still needs a leader designated | ||
;dpsNeeds : Boolean - needing more DPS'ers | ;tankNeeds | ||
;instanceType : Number - unknown relation | : Boolean - waiting for a tank | ||
;instanceName : String - as selected in LFD Finder | ;healerNeeds | ||
;averageWait : number - average wait for an entire group to be assembled | : Boolean - waiting for a designated healer | ||
;tankWait : number - average wait time for queuing Tanks | ;dpsNeeds | ||
;healerWait : number - average wait time for queuing Healers | : Boolean - needing more DPS'ers | ||
;damageWait : number - average wait time for queuing DPS'ers | ;instanceType | ||
;myWait : number - predicted wait time for you | : Number - unknown relation | ||
;queuedTime : number - appears to be the absolute time of when the queue began. | ;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 [[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 | ||
== Changes == | |||
5.4.?: Now requires LE_LFG_CATEGORY argument. | |||
Revision as of 15:53, 24 February 2014
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
- "LFG_QUEUE_STATUS_UPDATE", new data available with this event
Changes
5.4.?: Now requires LE_LFG_CATEGORY argument.