Core/Creatures: converted CMSG_PET_ACTION to packet class and moved most parts of it to the SummonInfo API

Author: Ovahlord

src/server/game/Entities/Creature/SummonInfo/SummonInfo.cpp

@@ -33,7 +33,7 @@ SummonInfo::SummonInfo(Creature* summonedCreature, SummonInfoArgs const& args) :
     _summonedCreature(ASSERT_NOTNULL(summonedCreature)), _summonerGUID(args.Summoner ? args.Summoner->GetGUID() : ObjectGuid::Empty),
     _remainingDuration(args.Duration), _maxHealth(args.MaxHealth), _creatureLevel(args.CreatureLevel),
     _flags(SummonPropertiesFlags::None), _control(SummonPropertiesControl::None), _summonSlot(SummonPropertiesSlot::None),
-    _hasBeenSummonedByCreature(args.Summoner ? args.Summoner->IsCreature() : false)
+    _hasBeenSummonedByPlayer(args.Summoner ? args.Summoner->IsPlayer() : false)
 {
     if (args.SummonPropertiesId.has_value())
         InitializeSummonProperties(*args.SummonPropertiesId, Object::ToUnit(args.Summoner));
@@ -247,7 +247,7 @@ bool SummonInfo::DespawnsOnSummonerLogout() const
     if (IsControlledBySummoner())
     {
         // Controlled creatures summoned by a creature will only despawn when not engaged
-        if (_hasBeenSummonedByCreature)
+        if (!_hasBeenSummonedByPlayer)
             return !_summonedCreature->IsEngaged();
 
         // Player controlled summons, however, always despawn
@@ -273,7 +273,7 @@ bool SummonInfo::DespawnsOnSummonerDeath() const
     if (IsControlledBySummoner())
     {
         // Controlled creatures summoned by a creature will only despawn when not engaged (they will despawn when reaching home)
-        if (_hasBeenSummonedByCreature)
+        if (!_hasBeenSummonedByPlayer)
             return !_summonedCreature->IsEngaged();
 
         // Player controlled summons, however, always despawn
@@ -332,6 +332,11 @@ SummonPropertiesControl SummonInfo::GetControl() const
     return _control;
 }
 
+bool SummonInfo::IsClassPet() const
+{
+    return _isClassPet;
+}
+
 void SummonInfo::castPassiveSpells()
 {
     CreatureTemplate const* creatureInfo = _summonedCreature->GetCreatureTemplate();
@@ -371,7 +376,7 @@ void SummonInfo::initializeReactState()
             break;
         case SummonPropertiesControl::Pet:
             // Player pets default to assist while creature summons retain their original state
-            if (!_hasBeenSummonedByCreature)
+            if (_hasBeenSummonedByPlayer)
                 _summonedCreature->SetReactState(REACT_ASSIST);
             else if (CharmInfo* charmInfo = _summonedCreature->GetCharmInfo())
                 charmInfo->RestoreState();

src/server/game/Entities/Creature/SummonInfo/SummonInfo.h

@@ -100,6 +100,8 @@ class TC_GAME_API SummonInfo
     SummonPropertiesSlot GetSummonSlot() const;
     // Returns the summon control type which determines how the summon can be controlled by the summoner
     SummonPropertiesControl GetControl() const;
+    // Returns true when the summon is a class pet (Hunter Pet, Warlock Minion or Death Knight Ghoul)
+    bool IsClassPet() const;
 
 private:
     // Looks up and casts all passive spells of the creature summon. Often used for scaling auras.
@@ -116,7 +118,8 @@ class TC_GAME_API SummonInfo
     EnumFlag<SummonPropertiesFlags> _flags;
     SummonPropertiesControl _control;
     SummonPropertiesSlot _summonSlot;
-    bool _hasBeenSummonedByCreature;
+    bool _hasBeenSummonedByPlayer;
+    bool _isClassPet;                           // Placeholder for class pet interface
 };
 
 #endif // _SummonInfo_h__

src/server/game/Entities/Unit/Unit.cpp

@@ -8843,10 +8843,10 @@ void Unit::RegisterSummon(SummonInfo* summon)
     // causes them to interact with the summoner in some way (e.g. despawning when the summoner died)
     if (slot == SummonPropertiesSlot::None)
     {
-        if (advstd::ranges::contains(_wildSummons, summon))
+        if (advstd::ranges::contains(_unslottedSummons, summon))
             return;
 
-        _wildSummons.push_back(summon);
+        _unslottedSummons.push_back(summon);
         return;
     }
 
@@ -8867,7 +8867,7 @@ void Unit::UnregisterSummon(SummonInfo* summon)
     SummonPropertiesSlot slot = summon->GetSummonSlot();
     if (slot == SummonPropertiesSlot::None)
     {
-        std::erase(_wildSummons, summon);
+        std::erase(_unslottedSummons, summon);
         return;
     }
 
@@ -8877,30 +8877,38 @@ void Unit::UnregisterSummon(SummonInfo* summon)
 
 void Unit::DespawnSummonsOnSummonerLogout()
 {
-    // Summons which are stored in a summon slot will always despawn
-    std::vector<SummonInfo*> slottedSummons = _slottedSummons;
-    for (SummonInfo* summon : slottedSummons)
-        if (summon)
+    std::vector<SummonInfo*> unslottedSummons = _unslottedSummons;
+    for (SummonInfo* summon : unslottedSummons)
+        if (summon->DespawnsOnSummonerLogout())
             summon->GetSummonedCreature()->DespawnOrUnsummon();
 
-    // Wild summons on the other hand only despawn when the according flag is set
-    std::vector<SummonInfo*> wildSummons = _wildSummons;
-    for (SummonInfo* summon : wildSummons)
-        if (summon->DespawnsOnSummonerLogout())
+    std::vector<SummonInfo*> slottedSummons = _slottedSummons;
+    for (SummonInfo* summon : slottedSummons)
+        if (summon && summon->DespawnsOnSummonerLogout())
             summon->GetSummonedCreature()->DespawnOrUnsummon();
 }
 
 void Unit::DespawnSummonsOnSummonerDeath()
 {
+    std::vector<SummonInfo*> unslottedSummons = _unslottedSummons;
+    for (SummonInfo* summon : unslottedSummons)
+        if (summon->DespawnsOnSummonerDeath())
+            summon->GetSummonedCreature()->DespawnOrUnsummon();
+
     std::vector<SummonInfo*> slottedSummons = _slottedSummons;
     for (SummonInfo* summon : slottedSummons)
         if (summon && summon->DespawnsOnSummonerDeath())
             summon->GetSummonedCreature()->DespawnOrUnsummon();
 
-    std::vector<SummonInfo*> wildSummons = _wildSummons;
-    for (SummonInfo* summon : wildSummons)
-        if (summon->DespawnsOnSummonerDeath())
-            summon->GetSummonedCreature()->DespawnOrUnsummon();
+}
+
+void Unit::DismissPet()
+{
+    if (!GetMinionGUID())
+        return;
+
+    for (SummonInfo* summonInfo : GetSummonsByControlType(SummonPropertiesControl::Pet))
+        summonInfo->GetSummonedCreature()->DespawnOrUnsummon();
 }
 
 SummonInfo* Unit::GetSummonInSlot(SummonPropertiesSlot slot) const
@@ -8921,14 +8929,14 @@ std::vector<SummonInfo*> Unit::GetSummonsByCreatureId(uint32 creatureId)
     std::vector<SummonInfo*> summons;
 
 
-    std::ranges::copy_if(_wildSummons, std::back_inserter(summons), [creatureId](SummonInfo const* summon)
+    std::ranges::copy_if(_unslottedSummons, std::back_inserter(summons), [creatureId](SummonInfo const* summon)
     {
         return summon->GetSummonedCreature()->GetEntry() == creatureId;
     });
 
     std::ranges::copy_if(_slottedSummons, std::back_inserter(summons), [creatureId](SummonInfo const* summon)
     {
-        return summon->GetSummonedCreature()->GetEntry() == creatureId;
+        return summon && summon->GetSummonedCreature()->GetEntry() == creatureId;
     });
 
     return summons;
@@ -8941,14 +8949,31 @@ std::vector<SummonInfo*> Unit::GetSummonsBySpellId(uint32 spellId)
 
     std::vector<SummonInfo*> summons;
 
-    std::ranges::copy_if(_wildSummons, std::back_inserter(summons), [spellId](SummonInfo const* summon)
+    std::ranges::copy_if(_unslottedSummons, std::back_inserter(summons), [spellId](SummonInfo const* summon)
     {
         return summon->GetSummonedCreature()->GetUInt32Value(UNIT_CREATED_BY_SPELL) == spellId;
     });
 
     std::ranges::copy_if(_slottedSummons, std::back_inserter(summons), [spellId](SummonInfo const* summon)
     {
-        return summon->GetSummonedCreature()->GetUInt32Value(UNIT_CREATED_BY_SPELL) == spellId;
+        return summon && summon->GetSummonedCreature()->GetUInt32Value(UNIT_CREATED_BY_SPELL) == spellId;
+    });
+
+    return summons;
+}
+
+std::vector<SummonInfo*> Unit::GetSummonsByControlType(SummonPropertiesControl control)
+{
+    std::vector<SummonInfo*> summons;
+
+    std::ranges::copy_if(_unslottedSummons, std::back_inserter(summons), [control](SummonInfo const* summon)
+    {
+        return summon->GetControl() == control;
+    });
+
+    std::ranges::copy_if(_slottedSummons, std::back_inserter(summons), [control](SummonInfo const* summon)
+    {
+        return summon && summon->GetControl() == control;
     });
 
     return summons;
@@ -9744,7 +9769,7 @@ void Unit::RemoveFromWorld()
         }
 
         // Clear all active summon references. If we are about to switch map instances, we want to make sure that we leave all summons behind so we won't do threadunsafe operations
-        _wildSummons.clear();
+        _unslottedSummons.clear();
         _slottedSummons.clear();
 
         WorldObject::RemoveFromWorld();

src/server/game/Entities/Unit/Unit.h

@@ -103,6 +103,7 @@ enum ProcFlagsSpellType : uint32;
 enum ZLiquidStatus : uint32;
 enum CharmType : uint8;
 
+enum class SummonPropertiesControl : uint8;
 enum class SummonPropertiesSlot: int8;
 
 namespace Movement
@@ -1341,13 +1342,17 @@ class TC_GAME_API Unit : public WorldObject
         void DespawnSummonsOnSummonerLogout();
         // Despawns all summons that should despawn when the summoner dies
         void DespawnSummonsOnSummonerDeath();
+        // Dismisses the currently active pet summon(s) (class pets and summons which are considered pets)
+        void DismissPet();
 
         // Returns the currently active summon that is the summoner's specified summon slot
         SummonInfo* GetSummonInSlot(SummonPropertiesSlot slot) const;
         // Returns a vector with all currently active summons with the specified creature Id
         std::vector<SummonInfo*> GetSummonsByCreatureId(uint32 creatureId);
         // Returns a vector with all currently active summons which have been created by the specified spell Id
         std::vector<SummonInfo*> GetSummonsBySpellId(uint32 spellId);
+        // Returns a vector with all currently active summons which are being controlled in a specific way
+        std::vector<SummonInfo*> GetSummonsByControlType(SummonPropertiesControl control);
 
         ShapeshiftForm GetShapeshiftForm() const { return ShapeshiftForm(GetByteValue(UNIT_FIELD_BYTES_2, UNIT_BYTES_2_OFFSET_SHAPESHIFT_FORM)); }
         void SetShapeshiftForm(ShapeshiftForm form);
@@ -1847,7 +1852,7 @@ class TC_GAME_API Unit : public WorldObject
         /* Player Movement fields END*/
 
         // SummonInfo slot handling
-        std::vector<SummonInfo*> _wildSummons;
+        std::vector<SummonInfo*> _unslottedSummons;
         std::vector<SummonInfo*> _slottedSummons;
 };