NullCreatureAI Class Reference

#include "PassiveAI.h"

Inheritance diagram for NullCreatureAI:

Public Member Functions
	NullCreatureAI (Creature *c)
void	MoveInLineOfSight (Unit *) override
void	AttackStart (Unit *) override
void	JustStartedThreateningMe (Unit *) override
void	JustEnteredCombat (Unit *) override
	Called when the unit enters combat.
void	UpdateAI (uint32) override
	Use to start attacking a target. Called just before JustEngagedWith()
void	EnterEvadeMode (EvadeReason) override
void	OnCharmed (bool) override
	Called when unit is charmed.
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
bool	IsEngaged () const
	Check if creature is currently engaged in combat.
void	MoveCircleChecks ()
void	MoveBackwardsChecks ()
void	MoveInLineOfSight_Safe (Unit *who)
	== Reactions At =================================
void	TriggerAlert (Unit const *who) const
virtual bool	CanRespawn ()
virtual void	JustEngagedWith (Unit *)
	Called for reaction when initially engaged - this happens after JustEnteredCombat.
void	EngagementStart (Unit *who)
void	EngagementOver ()
void	JustExitedCombat () override
	Called when the unit leaves combat.
virtual void	JustDied (Unit *)
virtual void	KilledUnit (Unit *)
virtual void	JustSummoned (Creature *)
virtual void	IsSummonedBy (WorldObject *)
virtual void	SummonedCreatureDespawn (Creature *)
virtual void	SummonedCreatureDies (Creature *, Unit *)
virtual void	SummonedCreatureDespawnAll ()
virtual void	SummonedCreatureEvade (Creature *)
virtual void	SpellHit (Unit *, SpellInfo const *)
virtual void	SpellHitTarget (Unit *, SpellInfo const *)
virtual void	OnSpellStart (SpellInfo const *)
virtual void	OnSpellCast (SpellInfo const *)
virtual void	OnSpellFailed (SpellInfo const *)
virtual void	OnChannelFinished (SpellInfo const *)
virtual void	AttackedBy (Unit *)
virtual bool	IsEscorted ()
virtual void	JustRespawned ()
virtual void	MovementInform (uint32, uint32)
virtual void	PathEndReached (uint32)
virtual void	WaypointPathStarted (uint32)
	== Waypoints system =============================
virtual void	WaypointStarted (uint32, uint32)
virtual void	WaypointReached (uint32, uint32)
virtual void	WaypointPathEnded (uint32, uint32)
virtual void	JustReachedHome ()
void	DoZoneInCombat (Creature *creature=nullptr, float maxRangeToNearestTarget=250.0f)
virtual void	ReceiveEmote (Player *, uint32)
virtual void	OwnerAttackedBy (Unit *attacker)
virtual void	OwnerAttacked (Unit *target)
void	OnOwnerCombatInteraction (Unit *target)
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	Reset ()
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	EvadeTimerExpired ()
	Called when evade timer expires (target unreachable for too long)
virtual void	DamageDealt (Unit *, uint32 &, DamageEffectType, SpellSchoolMask)
	Called at any Damage to any victim (before damage apply)
virtual void	DamageTaken (Unit *, uint32 &, DamageEffectType, SpellSchoolMask)
	Called at any Damage from any attacker (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

Static Public Member Functions
static int32	Permissible (Creature const *creature)
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 ()

Additional Inherited Members
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 Attributes inherited from UnitAI
static AISpellInfoType *	AISpellInfo
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)
Protected Attributes inherited from CreatureAI
Creature *const	me
EventMap	events
TaskScheduler	scheduler
CreatureBoundary const *	_boundary
bool	_negateBoundary
bool	_isEngaged
Protected Attributes inherited from UnitAI
Unit *const	me

Detailed Description

Constructor & Destructor Documentation

NullCreatureAI()

NullCreatureAI::NullCreatureAI ( Creature *  c )

explicit

                                          : CreatureAI(c)
{
    me->SetReactState(REACT_PASSIVE);
    // TODO: Remove once WorldObject casting is ported (triggers won't create combat refs from spell casts)
    me->SetIsCombatDisallowed(true);
}

References CreatureAI::me, REACT_PASSIVE, Unit::SetIsCombatDisallowed(), and Creature::SetReactState().

Member Function Documentation

AttackStart()

void NullCreatureAI::AttackStart ( Unit *  )

inlineoverridevirtual

Reimplemented from UnitAI.

{}

EnterEvadeMode()

void NullCreatureAI::EnterEvadeMode ( EvadeReason  )

inlineoverridevirtual

Reimplemented from CreatureAI.

{}

JustEnteredCombat()

void NullCreatureAI::JustEnteredCombat ( Unit *  )

inlineoverridevirtual

Called when the unit enters combat.

Note

NOTE: Creature engage logic should NOT be here, but in JustEngagedWith, which happens once threat is established!)

Todo:

Never invoked right now. Preparation for Combat Threat refactor

Reimplemented from CreatureAI.

{}

JustStartedThreateningMe()

void NullCreatureAI::JustStartedThreateningMe ( Unit *  )

inlineoverridevirtual

Reimplemented from CreatureAI.

{}

MoveInLineOfSight()

void NullCreatureAI::MoveInLineOfSight ( Unit *  )

inlineoverridevirtual

Reimplemented from CreatureAI.

{}

OnCharmed()

void NullCreatureAI::OnCharmed ( bool  apply )

inlineoverridevirtual

Called when unit is charmed.

Reimplemented from CreatureAI.

{}

Permissible()

int32 NullCreatureAI::Permissible ( Creature const *  creature )

static

{
    if (creature->HasNpcFlag(UNIT_NPC_FLAG_SPELLCLICK))
        return PERMIT_BASE_PROACTIVE + 50;
 
    if (creature->IsTrigger())
        return PERMIT_BASE_PROACTIVE;
 
    return PERMIT_BASE_IDLE;
}

References Unit::HasNpcFlag(), Creature::IsTrigger(), PERMIT_BASE_IDLE, PERMIT_BASE_PROACTIVE, and UNIT_NPC_FLAG_SPELLCLICK.

UpdateAI()

void NullCreatureAI::UpdateAI ( uint32  )

inlineoverridevirtual

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

Implements UnitAI.

Reimplemented in trigger_periodic::trigger_periodicAI.

{}

---

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

• azerothcore-wotlk/src/server/game/AI/CoreAI/PassiveAI.h
• azerothcore-wotlk/src/server/game/AI/CoreAI/PassiveAI.cpp