#include "ScriptedEscortAI.h"

Inheritance diagram for npc_escortAI:

Public Member Functions
	npc_escortAI (Creature *creature)

	~npc_escortAI () override

void	AttackStart (Unit *who) override

void	MoveInLineOfSight (Unit *who) override

void	JustDied (Unit *) override

void	JustRespawned () override

void	ReturnToLastPoint ()

void	EnterEvadeMode (EvadeReason=EVADE_REASON_OTHER) override

void	UpdateAI (uint32 diff) override
	Use to start attacking a target. Called just before JustEngagedWith()

virtual void	UpdateEscortAI (uint32 diff)

void	MovementInform (uint32, uint32) override

void	AddWaypoint (uint32 id, float x, float y, float z, uint32 waitTime=0)

bool	SetNextWaypoint (uint32 pointId, float x, float y, float z, float orientation)

bool	SetNextWaypoint (uint32 pointId, bool setPosition=true)

bool	GetWaypointPosition (uint32 pointId, float &x, float &y, float &z)

void	GenerateWaypointArray (Movement::PointsArray *points)

virtual void	WaypointReached (uint32 pointId)=0

virtual void	WaypointStart (uint32)

void	Start (bool isActiveAttacker=true, ObjectGuid playerGUID=ObjectGuid::Empty, Quest const *quest=nullptr, bool instantRespawn=false, bool canLoopPath=false, bool resetWaypoints=true)

void	SetEscortPaused (bool on)

bool	HasEscortState (uint32 escortState)

bool	IsEscorted () override

void	SetMaxPlayerDistance (float newMax)

float	GetMaxPlayerDistance ()

void	SetDespawnAtEnd (bool despawn)

void	SetDespawnAtFar (bool despawn)

bool	GetAttack ()

void	SetCanAttack (bool attack)

ObjectGuid	GetEventStarterGUID ()

void	AddEscortState (uint32 escortState)

void	RemoveEscortState (uint32 escortState)

Public Member Functions inherited from ScriptedAI
	ScriptedAI (Creature *creature)

	~ScriptedAI () override

void	AttackStartNoMove (Unit *target)

void	DamageTaken (Unit *, uint32 &, DamageEffectType, SpellSchoolMask) override
	Called at any Damage from any attacker (before damage apply)

void	UpdateAI (uint32 diff) override
	Use to start attacking a target. Called just before JustEngagedWith()

void	JustDied (Unit *) override

void	KilledUnit (Unit *) override

void	JustSummoned (Creature *) override

void	SummonedCreatureDespawn (Creature *) override

void	SpellHit (Unit , SpellInfo const ) override

void	SpellHitTarget (Unit , SpellInfo const ) override

void	MovementInform (uint32, uint32) override

void	OnPossess (bool)

void	SetRun (bool run)

bool	IsInRoom (const Position *pos, Axis axis, bool above)

void	Reset () override

void	JustEngagedWith (Unit *) override
	Called for reaction when initially engaged.

void	AttackStart (Unit *) override

void	DoStartMovement (Unit *target, float distance=0.0f, float angle=0.0f)

void	DoStartNoMovement (Unit *target)

void	DoStopAttack ()

void	DoCastSpell (Unit target, SpellInfo const spellInfo, bool triggered=false)

void	DoPlaySoundToSet (WorldObject *source, uint32 soundId)

void	DoPlayMusic (uint32 soundId, bool zone)

void	DoAddThreat (Unit *unit, float amount)

void	DoModifyThreatByPercent (Unit *unit, int32 pct)

void	DoResetThreat (Unit *unit)

void	DoResetThreatList ()

float	DoGetThreat (Unit *unit)

void	DoTeleportPlayer (Unit *unit, float x, float y, float z, float o)

void	DoTeleportPlayer (Unit *unit, Position pos)

void	DoTeleportAll (float x, float y, float z, float o)

Unit *	DoSelectLowestHpFriendly (float range, uint32 minHPDiff=1)

std::list< Creature * >	DoFindFriendlyCC (float range)

std::list< Creature * >	DoFindFriendlyMissingBuff (float range, uint32 spellId)

Player *	GetPlayerAtMinimumRange (float minRange)

Creature *	DoSpawnCreature (uint32 entry, float offsetX, float offsetY, float offsetZ, float angle, uint32 type, uint32 despawntime)

bool	IsUniqueTimedEventDone (uint32 id) const

void	SetUniqueTimedEventDone (uint32 id)

void	ResetUniqueTimedEvent (uint32 id)

void	ClearUniqueTimedEventsDone ()

void	ScheduleTimedEvent (Milliseconds timerMin, Milliseconds timerMax, std::function< void()> exec, Milliseconds repeatMin, Milliseconds repeatMax=0ms, uint32 uniqueId=0)

void	ScheduleTimedEvent (Milliseconds timerMax, std::function< void()> exec, Milliseconds repeatMin, Milliseconds repeatMax=0ms, uint32 uniqueId=0)

void	ScheduleUniqueTimedEvent (Milliseconds timer, std::function< void()> exec, uint32 uniqueId)

bool	HealthBelowPct (uint32 pct) const

bool	HealthAbovePct (uint32 pct) const

SpellInfo const *	SelectSpell (Unit *target, uint32 school, uint32 mechanic, SelectTargetType targets, uint32 powerCostMin, uint32 powerCostMax, float rangeMin, float rangeMax, SelectEffect effect)

void	SetEquipmentSlots (bool loadDefault, int32 mainHand=EQUIP_NO_CHANGE, int32 offHand=EQUIP_NO_CHANGE, int32 ranged=EQUIP_NO_CHANGE)

virtual bool	CheckEvadeIfOutOfCombatArea () const

bool	IsHeroic () const

Difficulty	GetDifficulty () const

bool	Is25ManRaid () const

template<class T >
const T &	DUNGEON_MODE (const T &normal5, const T &heroic10) const

template<class T >
const T &	RAID_MODE (const T &normal10, const T &normal25) const

template<class T >
const T &	RAID_MODE (const T &normal10, const T &normal25, const T &heroic10, const T &heroic25) const

Player *	SelectTargetFromPlayerList (float maxdist, uint32 excludeAura=0, bool mustBeInLOS=false) const

void	SetInvincibility (bool apply)

bool	IsInvincible () const

void	SetAutoAttackAllowed (bool allow)

bool	IsAutoAttackAllowed () const

Public Member Functions inherited from CreatureAI
void	Talk (uint8 id, WorldObject const *whisperTarget=nullptr, Milliseconds delay=0ms)
	Causes the creature to talk/say the text assigned to their entry in the `creature_text` database table.

void	Talk (uint8 id, Milliseconds delay)

WorldObject *	GetSummoner () const
	Returns the summoner creature/object, if the creature is a temporary summon.

	CreatureAI (Creature *creature)

	~CreatureAI () override

void	MoveCircleChecks ()

void	MoveBackwardsChecks ()

void	MoveInLineOfSight_Safe (Unit *who)
	== Reactions At =================================

void	TriggerAlert (Unit const *who) const

virtual bool	CanRespawn ()

virtual void	IsSummonedBy (WorldObject *)

virtual void	SummonedCreatureDies (Creature , Unit )

virtual void	SummonedCreatureDespawnAll ()

virtual void	SummonedCreatureEvade (Creature *)

virtual void	OnSpellCastFinished (SpellInfo const *, SpellFinishReason)

virtual void	AttackedBy (Unit *)

virtual void	PathEndReached (uint32)

void	OnCharmed (bool apply) override
	Called when unit is charmed.

virtual void	JustReachedHome ()

void	DoZoneInCombat (Creature *creature=nullptr, float maxRangeToNearestTarget=250.0f)

virtual void	ReceiveEmote (Player *, uint32)

virtual void	OwnerAttackedBy (Unit *)

virtual void	OwnerAttacked (Unit *)

virtual void	CorpseRemoved (uint32 &)
	== Triggered Actions Requested ==================

virtual void	PassengerBoarded (Unit *, int8, bool)
	== Fields =======================================

virtual bool	BeforeSpellClick (Unit *)

virtual void	OnSpellClick (Unit *, bool &)

virtual bool	CanSeeAlways (WorldObject const *)

virtual bool	CanBeSeen (Player const *)

virtual bool	CanAlwaysBeDetectable (WorldObject const *)

virtual void	PetStopAttack ()

int32	VisualizeBoundary (uint32 duration, Unit *owner=nullptr, bool fill=false, bool checkZ=false) const

virtual bool	CheckInRoom ()

CreatureBoundary const *	GetBoundary () const

