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 #define CRITERIA_CAST_SPELL_REQ_COUNT 46
  31 #define ACHIEVEMENT_REWARD_COUNT 57
  32
  33 typedef std::list<AchievementCriteriaEntry const*> AchievementCriteriaEntryList;
  34 typedef std::list<AchievementEntry const*>         AchievementEntryList;
  35
  36 typedef std::map<uint32,AchievementCriteriaEntryList> AchievementCriteriaListByAchievement;
  37 typedef std::map<uint32,AchievementEntryList>         AchievementListByReferencedId;
  38
  39 struct CriteriaProgress
  40 {
  41     uint32 counter;
  42     time_t date;
  43     bool changed;
  44 };
  45
  46 struct CriteriaCastSpellRequirement
  47 {
  48     uint32 achievementCriteriaId;
  49     uint32 creatureEntry;
  50     uint8 playerClass;
  51     uint8 playerRace;
  52 };
  53
  54 struct AchievementReward
  55 {
  56     uint32 titleId[2];
  57     uint32 itemId;
  58     uint32 sender;
  59     std::string subject;
  60     std::string text;
  61 };
  62
  63 typedef std::map<uint32,AchievementReward> AchievementRewards;
  64
  65 struct AchievementRewardLocale
  66 {
  67     std::vector<std::string> subject;
  68     std::vector<std::string> text;
  69 };
  70
  71 typedef std::map<uint32,AchievementRewardLocale> AchievementRewardLocales;
  72
  73
  74 struct CompletedAchievementData
  75 {
  76     time_t date;
  77     bool changed;
  78 };
  79
  80 typedef UNORDERED_MAP<uint32, CriteriaProgress> CriteriaProgressMap;
  81 typedef UNORDERED_MAP<uint32, CompletedAchievementData> CompletedAchievementMap;
  82
  83 class Unit;
  84 class Player;
  85 class WorldPacket;
  86
  87 class AchievementMgr
  88 {
  89     public:
  90         AchievementMgr(Player* pl);
  91         ~AchievementMgr();
  92
  93         void Reset();
  94         static void DeleteFromDB(uint32 lowguid);
  95         void LoadFromDB(QueryResult *achievementResult, QueryResult *criteriaResult);
  96         void SaveToDB();
  97         void UpdateAchievementCriteria(AchievementCriteriaTypes type, uint32 miscvalue1=0, uint32 miscvalue2=0, Unit *unit=NULL, uint32 time=0);
  98         void CheckAllAchievementCriteria();
  99         void SendAllAchievementData();
 100         void SendRespondInspectAchievements(Player* player);
 101         Player* GetPlayer() { return m_player;}
 102
 103     private:
 104         enum ProgressType { PROGRESS_SET, PROGRESS_ACCUMULATE, PROGRESS_HIGHEST };
 105         void SendAchievementEarned(AchievementEntry const* achievement);
 106         void SendCriteriaUpdate(uint32 id, CriteriaProgress const* progress);
 107         void SetCriteriaProgress(AchievementCriteriaEntry const* entry, uint32 changeValue, ProgressType ptype = PROGRESS_SET);
 108         void CompletedCriteria(AchievementCriteriaEntry const* entry, AchievementEntry const* achievement);
 109         void CompletedAchievement(AchievementEntry const* entry);
 110         bool IsCompletedCriteria(AchievementCriteriaEntry const* criteria, AchievementEntry const* achievement);
 111         bool IsCompletedAchievement(AchievementEntry const* entry);
 112         void CompleteAchievementsWithRefs(AchievementEntry const* entry);
 113         void BuildAllDataPacket(WorldPacket *data);
 114
 115         Player* m_player;
 116         CriteriaProgressMap m_criteriaProgress;
 117         CompletedAchievementMap m_completedAchievements;
 118 };
 119
 120 class AchievementGlobalMgr
 121 {
 122     public:
 123         AchievementCriteriaEntryList const& GetAchievementCriteriaByType(AchievementCriteriaTypes type);
 124         AchievementCriteriaEntryList const* GetAchievementCriteriaByAchievement(uint32 id)
 125         {
 126             AchievementCriteriaListByAchievement::const_iterator itr = m_AchievementCriteriaListByAchievement.find(id);
 127             return itr != m_AchievementCriteriaListByAchievement.end() ? &itr->second : NULL;
 128         }
 129
 130         AchievementEntryList const* GetAchievementByReferencedId(uint32 id) const
 131         {
 132             AchievementListByReferencedId::const_iterator itr = m_AchievementListByReferencedId.find(id);
 133             return itr != m_AchievementListByReferencedId.end() ? &itr->second : NULL;
 134         }
 135
 136         AchievementReward const* GetAchievementReward(AchievementEntry const* achievement) const
 137         {
 138             AchievementRewards::const_iterator iter = m_achievementRewards.find(achievement->ID);
 139             return iter!=m_achievementRewards.end() ? &iter->second : NULL;
 140         }
 141
 142         AchievementRewardLocale const* GetAchievementRewardLocale(AchievementEntry const* achievement) const
 143         {
 144             AchievementRewardLocales::const_iterator iter = m_achievementRewardLocales.find(achievement->ID);
 145             return iter!=m_achievementRewardLocales.end() ? &iter->second : NULL;
 146         }
 147
 148         static CriteriaCastSpellRequirement const * GetCriteriaCastSpellRequirement(AchievementCriteriaEntry const *achievementCriteria)
 149         {
 150             for (uint32 i=0; i < CRITERIA_CAST_SPELL_REQ_COUNT; ++i)
 151                 if (m_criteriaCastSpellRequirements[i].achievementCriteriaId == achievementCriteria->ID)
 152                     return  &m_criteriaCastSpellRequirements[i];
 153
 154             return NULL;
 155         }
 156
 157         bool IsRealmCompleted(AchievementEntry const* achievement) const
 158         {
 159             return m_allCompletedAchievements.find(achievement->ID) != m_allCompletedAchievements.end();
 160         }
 161
 162         void SetRealmCompleted(AchievementEntry const* achievement)
 163         {
 164             m_allCompletedAchievements.insert(achievement->ID);
 165         }
 166
 167         void LoadAchievementCriteriaList();
 168         void LoadAchievementReferenceList();
 169         void LoadCompletedAchievements();
 170         void LoadRewards();
 171         void LoadRewardLocales();
 172     private:
 173         static const CriteriaCastSpellRequirement m_criteriaCastSpellRequirements[];
 174
 175         // store achievement criterias by type to speed up lookup
 176         AchievementCriteriaEntryList m_AchievementCriteriasByType[ACHIEVEMENT_CRITERIA_TYPE_TOTAL];
 177         // store achievement criterias by achievement to speed up lookup
 178         AchievementCriteriaListByAchievement m_AchievementCriteriaListByAchievement;
 179         // store achievements by referenced achievement id to speed up lookup
 180         AchievementListByReferencedId m_AchievementListByReferencedId;
 181
 182         typedef std::set<uint32> AllCompletedAchievements;
 183         AllCompletedAchievements m_allCompletedAchievements;
 184
 185         AchievementRewards m_achievementRewards;
 186         AchievementRewardLocales m_achievementRewardLocales;
 187 };
 188
 189 #define achievementmgr MaNGOS::Singleton<AchievementGlobalMgr>::Instance()
 190
 191 #endif