UnitAI.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef SKYFIRE_UNITAI_H
#define SKYFIRE_UNITAI_H
 
#include "Containers.h"
#include "Define.h"
#include "UnaryFunction.h"
#include "Unit.h"
#include <list>
 
class Player;
class Quest;
class Unit;
struct AISpellInfoType;
 
//Selection method used by SelectTarget
enum SelectAggroTarget
{
    SELECT_TARGET_RANDOM = 0,                               //Just selects a random target
    SELECT_TARGET_TOPAGGRO,                                 //Selects targes from top aggro to bottom
    SELECT_TARGET_BOTTOMAGGRO,                              //Selects targets from bottom aggro to top
    SELECT_TARGET_NEAREST,
    SELECT_TARGET_FARTHEST
};
 
// default predicate function to select target based on distance, player and/or aura criteria
struct DefaultTargetSelector : public SF_UNARY_FUNCTION<Unit*, bool>
{
    const Unit* me;
    float m_dist;
    bool m_playerOnly;
    int32 m_aura;
 
    // unit: the reference unit
    // dist: if 0: ignored, if > 0: maximum distance to the reference unit, if < 0: minimum distance to the reference unit
    // playerOnly: self explaining
    // aura: if 0: ignored, if > 0: the target shall have the aura, if < 0, the target shall NOT have the aura
    DefaultTargetSelector(Unit const* unit, float dist, bool playerOnly, int32 aura) : me(unit), m_dist(dist), m_playerOnly(playerOnly), m_aura(aura) { }
 
    bool operator()(Unit const* target) const
    {
        if (!me)
            return false;
 
        if (!target)
            return false;
 
        if (m_playerOnly && (target->GetTypeId() != TypeID::TYPEID_PLAYER))
            return false;
 
        if (m_dist > 0.0f && !me->IsWithinCombatRange(target, m_dist))
            return false;
 
        if (m_dist < 0.0f && me->IsWithinCombatRange(target, -m_dist))
            return false;
 
        if (m_aura)
        {
            if (m_aura > 0)
            {
                if (!target->HasAura(m_aura))
                    return false;
            }
            else
            {
                if (target->HasAura(-m_aura))
                    return false;
            }
        }
 
        return true;
    }
};
 
// Target selector for spell casts checking range, auras and attributes
struct SpellTargetSelector : public SF_UNARY_FUNCTION<Unit*, bool>
{
public:
    SpellTargetSelector(Unit* caster, uint32 spellId);
    bool operator()(Unit const* target) const;
 
private:
    Unit const* _caster;
    SpellInfo const* _spellInfo;
};
 
// Very simple target selector, will just skip main target
// NOTE: When passing to UnitAI::SelectTarget remember to use 0 as position for random selection
//       because tank will not be in the temporary list
struct NonTankTargetSelector : public SF_UNARY_FUNCTION<Unit*, bool>
{
public:
    NonTankTargetSelector(Creature* source, bool playerOnly = true) : _source(source), _playerOnly(playerOnly) { }
    bool operator()(Unit const* target) const;
 
private:
    Creature const* _source;
    bool _playerOnly;
};
 
class UnitAI
{
protected:
    Unit* const me;
public:
    explicit UnitAI(Unit* unit) : me(unit) { }
    virtual ~UnitAI() { }
 
    virtual bool CanAIAttack(Unit const* /*target*/) const { return true; }
    virtual void AttackStart(Unit* /*target*/);
    virtual void UpdateAI(uint32 diff) = 0;
 
    virtual void InitializeAI() { if (!me->isDead()) Reset(); }
 
    virtual void Reset() { };
 
    // Called when unit is charmed
    virtual void OnCharmed(bool apply) = 0;
 
    // Pass parameters between AI
    virtual void DoAction(int32 /*param*/) { }
    virtual uint32 GetData(uint32 /*id = 0*/) const { return 0; }
    virtual void SetData(uint32 /*id*/, uint32 /*value*/) { }
    virtual void SetGUID(uint64 /*guid*/, int32 /*id*/ = 0) { }
    virtual uint64 GetGUID(int32 /*id*/ = 0) const { return 0; }
 
    Unit* SelectTarget(SelectAggroTarget targetType, uint32 position = 0, float dist = 0.0f, bool playerOnly = false, int32 aura = 0);
    // Select the targets satifying the predicate.
    // predicate shall extend std::unary_function<Unit*, bool>
    template <class PREDICATE> Unit* SelectTarget(SelectAggroTarget targetType, uint32 position, PREDICATE const& predicate)
    {
        ThreatContainer::StorageType const& threatlist = me->getThreatManager().getThreatList();
        if (position >= threatlist.size())
            return NULL;
 
        std::list<Unit*> targetList;
        for (ThreatContainer::StorageType::const_iterator itr = threatlist.begin(); itr != threatlist.end(); ++itr)
            if (predicate((*itr)->getTarget()))
                targetList.push_back((*itr)->getTarget());
 
        if (position >= targetList.size())
            return NULL;
 
        if (targetType == SELECT_TARGET_NEAREST || targetType == SELECT_TARGET_FARTHEST)
            targetList.sort(Skyfire::ObjectDistanceOrderPred(me));
 
        switch (targetType)
        {
            case SELECT_TARGET_NEAREST:
            case SELECT_TARGET_TOPAGGRO:
            {
                std::list<Unit*>::iterator itr = targetList.begin();
                std::advance(itr, position);
                return *itr;
            }
            case SELECT_TARGET_FARTHEST:
            case SELECT_TARGET_BOTTOMAGGRO:
            {
                std::list<Unit*>::reverse_iterator ritr = targetList.rbegin();
                std::advance(ritr, position);
                return *ritr;
            }
            case SELECT_TARGET_RANDOM:
            {
                std::list<Unit*>::iterator itr = targetList.begin();
                std::advance(itr, (std::rand() % targetList.size()) + position);
                return *itr;
            }
            default:
                break;
        }
 
        return NULL;
    }
 
