#include "CombatAI.h"

Inheritance diagram for VehicleAI:

Public Member Functions
	VehicleAI (Creature *creature)

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

void	MoveInLineOfSight (Unit *) override

void	AttackStart (Unit *) override

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

Public Member Functions inherited from CreatureAI
void	Talk (uint8 id, WorldObject const *whisperTarget=nullptr, Milliseconds delay=0s)
	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	EnterEvadeMode (EvadeReason why=EVADE_REASON_OTHER)

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

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	AttackedBy (Unit *)

virtual bool	IsEscorted ()

virtual void	JustRespawned ()

virtual void	MovementInform (uint32, uint32)

virtual void	PathEndReached (uint32)

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

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)

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, 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	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 ()

Private Member Functions
void	LoadConditions ()

void	CheckConditions (uint32 diff)

Private Attributes
ConditionList	conditions

uint32	m_ConditionsTimer

bool	m_DoDismiss

uint32	m_DismissTimer

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

Protected Attributes inherited from UnitAI
Unit *const	me

Detailed Description

Constructor & Destructor Documentation

◆ VehicleAI()

VehicleAI::VehicleAI ( Creature * creature )

explicit

                                : CreatureAI(c), m_ConditionsTimer(VEHICLE_CONDITION_CHECK_TIME)
{
    LoadConditions();
    m_DoDismiss = false;
    m_DismissTimer = VEHICLE_DISMISS_TIME;
}

References LoadConditions(), m_DismissTimer, m_DoDismiss, and VEHICLE_DISMISS_TIME.

Member Function Documentation

◆ AttackStart()

void VehicleAI::AttackStart ( Unit * )

inlineoverridevirtual

Reimplemented from UnitAI.

105{}

◆ CheckConditions()

void VehicleAI::CheckConditions ( uint32 diff )

private

{
    if (m_ConditionsTimer < diff)
    {
        if (!conditions.empty())
        {
            if (Vehicle* vehicleKit = me->GetVehicleKit())
                for (SeatMap::iterator itr = vehicleKit->Seats.begin(); itr != vehicleKit->Seats.end(); ++itr)
                    if (Unit* passenger = ObjectAccessor::GetUnit(*me, itr->second.Passenger.Guid))
                    {
                        if (Player* player = passenger->ToPlayer())
                        {
                            if (!sConditionMgr->IsObjectMeetToConditions(player, me, conditions))
                            {
                                player->ExitVehicle();
                                return; // check other pessanger in next tick
                            }
                        }
                    }
        }
        m_ConditionsTimer = VEHICLE_CONDITION_CHECK_TIME;
    }
    else
        m_ConditionsTimer -= diff;
}

References conditions, ObjectAccessor::GetUnit(), Unit::GetVehicleKit(), m_ConditionsTimer, CreatureAI::me, sConditionMgr, Object::ToPlayer(), and VEHICLE_CONDITION_CHECK_TIME.

Referenced by UpdateAI().

◆ LoadConditions()

void VehicleAI::LoadConditions ( )

private

{
    conditions = sConditionMgr->GetConditionsForNotGroupedEntry(CONDITION_SOURCE_TYPE_CREATURE_TEMPLATE_VEHICLE, me->GetEntry());
    if (!conditions.empty())
        LOG_DEBUG("condition", "VehicleAI::LoadConditions: loaded {} conditions", uint32(conditions.size()));
}

References CONDITION_SOURCE_TYPE_CREATURE_TEMPLATE_VEHICLE, conditions, Object::GetEntry(), LOG_DEBUG, CreatureAI::me, and sConditionMgr.

Referenced by VehicleAI().

◆ MoveInLineOfSight()

void VehicleAI::MoveInLineOfSight ( Unit * )

inlineoverridevirtual

Reimplemented from CreatureAI.

104{}

◆ OnCharmed()

void VehicleAI::OnCharmed ( bool apply )

overridevirtual

Called when unit is charmed.

Reimplemented from CreatureAI.

{
    if (!me->GetVehicleKit()->IsVehicleInUse() && !apply && !conditions.empty()) // was used and has conditions
        m_DoDismiss = true; // needs reset
    else if (apply)
        m_DoDismiss = false; // in use again
 
    m_DismissTimer = VEHICLE_DISMISS_TIME;//reset timer
}

References conditions, Unit::GetVehicleKit(), Vehicle::IsVehicleInUse(), m_DismissTimer, m_DoDismiss, CreatureAI::me, and VEHICLE_DISMISS_TIME.

◆ Permissible()

int32 VehicleAI::Permissible ( Creature const * creature )

static

{
    if (creature->IsVehicle())
        return PERMIT_BASE_SPECIAL;
 
    return PERMIT_BASE_NO;
}

References Unit::IsVehicle(), PERMIT_BASE_NO, and PERMIT_BASE_SPECIAL.

◆ UpdateAI()

void VehicleAI::UpdateAI ( uint32 )

overridevirtual

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

Implements UnitAI.

{
    CheckConditions(diff);
 
    if (m_DoDismiss)
    {
        if (m_DismissTimer < diff)
        {
            m_DoDismiss = false;
            me->DespawnOrUnsummon();
        }
        else
            m_DismissTimer -= diff;
    }
}

References CheckConditions(), Creature::DespawnOrUnsummon(), m_DismissTimer, m_DoDismiss, and CreatureAI::me.

Referenced by npc_scarlet_cannon::npc_scarlet_cannonAI::UpdateAI(), npc_isle_of_conquest_turret::npc_isle_of_conquest_turretAI::UpdateAI(), npc_oculus_drake::npc_oculus_drakeAI::UpdateAI(), boss_flame_leviathan_seat::boss_flame_leviathan_seatAI::UpdateAI(), npc_frostbrood_skytalon::npc_frostbrood_skytalonAI::UpdateAI(), and npc_wg_siege_machine::npc_wg_siege_machineAI::UpdateAI().

Member Data Documentation

◆ conditions

ConditionList VehicleAI::conditions

private

Referenced by CheckConditions(), LoadConditions(), and OnCharmed().

◆ m_ConditionsTimer

uint32 VehicleAI::m_ConditionsTimer

private

Referenced by CheckConditions().

◆ m_DismissTimer

uint32 VehicleAI::m_DismissTimer

private

Referenced by OnCharmed(), UpdateAI(), and VehicleAI().

◆ m_DoDismiss

bool VehicleAI::m_DoDismiss

private

Referenced by OnCharmed(), UpdateAI(), and VehicleAI().

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VehicleAI()

Member Function Documentation

◆ AttackStart()

◆ CheckConditions()

◆ LoadConditions()

◆ MoveInLineOfSight()

◆ OnCharmed()

◆ Permissible()

◆ UpdateAI()

Member Data Documentation

◆ conditions

◆ m_ConditionsTimer

◆ m_DismissTimer

◆ m_DoDismiss