src/game/AchievementMgr.h

   1 /*
   2  * Copyright (C) 2005-2009 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 #ifndef __MANGOS_ACHIEVEMENTMGR_H
  19 #define __MANGOS_ACHIEVEMENTMGR_H
  20
  21 #include "Common.h"
  22 #include "Policies/Singleton.h"
  23 #include "Database/DatabaseEnv.h"
  24 #include "DBCEnums.h"
  25 #include "DBCStores.h"
  26
  27 #include <map>
  28 #include <string>
  29
  30 typedef std::list<AchievementCriteriaEntry const*> AchievementCriteriaEntryList;
  31 typedef std::list<AchievementEntry const*>         AchievementEntryList;
  32
  33 typedef std::map<uint32,AchievementCriteriaEntryList> AchievementCriteriaListByAchievement;
  34 typedef std::map<uint32,AchievementEntryList>         AchievementListByReferencedId;
  35
  36 struct CriteriaProgress
  37 {
  38     uint32 counter;
  39     time_t date;
  40     bool changed;
  41 };
  42
  43 enum AchievementCriteriaDataType
  44 {                                                           // value1         value2        comment
  45     ACHIEVEMENT_CRITERIA_DATA_TYPE_NONE                = 0, // 0              0
  46     ACHIEVEMENT_CRITERIA_DATA_TYPE_T_CREATURE          = 1, // creature_id    0
  47     ACHIEVEMENT_CRITERIA_DATA_TYPE_T_PLAYER_CLASS_RACE = 2, // class_id       race_id
  48     ACHIEVEMENT_CRITERIA_DATA_TYPE_T_PLAYER_LESS_HEALTH= 3, // health_percent 0
  49     ACHIEVEMENT_CRITERIA_DATA_TYPE_T_PLAYER_DEAD       = 4, // 0              0             not corpse (not released body)
  50     ACHIEVEMENT_CRITERIA_DATA_TYPE_S_AURA              = 5, // spell_id       effect_idx
  51     ACHIEVEMENT_CRITERIA_DATA_TYPE_S_AREA              = 6, // area id        0
  52     ACHIEVEMENT_CRITERIA_DATA_TYPE_T_AURA              = 7, // spell_id       effect_idx
  53 };
  54
  55 #define MAX_ACHIEVEMENT_CRITERIA_DATA_TYPE               8  // maximum value in AchievementCriteriaDataType enum
  56
  57 class Player;
  58 class Unit;
  59
  60 struct AchievementCriteriaData
  61 {
  62     AchievementCriteriaDataType dataType;
  63     union
  64     {
  65         // ACHIEVEMENT_CRITERIA_DATA_TYPE_T_CREATURE
  66         struct
  67         {
  68             uint32 id;
  69         } creature;
  70         // ACHIEVEMENT_CRITERIA_DATA_TYPE_T_PLAYER_CLASS_RACE
  71         struct
  72         {
  73             uint32 class_id;
  74             uint32 race_id;
  75         } classRace;
  76         // ACHIEVEMENT_CRITERIA_DATA_TYPE_T_PLAYER_LESS_HEALTH
  77         struct
  78         {
  79             uint32 percent;
  80         } health;
  81         // ACHIEVEMENT_CRITERIA_DATA_TYPE_T_AURA
  82         // ACHIEVEMENT_CRITERIA_DATA_TYPE_S_AURA
  83         struct
  84         {
  85             uint32 spell_id;
  86             uint32 effect_idx;
  87         } aura;
  88         // ACHIEVEMENT_CRITERIA_DATA_TYPE_S_AREA
  89         struct
  90         {
  91             uint32 id;
  92         } area;
  93         // ...
  94         struct
  95         {
  96             uint32 value1;
  97             uint32 value2;
  98         } raw;
  99     };
 100
 101     AchievementCriteriaData() : dataType(ACHIEVEMENT_CRITERIA_DATA_TYPE_NONE)
 102     {
 103         raw.value1 = 0;
 104         raw.value2 = 0;
 105     }
 106
 107     AchievementCriteriaData(uint32 _dataType, uint32 _value1, uint32 _value2) : dataType(AchievementCriteriaDataType(_dataType))
 108     {
 109         raw.value1 = _value1;
 110         raw.value2 = _value2;
 111     }
 112
 113     bool IsValid(AchievementCriteriaEntry const* criteria);
 114     bool Meets(Player const* source, Unit const* target) const;
 115 };
 116
 117 struct AchievementCriteriaDataSet
 118 {
 119         typedef std::vector<AchievementCriteriaData> Storage;
 120         void Add(AchievementCriteriaData const& data) { storage.push_back(data); }
 121         bool Meets(Player const* source, Unit const* target) const;
 122     private:
 123         Storage storage;
 124 };
 125
 126
 127 typedef std::map<uint32,AchievementCriteriaDataSet> AchievementCriteriaDataMap;
 128
 129 struct AchievementReward
 130 {
 131     uint32 titleId[2];
 132     uint32 itemId;
 133     uint32 sender;
 134     std::string subject;
 135     std::string text;
 136 };
 137
 138 typedef std::map<uint32,AchievementReward> AchievementRewards;
 139
 140 struct AchievementRewardLocale
 141 {
 142     std::vector<std::string> subject;
 143     std::vector<std::string> text;
 144 };
 145
 146 typedef std::map<uint32,AchievementRewardLocale> AchievementRewardLocales;
 147
 148
 149 struct CompletedAchievementData
 150 {
 151     time_t date;
 152     bool changed;
 153 };
 154
 155 typedef UNORDERED_MAP<uint32, CriteriaProgress> CriteriaProgressMap;
 156 typedef UNORDERED_MAP<uint32, CompletedAchievementData> CompletedAchievementMap;
 157
 158 class Unit;
 159 class Player;
 160 class WorldPacket;
 161
 162 class AchievementMgr
 163 {
 164     public:
 165         AchievementMgr(Player* pl);
 166         ~AchievementMgr();
 167
 168         void Reset();
 169         static void DeleteFromDB(uint32 lowguid);
 170         void LoadFromDB(QueryResult *achievementResult, QueryResult *criteriaResult);
 171         void SaveToDB();
 172         void ResetAchievementCriteria(AchievementCriteriaTypes type, uint32 miscvalue1=0, uint32 miscvalue2=0);
 173         void UpdateAchievementCriteria(AchievementCriteriaTypes type, uint32 miscvalue1=0, uint32 miscvalue2=0, Unit *unit=NULL, uint32 time=0);
 174         void CheckAllAchievementCriteria();
 175         void SendAllAchievementData();
 176         void SendRespondInspectAchievements(Player* player);
 177         Player* GetPlayer() { return m_player;}
 178
 179     private:
 180         enum ProgressType { PROGRESS_SET, PROGRESS_ACCUMULATE, PROGRESS_HIGHEST };
 181         void SendAchievementEarned(AchievementEntry const* achievement);
 182         void SendCriteriaUpdate(uint32 id, CriteriaProgress const* progress);
 183         void SetCriteriaProgress(AchievementCriteriaEntry const* entry, uint32 changeValue, ProgressType ptype = PROGRESS_SET);
 184         void CompletedCriteriaFor(AchievementEntry const* achievement);
 185         void CompletedAchievement(AchievementEntry const* entry);
 186         bool IsCompletedCriteria(AchievementCriteriaEntry const* criteria, AchievementEntry const* achievement);
 187         bool IsCompletedAchievement(AchievementEntry const* entry);
 188         void CompleteAchievementsWithRefs(AchievementEntry const* entry);
 189         void BuildAllDataPacket(WorldPacket *data);
 190
 191         Player* m_player;
 192         CriteriaProgressMap m_criteriaProgress;
 193         CompletedAchievementMap m_completedAchievements;
 194 };
 195
 196 class AchievementGlobalMgr
 197 {
 198     public:
 199         AchievementCriteriaEntryList const& GetAchievementCriteriaByType(AchievementCriteriaTypes type);
 200         AchievementCriteriaEntryList const* GetAchievementCriteriaByAchievement(uint32 id)
 201         {
 202             AchievementCriteriaListByAchievement::const_iterator itr = m_AchievementCriteriaListByAchievement.find(id);
 203             return itr != m_AchievementCriteriaListByAchievement.end() ? &itr->second : NULL;
 204         }
 205
 206         AchievementEntryList const* GetAchievementByReferencedId(uint32 id) const
 207         {
 208             AchievementListByReferencedId::const_iterator itr = m_AchievementListByReferencedId.find(id);
 209             return itr != m_AchievementListByReferencedId.end() ? &itr->second : NULL;
 210         }
 211
 212         AchievementReward const* GetAchievementReward(AchievementEntry const* achievement) const
 213         {
 214             AchievementRewards::const_iterator iter = m_achievementRewards.find(achievement->ID);
 215             return iter!=m_achievementRewards.end() ? &iter->second : NULL;
 216         }
 217
 218         AchievementRewardLocale const* GetAchievementRewardLocale(AchievementEntry const* achievement) const
 219         {
 220             AchievementRewardLocales::const_iterator iter = m_achievementRewardLocales.find(achievement->ID);
 221             return iter!=m_achievementRewardLocales.end() ? &iter->second : NULL;
 222         }
 223
 224         AchievementCriteriaDataSet const* GetCriteriaDataSet(AchievementCriteriaEntry const *achievementCriteria)
 225         {
 226             AchievementCriteriaDataMap::const_iterator iter = m_criteriaDataMap.find(achievementCriteria->ID);
 227             return iter!=m_criteriaDataMap.end() ? &iter->second : NULL;
 228         }
 229
 230         bool IsRealmCompleted(AchievementEntry const* achievement) const
 231         {
 232             return m_allCompletedAchievements.find(achievement->ID) != m_allCompletedAchievements.end();
 233         }
 234
 235         void SetRealmCompleted(AchievementEntry const* achievement)
 236         {
 237             m_allCompletedAchievements.insert(achievement->ID);
 238         }
 239
 240         void LoadAchievementCriteriaList();
 241         void LoadAchievementCriteriaData();
 242         void LoadAchievementReferenceList();
 243         void LoadCompletedAchievements();
 244         void LoadRewards();
 245         void LoadRewardLocales();
 246     private:
 247         AchievementCriteriaDataMap m_criteriaDataMap;
 248
 249         // store achievement criterias by type to speed up lookup
 250         AchievementCriteriaEntryList m_AchievementCriteriasByType[ACHIEVEMENT_CRITERIA_TYPE_TOTAL];
 251         // store achievement criterias by achievement to speed up lookup
 252         AchievementCriteriaListByAchievement m_AchievementCriteriaListByAchievement;
 253         // store achievements by referenced achievement id to speed up lookup
 254         AchievementListByReferencedId m_AchievementListByReferencedId;
 255
 256         typedef std::set<uint32> AllCompletedAchievements;
 257         AllCompletedAchievements m_allCompletedAchievements;
 258
 259         AchievementRewards m_achievementRewards;
 260         AchievementRewardLocales m_achievementRewardLocales;
 261 };
 262
 263 #define achievementmgr MaNGOS::Singleton<AchievementGlobalMgr>::Instance()
 264
 265 #endif