ryzom/server/src/entities_game_service/egs_pd.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (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 Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 #ifndef EGS_PD_H
  19 #define EGS_PD_H
  20
  21 #include <nel/misc/types_nl.h>
  22 #include <pd_lib/pd_lib.h>
  23
  24 namespace EGSPD
  25 {
  26
  27
  28 //
  29 // Global Forward Declarations
  30 //
  31
  32 class CFameContainerEntryPD;
  33 class CFameContainerPD;
  34 class CGuildFameContainerPD;
  35 class CGuildMemberPD;
  36 class CGuildPD;
  37 class CGuildContainerPD;
  38 class CActiveStepStatePD;
  39 class CActiveStepPD;
  40 class CDoneStepPD;
  41 class CMissionCompassPD;
  42 class CMissionTeleportPD;
  43 class CMissionInsidePlacePD;
  44 class CMissionOutsidePlacePD;
  45 class CHandledAIGroupPD;
  46 class CMissionPD;
  47 class CMissionGuildPD;
  48 class CMissionTeamPD;
  49 class CMissionSoloPD;
  50 class CMissionContainerPD;
  51
  52 //
  53
  54 /// \name Public API for EGSPD database
  55 // @{
  56
  57 /**
  58  * Initialise the whole database engine.
  59  * Call this function at service init.
  60  */
  61 void                                                    init(uint32 overrideDbId);
  62
  63 /**
  64  * Tells if database engine is ready to work.
  65  * Engine may not be ready because PDS is down, not yet ready
  66  * or message queue to PDS is full.
  67  */
  68 bool                                                    ready();
  69
  70 /**
  71  * Update the database engine.
  72  * Call this method once per tick, only if engine is ready (see also ready() above).
  73  */
  74 void                                                    update();
  75
  76 /**
  77  * Logs chat sentence with sender and receipiants.
  78  */
  79 void                                                    logChat(const ucstring& sentence, const NLMISC::CEntityId& from, const std::vector<NLMISC::CEntityId>& to);
  80
  81 /**
  82  * Logs tell sentence with sender and single recipient (might be player or group).
  83  */
  84 void                                                    logTell(const ucstring& sentence, const NLMISC::CEntityId& from, const NLMISC::CEntityId& to);
  85
  86 /**
  87  * Release the whole database engine.
  88  * Call this function at service release.
  89  */
  90 void                                                    release();
  91
  92 // @}
  93
  94 extern RY_PDS::CPDSLib  PDSLib;
  95
  96 } // End of EGSPD
  97
  98 //
  99 // Includes
 100 //
 101
 102 #include "common_pd.h"
 103 #include "game_share/people_pd.h"
 104 #include "game_share/sp_type.h"
 105 #include "game_share/guild_grade.h"
 106 #include "game_share/season.h"
 107 #include "fame_pd.h"
 108 #include "guild_member_pd.h"
 109 #include "guild_pd.h"
 110 #include "guild_container_pd.h"
 111 #include "mission_pd.h"
 112
 113 #include "fame_pd_inline.h"
 114 #include "guild_member_pd_inline.h"
 115 #include "guild_pd_inline.h"
 116 #include "guild_container_pd_inline.h"
 117 #include "mission_pd_inline.h"
 118
 119 //
 120
 121
 122 #include "egs_pd_inline.h"
 123
 124
 125 #endif