WoW:API GetLFGQueueStats: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added the new required argument. Someone experienced please look this over.)
m (Move page script moved page API GetLFGQueueStats to 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, instanceType, instanceName, averageWait,
  hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds,
          tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats(LE_LFG_CATEGORY[, lfgID])
    totalTanks, totalHealers, totalDPS, instanceType, instanceSubType,
    instanceName, averageWait, tankWait, healerWait, damageWait,
    myWait, queuedTime, activeID = GetLFGQueueStats(lfgType[, lfgID])
 
== Arguments ==
== Arguments ==
;LE_LFG_CATEGORY
;lfgType
: Any of LE_LFG_CATEGORY_LFD, LE_LFG_CATEGORY_LFR, LE_LFG_CATEGORY_RF depending on which type of LFG you're looking for.
: {{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
:Unknown. Hope someone can fill this in.
:(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
: Boolean - waiting for a tank
: number - count of tanks still needed
;healerNeeds
;healerNeeds
: Boolean - waiting for a designated healer
: number - count of healers still needed
;dpsNeeds
;dpsNeeds
: Boolean - needing more DPS'ers
: 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
: number - unknown relation
;instanceSubType
: number - unknown relation
 
;instanceName
;instanceName
: String - as selected in LFD Finder
: 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.?: Now requires LE_LFG_CATEGORY argument.
* {{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"