void	SetBoundary (CreatureBoundary const *boundary, bool negativeBoundaries=false)

bool	IsInBoundary (Position const *who=nullptr) const

virtual void	CalculateThreat (Unit , float &, SpellInfo const )

virtual bool	OnTeleportUnreacheablePlayer (Player *)

virtual void	OnAuraRemove (AuraApplication *, AuraRemoveMode)

virtual void	DistancingStarted ()

virtual void	DistancingEnded ()

Public Member Functions inherited from UnitAI
	UnitAI (Unit *unit)

virtual	~UnitAI ()

virtual bool	CanAIAttack (Unit const *) const

virtual void	InitializeAI ()

virtual void	DoAction (int32)

virtual uint32	GetData (uint32) const

virtual void	SetData (uint32, uint32)

virtual void	SetGUID (ObjectGuid const &, int32=0)

virtual ObjectGuid	GetGUID (int32=0) const

Unit *	SelectTarget (SelectTargetMethod targetType, uint32 position=0, float dist=0.0f, bool playerOnly=false, bool withTank=true, int32 aura=0)

template<class PREDICATE >
Unit *	SelectTarget (SelectTargetMethod targetType, uint32 position, PREDICATE const &predicate)

void	SelectTargetList (std::list< Unit * > &targetList, uint32 num, SelectTargetMethod targetType, uint32 position=0, float dist=0.0f, bool playerOnly=false, bool withTank=true, int32 aura=0)
	Select the best (up to) <num> targets (in <targetType> order) from the threat list that fulfill the following:

template<class PREDICATE >
void	SelectTargetList (std::list< Unit * > &targetList, uint32 num, SelectTargetMethod targetType, uint32 position, PREDICATE const &predicate)

virtual void	JustEnteredCombat (Unit *)
	Called when the unit enters combat.

virtual void	JustExitedCombat ()
	Called when the unit leaves combat.

virtual void	DamageDealt (Unit *, uint32 &, DamageEffectType, SpellSchoolMask)
	Called at any Damage to any victim (before damage apply)

virtual void	HealReceived (Unit *, uint32 &)
	Called when the creature receives heal.

virtual void	OnPowerUpdate (Powers, int32, int32, uint32)
	Called when the creature power updates.

virtual void	HealDone (Unit *, uint32 &)
	Called when the unit heals.

virtual void	OnCalculateMeleeDamageReceived (uint32 &, Unit *)
	Called during damage calculations.

virtual void	OnCalculateSpellDamageReceived (int32 &, Unit *)

virtual void	OnCalculatePeriodicTickReceived (uint32 &, Unit *)
	Called during calculation when receiving periodic healing or damage (DoT or HoT)

void	AttackStartCaster (Unit *victim, float dist)

SpellCastResult	DoAddAuraToAllHostilePlayers (uint32 spellid)

SpellCastResult	DoCast (uint32 spellId)

SpellCastResult	DoCast (Unit *victim, uint32 spellId, bool triggered=false)

SpellCastResult	DoCastSelf (uint32 spellId, bool triggered=false)

SpellCastResult	DoCastToAllHostilePlayers (uint32 spellid, bool triggered=false)
	To specify the caster as target if the spell is self-cast.

SpellCastResult	DoCastVictim (uint32 spellId, bool triggered=false)

SpellCastResult	DoCastAOE (uint32 spellId, bool triggered=false)

SpellCastResult	DoCastRandomTarget (uint32 spellId, uint32 threatTablePosition=0, float dist=0.0f, bool playerOnly=true, bool triggered=false, bool withTank=true)
	Cast the spell on a random unit from the threat list.

SpellCastResult	DoCastMaxThreat (uint32 spellId, uint32 threatTablePosition=0, float dist=0.0f, bool playerOnly=true, bool triggered=false)
	Cast spell on the top threat target, which may not be the current victim.

float	DoGetSpellMaxRange (uint32 spellId, bool positive=false)

void	DoMeleeAttackIfReady ()

bool	DoSpellAttackIfReady (uint32 spell)

void	DoSpellAttackToRandomTargetIfReady (uint32 spell, uint32 threatTablePosition=0, float dist=0.f, bool playerOnly=true)

virtual void	SummonMovementInform (Creature *, uint32, uint32)
	Called when a summon reaches a waypoint or point movement finished.

virtual void	sGossipHello (Player *)

virtual void	sGossipSelect (Player *, uint32, uint32)

virtual void	sGossipSelectCode (Player , uint32, uint32, char const )

virtual void	sQuestAccept (Player , Quest const )

virtual void	sQuestSelect (Player , Quest const )

virtual void	sQuestComplete (Player , Quest const )

virtual void	sQuestReward (Player , Quest const , uint32)

virtual void	sOnGameEvent (bool, uint16)

virtual std::string	GetDebugInfo () const

Protected Member Functions
Player *	GetPlayerForEscort ()

Protected Member Functions inherited from CreatureAI
bool	UpdateVictim ()

bool	UpdateVictimWithGaze ()

void	SetGazeOn (Unit *target)

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)

bool	_EnterEvadeMode (EvadeReason why=EVADE_REASON_OTHER)

Private Member Functions
bool	AssistPlayerInCombatAgainst (Unit *who)

bool	IsPlayerOrGroupInRange ()

void	FillPointMovementListForCreature ()

Private Attributes
ObjectGuid	m_uiPlayerGUID

uint32	m_uiWPWaitTimer

uint32	m_uiPlayerCheckTimer

uint32	m_uiEscortState

float	MaxPlayerDistance

Quest const *	m_pQuestForEscort

std::list< Escort_Waypoint >	WaypointList

std::list< Escort_Waypoint >::iterator	CurrentWP

bool	m_bIsActiveAttacker

bool	m_bCanInstantRespawn

bool	m_bCanReturnToStart

bool	DespawnAtEnd

bool	DespawnAtFar

bool	ScriptWP

bool	HasImmuneToNPCFlags

Additional Inherited Members
Public Types inherited from ScriptedAI
enum class	Axis { AXIS_X , AXIS_Y }

Public Types inherited from CreatureAI
enum	EvadeReason { EVADE_REASON_NO_HOSTILES , EVADE_REASON_BOUNDARY , EVADE_REASON_SEQUENCE_BREAK , EVADE_REASON_NO_PATH , EVADE_REASON_OTHER }

Static Public Member Functions inherited from CreatureAI
static bool	IsInBounds (CreatureBoundary const &boundary, Position const *who)

Static Public Member Functions inherited from UnitAI
static void	FillAISpellInfo ()

Public Attributes inherited from ScriptedAI
Creature *	me

Static Public Attributes inherited from UnitAI
static AISpellInfoType *	AISpellInfo

Protected Attributes inherited from CreatureAI
Creature *const	me

EventMap	events

TaskScheduler	scheduler

CreatureBoundary const *	_boundary

bool	_negateBoundary

Protected Attributes inherited from UnitAI
Unit *const	me

Detailed Description

Constructor & Destructor Documentation

◆ npc_escortAI()

npc_escortAI::npc_escortAI ( Creature * creature )

explicit

                                             : ScriptedAI(creature),
    m_uiWPWaitTimer(1000),
    m_uiPlayerCheckTimer(0),
    m_uiEscortState(STATE_ESCORT_NONE),
    MaxPlayerDistance(DEFAULT_MAX_PLAYER_DISTANCE),
    m_pQuestForEscort(nullptr),
    m_bIsActiveAttacker(true),
    m_bCanInstantRespawn(false),
    m_bCanReturnToStart(false),
    DespawnAtEnd(true),
    DespawnAtFar(true),
    ScriptWP(false),
    HasImmuneToNPCFlags(false)
{}

◆ ~npc_escortAI()

npc_escortAI::~npc_escortAI ( )

inlineoverride

56{}

Member Function Documentation

◆ AddEscortState()

void npc_escortAI::AddEscortState ( uint32 escortState )

inline

109{ m_uiEscortState |= escortState; }

References m_uiEscortState.

Referenced by npc_varian_wrynn::npc_varian_wrynnAI::EnterEvadeMode(), npc_thrall_bfu::npc_thrall_bfuAI::EnterEvadeMode(), violet_hold_trashAI::EnterEvadeMode(), EnterEvadeMode(), SetEscortPaused(), and Start().

◆ AddWaypoint()

void npc_escortAI::AddWaypoint	(	uint32	id,
		float	x,
		float	y,
		float	z,
		uint32	waitTime = `0`
	)

