OpenTTD Source: src/train.h Source File

OpenTTD Source 14.1

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
22 struct Train;
23
25 enum VehicleRailFlags {
26 VRF_REVERSING = 0,
27 VRF_POWEREDWAGON = 3,
28 VRF_REVERSE_DIRECTION = 4,
29
30 VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,
31 VRF_TOGGLE_REVERSE = 7,
32 VRF_TRAIN_STUCK = 8,
33 VRF_LEAVING_STATION = 9,
34 };
35
37 enum TrainForceProceeding : byte {
38 TFP_NONE = 0,
39 TFP_STUCK = 1,
40 TFP_SIGNAL = 2,
41 };
42
44 enum ConsistChangeFlags {
45 CCF_LENGTH = 0x01,
46 CCF_CAPACITY = 0x02,
47
48 CCF_TRACK = 0,
49 CCF_LOADUNLOAD = 0,
50 CCF_AUTOREFIT = CCF_CAPACITY,
51 CCF_REFIT = CCF_LENGTH | CCF_CAPACITY,
52 CCF_ARRANGE = CCF_LENGTH | CCF_CAPACITY,
53 CCF_SAVELOAD = CCF_LENGTH,
54 };
55 DECLARE_ENUM_AS_BIT_SET(ConsistChangeFlags)
56
57 byte FreightWagonMult(CargoID cargo);
58
59 void CheckTrainsLengths();
60
61 void FreeTrainTrackReservation(const Train *v);
62 bool TryPathReserve(Train *v, bool mark_as_stuck = false, bool first_tile_okay = false);
63
64 int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length);
65
66 void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
67
68 bool TrainOnCrossing(TileIndex tile);
69 void NormalizeTrainVehInDepot(const Train *u);
70
72 struct TrainCache {
73 /* Cached wagon override spritegroup */
74 const struct SpriteGroup *cached_override;
75
76 /* cached values, recalculated on load and each time a vehicle is added to/removed from the consist. */
77 bool cached_tilt;
78 int cached_curve_speed_mod;
79
80 byte user_def_data;
81
82 /* cached max. speed / acceleration data */
83 int cached_max_curve_speed;
84 };
85
89 struct Train final : public GroundVehicle<Train, VEH_TRAIN> {
90 TrainCache tcache;
91
92 /* Link between the two ends of a multiheaded engine */
93 Train *other_multiheaded_part;
94
95 uint16_t crash_anim_pos;
96
97 uint16_t flags;
98 TrackBits track;
99 TrainForceProceeding force_proceed;
100 RailType railtype;
101 RailTypes compatible_railtypes;
102
104 uint16_t wait_counter;
105
107 Train() : GroundVehicleBase() {}
109 virtual ~Train() { this->PreDestructor(); }
110
111 friend struct GroundVehicle<Train, VEH_TRAIN>; // GroundVehicle needs to use the acceleration functions defined at Train.
112
113 void MarkDirty() override;
114 void UpdateDeltaXY() override;
115 ExpensesType GetExpenseType(bool income) const override { return income ? EXPENSES_TRAIN_REVENUE : EXPENSES_TRAIN_RUN; }
116 void PlayLeaveStationSound(bool force = false) const override;
117 bool IsPrimaryVehicle() const override { return this->IsFrontEngine(); }
118 void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override;
119 int GetDisplaySpeed() const override { return this->gcache.last_speed; }
120 int GetDisplayMaxSpeed() const override { return this->vcache.cached_max_speed; }
121 Money GetRunningCost() const override;
122 int GetCursorImageOffset() const;
123 int GetDisplayImageWidth(Point *offset = nullptr) const;
124 bool IsInDepot() const override { return this->track == TRACK_BIT_DEPOT; }
125 bool Tick() override;
126 void OnNewCalendarDay() override;
127 void OnNewEconomyDay() override;
128 uint Crash(bool flooded = false) override;
129 Trackdir GetVehicleTrackdir() const override;
130 TileIndex GetOrderStationLocation(StationID station) override;
131 ClosestDepot FindClosestDepot() override;
132
133 void ReserveTrackUnderConsist() const;
134
135 int GetCurveSpeedLimit() const;
136
137 void ConsistChanged(ConsistChangeFlags allowed_changes);
138
139 int UpdateSpeed();
140
141 void UpdateAcceleration();
142
143 int GetCurrentMaxSpeed() const override;
144
149 inline Train *GetNextUnit() const
150 {
151 Train *v = this->GetNextVehicle();
152 if (v != nullptr && v->IsRearDualheaded()) v = v->GetNextVehicle();
153
154 return v;
155 }
156
161 inline Train *GetPrevUnit()
162 {
163 Train *v = this->GetPrevVehicle();
164 if (v != nullptr && v->IsRearDualheaded()) v = v->GetPrevVehicle();
165
166 return v;
167 }
168
173 int CalcNextVehicleOffset() const
174 {
175 /* For vehicles with odd lengths the part before the center will be one unit
176 * longer than the part after the center. This means we have to round up the
177 * length of the next vehicle but may not round the length of the current
178 * vehicle. */
179 return this->gcache.cached_veh_length / 2 + (this->Next() != nullptr ? this->Next()->gcache.cached_veh_length + 1 : 0) / 2;
180 }
181
182 protected: // These functions should not be called outside acceleration code.
183
188 inline uint16_t GetPower() const
189 {
190 /* Power is not added for articulated parts */
191 if (!this->IsArticulatedPart() && HasPowerOnRail(this->railtype, GetRailType(this->tile))) {
192 uint16_t power = GetVehicleProperty(this, PROP_TRAIN_POWER, RailVehInfo(this->engine_type)->power);
193 /* Halve power for multiheaded parts */
194 if (this->IsMultiheaded()) power /= 2;
195 return power;
196 }
197
198 return 0;
199 }
200
205 inline uint16_t GetPoweredPartPower(const Train *head) const
206 {
207 /* For powered wagons the engine defines the type of engine (i.e. railtype) */
208 if (HasBit(this->flags, VRF_POWEREDWAGON) && HasPowerOnRail(head->railtype, GetRailType(this->tile))) {
209 return RailVehInfo(this->gcache.first_engine)->pow_wag_power;
210 }
211
212 return 0;
213 }
214
219 inline uint16_t GetWeight() const
220 {
221 uint16_t weight = CargoSpec::Get(this->cargo_type)->WeightOfNUnitsInTrain(this->cargo.StoredCount());
222
223 /* Vehicle weight is not added for articulated parts. */
224 if (!this->IsArticulatedPart()) {
225 weight += GetVehicleProperty(this, PROP_TRAIN_WEIGHT, RailVehInfo(this->engine_type)->weight);
226 }
227
228 /* Powered wagons have extra weight added. */
229 if (HasBit(this->flags, VRF_POWEREDWAGON)) {
230 weight += RailVehInfo(this->gcache.first_engine)->pow_wag_weight;
231 }
232
233 return weight;
234 }
235
240 uint16_t GetMaxWeight() const override;
241
246 inline byte GetTractiveEffort() const
247 {
248 return GetVehicleProperty(this, PROP_TRAIN_TRACTIVE_EFFORT, RailVehInfo(this->engine_type)->tractive_effort);
249 }
250
255 inline byte GetAirDragArea() const
256 {
257 /* Air drag is higher in tunnels due to the limited cross-section. */
258 return (this->track == TRACK_BIT_WORMHOLE && this->vehstatus & VS_HIDDEN) ? 28 : 14;
259 }
260
265 inline byte GetAirDrag() const
266 {
267 return RailVehInfo(this->engine_type)->air_drag;
268 }
269
274 inline AccelStatus GetAccelerationStatus() const
275 {
276 return (this->vehstatus & VS_STOPPED) || HasBit(this->flags, VRF_REVERSING) || HasBit(this->flags, VRF_TRAIN_STUCK) ? AS_BRAKE : AS_ACCEL;
277 }
278
283 inline uint16_t GetCurrentSpeed() const
284 {
285 return this->cur_speed;
286 }
287
292 inline uint32_t GetRollingFriction() const
293 {
294 /* Rolling friction for steel on steel is between 0.1% and 0.2%.
295 * The friction coefficient increases with speed in a way that
296 * it doubles at 512 km/h, triples at 1024 km/h and so on. */
297 return 15 * (512 + this->GetCurrentSpeed()) / 512;
298 }
299
304 inline int GetAccelerationType() const
305 {
306 return GetRailTypeInfo(this->railtype)->acceleration_type;
307 }
308
313 inline uint32_t GetSlopeSteepness() const
314 {
315 return _settings_game.vehicle.train_slope_steepness;
316 }
317
322 inline uint16_t GetMaxTrackSpeed() const
323 {
324 return GetRailTypeInfo(GetRailType(this->tile))->max_speed;
325 }
326
331 inline int GetCurveSpeedModifier() const
332 {
333 return GetVehicleProperty(this, PROP_TRAIN_CURVE_SPEED_MOD, RailVehInfo(this->engine_type)->curve_speed_mod, true);
334 }
335
340 inline bool TileMayHaveSlopedTrack() const
341 {
342 /* Any track that isn't TRACK_BIT_X or TRACK_BIT_Y cannot be sloped. */
343 return this->track == TRACK_BIT_X || this->track == TRACK_BIT_Y;
344 }
345
351 inline bool HasToUseGetSlopePixelZ()
352 {
353 return false;
354 }
355 };
356
357 #endif /* TRAIN_H */
Train::GetDisplayImageWidth
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
Definition: train_cmd.cpp:460
Train::IsInDepot
bool IsInDepot() const override
Check whether the vehicle is in the depot.
Definition: train.h:124
SpecializedVehicle< Train, Type >::GetNextVehicle
Train * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1170
Train::IsPrimaryVehicle
bool IsPrimaryVehicle() const override
Whether this is the primary vehicle in the chain.
Definition: train.h:117
Vehicle::IsFrontEngine
debug_inline bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:941
VRF_TOGGLE_REVERSE
@ VRF_TOGGLE_REVERSE
Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle ...
Definition: train.h:31
TRACK_BIT_WORMHOLE
@ TRACK_BIT_WORMHOLE
Bitflag for a wormhole (used for tunnels)
Definition: track_type.h:52
Train::OnNewCalendarDay
void OnNewCalendarDay() override
Calendar day handler.
Definition: train_cmd.cpp:4180
RailVehicleInfo::pow_wag_power
uint16_t pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition: engine_type.h:56
VehicleCargoList::StoredCount
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition: cargopacket.h:434
RailVehicleInfo::pow_wag_weight
byte pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition: engine_type.h:57
CCF_CAPACITY
@ CCF_CAPACITY
Allow vehicles to change capacity.
Definition: train.h:46
Vehicle::PreDestructor
void PreDestructor()
Destroy all stuff that (still) needs the virtual functions to work properly.
Definition: vehicle.cpp:826
Train::crash_anim_pos
uint16_t crash_anim_pos
Crash animation counter.
Definition: train.h:95
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
Train::TileMayHaveSlopedTrack
bool TileMayHaveSlopedTrack() const
Checks if the vehicle is at a tile that can be sloped.
Definition: train.h:340
Train::GetTractiveEffort
byte GetTractiveEffort() const
Allows to know the tractive effort value that this vehicle will use.
Definition: train.h:246
GetRailTypeInfo
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:307
TrainCache::cached_tilt
bool cached_tilt
train can tilt; feature provides a bonus in curves
Definition: train.h:77
Train::GetRunningCost
Money GetRunningCost() const override
Get running cost for the train consist.
Definition: train_cmd.cpp:4083
Train::GetCurrentMaxSpeed
int GetCurrentMaxSpeed() const override
Calculates the maximum speed of the vehicle under its current conditions.
Definition: train_cmd.cpp:382
GroundVehicleCache::first_engine
EngineID first_engine
Cached EngineID of the front vehicle. INVALID_ENGINE for the front vehicle itself.
Definition: ground_vehicle.hpp:43
SpecializedVehicle< Train, Type >::Next
Train * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1126
PROP_TRAIN_TRACTIVE_EFFORT
@ PROP_TRAIN_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
Definition: newgrf_properties.h:27
TrainCache::cached_curve_speed_mod
int cached_curve_speed_mod
curve speed modifier of the entire train
Definition: train.h:78
EXPENSES_TRAIN_REVENUE
@ EXPENSES_TRAIN_REVENUE
Revenue from trains.
Definition: economy_type.h:180
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:349
Train::GetCurrentSpeed
uint16_t GetCurrentSpeed() const
Calculates the current speed of this vehicle.
Definition: train.h:283
VRF_POWEREDWAGON
@ VRF_POWEREDWAGON
Wagon is powered.
Definition: train.h:27
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:131
TrainOnCrossing
bool TrainOnCrossing(TileIndex tile)
Check if a level crossing tile has a train on it.
Definition: train_cmd.cpp:1682
Train::UpdateSpeed
int UpdateSpeed()
This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables.
Definition: train_cmd.cpp:2985
Train::GetAccelerationStatus
AccelStatus GetAccelerationStatus() const
Checks the current acceleration status of this vehicle.
Definition: train.h:274
TrainCache::user_def_data
byte user_def_data
Cached property 0x25. Can be set by Callback 0x36.
Definition: train.h:80
VehicleRailFlags
VehicleRailFlags
Rail vehicle flags.
Definition: train.h:25
VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL
@ VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL
Electric train engine is allowed to run on normal rail. *‍/.
Definition: train.h:30
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
AS_ACCEL
@ AS_ACCEL
We want to go faster, if possible of course.
Definition: ground_vehicle.hpp:21
GroundVehicle::IsRearDualheaded
bool IsRearDualheaded() const
Tell if we are dealing with the rear end of a multiheaded engine.
Definition: ground_vehicle.hpp:333
CCF_REFIT
@ CCF_REFIT
Valid changes for refitting in a depot.
Definition: train.h:51
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
GetRailType
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
RailTypes
RailTypes
Allow incrementing of Track variables.
Definition: rail_type.h:44
GroundVehicleCache::last_speed
uint16_t last_speed
The last speed we did display, so we only have to redraw when this changes.
Definition: ground_vehicle.hpp:47
Train::HasToUseGetSlopePixelZ
bool HasToUseGetSlopePixelZ()
Trains can always use the faster algorithm because they have always the same direction as the track u...
Definition: train.h:351
Vehicle::IsArticulatedPart
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:950
Train::MarkDirty
void MarkDirty() override
Goods at the consist have changed, update the graphics, cargo, and acceleration.
Definition: train_cmd.cpp:2965
VehicleCache::cached_max_speed
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:124
VRF_LEAVING_STATION
@ VRF_LEAVING_STATION
Train is just leaving a station.
Definition: train.h:33
Train::GetAccelerationType
int GetAccelerationType() const
Allows to know the acceleration type of a vehicle.
Definition: train.h:304
Train::Crash
uint Crash(bool flooded=false) override
The train vehicle crashed! Update its status and other parts around it.
Definition: train_cmd.cpp:3109
Train::GetRollingFriction
uint32_t GetRollingFriction() const
Returns the rolling friction coefficient of this vehicle.
Definition: train.h:292
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:33
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
VRF_TRAIN_STUCK
@ VRF_TRAIN_STUCK
Train can't get a path reservation.
Definition: train.h:32
Train::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const override
Get the tracks of the train vehicle.
Definition: train_cmd.cpp:4224
Train::UpdateDeltaXY
void UpdateDeltaXY() override
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: train_cmd.cpp:1464
RailVehicleInfo::air_drag
byte air_drag
Coefficient of air drag.
Definition: engine_type.h:61
newgrf_engine.h
Train::~Train
virtual ~Train()
We want to 'destruct' the right class.
Definition: train.h:109
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:260
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:319
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:131
rail_map.h
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:341
CCF_ARRANGE
@ CCF_ARRANGE
Valid changes for arranging the consist in a depot.
Definition: train.h:52
GroundVehicle< Train, VEH_TRAIN >::gcache
GroundVehicleCache gcache
Cache of often calculated values.
Definition: ground_vehicle.hpp:80
Vehicle::GetExpenseType
virtual ExpensesType GetExpenseType([[maybe_unused]] bool income) const
Sets the expense type associated to this vehicle type.
Definition: vehicle_base.h:462
Train::GetCurveSpeedModifier
int GetCurveSpeedModifier() const
Returns the curve speed modifier of this vehicle.
Definition: train.h:331
Vehicle::cur_speed
uint16_t cur_speed
current speed
Definition: vehicle_base.h:324
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:55
Train::GetMaxWeight
uint16_t GetMaxWeight() const override
Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
Definition: train_cmd.cpp:4241
Train::GetWeight
uint16_t GetWeight() const
Allows to know the weight value that this vehicle will use.
Definition: train.h:219
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:34
TRACK_BIT_X
@ TRACK_BIT_X
X-axis track.
Definition: track_type.h:37
Train
'Train' is either a loco or a wagon.
Definition: train.h:89
FreeTrainTrackReservation
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
Definition: train_cmd.cpp:2395
Train::Train
Train()
We don't want GCC to zero our struct! It already is zeroed and has an index!
Definition: train.h:107
rail.h
VRF_REVERSE_DIRECTION
@ VRF_REVERSE_DIRECTION
Reverse the visible direction of the vehicle.
Definition: train.h:28
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ConsistChangeFlags
ConsistChangeFlags
Flags for Train::ConsistChanged.
Definition: train.h:44
Train::GetAirDragArea
byte GetAirDragArea() const
Gets the area used for calculating air drag.
Definition: train.h:255
CCF_SAVELOAD
@ CCF_SAVELOAD
Valid changes when loading a savegame. (Everything that is not stored in the save....
Definition: train.h:53
PROP_TRAIN_CURVE_SPEED_MOD
@ PROP_TRAIN_CURVE_SPEED_MOD
Modifier to maximum speed in curves.
Definition: newgrf_properties.h:31
GetTrainStopLocation
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.
Definition: train_cmd.cpp:264
Train::ReserveTrackUnderConsist
void ReserveTrackUnderConsist() const
Tries to reserve track under whole train consist.
Definition: train_cmd.cpp:3087
TrainForceProceeding
TrainForceProceeding
Modes for ignoring signals.
Definition: train.h:37
Vehicle::direction
Direction direction
facing
Definition: vehicle_base.h:303
Train::GetCurveSpeedLimit
int GetCurveSpeedLimit() const
Computes train speed limit caused by curves.
Definition: train_cmd.cpp:308
RailTypeInfo::max_speed
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition: rail.h:231
TRACK_BIT_DEPOT
@ TRACK_BIT_DEPOT
Bitflag for a depot.
Definition: track_type.h:53
Train::OnNewEconomyDay
void OnNewEconomyDay() override
Economy day handler.
Definition: train_cmd.cpp:4186
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:362
CCF_AUTOREFIT
@ CCF_AUTOREFIT
Valid changes for autorefitting in stations.
Definition: train.h:50
PROP_TRAIN_WEIGHT
@ PROP_TRAIN_WEIGHT
Weight in t (if dualheaded: for each single vehicle)
Definition: newgrf_properties.h:25
CCF_LOADUNLOAD
@ CCF_LOADUNLOAD
Valid changes while vehicle is loading/unloading.
Definition: train.h:49
Train::GetAirDrag
byte GetAirDrag() const
Gets the air drag coefficient of this vehicle.
Definition: train.h:265
TryPathReserve
bool TryPathReserve(Train *v, bool mark_as_stuck=false, bool first_tile_okay=false)
Try to reserve a path to a safe position.
Definition: train_cmd.cpp:2860
Train::ConsistChanged
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
Definition: train_cmd.cpp:111
GetTrainSpriteSize
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).
Definition: train_cmd.cpp:581
Train::GetSlopeSteepness
uint32_t GetSlopeSteepness() const
Returns the slope steepness used by this vehicle.
Definition: train.h:313
Train::UpdateAcceleration
void UpdateAcceleration()
Update acceleration of the train from the cached power and weight.
Definition: train_cmd.cpp:430
Train::GetPrevUnit
Train * GetPrevUnit()
Get the previous real (non-articulated part and non rear part of dualheaded engine) vehicle in the co...
Definition: train.h:161
GroundVehicle
Base class for all vehicles that move through ground.
Definition: ground_vehicle.hpp:79
cargotype.h
Train::GetPoweredPartPower
uint16_t GetPoweredPartPower(const Train *head) const
Returns a value if this articulated part is powered.
Definition: train.h:205
Train::GetMaxTrackSpeed
uint16_t GetMaxTrackSpeed() const
Gets the maximum speed allowed by the track for this vehicle.
Definition: train.h:322
TrainCache::cached_max_curve_speed
int cached_max_curve_speed
max consist speed limited by curves
Definition: train.h:83
enum_type.hpp
ClosestDepot
Structure to return information about the closest depot location, and whether it could be found.
Definition: vehicle_base.h:226
Train::GetImage
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override
Get the sprite to display the train.
Definition: train_cmd.cpp:494
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
Train::FindClosestDepot
ClosestDepot FindClosestDepot() override
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: train_cmd.cpp:2182
TrackBits
TrackBits
Allow incrementing of Track variables.
Definition: track_type.h:35
ground_vehicle.hpp
TrainCache
Variables that are cached to improve performance and such.
Definition: train.h:72
EXPENSES_TRAIN_RUN
@ EXPENSES_TRAIN_RUN
Running costs trains.
Definition: economy_type.h:175
OverflowSafeInt< int64_t >
TFP_SIGNAL
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
Definition: train.h:40
CCF_LENGTH
@ CCF_LENGTH
Allow vehicles to change length.
Definition: train.h:45
CheckTrainsLengths
void CheckTrainsLengths()
Checks if lengths of all rail vehicles are valid.
Definition: train_cmd.cpp:77
engine_base.h
Train::GetOrderStationLocation
TileIndex GetOrderStationLocation(StationID station) override
Get the location of the next station to visit.
Definition: train_cmd.cpp:2950
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:337
Train::GetNextUnit
Train * GetNextUnit() const
Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consis...
Definition: train.h:149
TRACK_BIT_Y
@ TRACK_BIT_Y
Y-axis track.
Definition: track_type.h:38
Train::CalcNextVehicleOffset
int CalcNextVehicleOffset() const
Calculate the offset from this vehicle's center to the following center taking the vehicle lengths in...
Definition: train.h:173
CCF_TRACK
@ CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition: train.h:48
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:626
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:67
Train::GetPower
uint16_t GetPower() const
Allows to know the power value that this vehicle will use.
Definition: train.h:188
TFP_NONE
@ TFP_NONE
Normal operation.
Definition: train.h:38
TFP_STUCK
@ TFP_STUCK
Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
Definition: train.h:39
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Train::Tick
bool Tick() override
Update train vehicle data for a tick.
Definition: train_cmd.cpp:4108
HasPowerOnRail
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:335
AS_BRAKE
@ AS_BRAKE
We want to stop.
Definition: ground_vehicle.hpp:22
ExpensesType
ExpensesType
Types of expenses.
Definition: economy_type.h:172
PROP_TRAIN_POWER
@ PROP_TRAIN_POWER
Power in hp (if dualheaded: sum of both vehicles)
Definition: newgrf_properties.h:22
GroundVehicleCache::cached_veh_length
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...
Definition: ground_vehicle.hpp:44
Train::wait_counter
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:104
Train::GetDisplayMaxSpeed
int GetDisplayMaxSpeed() const override
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: train.h:120
RailTypeInfo::acceleration_type
uint8_t acceleration_type
Acceleration type of this rail type.
Definition: rail.h:226
SpecializedVehicle< Train, Type >::GetPrevVehicle
Train * GetPrevVehicle() const
Get the previous real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1176
SpriteGroup
Definition: newgrf_spritegroup.h:57
AccelStatus
AccelStatus
What is the status of our acceleration?
Definition: ground_vehicle.hpp:20
NormalizeTrainVehInDepot
void NormalizeTrainVehInDepot(const Train *u)
Move all free vehicles in the depot to the train.
Definition: train_cmd.cpp:693
VehicleSettings::train_slope_steepness
uint8_t train_slope_steepness
Steepness of hills for trains when using realistic acceleration.
Definition: settings_type.h:519
Train::GetDisplaySpeed
int GetDisplaySpeed() const override
Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: train.h:119
Train::PlayLeaveStationSound
void PlayLeaveStationSound(bool force=false) const override
Play a sound for a train leaving the station.
Definition: train_cmd.cpp:2191
GroundVehicle< Train, VEH_TRAIN >::IsMultiheaded
bool IsMultiheaded() const
Check if the vehicle is a multiheaded engine.
Definition: ground_vehicle.hpp:327
FreightWagonMult
byte FreightWagonMult(CargoID cargo)
Return the cargo weight multiplier to use for a rail vehicle.
Definition: train_cmd.cpp:70
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103