#include <ScriptedEscortAI.h>

Public Member Functions
	npc_escortAI (Creature *creature)

	~npc_escortAI ()

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

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 resetWaypointsOnFail=true)

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

virtual void	WaypointReached (uint32 pointId)=0

virtual void	WaypointStart (uint32)

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

void	SetRun (bool on=true)

void	SetEscortPaused (bool on)

bool	HasEscortState (uint32 escortState)

virtual bool	IsEscorted () const override

void	SetMaxPlayerDistance (float newMax)

float	GetMaxPlayerDistance () const

void	SetDespawnAtEnd (bool despawn)

void	SetDespawnAtFar (bool despawn)

bool	GetAttack () const

void	SetCanAttack (bool attack)

ObjectGuid	GetEventStarterGUID () const

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

virtual	~ScriptedAI ()

void	AttackStartNoMove (Unit *target)

void	DamageTaken (Unit *, uint32 &) 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	OnPossess (bool)

void	Reset () override

void	EnterCombat (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	DoResetThreat ()

float	DoGetThreat (Unit *unit)

void	DoModifyThreatPercent (Unit *unit, int32 pct)

void	DoTeleportTo (float x, float y, float z, uint32 time=0)

void	DoTeleportTo (float const pos[4])

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

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	HealthBelowPct (uint32 pct) const

bool	HealthAbovePct (uint32 pct) const

SpellInfo const *	SelectSpell (Unit *target, uint32 school, uint32 mechanic, SelectTargetType targets, 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)

void	SetCombatMovement (bool allowMovement)

bool	IsCombatMovementAllowed () 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

Public Member Functions inherited from CreatureAI
void	Talk (uint8 id, WorldObject const *whisperTarget=nullptr)

	CreatureAI (Creature *creature)

virtual	~CreatureAI ()

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

void	TriggerAlert (Unit const *who) const

virtual bool	CanRespawn ()

virtual void	IsSummonedBy (Unit *)

virtual void	SummonedCreatureDies (Creature , Unit )

virtual void	AttackedBy (Unit *)

void	OnCharmed (bool apply) override

virtual void	JustReachedHome ()

void	DoZoneInCombat (Creature *creature=NULL, float maxRangeToNearestTarget=50.0f)

virtual void	ReceiveEmote (Player *, uint32)

virtual void	OwnerAttackedBy (Unit *)

virtual void	OwnerAttacked (Unit *)

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

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

virtual void	OnSpellClick (Unit *, bool &)

virtual bool	CanSeeAlways (WorldObject const *)

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

virtual bool	CheckInRoom ()

CreatureBoundary const *	GetBoundary () const

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, int32=0)

virtual ObjectGuid	GetGUID (int32=0) const

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

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

void	SelectTargetList (std::list< Unit * > &targetList, uint32 num, SelectAggroTarget targetType, float dist=0.0f, bool playerOnly=false, int32 aura=0)

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

virtual void	DamageDealt (Unit *, uint32 &, DamageEffectType)

virtual void	HealReceived (Unit *, uint32 &)

virtual void	HealDone (Unit *, uint32 &)

virtual void	SpellInterrupted (uint32, uint32)

void	AttackStartCaster (Unit *victim, float dist)

void	DoCast (uint32 spellId)

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

void	DoCastVictim (uint32 spellId, bool triggered=false)

void	DoCastAOE (uint32 spellId, bool triggered=false)

void	DoMeleeAttackIfReady ()

bool	DoSpellAttackIfReady (uint32 spellId)

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	sQuestReward (Player , Quest const , uint32)

virtual bool	sOnDummyEffect (Unit *, uint32, SpellEffIndex)

virtual void	sOnGameEvent (bool, uint16)

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	CheckBoundary (Position const *who=nullptr) const

void	SetBoundary (CreatureBoundary const *boundary)

bool	_EnterEvadeMode (EvadeReason why=EVADE_REASON_OTHER)

Private Member Functions
bool	AssistPlayerInCombat (Unit *who)

bool	IsPlayerOrGroupInRange ()

void	FillPointMovementListForCreature ()

void	AddEscortState (uint32 escortState)

