API types < partyCategoryType

A common set of parameters for determining a special Group type. Added in 5.0.4.

Values Edit

  • LE_PARTY_CATEGORY_HOME - the local or manually created group.
  • LE_PARTY_CATEGORY_INSTANCE - the player's automatic battleground, arena, or dungeon finder group.

Uses Edit

groupType - (optional) the type of group. Default is 'LE_PARTY_CATEGORY_INSTANCE' if in an instance group, otherwise 'LE_PARTY_CATEGORY_HOME'.

Details Edit

The purpose is to differentiate when a player is a member of more than one group, which group is meant. A player can be in a locally created group or an automatic group (ala Finder).

Examples Edit

/run local x=UnitIsGroupLeader("Player", LE_PARTY_CATEGORY_INSTANCE); SendChatMessage(tostring(x))
/run local x=UnitIsGroupLeader("Player", LE_PARTY_CATEGORY_HOME); SendChatMessage(tostring(x))

For example if you logged in, then joined a normal finder dungeon group and happend to be the leader, then using 'LE_PARTY_CATEGORY_INSTANCE' on UnitIsGroupLeader for yourself, will return 'true' and using 'LE_PARTY_CATEGORY_HOME' will return 'false'. This is because in your 'home world' or 'explicit group' you are not in a 'group' and you are no 'leader' there, but in the 'foriegn world' or 'automatic group' you are the 'leader'.

Changes Edit

See also Edit

Community content is available under CC-BY-SA unless otherwise noted.