WoW:API IsInGroup: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Created page with "{{wowapi}} ''Added in {{mists-inline}} 5.0.4'' isGroup = IsInGroup() Determines if the player is in a raid type group. == Returns == :;isGroup: true if the player is in ...")
 
m (Move page script moved page API IsInGroup to WoW:API IsInGroup without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
''Added in {{mists-inline}} 5.0.4''
''Added in {{mists-inline}} 5.0.4''


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


Determines if the player is in a raid type 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 ==
:;isGroup: true if the player is in a some kind of group, otherwise false
:;isGroup: true if the player is in any kind of group, otherwise false


== Example ==
== Example ==
Line 13: Line 19:
   if IsInGroup() then
   if IsInGroup() then
       DEFAULT_CHAT_FRAME:AddMessage ("I am in some kind of Group.");
       DEFAULT_CHAT_FRAME:AddMessage ("I am in some kind of Group.");
   elseif not IsInGroup() then
   else
       DEFAULT_CHAT_FRAME:AddMessage ("I am not in any kind of Group.");
       DEFAULT_CHAT_FRAME:AddMessage ("I am not in any kind of Group.");
   end
   end
Line 19: Line 25:
== Patch history ==
== Patch history ==
{{Patch 5.0.4|note=Added for status help due to removed {{api|GetNumRaidMembers}} and {{api|GetNumPartyMembers}}.}}
{{Patch 5.0.4|note=Added for status help due to removed {{api|GetNumRaidMembers}} and {{api|GetNumPartyMembers}}.}}
== Notes ==

Latest revision as of 04:46, 15 August 2023

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 Patch 5.0.4 (patch date::28-August-2012): Added for status help due to removed GetNumRaidMembers and GetNumPartyMembers.