src/timer/timer_game_tick.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD 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, version 2.
   4  * OpenTTD 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.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file timer_game_tick.h Definition of the tick-based game-timer */
   9
  10 #ifndef TIMER_GAME_TICK_H
  11 #define TIMER_GAME_TICK_H
  12
  13 #include "../gfx_type.h"
  14
  15 #include <chrono>
  16
  17 /**
  18  * Timer that represents the game-ticks. It will pause when the game is paused.
  19  *
  20  * @note Callbacks are executed in the game-thread.
  21  */
  22 class TimerGameTick {
  23 public:
  24         using Ticks = int32_t; ///< The type to store ticks in
  25         using TickCounter = uint64_t; ///< The type that the tick counter is stored in
  26
  27         using TPeriod = uint;
  28         using TElapsed = uint;
  29         struct TStorage {
  30                 uint elapsed;
  31         };
  32
  33         static TickCounter counter; ///< Monotonic counter, in ticks, since start of game.
  34 };
  35
  36 /**
  37  * Storage class for Ticks constants.
  38  */
  39 class Ticks {
  40 public:
  41         static constexpr TimerGameTick::Ticks INVALID_TICKS = -1; ///< Representation of an invalid number of ticks.
  42
  43         /**
  44          * 1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885. On an overflow the new day begun and 65535 / 885 = 74.
  45          * 1 tick is approximately 27 ms.
  46          * 1 day is thus about 2 seconds (74 * 27 = 1998) on a machine that can run OpenTTD normally
  47          */
  48         static constexpr TimerGameTick::Ticks DAY_TICKS = 74; ///< ticks per day
  49         static constexpr TimerGameTick::Ticks TICKS_PER_SECOND = 1000 / MILLISECONDS_PER_TICK; ///< Estimation of how many ticks fit in a single second.
  50
  51         static constexpr TimerGameTick::Ticks STATION_RATING_TICKS = 185; ///< Cycle duration for updating station rating.
  52         static constexpr TimerGameTick::Ticks STATION_ACCEPTANCE_TICKS = 250; ///< Cycle duration for updating station acceptance.
  53         static constexpr TimerGameTick::Ticks STATION_LINKGRAPH_TICKS = 504; ///< Cycle duration for cleaning dead links.
  54         static constexpr TimerGameTick::Ticks CARGO_AGING_TICKS = 185; ///< Cycle duration for aging cargo.
  55         static constexpr TimerGameTick::Ticks INDUSTRY_PRODUCE_TICKS = 256; ///< Cycle duration for industry production.
  56         static constexpr TimerGameTick::Ticks TOWN_GROWTH_TICKS = 70;  ///< Cycle duration for towns trying to grow (this originates from the size of the town array in TTD).
  57         static constexpr TimerGameTick::Ticks INDUSTRY_CUT_TREE_TICKS = INDUSTRY_PRODUCE_TICKS * 2; ///< Cycle duration for lumber mill's extra action.
  58 };
  59
  60 #endif /* TIMER_GAME_TICK_H */