{
    Escort_Waypoint t(id, x, y, z, waitTime);
 
    WaypointList.push_back(t);
 
    // i think SD2 no longer uses this function
    ScriptWP = true;
    /*PointMovement wp;
    wp.m_uiCreatureEntry = me->GetEntry();
    wp.m_uiPointId = id;
    wp.m_fX = x;
    wp.m_fY = y;
    wp.m_fZ = z;
    wp.m_uiWaitTime = WaitTimeMs;
    PointMovementMap[wp.m_uiCreatureEntry].push_back(wp);*/
}

References ScriptWP, and WaypointList.

Referenced by npc_onyx_flamecaller::npc_onyx_flamecallerAI::AddWaypoints(), boss_bjarngrim::boss_bjarngrim(), npc_scarlet_miner::npc_scarlet_minerAI::InitWaypoint(), boss_thorim_lightning_orb::boss_thorim_lightning_orbAI::InitWaypoint(), boss_thorim_sif_blizzard::boss_thorim_sif_blizzardAI::InitWaypoint(), boss_yoggsaron_cloud::boss_yoggsaron_cloudAI::InitWaypoint(), boss_grand_champion::boss_grand_championAI::SetData(), npc_argent_soldier::npc_argent_soldierAI::SetData(), npc_clintar_spirit::npc_clintar_spiritAI::StartEvent(), violet_hold_trashAI::UpdateAI(), and npc_azure_saboteur::npc_azure_saboteurAI::UpdateAI().

◆ AssistPlayerInCombatAgainst()

bool npc_escortAI::AssistPlayerInCombatAgainst ( Unit * who )

private

{
    if (!who || !who->GetVictim())
    {
        return false;
    }
 
    if (me->HasReactState(REACT_PASSIVE))
    {
        return false;
    }
 
    //experimental (unknown) flag not present
    if (!(me->GetCreatureTemplate()->type_flags & CREATURE_TYPE_FLAG_CAN_ASSIST))
    {
        return false;
    }
 
    //not a player
    if (!who->GetVictim()->GetCharmerOrOwnerPlayerOrPlayerItself())
    {
        return false;
    }
 
    if (!who->isInAccessiblePlaceFor(me))
    {
        return false;
    }
 
    if (!CanAIAttack(who))
    {
        return false;
    }
 
    // we cannot attack in evade mode
    if (me->IsInEvadeMode())
    {
        return false;
    }
 
    // or if enemy is in evade mode
    if (who->IsCreature() && who->ToCreature()->IsInEvadeMode())
    {
        return false;
    }
 
    //never attack friendly
    if (!me->IsValidAttackTarget(who))
    {
        return false;
    }
 
    //too far away and no free sight?
    if (me->IsWithinDistInMap(who, GetMaxPlayerDistance()) && me->IsWithinLOSInMap(who))
    {
        AttackStart(who);
        return true;
    }
 
    return false;
}

References AttackStart(), UnitAI::CanAIAttack(), CREATURE_TYPE_FLAG_CAN_ASSIST, Unit::GetCharmerOrOwnerPlayerOrPlayerItself(), Creature::GetCreatureTemplate(), GetMaxPlayerDistance(), Unit::GetVictim(), Creature::HasReactState(), Object::IsCreature(), Unit::isInAccessiblePlaceFor(), Creature::IsInEvadeMode(), Unit::IsValidAttackTarget(), WorldObject::IsWithinDistInMap(), WorldObject::IsWithinLOSInMap(), ScriptedAI::me, REACT_PASSIVE, Object::ToCreature(), and CreatureTemplate::type_flags.

Referenced by MoveInLineOfSight().

◆ AttackStart()

void npc_escortAI::AttackStart ( Unit * who )

overridevirtual

Reimplemented from UnitAI.

Reimplemented in npc_taretha::npc_tarethaAI, npc_mimirons_inferno::npc_mimirons_infernoAI, npc_frosthound, npc_icefang::npc_icefangAI, and violet_hold_trashAI.

{
    if (!who)
        return;
 
    if (me->Attack(who, true))
    {
        MovementGeneratorType type = me->GetMotionMaster()->GetMotionSlotType(MOTION_SLOT_ACTIVE);
        if (type == ESCORT_MOTION_TYPE || type == POINT_MOTION_TYPE)
        {
            me->GetMotionMaster()->MovementExpired();
            //me->DisableSpline();
            me->StopMoving();
        }
 
        if (me->IsCombatMovementAllowed())
            me->GetMotionMaster()->MoveChase(who);
    }
}

References Unit::Attack(), ESCORT_MOTION_TYPE, Unit::GetMotionMaster(), MotionMaster::GetMotionSlotType(), Creature::IsCombatMovementAllowed(), ScriptedAI::me, MOTION_SLOT_ACTIVE, MotionMaster::MoveChase(), MotionMaster::MovementExpired(), POINT_MOTION_TYPE, and Unit::StopMoving().

Referenced by AssistPlayerInCombatAgainst(), npc_tapoke_slim_jahn::npc_tapoke_slim_jahnAI::AttackedBy(), npc_clintar_spirit::npc_clintar_spiritAI::EnterEvadeMode(), MoveInLineOfSight(), npc_general_andorov::MoveInLineOfSight(), npc_captain_saeed::npc_captain_saeedAI::MoveInLineOfSight(), boss_grand_champion::boss_grand_championAI::MovementInform(), npc_arthas::npc_arthasAI::UpdateAI(), npc_clintar_spirit::npc_clintar_spiritAI::UpdateAI(), boss_grand_champion::boss_grand_championAI::UpdateAI(), npc_captain_saeed::npc_captain_saeedAI::UpdateAI(), npc_ranger_lilatha::WaypointReached(), and npc_cork_gizelton::npc_cork_gizeltonAI::WaypointReached().

◆ EnterEvadeMode()

void npc_escortAI::EnterEvadeMode ( EvadeReason = EVADE_REASON_OTHER )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_lord_gregor_lescovar::npc_lord_gregor_lescovarAI, npc_varian_wrynn::npc_varian_wrynnAI, npc_thrall_bfu::npc_thrall_bfuAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, violet_hold_trashAI, npc_frosthound, and npc_icefang::npc_icefangAI.

{
    me->GetThreatMgr().ClearAllThreat();
    me->CombatStop(true);
    me->SetLootRecipient(nullptr);
 
    if (HasEscortState(STATE_ESCORT_ESCORTING))
    {
        AddEscortState(STATE_ESCORT_RETURNING);
        ReturnToLastPoint();
        LOG_DEBUG("scripts.ai", "EscortAI has left combat and is now returning to last point");
    }
    else
    {
        me->GetMotionMaster()->MoveTargetedHome();
        if (HasImmuneToNPCFlags)
            me->SetImmuneToNPC(true);
        Reset();
    }
}

References AddEscortState(), ThreatMgr::ClearAllThreat(), Unit::CombatStop(), Unit::GetMotionMaster(), Unit::GetThreatMgr(), HasEscortState(), HasImmuneToNPCFlags, LOG_DEBUG, ScriptedAI::me, MotionMaster::MoveTargetedHome(), ScriptedAI::Reset(), ReturnToLastPoint(), Unit::SetImmuneToNPC(), Creature::SetLootRecipient(), STATE_ESCORT_ESCORTING, and STATE_ESCORT_RETURNING.

Referenced by npc_arthas::npc_arthasAI::DoAction(), npc_cork_gizelton::npc_cork_gizeltonAI::EnterEvadeMode(), npc_clintar_spirit::npc_clintar_spiritAI::EnterEvadeMode(), and npc_captain_saeed::npc_captain_saeedAI::EnterEvadeMode().

◆ FillPointMovementListForCreature()

void npc_escortAI::FillPointMovementListForCreature ( )

private

{
    ScriptPointVector const& movePoints = sScriptSystemMgr->GetPointMoveList(me->GetEntry());
    if (movePoints.empty())
        return;
 
    ScriptPointVector::const_iterator itrEnd = movePoints.end();
    for (ScriptPointVector::const_iterator itr = movePoints.begin(); itr != itrEnd; ++itr)
    {
        Escort_Waypoint point(itr->uiPointId, itr->fX, itr->fY, itr->fZ, itr->uiWaitTime);
        WaypointList.push_back(point);
    }
}

References Object::GetEntry(), ScriptedAI::me, sScriptSystemMgr, and WaypointList.

Referenced by SetNextWaypoint(), and Start().

◆ GenerateWaypointArray()

void npc_escortAI::GenerateWaypointArray ( Movement::PointsArray * points )

