WoW:API IsInGroup: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Correct the summary that mentioned only a raid group)
(Added optional groupType parameter, needed to distinguish between local group (/p) and instance group (/i).)
Line 2: Line 2:
''Added in {{mists-inline}} 5.0.4''
''Added in {{mists-inline}} 5.0.4''


   isGroup = IsInGroup()  
   isGroup = IsInGroup([groupType])  


Determines whether the player is in a party or a raid group
Determines whether the player is in a party or a raid group
== Arguments ==
; groupType (optional)
: The type of group:
:* LE_PARTY_CATEGORY_HOME - true if the player is in a local or manual group.
:* LE_PARTY_CATEGORY_INSTANCE - true if the player is in a instance type group. (e.g. LFG, LFR)


== Returns ==
== Returns ==

Revision as of 23:23, 9 August 2017

WoW API < IsInGroup

Added in Template:Mists-inline 5.0.4

 isGroup = IsInGroup([groupType]) 

Determines whether the player is in a party or a raid group

Arguments

groupType (optional)
The type of group:
  • LE_PARTY_CATEGORY_HOME - true if the player is in a local or manual group.
  • LE_PARTY_CATEGORY_INSTANCE - true if the player is in a instance type group. (e.g. LFG, LFR)

Returns

isGroup
true if the player is in any kind of group, otherwise false

Example

 if IsInGroup() then
     DEFAULT_CHAT_FRAME:AddMessage ("I am in some kind of Group.");
 else
     DEFAULT_CHAT_FRAME:AddMessage ("I am not in any kind of Group.");
 end

Patch history

Template:Mists-inline <span style="" title="Patch 5.0.4">Patch 5.0.4</span> (patch date::28-August-2012): Added for status help due to removed GetNumRaidMembers and GetNumPartyMembers.