1. Description

Timers for UniTask. Using UniTask's functionality to integrate with PlayerLoop. Featuring flexible settings and eliminating accumulation of errors in cyclic executions.

Key Features and Advantages:

• Accuracy without error accumulation.
  Each timer tick accounts for the difference between the scheduled and actual execution times, preventing error accumulation.
• Configurable number of ticks.
  You can set a specific number of timer ticks, such as having the timer run 10 times at one-second intervals and then stop.
• Choice of game cycle for execution.
  The timer can run in various cycles like Update, FixedUpdate, and others.
• Custom time function.
  You can use your own time function instead of the standard Time.time and Time.deltaTime.
• Multiple ticks per frame.
  For very short intervals, the timer can trigger events multiple times within a single frame.
• Safe multiple starts and stops.
  The timer remains stable even if Start() and Stop() are called multiple times within the same frame.
• On-the-fly parameter changes.
  Parameters such as the interval and number of ticks can be adjusted during the timer's operation.
• Easy saving and copying.
  Internal parameters like elapsed time and the number of ticks are accessible, making it easy to save the state or create copies.

 

2. Example

An example of a timer that ticks every second and stops after 10 ticks

 Func<float> getTimeFunc = GameWorldTime.GetTime;
 
 // Create and init timer
 var timer = new RealtimeTimer()
 {
     Interval = 1f,
     TotalTicks = 10
 };
 
 // Set custom time function
 timer.SetTimeFunction(getTimeFunc);
 // Or use Time.time, Time.unscaledDeltaTime or Time.realtimeSinceStartup
 // Default is Time.time;
 timer.SetTimeFunction(RealtimeMode.Unscaled);
 
 timer.Started += () => Debug.Log("Timer started");
 timer.Completed += () => Debug.Log("Timer finished");
 timer.Tick += () => Debug.Log($"Tick at {Time.time}. Scheduled time - {timer.LastTime}");
 
 // Start or resume the timer
 timer.Start();
 
 // Timer properties can be changed while running.
 timer.Interval /= 2;
 timer.LastTime = GameWorldTime.GetTime() + 10f;
 
 // The timer can be stopped and later resumed.
 timer.Stop();
 
 // Stop and reset the timer
 timer.Reset();

 

3. Timers

IntervalTimer

Base class for timers.

Properties

• Interval - The time interval after which the timer triggers the Tick event.
• CompletedTicks - The current number of times the timer has triggered.
• TotalTicks - The total number of times the timer will trigger before stopping. -1 indicates an infinite loop.
• Mode – Timer operation mode.
  • Single – The event is triggered no more than once per frame, even if the timer elapsed multiple times during that frame. To determine how many times the timer elapsed within a frame, use the FrameTicksCount property in the event handler.
  • MultiplePrecalc – The event can be triggered multiple times per frame. The number of timer elapses is calculated in advance.
  • MultipleDynamic – The event can be triggered multiple times per frame. The number of timer elapses is not calculated in advance and depends on changes to timer parameters (such as Interval, ElapsedTime, or LastTime) that occur during the execution of event handlers. -FrameTicksCount – The number of times the timer elapsed within a single frame. Used in Single mode to determine how many timer elapses occurred during the frame.
• State - Timer state.

Methods

• Start() - Starts or resumes the timer. If it's the first start, parameters are initialized automatically
• Stop() - Stops the timer with the option to resume later.
• Reset() - Stops the timer and resets its state.

 

1. DeltaTimeTimer

• Uses the difference in time between frames (Time.deltaTime and similar) for its calculations.
• Upon stopping and restarting, continues without accounting for the time when the timer was paused.

Properties and methods

• ElapsedTime - The time since the timer was started or last triggered.
• SetDeltaTimeFunction(bool unscaled) - Specifies which type of time the timer will use: Time.deltaTime or Time.unscaledDeltaTime
• SetDeltaTimeFunction(Func<float> getDeltaTime) - Sets a custom function that returns the interval between the current and previous frames.

 

2. RealtimeTimer

• Uses game time (Time.time and similar, or a user-defined time function).
• Upon stopping and restarting, triggers all missed events.
• In the case of multiple events within a single frame, the timer accurately determines the time of each event using the LateTime property.

Properties and methods

• LastTime - The time of the last trigger or when the timer started.
• SetTimeFunction(RealtimeMode mode) - Specifies which type of time the timer will use: Time.time, Time.unscaledDeltaTime, or Time.realtimeSinceStartup.
• SetTimeFunction(Func<float> getTime) - Sets a custom function that returns the time.

 

3. DateTimeTimer

• Uses system time (DateTime.Now or a user-defined function).
• Upon stopping and restarting, triggers all missed events.
• In the case of multiple events within a single frame, the timer accurately determines the time of each event using the LateTime property.

Properties and methods

• LastTime - The time of the last trigger or when the timer started.
• SetTimeFunction(Func<DateTime> getTime) - Sets a custom function that returns the time. Default is DateTime.Now.

 

4. Additional Information

TimerMode

