src/game/Group.h

   1 /*
   2  * Copyright (C) 2005-2008 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef MANGOSSERVER_GROUP_H
  20 #define MANGOSSERVER_GROUP_H
  21
  22 #include "GroupReference.h"
  23 #include "GroupRefManager.h"
  24 #include "LootMgr.h"
  25
  26 #include <map>
  27 #include <vector>
  28
  29 #define MAXGROUPSIZE 5
  30 #define MAXRAIDSIZE 40
  31 #define TARGETICONCOUNT 8
  32
  33 enum RollVote
  34 {
  35     PASS              = 0,
  36     NEED              = 1,
  37     GREED             = 2,
  38     NOT_EMITED_YET    = 3,
  39     NOT_VALID         = 4
  40 };
  41
  42 enum GroupMemberOnlineStatus
  43 {
  44     MEMBER_STATUS_OFFLINE   = 0x0000,
  45     MEMBER_STATUS_ONLINE    = 0x0001,
  46     MEMBER_STATUS_PVP       = 0x0002,
  47     MEMBER_STATUS_UNK0      = 0x0004,                       // dead? (health=0)
  48     MEMBER_STATUS_UNK1      = 0x0008,                       // ghost? (health=1)
  49     MEMBER_STATUS_UNK2      = 0x0010,                       // never seen
  50     MEMBER_STATUS_UNK3      = 0x0020,                       // never seen
  51     MEMBER_STATUS_UNK4      = 0x0040,                       // appears with dead and ghost flags
  52     MEMBER_STATUS_UNK5      = 0x0080,                       // never seen
  53 };
  54
  55 enum GroupType
  56 {
  57     GROUPTYPE_NORMAL = 0,
  58     GROUPTYPE_RAID   = 1
  59 };
  60
  61 class BattleGround;
  62
  63 enum GroupUpdateFlags
  64 {
  65     GROUP_UPDATE_FLAG_NONE              = 0x00000000,       // nothing
  66     GROUP_UPDATE_FLAG_STATUS            = 0x00000001,       // uint16, flags
  67     GROUP_UPDATE_FLAG_CUR_HP            = 0x00000002,       // uint16
  68     GROUP_UPDATE_FLAG_MAX_HP            = 0x00000004,       // uint16
  69     GROUP_UPDATE_FLAG_POWER_TYPE        = 0x00000008,       // uint8
  70     GROUP_UPDATE_FLAG_CUR_POWER         = 0x00000010,       // uint16
  71     GROUP_UPDATE_FLAG_MAX_POWER         = 0x00000020,       // uint16
  72     GROUP_UPDATE_FLAG_LEVEL             = 0x00000040,       // uint16
  73     GROUP_UPDATE_FLAG_ZONE              = 0x00000080,       // uint16
  74     GROUP_UPDATE_FLAG_POSITION          = 0x00000100,       // uint16, uint16
  75     GROUP_UPDATE_FLAG_AURAS             = 0x00000200,       // uint64 mask, for each bit set uint16 spellid + uint8 unk
  76     GROUP_UPDATE_FLAG_PET_GUID          = 0x00000400,       // uint64 pet guid
  77     GROUP_UPDATE_FLAG_PET_NAME          = 0x00000800,       // pet name, NULL terminated string
  78     GROUP_UPDATE_FLAG_PET_MODEL_ID      = 0x00001000,       // uint16, model id
  79     GROUP_UPDATE_FLAG_PET_CUR_HP        = 0x00002000,       // uint16 pet cur health
  80     GROUP_UPDATE_FLAG_PET_MAX_HP        = 0x00004000,       // uint16 pet max health
  81     GROUP_UPDATE_FLAG_PET_POWER_TYPE    = 0x00008000,       // uint8 pet power type
  82     GROUP_UPDATE_FLAG_PET_CUR_POWER     = 0x00010000,       // uint16 pet cur power
  83     GROUP_UPDATE_FLAG_PET_MAX_POWER     = 0x00020000,       // uint16 pet max power
  84     GROUP_UPDATE_FLAG_PET_AURAS         = 0x00040000,       // uint64 mask, for each bit set uint16 spellid + uint8 unk, pet auras...
  85     GROUP_UPDATE_PET                    = 0x0007FC00,       // all pet flags
  86     GROUP_UPDATE_FULL                   = 0x0007FFFF,       // all known flags
  87 };
  88
  89 #define GROUP_UPDATE_FLAGS_COUNT          20
  90                                                                 // 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11,12,13,14,15,16,17,18,19
  91 static const uint8 GroupUpdateLength[GROUP_UPDATE_FLAGS_COUNT] = { 0, 2, 2, 2, 1, 2, 2, 2, 2, 4, 8, 8, 1, 2, 2, 2, 1, 2, 2, 8};
  92
  93 class InstanceSave;
  94
  95 class Roll : public LootValidatorRef
  96 {
  97     public:
  98         Roll(uint64 _guid, LootItem const& li)
  99             : itemGUID(_guid), itemid(li.itemid), itemRandomPropId(li.randomPropertyId), itemRandomSuffix(li.randomSuffix),
 100             totalPlayersRolling(0), totalNeed(0), totalGreed(0), totalPass(0), itemSlot(0) {}
 101         ~Roll() { }
 102         void setLoot(Loot *pLoot) { link(pLoot, this); }
 103         Loot *getLoot() { return getTarget(); }
 104         void targetObjectBuildLink();
 105
 106         uint64 itemGUID;
 107         uint32 itemid;
 108         int32  itemRandomPropId;
 109         uint32 itemRandomSuffix;
 110         typedef std::map<uint64, RollVote> PlayerVote;
 111         PlayerVote playerVote;                              //vote position correspond with player position (in group)
 112         uint8 totalPlayersRolling;
 113         uint8 totalNeed;
 114         uint8 totalGreed;
 115         uint8 totalPass;
 116         uint8 itemSlot;
 117 };
 118
 119 struct InstanceGroupBind
 120 {
 121     InstanceSave *save;
 122     bool perm;
 123     /* permanent InstanceGroupBinds exist iff the leader has a permanent
 124        PlayerInstanceBind for the same instance. */
 125     InstanceGroupBind() : save(NULL), perm(false) {}
 126 };
 127
 128 /** request member stats checken **/
 129 /** todo: uninvite people that not accepted invite **/
 130 class MANGOS_DLL_SPEC Group
 131 {
 132     public:
 133         struct MemberSlot
 134         {
 135             uint64      guid;
 136             std::string name;
 137             uint8       group;
 138             bool        assistant;
 139         };
 140         typedef std::list<MemberSlot> MemberSlotList;
 141         typedef MemberSlotList::const_iterator member_citerator;
 142
 143         typedef UNORDERED_MAP< uint32 /*mapId*/, InstanceGroupBind> BoundInstancesMap;
 144     protected:
 145         typedef MemberSlotList::iterator member_witerator;
 146         typedef std::set<uint64> InvitesList;
 147
 148         typedef std::vector<Roll*> Rolls;
 149
 150     public:
 151         Group();
 152         ~Group();
 153
 154         // group manipulation methods
 155         bool   Create(const uint64 &guid, const char * name);
 156         bool   LoadGroupFromDB(const uint64 &leaderGuid, QueryResult *result = NULL, bool loadMembers = true);
 157         bool   LoadMemberFromDB(uint32 guidLow, uint8 subgroup, bool assistant);
 158         bool   AddInvite(Player *player);
 159         uint32 RemoveInvite(Player *player);
 160         void   RemoveAllInvites();
 161         bool   AddLeaderInvite(Player *player);
 162         bool   AddMember(const uint64 &guid, const char* name);
 163                                                             // method: 0=just remove, 1=kick
 164         uint32 RemoveMember(const uint64 &guid, const uint8 &method);
 165         void   ChangeLeader(const uint64 &guid);
 166         void   SetLootMethod(LootMethod method) { m_lootMethod = method; }
 167         void   SetLooterGuid(const uint64 &guid) { m_looterGuid = guid; }
 168         void   UpdateLooterGuid( Creature* creature, bool ifneed = false );
 169         void   SetLootThreshold(ItemQualities threshold) { m_lootThreshold = threshold; }
 170         void   Disband(bool hideDestroy=false);
 171
 172         // properties accessories
 173         bool IsFull() const { return (m_groupType==GROUPTYPE_NORMAL) ? (m_memberSlots.size()>=MAXGROUPSIZE) : (m_memberSlots.size()>=MAXRAIDSIZE); }
 174         bool isRaidGroup() const { return m_groupType==GROUPTYPE_RAID; }
 175         bool isBGGroup()   const { return m_bgGroup != NULL; }
 176         bool IsCreated()   const { return GetMembersCount() > 0; }
 177         const uint64& GetLeaderGUID() const { return m_leaderGuid; }
 178         const char * GetLeaderName() const { return m_leaderName.c_str(); }
 179         LootMethod    GetLootMethod() const { return m_lootMethod; }
 180         const uint64& GetLooterGuid() const { return m_looterGuid; }
 181         ItemQualities GetLootThreshold() const { return m_lootThreshold; }
 182
 183         // member manipulation methods
 184         bool IsMember(const uint64& guid) const { return _getMemberCSlot(guid) != m_memberSlots.end(); }
 185         bool IsLeader(const uint64& guid) const { return (GetLeaderGUID() == guid); }
 186         bool IsAssistant(uint64 guid) const
 187         {
 188             member_citerator mslot = _getMemberCSlot(guid);
 189             if(mslot==m_memberSlots.end())
 190                 return false;
 191
 192             return mslot->assistant;
 193         }
 194
 195         bool SameSubGroup(uint64 guid1,const uint64& guid2) const
 196         {
 197             member_citerator mslot2 = _getMemberCSlot(guid2);
 198             if(mslot2==m_memberSlots.end())
 199                 return false;
 200
 201             return SameSubGroup(guid1,&*mslot2);
 202         }
 203
 204         bool SameSubGroup(uint64 guid1, MemberSlot const* slot2) const
 205         {
 206             member_citerator mslot1 = _getMemberCSlot(guid1);
 207             if(mslot1==m_memberSlots.end() || !slot2)
 208                 return false;
 209
 210             return (mslot1->group==slot2->group);
 211         }
 212
 213         bool HasFreeSlotSubGroup(uint8 subgroup) const
 214         {
 215             return (m_subGroupsCounts && m_subGroupsCounts[subgroup] < MAXGROUPSIZE);
 216         }
 217
 218         bool SameSubGroup(Player const* member1, Player const* member2) const;
 219
 220         MemberSlotList const& GetMemberSlots() const { return m_memberSlots; }
 221         GroupReference* GetFirstMember() { return m_memberMgr.getFirst(); }
 222         uint32 GetMembersCount() const { return m_memberSlots.size(); }
 223         void GetDataForXPAtKill(Unit const* victim, uint32& count,uint32& sum_level, Player* & member_with_max_level, Player* & not_gray_member_with_max_level);
 224         uint8  GetMemberGroup(uint64 guid) const
 225         {
 226             member_citerator mslot = _getMemberCSlot(guid);
 227             if(mslot==m_memberSlots.end())
 228                 return (MAXRAIDSIZE/MAXGROUPSIZE+1);
 229
 230             return mslot->group;
 231         }
 232
 233         // some additional raid methods
 234         void ConvertToRaid();
 235
 236         void SetBattlegroundGroup(BattleGround *bg) { m_bgGroup = bg; }
 237
 238         void ChangeMembersGroup(const uint64 &guid, const uint8 &group);
 239         void ChangeMembersGroup(Player *player, const uint8 &group);
 240
 241         void SetAssistant(uint64 guid, const bool &state)
 242         {
 243             if(!isRaidGroup())
 244                 return;
 245             if(_setAssistantFlag(guid, state))
 246                 SendUpdate();
 247         }
 248         void SetMainTank(uint64 guid)
 249         {
 250             if(!isRaidGroup())
 251                 return;
 252
 253             if(_setMainTank(guid))
 254                 SendUpdate();
 255         }
 256         void SetMainAssistant(uint64 guid)
 257         {
 258             if(!isRaidGroup())
 259                 return;
 260
 261             if(_setMainAssistant(guid))
 262                 SendUpdate();
 263         }
 264
 265         void SetTargetIcon(uint8 id, uint64 guid);
 266         void SetDifficulty(uint8 difficulty);
 267         uint8 GetDifficulty() { return m_difficulty; }
 268         uint16 InInstance();
 269         bool InCombatToInstance(uint32 instanceId);
 270         void ResetInstances(uint8 method, Player* SendMsgTo);
 271
 272         // -no description-
 273         //void SendInit(WorldSession *session);
 274         void SendTargetIconList(WorldSession *session);
 275         void SendUpdate();
 276         void UpdatePlayerOutOfRange(Player* pPlayer);
 277                                                             // ignore: GUID of player that will be ignored
 278         void BroadcastPacket(WorldPacket *packet, int group=-1, uint64 ignore=0);
 279         void BroadcastReadyCheck(WorldPacket *packet);
 280         void OfflineReadyCheck();
 281
 282         /*********************************************************/
 283         /***                   LOOT SYSTEM                     ***/
 284         /*********************************************************/
 285
 286         void SendLootStartRoll(uint32 CountDown, const Roll &r);
 287         void SendLootRoll(const uint64& SourceGuid, const uint64& TargetGuid, uint8 RollNumber, uint8 RollType, const Roll &r);
 288         void SendLootRollWon(const uint64& SourceGuid, const uint64& TargetGuid, uint8 RollNumber, uint8 RollType, const Roll &r);
 289         void SendLootAllPassed(uint32 NumberOfPlayers, const Roll &r);
 290         void GroupLoot(const uint64& playerGUID, Loot *loot, Creature *creature);
 291         void NeedBeforeGreed(const uint64& playerGUID, Loot *loot, Creature *creature);
 292         void MasterLoot(const uint64& playerGUID, Loot *loot, Creature *creature);
 293         Rolls::iterator GetRoll(uint64 Guid)
 294         {
 295             Rolls::iterator iter;
 296             for (iter=RollId.begin(); iter != RollId.end(); ++iter)
 297             {
 298                 if ((*iter)->itemGUID == Guid && (*iter)->isValid())
 299                 {
 300                     return iter;
 301                 }
 302             }
 303             return RollId.end();
 304         }
 305         void CountTheRoll(Rolls::iterator roll, uint32 NumberOfPlayers);
 306         void CountRollVote(const uint64& playerGUID, const uint64& Guid, uint32 NumberOfPlayers, uint8 Choise);
 307         void EndRoll();
 308
 309         void LinkMember(GroupReference *pRef) { m_memberMgr.insertFirst(pRef); }
 310         void DelinkMember(GroupReference* /*pRef*/ ) { }
 311
 312         InstanceGroupBind* BindToInstance(InstanceSave *save, bool permanent, bool load = false);
 313         void UnbindInstance(uint32 mapid, uint8 difficulty, bool unload = false);
 314         InstanceGroupBind* GetBoundInstance(uint32 mapid, uint8 difficulty);
 315         BoundInstancesMap& GetBoundInstances(uint8 difficulty) { return m_boundInstances[difficulty]; }
 316
 317     protected:
 318         bool _addMember(const uint64 &guid, const char* name, bool isAssistant=false);
 319         bool _addMember(const uint64 &guid, const char* name, bool isAssistant, uint8 group);
 320         bool _removeMember(const uint64 &guid);             // returns true if leader has changed
 321         void _setLeader(const uint64 &guid);
 322
 323         void _removeRolls(const uint64 &guid);
 324
 325         bool _setMembersGroup(const uint64 &guid, const uint8 &group);
 326         bool _setAssistantFlag(const uint64 &guid, const bool &state);
 327         bool _setMainTank(const uint64 &guid);
 328         bool _setMainAssistant(const uint64 &guid);
 329
 330         void _homebindIfInstance(Player *player);
 331
 332         void _initRaidSubGroupsCounter()
 333         {
 334             // Sub group counters initialization
 335             if (!m_subGroupsCounts)
 336                 m_subGroupsCounts = new uint8[MAXRAIDSIZE / MAXGROUPSIZE];
 337
 338             memset((void*)m_subGroupsCounts, 0, (MAXRAIDSIZE / MAXGROUPSIZE)*sizeof(uint8));
 339
 340             for (member_citerator itr = m_memberSlots.begin(); itr != m_memberSlots.end(); ++itr)
 341                 ++m_subGroupsCounts[itr->group];
 342         }
 343
 344         member_citerator _getMemberCSlot(uint64 Guid) const
 345         {
 346             for(member_citerator itr = m_memberSlots.begin(); itr != m_memberSlots.end(); ++itr)
 347             {
 348                 if (itr->guid == Guid)
 349                     return itr;
 350             }
 351             return m_memberSlots.end();
 352         }
 353
 354         member_witerator _getMemberWSlot(uint64 Guid)
 355         {
 356             for(member_witerator itr = m_memberSlots.begin(); itr != m_memberSlots.end(); ++itr)
 357             {
 358                 if (itr->guid == Guid)
 359                     return itr;
 360             }
 361             return m_memberSlots.end();
 362         }
 363
 364         void SubGroupCounterIncrease(uint8 subgroup)
 365         {
 366             if (m_subGroupsCounts)
 367                 ++m_subGroupsCounts[subgroup];
 368         }
 369
 370         void SubGroupCounterDecrease(uint8 subgroup)
 371         {
 372             if (m_subGroupsCounts)
 373                 --m_subGroupsCounts[subgroup];
 374         }
 375
 376         MemberSlotList      m_memberSlots;
 377         GroupRefManager     m_memberMgr;
 378         InvitesList         m_invitees;
 379         uint64              m_leaderGuid;
 380         std::string         m_leaderName;
 381         uint64              m_mainTank;
 382         uint64              m_mainAssistant;
 383         GroupType           m_groupType;
 384         uint8               m_difficulty;
 385         BattleGround*       m_bgGroup;
 386         uint64              m_targetIcons[TARGETICONCOUNT];
 387         LootMethod          m_lootMethod;
 388         ItemQualities       m_lootThreshold;
 389         uint64              m_looterGuid;
 390         Rolls               RollId;
 391         BoundInstancesMap   m_boundInstances[TOTAL_DIFFICULTIES];
 392         uint8*              m_subGroupsCounts;
 393 };
 394 #endif