WoW:API GetLFGQueueStats: Difference between revisions

← Older edit

WoW:API GetLFGQueueStats (source)

Revision as of 04:46, 15 August 2023

806 bytes added , 15 August 2023

m

Move page script moved page API GetLFGQueueStats to WoW:API GetLFGQueueStats without leaving a redirect

Anonymous user

Move page script

@@ Line 3: / Line 3: @@
 Returns the current state and wait times for being in queue.
-     hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait,
+  hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds,
-          tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats()
+    totalTanks, totalHealers, totalDPS, instanceType, instanceSubType,
+    instanceName, averageWait, tankWait, healerWait, damageWait,
+    myWait, queuedTime, activeID = GetLFGQueueStats(lfgType[, lfgID])
+== 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
+:(Optional) specific LFG 'forming group' ID
 == Returns ==
-;hasData : Boolean  - indicates if you are in queue
+;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
+: number - count of tanks still needed
-;instanceName : String - as selected in LFD Finder
+;healerNeeds
-;averageWait : number - average wait for an entire group to be assembled
+: number - count of healers still needed
-;tankWait : number - average wait time for queuing Tanks
+;dpsNeeds
-;healerWait : number - average wait time for queuing Healers
+: number - count of DPS still needed
-;damageWait : number - average wait time for queuing DPS'ers
-;myWait : number - predicted wait time for you
+;totalTanks
-;queuedTime : number - appears to be the absolute time of when the queue began.  Use against [[API GetTime|GetTime]]()
+: number - count of total tanks required
+;totalHealers
+: number - count of total healers required
+;totalDPS
+: number - count of total DPS required
+;instanceType
+: number - unknown relation
+;instanceSubType
+: 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 [[API GetTime|GetTime]]()
+;activeID
+: unknown - possibly not used, shows in UI code as a default lfgID/activeID for a given lfgCategoryType
 == Related Events ==
 <!-- 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
+== Changes ==
+* {{Patch 5.4.0|note=Now requires a lfgCategoryType (LE_LFG_CATEGORY_) argument.}}