src/game/Pet.h

   1 /*
   2  * Copyright (C) 2005-2008 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 enum PetSaveMode
  38 {
  39     PET_SAVE_AS_DELETED       =-1,
  40     PET_SAVE_AS_CURRENT       = 0,
  41     PET_SAVE_IN_STABLE_SLOT_1 = 1,
  42     PET_SAVE_IN_STABLE_SLOT_2 = 2,
  43     PET_SAVE_NOT_IN_SLOT      = 3
  44 };
  45
  46 enum HappinessState
  47 {
  48     UNHAPPY = 1,
  49     CONTENT = 2,
  50     HAPPY   = 3
  51 };
  52
  53 enum LoyaltyLevel
  54 {
  55     REBELLIOUS  = 1,
  56     UNRULY      = 2,
  57     SUBMISSIVE  = 3,
  58     DEPENDABLE  = 4,
  59     FAITHFUL    = 5,
  60     BEST_FRIEND = 6
  61 };
  62
  63 enum PetSpellState
  64 {
  65     PETSPELL_UNCHANGED = 0,
  66     PETSPELL_CHANGED   = 1,
  67     PETSPELL_NEW       = 2,
  68     PETSPELL_REMOVED   = 3
  69 };
  70
  71 enum PetSpellType
  72 {
  73     PETSPELL_NORMAL = 0,
  74     PETSPELL_FAMILY = 1,
  75 };
  76
  77 struct PetSpell
  78 {
  79     uint16 slotId;
  80     uint16 active;
  81     PetSpellState state : 16;
  82     PetSpellType type   : 16;
  83 };
  84
  85 enum ActionFeedback
  86 {
  87     FEEDBACK_NONE            = 0,
  88     FEEDBACK_PET_DEAD        = 1,
  89     FEEDBACK_NOTHING_TO_ATT  = 2,
  90     FEEDBACK_CANT_ATT_TARGET = 3
  91 };
  92
  93 enum PetTalk
  94 {
  95     PET_TALK_SPECIAL_SPELL  = 0,
  96     PET_TALK_ATTACK         = 1
  97 };
  98
  99 enum PetNameInvalidReason
 100 {
 101     PET_NAME_INVALID                                        = 1,
 102     PET_NAME_NO_NAME                                        = 2,
 103     PET_NAME_TOO_SHORT                                      = 3,
 104     PET_NAME_TOO_LONG                                       = 4,
 105     PET_NAME_MIXED_LANGUAGES                                = 6,
 106     PET_NAME_PROFANE                                        = 7,
 107     PET_NAME_RESERVED                                       = 8,
 108     PET_NAME_THREE_CONSECUTIVE                              = 11,
 109     PET_NAME_INVALID_SPACE                                  = 12,
 110     PET_NAME_CONSECUTIVE_SPACES                             = 13,
 111     PET_NAME_RUSSIAN_CONSECUTIVE_SILENT_CHARACTERS          = 14,
 112     PET_NAME_RUSSIAN_SILENT_CHARACTER_AT_BEGINNING_OR_END   = 15,
 113     PET_NAME_DECLENSION_DOESNT_MATCH_BASE_NAME              = 16
 114 };
 115
 116 typedef UNORDERED_MAP<uint16, PetSpell*> PetSpellMap;
 117 typedef std::map<uint32,uint32> TeachSpellMap;
 118 typedef std::vector<uint32> AutoSpellList;
 119
 120 #define HAPPINESS_LEVEL_SIZE        333000
 121
 122 extern const uint32 LevelUpLoyalty[6];
 123 extern const uint32 LevelStartLoyalty[6];
 124
 125 #define ACTIVE_SPELLS_MAX           4
 126
 127 #define OWNER_MAX_DISTANCE 100
 128
 129 #define PET_FOLLOW_DIST  1
 130 #define PET_FOLLOW_ANGLE (M_PI/2)
 131
 132 class Pet : public Creature
 133 {
 134     public:
 135         explicit Pet(PetType type = MAX_PET_TYPE);
 136         virtual ~Pet();
 137
 138         void AddToWorld();
 139         void RemoveFromWorld();
 140
 141         PetType getPetType() const { return m_petType; }
 142         void setPetType(PetType type) { m_petType = type; }
 143         bool isControlled() const { return getPetType()==SUMMON_PET || getPetType()==HUNTER_PET; }
 144         bool isTemporarySummoned() const { return m_duration > 0; }
 145
 146         bool Create (uint32 guidlow, Map *map, uint32 Entry, uint32 pet_number);
 147         bool CreateBaseAtCreature( Creature* creature );
 148         bool LoadPetFromDB( Unit* owner,uint32 petentry = 0,uint32 petnumber = 0, bool current = false );
 149         void SavePetToDB(PetSaveMode mode);
 150         void Remove(PetSaveMode mode, bool returnreagent = false);
 151         static void DeleteFromDB(uint32 guidlow);
 152
 153         void setDeathState(DeathState s);                   // overwrite virtual Creature::setDeathState and Unit::setDeathState
 154         void Update(uint32 diff);                           // overwrite virtual Creature::Update and Unit::Update
 155
 156         uint8 GetPetAutoSpellSize() const { return m_autospells.size(); }
 157         uint32 GetPetAutoSpellOnPos(uint8 pos) const
 158         {
 159             if (pos >= m_autospells.size())
 160                 return 0;
 161             else
 162                 return m_autospells[pos];
 163         }
 164
 165         void RegenerateFocus();
 166         void LooseHappiness();
 167         void TickLoyaltyChange();
 168         void ModifyLoyalty(int32 addvalue);
 169         HappinessState GetHappinessState();
 170         uint32 GetMaxLoyaltyPoints(uint32 level);
 171         uint32 GetStartLoyaltyPoints(uint32 level);
 172         void KillLoyaltyBonus(uint32 level);
 173         uint32 GetLoyaltyLevel() { return GetByteValue(UNIT_FIELD_BYTES_1, 1); }
 174         void SetLoyaltyLevel(LoyaltyLevel level);
 175         void GivePetXP(uint32 xp);
 176         void GivePetLevel(uint32 level);
 177         bool InitStatsForLevel(uint32 level);
 178         bool HaveInDiet(ItemPrototype const* item) const;
 179         uint32 GetCurrentFoodBenefitLevel(uint32 itemlevel);
 180         void SetDuration(int32 dur) { m_duration = dur; }
 181
 182         int32 GetBonusDamage() { return m_bonusdamage; }
 183         void SetBonusDamage(int32 damage) { m_bonusdamage = damage; }
 184
 185         bool UpdateStats(Stats stat);
 186         bool UpdateAllStats();
 187         void UpdateResistances(uint32 school);
 188         void UpdateArmor();
 189         void UpdateMaxHealth();
 190         void UpdateMaxPower(Powers power);
 191         void UpdateAttackPowerAndDamage(bool ranged = false);
 192         void UpdateDamagePhysical(WeaponAttackType attType);
 193
 194         bool   CanTakeMoreActiveSpells(uint32 SpellIconID);
 195         void   ToggleAutocast(uint32 spellid, bool apply);
 196         bool   HasTPForSpell(uint32 spellid);
 197         int32  GetTPForSpell(uint32 spellid);
 198
 199         bool HasSpell(uint32 spell) const;
 200         void AddTeachSpell(uint32 learned_id, uint32 source_id) { m_teachspells[learned_id] = source_id; }
 201
 202         void LearnPetPassives();
 203         void CastPetAuras(bool current);
 204         void CastPetAura(PetAura const* aura);
 205
 206         void _LoadSpellCooldowns();
 207         void _SaveSpellCooldowns();
 208         void _LoadAuras(uint32 timediff);
 209         void _SaveAuras();
 210         void _LoadSpells();
 211         void _SaveSpells();
 212
 213         bool addSpell(uint16 spell_id,uint16 active = ACT_DECIDE, PetSpellState state = PETSPELL_NEW, uint16 slot_id=0xffff, PetSpellType type = PETSPELL_NORMAL);
 214         bool learnSpell(uint16 spell_id);
 215         void removeSpell(uint16 spell_id);
 216         bool _removeSpell(uint16 spell_id);
 217
 218         PetSpellMap     m_spells;
 219         TeachSpellMap   m_teachspells;
 220         AutoSpellList   m_autospells;
 221
 222         void InitPetCreateSpells();
 223         void CheckLearning(uint32 spellid);
 224         uint32 resetTalentsCost() const;
 225
 226         void  SetTP(int32 TP);
 227         int32 GetDispTP();
 228
 229         int32   m_TrainingPoints;
 230         uint32  m_resetTalentsCost;
 231         time_t  m_resetTalentsTime;
 232
 233         uint64 GetAuraUpdateMask() { return m_auraUpdateMask; }
 234         void SetAuraUpdateMask(uint8 slot) { m_auraUpdateMask |= (uint64(1) << slot); }
 235         void ResetAuraUpdateMask() { m_auraUpdateMask = 0; }
 236
 237         // overwrite Creature function for name localization back to WorldObject version without localization
 238         const char* GetNameForLocaleIdx(int32 locale_idx) const { return WorldObject::GetNameForLocaleIdx(locale_idx); }
 239
 240         DeclinedName const* GetDeclinedNames() const { return m_declinedname; }
 241
 242         bool    m_removed;                                  // prevent overwrite pet state in DB at next Pet::Update if pet already removed(saved)
 243     protected:
 244         uint32  m_regenTimer;
 245         uint32  m_happinessTimer;
 246         uint32  m_loyaltyTimer;
 247         PetType m_petType;
 248         int32   m_duration;                                 // time until unsummon (used mostly for summoned guardians and not used for controlled pets)
 249         int32   m_loyaltyPoints;
 250         int32   m_bonusdamage;
 251         uint64  m_auraUpdateMask;
 252
 253         DeclinedName *m_declinedname;
 254
 255     private:
 256         void SaveToDB(uint32, uint8)                        // overwrited of Creature::SaveToDB     - don't must be called
 257         {
 258             assert(false);
 259         }
 260         void DeleteFromDB()                                 // overwrited of Creature::DeleteFromDB - don't must be called
 261         {
 262             assert(false);
 263         }
 264 };
 265 #endif