{
    if (WaypointList.empty())
        return;
 
    uint32 startingWaypointId = CurrentWP->id;
 
    // Flying unit, just fill array
    if (me->m_movementInfo.HasMovementFlag((MovementFlags)(MOVEMENTFLAG_CAN_FLY | MOVEMENTFLAG_DISABLE_GRAVITY)))
    {
        // xinef: first point in vector is unit real position
        points->clear();
        points->push_back(G3D::Vector3(me->GetPositionX(), me->GetPositionY(), me->GetPositionZ()));
        for (std::list<Escort_Waypoint>::const_iterator itr = CurrentWP; itr != WaypointList.end(); ++itr)
            points->push_back(G3D::Vector3(itr->x, itr->y, itr->z));
    }
    else
    {
        for (float size = 1.0f; size; size *= 0.5f)
        {
            std::vector<G3D::Vector3> pVector;
            // xinef: first point in vector is unit real position
            pVector.push_back(G3D::Vector3(me->GetPositionX(), me->GetPositionY(), me->GetPositionZ()));
            uint32 length = (WaypointList.size() - startingWaypointId) * size;
 
            uint32 cnt = 0;
            for (std::list<Escort_Waypoint>::const_iterator itr = CurrentWP; itr != WaypointList.end() && cnt <= length; ++itr, ++cnt)
                pVector.push_back(G3D::Vector3(itr->x, itr->y, itr->z));
 
            if (pVector.size() > 2) // more than source + dest
            {
                G3D::Vector3 middle = (pVector[0] + pVector[pVector.size() - 1]) / 2.f;
                G3D::Vector3 offset;
 
                bool continueLoop = false;
                for (uint32 i = 1; i < pVector.size() - 1; ++i)
                {
                    offset = middle - pVector[i];
                    if (std::fabs(offset.x) >= 0xFF || std::fabs(offset.y) >= 0xFF || std::fabs(offset.z) >= 0x7F)
                    {
                        // offset is too big, split points
                        continueLoop = true;
                        break;
                    }
                }
                if (continueLoop)
                    continue;
            }
            // everything ok
            *points = pVector;
            break;
        }
    }
}

References CurrentWP, Position::GetPositionX(), Position::GetPositionY(), Position::GetPositionZ(), MovementInfo::HasMovementFlag(), WorldObject::m_movementInfo, ScriptedAI::me, MOVEMENTFLAG_CAN_FLY, MOVEMENTFLAG_DISABLE_GRAVITY, and WaypointList.

Referenced by UpdateAI().

◆ GetAttack()

bool npc_escortAI::GetAttack ( )

inline

105{ return m_bIsActiveAttacker; }//used in EnterEvadeMode override

References m_bIsActiveAttacker.

Referenced by npc_apothecary_hanes::npc_Apothecary_HanesAI::UpdateEscortAI(), and npc_bonker_togglevolt::npc_bonker_togglevoltAI::UpdateEscortAI().

◆ GetEventStarterGUID()

ObjectGuid npc_escortAI::GetEventStarterGUID ( )

inline

107{ return m_uiPlayerGUID; }

npc_escortAI::m_uiPlayerGUID

ObjectGuid m_uiPlayerGUID

Definition ScriptedEscortAI.h:120

References m_uiPlayerGUID.

◆ GetMaxPlayerDistance()

float npc_escortAI::GetMaxPlayerDistance ( )

inline

101{ return MaxPlayerDistance; }

References MaxPlayerDistance.

Referenced by AssistPlayerInCombatAgainst(), and IsPlayerOrGroupInRange().

◆ GetPlayerForEscort()

Player * npc_escortAI::GetPlayerForEscort ( )

inlineprotected

113{ return ObjectAccessor::GetPlayer(*me, m_uiPlayerGUID); }

ObjectAccessor::GetPlayer

Player * GetPlayer(Map const *, ObjectGuid const &guid)

Definition ObjectAccessor.cpp:220

References ObjectAccessor::GetPlayer(), m_uiPlayerGUID, and ScriptedAI::me.

◆ GetWaypointPosition()

bool npc_escortAI::GetWaypointPosition	(	uint32	pointId,
		float &	x,
		float &	y,
		float &	z
	)

{
    ScriptPointVector const& waypoints = sScriptSystemMgr->GetPointMoveList(me->GetEntry());
    if (waypoints.empty())
        return false;
 
    for (ScriptPointVector::const_iterator itr = waypoints.begin(); itr != waypoints.end(); ++itr)
    {
        if (itr->uiPointId == pointId)
        {
            x = itr->fX;
            y = itr->fY;
            z = itr->fZ;
            return true;
        }
    }
 
    return false;
}

References Object::GetEntry(), ScriptedAI::me, and sScriptSystemMgr.

◆ HasEscortState()

bool npc_escortAI::HasEscortState ( uint32 escortState )

inline

97{ return (m_uiEscortState & escortState); }

References m_uiEscortState.

Referenced by npc_varian_wrynn::npc_varian_wrynnAI::EnterEvadeMode(), npc_thrall_bfu::npc_thrall_bfuAI::EnterEvadeMode(), violet_hold_trashAI::EnterEvadeMode(), EnterEvadeMode(), JustDied(), npc_muglash::npc_muglashAI::JustDied(), npc_engineer_helice::npc_engineer_heliceAI::JustDied(), npc_maghar_captive::npc_maghar_captiveAI::JustDied(), npc_kurenai_captive::npc_kurenai_captiveAI::JustDied(), npc_tapoke_slim_jahn::npc_tapoke_slim_jahnAI::JustEngagedWith(), npc_muglash::npc_muglashAI::JustEngagedWith(), npc_wounded_blood_elf::npc_wounded_blood_elfAI::JustEngagedWith(), npc_rinji::npc_rinjiAI::JustEngagedWith(), MoveInLineOfSight(), npc_custodian_of_time::npc_custodian_of_timeAI::MoveInLineOfSight(), MovementInform(), npc_rocknot::npc_rocknotAI::Reset(), npc_varian_wrynn::npc_varian_wrynnAI::Reset(), npc_thrall_bfu::npc_thrall_bfuAI::Reset(), npc_tapoke_slim_jahn::npc_tapoke_slim_jahnAI::Reset(), npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI::Reset(), npc_lurgglbr::npc_lurgglbrAI::Reset(), SetEscortPaused(), Start(), UpdateAI(), npc_barnes::npc_barnesAI::UpdateAI(), npc_corporal_keeshan::npc_corporal_keeshanAI::UpdateAI(), npc_muglash::npc_muglashAI::UpdateAI(), npc_engineer_helice::npc_engineer_heliceAI::UpdateAI(), and npc_rinji::npc_rinjiAI::UpdateEscortAI().

◆ IsEscorted()

bool npc_escortAI::IsEscorted ( )

inlineoverridevirtual

Reimplemented from CreatureAI.

98{ return (m_uiEscortState & STATE_ESCORT_ESCORTING); }

References m_uiEscortState, and STATE_ESCORT_ESCORTING.

◆ IsPlayerOrGroupInRange()

bool npc_escortAI::IsPlayerOrGroupInRange ( )

private

{
    if (Player* player = GetPlayerForEscort())
    {
        if (Group* group = player->GetGroup())
        {
            for (GroupReference* groupRef = group->GetFirstMember(); groupRef != nullptr; groupRef = groupRef->next())
                if (Player* member = groupRef->GetSource())
                    if (me->IsWithinDistInMap(member, GetMaxPlayerDistance(), true, false))
                        return true;
        }
        else if (me->IsWithinDistInMap(player, GetMaxPlayerDistance(), true, false))
            return true;
    }
 
    return false;
}

References GetMaxPlayerDistance(), GetPlayerForEscort(), WorldObject::IsWithinDistInMap(), and ScriptedAI::me.

Referenced by UpdateAI().

◆ JustDied()

void npc_escortAI::JustDied ( Unit * )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_muglash::npc_muglashAI, violet_hold_trashAI, npc_mootoo_the_younger::npc_mootoo_the_youngerAI, npc_frosthound, npc_icefang::npc_icefangAI, npc_maghar_captive::npc_maghar_captiveAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_maxx_a_million_escort::npc_maxx_a_million_escortAI, npc_isla_starmane::npc_isla_starmaneAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, and npc_general_andorov.

{
    if (!HasEscortState(STATE_ESCORT_ESCORTING) || !m_uiPlayerGUID || !m_pQuestForEscort)
        return;
 
    if (Player* player = GetPlayerForEscort())
    {
        if (Group* group = player->GetGroup())
        {
            for (GroupReference* groupRef = group->GetFirstMember(); groupRef != nullptr; groupRef = groupRef->next())
                if (Player* member = groupRef->GetSource())
                    if (member->IsInMap(player) && member->GetQuestStatus(m_pQuestForEscort->GetQuestId()) == QUEST_STATUS_INCOMPLETE)
                        member->FailQuest(m_pQuestForEscort->GetQuestId());
        }
        else
        {
            if (player->GetQuestStatus(m_pQuestForEscort->GetQuestId()) == QUEST_STATUS_INCOMPLETE)
                player->FailQuest(m_pQuestForEscort->GetQuestId());
        }
    }
}

