EventProcessor.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2016 TrinityCore <http://www.trinitycore.org/>
 * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
 *
 * 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 __EVENTPROCESSOR_H
#define __EVENTPROCESSOR_H

#include "Define.h"

#include <map>

// Note. All times are in milliseconds here.

class TC_COMMON_API BasicEvent
{
 public:
 BasicEvent()
 {
 to_Abort = false;
 m_addTime = 0;
 m_execTime = 0;
 }
 virtual ~BasicEvent() { } // override destructor to perform some actions on event removal

 // this method executes when the event is triggered
 // return false if event does not want to be deleted
 // e_time is execution time, p_time is update interval
 virtual bool Execute(uint64 /*e_time*/, uint32 /*p_time*/) { return true; }

 virtual bool IsDeletable() const { return true; } // this event can be safely deleted

 virtual void Abort(uint64 /*e_time*/) { } // this method executes when the event is aborted

 bool to_Abort; // set by externals when the event is aborted, aborted events don't execute
 // and get Abort call when deleted

 // these can be used for time offset control
 uint64 m_addTime; // time when the event was added to queue, filled by event handler
 uint64 m_execTime; // planned time of next execution, filled by event handler
};

typedef std::multimap<uint64, BasicEvent*> EventList;

class TC_COMMON_API EventProcessor
{
 public:
 EventProcessor();
 ~EventProcessor();

 void Update(uint32 p_time);
 void KillAllEvents(bool force);
 void AddEvent(BasicEvent* Event, uint64 e_time, bool set_addtime = true);
 uint64 CalculateTime(uint64 t_offset) const;
 protected:
 uint64 m_time;
 EventList m_events;
 bool m_aborting;
};
#endif