root/trunk/src/game/Guild.h @ 240

Revision 229, 15.8 kB (checked in by yumileroy, 17 years ago)

[svn] *** Source: MaNGOS ***
* Fixed build extractor at Windows Vista. Author: Vladimir
* Fixed comment text and code indentifiers spelling. Author: Vladimir & Paradox.
* Access cached member lists in guild handlers instead of querying the DB. Author: Hunuza
* Small fixes in send/received packet and simple code cleanup also. Author: Vladimir
* Not output error at loading empty character_ticket table. Author: Vladimir
* Not reset display model at shapeshift aura remove if it not set at apply. Author: Arthorius
* Applied props to few files.

Original author: visagalis
Date: 2008-11-14 16:28:45-06:00
Line 
1/*
2 * Copyright (C) 2005-2008 MaNGOS <http://www.mangosproject.org/>
3 *
4 * Copyright (C) 2008 Trinity <http://www.trinitycore.org/>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21#ifndef TRINITYCORE_GUILD_H
22#define TRINITYCORE_GUILD_H
23
24#define WITHDRAW_MONEY_UNLIMITED    0xFFFFFFFF
25#define WITHDRAW_SLOT_UNLIMITED     0xFFFFFFFF
26
27#include "Item.h"
28
29class Item;
30
31enum GuildDefaultRanks
32{
33    GR_GUILDMASTER  = 0,
34    GR_OFFICER      = 1,
35    //GR_VETERAN      = 2, -- not used anywhere and possible incorrect in modified rank list
36    //GR_MEMBER       = 3,
37    //GR_INITIATE     = 4, -- use Guild::GetLowestRank() instead for lowest rank
38};
39
40enum GuildRankRights
41{
42    GR_RIGHT_EMPTY              = 0x00000040,
43    GR_RIGHT_GCHATLISTEN        = 0x00000041,
44    GR_RIGHT_GCHATSPEAK         = 0x00000042,
45    GR_RIGHT_OFFCHATLISTEN      = 0x00000044,
46    GR_RIGHT_OFFCHATSPEAK       = 0x00000048,
47    GR_RIGHT_PROMOTE            = 0x000000C0,
48    GR_RIGHT_DEMOTE             = 0x00000140,
49    GR_RIGHT_INVITE             = 0x00000050,
50    GR_RIGHT_REMOVE             = 0x00000060,
51    GR_RIGHT_SETMOTD            = 0x00001040,
52    GR_RIGHT_EPNOTE             = 0x00002040,
53    GR_RIGHT_VIEWOFFNOTE        = 0x00004040,
54    GR_RIGHT_EOFFNOTE           = 0x00008040,
55    GR_RIGHT_MODIFY_GUILD_INFO  = 0x00010040,
56    GR_RIGHT_REPAIR_FROM_GUILD  = 0x00020000,               // unused in 2.4.x?, Remove money withdraw capacity
57    GR_RIGHT_WITHDRAW_REPAIR    = 0x00040000,               // withdraw for repair
58    GR_RIGHT_WITHDRAW_GOLD      = 0x00080000,               // withdraw gold
59    GR_RIGHT_ALL                = 0x000FF1FF
60};
61
62enum Typecommand
63{
64    GUILD_CREATE_S  = 0x00,
65    GUILD_INVITE_S  = 0x01,
66    GUILD_QUIT_S    = 0x03,
67    GUILD_FOUNDER_S = 0x0E,
68    GUILD_UNK1      = 0x10,
69    GUILD_BANK_S    = 0x15,
70    GUILD_UNK3      = 0x16
71};
72
73enum CommandErrors
74{
75    GUILD_PLAYER_NO_MORE_IN_GUILD   = 0x00,
76    GUILD_INTERNAL                  = 0x01,
77    GUILD_ALREADY_IN_GUILD          = 0x02,
78    ALREADY_IN_GUILD                = 0x03,
79    INVITED_TO_GUILD                = 0x04,
80    ALREADY_INVITED_TO_GUILD        = 0x05,
81    GUILD_NAME_INVALID              = 0x06,
82    GUILD_NAME_EXISTS               = 0x07,
83    GUILD_LEADER_LEAVE              = 0x08,
84    GUILD_PERMISSIONS               = 0x08,
85    GUILD_PLAYER_NOT_IN_GUILD       = 0x09,
86    GUILD_PLAYER_NOT_IN_GUILD_S     = 0x0A,
87    GUILD_PLAYER_NOT_FOUND          = 0x0B,
88    GUILD_NOT_ALLIED                = 0x0C,
89    GUILD_RANK_TOO_HIGH_S           = 0x0D,
90    GUILD_ALREADY_LOWEST_RANK_S     = 0x0E,
91    GUILD_TEMP_ERROR                = 0x11,
92    GUILD_RANK_IN_USE               = 0x12,
93    GUILD_IGNORE                    = 0x13,
94    GUILD_ERR_UNK1                  = 0x17,
95    GUILD_WITHDRAW_TOO_MUCH         = 0x18,
96    GUILD_BANK_NO_MONEY             = 0x19,
97    GUILD_BANK_TAB_IS_FULL          = 0x1B,
98    GUILD_BANK_ITEM_NOT_FOUND       = 0x1C
99};
100
101enum GuildEvents
102{
103    GE_PROMOTION        = 0x00,
104    GE_DEMOTION         = 0x01,
105    GE_MOTD             = 0x02,
106    GE_JOINED           = 0x03,
107    GE_LEFT             = 0x04,
108    GE_REMOVED          = 0x05,
109    GE_LEADER_IS        = 0x06,
110    GE_LEADER_CHANGED   = 0x07,
111    GE_DISBANDED        = 0x08,
112    GE_TABARDCHANGE     = 0x09,
113    GE_UNK1             = 0x0A,                             // string, string
114    GE_UNK2             = 0x0B,
115    GE_SIGNED_ON        = 0x0C,
116    GE_SIGNED_OFF       = 0x0D,
117    GE_UNK3             = 0x0E,
118    GE_BANKTAB_PURCHASED= 0x0F,
119    GE_UNK5             = 0x10,
120    GE_UNK6             = 0x11,                             // string 0000000000002710 is 1 gold
121    GE_UNK7             = 0x12
122};
123
124enum PetitionTurns
125{
126    PETITION_TURN_OK                    = 0,
127    PETITION_TURN_ALREADY_IN_GUILD      = 2,
128    PETITION_TURN_NEED_MORE_SIGNATURES  = 4,
129};
130
131enum PetitionSigns
132{
133    PETITION_SIGN_OK                = 0,
134    PETITION_SIGN_ALREADY_SIGNED    = 1,
135    PETITION_SIGN_ALREADY_IN_GUILD  = 2,
136    PETITION_SIGN_CANT_SIGN_OWN     = 3,
137    PETITION_SIGN_NOT_SERVER        = 4,
138};
139
140enum GuildBankRights
141{
142    GUILD_BANK_RIGHT_VIEW_TAB       = 0x01,
143    GUILD_BANK_RIGHT_PUT_ITEM       = 0x02,
144    GUILD_BANK_RIGHT_UPDATE_TEXT    = 0x04,
145
146    GUILD_BANK_RIGHT_DEPOSIT_ITEM   = GUILD_BANK_RIGHT_VIEW_TAB | GUILD_BANK_RIGHT_PUT_ITEM,
147    GUILD_BANK_RIGHT_FULL           = 0xFF,
148};
149
150enum GuildBankLogEntries
151{
152    GUILD_BANK_LOG_DEPOSIT_ITEM     = 1,
153    GUILD_BANK_LOG_WITHDRAW_ITEM    = 2,
154    GUILD_BANK_LOG_MOVE_ITEM        = 3,
155    GUILD_BANK_LOG_DEPOSIT_MONEY    = 4,
156    GUILD_BANK_LOG_WITHDRAW_MONEY   = 5,
157    GUILD_BANK_LOG_REPAIR_MONEY     = 6,
158    GUILD_BANK_LOG_MOVE_ITEM2       = 7,
159};
160
161enum GuildEventLogEntryTypes
162{
163    GUILD_EVENT_LOG_INVITE_PLAYER     = 1,
164    GUILD_EVENT_LOG_JOIN_GUILD        = 2,
165    GUILD_EVENT_LOG_PROMOTE_PLAYER    = 3,
166    GUILD_EVENT_LOG_DEMOTE_PLAYER     = 4,
167    GUILD_EVENT_LOG_UNINVITE_PLAYER   = 5,
168    GUILD_EVENT_LOG_LEAVE_GUILD       = 6,
169};
170
171struct GuildEventlogEntry
172{
173    uint32 LogGuid;
174    uint8  EventType;
175    uint32 PlayerGuid1;
176    uint32 PlayerGuid2;
177    uint8  NewRank;
178    uint64 TimeStamp;
179};
180
181enum GuildEmblem
182{
183    ERR_GUILDEMBLEM_SUCCESS               = 0,
184    ERR_GUILDEMBLEM_INVALID_TABARD_COLORS = 1,
185    ERR_GUILDEMBLEM_NOGUILD               = 2,
186    ERR_GUILDEMBLEM_NOTGUILDMASTER        = 3,
187    ERR_GUILDEMBLEM_NOTENOUGHMONEY        = 4,
188    ERR_GUILDEMBLEM_INVALIDVENDOR         = 5
189};
190
191struct GuildBankEvent
192{
193    uint32 LogGuid;
194    uint8  LogEntry;
195    uint8  TabId;
196    uint32 PlayerGuid;
197    uint32 ItemOrMoney;
198    uint8  ItemStackCount;
199    uint8  DestTabId;
200    uint64 TimeStamp;
201
202    const bool isMoneyEvent()
203    {
204        return LogEntry == GUILD_BANK_LOG_DEPOSIT_MONEY ||
205            LogEntry == GUILD_BANK_LOG_WITHDRAW_MONEY ||
206            LogEntry == GUILD_BANK_LOG_REPAIR_MONEY;
207    }
208};
209
210struct GuildBankTab
211{
212    Item* Slots[GUILD_BANK_MAX_SLOTS];
213    std::string Name;
214    std::string Icon;
215    std::string Text;
216};
217
218struct GuildItemPosCount
219{
220    GuildItemPosCount(uint8 _slot, uint8 _count) : slot(_slot), count(_count) {}
221
222    bool isContainedIn(std::vector<GuildItemPosCount> const& vec) const;
223
224    uint8 slot;
225    uint8 count;
226};
227typedef std::vector<GuildItemPosCount> GuildItemPosCountVec;
228
229struct MemberSlot
230{
231    uint64 logout_time;
232    std::string name;
233    std::string Pnote;
234    std::string OFFnote;
235    uint32 RankId;
236    uint32 zoneId;
237    uint8 level;
238    uint8 Class;
239    uint32 BankResetTimeMoney;
240    uint32 BankRemMoney;
241    uint32 BankResetTimeTab[GUILD_BANK_MAX_TABS];
242    uint32 BankRemSlotsTab[GUILD_BANK_MAX_TABS];
243};
244
245struct RankInfo
246{
247    RankInfo(std::string _name, uint32 _rights, uint32 _money) : name(_name), rights(_rights), BankMoneyPerDay(_money)
248    {
249        for(uint8 i = 0; i < GUILD_BANK_MAX_TABS; ++i)
250        {
251            TabRight[i] = 0;
252            TabSlotPerDay[i] = 0;
253        }
254    }
255
256    std::string name;
257    uint32 rights;
258    uint32 BankMoneyPerDay;
259    uint32 TabRight[GUILD_BANK_MAX_TABS];
260    uint32 TabSlotPerDay[GUILD_BANK_MAX_TABS];
261};
262
263class Guild
264{
265    public:
266        Guild();
267        ~Guild();
268
269        bool create(uint64 lGuid, std::string gname);
270        void Disband();
271
272        typedef std::map<uint32, MemberSlot> MemberList;
273        typedef std::vector<RankInfo> RankList;
274
275        uint32 GetId(){ return Id; }
276        const uint64& GetLeader(){ return leaderGuid; }
277        std::string GetName(){ return name; }
278        std::string GetMOTD(){ return MOTD; }
279        std::string GetGINFO(){ return GINFO; }
280
281        uint32 GetCreatedYear(){ return CreatedYear; }
282        uint32 GetCreatedMonth(){ return CreatedMonth; }
283        uint32 GetCreatedDay(){ return CreatedDay; }
284
285        uint32 GetEmblemStyle(){ return EmblemStyle; }
286        uint32 GetEmblemColor(){ return EmblemColor; }
287        uint32 GetBorderStyle(){ return BorderStyle; }
288        uint32 GetBorderColor(){ return BorderColor; }
289        uint32 GetBackgroundColor(){ return BackgroundColor; }
290
291        void SetLeader(uint64 guid);
292        bool AddMember(uint64 plGuid, uint32 plRank);
293        void ChangeRank(uint64 guid, uint32 newRank);
294        void DelMember(uint64 guid, bool isDisbanding=false);
295        uint32 GetLowestRank() const { return GetNrRanks()-1; }
296
297        void SetMOTD(std::string motd);
298        void SetGINFO(std::string ginfo);
299        void SetPNOTE(uint64 guid,std::string pnote);
300        void SetOFFNOTE(uint64 guid,std::string offnote);
301        void SetEmblem(uint32 emblemStyle, uint32 emblemColor, uint32 borderStyle, uint32 borderColor, uint32 backgroundColor);
302
303        uint32 GetMemberSize() const { return members.size(); }
304
305        bool LoadGuildFromDB(uint32 GuildId);
306        bool LoadRanksFromDB(uint32 GuildId);
307        bool LoadMembersFromDB(uint32 GuildId);
308
309        bool FillPlayerData(uint64 guid, MemberSlot* memslot);
310        void LoadPlayerStatsByGuid(uint64 guid);
311
312        void BroadcastToGuild(WorldSession *session, std::string msg, uint32 language = LANG_UNIVERSAL);
313        void BroadcastToOfficers(WorldSession *session, std::string msg, uint32 language = LANG_UNIVERSAL);
314        void BroadcastPacketToRank(WorldPacket *packet, uint32 rankId);
315        void BroadcastPacket(WorldPacket *packet);
316
317        void CreateRank(std::string name,uint32 rights);
318        void DelRank();
319        std::string GetRankName(uint32 rankId);
320        uint32 GetRankRights(uint32 rankId);
321        uint32 GetNrRanks() const { return m_ranks.size(); }
322
323        void SetRankName(uint32 rankId, std::string name);
324        void SetRankRights(uint32 rankId, uint32 rights);
325        bool HasRankRight(uint32 rankId, uint32 right)
326        {
327            return ((GetRankRights(rankId) & right) != GR_RIGHT_EMPTY) ? true : false;
328        }
329        int32 GetRank(uint32 LowGuid);
330        bool IsMember(uint32 LowGuid)
331        {
332            return (members.find(LowGuid) != members.end());
333        }
334        MemberSlot* GetMemberSlot(std::string const& name, uint64& guid)
335        {
336            for(MemberList::iterator itr = members.begin(); itr != members.end(); ++itr)
337            {
338                if(itr->second.name == name)
339                {
340                    guid = itr->first;
341                    return &itr->second;
342                }
343            }
344            return NULL;
345        }
346
347        void Roster(WorldSession *session);
348        void Query(WorldSession *session);
349
350        void UpdateLogoutTime(uint64 guid);
351        // Guild eventlog
352        void   LoadGuildEventLogFromDB();
353        void   UnloadGuildEventlog();
354        void   DisplayGuildEventlog(WorldSession *session);
355        void   LogGuildEvent(uint8 EventType, uint32 PlayerGuid1, uint32 PlayerGuid2, uint8 NewRank);
356        void   RenumGuildEventlog();
357
358        // ** Guild bank **
359        // Content & item deposit/withdraw
360        void   DisplayGuildBankContent(WorldSession *session, uint8 TabId);
361        void   DisplayGuildBankContentUpdate(uint8 TabId, int32 slot1, int32 slot2 = -1);
362        void   DisplayGuildBankContentUpdate(uint8 TabId, GuildItemPosCountVec const& slots);
363        void   DisplayGuildBankMoneyUpdate();
364
365        Item*  GetItem(uint8 TabId, uint8 SlotId);
366        uint8  CanStoreItem( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32 count, Item *pItem, bool swap = false) const;
367        Item*  StoreItem( uint8 tab, GuildItemPosCountVec const& pos, Item *pItem );
368        void   RemoveItem(uint8 tab, uint8 slot );
369
370        // Tabs
371        void   DisplayGuildBankTabsInfo(WorldSession *session);
372        void   CreateNewBankTab();
373        void   SetGuildBankTabText(uint8 TabId, std::string text);
374        void   SendGuildBankTabText(WorldSession *session, uint8 TabId);
375        void   SetGuildBankTabInfo(uint8 TabId, std::string name, std::string icon);
376        void   CreateBankRightForTab(uint32 rankid, uint8 TabId);
377        const  GuildBankTab *GetBankTab(uint8 index) { if(index >= m_TabListMap.size()) return NULL; return m_TabListMap[index]; }
378        const  uint8 GetPurchasedTabs() const { return purchased_tabs; }
379        uint32 GetBankRights(uint32 rankId, uint8 TabId) const;
380        bool   IsMemberHaveRights(uint32 LowGuid, uint8 TabId,uint32 rights) const;
381        bool   CanMemberViewTab(uint32 LowGuid, uint8 TabId) const;
382        // Load/unload
383        void   LoadGuildBankFromDB();
384        void   UnloadGuildBank();
385        void   IncOnlineMemberCount() { ++m_onlinemembers; }
386        // Money deposit/withdraw
387        void   SendMoneyInfo(WorldSession *session, uint32 LowGuid);
388        bool   MemberMoneyWithdraw(uint32 amount, uint32 LowGuid);
389        uint64 GetGuildBankMoney() { return guildbank_money; }
390        void   SetBankMoney(int64 money);
391        // per days
392        bool   MemberItemWithdraw(uint8 TabId, uint32 LowGuid);
393        uint32 GetMemberSlotWithdrawRem(uint32 LowGuid, uint8 TabId);
394        uint32 GetMemberMoneyWithdrawRem(uint32 LowGuid);
395        void   SetBankMoneyPerDay(uint32 rankId, uint32 money);
396        void   SetBankRightsAndSlots(uint32 rankId, uint8 TabId, uint32 right, uint32 SlotPerDay, bool db);
397        uint32 GetBankMoneyPerDay(uint32 rankId);
398        uint32 GetBankSlotPerDay(uint32 rankId, uint8 TabId);
399        // rights per day
400        void   LoadBankRightsFromDB(uint32 GuildId);
401        // logs
402        void   LoadGuildBankEventLogFromDB();
403        void   UnloadGuildBankEventLog();
404        void   DisplayGuildBankLogs(WorldSession *session, uint8 TabId);
405        void   LogBankEvent(uint8 LogEntry, uint8 TabId, uint32 PlayerGuidLow, uint32 ItemOrMoney, uint8 ItemStackCount=0, uint8 DestTabId=0);
406        void   RenumBankLogs();
407        bool   AddGBankItemToDB(uint32 GuildId, uint32 BankTab , uint32 BankTabSlot , uint32 GUIDLow, uint32 Entry );
408
409    protected:
410        void AddRank(std::string name,uint32 rights,uint32 money);
411
412        uint32 Id;
413        std::string name;
414        uint64 leaderGuid;
415        std::string MOTD;
416        std::string GINFO;
417        uint32 CreatedYear;
418        uint32 CreatedMonth;
419        uint32 CreatedDay;
420
421        uint32 EmblemStyle;
422        uint32 EmblemColor;
423        uint32 BorderStyle;
424        uint32 BorderColor;
425        uint32 BackgroundColor;
426
427        RankList m_ranks;
428
429        MemberList members;
430
431        typedef std::vector<GuildBankTab*> TabListMap;
432        TabListMap m_TabListMap;
433
434        /** These are actually ordered lists. The first element is the oldest entry.*/
435        typedef std::list<GuildEventlogEntry*> GuildEventlog;
436        typedef std::list<GuildBankEvent*> GuildBankEventLog;
437        GuildEventlog m_GuildEventlog;
438        GuildBankEventLog m_GuildBankEventLog_Money;
439        GuildBankEventLog m_GuildBankEventLog_Item[GUILD_BANK_MAX_TABS];
440
441        bool m_bankloaded;
442        bool m_eventlogloaded;
443        uint32 m_onlinemembers;
444        uint64 guildbank_money;
445        uint8 purchased_tabs;
446
447        uint32 LogMaxGuid;
448        uint32 GuildEventlogMaxGuid;
449    private:
450        // internal common parts for CanStore/StoreItem functions
451        void AppendDisplayGuildBankSlot( WorldPacket& data, GuildBankTab const *tab, int32 slot );
452        uint8 _CanStoreItem_InSpecificSlot( uint8 tab, uint8 slot, GuildItemPosCountVec& dest, uint32& count, bool swap, Item *pSrcItem ) const;
453        uint8 _CanStoreItem_InTab( uint8 tab, GuildItemPosCountVec& dest, uint32& count, bool merge, Item *pSrcItem, uint8 skip_slot ) const;
454        Item* _StoreItem( uint8 tab, uint8 slot, Item *pItem, uint32 count, bool clone );
455};
456#endif
Note: See TracBrowser for help on using the browser.