Pet.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef TRINITYCORE_PET_H
#define TRINITYCORE_PET_H
 
#include "PetDefines.h"
#include "TemporarySummon.h"
 
#define HAPPINESS_LEVEL_SIZE 333000
 
struct PetSpell
{
 ActiveStates active;
 PetSpellState state;
 PetSpellType type;
};
 
enum PetStableinfo
{
 PET_STABLE_ACTIVE = 1,
 PET_STABLE_INACTIVE = 2
};
 
typedef std::unordered_map<uint32, PetSpell> PetSpellMap;
typedef std::vector<uint32> AutoSpellList;
 
class Player;
class PetAura;
 
class TC_GAME_API Pet : public Guardian
{
 public:
 explicit Pet(Player* owner, PetType type = MAX_PET_TYPE);
 virtual ~Pet();
 
 void AddToWorld() override;
 void RemoveFromWorld() override;
 
 float GetNativeObjectScale() const override;
 void SetDisplayId(uint32 modelId, float displayScale = 1.f) override;
 
 PetType getPetType() const { return m_petType; }
 void setPetType(PetType type) { m_petType = type; }
 bool isControlled() const { return getPetType() == SUMMON_PET || getPetType() == HUNTER_PET; }
 bool isTemporarySummoned() const { return m_duration > 0; }
 
 bool IsPermanentPetFor(Player* owner) const; // pet have tab in character windows and set UNIT_FIELD_PETNUMBER
 
 bool Create(ObjectGuid::LowType guidlow, Map* map, uint32 Entry, uint32 pet_number);
 bool CreateBaseAtCreature(Creature* creature);
 bool CreateBaseAtCreatureInfo(CreatureTemplate const* cinfo, Unit* owner);
 bool CreateBaseAtTamed(CreatureTemplate const* cinfo, Map* map);
 static std::pair<PetStable::PetInfo const*, PetSaveMode> GetLoadPetInfo(PetStable const& stable, uint32 petEntry, uint32 petnumber, Optional<PetSaveMode> slot);
 bool LoadPetFromDB(Player* owner, uint32 petEntry, uint32 petnumber, bool current, Optional<PetSaveMode> forcedSlot = {});
 bool IsLoading() const override { return m_loading;}
 void SavePetToDB(PetSaveMode mode);
 void FillPetInfo(PetStable::PetInfo* petInfo) const;
 void Remove(PetSaveMode mode, bool returnreagent = false);
 static void DeleteFromDB(uint32 petNumber);
 
 void setDeathState(DeathState s) override; // overwrite virtual Creature::setDeathState and Unit::setDeathState
 void Update(uint32 diff) override; // overwrite virtual Creature::Update and Unit::Update
 
 uint8 GetPetAutoSpellSize() const override { return uint8(m_autospells.size()); }
 uint32 GetPetAutoSpellOnPos(uint8 pos) const override
 {
 if (pos >= m_autospells.size())
 return 0;
 else
 return m_autospells[pos];
 }
 
 void GivePetXP(uint32 xp);
 void GivePetLevel(uint8 level);
 void SetPetExperience(uint32 xp) { SetUpdateFieldValue(m_values.ModifyValue(&Unit::m_unitData).ModifyValue(&UF::UnitData::PetExperience), xp); }
 void SetPetNextLevelExperience(uint32 xp) { SetUpdateFieldValue(m_values.ModifyValue(&Unit::m_unitData).ModifyValue(&UF::UnitData::PetNextLevelExperience), xp); }
 void SynchronizeLevelWithOwner();
 bool HaveInDiet(ItemTemplate const* item) const;
 void SetDuration(int32 dur) { m_duration = dur; }
 int32 GetDuration() const { return m_duration; }
 
 /*
 bool UpdateStats(Stats stat);
 bool UpdateAllStats();
 void UpdateResistances(uint32 school);
 void UpdateArmor();
 void UpdateMaxHealth();
 void UpdateMaxPower(Powers power);
 void UpdateAttackPowerAndDamage(bool ranged = false);
 void UpdateDamagePhysical(WeaponAttackType attType) override;
 */
 
 void ToggleAutocast(SpellInfo const* spellInfo, bool apply);
 
 bool HasSpell(uint32 spell) const override;
 
 void LearnPetPassives();
 void CastPetAuras(bool current);
 void CastPetAura(PetAura const* aura);
  bool IsPetAura(Aura const* aura);
 
 void _LoadAuras(PreparedQueryResult auraResult, PreparedQueryResult effectResult, uint32 timediff);
 void _SaveAuras(CharacterDatabaseTransaction trans);
 void _LoadSpells(PreparedQueryResult result);
 void _SaveSpells(CharacterDatabaseTransaction trans);
 
 bool addSpell(uint32 spellId, ActiveStates active = ACT_DECIDE, PetSpellState state = PETSPELL_NEW, PetSpellType type = PETSPELL_NORMAL);
 bool learnSpell(uint32 spell_id);
 void learnSpells(std::vector<uint32> const& spellIds);
 void learnSpellHighRank(uint32 spellid);
 void InitLevelupSpellsForLevel();
 bool unlearnSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 void unlearnSpells(std::vector<uint32> const& spellIds, bool learn_prev, bool clear_ab = true);
 bool removeSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 void CleanupActionBar();
 std::string GenerateActionBarData() const;
 
 PetSpellMap m_spells;
 AutoSpellList m_autospells;
 
 void InitPetCreateSpells();
 
 uint16 GetSpecialization() const { return m_petSpecialization; }
 void SetSpecialization(uint16 spec);
 void LearnSpecializationSpells();
 void RemoveSpecializationSpells(bool clearActionBar);
 
 uint32 GetGroupUpdateFlag() const { return m_groupUpdateMask; }
 void SetGroupUpdateFlag(uint32 flag);
 void ResetGroupUpdateFlag();
 
 DeclinedName const* GetDeclinedNames() const { return m_declinedname.get(); }
 
 bool m_removed; // prevent overwrite pet state in DB at next Pet::Update if pet already removed(saved)
 
 Player* GetOwner() const;
 
 std::string GetDebugInfo() const override;
 
 protected:
 PetType m_petType;
 int32 m_duration; // time until unsummon (used mostly for summoned guardians and not used for controlled pets)
 bool m_loading;
 uint32 m_focusRegenTimer;
 uint32 m_groupUpdateMask;
 
 std::unique_ptr<DeclinedName> m_declinedname;
 
 uint16 m_petSpecialization;
 
 private:
 void SaveToDB(uint32, std::vector<Difficulty> const&) override // override of Creature::SaveToDB - must not be called
 {
 ABORT();
 }
};
#endif