GetLFGMode()

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ FrameXML Funcs

→ FrameXML Docs

This function is implemented in FrameXML/UIParent.lua.

Returns the current mode while in LFG.

    mode, submode = GetLFGMode(category, lfgID)

Note that Blizzard divides "Looking For ___" functions into three categories: LFR specific to the raid finder, LFD specific to the 5-player instance finder, and generic "Looking For Group" routines like this one, applicable to both of the finder/matching tools.

Arguments

category

number - One of the LE_LFG_CATEGORY_* constants (see below).

Returns

mode

string - returns your LFG status for that category.

submode

string - returns your LFG sub-status (additional details).

Values

Mode	Submode	Meaning
nil	nil	Not in LFG.
proposal	unaccepted	LFG group formed, notifying matched players dungeon is ready (ready check). Player has not yet responded.
	accepted	Player has accepted the ready check and is waiting on the other potential groupmates.
queued	empowered	LFG forming up. See below for empowered status.
	unempowered
rolecheck	nil	Role Check in progress before queuing or re-queuing.
listed	empowered	Listed in the Raid Browser. Note that this is not "queued" for anything, in the sense of being automatically matched up with other players. See below for empowered status.
	unempowered
suspended	empowered	Would be in queue, but not actually queued right now because of other circumstances. For example, during a raid boss encounter (at the end of which, the mode will change to queued automatically). See below for empowered status.
	unempowered
lfgparty	nil	Dungeon in progress. (Do not be misled by "party"; this is true in raid finder as well.)
abandonedInDungeon	nil	Group disbanded, but player is still in instance.

Submode

Multiple status modes additionally indicate whether the player has the ability to queue/re-queue/de-queue (empowered) or not (the default, unempowered). As a rule, solo players and players in Dungeon Finder groups are empowered; in a raid group only the leader and assistants are empowered.

Notes

This function is implemented in FrameXML/UIParent.lua. In 4.x, this function took no arguments; with 5.x and the advent of multiple queues, the category argument specifies which queue to examine for data:

LE_LFG_CATEGORY_LFD

the dungeon finder

LE_LFG_CATEGORY_RF

the raid finder (automated matchmaking)

LE_LFG_CATEGORY_SCENARIO

scenarios

LE_LFG_CATEGORY_LFR

the raid browser

Patch changes

• Patch 5.4.0 (2013-09-10): lfgID added.
  

See Also

GetLFGModeType - in 4.x
GetLFGInfoServer - used to implement GetLFGMode in 5.x