WoW:API GetLFGQueueStats - Revision history

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

2023-08-15T04:46:04Z

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

← Older revision

Revision as of 04:46, 15 August 2023

86.150.18.186: /* Arguments */ Added LE_LFG_CATEGORY_WORLDPVP

2016-08-01T16:37:47Z

Arguments: Added LE_LFG_CATEGORY_WORLDPVP

← Older revision		Revision as of 16:37, 1 August 2016
Line 10:		Line 10:
	== Arguments ==		== Arguments ==
	;lfgType		;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] - 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
	:(Optional) specific LFG 'forming group' ID		:(Optional) specific LFG 'forming group' ID

Bear at 03:27, 26 February 2014

2014-02-26T03:27:15Z

← Older revision		Revision as of 03:27, 26 February 2014
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] - 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.}}

111.69.78.231: Added the new required argument. Someone experienced please look this over.

2014-02-24T15:53:55Z

Added the new required argument. Someone experienced please look this over.

← Older revision		Revision as of 15:53, 24 February 2014
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 - 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		: 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. Use against [[API GetTime\|GetTime]]()		;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.

WoWWiki>Nafe at 22:57, 26 May 2010

2010-05-26T22:57:18Z

← Older revision		Revision as of 22:57, 26 May 2010
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, instanceType, instanceName, averageWait,
	tankWait, healerWait, damageWait, myWait = GetLFGQueueStats()		tankWait, healerWait, damageWait, myWait, queuedTime = GetLFGQueueStats()

	== Returns ==		== Returns ==
Line 19:		Line 19:
	;damageWait : number - average wait time for queuing DPS'ers		;damageWait : number - average wait time for queuing DPS'ers
	;myWait : number - predicted wait time for you		;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

WoWWiki>Orionshock: OnPageCreate

2009-12-13T10:04:57Z

OnPageCreate

New page

{{wowapi}} __NOTOC__

Returns the current state and wait times for being in queue.

hasData, leaderNeeds, tankNeeds, healerNeeds, dpsNeeds, instanceType, instanceName, averageWait,
tankWait, healerWait, damageWait, myWait = GetLFGQueueStats()

== 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

== Related Events ==

* "[[Events/L#WLFG_QUEUE_STATUS_UPDATE|LFG_QUEUE_STATUS_UPDATE]]", new data available with this event