GetLFGProposal

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

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 3.3.0 / 1.15.0

Returns information about the current LFD group invite.

proposalExists, id, typeID, subtypeID, name, texture, role, hasResponded, totalEncounters,
 completedEncounters, numMembers, isLeader, isHoliday, proposalCategory = GetLFGProposal()

Return values

proposalExists

boolean - true if your character has a pending LFD invitation, nil otherwise.

id

number - dungeonID (?)

typeID

number - LFG type ID - one of TYPEID_DUNGEON (1), TYPEID_RANDOM_DUNGEON (6).

subtypeID

number - One of the LFG_SUBTYPEID_* values:

• LFG_SUBTYPEID_DUNGEON = 1
• LFG_SUBTYPEID_HEROIC = 2
• LFG_SUBTYPEID_RAID = 3
• LFG_SUBTYPEID_SCENARIO = 4
• LFG_SUBTYPEID_FLEXRAID = 5

name

string - Instance name (unless the invitation is to a random dungeon).

texture

string - Invitation background texture name (appended to "Interface\\LFGFrame\\UI-LFG-BACKGROUND-").

role

string - Proposed player role; one of "HEALER", "TANK", "DAMAGER", or "NONE".

hasResponded

boolean - true if your character has already accepted/rejected the invitation, false otherwise.

totalEncounters

number - total number of bosses in the dungeon.

completedEncounters

number - number of bosses in the dungeon already killed.

numMembers

number - number of members in the proposed party.

isLeader

boolean - true if your character is selected to be the party leader, false otherwise.

isHoliday

boolean - true if the proposal is for a holiday event queue, false otherwise.

proposalCategory

number - queue category; one of the LE_LFG_CATEGORY constants.

See also

• AcceptProposal
• RejectProposal