AreaTriggerAI.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef TRINITY_AREATRIGGERAI_H
#define TRINITY_AREATRIGGERAI_H
 
#include "Define.h"
#include "ObjectGuid.h"
 
class AreaTrigger;
class Spell;
class Unit;
enum class AreaTriggerExitReason : uint8;
 
class TC_GAME_API AreaTriggerAI
{
        uint32 _scriptId;
 
    protected:
        AreaTrigger* const at;
    public:
        explicit AreaTriggerAI(AreaTrigger* a, uint32 scriptId = {}) noexcept;
        AreaTriggerAI(AreaTriggerAI const&) = delete;
        AreaTriggerAI(AreaTriggerAI&&) = delete;
        AreaTriggerAI& operator=(AreaTriggerAI const&) = delete;
        AreaTriggerAI& operator=(AreaTriggerAI&&) = delete;
        virtual ~AreaTriggerAI();
 
        // Called when the AreaTrigger has just been initialized, just before added to map
        virtual void OnInitialize() { }
 
        // Called when the AreaTrigger has just been created
        virtual void OnCreate([[maybe_unused]] Spell const* creatingSpell) { }
 
        // Called on each AreaTrigger update
        virtual void OnUpdate([[maybe_unused]] uint32 diff) { }
 
        // Called when the AreaTrigger reach splineIndex
        virtual void OnSplineIndexReached([[maybe_unused]] int32 splineIndex) { }
 
        // Called when the AreaTrigger reach its destination
        virtual void OnDestinationReached() { }
 
        // Called when an unit enter the AreaTrigger
        virtual void OnUnitEnter([[maybe_unused]] Unit* unit) { }
 
        // Called when an unit exit the AreaTrigger, or when the AreaTrigger is removed
        virtual void OnUnitExit([[maybe_unused]] Unit* unit, [[maybe_unused]] AreaTriggerExitReason reason) { }
 
        // Called when the AreaTrigger is removed
        virtual void OnRemove() { }
 
        // Pass parameters between AI
        virtual void DoAction([[maybe_unused]] int32 param) { }
        virtual uint32 GetData([[maybe_unused]] uint32 id) const { return 0; }
        virtual void SetData([[maybe_unused]] uint32 id, [[maybe_unused]] uint32 value) { }
        virtual void SetGUID([[maybe_unused]] ObjectGuid const& guid, [[maybe_unused]] int32 id) { }
        virtual ObjectGuid GetGUID([[maybe_unused]] int32 id) const { return ObjectGuid::Empty; }
 
        // Gets the id of the AI (script id)
        uint32 GetId() const { return _scriptId; }
};
 
class NullAreaTriggerAI : public AreaTriggerAI
{
    public:
        using AreaTriggerAI::AreaTriggerAI;
};
 
#endif