    void SelectTargetList(std::list<Unit*>& targetList, uint32 num, SelectAggroTarget targetType, float dist = 0.0f, bool playerOnly = false, int32 aura = 0);
 
    // Select the targets satifying the predicate.
    // predicate shall extend std::unary_function<Unit*, bool>
    template <class PREDICATE> void SelectTargetList(std::list<Unit*>& targetList, PREDICATE const& predicate, uint32 maxTargets, SelectAggroTarget targetType)
    {
        ThreatContainer::StorageType const& threatlist = me->getThreatManager().getThreatList();
        if (threatlist.empty())
            return;
 
        for (ThreatContainer::StorageType::const_iterator itr = threatlist.begin(); itr != threatlist.end(); ++itr)
            if (predicate((*itr)->getTarget()))
                targetList.push_back((*itr)->getTarget());
 
        if (targetList.size() < maxTargets)
            return;
 
        if (targetType == SELECT_TARGET_NEAREST || targetType == SELECT_TARGET_FARTHEST)
            targetList.sort(Skyfire::ObjectDistanceOrderPred(me));
 
        if (targetType == SELECT_TARGET_FARTHEST || targetType == SELECT_TARGET_BOTTOMAGGRO)
            targetList.reverse();
 
        if (targetType == SELECT_TARGET_RANDOM)
            Skyfire::Containers::RandomResizeList(targetList, maxTargets);
        else
            targetList.resize(maxTargets);
    }
 
    // Called at any Damage to any victim (before damage apply)
    virtual void DamageDealt(Unit* /*victim*/, uint32& /*damage*/, DamageEffectType /*damageType*/) { }
 
    // Called at any Damage from any attacker (before damage apply)
    // Note: it for recalculation damage or special reaction at damage
    // for attack reaction use AttackedBy called for not DOT damage in Unit::DealDamage also
    virtual void DamageTaken(Unit* /*attacker*/, uint32& /*damage*/) { }
 
    // Called when the creature receives heal
    virtual void HealReceived(Unit* /*done_by*/, uint32& /*addhealth*/) { }
 
    // Called when the unit heals
    virtual void HealDone(Unit* /*done_to*/, uint32& /*addhealth*/) { }

    virtual void SpellInterrupted(uint32 /*spellId*/, uint32 /*unTimeMs*/) { }
 
    void AttackStartCaster(Unit* victim, float dist);
 
    void DoAddAuraToAllHostilePlayers(uint32 spellid);
    void DoCast(uint32 spellId);
    void DoCast(Unit* victim, uint32 spellId, bool triggered = false);
    void DoCastToAllHostilePlayers(uint32 spellid, bool triggered = false);
    void DoCastVictim(uint32 spellId, bool triggered = false);
    void DoCastAOE(uint32 spellId, bool triggered = false);
 
    float DoGetSpellMaxRange(uint32 spellId, bool positive = false);
 
    void DoMeleeAttackIfReady();
    bool DoSpellAttackIfReady(uint32 spell);
 
    static AISpellInfoType* AISpellInfo;
    static void FillAISpellInfo();
 
    virtual bool OnGossipHello(Player* player) { sGossipHello(player); return false; }
    virtual void sGossipHello(Player* /*player*/) { }
    virtual void sGossipSelect(Player* /*player*/, uint32 /*sender*/, uint32 /*action*/) { }
    virtual void sGossipSelectCode(Player* /*player*/, uint32 /*sender*/, uint32 /*action*/, char const* /*code*/) { }
    virtual void sQuestAccept(Player* /*player*/, Quest const* /*quest*/) { }
    virtual void sQuestSelect(Player* /*player*/, Quest const* /*quest*/) { }
    virtual void sQuestComplete(Player* /*player*/, Quest const* /*quest*/) { }
    virtual void sQuestReward(Player* /*player*/, Quest const* /*quest*/, uint32 /*opt*/) { }
    virtual bool sOnDummyEffect(Unit* /*caster*/, uint32 /*spellId*/, SpellEffIndex /*effIndex*/) { return false; }
    virtual void sOnGameEvent(bool /*start*/, uint16 /*eventId*/) { }
private:
    UnitAI(UnitAI const& right) = delete;
    UnitAI& operator=(UnitAI const& right) = delete;
};
 
class PlayerAI : public UnitAI
{
protected:
    Player* const me;
public:
    explicit PlayerAI(Player* player) : UnitAI((Unit*)player), me(player) { }
 
    void OnCharmed(bool apply) OVERRIDE;
};
 
class SimpleCharmedAI : public PlayerAI
{
public:
    void UpdateAI(uint32 diff) OVERRIDE;
    SimpleCharmedAI(Player* player) : PlayerAI(player) { }
};
 
#endif