OpenTTD Source: src/base_consist.h Source File

OpenTTD Source 14.0-RC3

base_consist.h
Go to the documentation of this file.
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
10 #ifndef BASE_CONSIST_H
11 #define BASE_CONSIST_H
12
13 #include "order_type.h"
14 #include "timer/timer_game_tick.h"
15
17 struct BaseConsist {
18 std::string name;
19
20 /* Used for timetabling. */
21 TimerGameTick::Ticks current_order_time;
22 TimerGameTick::Ticks lateness_counter;
23 TimerGameTick::TickCounter timetable_start;
24
25 TimerGameTick::TickCounter depot_unbunching_last_departure;
26 TimerGameTick::TickCounter depot_unbunching_next_departure;
27 TimerGameTick::Ticks round_trip_time;
28
29 uint16_t service_interval;
30
31 VehicleOrderID cur_real_order_index;
32 VehicleOrderID cur_implicit_order_index;
33
34 uint16_t vehicle_flags;
35
36 virtual ~BaseConsist() = default;
37
38 void CopyConsistPropertiesFrom(const BaseConsist *src);
39 void ResetDepotUnbunching();
40 };
41
42 #endif /* BASE_CONSIST_H */
BaseConsist::cur_implicit_order_index
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
Definition: base_consist.h:32
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
BaseConsist::round_trip_time
TimerGameTick::Ticks round_trip_time
How many ticks for a single circumnavigation of the orders.
Definition: base_consist.h:27
BaseConsist::service_interval
uint16_t service_interval
The interval for (automatic) servicing; either in days or %.
Definition: base_consist.h:29
BaseConsist::name
std::string name
Name of vehicle.
Definition: base_consist.h:18
BaseConsist::depot_unbunching_next_departure
TimerGameTick::TickCounter depot_unbunching_next_departure
When the vehicle will next try to leave its unbunching depot.
Definition: base_consist.h:26
BaseConsist::vehicle_flags
uint16_t vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:34
BaseConsist::lateness_counter
TimerGameTick::Ticks lateness_counter
How many ticks late (or early if negative) this vehicle is.
Definition: base_consist.h:22
BaseConsist::current_order_time
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:21
TimerGameTick::TickCounter
uint64_t TickCounter
The type that the tick counter is stored in.
Definition: timer_game_tick.h:25
BaseConsist::depot_unbunching_last_departure
TimerGameTick::TickCounter depot_unbunching_last_departure
When the vehicle last left its unbunching depot.
Definition: base_consist.h:25
timer_game_tick.h
BaseConsist::ResetDepotUnbunching
void ResetDepotUnbunching()
Resets all the data used for depot unbunching.
Definition: base_consist.cpp:49
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition: base_consist.h:31
TimerGameTick::Ticks
int32_t Ticks
The type to store ticks in.
Definition: timer_game_tick.h:24
BaseConsist::timetable_start
TimerGameTick::TickCounter timetable_start
At what tick of TimerGameTick::counter the vehicle should start its timetable.
Definition: base_consist.h:23
BaseConsist
Various front vehicle properties that are preserved when autoreplacing, using order-backup or switchi...
Definition: base_consist.h:17
order_type.h
BaseConsist::CopyConsistPropertiesFrom
void CopyConsistPropertiesFrom(const BaseConsist *src)
Copy properties of other BaseConsist.
Definition: base_consist.cpp:22