WoW:API GetLookingForGroup: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
Returns the names of all objectives you are currently flagged to as LFG
Returns the objectives you are currently flagged to as LFG.<br>
objective1, objective2, objective3, message = GetLookingForGroup()
Usage:<br>
<nowiki> type1, number1, type2, number2, type3, number3, lfmType, lfmNumber,
comment [, queued, lfgStatus, lfmStatus][,viewframe,forcejoin]= GetLookingForGroup()</nowiki>


===Takes===
===Takes===
Line 7: Line 9:


===Returns===
===Returns===
: String objective1 
: Type, number
:: The name of the first objective you are registered to
:: The type and number of each objective you are queued in.  Eg. type 2=dungeon, type 3= raid.
: String objective2 
: lfmNumber
:: The name of the second objective you are registered to
:: The number of the instance in the LFM list. Returns 0 if not in a party.
: String objective3  
: comment
:: The name of the third objective you are registered to
: String message 
:: A message you provided when flagging yourself as LFG with [[API SetLookingForGroup|SetLookingForGroup()]]
:: A message you provided when flagging yourself as LFG with [[API SetLookingForGroup|SetLookingForGroup()]]
The first 9 keys are always the same and can be referenced by number, 1-9.  The rest of the table is different depending on whether you are currently queued or not. 
If you are '''not''' in LFG, keys 10-12 will be [,queued, lfgStatus, lfmStatus].  If you are in LFG, keys 10-13 will not exist.  Instead [,viewframe,forcejoin] will be part of the table and are referenced by string.
:Eg. table["viewframe"]
===Notes===
This function has (apparently) been removed in patch 3.3.  Use [[API GetLFGRoleUpdateSlot()|GetLFGRoleUpdateSlot()]] instead.

Revision as of 06:45, 9 December 2009

← WoW API < GetLookingForGroup

Returns the objectives you are currently flagged to as LFG.
Usage:
type1, number1, type2, number2, type3, number3, lfmType, lfmNumber, comment [, queued, lfgStatus, lfmStatus][,viewframe,forcejoin]= GetLookingForGroup()

Takes

Nothing

Returns

Type, number
The type and number of each objective you are queued in. Eg. type 2=dungeon, type 3= raid.
lfmNumber
The number of the instance in the LFM list. Returns 0 if not in a party.
comment
A message you provided when flagging yourself as LFG with SetLookingForGroup()


The first 9 keys are always the same and can be referenced by number, 1-9. The rest of the table is different depending on whether you are currently queued or not. If you are not in LFG, keys 10-12 will be [,queued, lfgStatus, lfmStatus]. If you are in LFG, keys 10-13 will not exist. Instead [,viewframe,forcejoin] will be part of the table and are referenced by string.

Eg. table["viewframe"]


Notes

This function has (apparently) been removed in patch 3.3. Use GetLFGRoleUpdateSlot() instead.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetLookingForGroup&oldid=13609"