Pet.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2016 TrinityCore <http://www.trinitycore.org/>
 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
 *
 * 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 PET_FOCUS_REGEN_INTERVAL 4 * IN_MILLISECONDS
#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 TC_GAME_API Pet : public Guardian
{
 public:
 explicit Pet(Player* owner, PetType type = MAX_PET_TYPE);
 virtual ~Pet();

 void AddToWorld() override;
 void RemoveFromWorld() override;

 void SetDisplayId(uint32 modelId) 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);
 bool CreateBaseAtCreature(Creature* creature);
 bool CreateBaseAtCreatureInfo(CreatureTemplate const* cinfo, Unit* owner);
 bool CreateBaseAtTamed(CreatureTemplate const* cinfo, Map* map);
 bool LoadPetFromDB(Player* owner, uint32 petentry = 0, uint32 petnumber = 0, bool current = false);
 bool IsLoading() const override { return m_loading;}
 void SavePetToDB(PetSaveMode mode);
 void Remove(PetSaveMode mode, bool returnreagent = false);
 static void DeleteFromDB(uint32 guidlow);

 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 SynchronizeLevelWithOwner();
 bool HaveInDiet(ItemTemplate const* item) const;
 uint32 GetCurrentFoodBenefitLevel(uint32 itemlevel) 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 _LoadSpellCooldowns();
 void _LoadAuras(uint32 timediff);
 void _SaveAuras(SQLTransaction& trans);
 void _LoadSpells();
 void _SaveSpells(SQLTransaction& trans);

 bool addSpell(uint32 spellId, ActiveStates active = ACT_DECIDE, PetSpellState state = PETSPELL_NEW, PetSpellType type = PETSPELL_NORMAL);
 bool learnSpell(uint32 spell_id);
 void learnSpellHighRank(uint32 spellid);
 void InitLevelupSpellsForLevel();
 bool unlearnSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 bool removeSpell(uint32 spell_id, bool learn_prev, bool clear_ab = true);
 void CleanupActionBar();

 PetSpellMap m_spells;
 AutoSpellList m_autospells;

 void InitPetCreateSpells();

 bool resetTalents();
 static void resetTalentsForAllPetsOf(Player* owner, Pet* online_pet = nullptr);
 void InitTalentForLevel();

 uint8 GetMaxTalentPointsForLevel(uint8 level) const;
 uint8 GetFreeTalentPoints() const { return GetByteValue(UNIT_FIELD_BYTES_1, 1); }
 void SetFreeTalentPoints(uint8 points) { SetByteValue(UNIT_FIELD_BYTES_1, 1, points); }

 uint32 m_usedTalentCount;

 uint32 GetGroupUpdateFlag() const { return m_groupUpdateMask; }
 void SetGroupUpdateFlag(uint32 flag);
 void ResetGroupUpdateFlag();

 DeclinedName const* GetDeclinedNames() const { return m_declinedname; }

 bool m_removed; // prevent overwrite pet state in DB at next Pet::Update if pet already removed(saved)

 Player* GetOwner() const;

 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;

 DeclinedName *m_declinedname;

 private:
 void SaveToDB(uint32, uint32, uint32) override // override of Creature::SaveToDB - must not be called
 {
 ABORT();
 }
 void DeleteFromDB() override // override of Creature::DeleteFromDB - must not be called
 {
 ABORT();
 }
};
#endif