feat(Core/Maps): AreaBoundary (#10525)

* cherry-picked commit (https://github.com/TrinityCore/TrinityCore/commit/2da458c56d024aac04468ce2af454a83ad790bf6)

src/server/game/AI/CoreAI/GuardAI.cpp

@@ -37,7 +37,7 @@ void GuardAI::Reset()
     me->CastSpell(me, 18950 /*SPELL_INVISIBILITY_AND_STEALTH_DETECTION*/, true);
 }
 
-void GuardAI::EnterEvadeMode()
+void GuardAI::EnterEvadeMode(EvadeReason /*why*/)
 {
     if (!me->IsAlive())
     {

src/server/game/AI/CoreAI/GuardAI.h

@@ -30,7 +30,7 @@ public:
     static int Permissible(Creature const* creature);
 
     void Reset() override;
-    void EnterEvadeMode() override;
+    void EnterEvadeMode(EvadeReason /*why*/) override;
     void JustDied(Unit* killer) override;
 };
 #endif

src/server/game/AI/CoreAI/PassiveAI.cpp

@@ -26,7 +26,7 @@ NullCreatureAI::NullCreatureAI(Creature* c) : CreatureAI(c) { me->SetReactState(
 void PassiveAI::UpdateAI(uint32)
 {
     if (me->IsInCombat() && me->getAttackers().empty())
-        EnterEvadeMode();
+        EnterEvadeMode(EVADE_REASON_NO_HOSTILES);
 }
 
 void PossessedAI::AttackStart(Unit* target)
@@ -66,11 +66,11 @@ void CritterAI::DamageTaken(Unit*, uint32&, DamageEffectType, SpellSchoolMask)
     _combatTimer = 1;
 }
 
-void CritterAI::EnterEvadeMode()
+void CritterAI::EnterEvadeMode(EvadeReason why)
 {
     if (me->HasUnitState(UNIT_STATE_FLEEING))
         me->SetControlled(false, UNIT_STATE_FLEEING);
-    CreatureAI::EnterEvadeMode();
+    CreatureAI::EnterEvadeMode(why);
     _combatTimer = 0;
 }
 
@@ -80,7 +80,7 @@ void CritterAI::UpdateAI(uint32 diff)
     {
         _combatTimer += diff;
         if (_combatTimer >= 5000)
-            EnterEvadeMode();
+            EnterEvadeMode(EVADE_REASON_OTHER);
     }
 }
 

src/server/game/AI/CoreAI/PassiveAI.h

@@ -41,7 +41,7 @@ public:
     void MoveInLineOfSight(Unit*) override {}
     void AttackStart(Unit* target) override;
     void UpdateAI(uint32) override;
-    void EnterEvadeMode() override {}
+    void EnterEvadeMode(EvadeReason /*why*/) override {}
 
     void JustDied(Unit*) override;
     void KilledUnit(Unit* victim) override;
@@ -57,7 +57,7 @@ public:
     void MoveInLineOfSight(Unit*) override {}
     void AttackStart(Unit*) override {}
     void UpdateAI(uint32) override {}
-    void EnterEvadeMode() override {}
+    void EnterEvadeMode(EvadeReason /*why*/) override {}
     void OnCharmed(bool /*apply*/) override {}
 
     static int Permissible(Creature const*) { return PERMIT_BASE_IDLE;  }
@@ -69,7 +69,7 @@ public:
     explicit CritterAI(Creature* c) : PassiveAI(c) { _combatTimer = 0; }
 
     void DamageTaken(Unit* /*done_by*/, uint32& /*damage*/, DamageEffectType damagetype, SpellSchoolMask damageSchoolMask) override;
-    void EnterEvadeMode() override;
+    void EnterEvadeMode(EvadeReason why) override;
     void UpdateAI(uint32) override;
 
     // Xinef: Added

src/server/game/AI/CoreAI/PetAI.h

@@ -64,7 +64,8 @@ public:
     //
     void MoveInLineOfSight(Unit* /*who*/) override {} // CreatureAI interferes with returning pets
     void MoveInLineOfSight_Safe(Unit* /*who*/) {} // CreatureAI interferes with returning pets
-    void EnterEvadeMode() override {} // For fleeing, pets don't use this type of Evade mechanic
+
+    void EnterEvadeMode(EvadeReason /*why*/) override {} // For fleeing, pets don't use this type of Evade mechanic
     void SpellHit(Unit* caster, SpellInfo const* spellInfo) override;
 
     void PetStopAttack() override;

src/server/game/AI/CoreAI/TotemAI.cpp

@@ -50,7 +50,7 @@ void TotemAI::MoveInLineOfSight(Unit* /*who*/)
 {
 }
 
-void TotemAI::EnterEvadeMode()
+void TotemAI::EnterEvadeMode(EvadeReason /*why*/)
 {
     me->CombatStop(true);
 }

src/server/game/AI/CoreAI/TotemAI.h

@@ -31,8 +31,10 @@ public:
 
     void MoveInLineOfSight(Unit* who) override;
     void AttackStart(Unit* victim) override;
-    void EnterEvadeMode() override;
+
+    void EnterEvadeMode(EvadeReason /*why*/) override;
     void SpellHit(Unit* /*caster*/, SpellInfo const* /*spellInfo*/) override;
+
     void DoAction(int32 param) override;
 
     void UpdateAI(uint32 diff) override;

src/server/game/AI/CreatureAI.cpp

@@ -15,6 +15,7 @@
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "AreaBoundary.h"
 #include "CreatureAI.h"
 #include "Creature.h"
 #include "CreatureAIImpl.h"
@@ -24,6 +25,7 @@
 #include "MapReference.h"
 #include "Player.h"
 #include "Vehicle.h"
+#include "Language.h"
 
 class PhasedRespawn : public BasicEvent
 {
@@ -196,9 +198,9 @@ void CreatureAI::TriggerAlert(Unit const* who) const
     me->GetMotionMaster()->MoveDistract(5 * IN_MILLISECONDS);
 }
 
-void CreatureAI::EnterEvadeMode()
+void CreatureAI::EnterEvadeMode(EvadeReason why)
 {
-    if (!_EnterEvadeMode())
+    if (!_EnterEvadeMode(why))
         return;
 
     LOG_DEBUG("entities.unit", "Creature {} enters evade mode.", me->GetEntry());
@@ -290,7 +292,7 @@ bool CreatureAI::UpdateVictim()
     return true;
 }
 
-bool CreatureAI::_EnterEvadeMode()
+bool CreatureAI::_EnterEvadeMode(EvadeReason /*why*/)
 {
     if (!me->IsAlive())
     {
@@ -357,6 +359,44 @@ void CreatureAI::MoveBackwardsChecks() {
     me->GetMotionMaster()->MoveBackwards(victim, moveDist);
 }
 
+bool CreatureAI::IsInBoundary(Position const* who) const
+{
+    if (!_boundary)
+        return true;
+
+    if (!who)
+        who = me;
+
+    return (CreatureAI::IsInBounds(*_boundary, who) != _negateBoundary);
+}
+
+bool CreatureAI::IsInBounds(CreatureBoundary const& boundary, Position const* pos)
+{
+    for (AreaBoundary const* areaBoundary : boundary)
+        if (!areaBoundary->IsWithinBoundary(pos))
+            return false;
+
+    return true;
+}
+
+bool CreatureAI::CheckInRoom()
+{
+    if (IsInBoundary())
+        return true;
+    else
+    {
+        EnterEvadeMode(EVADE_REASON_BOUNDARY);
+        return false;
+    }
+}
+
+void CreatureAI::SetBoundary(CreatureBoundary const* boundary, bool negateBoundaries /*= false*/)
+{
+    _boundary = boundary;
+    _negateBoundary = negateBoundaries;
+    me->DoImmediateBoundaryCheck();
+}
+
 Creature* CreatureAI::DoSummon(uint32 entry, const Position& pos, uint32 despawnTime, TempSummonType summonType)
 {
     return me->SummonCreature(entry, pos, summonType, despawnTime);

src/server/game/AI/CreatureAI.h

@@ -18,6 +18,7 @@
 #ifndef ACORE_CREATUREAI_H
 #define ACORE_CREATUREAI_H
 
+#include "AreaBoundary.h"
 #include "Common.h"
 #include "Creature.h"
 #include "UnitAI.h"
@@ -29,6 +30,8 @@ class Creature;
 class Player;
 class SpellInfo;
 
+typedef std::vector<AreaBoundary const*> CreatureBoundary;
+
 #define TIME_INTERVAL_LOOK   5000
 #define VISIBILITY_RANGE    10000
 
@@ -78,10 +81,19 @@ protected:
     Creature* DoSummon(uint32 entry, Position const& pos, uint32 despawnTime = 30000, TempSummonType summonType = TEMPSUMMON_CORPSE_TIMED_DESPAWN);
     Creature* DoSummon(uint32 entry, WorldObject* obj, float radius = 5.0f, uint32 despawnTime = 30000, TempSummonType summonType = TEMPSUMMON_CORPSE_TIMED_DESPAWN);
     Creature* DoSummonFlyer(uint32 entry, WorldObject* obj, float flightZ, float radius = 5.0f, uint32 despawnTime = 30000, TempSummonType summonType = TEMPSUMMON_CORPSE_TIMED_DESPAWN);
-
 public:
+    // EnumUtils: DESCRIBE THIS
+    enum EvadeReason
+    {
+        EVADE_REASON_NO_HOSTILES,       // the creature's threat list is empty
+        EVADE_REASON_BOUNDARY,          // the creature has moved outside its evade boundary
+        EVADE_REASON_SEQUENCE_BREAK,    // this is a boss and the pre-requisite encounters for engaging it are not defeated yet
+        EVADE_REASON_OTHER
+    };
+
     void Talk(uint8 id, WorldObject const* whisperTarget = nullptr);
-    explicit CreatureAI(Creature* creature) : UnitAI(creature), me(creature), m_MoveInLineOfSight_locked(false) {}
+
+    explicit CreatureAI(Creature* creature) : UnitAI(creature), me(creature), _boundary(nullptr), _negateBoundary(false), m_MoveInLineOfSight_locked(false) { }
 
     ~CreatureAI() override {}
 
@@ -100,7 +112,7 @@ public:
     virtual bool CanRespawn() { return true; }
 
     // Called for reaction at stopping attack at no attackers or targets
-    virtual void EnterEvadeMode();
+    virtual void EnterEvadeMode(EvadeReason why = EVADE_REASON_OTHER);
 
     // Called for reaction at enter to combat if not in combat yet (enemy can be nullptr)
     virtual void EnterCombat(Unit* /*victim*/) {}
@@ -187,10 +199,20 @@ public:
 
     virtual void PetStopAttack() { }
 
+    // boundary system methods
+    virtual bool CheckInRoom();
+    CreatureBoundary const* GetBoundary() const { return _boundary; }
+    void SetBoundary(CreatureBoundary const* boundary, bool negativeBoundaries = false);
+
+    static bool IsInBounds(CreatureBoundary const& boundary, Position const* who);
+    bool IsInBoundary(Position const* who = nullptr) const;
 protected:
     virtual void MoveInLineOfSight(Unit* /*who*/);
 
-    bool _EnterEvadeMode();
+    bool _EnterEvadeMode(EvadeReason why = EVADE_REASON_OTHER);
+
+    CreatureBoundary const* _boundary;
+    bool _negateBoundary;
 
 private:
     bool m_MoveInLineOfSight_locked;

src/server/game/AI/ScriptedAI/ScriptedCreature.cpp

@@ -15,6 +15,7 @@
  * with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "AreaBoundary.h"
 #include "ScriptedCreature.h"
 #include "Cell.h"
 #include "CellImpl.h"
@@ -171,7 +172,6 @@ bool SummonList::IsAnyCreatureInCombat() const
 ScriptedAI::ScriptedAI(Creature* creature) : CreatureAI(creature),
     me(creature),
     IsFleeing(false),
-    _evadeCheckCooldown(2500),
     _isCombatMovementAllowed(true)
 {
     _isHeroic = me->GetMap()->IsHeroic();
@@ -489,23 +489,6 @@ enum eNPCs
     NPC_FREYA       = 32906,
 };
 
-bool ScriptedAI::EnterEvadeIfOutOfCombatArea()
-{
-    if (me->IsInEvadeMode() || !me->IsInCombat())
-        return false;
-
-    if (_evadeCheckCooldown == GameTime::GetGameTime().count())
-        return false;
-
-    _evadeCheckCooldown = GameTime::GetGameTime().count();
-
-    if (!CheckEvadeIfOutOfCombatArea())
-        return false;
-
-    EnterEvadeMode();
-    return true;
-}
-
 Player* ScriptedAI::SelectTargetFromPlayerList(float maxdist, uint32 excludeAura, bool mustBeInLOS) const
 {
     Map::PlayerList const& pList = me->GetMap()->GetPlayers();
@@ -531,9 +514,10 @@ Player* ScriptedAI::SelectTargetFromPlayerList(float maxdist, uint32 excludeAura
 BossAI::BossAI(Creature* creature, uint32 bossId) : ScriptedAI(creature),
     instance(creature->GetInstanceScript()),
     summons(creature),
-    _boundary(instance ? instance->GetBossBoundary(bossId) : nullptr),
     _bossId(bossId)
 {
+    if (instance)
+        SetBoundary(instance->GetBossBoundary(bossId));
 }
 
 void BossAI::_Reset()
@@ -583,59 +567,10 @@ void BossAI::TeleportCheaters()
     ThreatContainer::StorageType threatList = me->getThreatMgr().getThreatList();
     for (ThreatContainer::StorageType::const_iterator itr = threatList.begin(); itr != threatList.end(); ++itr)
         if (Unit* target = (*itr)->getTarget())
-            if (target->GetTypeId() == TYPEID_PLAYER && !CheckBoundary(target))
+            if (target->GetTypeId() == TYPEID_PLAYER && !IsInBoundary(target))
                 target->NearTeleportTo(x, y, z, 0);
 }
 
-bool BossAI::CheckBoundary(Unit* who)
-{
-    if (!GetBoundary() || !who)
-        return true;
-
-    for (BossBoundaryMap::const_iterator itr = GetBoundary()->begin(); itr != GetBoundary()->end(); ++itr)
-    {
-        switch (itr->first)
-        {
-            case BOUNDARY_N:
-                if (who->GetPositionX() > itr->second)
-                    return false;
-                break;
-            case BOUNDARY_S:
-                if (who->GetPositionX() < itr->second)
-                    return false;
-                break;
-            case BOUNDARY_E:
-                if (who->GetPositionY() < itr->second)
-                    return false;
-                break;
-            case BOUNDARY_W:
-                if (who->GetPositionY() > itr->second)
-                    return false;
-                break;
-            case BOUNDARY_NW:
-                if (who->GetPositionX() + who->GetPositionY() > itr->second)
-                    return false;
-                break;
-            case BOUNDARY_SE:
-                if (who->GetPositionX() + who->GetPositionY() < itr->second)
-                    return false;
-                break;
-            case BOUNDARY_NE:
-                if (who->GetPositionX() - who->GetPositionY() > itr->second)
-                    return false;
-                break;
-            case BOUNDARY_SW:
-                if (who->GetPositionX() - who->GetPositionY() < itr->second)
-                    return false;
-                break;
-            default:
-                break;
-        }
-    }
-
-    return true;
-}
-
 void BossAI::JustSummoned(Creature* summon)
 {
     summons.Summon(summon);

src/server/game/AI/ScriptedAI/ScriptedCreature.h

@@ -344,7 +344,6 @@ struct ScriptedAI : public CreatureAI
     void SetCombatMovement(bool allowMovement);
     bool IsCombatMovementAllowed() const { return _isCombatMovementAllowed; }
 
-    bool EnterEvadeIfOutOfCombatArea();
     virtual bool CheckEvadeIfOutOfCombatArea() const { return false; }
 
     // return true for heroic mode. i.e.
@@ -416,7 +415,6 @@ struct ScriptedAI : public CreatureAI
 
 private:
     Difficulty _difficulty;
-    uint32 _evadeCheckCooldown;
     bool _isCombatMovementAllowed;
     bool _isHeroic;
 };
@@ -428,7 +426,6 @@ public:
     ~BossAI() override {}
 
     InstanceScript* const instance;
-    BossBoundaryMap const* GetBoundary() const { return _boundary; }
 
     void JustSummoned(Creature* summon) override;
     void SummonedCreatureDespawn(Creature* summon) override;
@@ -453,23 +450,12 @@ protected:
     void _JustDied();
     void _JustReachedHome() { me->setActive(false); }
 
-    bool CheckInRoom()
-    {
-        if (CheckBoundary(me))
-            return true;
-
-        EnterEvadeMode();
-        return false;
-    }
-
-    bool CheckBoundary(Unit* who);
     void TeleportCheaters();
 
     EventMap events;
     SummonList summons;
 
 private:
-    BossBoundaryMap const* const _boundary;
     uint32 const _bossId;
 };
 

src/server/game/AI/ScriptedAI/ScriptedEscortAI.cpp

@@ -198,7 +198,7 @@ void npc_escortAI::ReturnToLastPoint()
     me->GetMotionMaster()->MovePoint(POINT_LAST_POINT, x, y, z);
 }
 
-void npc_escortAI::EnterEvadeMode()
+void npc_escortAI::EnterEvadeMode(EvadeReason /*why*/)
 {
     me->RemoveAllAuras();
     me->DeleteThreatList();

src/server/game/AI/ScriptedAI/ScriptedEscortAI.h

@@ -66,7 +66,7 @@ public:
 
     void ReturnToLastPoint();
 
-    void EnterEvadeMode() override;
+    void EnterEvadeMode(EvadeReason /*why*/ = EVADE_REASON_OTHER) override;
 
     void UpdateAI(uint32 diff) override;                   //the "internal" update, calls UpdateEscortAI()
     virtual void UpdateEscortAI(uint32 diff);     //used when it's needed to add code in update (abilities, scripted events, etc)

src/server/game/AI/ScriptedAI/ScriptedFollowerAI.cpp

@@ -150,7 +150,7 @@ void FollowerAI::JustRespawned()
     Reset();
 }
 
-void FollowerAI::EnterEvadeMode()
+void FollowerAI::EnterEvadeMode(EvadeReason /*why*/)
 {
     me->RemoveAllAuras();
     me->DeleteThreatList();

src/server/game/AI/ScriptedAI/ScriptedFollowerAI.h

@@ -46,7 +46,7 @@ public:
 
     void MoveInLineOfSight(Unit*) override;
 
-    void EnterEvadeMode() override;
+    void EnterEvadeMode(EvadeReason /*why*/ = EVADE_REASON_OTHER) override;
 
     void JustDied(Unit*) override;
 

src/server/game/AI/SmartScripts/SmartAI.cpp

@@ -618,7 +618,7 @@ void SmartAI::MovementInform(uint32 MovementType, uint32 Data)
         MovepointReached(Data);
 }
 
-void SmartAI::EnterEvadeMode()
+void SmartAI::EnterEvadeMode(EvadeReason /*why*/)
 {
     // xinef: fixes strange jumps when charming SmartAI npc
     if (!me->IsAlive() || me->IsInEvadeMode())

src/server/game/AI/SmartScripts/SmartAI.h

@@ -80,7 +80,7 @@ public:
     void EnterCombat(Unit* enemy) override;
 
     // Called for reaction at stopping attack at no attackers or targets
-    void EnterEvadeMode() override;
+    void EnterEvadeMode(EvadeReason why = EVADE_REASON_OTHER) override;
 
     // Called when the creature is killed
     void JustDied(Unit* killer) override;