void	RemoveEscortState (uint32 escortState)

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_bIsRunning

bool	m_bCanInstantRespawn

bool	m_bCanReturnToStart

bool	DespawnAtEnd

bool	DespawnAtFar

bool	ScriptWP

bool	HasImmuneToNPCFlags

Additional Inherited Members
Public Types inherited from CreatureAI
enum	EvadeReason { EVADE_REASON_NO_HOSTILES, EVADE_REASON_BOUNDARY, EVADE_REASON_SEQUENCE_BREAK, EVADE_REASON_OTHER }

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

Public Attributes inherited from ScriptedAI
bool	IsFleeing

Static Public Attributes inherited from UnitAI
static AISpellInfoType *	AISpellInfo

Protected Attributes inherited from CreatureAI
Creature *const	me

CreatureBoundary const *	_boundary

Protected Attributes inherited from UnitAI
Unit *const	me

Constructor & Destructor Documentation

npc_escortAI::npc_escortAI ( Creature * creature )

explicit

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

npc_escortAI::~npc_escortAI ( )

inline

56 { }

Member Function Documentation

void npc_escortAI::AddEscortState ( uint32 escortState )

inlineprivate

116 { m_uiEscortState |= escortState; }

npc_escortAI::m_uiEscortState

uint32 m_uiEscortState

Definition: ScriptedEscortAI.h:122

Here is the caller graph for this function:

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);*/
 }

Here is the caller graph for this function:

bool npc_escortAI::AssistPlayerInCombat ( Unit * who )