When the timer's interval is shorter than the frame time, this parameter defines how the timer will trigger events.

TimerMode.Multi

In this mode, the Tick event is called multiple times within a single frame.

float interval = 0.005f;
int ticksCount = 5;

var timer = new RealtimeTimer()
{
    Interval = interval,
    TotalTicks = ticksCount,
    Mode = TimerMode.MultipleDynamic
};
timer.Started += () => Debug.Log($"Timer started at {Time.time}");
timer.Completed += () => Debug.Log($"Timer finished at {Time.time}");
timer.Tick += () => Debug.Log($"Current time - {Time.time}. Scheduled time - {timer.LastTime}.");

timer.Start();

Output

  Timer started at 19,02731
  Current time - 19,03973. Scheduled time - 19,03231.
  Current time - 19,03973. Scheduled time - 19,03731.
  Current time - 19,05369. Scheduled time - 19,04231.
  Current time - 19,05369. Scheduled time - 19,04731.
  Current time - 19,05369. Scheduled time - 19,05231.
  Timer finished at 19,05369

TimerMode.Single

In this mode, the Tick method is called once per frame. The FrameTicksCount properties provide information about the number of timer triggers.

float interval = 0.005f;
int ticksCount = 5;

var timer = new RealtimeTimer()
{
    Interval = interval,
    TotalTicks = ticksCount,
    Mode = TimerMode.Single
};
timer.Started += () => Debug.Log($"Timer started at {Time.time}");
timer.Completed += () => Debug.Log($"Timer finished at {Time.time}");
timer.Tick += () => Debug.Log($"Current time - {Time.time}. Scheduled time - {timer.LastTime}. Ticks - {timer.FrameTicksCount}");

timer.Start();

Output

  Timer started at 19,02731
  Current time - 19,03973. Ticks - 2
  Current time - 19,05369. Ticks - 3
  Timer finished at 19,05369

   

1. Описание

Таймеры для UniTask. Используют функционал библиотеки UniTask для интеграции в PlayerLoop. Имеют гибкие настройки и не накапливают погрешности в циклических срабатываниях.

Основные возможности и преимущества:

• Точность работы без накопления ошибок.
  При каждом срабатывании таймера учитывается разница между запланированным и фактическим временем выполнения.
• Настраиваемое количество срабатываний.
  Возможность задать количество срабатываний, например, чтобы таймер отработал 10 раз с интервалом в одну секунду и затем остановился.
• Выбор игрового цикла для выполнения.
  Таймер может работать в Update, FixedUpdate и других циклах.
• Пользовательская функция времени.
  Возможность использовать собственную функцию времени вместо стандартных Time.time, Time.deltaTime и других.
• Многократные срабатывания за один кадр.
  При малых интервалах времени таймер может вызывать события несколько раз за один кадр.
• Безопасный многократный запуск и остановка.
  Таймер остается стабильным при многократных вызовах Start() и Stop() в пределах одного кадра
• Изменение параметров на лету.
  Интервал, количество срабатываний и другие параметры могут быть изменены в процессе работы таймера.
• Простота сохранения и копирования.
  Внутренние параметры таймера, такие как прошедшее время и количество срабатываний, доступны для сохранения и создания копий.

 

2. Пример

Пример таймера, который срабатывает каждую секунду и останавливается после 10 срабатываний.

 Func<float> getTimeFunc = GameWorldTime.GetTime;
 
 // Создание и инициализация таймера.
 var timer = new RealtimeTimer()
 {
     Interval = 1f,
     TotalTicks = 10
 };
 
 // Установка пользовательской функции времени
 timer.SetTimeFunction(getTimeFunc);
 // Или указание одной из Time.time, Time.unscaledDeltaTime или Time.realtimeSinceStartup
 // По умолчанию Time.time;
 timer.SetTimeFunction(RealtimeMode.Unscaled);
 
 timer.Started += () => Debug.Log("Timer started");
 timer.Completed += () => Debug.Log("Timer finished");
 timer.Tick += () => Debug.Log($"Tick at {Time.time}. Scheduled time - {timer.LastTime}");
 
 // Запуск таймера или продолжение его работы.
 timer.Start();
 
 // Свойства таймера могут быть изменены во время его выполнения.
 timer.Interval /= 2;
 timer.LastTime = GameWorldTime.GetTime() + 10f;
 
 // Остановка таймера с возможностью продолжения его работу позже.
 timer.Stop();
 
 // Остановка и сброс параметров таймера.
 timer.Reset();

 

3. Таймеры

IntervalTimer

Базовый класс всех таймеров.

Cвойства