References GetPlayerForEscort(), Quest::GetQuestId(), HasEscortState(), m_pQuestForEscort, m_uiPlayerGUID, QUEST_STATUS_INCOMPLETE, and STATE_ESCORT_ESCORTING.

Referenced by npc_cork_gizelton::npc_cork_gizeltonAI::JustDied().

◆ JustRespawned()

void npc_escortAI::JustRespawned ( )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_rinji::npc_rinjiAI, and npc_isla_starmane::npc_isla_starmaneAI.

{
    RemoveEscortState(STATE_ESCORT_ESCORTING | STATE_ESCORT_RETURNING | STATE_ESCORT_PAUSED);
 
    if (!me->IsCombatMovementAllowed())
        me->SetCombatMovement(true);
 
    //add a small delay before going to first waypoint, normal in near all cases
    m_uiWPWaitTimer = 1000;
 
    if (me->GetFaction() != me->GetCreatureTemplate()->faction)
        me->RestoreFaction();
 
    Reset();
}

References CreatureTemplate::faction, Creature::GetCreatureTemplate(), Unit::GetFaction(), Creature::IsCombatMovementAllowed(), m_uiWPWaitTimer, ScriptedAI::me, RemoveEscortState(), ScriptedAI::Reset(), Unit::RestoreFaction(), Creature::SetCombatMovement(), STATE_ESCORT_ESCORTING, STATE_ESCORT_PAUSED, and STATE_ESCORT_RETURNING.

Referenced by npc_rinji::npc_rinjiAI::JustRespawned(), npc_cork_gizelton::npc_cork_gizeltonAI::JustRespawned(), and npc_isla_starmane::npc_isla_starmaneAI::JustRespawned().

◆ MoveInLineOfSight()

void npc_escortAI::MoveInLineOfSight ( Unit * who )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_taretha::npc_tarethaAI, npc_mimirons_inferno::npc_mimirons_infernoAI, npc_general_andorov, and violet_hold_trashAI.

{
    if (me->GetVictim())
        return;
 
    if (!me->HasUnitState(UNIT_STATE_STUNNED) && who->isTargetableForAttack(true, me) && who->isInAccessiblePlaceFor(me))
        if (HasEscortState(STATE_ESCORT_ESCORTING) && AssistPlayerInCombatAgainst(who))
            return;
 
    if (me->HasReactState(REACT_AGGRESSIVE) && me->CanStartAttack(who))
    {
        if (me->HasUnitState(UNIT_STATE_DISTRACTED))
        {
            me->ClearUnitState(UNIT_STATE_DISTRACTED);
            me->GetMotionMaster()->Clear();
        }
        AttackStart(who);
    }
}

References AssistPlayerInCombatAgainst(), AttackStart(), Creature::CanStartAttack(), MotionMaster::Clear(), Unit::ClearUnitState(), Unit::GetMotionMaster(), Unit::GetVictim(), HasEscortState(), Creature::HasReactState(), Unit::HasUnitState(), Unit::isInAccessiblePlaceFor(), Unit::isTargetableForAttack(), ScriptedAI::me, REACT_AGGRESSIVE, STATE_ESCORT_ESCORTING, UNIT_STATE_DISTRACTED, and UNIT_STATE_STUNNED.

Referenced by boss_grand_champion::boss_grand_championAI::MoveInLineOfSight(), npc_ancestral_wolf::npc_ancestral_wolfAI::MoveInLineOfSight(), and npc_captain_saeed::npc_captain_saeedAI::MoveInLineOfSight().

◆ MovementInform()

void npc_escortAI::MovementInform	(	uint32	moveType,
		uint32	pointId
	)

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI.

{
    // xinef: no action allowed if there is no escort
    if (!HasEscortState(STATE_ESCORT_ESCORTING))
        return;
 
    if (moveType == POINT_MOTION_TYPE)
    {
        //Combat start position reached, continue waypoint movement
        if (pointId == POINT_LAST_POINT)
        {
            LOG_DEBUG("scripts.ai", "EscortAI has returned to original position before combat");
 
            RemoveEscortState(STATE_ESCORT_RETURNING);
 
            if (!m_uiWPWaitTimer)
                m_uiWPWaitTimer = 1;
        }
        else if (pointId == POINT_HOME)
        {
            LOG_DEBUG("scripts.ai", "EscortAI has returned to original home location and will continue from beginning of waypoint list.");
 
            CurrentWP = WaypointList.begin();
            m_uiWPWaitTimer = 1;
        }
    }
    else if (moveType == ESCORT_MOTION_TYPE)
    {
        if (m_uiWPWaitTimer <= 1 && !HasEscortState(STATE_ESCORT_PAUSED) && CurrentWP != WaypointList.end())
        {
            //Call WP function
            me->SetPosition(CurrentWP->x, CurrentWP->y, CurrentWP->z, me->GetOrientation());
            me->SetHomePosition(me->GetPositionX(), me->GetPositionY(), me->GetPositionZ(), me->GetOrientation());
            WaypointReached(CurrentWP->id);
 
            m_uiWPWaitTimer = CurrentWP->WaitTimeMs + 1;
 
            ++CurrentWP;
 
            if (m_uiWPWaitTimer > 1 || HasEscortState(STATE_ESCORT_PAUSED))
            {
                if (me->GetMotionMaster()->GetMotionSlotType(MOTION_SLOT_ACTIVE) == ESCORT_MOTION_TYPE)
                    me->GetMotionMaster()->MovementExpired();
                me->StopMovingOnCurrentPos();
                me->GetMotionMaster()->MoveIdle();
            }
        }
    }
}

References CurrentWP, ESCORT_MOTION_TYPE, Unit::GetMotionMaster(), MotionMaster::GetMotionSlotType(), Position::GetOrientation(), Position::GetPositionX(), Position::GetPositionY(), Position::GetPositionZ(), HasEscortState(), LOG_DEBUG, m_uiWPWaitTimer, ScriptedAI::me, MOTION_SLOT_ACTIVE, MotionMaster::MoveIdle(), MotionMaster::MovementExpired(), POINT_HOME, POINT_LAST_POINT, POINT_MOTION_TYPE, RemoveEscortState(), Creature::SetHomePosition(), Creature::SetPosition(), STATE_ESCORT_ESCORTING, STATE_ESCORT_PAUSED, STATE_ESCORT_RETURNING, Unit::StopMovingOnCurrentPos(), WaypointList, and WaypointReached().

Referenced by boss_grand_champion::boss_grand_championAI::MovementInform(), and npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::MovementInform().

◆ RemoveEscortState()

void npc_escortAI::RemoveEscortState ( uint32 escortState )

inline

110{ m_uiEscortState &= ~escortState; }

References m_uiEscortState.

