WoW:API GetLFGQueueStats: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetLFGQueueStats to API GetLFGQueueStats without leaving a redirect)
 
(3 intermediate revisions by 3 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, 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 ==
== 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 ==
== 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 ==
* {{Patch 5.4.0|note=Now requires a lfgCategoryType (LE_LFG_CATEGORY_) argument.}}

Latest revision as of 04:46, 15 August 2023

← WoW API < GetLFGQueueStats

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[edit]

lfgType
lfgCategoryType [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[edit]

hasData
Boolean - indicates if you are in queue
leaderNeeds
Boolean - if group still needs a leader designated
tankNeeds
number - count of tanks still needed
healerNeeds
number - count of healers still needed
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
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 GetTime()
activeID
unknown - possibly not used, shows in UI code as a default lfgID/activeID for a given lfgCategoryType

Related Events[edit]

Changes[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetLFGQueueStats&oldid=19100"