private

 {
  if (!who || !who->GetVictim())
  return false;
 
  //experimental (unknown) flag not present
  if (!(me->GetCreatureTemplate()->type_flags & CREATURE_TYPEFLAGS_CAN_ASSIST))
  return false;
 
  //not a player
  if (!who->EnsureVictim()->GetCharmerOrOwnerPlayerOrPlayerItself())
  return false;
 
  //never attack friendly
  if (me->IsFriendlyTo(who))
  return false;
 
  //too far away and no free sight?
  if (me->IsWithinDistInMap(who, GetMaxPlayerDistance()) && me->IsWithinLOSInMap(who))
  {
  //already fighting someone?
  if (!me->GetVictim())
  {
  AttackStart(who);
  return true;
  }
  else
  {
  who->SetInCombatWith(me);
  me->AddThreat(who, 0.0f);
  return true;
  }
  }
 
  return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::AttackStart ( Unit * who )

overridevirtual

Reimplemented from ScriptedAI.

Reimplemented in npc_highlord_darion_mograine::npc_highlord_darion_mograineAI, npc_arthas::npc_arthasAI, and npc_icefang::npc_icefangAI.

 {
  if (!who)
  return;
 
  if (me->Attack(who, true))
  {
  if (me->GetMotionMaster()->GetCurrentMovementGeneratorType() == POINT_MOTION_TYPE)
  me->GetMotionMaster()->MovementExpired();
 
  if (IsCombatMovementAllowed())
  me->GetMotionMaster()->MoveChase(who);
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::EnterEvadeMode ( EvadeReason = EVADE_REASON_OTHER )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_highlord_darion_mograine::npc_highlord_darion_mograineAI, npc_icefang::npc_icefangAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, npc_ancestral_wolf::npc_ancestral_wolfAI, and hyjalAI.

 {
  me->RemoveAllAuras();
  me->DeleteThreatList();
  me->CombatStop(true);
  me->SetLootRecipient(NULL);
 
  if (HasEscortState(STATE_ESCORT_ESCORTING))
  {
  AddEscortState(STATE_ESCORT_RETURNING);
  ReturnToLastPoint();
  TC_LOG_DEBUG("scripts", "EscortAI has left combat and is now returning to last point");
  }
  else
  {
  me->GetMotionMaster()->MoveTargetedHome();
  if (HasImmuneToNPCFlags)
  me->SetFlag(UNIT_FIELD_FLAGS, UNIT_FLAG_IMMUNE_TO_NPC);
  Reset();
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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);
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool npc_escortAI::GetAttack ( ) const

inline

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

npc_escortAI::m_bIsActiveAttacker

bool m_bIsActiveAttacker

Definition: ScriptedEscortAI.h:130

Here is the caller graph for this function:

ObjectGuid npc_escortAI::GetEventStarterGUID ( ) const

inline

106 { return m_uiPlayerGUID; }

npc_escortAI::m_uiPlayerGUID

ObjectGuid m_uiPlayerGUID

Definition: ScriptedEscortAI.h:119

float npc_escortAI::GetMaxPlayerDistance ( ) const

inline

100 { return MaxPlayerDistance; }

npc_escortAI::MaxPlayerDistance

float MaxPlayerDistance

Definition: ScriptedEscortAI.h:123

Here is the caller graph for this function:

Player* npc_escortAI::GetPlayerForEscort ( )

inlineprotected

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

CreatureAI::me

Creature *const me

Definition: CreatureAI.h:71

ObjectAccessor::GetPlayer

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

Definition: ObjectAccessor.cpp:184

npc_escortAI::m_uiPlayerGUID

ObjectGuid m_uiPlayerGUID

Definition: ScriptedEscortAI.h:119

Here is the call graph for this function:

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;
 }

Here is the call graph for this function:

bool npc_escortAI::HasEscortState ( uint32 escortState )

inline

96 { return (m_uiEscortState & escortState) != 0; }

npc_escortAI::m_uiEscortState

uint32 m_uiEscortState

Definition: ScriptedEscortAI.h:122

Here is the caller graph for this function:

virtual bool npc_escortAI::IsEscorted ( ) const

inlineoverridevirtual

Reimplemented from CreatureAI.

97 { return (m_uiEscortState & STATE_ESCORT_ESCORTING); }

npc_escortAI::m_uiEscortState

uint32 m_uiEscortState

Definition: ScriptedEscortAI.h:122

STATE_ESCORT_ESCORTING

Definition: ScriptedEscortAI.h:47

bool npc_escortAI::IsPlayerOrGroupInRange ( )

private

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

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::JustDied ( Unit * )

overridevirtual

Reimplemented from ScriptedAI.

Reimplemented in npc_bonker_togglevolt::npc_bonker_togglevoltAI, npc_mootoo_the_younger::npc_mootoo_the_youngerAI, npc_gargoyle::npc_gargoyleAI, npc_frost_wyrm::npc_frost_wyrmAI, npc_thassarian::npc_thassarianAI, npc_maxx_a_million_escort::npc_maxx_a_million_escortAI, npc_argent_soldier::npc_argent_soldierAI, npc_bessy::npc_bessyAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_isla_starmane::npc_isla_starmaneAI, npc_arthas::npc_arthasAI, npc_icefang::npc_icefangAI, npc_engineer_helice::npc_engineer_heliceAI, npc_lesser_doomguard::npc_lesser_doomguardAI, npc_muglash::npc_muglashAI, npc_disciple_of_naralex::npc_disciple_of_naralexAI, boss_ambassador_hellmaw::boss_ambassador_hellmawAI, hyjalAI, npc_willix::npc_willixAI, npc_maghar_captive::npc_maghar_captiveAI, boss_azgalor::boss_azgalorAI, boss_anetheron::boss_anetheronAI, boss_kazrogal::boss_kazrogalAI, boss_rage_winterchill::boss_rage_winterchillAI, npc_apothecary_hanes::npc_Apothecary_HanesAI, npc_injured_goblin::npc_injured_goblinAI, and hyjal_trashAI.

 {
  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 != NULL; groupRef = groupRef->next())
  if (Player* member = groupRef->GetSource())
  if (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());
  }
  }
 }

Here is the call graph for this function:

void npc_escortAI::JustRespawned ( )

overridevirtual

Reimplemented from CreatureAI.

 {
  m_uiEscortState = STATE_ESCORT_NONE;
 
  if (!IsCombatMovementAllowed())
  SetCombatMovement(true);
 
  //add a small delay before going to first waypoint, normal in near all cases
  m_uiWPWaitTimer = 2500;
 
  if (me->getFaction() != me->GetCreatureTemplate()->faction)
  me->RestoreFaction();
 
  Reset();
 }