Referenced by violet_hold_trashAI::CreatureStartAttackDoor(), npc_arthas::npc_arthasAI::JustDied(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::JustDied(), JustRespawned(), MovementInform(), brann_bronzebeard::brann_bronzebeardAI::Reset(), SetEscortPaused(), and UpdateAI().

◆ ReturnToLastPoint()

void npc_escortAI::ReturnToLastPoint ( )

{
    float x, y, z, o;
    me->GetHomePosition(x, y, z, o);
    me->GetMotionMaster()->MovePoint(POINT_LAST_POINT, x, y, z, FORCED_MOVEMENT_RUN);
}

References FORCED_MOVEMENT_RUN, Creature::GetHomePosition(), Unit::GetMotionMaster(), ScriptedAI::me, MotionMaster::MovePoint(), and POINT_LAST_POINT.

Referenced by npc_varian_wrynn::npc_varian_wrynnAI::EnterEvadeMode(), npc_thrall_bfu::npc_thrall_bfuAI::EnterEvadeMode(), violet_hold_trashAI::EnterEvadeMode(), and EnterEvadeMode().

◆ SetCanAttack()

void npc_escortAI::SetCanAttack ( bool attack )

inline

106{ m_bIsActiveAttacker = attack; }

References m_bIsActiveAttacker.

◆ SetDespawnAtEnd()

void npc_escortAI::SetDespawnAtEnd ( bool despawn )

inline

103{ DespawnAtEnd = despawn; }

References DespawnAtEnd.

Referenced by boss_grand_champion::boss_grand_championAI::boss_grand_championAI(), boss_thorim_sif_blizzard::boss_thorim_sif_blizzardAI::boss_thorim_sif_blizzardAI(), npc_argent_soldier::npc_argent_soldierAI::npc_argent_soldierAI(), npc_crok_scourgebane::npc_crok_scourgebaneAI::npc_crok_scourgebaneAI(), npc_general_andorov::npc_general_andorov(), npc_onyx_flamecaller::npc_onyx_flamecallerAI::npc_onyx_flamecallerAI(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::ReorderInstance(), npc_black_knight_skeletal_gryphon::npc_black_knight_skeletal_gryphonAI::Reset(), brann_bronzebeard::brann_bronzebeardAI::Reset(), npc_arthas::npc_arthasAI::UpdateAI(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::UpdateAI(), violet_hold_trashAI::UpdateAI(), npc_azure_saboteur::npc_azure_saboteurAI::UpdateAI(), and npc_cork_gizelton::npc_cork_gizeltonAI::UpdateEscortAI().

◆ SetDespawnAtFar()

void npc_escortAI::SetDespawnAtFar ( bool despawn )

inline

104{ DespawnAtFar = despawn; }

References DespawnAtFar.

Referenced by npc_scarlet_miner::npc_scarlet_minerAI::InitCartQuest(), npc_crok_scourgebane::npc_crok_scourgebaneAI::npc_crok_scourgebaneAI(), npc_general_andorov::npc_general_andorov(), brann_bronzebeard::brann_bronzebeardAI::Reset(), npc_mootoo_the_younger::npc_mootoo_the_youngerAI::Reset(), npc_bonker_togglevolt::npc_bonker_togglevoltAI::Reset(), npc_apothecary_hanes::npc_Apothecary_HanesAI::Reset(), and npc_arthas::npc_arthasAI::UpdateAI().

◆ SetEscortPaused()

void npc_escortAI::SetEscortPaused ( bool on )

{
    if (!HasEscortState(STATE_ESCORT_ESCORTING))
        return;
 
    if (on)
        AddEscortState(STATE_ESCORT_PAUSED);
    else
        RemoveEscortState(STATE_ESCORT_PAUSED);
}

References AddEscortState(), HasEscortState(), RemoveEscortState(), STATE_ESCORT_ESCORTING, and STATE_ESCORT_PAUSED.

◆ SetMaxPlayerDistance()

void npc_escortAI::SetMaxPlayerDistance ( float newMax )

inline

100{ MaxPlayerDistance = newMax; }

References MaxPlayerDistance.

◆ SetNextWaypoint() [1/2]

bool npc_escortAI::SetNextWaypoint	(	uint32	pointId,
		bool	setPosition = `true`
	)

{
    if (!WaypointList.empty())
        WaypointList.clear();
 
    FillPointMovementListForCreature();
 
    if (WaypointList.empty())
        return false;
 
    Escort_Waypoint waypoint(0, 0, 0, 0, 0);
    for (CurrentWP = WaypointList.begin(); CurrentWP != WaypointList.end(); ++CurrentWP)
    {
        if (CurrentWP->id == pointId)
        {
            if (setPosition)
                me->UpdatePosition(CurrentWP->x, CurrentWP->y, CurrentWP->z, me->GetOrientation());
            return true;
        }
    }
 
    return false;
}

References CurrentWP, FillPointMovementListForCreature(), Position::GetOrientation(), ScriptedAI::me, Unit::UpdatePosition(), and WaypointList.

◆ SetNextWaypoint() [2/2]

bool npc_escortAI::SetNextWaypoint	(	uint32	pointId,
		float	x,
		float	y,
		float	z,
		float	orientation
	)

{
    me->UpdatePosition(x, y, z, orientation);
    return SetNextWaypoint(pointId, false);
}

References ScriptedAI::me, SetNextWaypoint(), and Unit::UpdatePosition().

Referenced by brann_bronzebeard::brann_bronzebeardAI::DoAction(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::ReorderInstance(), npc_time_lost_proto_drake::npc_time_lost_proto_drakeAI::RollPath(), and SetNextWaypoint().

◆ Start()

void npc_escortAI::Start	(	bool	isActiveAttacker = `true`,
		ObjectGuid	playerGUID = `ObjectGuid::Empty`,
		Quest const *	quest = `nullptr`,
		bool	instantRespawn = `false`,
		bool	canLoopPath = `false`,
		bool	resetWaypoints = `true`
	)

{
    if (me->GetVictim())
    {
        LOG_ERROR("entities.unit.ai", "ERROR: EscortAI (script: {}, creature entry: {}) attempts to Start while in combat", me->GetScriptName(), me->GetEntry());
        return;
    }
 
    if (HasEscortState(STATE_ESCORT_ESCORTING))
    {
        LOG_ERROR("entities.unit.ai", "EscortAI (script: {}, creature entry: {}) attempts to Start while already escorting", me->GetScriptName(), me->GetEntry());
        return;
    }
 
    if (!ScriptWP && resetWaypoints) // sd2 never adds wp in script, but tc does
    {
        if (!WaypointList.empty())
            WaypointList.clear();
        FillPointMovementListForCreature();
    }
 
    if (WaypointList.empty())
    {
        LOG_ERROR("sql.sql", "EscortAI (script: {}, creature entry: {}) starts with 0 waypoints (possible missing entry in script_waypoint. Quest: {}).",
                         me->GetScriptName(), me->GetEntry(), quest ? quest->GetQuestId() : 0);
        return;
    }
 
    //set variables
    m_bIsActiveAttacker = isActiveAttacker;
 
    m_uiPlayerGUID = playerGUID;
    m_pQuestForEscort = quest;
 
    m_bCanInstantRespawn = instantRespawn;
    m_bCanReturnToStart = canLoopPath;
 
    if (m_bCanReturnToStart && m_bCanInstantRespawn)
        LOG_DEBUG("scripts.ai", "EscortAI is set to return home after waypoint end and instant respawn at waypoint end. Creature will never despawn.");
 
    if (me->GetMotionMaster()->GetCurrentMovementGeneratorType() == WAYPOINT_MOTION_TYPE)
    {
        me->GetMotionMaster()->MovementExpired();
        me->GetMotionMaster()->MoveIdle();
        LOG_DEBUG("scripts.ai", "EscortAI start with WAYPOINT_MOTION_TYPE, changed to MoveIdle.");
    }
 
    //disable npcflags
    me->ReplaceAllNpcFlags(UNIT_NPC_FLAG_NONE);
    if (me->IsImmuneToNPC())
    {
        HasImmuneToNPCFlags = true;
        me->SetImmuneToNPC(false);
    }
 
    LOG_DEBUG("scripts.ai", "EscortAI started with {} waypoints. ActiveAttacker = {}, PlayerGUID = {}",
        uint64(WaypointList.size()), m_bIsActiveAttacker, m_uiPlayerGUID.ToString());
 
    CurrentWP = WaypointList.begin();
 
    AddEscortState(STATE_ESCORT_ESCORTING);
    if (me->GetMotionMaster()->GetMotionSlotType(MOTION_SLOT_ACTIVE) == ESCORT_MOTION_TYPE)
        me->GetMotionMaster()->MovementExpired();
    me->DisableSpline();
    me->GetMotionMaster()->MoveIdle();
}

References AddEscortState(), CurrentWP, Unit::DisableSpline(), ESCORT_MOTION_TYPE, FillPointMovementListForCreature(), MotionMaster::GetCurrentMovementGeneratorType(), Object::GetEntry(), Unit::GetMotionMaster(), MotionMaster::GetMotionSlotType(), Quest::GetQuestId(), Creature::GetScriptName(), Unit::GetVictim(), HasEscortState(), HasImmuneToNPCFlags, Unit::IsImmuneToNPC(), LOG_DEBUG, LOG_ERROR, m_bCanInstantRespawn, m_bCanReturnToStart, m_bIsActiveAttacker, m_pQuestForEscort, m_uiPlayerGUID, ScriptedAI::me, MOTION_SLOT_ACTIVE, MotionMaster::MoveIdle(), MotionMaster::MovementExpired(), Unit::ReplaceAllNpcFlags(), ScriptWP, Unit::SetImmuneToNPC(), STATE_ESCORT_ESCORTING, ObjectGuid::ToString(), UNIT_NPC_FLAG_NONE, WAYPOINT_MOTION_TYPE, and WaypointList.

Referenced by boss_bjarngrim::boss_bjarngrim(), boss_thorim_lightning_orb::boss_thorim_lightning_orbAI::boss_thorim_lightning_orbAI(), boss_thorim_sif_blizzard::boss_thorim_sif_blizzardAI::boss_thorim_sif_blizzardAI(), boss_yoggsaron_cloud::boss_yoggsaron_cloudAI::boss_yoggsaron_cloudAI(), brann_bronzebeard::brann_bronzebeardAI::DoAction(), npc_tirions_gambit_tirion::npc_tirions_gambit_tirionAI::DoAction(), npc_taretha::npc_tarethaAI::DoAction(), npc_scarlet_miner::npc_scarlet_minerAI::InitCartQuest(), npc_general_andorov::InitializeAI(), npc_kservant::npc_kservantAI::IsSummonedBy(), npc_custodian_of_time::npc_custodian_of_timeAI::MoveInLineOfSight(), npc_ancestral_wolf::npc_ancestral_wolfAI::npc_ancestral_wolfAI(), npc_frosthound::PassengerBoarded(), npc_icefang::npc_icefangAI::PassengerBoarded(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::ReorderInstance(), npc_onyx_flamecaller::npc_onyx_flamecallerAI::Reset(), npc_black_knight_skeletal_gryphon::npc_black_knight_skeletal_gryphonAI::Reset(), npc_plaguehound_tracker::npc_plaguehound_trackerAI::Reset(), npc_time_lost_proto_drake::npc_time_lost_proto_drakeAI::RollPath(), boss_grand_champion::boss_grand_championAI::SetData(), npc_argent_soldier::npc_argent_soldierAI::SetData(), npc_kurenai_captive::npc_kurenai_captiveAI::SetGUID(), npc_captain_saeed::npc_captain_saeedAI::SetGUID(), npc_professor_phizzlethorpe::npc_professor_phizzlethorpeAI::sQuestAccept(), npc_ranger_lilatha::sQuestAccept(), npc_rinji::npc_rinjiAI::sQuestAccept(), npc_corporal_keeshan::npc_corporal_keeshanAI::sQuestAccept(), npc_muglash::npc_muglashAI::sQuestAccept(), npc_wounded_blood_elf::npc_wounded_blood_elfAI::sQuestAccept(), npc_barnes::npc_barnesAI::StartEvent(), npc_clintar_spirit::npc_clintar_spiritAI::StartEvent(), npc_arthas::npc_arthasAI::UpdateAI(), npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI::UpdateAI(), npc_crok_scourgebane::npc_crok_scourgebaneAI::UpdateAI(), violet_hold_trashAI::UpdateAI(), npc_azure_saboteur::npc_azure_saboteurAI::UpdateAI(), npc_grimstone::npc_grimstoneAI::UpdateEscortAI(), npc_magwin::npc_magwinAI::UpdateEscortAI(), and npc_cork_gizelton::npc_cork_gizeltonAI::UpdateEscortAI().

◆ UpdateAI()

void npc_escortAI::UpdateAI ( uint32 )

overridevirtual

Use to start attacking a target. Called just before JustEngagedWith()

Implements UnitAI.

Reimplemented in npc_rocknot::npc_rocknotAI, npc_scarlet_miner::npc_scarlet_minerAI, npc_professor_phizzlethorpe::npc_professor_phizzlethorpeAI, npc_varian_wrynn::npc_varian_wrynnAI, npc_thrall_bfu::npc_thrall_bfuAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_muglash::npc_muglashAI, npc_mimirons_inferno::npc_mimirons_infernoAI, violet_hold_trashAI, npc_lurgglbr::npc_lurgglbrAI, npc_frosthound, npc_icefang::npc_icefangAI, npc_maghar_captive::npc_maghar_captiveAI, npc_garments_of_quests::npc_garments_of_questsAI, npc_lord_gregor_lescovar::npc_lord_gregor_lescovarAI, npc_tyrion_spybot::npc_tyrion_spybotAI, and npc_maxx_a_million_escort::npc_maxx_a_million_escortAI.

{
    if (HasEscortState(STATE_ESCORT_ESCORTING) && !me->GetVictim() && m_uiWPWaitTimer && !HasEscortState(STATE_ESCORT_RETURNING))
    {
        if (m_uiWPWaitTimer <= diff)
        {
            if (CurrentWP == WaypointList.end())
            {
                if (DespawnAtEnd)
                {
                    if (m_bCanReturnToStart)
                    {
                        float fRetX, fRetY, fRetZ;
                        me->GetRespawnPosition(fRetX, fRetY, fRetZ);
                        me->GetMotionMaster()->MovePoint(POINT_HOME, fRetX, fRetY, fRetZ);
 
                        m_uiWPWaitTimer = 0;
                        return;
                    }
 
                    if (m_bCanInstantRespawn)
                    {
                        me->setDeathState(DeathState::JustDied);
                        me->Respawn();
                    }
                    else
                        me->DespawnOrUnsummon();
                }
 
                // xinef: remove escort state, escort was finished (lack of this line resulted in skipping UpdateEscortAI calls after finished escort)
                RemoveEscortState(STATE_ESCORT_ESCORTING);
                return;
            }
 
            if (!HasEscortState(STATE_ESCORT_PAUSED))
            {
                // xinef, start escort if there is no spline active
                if (me->movespline->Finalized())
                {
                    Movement::PointsArray pathPoints;
                    GenerateWaypointArray(&pathPoints);
                    me->GetMotionMaster()->MoveSplinePath(&pathPoints);
                }
 
                WaypointStart(CurrentWP->id);
                m_uiWPWaitTimer = 0;
            }
        }
        else
            m_uiWPWaitTimer -= diff;
    }
 
    //Check if player or any member of his group is within range
    if (HasEscortState(STATE_ESCORT_ESCORTING) && m_uiPlayerGUID && !me->GetVictim() && !HasEscortState(STATE_ESCORT_RETURNING))
    {
        m_uiPlayerCheckTimer += diff;
        if (m_uiPlayerCheckTimer > 1000)
        {
            if (DespawnAtFar && !IsPlayerOrGroupInRange())
            {
                if (m_bCanInstantRespawn)
                {
                    me->setDeathState(DeathState::JustDied);
                    me->Respawn();
                }
                else
                    me->DespawnOrUnsummon();
 
                return;
            }
 
            m_uiPlayerCheckTimer = 0;
        }
    }
 
    UpdateEscortAI(diff);
}

References CurrentWP, DespawnAtEnd, DespawnAtFar, Creature::DespawnOrUnsummon(), Movement::MoveSpline::Finalized(), GenerateWaypointArray(), Unit::GetMotionMaster(), Creature::GetRespawnPosition(), Unit::GetVictim(), HasEscortState(), IsPlayerOrGroupInRange(), JustDied, m_bCanInstantRespawn, m_bCanReturnToStart, m_uiPlayerCheckTimer, m_uiPlayerGUID, m_uiWPWaitTimer, ScriptedAI::me, MotionMaster::MovePoint(), Unit::movespline, MotionMaster::MoveSplinePath(), POINT_HOME, RemoveEscortState(), Creature::Respawn(), Creature::setDeathState(), STATE_ESCORT_ESCORTING, STATE_ESCORT_PAUSED, STATE_ESCORT_RETURNING, UpdateEscortAI(), WaypointList, and WaypointStart().

◆ UpdateEscortAI()

void npc_escortAI::UpdateEscortAI ( uint32 diff )

virtual

Reimplemented in npc_grimstone::npc_grimstoneAI, npc_rinji::npc_rinjiAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_general_andorov, npc_magwin::npc_magwinAI, npc_cork_gizelton::npc_cork_gizeltonAI, npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, npc_ranshalla::npc_ranshallaAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, boss_bjarngrim, brann_bronzebeard::brann_bronzebeardAI, boss_yoggsaron_cloud::boss_yoggsaron_cloudAI, npc_apothecary_hanes::npc_Apothecary_HanesAI, npc_tirions_gambit_tirion::npc_tirions_gambit_tirionAI, npc_time_lost_proto_drake::npc_time_lost_proto_drakeAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_isla_starmane::npc_isla_starmaneAI, npc_crok_scourgebane::npc_crok_scourgebaneAI, and npc_bonker_togglevolt::npc_bonker_togglevoltAI.

{
    if (!UpdateVictim())
        return;
 
    DoMeleeAttackIfReady();
}

References UnitAI::DoMeleeAttackIfReady(), and CreatureAI::UpdateVictim().

Referenced by UpdateAI(), npc_magwin::npc_magwinAI::UpdateEscortAI(), npc_ranshalla::npc_ranshallaAI::UpdateEscortAI(), and brann_bronzebeard::brann_bronzebeardAI::UpdateEscortAI().

◆ WaypointReached()

virtual void npc_escortAI::WaypointReached ( uint32 pointId )

pure virtual

Implemented in npc_black_knight_skeletal_gryphon::npc_black_knight_skeletal_gryphonAI, boss_grand_champion::boss_grand_championAI, npc_captain_saeed::npc_captain_saeedAI, brann_bronzebeard::brann_bronzebeardAI, violet_hold_trashAI, boss_bjarngrim, npc_ranshalla::npc_ranshallaAI, npc_tirions_gambit_tirion::npc_tirions_gambit_tirionAI, npc_argent_soldier::npc_argent_soldierAI, npc_arthas::npc_arthasAI, npc_azure_saboteur::npc_azure_saboteurAI, npc_grimstone::npc_grimstoneAI, npc_rocknot::npc_rocknotAI, npc_barnes::npc_barnesAI, npc_scarlet_miner::npc_scarlet_minerAI, npc_professor_phizzlethorpe::npc_professor_phizzlethorpeAI, npc_ranger_lilatha, npc_rinji::npc_rinjiAI, npc_corporal_keeshan::npc_corporal_keeshanAI, npc_deathstalker_erland::npc_deathstalker_erlandAI, npc_lord_gregor_lescovar::npc_lord_gregor_lescovarAI, npc_tyrion_spybot::npc_tyrion_spybotAI, npc_varian_wrynn::npc_varian_wrynnAI, npc_thrall_bfu::npc_thrall_bfuAI, npc_daphne_stilwell::npc_daphne_stilwellAI, npc_tapoke_slim_jahn::npc_tapoke_slim_jahnAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_taretha::npc_tarethaAI, npc_general_andorov, npc_muglash::npc_muglashAI, npc_magwin::npc_magwinAI, npc_prospector_remtravel::npc_prospector_remtravelAI, npc_cork_gizelton::npc_cork_gizeltonAI, npc_clintar_spirit::npc_clintar_spiritAI, npc_kaya_flathoof::npc_kaya_flathoofAI, npc_custodian_of_time::npc_custodian_of_timeAI, npc_gilthares::npc_giltharesAI, npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, npc_lakota_windsong::npc_lakota_windsongAI, npc_paoka_swiftmountain::npc_paoka_swiftmountainAI, npc_ame::npc_ameAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, npc_crok_scourgebane::npc_crok_scourgebaneAI, npc_lurgglbr::npc_lurgglbrAI, npc_mootoo_the_younger::npc_mootoo_the_youngerAI, npc_bonker_togglevolt::npc_bonker_togglevoltAI, npc_emily::npc_emilyAI, npc_apothecary_hanes::npc_Apothecary_HanesAI, npc_plaguehound_tracker::npc_plaguehound_trackerAI, npc_engineer_helice::npc_engineer_heliceAI, npc_frosthound, npc_ancestral_wolf::npc_ancestral_wolfAI, npc_wounded_blood_elf::npc_wounded_blood_elfAI, npc_maghar_captive::npc_maghar_captiveAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_bessy::npc_bessyAI, npc_maxx_a_million_escort::npc_maxx_a_million_escortAI, npc_kservant::npc_kservantAI, npc_isla_starmane::npc_isla_starmaneAI, npc_mimirons_inferno::npc_mimirons_infernoAI, boss_thorim_lightning_orb::boss_thorim_lightning_orbAI, boss_thorim_sif_blizzard::boss_thorim_sif_blizzardAI, boss_yoggsaron_cloud::boss_yoggsaron_cloudAI, npc_time_lost_proto_drake::npc_time_lost_proto_drakeAI, npc_icefang::npc_icefangAI, and npc_garments_of_quests::npc_garments_of_questsAI.

Referenced by MovementInform().

◆ WaypointStart()

virtual void npc_escortAI::WaypointStart ( uint32 )

inlinevirtual

Reimplemented in npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, and npc_crok_scourgebane::npc_crok_scourgebaneAI.

91{}

Referenced by UpdateAI().

Member Data Documentation

◆ CurrentWP

std::list<Escort_Waypoint>::iterator npc_escortAI::CurrentWP

private

Referenced by GenerateWaypointArray(), MovementInform(), SetNextWaypoint(), Start(), and UpdateAI().

◆ DespawnAtEnd

bool npc_escortAI::DespawnAtEnd

private

Referenced by SetDespawnAtEnd(), and UpdateAI().

◆ DespawnAtFar

bool npc_escortAI::DespawnAtFar

private

Referenced by SetDespawnAtFar(), and UpdateAI().

◆ HasImmuneToNPCFlags

bool npc_escortAI::HasImmuneToNPCFlags

private

Referenced by EnterEvadeMode(), and Start().

◆ m_bCanInstantRespawn

bool npc_escortAI::m_bCanInstantRespawn

private

Referenced by Start(), and UpdateAI().

◆ m_bCanReturnToStart

bool npc_escortAI::m_bCanReturnToStart

private

Referenced by Start(), and UpdateAI().

◆ m_bIsActiveAttacker

bool npc_escortAI::m_bIsActiveAttacker

private

Referenced by GetAttack(), SetCanAttack(), and Start().

◆ m_pQuestForEscort

Quest const* npc_escortAI::m_pQuestForEscort

private

Referenced by JustDied(), and Start().

◆ m_uiEscortState

uint32 npc_escortAI::m_uiEscortState

private

Referenced by AddEscortState(), HasEscortState(), IsEscorted(), and RemoveEscortState().

◆ m_uiPlayerCheckTimer

uint32 npc_escortAI::m_uiPlayerCheckTimer

private

Referenced by UpdateAI().

◆ m_uiPlayerGUID

ObjectGuid npc_escortAI::m_uiPlayerGUID

private

Referenced by GetEventStarterGUID(), GetPlayerForEscort(), JustDied(), Start(), and UpdateAI().

◆ m_uiWPWaitTimer

uint32 npc_escortAI::m_uiWPWaitTimer

private

Referenced by JustRespawned(), MovementInform(), and UpdateAI().

◆ MaxPlayerDistance

float npc_escortAI::MaxPlayerDistance

private

Referenced by GetMaxPlayerDistance(), and SetMaxPlayerDistance().

◆ ScriptWP

bool npc_escortAI::ScriptWP

private

Referenced by AddWaypoint(), and Start().

◆ WaypointList

std::list<Escort_Waypoint> npc_escortAI::WaypointList

private

Referenced by AddWaypoint(), FillPointMovementListForCreature(), GenerateWaypointArray(), MovementInform(), SetNextWaypoint(), Start(), and UpdateAI().

The documentation for this struct was generated from the following files:

azerothcore-wotlk/src/server/game/AI/ScriptedAI/ScriptedEscortAI.h
azerothcore-wotlk/src/server/game/AI/ScriptedAI/ScriptedEscortAI.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ npc_escortAI()

◆ ~npc_escortAI()

Member Function Documentation

◆ AddEscortState()

◆ AddWaypoint()

◆ AssistPlayerInCombatAgainst()

◆ AttackStart()

◆ EnterEvadeMode()

◆ FillPointMovementListForCreature()

◆ GenerateWaypointArray()

◆ GetAttack()

◆ GetEventStarterGUID()

◆ GetMaxPlayerDistance()

◆ GetPlayerForEscort()

◆ GetWaypointPosition()

◆ HasEscortState()

◆ IsEscorted()

◆ IsPlayerOrGroupInRange()

◆ JustDied()

◆ JustRespawned()

◆ MoveInLineOfSight()

◆ MovementInform()

◆ RemoveEscortState()

◆ ReturnToLastPoint()

◆ SetCanAttack()

◆ SetDespawnAtEnd()

◆ SetDespawnAtFar()

◆ SetEscortPaused()

◆ SetMaxPlayerDistance()

◆ SetNextWaypoint() [1/2]

◆ SetNextWaypoint() [2/2]

◆ Start()

◆ UpdateAI()

◆ UpdateEscortAI()

◆ WaypointReached()

◆ WaypointStart()

Member Data Documentation

◆ CurrentWP

◆ DespawnAtEnd

◆ DespawnAtFar

◆ HasImmuneToNPCFlags

◆ m_bCanInstantRespawn

◆ m_bCanReturnToStart

◆ m_bIsActiveAttacker

◆ m_pQuestForEscort

◆ m_uiEscortState

◆ m_uiPlayerCheckTimer

◆ m_uiPlayerGUID

◆ m_uiWPWaitTimer

◆ MaxPlayerDistance

◆ ScriptWP

◆ WaypointList