EventMap.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 TRINITYCORE_EVENT_MAP_H
#define TRINITYCORE_EVENT_MAP_H
 
#include "Define.h"
#include "Duration.h"
#include <compare>
#include <map>
#include <vector>
 
class TC_COMMON_API EventMap
{
    using EventId = uint16;
    using GroupIndex = uint8;
    using GroupMask = uint8;
    using PhaseIndex = uint8;
    using PhaseMask = uint8;
    struct Event
    {
        Event() = default;
        Event(EventId id, GroupIndex groupIndex, PhaseIndex phaseIndex) :
            _id(id),
            _groupMask(groupIndex ? GroupMask(1u << (groupIndex - 1u)) : 0u),
            _phaseMask(phaseIndex ? PhaseMask(1u << (phaseIndex - 1u)) : 0u)
        {
        }
 
        EventId _id          = 0u;
        GroupMask _groupMask = 0u;
        PhaseMask _phaseMask = 0u;
 
        std::strong_ordering operator<=>(Event const& right) const = default;
    };
 
    using EventStore = std::multimap<TimePoint, Event>;
    using EventSeriesStore = std::map<Event, std::vector<Milliseconds>>;
 
public:
    EventMap() : _time(TimePoint::min()), _phaseMask(0) { }
    EventMap(EventMap const& other);
    EventMap(EventMap&& other) noexcept = default;
    EventMap& operator=(EventMap const& other);
    EventMap& operator=(EventMap&& other) noexcept = default;
    ~EventMap();
 
    void Reset();
 
    void Update(uint32 time)
    {
        Update(Milliseconds(time));
    }
 
    void Update(Milliseconds time)
    {
        _time += time;
    }
 
    PhaseMask GetPhaseMask() const
    {
        return _phaseMask;
    }
 
    bool Empty() const
    {
        return _eventMap.empty();
    }
 
    void SetPhase(PhaseIndex phase);
 
    void AddPhase(PhaseIndex phase)
    {
        if (phase && phase <= sizeof(PhaseMask) * 8)
            _phaseMask |= PhaseMask(1u << (phase - 1u));
    }
 
    void RemovePhase(PhaseIndex phase)
    {
        if (phase && phase <= sizeof(PhaseMask) * 8)
            _phaseMask &= PhaseMask(~(1u << (phase - 1u)));
    }
 
    void ScheduleEvent(EventId eventId, Milliseconds time, GroupIndex group = 0u, PhaseIndex phase = 0u);
 
    void ScheduleEvent(EventId eventId, Milliseconds minTime, Milliseconds maxTime, GroupIndex group = 0u, PhaseIndex phase = 0u);
 
    void RescheduleEvent(EventId eventId, Milliseconds time, GroupIndex group = 0u, PhaseIndex phase = 0u);
 
    void RescheduleEvent(EventId eventId, Milliseconds minTime, Milliseconds maxTime, GroupIndex group = 0u, PhaseIndex phase = 0u);
 
    void Repeat(Milliseconds time);
 
    void Repeat(Milliseconds minTime, Milliseconds maxTime);
 
    EventId ExecuteEvent();
 
    void DelayEvents(Milliseconds delay);
 
    void DelayEvents(Milliseconds delay, GroupIndex group);
 
    void SetMinimalDelay(EventId eventId, Milliseconds delay);
 
    void CancelEvent(EventId eventId);
 
    void CancelEventGroup(GroupIndex group);
 
    bool IsInPhase(PhaseIndex phase) const
    {
        return phase <= sizeof(PhaseIndex) * 8 && (!phase || _phaseMask & PhaseMask(1u << (phase - 1u)));
    }
 
    Milliseconds GetTimeUntilEvent(EventId eventId) const;
 
    bool HasEventScheduled(EventId eventId) const;
 
    void ScheduleNextFromSeries(Event eventData);
 
    void ScheduleEventSeries(EventId eventId, GroupIndex group, PhaseIndex phase, std::initializer_list<Milliseconds> timeSeries);
 
    void ScheduleEventSeries(EventId eventId, std::initializer_list<Milliseconds> timeSeries);
 
private:
    TimePoint _time;
 
    PhaseMask _phaseMask;
 
    EventStore _eventMap;
 
    Event _lastEvent;
 
    EventSeriesStore _timerSeries;
};
 
#endif // TRINITYCORE_EVENT_MAP_H