WoW:API GetLFGQueueStats: Difference between revisions
Jump to navigation
Jump to search
m
Move page script moved page API GetLFGQueueStats to WoW:API GetLFGQueueStats without leaving a redirect
(Added the new required argument. Someone experienced please look this over.) |
m (Move page script moved page API GetLFGQueueStats to WoW:API GetLFGQueueStats without leaving a redirect) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| 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, | |||
totalTanks, totalHealers, totalDPS, instanceType, instanceSubType, | |||
instanceName, averageWait, tankWait, healerWait, damageWait, | |||
myWait, queuedTime, activeID = GetLFGQueueStats(lfgType[, lfgID]) | |||
== Arguments == | == Arguments == | ||
; | ;lfgType | ||
: | : {{api|lfgCategoryType|t=t}} [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 | ;lfgID | ||
: | :(Optional) specific LFG 'forming group' ID | ||
== Returns == | == Returns == | ||
| Line 17: | Line 20: | ||
: Boolean - if group still needs a leader designated | : Boolean - if group still needs a leader designated | ||
;tankNeeds | ;tankNeeds | ||
: | : number - count of tanks still needed | ||
;healerNeeds | ;healerNeeds | ||
: | : number - count of healers still needed | ||
;dpsNeeds | ;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 | ;instanceType | ||
: | : number - unknown relation | ||
;instanceSubType | |||
: number - unknown relation | |||
;instanceName | ;instanceName | ||
: | : string - as selected in LFD Finder | ||
;averageWait | ;averageWait | ||
: number - average wait for an entire group to be assembled | : number - average wait for an entire group to be assembled | ||
| Line 34: | Line 47: | ||
;damageWait | ;damageWait | ||
: number - average wait time for queuing DPS'ers | : number - average wait time for queuing DPS'ers | ||
;myWait | ;myWait | ||
: number - predicted wait time for you | : number - predicted wait time for you | ||
;queuedTime | ;queuedTime | ||
: number - appears to be the absolute time of when the queue began. Use against [[API GetTime|GetTime]]() | : number - appears to be the absolute time of when the queue began. Use against [[API GetTime|GetTime]]() | ||
;activeID | |||
: unknown - possibly not used, shows in UI code as a default lfgID/activeID for a given lfgCategoryType | |||
== Related Events == | == Related Events == | ||
| Line 44: | Line 60: | ||
== Changes == | == Changes == | ||
5.4. | * {{Patch 5.4.0|note=Now requires a lfgCategoryType (LE_LFG_CATEGORY_) argument.}} | ||