GetLFGProposal

Main Menu
WoW API Widget API Widget scripts Lua API Events CVars XML schema Macro commands Combat Log Escape sequences API changes HOWTOs Snippets UI tech. Category nav.

→ API by Alphabet

→ API Overview

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 

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