OpenTTD Source 20250612-master-gb012d9e3dc
train.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 TRAIN_H
11#define TRAIN_H
12
13#include "core/enum_type.hpp"
14
15#include "newgrf_engine.h"
16#include "cargotype.h"
17#include "rail.h"
18#include "engine_base.h"
19#include "rail_map.h"
20#include "ground_vehicle.hpp"
21
22struct Train;
23
36
38enum TrainForceProceeding : uint8_t {
42};
43
45enum class ConsistChangeFlag : uint8_t {
46 Length,
47 Capacity,
48};
49
51
52static constexpr ConsistChangeFlags CCF_TRACK{};
58
60
62
63void FreeTrainTrackReservation(const Train *v);
64bool TryPathReserve(Train *v, bool mark_as_stuck = false, bool first_tile_okay = false);
65
66int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length);
67
68void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
69
71void NormalizeTrainVehInDepot(const Train *u);
72
74struct TrainCache {
75 /* Cached wagon override spritegroup */
76 const struct SpriteGroup *cached_override = nullptr;
77
78 /* cached values, recalculated on load and each time a vehicle is added to/removed from the consist. */
79 bool cached_tilt = false;
80 uint8_t user_def_data = 0;
81
84
85 auto operator<=>(const TrainCache &) const = default;
86};
87
91struct Train final : public GroundVehicle<Train, VEH_TRAIN> {
92 VehicleRailFlags flags{};
93 uint16_t crash_anim_pos = 0;
94 uint16_t wait_counter = 0;
95
96 TrainCache tcache{};
97
98 /* Link between the two ends of a multiheaded engine */
99 Train *other_multiheaded_part = nullptr;
100
101 RailTypes compatible_railtypes{};
102 RailType railtype = INVALID_RAILTYPE;
103
104 TrackBits track{};
105 TrainForceProceeding force_proceed{};
106
110 virtual ~Train() { this->PreDestructor(); }
111
112 friend struct GroundVehicle<Train, VEH_TRAIN>; // GroundVehicle needs to use the acceleration functions defined at Train.
113
114 void MarkDirty() override;
115 void UpdateDeltaXY() override;
116 ExpensesType GetExpenseType(bool income) const override { return income ? EXPENSES_TRAIN_REVENUE : EXPENSES_TRAIN_RUN; }
117 void PlayLeaveStationSound(bool force = false) const override;
118 bool IsPrimaryVehicle() const override { return this->IsFrontEngine(); }
119 void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override;
120 int GetDisplaySpeed() const override { return this->gcache.last_speed; }
121 int GetDisplayMaxSpeed() const override { return this->vcache.cached_max_speed; }
122 Money GetRunningCost() const override;
123 int GetCursorImageOffset() const;
124 int GetDisplayImageWidth(Point *offset = nullptr) const;
125 bool IsInDepot() const override { return this->track == TRACK_BIT_DEPOT; }
126 bool Tick() override;
127 void OnNewCalendarDay() override;
128 void OnNewEconomyDay() override;
129 uint Crash(bool flooded = false) override;
130 Trackdir GetVehicleTrackdir() const override;
133
134 void ReserveTrackUnderConsist() const;
135
136 uint16_t GetCurveSpeedLimit() const;
137
138 void ConsistChanged(ConsistChangeFlags allowed_changes);
139
140 int UpdateSpeed();
141
142 void UpdateAcceleration();
143
144 int GetCurrentMaxSpeed() const override;
145
150 inline Train *GetNextUnit() const
151 {
152 Train *v = this->GetNextVehicle();
153 if (v != nullptr && v->IsRearDualheaded()) v = v->GetNextVehicle();
154
155 return v;
156 }
157
163 {
164 Train *v = this->GetPrevVehicle();
165 if (v != nullptr && v->IsRearDualheaded()) v = v->GetPrevVehicle();
166
167 return v;
168 }
169
175 {
176 /* For vehicles with odd lengths the part before the center will be one unit
177 * longer than the part after the center. This means we have to round up the
178 * length of the next vehicle but may not round the length of the current
179 * vehicle. */
180 return this->gcache.cached_veh_length / 2 + (this->Next() != nullptr ? this->Next()->gcache.cached_veh_length + 1 : 0) / 2;
181 }
182
183protected: // These functions should not be called outside acceleration code.
184
189 inline uint16_t GetPower() const
190 {
191 /* Power is not added for articulated parts */
192 if (!this->IsArticulatedPart() && HasPowerOnRail(this->railtype, GetRailType(this->tile))) {
193 uint16_t power = GetVehicleProperty(this, PROP_TRAIN_POWER, RailVehInfo(this->engine_type)->power);
194 /* Halve power for multiheaded parts */
195 if (this->IsMultiheaded()) power /= 2;
196 return power;
197 }
198
199 return 0;
200 }
201
206 inline uint16_t GetPoweredPartPower(const Train *head) const
207 {
208 /* For powered wagons the engine defines the type of engine (i.e. railtype) */
209 if (this->flags.Test(VehicleRailFlag::PoweredWagon) && HasPowerOnRail(head->railtype, GetRailType(this->tile))) {
210 return RailVehInfo(this->gcache.first_engine)->pow_wag_power;
211 }
212
213 return 0;
214 }
215
220 inline uint16_t GetWeight() const
221 {
222 uint16_t weight = CargoSpec::Get(this->cargo_type)->WeightOfNUnitsInTrain(this->cargo.StoredCount());
223
224 /* Vehicle weight is not added for articulated parts. */
225 if (!this->IsArticulatedPart()) {
226 weight += GetVehicleProperty(this, PROP_TRAIN_WEIGHT, RailVehInfo(this->engine_type)->weight);
227 }
228
229 /* Powered wagons have extra weight added. */
230 if (this->flags.Test(VehicleRailFlag::PoweredWagon)) {
231 weight += RailVehInfo(this->gcache.first_engine)->pow_wag_weight;
232 }
233
234 return weight;
235 }
236
241 uint16_t GetMaxWeight() const override;
242
247 inline uint8_t GetTractiveEffort() const
248 {
249 return GetVehicleProperty(this, PROP_TRAIN_TRACTIVE_EFFORT, RailVehInfo(this->engine_type)->tractive_effort);
250 }
251
256 inline uint8_t GetAirDragArea() const
257 {
258 /* Air drag is higher in tunnels due to the limited cross-section. */
259 return (this->track == TRACK_BIT_WORMHOLE && this->vehstatus.Test(VehState::Hidden)) ? 28 : 14;
260 }
261
266 inline uint8_t GetAirDrag() const
267 {
268 return RailVehInfo(this->engine_type)->air_drag;
269 }
270
279
284 inline uint16_t GetCurrentSpeed() const
285 {
286 return this->cur_speed;
287 }
288
293 inline uint32_t GetRollingFriction() const
294 {
295 /* Rolling friction for steel on steel is between 0.1% and 0.2%.
296 * The friction coefficient increases with speed in a way that
297 * it doubles at 512 km/h, triples at 1024 km/h and so on. */
298 return 15 * (512 + this->GetCurrentSpeed()) / 512;
299 }
300
305 inline int GetAccelerationType() const
306 {
307 return GetRailTypeInfo(this->railtype)->acceleration_type;
308 }
309
314 inline uint32_t GetSlopeSteepness() const
315 {
317 }
318
323 inline uint16_t GetMaxTrackSpeed() const
324 {
326 }
327
332 inline int16_t GetCurveSpeedModifier() const
333 {
334 return GetVehicleProperty(this, PROP_TRAIN_CURVE_SPEED_MOD, RailVehInfo(this->engine_type)->curve_speed_mod, true);
335 }
336
341 inline bool TileMayHaveSlopedTrack() const
342 {
343 /* Any track that isn't TRACK_BIT_X or TRACK_BIT_Y cannot be sloped. */
344 return this->track == TRACK_BIT_X || this->track == TRACK_BIT_Y;
345 }
346
353 {
354 return false;
355 }
356};
357
358#endif /* TRAIN_H */
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:23
Types/functions related to cargoes.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:222
uint8_t acceleration_type
Acceleration type of this rail type.
Definition rail.h:217
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Direction
Defines the 8 directions on the map.
ExpensesType
Types of expenses.
@ EXPENSES_TRAIN_RUN
Running costs trains.
@ EXPENSES_TRAIN_REVENUE
Revenue from trains.
Base class for engines.
Type (helpers) for enums.
Base class and functions for all vehicles that move through ground.
AccelStatus
What is the status of our acceleration?
@ AS_BRAKE
We want to stop.
@ AS_ACCEL
We want to go faster, if possible of course.
Functions for NewGRF engines.
@ PROP_TRAIN_CURVE_SPEED_MOD
Modifier to maximum speed in curves.
@ PROP_TRAIN_WEIGHT
Weight in t (if dualheaded: for each single vehicle)
@ PROP_TRAIN_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
@ PROP_TRAIN_POWER
Power in hp (if dualheaded: sum of both vehicles)
Rail specific functions.
bool HasPowerOnRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType got power on a tile with a given RailType.
Definition rail.h:341
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
Hides the direct accesses to the map array with map accessors.
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:32
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:137
Structure to return information about the closest depot location, and whether it could be found.
VehicleSettings vehicle
options for vehicles
EngineID first_engine
Cached EngineID of the front vehicle. EngineID::Invalid() for the front vehicle itself.
uint16_t last_speed
The last speed we did display, so we only have to redraw when this changes.
uint8_t cached_veh_length
Length of this vehicle in units of 1/VEHICLE_LENGTH of normal length. It is cached because this can b...
Base class for all vehicles that move through ground.
GroundVehicleCache gcache
Cache of often calculated values.
bool IsRearDualheaded() const
Tell if we are dealing with the rear end of a multiheaded engine.
bool IsMultiheaded() const
Check if the vehicle is a multiheaded engine.
Coordinates of a point in 2D.
uint16_t pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition engine_type.h:61
uint8_t air_drag
Coefficient of air drag.
Definition engine_type.h:66
uint8_t pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition engine_type.h:62
T * Next() const
Get next vehicle in the chain.
T * GetPrevVehicle() const
Get the previous real (non-articulated part) vehicle in the consist.
T * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Variables that are cached to improve performance and such.
Definition train.h:74
uint16_t cached_max_curve_speed
max consist speed limited by curves
Definition train.h:83
int16_t cached_curve_speed_mod
curve speed modifier of the entire train
Definition train.h:82
uint8_t user_def_data
Cached property 0x25. Can be set by Callback 0x36.
Definition train.h:80
bool cached_tilt
train can tilt; feature provides a bonus in curves
Definition train.h:79
'Train' is either a loco or a wagon.
Definition train.h:91
void PlayLeaveStationSound(bool force=false) const override
Play a sound for a train leaving the station.
int GetAccelerationType() const
Allows to know the acceleration type of a vehicle.
Definition train.h:305
bool IsInDepot() const override
Check whether the vehicle is in the depot.
Definition train.h:125
void UpdateAcceleration()
Update acceleration of the train from the cached power and weight.
void OnNewCalendarDay() override
Calendar day handler.
Train * GetNextUnit() const
Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consis...
Definition train.h:150
Trackdir GetVehicleTrackdir() const override
Get the tracks of the train vehicle.
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override
Get the sprite to display the train.
int GetDisplayMaxSpeed() const override
Gets the maximum speed in km-ish/h that can be sent into string parameters for string processing.
Definition train.h:121
uint16_t crash_anim_pos
Crash animation counter.
Definition train.h:93
uint8_t GetTractiveEffort() const
Allows to know the tractive effort value that this vehicle will use.
Definition train.h:247
bool Tick() override
Update train vehicle data for a tick.
bool HasToUseGetSlopePixelZ()
Trains can always use the faster algorithm because they have always the same direction as the track u...
Definition train.h:352
uint16_t GetCurrentSpeed() const
Calculates the current speed of this vehicle.
Definition train.h:284
void ReserveTrackUnderConsist() const
Tries to reserve track under whole train consist.
TileIndex GetOrderStationLocation(StationID station) override
Get the location of the next station to visit.
Train * GetPrevUnit()
Get the previous real (non-articulated part and non rear part of dualheaded engine) vehicle in the co...
Definition train.h:162
uint16_t GetPoweredPartPower(const Train *head) const
Returns a value if this articulated part is powered.
Definition train.h:206
uint32_t GetRollingFriction() const
Returns the rolling friction coefficient of this vehicle.
Definition train.h:293
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
ClosestDepot FindClosestDepot() override
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
void UpdateDeltaXY() override
Updates the x and y offsets and the size of the sprite used for this vehicle.
uint16_t GetMaxTrackSpeed() const
Gets the maximum speed allowed by the track for this vehicle.
Definition train.h:323
int CalcNextVehicleOffset() const
Calculate the offset from this vehicle's center to the following center taking the vehicle lengths in...
Definition train.h:174
uint16_t GetMaxWeight() const override
Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
uint16_t GetCurveSpeedLimit() const
Computes train speed limit caused by curves.
uint8_t GetAirDrag() const
Gets the air drag coefficient of this vehicle.
Definition train.h:266
bool IsPrimaryVehicle() const override
Whether this is the primary vehicle in the chain.
Definition train.h:118
void MarkDirty() override
Goods at the consist have changed, update the graphics, cargo, and acceleration.
int GetDisplaySpeed() const override
Gets the speed in km-ish/h that can be sent into string parameters for string processing.
Definition train.h:120
int UpdateSpeed()
This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables.
uint Crash(bool flooded=false) override
The train vehicle crashed! Update its status and other parts around it.
Train()
We don't want GCC to zero our struct! It already is zeroed and has an index!
Definition train.h:108
AccelStatus GetAccelerationStatus() const
Checks the current acceleration status of this vehicle.
Definition train.h:275
virtual ~Train()
We want to 'destruct' the right class.
Definition train.h:110
void OnNewEconomyDay() override
Economy day handler.
int16_t GetCurveSpeedModifier() const
Returns the curve speed modifier of this vehicle.
Definition train.h:332
bool TileMayHaveSlopedTrack() const
Checks if the vehicle is at a tile that can be sloped.
Definition train.h:341
uint16_t GetWeight() const
Allows to know the weight value that this vehicle will use.
Definition train.h:220
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
ExpensesType GetExpenseType(bool income) const override
Sets the expense type associated to this vehicle type.
Definition train.h:116
Money GetRunningCost() const override
Get running cost for the train consist.
uint8_t GetAirDragArea() const
Gets the area used for calculating air drag.
Definition train.h:256
uint16_t GetPower() const
Allows to know the power value that this vehicle will use.
Definition train.h:189
uint16_t wait_counter
Ticks waiting in front of a signal, ticks being stuck or a counter for forced proceeding through sign...
Definition train.h:94
uint32_t GetSlopeSteepness() const
Returns the slope steepness used by this vehicle.
Definition train.h:314
int GetCurrentMaxSpeed() const override
Calculates the maximum speed of the vehicle under its current conditions.
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
uint8_t train_slope_steepness
Steepness of hills for trains when using realistic acceleration.
Sprite sequence for a vehicle part.
EngineID engine_type
The type of engine used for this vehicle.
Direction direction
facing
VehicleCargoList cargo
The cargo this vehicle is carrying.
VehStates vehstatus
Status.
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
CargoType cargo_type
type of cargo this vehicle is carrying
debug_inline bool IsFrontEngine() const
Check if the vehicle is a front engine.
void PreDestructor()
Destroy all stuff that (still) needs the virtual functions to work properly.
Definition vehicle.cpp:796
VehicleCache vcache
Cache of often used vehicle values.
uint16_t cur_speed
current speed
TileIndex tile
Current tile index.
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_WORMHOLE
Bitflag for a wormhole (used for tunnels)
Definition track_type.h:52
@ TRACK_BIT_DEPOT
Bitflag for a depot.
Definition track_type.h:53
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
Trackdir
Enumeration for tracks and directions.
Definition track_type.h:66
ConsistChangeFlag
Flags for Train::ConsistChanged.
Definition train.h:45
@ Capacity
Allow vehicles to change capacity.
@ Length
Allow vehicles to change length.
static constexpr ConsistChangeFlags CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition train.h:52
bool TryPathReserve(Train *v, bool mark_as_stuck=false, bool first_tile_okay=false)
Try to reserve a path to a safe position.
static constexpr ConsistChangeFlags CCF_SAVELOAD
Valid changes when loading a savegame. (Everything that is not stored in the save....
Definition train.h:57
void NormalizeTrainVehInDepot(const Train *u)
Move all free vehicles in the depot to the train.
uint8_t FreightWagonMult(CargoType cargo)
Return the cargo weight multiplier to use for a rail vehicle.
Definition train_cmd.cpp:69
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
static constexpr ConsistChangeFlags CCF_LOADUNLOAD
Valid changes while vehicle is loading/unloading.
Definition train.h:53
void CheckTrainsLengths()
Checks if lengths of all rail vehicles are valid.
Definition train_cmd.cpp:76
bool TrainOnCrossing(TileIndex tile)
Check if a level crossing tile has a train on it.
VehicleRailFlag
Rail vehicle flags.
Definition train.h:25
@ Reversed
Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle ...
Definition train.h:31
@ AllowedOnNormalRail
Electric train engine is allowed to run on normal rail. *‍/.
Definition train.h:30
@ Stuck
Train can't get a path reservation.
Definition train.h:32
@ Flipped
Reverse the visible direction of the vehicle.
Definition train.h:28
@ PoweredWagon
Wagon is powered.
Definition train.h:27
@ LeavingStation
Train is just leaving a station.
Definition train.h:33
@ Reversing
Train is slowing down to reverse.
Definition train.h:26
int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length)
Get the stop location of (the center) of the front vehicle of a train at a platform of a station.
TrainForceProceeding
Modes for ignoring signals.
Definition train.h:38
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
Definition train.h:41
@ TFP_NONE
Normal operation.
Definition train.h:39
@ TFP_STUCK
Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
Definition train.h:40
static constexpr ConsistChangeFlags CCF_REFIT
Valid changes for refitting in a depot.
Definition train.h:55
static constexpr ConsistChangeFlags CCF_AUTOREFIT
Valid changes for autorefitting in stations.
Definition train.h:54
void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a train sprite heading west, or both heads (used for lists).
static constexpr ConsistChangeFlags CCF_ARRANGE
Valid changes for arranging the consist in a depot.
Definition train.h:56
@ Hidden
Vehicle is not visible.
@ Stopped
Vehicle is stopped by the player.
EngineImageType
Visualisation contexts of vehicles and engines.
@ VEH_TRAIN
Train vehicle type.