WoW:API GetLFGProposal: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(skeleton)
 
Line 6: Line 6:


== Return values ==
== Return values ==
; proposalExists : Flag - 1 if your character has a pending LFD invitation, nil otherwise.
; proposalExists : Flag - true if your character has a pending LFD invitation, nil otherwise.
; typeID : LFG type ID - one of TYPEID_RANDOM_DUNGEON, TYPEID_HEROIC_DIFFICULTY.
; typeID : LFG type ID - one of TYPEID_RANDOM_DUNGEON, TYPEID_HEROIC_DIFFICULTY.
; id : Number - dungeonID (?)
; id : Number - dungeonID (?)

Revision as of 14:06, 25 July 2014

WoW API < GetLFGProposal

Returns information about the current LFD group invite.

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

Return values

proposalExists
Flag - true if your character has a pending LFD invitation, nil otherwise.
typeID
LFG type ID - one of TYPEID_RANDOM_DUNGEON, TYPEID_HEROIC_DIFFICULTY.
id
Number - dungeonID (?)
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 - One of "HEALER", "TANK", or "DAMAGER".
hasResponded
Flag - 1 if your character has already accepted/rejected the invitation, nil 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
Flag - 1 if your character is selected to be the party leader, nil otherwise.

See also