aboutsummaryrefslogtreecommitdiff
path: root/src/common/Utilities/EventMap.h
diff options
context:
space:
mode:
authorPeter Keresztes Schmidt <carbenium@outlook.com>2020-07-15 10:05:11 +0200
committerGitHub <noreply@github.com>2020-07-15 10:05:11 +0200
commitce1e2c0f9b4f80e1fa5c448ee12fec43204a3634 (patch)
tree6a77fa8a2b636c42d32a627bac604237af9b75eb /src/common/Utilities/EventMap.h
parent9fe6756cf26e916d69673879c31e09ee57ef6470 (diff)
Core/Util: Remove EventMap's non-std::chrono::duration based interface (#25049)
Closes #25012
Diffstat (limited to 'src/common/Utilities/EventMap.h')
-rw-r--r--src/common/Utilities/EventMap.h116
1 files changed, 19 insertions, 97 deletions
diff --git a/src/common/Utilities/EventMap.h b/src/common/Utilities/EventMap.h
index 65e4a4424fb..e2ccac945df 100644
--- a/src/common/Utilities/EventMap.h
+++ b/src/common/Utilities/EventMap.h
@@ -58,7 +58,7 @@ public:
/**
* @name GetTimer
- * @return Current timer in ms value.
+ * @return Current timer value in ms.
*/
uint32 GetTimer() const
{
@@ -114,20 +114,17 @@ public:
/**
* @name ScheduleEvent
- * @brief Creates new event entry in map.
+ * @brief Schedules a new event.
* @param eventId The id of the new event.
* @param time The time until the event occurs as std::chrono type.
* @param group The group which the event is associated to. Has to be between 1 and 8. 0 means it has no group.
* @param phase The phase in which the event can occur. Has to be between 1 and 8. 0 means it can occur in all phases.
*/
- void ScheduleEvent(uint32 eventId, Milliseconds time, uint32 group = 0, uint8 phase = 0)
- {
- ScheduleEvent(eventId, uint32(time.count()), group, phase);
- }
+ void ScheduleEvent(uint32 eventId, Milliseconds time, uint32 group = 0, uint8 phase = 0);
/**
* @name ScheduleEvent
- * @brief Creates new event entry in map.
+ * @brief Schedules a new event.
* @param eventId The id of the new event.
* @param minTime The minimum time until the event occurs as std::chrono type.
* @param maxTime The maximum time until the event occurs as std::chrono type.
@@ -137,16 +134,6 @@ public:
void ScheduleEvent(uint32 eventId, Milliseconds minTime, Milliseconds maxTime, uint32 group = 0, uint32 phase = 0);
/**
- * @name ScheduleEvent
- * @brief Creates new event entry in map.
- * @param eventId The id of the new event.
- * @param time The time in milliseconds until the event occurs.
- * @param group The group which the event is associated to. Has to be between 1 and 8. 0 means it has no group.
- * @param phase The phase in which the event can occur. Has to be between 1 and 8. 0 means it can occur in all phases.
- */
- void ScheduleEvent(uint32 eventId, uint32 time, uint32 group = 0, uint8 phase = 0);
-
- /**
* @name RescheduleEvent
* @brief Cancels the given event and reschedules it.
* @param eventId The id of the event.
@@ -154,10 +141,7 @@ public:
* @param group The group which the event is associated to. Has to be between 1 and 8. 0 means it has no group.
* @param phase The phase in which the event can occur. Has to be between 1 and 8. 0 means it can occur in all phases.
*/
- void RescheduleEvent(uint32 eventId, Milliseconds time, uint32 group = 0, uint8 phase = 0)
- {
- RescheduleEvent(eventId, uint32(time.count()), group, phase);
- }
+ void RescheduleEvent(uint32 eventId, Milliseconds time, uint32 group = 0, uint8 phase = 0);
/**
* @name RescheduleEvent
@@ -171,103 +155,41 @@ public:
void RescheduleEvent(uint32 eventId, Milliseconds minTime, Milliseconds maxTime, uint32 group = 0, uint32 phase = 0);
/**
- * @name RescheduleEvent
- * @brief Cancels the given event and reschedules it.
- * @param eventId The id of the event.
- * @param time The time in milliseconds until the event occurs.
- * @param group The group which the event is associated to. Has to be between 1 and 8. 0 means it has no group.
- * @param phase The phase in which the event can occur. Has to be between 1 and 8. 0 means it can occur in all phases.
- */
- void RescheduleEvent(uint32 eventId, uint32 time, uint32 group = 0, uint8 phase = 0)
- {
- CancelEvent(eventId);
- ScheduleEvent(eventId, time, group, phase);
- }
-
- /**
* @name RepeatEvent
- * @brief Repeats the mostly recently executed event.
- * @param time Time until in milliseconds as std::chrono::duration the event occurs.
+ * @brief Repeats the most recently executed event.
+ * @param time Time until the event occurs as std::chrono type.
*/
- void Repeat(Milliseconds time)
- {
- Repeat(uint32(time.count()));
- }
+ void Repeat(Milliseconds time);
/**
* @name RepeatEvent
- * @brief Repeats the mostly recently executed event.
- * @param time Time until the event occurs.
- */
- void Repeat(uint32 time)
- {
- _eventMap.insert(EventStore::value_type(_time + time, _lastEvent));
- }
-
- /**
- * @name RepeatEvent
- * @brief Repeats the mostly recently executed event.
- * @param minTime Minimum time as std::chrono::duration until the event occurs.
- * @param maxTime Maximum time as std::chrono::duration until the event occurs.
- */
- void Repeat(Milliseconds minTime, Milliseconds maxTime)
- {
- Repeat(uint32(minTime.count()), uint32(maxTime.count()));
- }
-
- /**
- * @name RepeatEvent
- * @brief Repeats the mostly recently executed event, Equivalent to Repeat(urand(minTime, maxTime).
- * @param minTime Minimum time until the event occurs.
- * @param maxTime Maximum time until the event occurs.
+ * @brief Repeats the most recently executed event.
+ * @param minTime The minimum time until the event occurs as std::chrono type.
+ * @param maxTime The maximum time until the event occurs as std::chrono type.
*/
- void Repeat(uint32 minTime, uint32 maxTime);
+ void Repeat(Milliseconds minTime, Milliseconds maxTime);
/**
* @name ExecuteEvent
- * @brief Returns the next event to execute and removes it from map.
+ * @brief Returns the next event to be executed and removes it from map.
* @return Id of the event to execute.
*/
uint32 ExecuteEvent();
/**
* @name DelayEvents
- * @brief Delays all events in the map. If delay is greater than or equal internal timer, delay will be 0.
- * @param delay Amount of delay in ms as std::chrono::duration.
- */
- void DelayEvents(Milliseconds delay)
- {
- DelayEvents(uint32(delay.count()));
- }
-
- /**
- * @name DelayEvents
- * @brief Delays all events in the map. If delay is greater than or equal internal timer, delay will be equal to internal timer.
- * @param delay Amount of delay.
+ * @brief Delays all events. If delay is greater than or equal internal timer, delay will be 0.
+ * @param delay Amount of delay as std::chrono type.
*/
- void DelayEvents(uint32 delay)
- {
- _time = delay < _time ? _time - delay : 0;
- }
-
- /**
- * @name DelayEvents
- * @brief Delay all events of the same group.
- * @param delay Amount of delay in ms as std::chrono::duration.
- * @param group Group of the events.
- */
- void DelayEvents(Milliseconds delay, uint32 group)
- {
- DelayEvents(uint32(delay.count()), group);
- }
+ void DelayEvents(Milliseconds delay);
/**
* @name DelayEvents
* @brief Delay all events of the same group.
- * @param delay Amount of delay.
+ * @param delay Amount of delay as std::chrono type.
* @param group Group of the events.
*/
- void DelayEvents(uint32 delay, uint32 group);
+ void DelayEvents(Milliseconds delay, uint32 group);
/**
* @name CancelEvent
@@ -285,7 +207,7 @@ public:
/**
* @name GetNextEventTime
- * @brief Returns closest occurence of specified event.
+ * @brief Returns closest occurrence of specified event.
* @param eventId Wanted event id.
* @return Time of found event.
*/