[9545] Rename ObjectDefines.h -> ObjectGuid.h
[getmangos.git] / src / game / Guild.h
blob25dc1ac9f4d107748803063d4fd6f911a09210b8
1 /*
2 * Copyright (C) 2005-2010 MaNGOS <http://getmangos.com/>
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.
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.
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
19 #ifndef MANGOSSERVER_GUILD_H
20 #define MANGOSSERVER_GUILD_H
22 #define WITHDRAW_MONEY_UNLIMITED 0xFFFFFFFF
23 #define WITHDRAW_SLOT_UNLIMITED 0xFFFFFFFF
25 #include "Common.h"
26 #include "Item.h"
28 class Item;
30 #define GUILD_RANKS_MIN_COUNT 5
31 #define GUILD_RANKS_MAX_COUNT 10
33 enum GuildDefaultRanks
35 //these ranks can be modified, but they cannot be deleted
36 GR_GUILDMASTER = 0,
37 GR_OFFICER = 1,
38 GR_VETERAN = 2,
39 GR_MEMBER = 3,
40 GR_INITIATE = 4,
41 //When promoting member server does: rank--;!
42 //When demoting member server does: rank++;!
45 enum GuildRankRights
47 GR_RIGHT_EMPTY = 0x00000040,
48 GR_RIGHT_GCHATLISTEN = 0x00000041,
49 GR_RIGHT_GCHATSPEAK = 0x00000042,
50 GR_RIGHT_OFFCHATLISTEN = 0x00000044,
51 GR_RIGHT_OFFCHATSPEAK = 0x00000048,
52 GR_RIGHT_PROMOTE = 0x000000C0,
53 GR_RIGHT_DEMOTE = 0x00000140,
54 GR_RIGHT_INVITE = 0x00000050,
55 GR_RIGHT_REMOVE = 0x00000060,
56 GR_RIGHT_SETMOTD = 0x00001040,
57 GR_RIGHT_EPNOTE = 0x00002040,
58 GR_RIGHT_VIEWOFFNOTE = 0x00004040,
59 GR_RIGHT_EOFFNOTE = 0x00008040,
60 GR_RIGHT_MODIFY_GUILD_INFO = 0x00010040,
61 GR_RIGHT_WITHDRAW_GOLD_LOCK = 0x00020000, // remove money withdraw capacity
62 GR_RIGHT_WITHDRAW_REPAIR = 0x00040000, // withdraw for repair
63 GR_RIGHT_WITHDRAW_GOLD = 0x00080000, // withdraw gold
64 GR_RIGHT_CREATE_GUILD_EVENT = 0x00100000, // wotlk
65 GR_RIGHT_ALL = 0x001DF1FF
68 enum Typecommand
70 GUILD_CREATE_S = 0x00,
71 GUILD_INVITE_S = 0x01,
72 GUILD_QUIT_S = 0x03,
73 // 0x05?
74 GUILD_FOUNDER_S = 0x0E,
75 GUILD_UNK1 = 0x13,
76 GUILD_UNK2 = 0x14
79 enum CommandErrors
81 ERR_PLAYER_NO_MORE_IN_GUILD = 0x00,
82 ERR_GUILD_INTERNAL = 0x01,
83 ERR_ALREADY_IN_GUILD = 0x02,
84 ERR_ALREADY_IN_GUILD_S = 0x03,
85 ERR_INVITED_TO_GUILD = 0x04,
86 ERR_ALREADY_INVITED_TO_GUILD_S = 0x05,
87 ERR_GUILD_NAME_INVALID = 0x06,
88 ERR_GUILD_NAME_EXISTS_S = 0x07,
89 ERR_GUILD_LEADER_LEAVE = 0x08,
90 ERR_GUILD_PERMISSIONS = 0x08,
91 ERR_GUILD_PLAYER_NOT_IN_GUILD = 0x09,
92 ERR_GUILD_PLAYER_NOT_IN_GUILD_S = 0x0A,
93 ERR_GUILD_PLAYER_NOT_FOUND_S = 0x0B,
94 ERR_GUILD_NOT_ALLIED = 0x0C,
95 ERR_GUILD_RANK_TOO_HIGH_S = 0x0D,
96 ERR_GUILD_RANK_TOO_LOW_S = 0x0E,
97 ERR_GUILD_RANKS_LOCKED = 0x11,
98 ERR_GUILD_RANK_IN_USE = 0x12,
99 ERR_GUILD_IGNORING_YOU_S = 0x13,
100 ERR_GUILD_UNK1 = 0x14,
101 ERR_GUILD_WITHDRAW_LIMIT = 0x19,
102 ERR_GUILD_NOT_ENOUGH_MONEY = 0x1A,
103 ERR_GUILD_BANK_FULL = 0x1C,
104 ERR_GUILD_ITEM_NOT_FOUND = 0x1D
107 enum GuildEvents
109 GE_PROMOTION = 0x00,
110 GE_DEMOTION = 0x01,
111 GE_MOTD = 0x02,
112 GE_JOINED = 0x03,
113 GE_LEFT = 0x04,
114 GE_REMOVED = 0x05,
115 GE_LEADER_IS = 0x06,
116 GE_LEADER_CHANGED = 0x07,
117 GE_DISBANDED = 0x08,
118 GE_TABARDCHANGE = 0x09,
119 GE_UNK1 = 0x0A, // string, string EVENT_GUILD_ROSTER_UPDATE tab content change?
120 GE_UNK2 = 0x0B, // EVENT_GUILD_ROSTER_UPDATE
121 GE_SIGNED_ON = 0x0C, // ERR_FRIEND_ONLINE_SS
122 GE_SIGNED_OFF = 0x0D, // ERR_FRIEND_OFFLINE_S
123 GE_GUILDBANKBAGSLOTS_CHANGED = 0x0E, // EVENT_GUILDBANKBAGSLOTS_CHANGED
124 GE_BANKTAB_PURCHASED = 0x0F, // EVENT_GUILDBANK_UPDATE_TABS
125 GE_UNK5 = 0x10, // EVENT_GUILDBANK_UPDATE_TABS
126 GE_GUILDBANK_UPDATE_MONEY = 0x11, // EVENT_GUILDBANK_UPDATE_MONEY, string 0000000000002710 is 1 gold
127 GE_GUILD_BANK_MONEY_WITHDRAWN = 0x12, // MSG_GUILD_BANK_MONEY_WITHDRAWN
128 GE_GUILDBANK_TEXT_CHANGED = 0x13 // EVENT_GUILDBANK_TEXT_CHANGED
131 enum PetitionTurns
133 PETITION_TURN_OK = 0,
134 PETITION_TURN_ALREADY_IN_GUILD = 2,
135 PETITION_TURN_NEED_MORE_SIGNATURES = 4,
138 enum PetitionSigns
140 PETITION_SIGN_OK = 0,
141 PETITION_SIGN_ALREADY_SIGNED = 1,
142 PETITION_SIGN_ALREADY_IN_GUILD = 2,
143 PETITION_SIGN_CANT_SIGN_OWN = 3,
144 PETITION_SIGN_NOT_SERVER = 4,
147 enum GuildBankRights
149 GUILD_BANK_RIGHT_VIEW_TAB = 0x01,
150 GUILD_BANK_RIGHT_PUT_ITEM = 0x02,
151 GUILD_BANK_RIGHT_UPDATE_TEXT = 0x04,
153 GUILD_BANK_RIGHT_DEPOSIT_ITEM = GUILD_BANK_RIGHT_VIEW_TAB | GUILD_BANK_RIGHT_PUT_ITEM,
154 GUILD_BANK_RIGHT_FULL = 0xFF,
157 enum GuildBankEventLogTypes
159 GUILD_BANK_LOG_DEPOSIT_ITEM = 1,
160 GUILD_BANK_LOG_WITHDRAW_ITEM = 2,
161 GUILD_BANK_LOG_MOVE_ITEM = 3,
162 GUILD_BANK_LOG_DEPOSIT_MONEY = 4,
163 GUILD_BANK_LOG_WITHDRAW_MONEY = 5,
164 GUILD_BANK_LOG_REPAIR_MONEY = 6,
165 GUILD_BANK_LOG_MOVE_ITEM2 = 7,
166 GUILD_BANK_LOG_UNK1 = 8,
167 GUILD_BANK_LOG_UNK2 = 9,
170 enum GuildEventLogTypes
172 GUILD_EVENT_LOG_INVITE_PLAYER = 1,
173 GUILD_EVENT_LOG_JOIN_GUILD = 2,
174 GUILD_EVENT_LOG_PROMOTE_PLAYER = 3,
175 GUILD_EVENT_LOG_DEMOTE_PLAYER = 4,
176 GUILD_EVENT_LOG_UNINVITE_PLAYER = 5,
177 GUILD_EVENT_LOG_LEAVE_GUILD = 6,
180 enum GuildEmblem
182 ERR_GUILDEMBLEM_SUCCESS = 0,
183 ERR_GUILDEMBLEM_INVALID_TABARD_COLORS = 1,
184 ERR_GUILDEMBLEM_NOGUILD = 2,
185 ERR_GUILDEMBLEM_NOTGUILDMASTER = 3,
186 ERR_GUILDEMBLEM_NOTENOUGHMONEY = 4,
187 ERR_GUILDEMBLEM_INVALIDVENDOR = 5
190 inline uint32 GetGuildBankTabPrice(uint8 Index)
192 switch(Index)
194 case 0: return 100;
195 case 1: return 250;
196 case 2: return 500;
197 case 3: return 1000;
198 case 4: return 2500;
199 case 5: return 5000;
200 default:
201 return 0;
203 return 0;
206 struct GuildEventLogEntry
208 uint8 EventType;
209 uint32 PlayerGuid1;
210 uint32 PlayerGuid2;
211 uint8 NewRank;
212 uint64 TimeStamp;
215 struct GuildBankEventLogEntry
217 uint8 EventType;
218 uint32 PlayerGuid;
219 uint32 ItemOrMoney;
220 uint8 ItemStackCount;
221 uint8 DestTabId;
222 uint64 TimeStamp;
224 bool isMoneyEvent() const
226 return EventType == GUILD_BANK_LOG_DEPOSIT_MONEY ||
227 EventType == GUILD_BANK_LOG_WITHDRAW_MONEY ||
228 EventType == GUILD_BANK_LOG_REPAIR_MONEY;
232 struct GuildBankTab
234 Item* Slots[GUILD_BANK_MAX_SLOTS];
235 std::string Name;
236 std::string Icon;
237 std::string Text;
240 struct GuildItemPosCount
242 GuildItemPosCount(uint8 _slot, uint32 _count) : Slot(_slot), Count(_count) {}
244 bool isContainedIn(std::vector<GuildItemPosCount> const& vec) const;
246 uint8 Slot;
247 uint32 Count;
249 typedef std::vector<GuildItemPosCount> GuildItemPosCountVec;
251 struct MemberSlot
253 std::string Name;
254 uint32 RankId;
255 uint8 Level;
256 uint8 Class;
257 uint32 ZoneId;
258 uint64 LogoutTime;
259 std::string Pnote;
260 std::string OFFnote;
261 uint32 BankResetTimeMoney;
262 uint32 BankRemMoney;
263 uint32 BankResetTimeTab[GUILD_BANK_MAX_TABS];
264 uint32 BankRemSlotsTab[GUILD_BANK_MAX_TABS];
267 struct RankInfo
269 RankInfo(const std::string& _name, uint32 _rights, uint32 _money) : Name(_name), Rights(_rights), BankMoneyPerDay(_money)
271 for(uint8 i = 0; i < GUILD_BANK_MAX_TABS; ++i)
273 TabRight[i] = 0;
274 TabSlotPerDay[i] = 0;
278 std::string Name;
279 uint32 Rights;
280 uint32 BankMoneyPerDay;
281 uint32 TabRight[GUILD_BANK_MAX_TABS];
282 uint32 TabSlotPerDay[GUILD_BANK_MAX_TABS];
285 class Guild
287 public:
288 Guild();
289 ~Guild();
291 bool Create(Player* leader, std::string gname);
292 void CreateDefaultGuildRanks(int locale_idx);
293 void Disband();
295 typedef std::map<uint32, MemberSlot> MemberList;
296 typedef std::vector<RankInfo> RankList;
298 uint32 GetId(){ return m_Id; }
299 const uint64& GetLeader(){ return m_LeaderGuid; }
300 std::string const& GetName() const { return m_Name; }
301 std::string const& GetMOTD() const { return MOTD; }
302 std::string const& GetGINFO() const { return GINFO; }
304 uint32 GetCreatedYear() const { return m_CreatedYear; }
305 uint32 GetCreatedMonth() const { return m_CreatedMonth; }
306 uint32 GetCreatedDay() const { return m_CreatedDay; }
308 uint32 GetEmblemStyle() const { return m_EmblemStyle; }
309 uint32 GetEmblemColor() const { return m_EmblemColor; }
310 uint32 GetBorderStyle() const { return m_BorderStyle; }
311 uint32 GetBorderColor() const { return m_BorderColor; }
312 uint32 GetBackgroundColor() const { return m_BackgroundColor; }
314 void SetLeader(uint64 guid);
315 bool AddMember(uint64 plGuid, uint32 plRank);
316 void ChangeRank(uint64 guid, uint32 newRank);
317 void DelMember(uint64 guid, bool isDisbanding = false);
318 //lowest rank is the count of ranks - 1 (the highest rank_id in table)
319 uint32 GetLowestRank() const { return m_Ranks.size() - 1; }
321 void SetMOTD(std::string motd);
322 void SetGINFO(std::string ginfo);
323 void SetPNOTE(uint64 guid, std::string pnote);
324 void SetOFFNOTE(uint64 guid, std::string offnote);
325 void SetEmblem(uint32 emblemStyle, uint32 emblemColor, uint32 borderStyle, uint32 borderColor, uint32 backgroundColor);
327 uint32 GetMemberSize() const { return members.size(); }
329 bool LoadGuildFromDB(QueryResult *guildDataResult);
330 bool CheckGuildStructure();
331 bool LoadRanksFromDB(QueryResult *guildRanksResult);
332 bool LoadMembersFromDB(QueryResult *guildMembersResult);
334 void SetMemberStats(uint64 guid);
336 void BroadcastToGuild(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
337 void BroadcastToOfficers(WorldSession *session, const std::string& msg, uint32 language = LANG_UNIVERSAL);
338 void BroadcastPacketToRank(WorldPacket *packet, uint32 rankId);
339 void BroadcastPacket(WorldPacket *packet);
340 void BroadcastEvent(GuildEvents event, uint64 guid, uint8 strCount, std::string str1, std::string str2, std::string str3);
342 template<class Do>
343 void BroadcastWorker(Do& _do, Player* except = NULL)
345 for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
346 if(Player *player = ObjectAccessor::FindPlayer(MAKE_NEW_GUID(itr->first, 0, HIGHGUID_PLAYER)))
347 if(player != except)
348 _do(player);
351 void CreateRank(std::string name,uint32 rights);
352 void DelRank();
353 std::string GetRankName(uint32 rankId);
354 uint32 GetRankRights(uint32 rankId);
355 uint32 GetRanksSize() const { return m_Ranks.size(); }
357 void SetRankName(uint32 rankId, std::string name);
358 void SetRankRights(uint32 rankId, uint32 rights);
359 bool HasRankRight(uint32 rankId, uint32 right)
361 return ((GetRankRights(rankId) & right) != GR_RIGHT_EMPTY) ? true : false;
363 int32 GetRank(uint32 LowGuid);
364 bool IsMember(uint32 LowGuid)
366 return (members.find(LowGuid) != members.end());
368 MemberSlot* GetMemberSlot(const std::string& name, uint64& guid)
370 for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
372 if(itr->second.Name == name)
374 guid = itr->first;
375 return &itr->second;
378 return NULL;
381 void Roster(WorldSession *session = NULL); // NULL = broadcast
382 void Query(WorldSession *session);
384 void UpdateLogoutTime(uint64 guid);
385 // Guild EventLog
386 void LoadGuildEventLogFromDB();
387 void DisplayGuildEventLog(WorldSession *session);
388 void LogGuildEvent(uint8 EventType, uint32 PlayerGuid1, uint32 PlayerGuid2, uint8 NewRank);
390 // ** Guild bank **
391 // Content & item deposit/withdraw
392 void DisplayGuildBankContent(WorldSession *session, uint8 TabId);
393 void DisplayGuildBankMoneyUpdate(WorldSession *session);
395 void SwapItems( Player * pl, uint8 BankTab, uint8 BankTabSlot, uint8 BankTabDst, uint8 BankTabSlotDst, uint32 SplitedAmount);
396 void MoveFromBankToChar( Player * pl, uint8 BankTab, uint8 BankTabSlot, uint8 PlayerBag, uint8 PlayerSlot, uint32 SplitedAmount);
397 void MoveFromCharToBank( Player * pl, uint8 PlayerBag, uint8 PlayerSlot, uint8 BankTab, uint8 BankTabSlot, uint32 SplitedAmount);
399 // Tabs
400 void DisplayGuildBankTabsInfo(WorldSession *session);
401 void CreateNewBankTab();
402 void SetGuildBankTabText(uint8 TabId, std::string text);
403 void SendGuildBankTabText(WorldSession *session, uint8 TabId);
404 void SetGuildBankTabInfo(uint8 TabId, std::string name, std::string icon);
405 uint8 GetPurchasedTabs() const { return m_PurchasedTabs; }
406 uint32 GetBankRights(uint32 rankId, uint8 TabId) const;
407 bool IsMemberHaveRights(uint32 LowGuid, uint8 TabId,uint32 rights) const;
408 bool CanMemberViewTab(uint32 LowGuid, uint8 TabId) const;
409 // Load
410 void LoadGuildBankFromDB();
411 // Money deposit/withdraw
412 void SendMoneyInfo(WorldSession *session, uint32 LowGuid);
413 bool MemberMoneyWithdraw(uint32 amount, uint32 LowGuid);
414 uint64 GetGuildBankMoney() { return m_GuildBankMoney; }
415 void SetBankMoney(int64 money);
416 // per days
417 bool MemberItemWithdraw(uint8 TabId, uint32 LowGuid);
418 uint32 GetMemberSlotWithdrawRem(uint32 LowGuid, uint8 TabId);
419 uint32 GetMemberMoneyWithdrawRem(uint32 LowGuid);
420 void SetBankMoneyPerDay(uint32 rankId, uint32 money);
421 void SetBankRightsAndSlots(uint32 rankId, uint8 TabId, uint32 right, uint32 SlotPerDay, bool db);
422 uint32 GetBankMoneyPerDay(uint32 rankId);
423 uint32 GetBankSlotPerDay(uint32 rankId, uint8 TabId);
424 // rights per day
425 bool LoadBankRightsFromDB(QueryResult *guildBankTabRightsResult);
426 // Guild Bank Event Logs
427 void LoadGuildBankEventLogFromDB();
428 void DisplayGuildBankLogs(WorldSession *session, uint8 TabId);
429 void LogBankEvent(uint8 EventType, uint8 TabId, uint32 PlayerGuidLow, uint32 ItemOrMoney, uint8 ItemStackCount=0, uint8 DestTabId=0);
430 bool AddGBankItemToDB(uint32 GuildId, uint32 BankTab , uint32 BankTabSlot , uint32 GUIDLow, uint32 Entry );
432 protected:
433 void AddRank(const std::string& name,uint32 rights,uint32 money);
435 uint32 m_Id;
436 std::string m_Name;
437 uint64 m_LeaderGuid;
438 std::string MOTD;
439 std::string GINFO;
440 uint32 m_CreatedYear;
441 uint32 m_CreatedMonth;
442 uint32 m_CreatedDay;
444 uint32 m_EmblemStyle;
445 uint32 m_EmblemColor;
446 uint32 m_BorderStyle;
447 uint32 m_BorderColor;
448 uint32 m_BackgroundColor;
450 RankList m_Ranks;
452 MemberList members;
454 typedef std::vector<GuildBankTab*> TabListMap;
455 TabListMap m_TabListMap;
457 /** These are actually ordered lists. The first element is the oldest entry.*/
458 typedef std::list<GuildEventLogEntry> GuildEventLog;
459 typedef std::list<GuildBankEventLogEntry> GuildBankEventLog;
460 GuildEventLog m_GuildEventLog;
461 GuildBankEventLog m_GuildBankEventLog_Money;
462 GuildBankEventLog m_GuildBankEventLog_Item[GUILD_BANK_MAX_TABS];
464 uint32 m_GuildEventLogNextGuid;
465 uint32 m_GuildBankEventLogNextGuid_Money;
466 uint32 m_GuildBankEventLogNextGuid_Item[GUILD_BANK_MAX_TABS];
468 uint64 m_GuildBankMoney;
469 uint8 m_PurchasedTabs;
471 private:
472 // used only from high level Swap/Move functions
473 Item* GetItem(uint8 TabId, uint8 SlotId);
474 uint8 CanStoreItem( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32 count, Item *pItem, bool swap = false) const;
475 Item* StoreItem( uint8 tab, GuildItemPosCountVec const& pos, Item *pItem );
476 void RemoveItem(uint8 tab, uint8 slot );
477 void DisplayGuildBankContentUpdate(uint8 TabId, int32 slot1, int32 slot2 = -1);
478 void DisplayGuildBankContentUpdate(uint8 TabId, GuildItemPosCountVec const& slots);
480 // internal common parts for CanStore/StoreItem functions
481 void AppendDisplayGuildBankSlot( WorldPacket& data, GuildBankTab const *tab, int32 slot );
482 uint8 _CanStoreItem_InSpecificSlot( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32& count, bool swap, Item *pSrcItem ) const;
483 uint8 _CanStoreItem_InTab( uint8 tab, GuildItemPosCountVec& dest, uint32& count, bool merge, Item *pSrcItem, uint8 skip_slot ) const;
484 Item* _StoreItem( uint8 tab, uint8 slot, Item *pItem, uint32 count, bool clone );
486 #endif