src/game/Pet.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
  19 #ifndef MANGOSSERVER_PET_H
  20 #define MANGOSSERVER_PET_H
  21
  22 #include "ObjectDefines.h"
  23 #include "Creature.h"
  24 #include "Unit.h"
  25
  26 enum PetType
  27 {
  28     SUMMON_PET              = 0,
  29     HUNTER_PET              = 1,
  30     GUARDIAN_PET            = 2,
  31     MINI_PET                = 3,
  32     MAX_PET_TYPE            = 4
  33 };
  34
  35 extern char const* petTypeSuffix[MAX_PET_TYPE];
  36
  37 #define MAX_PET_STABLES         4
  38
  39 // stored in character_pet.slot
  40 enum PetSaveMode
  41 {
  42     PET_SAVE_AS_DELETED        = -1,                        // not saved in fact
  43     PET_SAVE_AS_CURRENT        =  0,                        // in current slot (with player)
  44     PET_SAVE_FIRST_STABLE_SLOT =  1,
  45     PET_SAVE_LAST_STABLE_SLOT  =  MAX_PET_STABLES,          // last in DB stable slot index (including), all higher have same meaning as PET_SAVE_NOT_IN_SLOT
  46     PET_SAVE_NOT_IN_SLOT       =  100                       // for avoid conflict with stable size grow will use 100
  47 };
  48
  49 enum HappinessState
  50 {
  51     UNHAPPY = 1,
  52     CONTENT = 2,
  53     HAPPY   = 3
  54 };
  55
  56 enum PetSpellState
  57 {
  58     PETSPELL_UNCHANGED = 0,
  59     PETSPELL_CHANGED   = 1,
  60     PETSPELL_NEW       = 2,
  61     PETSPELL_REMOVED   = 3
  62 };
  63
  64 enum PetSpellType
  65 {
  66     PETSPELL_NORMAL = 0,
  67     PETSPELL_FAMILY = 1,
  68     PETSPELL_TALENT = 2,
  69 };
  70
  71 struct PetSpell
  72 {
  73     ActiveStates active : 16;
  74
  75     PetSpellState state : 8;
  76     PetSpellType type   : 8;
  77 };
  78
  79 enum ActionFeedback
  80 {
  81     FEEDBACK_NONE            = 0,
  82     FEEDBACK_PET_DEAD        = 1,
  83     FEEDBACK_NOTHING_TO_ATT  = 2,
  84     FEEDBACK_CANT_ATT_TARGET = 3
  85 };
  86
  87 enum PetTalk
  88 {
  89     PET_TALK_SPECIAL_SPELL  = 0,
  90     PET_TALK_ATTACK         = 1
  91 };
  92
  93 enum PetNameInvalidReason
  94 {
  95     PET_NAME_INVALID                                        = 1,
  96     PET_NAME_NO_NAME                                        = 2,
  97     PET_NAME_TOO_SHORT                                      = 3,
  98     PET_NAME_TOO_LONG                                       = 4,
  99     PET_NAME_MIXED_LANGUAGES                                = 6,
 100     PET_NAME_PROFANE                                        = 7,
 101     PET_NAME_RESERVED                                       = 8,
 102     PET_NAME_THREE_CONSECUTIVE                              = 11,
 103     PET_NAME_INVALID_SPACE                                  = 12,
 104     PET_NAME_CONSECUTIVE_SPACES                             = 13,
 105     PET_NAME_RUSSIAN_CONSECUTIVE_SILENT_CHARACTERS          = 14,
 106     PET_NAME_RUSSIAN_SILENT_CHARACTER_AT_BEGINNING_OR_END   = 15,
 107     PET_NAME_DECLENSION_DOESNT_MATCH_BASE_NAME              = 16
 108 };
 109
 110 typedef UNORDERED_MAP<uint32, PetSpell> PetSpellMap;
 111 typedef std::vector<uint32> AutoSpellList;
 112
 113 #define HAPPINESS_LEVEL_SIZE        333000
 114
 115 #define ACTIVE_SPELLS_MAX           4
 116
 117 #define OWNER_MAX_DISTANCE 100.0f
 118
 119 #define PET_FOLLOW_DIST  1
 120 #define PET_FOLLOW_ANGLE (M_PI/2)
 121
 122 class Player;
 123
 124 class Pet : public Creature
 125 {
 126     public:
 127         explicit Pet(PetType type = MAX_PET_TYPE);
 128         virtual ~Pet();
 129
 130         void AddToWorld();
 131         void RemoveFromWorld();
 132
 133         PetType getPetType() const { return m_petType; }
 134         void setPetType(PetType type) { m_petType = type; }
 135         bool isControlled() const { return getPetType()==SUMMON_PET || getPetType()==HUNTER_PET; }
 136         bool isTemporarySummoned() const { return m_duration > 0; }
 137
 138         bool IsPermanentPetFor(Player* owner);              // pet have tab in character windows and set UNIT_FIELD_PETNUMBER
 139
 140         bool Create (uint32 guidlow, Map *map, uint32 phaseMask, uint32 Entry, uint32 pet_number);
 141         bool CreateBaseAtCreature(Creature* creature);
 142         bool LoadPetFromDB( Player* owner,uint32 petentry = 0,uint32 petnumber = 0, bool current = false );
 143         void SavePetToDB(PetSaveMode mode);
 144         void Remove(PetSaveMode mode, bool returnreagent = false);
 145         static void DeleteFromDB(uint32 guidlow);
 146
 147         void setDeathState(DeathState s);                   // overwrite virtual Creature::setDeathState and Unit::setDeathState
 148         void Update(uint32 diff);                           // overwrite virtual Creature::Update and Unit::Update
 149
 150         uint8 GetPetAutoSpellSize() const { return m_autospells.size(); }
 151         uint32 GetPetAutoSpellOnPos(uint8 pos) const
 152         {
 153             if (pos >= m_autospells.size())
 154                 return 0;
 155             else
 156                 return m_autospells[pos];
 157         }
 158
 159         void Regenerate(Powers power);
 160         void LooseHappiness();
 161         HappinessState GetHappinessState();
 162         void GivePetXP(uint32 xp);
 163         void GivePetLevel(uint32 level);
 164         void SynchronizeLevelWithOwner();
 165         bool InitStatsForLevel(uint32 level);
 166         bool HaveInDiet(ItemPrototype const* item) const;
 167         uint32 GetCurrentFoodBenefitLevel(uint32 itemlevel);
 168         void SetDuration(int32 dur) { m_duration = dur; }
 169
 170         int32 GetBonusDamage() { return m_bonusdamage; }
 171         void SetBonusDamage(int32 damage) { m_bonusdamage = damage; }
 172
 173         bool UpdateStats(Stats stat);
 174         bool UpdateAllStats();
 175         void UpdateResistances(uint32 school);
 176         void UpdateArmor();
 177         void UpdateMaxHealth();
 178         void UpdateMaxPower(Powers power);
 179         void UpdateAttackPowerAndDamage(bool ranged = false);
 180         void UpdateDamagePhysical(WeaponAttackType attType);
 181
 182         bool CanTakeMoreActiveSpells(uint32 SpellIconID);
 183         void ToggleAutocast(uint32 spellid, bool apply);
 184
 185         bool HasSpell(uint32 spell) const;
 186
 187         void LearnPetPassives();
 188         void CastPetAuras(bool current);
 189         void CastPetAura(PetAura const* aura);
 190
 191         void _LoadSpellCooldowns();
 192         void _SaveSpellCooldowns();
 193         void _LoadAuras(uint32 timediff);
 194         void _SaveAuras();
 195         void _LoadSpells();
 196         void _SaveSpells();
 197
 198         bool addSpell(uint32 spell_id,ActiveStates active = ACT_DECIDE, PetSpellState state = PETSPELL_NEW, PetSpellType type = PETSPELL_NORMAL);
 199         bool learnSpell(uint32 spell_id);
 200         void learnSpellHighRank(uint32 spellid);
 201         void InitLevelupSpellsForLevel();
 202         bool unlearnSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 203         bool removeSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 204         void CleanupActionBar();
 205
 206         PetSpellMap     m_spells;
 207         AutoSpellList   m_autospells;
 208
 209         void InitPetCreateSpells();
 210
 211         bool resetTalents(bool no_cost = false);
 212         uint32 resetTalentsCost() const;
 213         void InitTalentForLevel();
 214
 215         uint8 GetMaxTalentPointsForLevel(uint32 level);
 216         uint8 GetFreeTalentPoints() { return GetByteValue(UNIT_FIELD_BYTES_1, 1); }
 217         void SetFreeTalentPoints(uint8 points) { SetByteValue(UNIT_FIELD_BYTES_1, 1, points); }
 218
 219         uint32  m_resetTalentsCost;
 220         time_t  m_resetTalentsTime;
 221         uint32  m_usedTalentCount;
 222
 223         const uint64& GetAuraUpdateMask() const { return m_auraUpdateMask; }
 224         void SetAuraUpdateMask(uint8 slot) { m_auraUpdateMask |= (uint64(1) << slot); }
 225         void ResetAuraUpdateMask() { m_auraUpdateMask = 0; }
 226
 227         // overwrite Creature function for name localization back to WorldObject version without localization
 228         const char* GetNameForLocaleIdx(int32 locale_idx) const { return WorldObject::GetNameForLocaleIdx(locale_idx); }
 229
 230         DeclinedName const* GetDeclinedNames() const { return m_declinedname; }
 231
 232         bool    m_removed;                                  // prevent overwrite pet state in DB at next Pet::Update if pet already removed(saved)
 233     protected:
 234         uint32  m_happinessTimer;
 235         PetType m_petType;
 236         int32   m_duration;                                 // time until unsummon (used mostly for summoned guardians and not used for controlled pets)
 237         int32   m_bonusdamage;
 238         uint64  m_auraUpdateMask;
 239         bool    m_loading;
 240
 241         DeclinedName *m_declinedname;
 242
 243     private:
 244         void SaveToDB(uint32, uint8)                        // overwrited of Creature::SaveToDB     - don't must be called
 245         {
 246             assert(false);
 247         }
 248         void DeleteFromDB()                                 // overwrited of Creature::DeleteFromDB - don't must be called
 249         {
 250             assert(false);
 251         }
 252 };
 253 #endif