Here is the call graph for this function:

void npc_escortAI::MoveInLineOfSight ( Unit * who )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_highlord_darion_mograine::npc_highlord_darion_mograineAI, npc_kservant::npc_kservantAI, npc_custodian_of_time::npc_custodian_of_timeAI, npc_skywing::npc_skywingAI, npc_lesser_doomguard::npc_lesser_doomguardAI, hyjalAI, and boss_ambassador_hellmaw::boss_ambassador_hellmawAI.

 {
  if (!me->HasUnitState(UNIT_STATE_STUNNED) && who->isTargetableForAttack() && who->isInAccessiblePlaceFor(me))
  {
  if (HasEscortState(STATE_ESCORT_ESCORTING) && AssistPlayerInCombat(who))
  return;
 
  if (!me->CanFly() && me->GetDistanceZ(who) > CREATURE_Z_ATTACK_RANGE)
  return;
 
  if (me->IsHostileTo(who))
  {
  float fAttackRadius = me->GetAttackDistance(who);
  if (me->IsWithinDistInMap(who, fAttackRadius) && me->IsWithinLOSInMap(who))
  {
  if (!me->GetVictim())
  {
  // Clear distracted state on combat
  if (me->HasUnitState(UNIT_STATE_DISTRACTED))
  {
  me->ClearUnitState(UNIT_STATE_DISTRACTED);
  me->GetMotionMaster()->Clear();
  }
 
  AttackStart(who);
  }
  else if (me->GetMap()->IsDungeon())
  {
  who->SetInCombatWith(me);
  me->AddThreat(who, 0.0f);
  }
  }
  }
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

overridevirtual

Reimplemented from CreatureAI.

 {
     if (moveType != POINT_MOTION_TYPE || !HasEscortState(STATE_ESCORT_ESCORTING))
         return;
 
     //Combat start position reached, continue waypoint movement
     if (pointId == POINT_LAST_POINT)
     {
         TC_LOG_DEBUG("scripts", "EscortAI has returned to original position before combat");
 
         me->SetWalk(!m_bIsRunning);
         RemoveEscortState(STATE_ESCORT_RETURNING);
 
         if (!m_uiWPWaitTimer)
             m_uiWPWaitTimer = 1;
     }
     else if (pointId == POINT_HOME)
     {
         TC_LOG_DEBUG("scripts", "EscortAI has returned to original home location and will continue from beginning of waypoint list.");
 
         CurrentWP = WaypointList.begin();
         m_uiWPWaitTimer = 1;
     }
     else
     {
         //Make sure that we are still on the right waypoint
         if (CurrentWP->id != pointId)
         {
             TC_LOG_ERROR("misc", "TSCR ERROR: EscortAI reached waypoint out of order %u, expected %u, creature entry %u", pointId, CurrentWP->id, me->GetEntry());
             return;
         }
 
         TC_LOG_DEBUG("scripts", "EscortAI Waypoint %u reached", CurrentWP->id);
 
         //Call WP function
         WaypointReached(CurrentWP->id);
 
         m_uiWPWaitTimer = CurrentWP->WaitTimeMs + 1;
 
         ++CurrentWP;
     }
 }

Here is the call graph for this function:

void npc_escortAI::RemoveEscortState ( uint32 escortState )

inlineprivate

117 { m_uiEscortState &= ~escortState; }

npc_escortAI::m_uiEscortState

uint32 m_uiEscortState

Definition: ScriptedEscortAI.h:122

Here is the caller graph for this function:

void npc_escortAI::ReturnToLastPoint ( )

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

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::SetCanAttack ( bool attack )

inline

105 { m_bIsActiveAttacker = attack; }

npc_escortAI::m_bIsActiveAttacker

bool m_bIsActiveAttacker

Definition: ScriptedEscortAI.h:130

Here is the caller graph for this function:

void npc_escortAI::SetDespawnAtEnd ( bool despawn )

inline

102 { DespawnAtEnd = despawn; }

npc_escortAI::DespawnAtEnd

bool DespawnAtEnd

Definition: ScriptedEscortAI.h:134

Here is the caller graph for this function:

void npc_escortAI::SetDespawnAtFar ( bool despawn )

inline

103 { DespawnAtFar = despawn; }

npc_escortAI::DespawnAtFar

bool DespawnAtFar

Definition: ScriptedEscortAI.h:135

Here is the caller graph for this function:

void npc_escortAI::SetEscortPaused ( bool on )

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

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::SetMaxPlayerDistance ( float newMax )

inline

99 { MaxPlayerDistance = newMax; }

npc_escortAI::MaxPlayerDistance

float MaxPlayerDistance

Definition: ScriptedEscortAI.h:123

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

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

Here is the call graph for this function:

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

 {
     if (!WaypointList.empty())
         WaypointList.clear();
 
     FillPointMovementListForCreature();
 
     if (WaypointList.empty())
         return false;
 
     size_t const size = WaypointList.size();
     Escort_Waypoint waypoint(0, 0, 0, 0, 0);
     do
     {
         waypoint = WaypointList.front();
         WaypointList.pop_front();
         if (waypoint.id == pointId)
         {
             if (setPosition)
                 me->UpdatePosition(waypoint.x, waypoint.y, waypoint.z, me->GetOrientation());
 
             CurrentWP = WaypointList.begin();
             return true;
         }
     }
     while (!WaypointList.empty());
 
     // we failed.
     // we reset the waypoints in the start; if we pulled any, reset it again
     if (resetWaypointsOnFail && size != WaypointList.size())
     {
         if (!WaypointList.empty())
             WaypointList.clear();
 
         FillPointMovementListForCreature();
     }
 
     return false;
 }

Here is the call graph for this function:

void npc_escortAI::SetRun ( bool on = true )

 {
     if (on)
     {
         if (!m_bIsRunning)
             me->SetWalk(false);
         else
             TC_LOG_DEBUG("scripts", "EscortAI attempt to set run mode, but is already running.");
     }
     else
     {
         if (m_bIsRunning)
             me->SetWalk(true);
         else
             TC_LOG_DEBUG("scripts", "EscortAI attempt to set walk mode, but is already walking.");
     }
 
     m_bIsRunning = on;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Todo:: get rid of this many variables passed in function.

 {
     if (me->GetVictim())
     {
         TC_LOG_ERROR("misc", "TSCR ERROR: EscortAI (script: %s, creature entry: %u) attempts to Start while in combat", me->GetScriptName().c_str(), me->GetEntry());
         return;
     }
 
     if (HasEscortState(STATE_ESCORT_ESCORTING))
     {
         TC_LOG_ERROR("scripts", "EscortAI (script: %s, creature entry: %u) attempts to Start while already escorting", me->GetScriptName().c_str(), me->GetEntry());
         return;
     }
 
     if (!ScriptWP && resetWaypoints) // sd2 never adds wp in script, but tc does
     {
         if (!WaypointList.empty())
             WaypointList.clear();
         FillPointMovementListForCreature();
     }
 
     if (WaypointList.empty())
     {
         TC_LOG_ERROR("scripts", "EscortAI (script: %s, creature entry: %u) starts with 0 waypoints (possible missing entry in script_waypoint. Quest: %u).",
             me->GetScriptName().c_str(), me->GetEntry(), quest ? quest->GetQuestId() : 0);
         return;
     }
 
     //set variables
     m_bIsActiveAttacker = isActiveAttacker;
     m_bIsRunning = run;
 
     m_uiPlayerGUID = playerGUID;
     m_pQuestForEscort = quest;
 
     m_bCanInstantRespawn = instantRespawn;
     m_bCanReturnToStart = canLoopPath;
 
     if (m_bCanReturnToStart && m_bCanInstantRespawn)
         TC_LOG_DEBUG("scripts", "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();
         TC_LOG_DEBUG("scripts", "EscortAI start with WAYPOINT_MOTION_TYPE, changed to MoveIdle.");
     }
 
     //disable npcflags
     me->SetUInt64Value(UNIT_NPC_FLAGS, UNIT_NPC_FLAG_NONE);
     if (me->HasFlag(UNIT_FIELD_FLAGS, UNIT_FLAG_IMMUNE_TO_NPC))
     {
         HasImmuneToNPCFlags = true;
         me->RemoveFlag(UNIT_FIELD_FLAGS, UNIT_FLAG_IMMUNE_TO_NPC);
     }
 
     TC_LOG_DEBUG("scripts", "EscortAI started with " UI64FMTD " waypoints. ActiveAttacker = %d, Run = %d, %s", uint64(WaypointList.size()), m_bIsActiveAttacker, m_bIsRunning, m_uiPlayerGUID.ToString().c_str());
 
     CurrentWP = WaypointList.begin();
 
     //Set initial speed
     if (m_bIsRunning)
         me->SetWalk(false);
     else
         me->SetWalk(true);
 
     AddEscortState(STATE_ESCORT_ESCORTING);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::UpdateAI ( uint32 diff )

overridevirtual

Reimplemented from ScriptedAI.

Reimplemented in npc_gargoyle::npc_gargoyleAI, npc_scarlet_miner::npc_scarlet_minerAI, npc_frost_wyrm::npc_frost_wyrmAI, npc_garments_of_quests::npc_garments_of_questsAI, npc_fel_stalker::npc_fel_stalkerAI, npc_mimirons_inferno::npc_mimirons_infernoAI, npc_crypt_fiend::npc_crypt_fiendAI, npc_thassarian::npc_thassarianAI, npc_banshee::npc_bansheeAI, npc_earthmender_wilda::npc_earthmender_wildaAI, npc_necromancer::npc_necromancerAI, npc_rocknot::npc_rocknotAI, npc_ghoul::npc_ghoulAI, npc_maxx_a_million_escort::npc_maxx_a_million_escortAI, npc_taretha::npc_tarethaAI, npc_highlord_darion_mograine::npc_highlord_darion_mograineAI, npc_arthas::npc_arthasAI, npc_argent_soldier::npc_argent_soldierAI, npc_lurgglbr::npc_lurgglbrAI, npc_abomination::npc_abominationAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_giant_infernal::npc_giant_infernalAI, npc_demolitionist_legoso::npc_demolitionist_legosoAI, npc_black_knight_skeletal_gryphon::npc_black_knight_skeletal_gryphonAI, npc_icefang::npc_icefangAI, npc_engineer_helice::npc_engineer_heliceAI, npc_koltira_deathweaver::npc_koltira_deathweaverAI, npc_muglash::npc_muglashAI, npc_custodian_of_time::npc_custodian_of_timeAI, npc_barnes::npc_barnesAI, npc_skywing::npc_skywingAI, npc_lesser_doomguard::npc_lesser_doomguardAI, generic_vehicleAI_toc5::generic_vehicleAI_toc5AI, npc_grimstone::npc_grimstoneAI, npc_disciple_of_naralex::npc_disciple_of_naralexAI, npc_maghar_captive::npc_maghar_captiveAI, npc_scarlet_trainee::npc_scarlet_traineeAI, hyjalAI, boss_azgalor::boss_azgalorAI, npc_professor_phizzlethorpe::npc_professor_phizzlethorpeAI, npc_ruul_snowhoof::npc_ruul_snowhoofAI, boss_anetheron::boss_anetheronAI, boss_kazrogal::boss_kazrogalAI, boss_rage_winterchill::boss_rage_winterchillAI, npc_injured_goblin::npc_injured_goblinAI, and hyjal_trashAI.

 {
     //Waypoint Updating
     if (HasEscortState(STATE_ESCORT_ESCORTING) && !me->GetVictim() && m_uiWPWaitTimer && !HasEscortState(STATE_ESCORT_RETURNING))
     {
         if (m_uiWPWaitTimer <= diff)
         {
             //End of the line
             if (CurrentWP == WaypointList.end())
             {
                 if (DespawnAtEnd)
                 {
                     TC_LOG_DEBUG("scripts", "EscortAI reached end of waypoints");
 
                     if (m_bCanReturnToStart)
                     {
                         float fRetX, fRetY, fRetZ;
                         me->GetRespawnPosition(fRetX, fRetY, fRetZ);
 
                         me->GetMotionMaster()->MovePoint(POINT_HOME, fRetX, fRetY, fRetZ);
 
                         m_uiWPWaitTimer = 0;
 
                         TC_LOG_DEBUG("scripts", "EscortAI are returning home to spawn location: %u, %f, %f, %f", POINT_HOME, fRetX, fRetY, fRetZ);
                         return;
                     }
 
                     if (m_bCanInstantRespawn)
                     {
                         me->setDeathState(JUST_DIED);
                         me->Respawn();
                     }
                     else
                         me->DespawnOrUnsummon();
 
                     return;
                 }
                 else
                 {
                     TC_LOG_DEBUG("scripts", "EscortAI reached end of waypoints with Despawn off");
 
                     return;
                 }
             }
 
             if (!HasEscortState(STATE_ESCORT_PAUSED))
             {
                 me->GetMotionMaster()->MovePoint(CurrentWP->id, CurrentWP->x, CurrentWP->y, CurrentWP->z);
                 TC_LOG_DEBUG("scripts", "EscortAI start waypoint %u (%f, %f, %f).", CurrentWP->id, CurrentWP->x, CurrentWP->y, CurrentWP->z);
 
                 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.IsEmpty() && !me->GetVictim() && !HasEscortState(STATE_ESCORT_RETURNING))
     {
         if (m_uiPlayerCheckTimer <= diff)
         {
             if (DespawnAtFar && !IsPlayerOrGroupInRange())
             {
                 TC_LOG_DEBUG("scripts", "EscortAI failed because player/group was to far away or not found");
 
                 if (m_bCanInstantRespawn)
                 {
                     me->setDeathState(JUST_DIED);
                     me->Respawn();
                 }
                 else
                     me->DespawnOrUnsummon();
 
                 return;
             }
 
             m_uiPlayerCheckTimer = 1000;
         }
         else
             m_uiPlayerCheckTimer -= diff;
     }
 
     UpdateEscortAI(diff);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void npc_escortAI::UpdateEscortAI ( uint32 diff )

virtual

Reimplemented in npc_bonker_togglevolt::npc_bonker_togglevoltAI, npc_crok_scourgebane::npc_crok_scourgebaneAI, violet_hold_trashAI, npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, npc_ranshalla::npc_ranshallaAI, npc_brann_hos::npc_brann_hosAI, npc_blastmaster_emi_shortfuse::npc_blastmaster_emi_shortfuseAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, boss_ambassador_hellmaw::boss_ambassador_hellmawAI, and npc_apothecary_hanes::npc_Apothecary_HanesAI.

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

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void npc_escortAI::WaypointReached ( uint32 pointId )

pure virtual

Implemented in npc_bonker_togglevolt::npc_bonker_togglevoltAI, npc_mootoo_the_younger::npc_mootoo_the_youngerAI, npc_gargoyle::npc_gargoyleAI, npc_scarlet_miner::npc_scarlet_minerAI, npc_frost_wyrm::npc_frost_wyrmAI, npc_garments_of_quests::npc_garments_of_questsAI, npc_fel_stalker::npc_fel_stalkerAI, npc_crok_scourgebane::npc_crok_scourgebaneAI, npc_mimirons_inferno::npc_mimirons_infernoAI, npc_crypt_fiend::npc_crypt_fiendAI, violet_hold_trashAI, npc_thassarian::npc_thassarianAI, npc_banshee::npc_bansheeAI, npc_necromancer::npc_necromancerAI, npc_earthmender_wilda::npc_earthmender_wildaAI, npc_rocknot::npc_rocknotAI, npc_demolitionist_legoso::npc_demolitionist_legosoAI, npc_ghoul::npc_ghoulAI, npc_maxx_a_million_escort::npc_maxx_a_million_escortAI, npc_akuno::npc_akunoAI, npc_taretha::npc_tarethaAI, npc_lurgglbr::npc_lurgglbrAI, npc_bessy::npc_bessyAI, npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, npc_abomination::npc_abominationAI, npc_argent_soldier::npc_argent_soldierAI, npc_kurenai_captive::npc_kurenai_captiveAI, npc_highlord_darion_mograine::npc_highlord_darion_mograineAI, npc_arthas::npc_arthasAI, npc_giant_infernal::npc_giant_infernalAI, npc_isla_starmane::npc_isla_starmaneAI, npc_ranshalla::npc_ranshallaAI, npc_OOX17::npc_OOX17AI, npc_black_knight_skeletal_gryphon::npc_black_knight_skeletal_gryphonAI, npc_magwin::npc_magwinAI, npc_icefang::npc_icefangAI, npc_kayra_longmane::npc_kayra_longmaneAI, npc_brann_hos::npc_brann_hosAI, npc_kservant::npc_kservantAI, npc_thrall_old_hillsbrad::npc_thrall_old_hillsbradAI, npc_wounded_blood_elf::npc_wounded_blood_elfAI, npc_engineer_helice::npc_engineer_heliceAI, npc_koltira_deathweaver::npc_koltira_deathweaverAI, npc_onyx_flamecaller::npc_onyx_flamecallerAI, npc_muglash::npc_muglashAI, npc_lesser_doomguard::npc_lesser_doomguardAI, npc_blastmaster_emi_shortfuse::npc_blastmaster_emi_shortfuseAI, npc_skywing::npc_skywingAI, npc_morridune::npc_morriduneAI, generic_vehicleAI_toc5::generic_vehicleAI_toc5AI, npc_plaguehound_tracker::npc_plaguehound_trackerAI, npc_custodian_of_time::npc_custodian_of_timeAI, npc_grimstone::npc_grimstoneAI, npc_barnes::npc_barnesAI, npc_ancestral_wolf::npc_ancestral_wolfAI, npc_scarlet_trainee::npc_scarlet_traineeAI, npc_disciple_of_naralex::npc_disciple_of_naralexAI, hyjalAI, npc_maghar_captive::npc_maghar_captiveAI, npc_gilthares::npc_giltharesAI, npc_apothecary_hanes::npc_Apothecary_HanesAI, npc_shadowfang_prisoner::npc_shadowfang_prisonerAI, boss_azgalor::boss_azgalorAI, boss_anetheron::boss_anetheronAI, boss_kazrogal::boss_kazrogalAI, boss_rage_winterchill::boss_rage_winterchillAI, boss_ambassador_hellmaw::boss_ambassador_hellmawAI, npc_ruul_snowhoof::npc_ruul_snowhoofAI, npc_oox09hl::npc_oox09hlAI, npc_tapoke_slim_jahn::npc_tapoke_slim_jahnAI, npc_emily::npc_emilyAI, npc_professor_phizzlethorpe::npc_professor_phizzlethorpeAI, npc_deathstalker_erland::npc_deathstalker_erlandAI, npc_ranger_lilatha::npc_ranger_lilathaAI, npc_willix::npc_willixAI, and npc_injured_goblin::npc_injured_goblinAI.

Here is the caller graph for this function:

virtual void npc_escortAI::WaypointStart ( uint32 )

inlinevirtual

Reimplemented in npc_crok_scourgebane::npc_crok_scourgebaneAI, npc_wizzlecrank_shredder::npc_wizzlecrank_shredderAI, and npc_oox09hl::npc_oox09hlAI.

89 { }

Here is the caller graph for this function:

Member Data Documentation

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

private

bool npc_escortAI::DespawnAtEnd

private

bool npc_escortAI::DespawnAtFar

private

bool npc_escortAI::HasImmuneToNPCFlags

private

bool npc_escortAI::m_bCanInstantRespawn

private

bool npc_escortAI::m_bCanReturnToStart

private

bool npc_escortAI::m_bIsActiveAttacker

private

bool npc_escortAI::m_bIsRunning

private

Quest const* npc_escortAI::m_pQuestForEscort

private

uint32 npc_escortAI::m_uiEscortState

private

uint32 npc_escortAI::m_uiPlayerCheckTimer

private

ObjectGuid npc_escortAI::m_uiPlayerGUID

private

uint32 npc_escortAI::m_uiWPWaitTimer

private

float npc_escortAI::MaxPlayerDistance

private

bool npc_escortAI::ScriptWP

private

std::list<Escort_Waypoint> npc_escortAI::WaypointList

private

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation