ryzom/client/src/interface_v3/guild_manager.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 // Copyright (C) 2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   7 //
   8 // This program is free software: you can redistribute it and/or modify
   9 // it under the terms of the GNU Affero General Public License as
  10 // published by the Free Software Foundation, either version 3 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU Affero General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Affero General Public License
  19 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22
  23 #ifndef RY_GUILD_MANAGER_H
  24 #define RY_GUILD_MANAGER_H
  25
  26 #include "nel/misc/types_nl.h"
  27 #include "obs_huge_list.h"
  28 #include "dbgroup_list_sheet_text.h"
  29 #include "nel/misc/cdb.h"
  30 #include "game_share/guild_grade.h"
  31 #include "game_share/misc_const.h"
  32
  33 // Must be the same as in database.xml
  34 #define MAX_GUILD_MEMBER 256
  35
  36 // ***************************************************************************
  37 struct SGuildMember
  38 {
  39         uint32          Index;  // Index in the DB
  40         uint32          NameID;
  41         std::string     Name;
  42         EGSPD::CGuildGrade::TGuildGrade Grade;
  43         TCharConnectionState                    Online;
  44         uint32          EnterDate;
  45         /////////////
  46         SGuildMember()
  47         {
  48                 Online = ccs_offline;
  49                 NameID = 0;
  50                 Grade = EGSPD::CGuildGrade::Member;
  51         }
  52 };
  53
  54 // ***************************************************************************
  55 struct SGuild
  56 {
  57         uint32          NameID;
  58         std::string     Name;
  59         uint64          Icon;
  60         bool            QuitGuildAvailable;
  61
  62         //////////////////////
  63         SGuild()
  64         {
  65                 NameID = 0;
  66                 Icon = 0;
  67                 QuitGuildAvailable = true;
  68         }
  69 };
  70
  71 // ***************************************************************************
  72 /**
  73  * class used to manage the guild of the current player
  74  * for the moment its used only to regroup access to the good data
  75  * \author Matthieu 'TrapII' Besson
  76  * \author Nevrax France
  77  * \date August 2003
  78  */
  79 class CGuildManager
  80 {
  81
  82 public:
  83
  84         /// The singleton 's instance
  85         static CGuildManager* getInstance()
  86         {
  87                 if (_Instance == NULL)
  88                         _Instance = new CGuildManager;
  89                 return _Instance;
  90         }
  91
  92         static void release()
  93         {
  94                 if (_Instance != NULL)
  95                         delete _Instance;
  96                 _Instance = NULL;
  97         }
  98
  99         /// Destructor
 100         virtual ~CGuildManager();
 101
 102         const SGuild &getGuild() { return _Guild; }
 103         const std::vector<SGuildMember> &getGuildMembers() { return _GuildMembers; }
 104
 105         enum TSortOrder
 106         {
 107                 sort_grade,
 108                 START_SORT_ORDER = sort_grade,
 109                 sort_name,
 110                 sort_online,
 111                 END_SORT_ORDER
 112         };
 113
 114         void sortGuildMembers(TSortOrder order = sort_grade);
 115
 116         /// Check if the guild is a proxified guild (not managed on the actual shard)
 117         bool isProxy();
 118
 119         /// Called from server (impulse message)
 120         //void init (const std::vector< std::pair<uint32,uint8> > &NameGrade);
 121
 122         /// Called from server (if MemberName==0 and MemberGrade==Unknown then remove the entry)
 123         //void set (uint32 indexMember, uint32 MemberName, uint8 MemberGrade, bool bOnline);
 124
 125         /// Indicate if the player belongs to a guild
 126         bool isInGuild();
 127
 128         /// Tell if we can recruit (invit a player in our guild)
 129         bool canRecruit();
 130
 131         /// Indicate if the player belongs to a guild
 132         bool isLeaderOfTheGuild();
 133
 134         /// If the player is in a guild get the guild name else return empty
 135         std::string getGuildName();
 136
 137         /// If the player is in a guild get the amount of money the guild owns else return zero
 138         uint64 getMoney();
 139
 140         /// If the player is in a guild get the XP the guild owns else return zero
 141         uint64 getXP();
 142
 143         /// If the player is in a guild get the guild grade
 144         EGSPD::CGuildGrade::TGuildGrade getGrade() { return _Grade; }
 145
 146         // Called once by frame to check if we have to rebuild interface
 147         void update();
 148
 149         // Launch ascensor interface
 150         void launchAscensor();
 151
 152         // Quit ascensor interface
 153         void quitAscensor();
 154
 155         // Launch join proposal interface (when a guild member player wants to invite you in its guild)
 156         void launchJoinProposal(uint32 phraseID);
 157
 158         // Close interface
 159         void quitJoinProposal();
 160
 161         // When quitting a guild we have to close all guild interfaces
 162         void closeAllInterfaces();
 163
 164         // Rebuild guild interface now
 165         void rebuildInterface();
 166
 167         // Open the guild window
 168         void openGuildWindow();
 169
 170         // Icon manipulations
 171         // ------------------
 172         // Icon is designed like this :
 173         // back image           : 4 bits at pos 0
 174         // symbol image         : 6 bits at pos 4
 175         // invert symbol        : 1 bits at pos 10
 176         // color back 1 R       : 8 bits at pos 11
 177         // color back 1 G       : 8 bits at pos 19
 178         // color back 1 B       : 8 bits at pos 27
 179         // color back 2 R       : 8 bits at pos 35
 180         // color back 2 G       : 8 bits at pos 43
 181         // color back 2 B       : 8 bits at pos 51
 182
 183         static uint64 iconMake (uint8 back, uint8 symb, bool inv, NLMISC::CRGBA col1, NLMISC::CRGBA col2)
 184         {
 185                 return ((uint64)(back&15)) | (((uint64)(symb&63))<<4) | (((uint64)(inv&1))<<10) |       \
 186                                 (((uint64)(col1.R&255))<<11) | (((uint64)(col1.G&255))<<19) | (((uint64)(col1.B&255))<<27) | \
 187                                 (((uint64)(col2.R&255))<<35) | (((uint64)(col2.G&255))<<43) | (((uint64)(col2.B&255))<<51);
 188         }
 189
 190         static uint8 iconGetBack(uint64 icon) { return (uint8)(icon&15); }
 191         static uint8 iconGetSymbol(uint64 icon) { return (uint8)(icon>>4)&63; }
 192         static bool  iconGetInvertSymbol(uint64 icon) { return ((uint8)(icon>>10)&1)==0?false:true; }
 193         static NLMISC::CRGBA iconGetColor1(uint64 icon) { return NLMISC::CRGBA((uint8)(icon>>11)&255,(uint8)(icon>>19)&255,(uint8)(icon>>27)&255); }
 194         static NLMISC::CRGBA iconGetColor2(uint64 icon) { return NLMISC::CRGBA((uint8)(icon>>35)&255,(uint8)(icon>>43)&255,(uint8)(icon>>51)&255); }
 195
 196         static void iconSetBack(uint64 &icon,uint8 n) { icon &= ~((uint64)15); icon |= ((uint64)n&15); }
 197         static void iconSetSymbol(uint64 &icon,uint8 n) { icon &= ~((uint64)63<<4); icon |= (((uint64)n&63)<<4); }
 198         static void iconSetInvertSymbol(uint64 &icon,bool inv) { icon &= ~((uint64)1<<10);      uint64 n = inv ? 1 : 0; icon |= n << 10; }
 199         static void iconSetColor1(uint64 &icon, NLMISC::CRGBA col) { icon &= ~((uint64)255<<11); icon &= ~((uint64)255<<19); icon &= ~((uint64)255<<27);
 200                                                                                                                                 icon |= ((uint64)col.R<<11); icon |= ((uint64)col.G<<19); icon |= ((uint64)col.B<<27); }
 201         static void iconSetColor2(uint64 &icon, NLMISC::CRGBA col) { icon &= ~((uint64)255<<35); icon &= ~((uint64)255<<43); icon &= ~((uint64)255<<51);
 202                                                                                                                                 icon |= ((uint64)col.R<<35); icon |= ((uint64)col.G<<43); icon |= ((uint64)col.B<<51); }
 203
 204
 205 private:
 206
 207         void initForDebug();
 208
 209         // Rebuild (at next update) this is called internally by the observer on DB
 210         void rebuildBasic() { _NeedRebuild = true; }
 211         // Need to rebuild Members at next update (+all). this is called internally by the observer on DB
 212         void rebuildBasicAndMembers()  { _NeedRebuild = _NeedRebuildMembers = true; }
 213
 214
 215         // Database management stuff
 216         class CDBObs : public NLMISC::ICDBNode::IPropertyObserver
 217         {
 218         public:
 219                 virtual void update(NLMISC::ICDBNode* node);
 220         };
 221         class CDBObsMembers : public NLMISC::ICDBNode::IPropertyObserver
 222         {
 223         public:
 224                 virtual void update(NLMISC::ICDBNode* node);
 225         };
 226
 227         CDBObs                  _DBObs;
 228         CDBObsMembers   _DBObsMembers;
 229         friend class CDBObs;
 230         friend class CDBObsMembers;
 231
 232         void initDBObservers();
 233
 234         // need rebuild data?
 235         bool _NeedRebuild;
 236         bool _NeedRebuildMembers;
 237         // need update (typically names, after rebuild done)
 238         bool _NeedUpdate;
 239         bool _NeedUpdateMembers;
 240
 241 private:
 242
 243         /// Constructor
 244         CGuildManager();
 245
 246         /// Singleton's instance
 247         static CGuildManager*           _Instance;
 248
 249         // Does the local player belongs to a guild ?
 250         bool                                            _InGuild;
 251         // Name Description and icon of the local player guild
 252         SGuild                                          _Guild;
 253         // Grade of local player giving administration rights
 254         // Leader : bear | invite | xp | (kick/set rank) members, bearer, recruiter, officer, high officer or Leader
 255         // High Officer : bear | invite | xp | (kick/set rank) members, bearer, recruiter or officer
 256         // Officer : bear | invite | kick members, recruiter or bearer
 257         // Recruiter : invite
 258         // Bearer : bear
 259         // Member : nothing
 260         // bear=can bear the banner, invite=can invite other players to the guild, xp= can spend XP guild on role masters
 261         // kick=can kick a player out of the guild, set rank=set the rank of a guild member
 262         EGSPD::CGuildGrade::TGuildGrade         _Grade;
 263         // Guild Members of the guild the local player belong to
 264         std::vector<SGuildMember>       _GuildMembers;
 265
 266         // Lift handling
 267         CHugeListObs Ascensors;
 268
 269         // flag set to true when EGS says the player has joined the guild
 270         bool            _NewToTheGuild;
 271
 272         // Join Proposal handling
 273         uint32          _JoinPropPhraseID;
 274         std::string     _JoinPropPhrase;
 275         bool            _JoinPropUpdate;
 276 };
 277
 278
 279 // ***************************************************************************
 280 class CDBGroupListAscensor : public CDBGroupListSheetText
 281 {
 282 public:
 283         // A child node
 284         struct  CSheetChildAscensor : public CDBGroupListSheetText::CSheetChild
 285         {
 286                 enum TAscensorEntryType
 287                 {
 288                         LiftTypeExit,
 289                         LiftTypeGuild,
 290                         LiftTypeGuildAnnexe
 291                 };
 292
 293                 bool Setuped;
 294                 uint Index;
 295                 sint32 SecondSheetIdCache;
 296
 297                 virtual void init(CDBGroupListSheetText *pFather, uint index);
 298                 virtual bool isInvalidated(CDBGroupListSheetText *pFather);
 299                 virtual void updateViewText(CDBGroupListSheetText * /* pFather */) { }
 300                 virtual bool isSheetValid(CDBGroupListSheetText *pFather);
 301         };
 302
 303         CDBGroupListAscensor(const TCtorParam &param) : CDBGroupListSheetText(param)
 304         {
 305                 _CheckCoordAccelerated = false; // isInvalidated called each frame
 306         }
 307
 308         virtual CSheetChild *createSheetChild() { return new CSheetChildAscensor; }
 309 };
 310
 311
 312
 313 #endif // RY_GUILD_MANAGER_H
 314
 315 /* End of guild_manager.h */