#include <ScriptedFollowerAI.h>

Public Member Functions
	FollowerAI (Creature *creature)

	~FollowerAI ()

void	MovementInform (uint32 motionType, uint32 pointId) override

void	AttackStart (Unit *) override

void	MoveInLineOfSight (Unit *) override

void	EnterEvadeMode (EvadeReason=EVADE_REASON_OTHER) override

void	JustDied (Unit *) override

void	JustRespawned () override

void	UpdateAI (uint32) override

virtual void	UpdateFollowerAI (uint32)

void	StartFollow (Player player, uint32 factionForFollower=0, const Quest quest=NULL)

void	SetFollowPaused (bool bPaused)

void	SetFollowComplete (bool bWithEndEvent=false)

bool	HasFollowState (uint32 uiFollowState)

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 *)

virtual bool	IsEscorted () const

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 *	GetLeaderForFollower ()

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
void	AddFollowState (uint32 uiFollowState)

void	RemoveFollowState (uint32 uiFollowState)

bool	AssistPlayerInCombat (Unit *who)

Private Attributes
ObjectGuid	m_uiLeaderGUID

uint32	m_uiUpdateFollowTimer

uint32	m_uiFollowState

const Quest *	m_pQuestForFollow

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

FollowerAI::FollowerAI ( Creature * creature )

explicit

  : ScriptedAI(creature),
  m_uiUpdateFollowTimer(2500),
  m_uiFollowState(STATE_FOLLOW_NONE),
  m_pQuestForFollow(NULL)
 { }

FollowerAI::~FollowerAI ( )

inline

39 { }

Member Function Documentation

void FollowerAI::AddFollowState ( uint32 uiFollowState )

inlineprivate

69 { m_uiFollowState |= uiFollowState; }

FollowerAI::m_uiFollowState

uint32 m_uiFollowState

Definition: ScriptedFollowerAI.h:76

Here is the caller graph for this function:

bool FollowerAI::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, MAX_PLAYER_DISTANCE) && 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 FollowerAI::AttackStart ( Unit * who )

overridevirtual