• Interval - Интервал времени, по истечению которого таймер вызывает событие Tick.
• CompletedTicks - Текущее количество срабатываний таймера.
• TotalTicks - Количество раз сколько должен сработать таймер. -1 - бесконечный режим работы таймера.
• Mode - Режим работы таймера.
  • Single - Событие вызывается не более одного раз за кадр, даже если таймер истекал несколько раз за этот период. Для получения информации о количестве срабатываний таймера за кадр используйте свойство FrameTicksCount в обработчике событий.
  • MultiplePrecalc - Событие может быть вызвано несколько раз за кадр. Количество срабатываний таймера рассчитывается заранее.
  • MultipleDynamic - Событие может быть вызвано несколько раз в одном кадре. Количество срабатываний не рассчитывается заранее и зависит от изменений параметров таймера (таких как Interval, ElapsedTime или LastTime), происходящих во время работы обработчиков событий.
• FrameTicksCount - Количество срабатываний таймера за один кадр. Используется в режиме Single для определения, сколько раз таймер истекал в течение одного кадра
• PlayerLoopTimiming - Определяет, в каком из игровых циклов (например, Update, FixedUpdate и т.д.) будет использоваться таймер.
• State - Состояние таймера.

Методы

• Start() - Запуск таймера или возобновление его работы
• Stop() - Остановка таймера с возможностью его последующего возобновления.
• Reset() - Остановка таймера и сброс его состояния.

 

1. DeltaTimeTimer

• Использует разницу времени между кадрами для своих расчётов (Time.deltaTime и другие).
• При остановке и последующем запуске продолжает работу без учета времени, когда таймер был остановлен.

Свойства и методы

• ElapsedTime - Время с момента запуска или последнего срабатывания таймера.
• SetDeltaTimeFunction(bool unscaled) - Позволяет указать какой тип времени использовать для обновления таймера: Time.deltaTime или Time.unscaledDeltaTime.
• SetDeltaTimeFunction(Func<float> getDeltaTime) - Позволяет указать пользовательскую функцию, возвращающая интервал между текущим и предыдущим кадром.

 

2. RealtimeTimer

• Использует игровое время (Time.time и другие или пользовательскую функцию времени).
• При остановке и последующем запуске вызываются все пропущенные срабатывания.
• В случае многократных срабатываний в пределах одного кадра, таймер позволяет точно определить время каждого срабатывания, используя свойство LastTime.

Свойства и методы

• LastTime - Время последнего срабатывания таймера или время его запуска.
• SetTimeFunction(RealtimeMode mode) - Позволяет указать какой тип времени используется таймером : Time.time, Time.unscaledDeltaTime или Time.realtimeSinceStartup
• SetTimeFunction(Func<float> getTime) - Позволяет указать пользовательскую функцию, возвращающая время.

 

3. DateTimeTimer

• Использует системное время (DateTime.Now или пользовательскую функцию).
• При остановке и последующем запуске вызываются все пропущенные срабатывания.
• В случае многократных срабатываний в пределах одного кадра, таймер позволяет точно определить время каждого срабатывания, используя свойство LastTime.

Свойства и методы

• LastTime - Время последнего срабатывания таймера или время его запуска.
• SetTimeFunction(Func<DateTime> getTime) - Позволяет указать пользовательскую функцию, возвращающая время. По умолчанию используется DateTime.Now;

 

4. Дополнительно

TimerMode

Если интервал срабатывания таймера меньше, чем интервал времени между кадрами, то этот параметр определяет как таймер будет вызывать событие.

TimerMode.MultipleDynamic и MultiplePrecalc

В этом режиме событие Tick будет вызываться несколько раз в течении одного кадра.

float interval = 0.005f;
int ticksCount = 5;

var timer = new RealtimeTimer()
{
    Interval = interval,
    TotalTicks = ticksCount,
    Mode = TimerMode.MultipleDynamic
};
timer.Started += () => Debug.Log($"Timer started at {Time.time}");
timer.Completed += () => Debug.Log($"Timer finished at {Time.time}");
timer.Tick += () => Debug.Log($"Current time - {Time.time}. Scheduled time - {timer.LastTime}.");

timer.Start();

Вывод

  Timer started at 19,02731
  Current time - 19,03973. Scheduled time - 19,03231.
  Current time - 19,03973. Scheduled time - 19,03731.
  Current time - 19,05369. Scheduled time - 19,04231.
  Current time - 19,05369. Scheduled time - 19,04731.
  Current time - 19,05369. Scheduled time - 19,05231.
  Timer finished at 19,05369

TimerMode.Single

В этом режиме событие Tick будет вызываться один раз в течении одного кадра. Свойство FrameTicksCount позволяет получить информацию о количестве срабатываний таймера.

float interval = 0.005f;
int ticksCount = 5;

var timer = new RealtimeTimer()
{
    Interval = interval,
    TotalTicks = ticksCount,
    Mode = TimerMode.Single
};
timer.Started += () => Debug.Log($"Timer started at {Time.time}");
timer.Completed += () => Debug.Log($"Timer finished at {Time.time}");
timer.Tick += () => Debug.Log($"Current time - {Time.time}. Scheduled time - {timer.LastTime}. Ticks - {timer.FrameTicksCount}");

timer.Start();

Вывод

  Timer started at 19,02731
  Current time - 19,03973. Ticks - 2
  Current time - 19,05369. Ticks - 3
  Timer finished at 19,05369