Reimplemented from ScriptedAI.

 {
  if (!who)
  return;
 
  if (me->Attack(who, true))
  {
  me->AddThreat(who, 0.0f);
  me->SetInCombatWith(who);
  who->SetInCombatWith(me);
 
  if (me->HasUnitState(UNIT_STATE_FOLLOW))
  me->ClearUnitState(UNIT_STATE_FOLLOW);
 
  if (IsCombatMovementAllowed())
  me->GetMotionMaster()->MoveChase(who);
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void FollowerAI::EnterEvadeMode ( EvadeReason = EVADE_REASON_OTHER )

overridevirtual

Reimplemented from CreatureAI.

 {
  me->RemoveAllAuras();
  me->DeleteThreatList();
  me->CombatStop(true);
  me->SetLootRecipient(NULL);
 
  if (HasFollowState(STATE_FOLLOW_INPROGRESS))
  {
  TC_LOG_DEBUG("scripts", "FollowerAI left combat, returning to CombatStartPosition.");
 
  if (me->GetMotionMaster()->GetCurrentMovementGeneratorType() == CHASE_MOTION_TYPE)
  {
  float fPosX, fPosY, fPosZ;
  me->GetPosition(fPosX, fPosY, fPosZ);
  me->GetMotionMaster()->MovePoint(POINT_COMBAT_START, fPosX, fPosY, fPosZ);
  }
  }
  else
  {
  if (me->GetMotionMaster()->GetCurrentMovementGeneratorType() == CHASE_MOTION_TYPE)
  me->GetMotionMaster()->MoveTargetedHome();
  }
 
  Reset();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Player * FollowerAI::GetLeaderForFollower ( )

protected

 {
  if (Player* player = ObjectAccessor::GetPlayer(*me, m_uiLeaderGUID))
  {
  if (player->IsAlive())
  return player;
  else
  {
  if (Group* group = player->GetGroup())
  {
  for (GroupReference* groupRef = group->GetFirstMember(); groupRef != NULL; groupRef = groupRef->next())
  {
  Player* member = groupRef->GetSource();
 
  if (member && member->IsAlive() && me->IsWithinDistInMap(member, MAX_PLAYER_DISTANCE))
  {
  TC_LOG_DEBUG("scripts", "FollowerAI GetLeader changed and returned new leader.");
  m_uiLeaderGUID = member->GetGUID();
  return member;
  }
  }
  }
  }
  }
 
  TC_LOG_DEBUG("scripts", "FollowerAI GetLeader can not find suitable leader.");
  return NULL;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool FollowerAI::HasFollowState ( uint32 uiFollowState )

inline

63 { return (m_uiFollowState & uiFollowState) != 0; }

FollowerAI::m_uiFollowState

uint32 m_uiFollowState

Definition: ScriptedFollowerAI.h:76

Here is the caller graph for this function:

void FollowerAI::JustDied ( Unit * )

overridevirtual

Todo:: need a better check for quests with time limit.

Reimplemented from ScriptedAI.

 {
  if (!HasFollowState(STATE_FOLLOW_INPROGRESS) || !m_uiLeaderGUID || !m_pQuestForFollow)
  return;
 
  if (Player* player = GetLeaderForFollower())
  {
  if (Group* group = player->GetGroup())
  {
  for (GroupReference* groupRef = group->GetFirstMember(); groupRef != NULL; groupRef = groupRef->next())
  {
  if (Player* member = groupRef->GetSource())
  {
  if (member->GetQuestStatus(m_pQuestForFollow->GetQuestId()) == QUEST_STATUS_INCOMPLETE)
  member->FailQuest(m_pQuestForFollow->GetQuestId());
  }
  }
  }
  else
  {
  if (player->GetQuestStatus(m_pQuestForFollow->GetQuestId()) == QUEST_STATUS_INCOMPLETE)
  player->FailQuest(m_pQuestForFollow->GetQuestId());
  }
  }
 }

Here is the call graph for this function:

void FollowerAI::JustRespawned ( )

overridevirtual

Reimplemented from CreatureAI.

 {
  m_uiFollowState = STATE_FOLLOW_NONE;
 
  if (!IsCombatMovementAllowed())
  SetCombatMovement(true);
 
  if (me->getFaction() != me->GetCreatureTemplate()->faction)
  me->setFaction(me->GetCreatureTemplate()->faction);
 
  Reset();
 }

Here is the call graph for this function:

void FollowerAI::MoveInLineOfSight ( Unit * who )

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_beryl_sorcerer::npc_beryl_sorcererAI, npc_nexus_drake_hatchling::npc_nexus_drake_hatchlingAI, npc_tooga::npc_toogaAI, and npc_mist::npc_mistAI.

 {
  if (!me->HasUnitState(UNIT_STATE_STUNNED) && who->isTargetableForAttack() && who->isInAccessiblePlaceFor(me))
  {
  if (HasFollowState(STATE_FOLLOW_INPROGRESS) && 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 FollowerAI::MovementInform	(	uint32	motionType,
		uint32	pointId
	)

overridevirtual

Reimplemented from CreatureAI.

Reimplemented in npc_tooga::npc_toogaAI.

 {
  if (motionType != POINT_MOTION_TYPE || !HasFollowState(STATE_FOLLOW_INPROGRESS))
  return;
 
  if (pointId == POINT_COMBAT_START)
  {
  if (GetLeaderForFollower())
  {
  if (!HasFollowState(STATE_FOLLOW_PAUSED))
  AddFollowState(STATE_FOLLOW_RETURNING);
  }
  else
  me->DespawnOrUnsummon();
  }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void FollowerAI::RemoveFollowState ( uint32 uiFollowState )

inlineprivate

70 { m_uiFollowState &= ~uiFollowState; }

FollowerAI::m_uiFollowState

uint32 m_uiFollowState

Definition: ScriptedFollowerAI.h:76

Here is the caller graph for this function:

void FollowerAI::SetFollowComplete ( bool bWithEndEvent = false )

 {
  if (me->HasUnitState(UNIT_STATE_FOLLOW))
  {
  me->ClearUnitState(UNIT_STATE_FOLLOW);
 
  me->StopMoving();
  me->GetMotionMaster()->Clear();
  me->GetMotionMaster()->MoveIdle();
  }
 
  if (bWithEndEvent)
  AddFollowState(STATE_FOLLOW_POSTEVENT);
  else
  {
  if (HasFollowState(STATE_FOLLOW_POSTEVENT))
  RemoveFollowState(STATE_FOLLOW_POSTEVENT);
  }
 
  AddFollowState(STATE_FOLLOW_COMPLETE);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void FollowerAI::SetFollowPaused ( bool bPaused )

 {
  if (!HasFollowState(STATE_FOLLOW_INPROGRESS) || HasFollowState(STATE_FOLLOW_COMPLETE))
  return;
 
  if (paused)
  {
  AddFollowState(STATE_FOLLOW_PAUSED);
 
  if (me->HasUnitState(UNIT_STATE_FOLLOW))
  {
  me->ClearUnitState(UNIT_STATE_FOLLOW);
 
  me->StopMoving();
  me->GetMotionMaster()->Clear();
  me->GetMotionMaster()->MoveIdle();
  }
  }
  else
  {
  RemoveFollowState(STATE_FOLLOW_PAUSED);
 
  if (Player* leader = GetLeaderForFollower())
  me->GetMotionMaster()->MoveFollow(leader, PET_FOLLOW_DIST, PET_FOLLOW_ANGLE);
  }
 }

Here is the call graph for this function:

void FollowerAI::StartFollow	(	Player *	player,
		uint32	factionForFollower = `0`,
		const Quest *	quest = `NULL`
	)

 {
  if (me->GetVictim())
  {
  TC_LOG_DEBUG("scripts", "FollowerAI attempt to StartFollow while in combat.");
  return;
  }
 
  if (HasFollowState(STATE_FOLLOW_INPROGRESS))
  {
  TC_LOG_ERROR("scripts", "FollowerAI attempt to StartFollow while already following.");
  return;
  }
 
  //set variables
  m_uiLeaderGUID = player->GetGUID();
 
  if (factionForFollower)
  me->setFaction(factionForFollower);
 
  m_pQuestForFollow = quest;
 
  if (me->GetMotionMaster()->GetCurrentMovementGeneratorType() == WAYPOINT_MOTION_TYPE)
  {
  me->GetMotionMaster()->Clear();
  me->GetMotionMaster()->MoveIdle();
  TC_LOG_DEBUG("scripts", "FollowerAI start with WAYPOINT_MOTION_TYPE, set to MoveIdle.");
  }
 
  me->SetUInt64Value(UNIT_NPC_FLAGS, UNIT_NPC_FLAG_NONE);
 
  AddFollowState(STATE_FOLLOW_INPROGRESS);
 
  me->GetMotionMaster()->MoveFollow(player, PET_FOLLOW_DIST, PET_FOLLOW_ANGLE);
 
  TC_LOG_DEBUG("scripts", "FollowerAI start follow %s (%s)", player->GetName().c_str(), m_uiLeaderGUID.ToString().c_str());
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void FollowerAI::UpdateAI ( uint32 uiDiff )

overridevirtual

Reimplemented from ScriptedAI.

Reimplemented in npc_beryl_sorcerer::npc_beryl_sorcererAI, and npc_nexus_drake_hatchling::npc_nexus_drake_hatchlingAI.

 {
  if (HasFollowState(STATE_FOLLOW_INPROGRESS) && !me->GetVictim())
  {
  if (m_uiUpdateFollowTimer <= uiDiff)
  {
  if (HasFollowState(STATE_FOLLOW_COMPLETE) && !HasFollowState(STATE_FOLLOW_POSTEVENT))
  {
  TC_LOG_DEBUG("scripts", "FollowerAI is set completed, despawns.");
  me->DespawnOrUnsummon();
  return;
  }
 
  bool bIsMaxRangeExceeded = true;
 
  if (Player* player = GetLeaderForFollower())
  {
  if (HasFollowState(STATE_FOLLOW_RETURNING))
  {
  TC_LOG_DEBUG("scripts", "FollowerAI is returning to leader.");
 
  RemoveFollowState(STATE_FOLLOW_RETURNING);
  me->GetMotionMaster()->MoveFollow(player, PET_FOLLOW_DIST, PET_FOLLOW_ANGLE);
  return;
  }
 
  if (Group* group = player->GetGroup())
  {
  for (GroupReference* groupRef = group->GetFirstMember(); groupRef != NULL; groupRef = groupRef->next())
  {
  Player* member = groupRef->GetSource();
 
  if (member && me->IsWithinDistInMap(member, MAX_PLAYER_DISTANCE))
  {
  bIsMaxRangeExceeded = false;
  break;
  }
  }
  }
  else
  {
  if (me->IsWithinDistInMap(player, MAX_PLAYER_DISTANCE))
  bIsMaxRangeExceeded = false;
  }
  }
 
  if (bIsMaxRangeExceeded)
  {
  TC_LOG_DEBUG("scripts", "FollowerAI failed because player/group was to far away or not found");
  me->DespawnOrUnsummon();
  return;
  }
 
  m_uiUpdateFollowTimer = 1000;
  }
  else
  m_uiUpdateFollowTimer -= uiDiff;
  }
 
  UpdateFollowerAI(uiDiff);
 }

Here is the call graph for this function:

void FollowerAI::UpdateFollowerAI ( uint32 )

virtual

Reimplemented in npc_tooga::npc_toogaAI.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const Quest* FollowerAI::m_pQuestForFollow

private

uint32 FollowerAI::m_uiFollowState

private

ObjectGuid FollowerAI::m_uiLeaderGUID

private

uint32 FollowerAI::m_uiUpdateFollowTimer

private

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation