OpenTTD
roadveh.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 ROADVEH_H
11 #define ROADVEH_H
12 
13 #include "ground_vehicle.hpp"
14 #include "engine_base.h"
15 #include "cargotype.h"
16 #include "track_func.h"
17 #include "road.h"
18 #include "road_map.h"
19 #include "newgrf_engine.h"
20 #include <deque>
21 
22 struct RoadVehicle;
23 
26  /*
27  * Lower 4 bits are used for vehicle track direction. (Trackdirs)
28  * When in a road stop (bit 5 or bit 6 set) these bits give the
29  * track direction of the entry to the road stop.
30  * As the entry direction will always be a diagonal
31  * direction (X_NE, Y_SE, X_SW or Y_NW) only bits 0 and 3
32  * are needed to hold this direction. Bit 1 is then used to show
33  * that the vehicle is using the second road stop bay.
34  * Bit 2 is then used for drive-through stops to show the vehicle
35  * is stopping at this road stop.
36  */
37 
38  /* Numeric values */
39  RVSB_IN_DEPOT = 0xFE,
40  RVSB_WORMHOLE = 0xFF,
41 
42  /* Bit numbers */
48 
49  /* Bit sets of the above specified bits */
51  RVSB_IN_ROAD_STOP_END = RVSB_IN_ROAD_STOP + TRACKDIR_END,
53  RVSB_IN_DT_ROAD_STOP_END = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,
54 
56 
59 };
60 
62 static const uint RDE_NEXT_TILE = 0x80;
63 static const uint RDE_TURNED = 0x40;
64 
65 /* Start frames for when a vehicle enters a tile/changes its state.
66  * The start frame is different for vehicles that turned around or
67  * are leaving the depot as the do not start at the edge of the tile.
68  * For trams there are a few different start frames as there are two
69  * places where trams can turn. */
70 static const uint RVC_DEFAULT_START_FRAME = 0;
71 static const uint RVC_TURN_AROUND_START_FRAME = 1;
72 static const uint RVC_DEPOT_START_FRAME = 6;
73 static const uint RVC_START_FRAME_AFTER_LONG_TRAM = 21;
74 static const uint RVC_TURN_AROUND_START_FRAME_SHORT_TRAM = 16;
75 /* Stop frame for a vehicle in a drive-through stop */
76 static const uint RVC_DRIVE_THROUGH_STOP_FRAME = 11;
77 static const uint RVC_DEPOT_STOP_FRAME = 11;
78 
80 static const byte RV_OVERTAKE_TIMEOUT = 35;
81 
82 void RoadVehUpdateCache(RoadVehicle *v, bool same_length = false);
83 void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
84 
86  std::deque<Trackdir> td;
87  std::deque<TileIndex> tile;
88 
89  inline bool empty() const { return this->td.empty(); }
90 
91  inline size_t size() const
92  {
93  assert(this->td.size() == this->tile.size());
94  return this->td.size();
95  }
96 
97  inline void clear()
98  {
99  this->td.clear();
100  this->tile.clear();
101  }
102 };
103 
107 struct RoadVehicle FINAL : public GroundVehicle<RoadVehicle, VEH_ROAD> {
109  byte state;
110  byte frame;
111  uint16 blocked_ctr;
112  byte overtaking;
114  uint16 crashed_ctr;
115  byte reverse_ctr;
116 
119 
123  virtual ~RoadVehicle() { this->PreDestructor(); }
124 
125  friend struct GroundVehicle<RoadVehicle, VEH_ROAD>; // GroundVehicle needs to use the acceleration functions defined at RoadVehicle.
126 
127  void MarkDirty();
128  void UpdateDeltaXY();
129  ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_INC : EXPENSES_ROADVEH_RUN; }
130  bool IsPrimaryVehicle() const { return this->IsFrontEngine(); }
131  void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const;
132  int GetDisplaySpeed() const { return this->gcache.last_speed / 2; }
133  int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed / 2; }
134  Money GetRunningCost() const;
135  int GetDisplayImageWidth(Point *offset = nullptr) const;
136  bool IsInDepot() const { return this->state == RVSB_IN_DEPOT; }
137  bool Tick();
138  void OnNewDay();
139  uint Crash(bool flooded = false);
141  TileIndex GetOrderStationLocation(StationID station);
142  bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
143 
144  bool IsBus() const;
145 
146  int GetCurrentMaxSpeed() const;
147  int UpdateSpeed();
148  void SetDestTile(TileIndex tile);
149 
150 protected: // These functions should not be called outside acceleration code.
151 
156  inline uint16 GetPower() const
157  {
158  /* Power is not added for articulated parts */
159  if (!this->IsArticulatedPart()) {
160  /* Road vehicle power is in units of 10 HP. */
161  return 10 * GetVehicleProperty(this, PROP_ROADVEH_POWER, RoadVehInfo(this->engine_type)->power);
162  }
163  return 0;
164  }
165 
170  inline uint16 GetPoweredPartPower(const RoadVehicle *head) const
171  {
172  return 0;
173  }
174 
179  inline uint16 GetWeight() const
180  {
181  uint16 weight = (CargoSpec::Get(this->cargo_type)->weight * this->cargo.StoredCount()) / 16;
182 
183  /* Vehicle weight is not added for articulated parts. */
184  if (!this->IsArticulatedPart()) {
185  /* Road vehicle weight is in units of 1/4 t. */
186  weight += GetVehicleProperty(this, PROP_ROADVEH_WEIGHT, RoadVehInfo(this->engine_type)->weight) / 4;
187  }
188 
189  return weight;
190  }
191 
196  inline byte GetTractiveEffort() const
197  {
198  /* The tractive effort coefficient is in units of 1/256. */
199  return GetVehicleProperty(this, PROP_ROADVEH_TRACTIVE_EFFORT, RoadVehInfo(this->engine_type)->tractive_effort);
200  }
201 
206  inline byte GetAirDragArea() const
207  {
208  return 6;
209  }
210 
215  inline byte GetAirDrag() const
216  {
217  return RoadVehInfo(this->engine_type)->air_drag;
218  }
219 
225  {
226  return (this->vehstatus & VS_STOPPED) ? AS_BRAKE : AS_ACCEL;
227  }
228 
233  inline uint16 GetCurrentSpeed() const
234  {
235  return this->cur_speed / 2;
236  }
237 
242  inline uint32 GetRollingFriction() const
243  {
244  /* Trams have a slightly greater friction coefficient than trains.
245  * The rest of road vehicles have bigger values. */
246  uint32 coeff = RoadTypeIsTram(this->roadtype) ? 40 : 75;
247  /* The friction coefficient increases with speed in a way that
248  * it doubles at 128 km/h, triples at 256 km/h and so on. */
249  return coeff * (128 + this->GetCurrentSpeed()) / 128;
250  }
251 
256  inline int GetAccelerationType() const
257  {
258  return 0;
259  }
260 
265  inline uint32 GetSlopeSteepness() const
266  {
268  }
269 
274  inline uint16 GetMaxTrackSpeed() const
275  {
276  return GetRoadTypeInfo(GetRoadType(this->tile, GetRoadTramType(this->roadtype)))->max_speed;
277  }
278 
283  inline bool TileMayHaveSlopedTrack() const
284  {
285  TrackStatus ts = GetTileTrackStatus(this->tile, TRANSPORT_ROAD, GetRoadTramType(this->roadtype));
286  TrackBits trackbits = TrackStatusToTrackBits(ts);
287 
288  return trackbits == TRACK_BIT_X || trackbits == TRACK_BIT_Y;
289  }
290 
299  {
300  const RoadVehicle *rv = this->First();
301 
302  /* Check if this vehicle is in the same direction as the road under.
303  * We already know it has either GVF_GOINGUP_BIT or GVF_GOINGDOWN_BIT set. */
304 
306  /* If the first vehicle is reversing, this vehicle may be reversing too
307  * (especially if this is the first, and maybe the only, vehicle).*/
308  return true;
309  }
310 
311  while (rv != this) {
312  /* If any previous vehicle has different direction,
313  * we may be in the middle of reversing. */
314  if (this->direction != rv->direction) return true;
315  rv = rv->Next();
316  }
317 
318  return false;
319  }
320 };
321 
322 #endif /* ROADVEH_H */
VehicleSettings vehicle
options for vehicles
Vehicle is stopped by the player.
Definition: vehicle_base.h:31
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:307
byte state
Definition: roadveh.h:109
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:79
Functions for NewGRF engines.
virtual void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Definition: vehicle_base.h:362
Direction direction
facing
Definition: vehicle_base.h:269
uint8 weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
Definition: cargotype.h:60
AccelStatus
What is the status of our acceleration?
static const uint RDE_TURNED
We just finished turning.
Definition: roadveh.h:63
static bool IsReversingRoadTrackdir(Trackdir dir)
Checks whether the trackdir means that we are reversing.
Definition: track_func.h:681
uint16 GetPower() const
Allows to know the power value that this vehicle will use.
Definition: roadveh.h:156
The vehicle is at the opposite side of the road.
Definition: roadveh.h:55
RoadTypes
The different roadtypes we support, but then a bitmask of them.
Definition: road_type.h:36
The vehicle is in a drive-through road stop.
Definition: roadveh.h:47
Map accessors for roads.
AccelStatus GetAccelerationStatus() const
Checks the current acceleration status of this vehicle.
Definition: roadveh.h:224
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:70
uint16 cur_speed
current speed
Definition: vehicle_base.h:291
int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: roadveh.h:133
bool TileMayHaveSlopedTrack() const
Checks if the vehicle is at a tile that can be sloped.
Definition: roadveh.h:283
Road specific functions.
RoadVehicle()
We don&#39;t want GCC to zero our struct! It already is zeroed and has an index!
Definition: roadveh.h:121
X-axis track.
Definition: track_type.h:40
static const uint RDE_NEXT_TILE
State information about the Road Vehicle controller.
Definition: roadveh.h:62
Only used when retrieving move data.
Definition: roadveh.h:45
ExpensesType GetExpenseType(bool income) const
Sets the expense type associated to this vehicle type.
Definition: roadveh.h:129
virtual void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
Definition: vehicle_base.h:440
uint32 GetSlopeSteepness() const
Returns the slope steepness used by this vehicle.
Definition: roadveh.h:265
T * First() const
Get the first vehicle in the chain.
Definition: vehicle_base.h:996
RoadType
The different roadtypes we support.
Definition: road_type.h:22
uint16 GetMaxTrackSpeed() const
Gets the maximum speed allowed by the track for this vehicle.
Definition: roadveh.h:274
byte vehstatus
Status.
Definition: vehicle_base.h:315
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition: cargopacket.h:351
byte overtaking
Set to RVSB_DRIVE_SIDE when overtaking, otherwise 0.
Definition: roadveh.h:112
uint16 cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:121
RoadVehicleStates
Road vehicle states.
Definition: roadveh.h:25
Buses, trucks and trams belong to this class.
Definition: roadveh.h:107
RoadType roadtype
Roadtype of this vehicle.
Definition: roadveh.h:117
static const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition: road.h:224
The vehicle is in a road stop.
Definition: roadveh.h:46
Used for iterations.
Definition: track_type.h:88
virtual bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: vehicle_base.h:748
We want to stop.
The vehicle is in a tunnel and/or bridge.
Definition: roadveh.h:40
T * Next() const
Get next vehicle in the chain.
Weight in 1/4 t.
byte GetAirDragArea() const
Gets the area used for calculating air drag.
Definition: roadveh.h:206
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:890
Direction
Defines the 8 directions on the map.
Only used while in a road stop.
Definition: roadveh.h:43
virtual int GetCurrentMaxSpeed() const
Calculates the maximum speed of the vehicle under its current conditions.
Definition: vehicle_base.h:490
The vehicle is in a depot.
Definition: roadveh.h:39
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:303
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:38
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:881
TileIndex tile
Current tile index.
Definition: vehicle_base.h:228
uint16 max_speed
Maximum speed for vehicles travelling on this road type.
Definition: road.h:139
virtual void UpdateDeltaXY()
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: vehicle_base.h:368
Power in 10 HP.
bool HasToUseGetSlopePixelZ()
Road vehicles have to use GetSlopePixelZ() to compute their height if they are reversing because in t...
Definition: roadveh.h:298
uint16 GetPoweredPartPower(const RoadVehicle *head) const
Returns a value if this articulated part is powered.
Definition: roadveh.h:170
virtual ~RoadVehicle()
We want to &#39;destruct&#39; the right class.
Definition: roadveh.h:123
virtual TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Definition: vehicle_base.h:738
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:128
byte GetTractiveEffort() const
Allows to know the tractive effort value that this vehicle will use.
Definition: roadveh.h:196
We want to go faster, if possible of course.
uint16 crashed_ctr
Animation counter when the vehicle has crashed.
Definition: roadveh.h:114
byte GetAirDrag() const
Gets the air drag coefficient of this vehicle.
Definition: roadveh.h:215
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:589
bool IsInDepot() const
Check whether the vehicle is in the depot.
Definition: roadveh.h:136
uint16 last_speed
The last speed we did display, so we only have to redraw when this changes.
virtual Money GetRunningCost() const
Gets the running cost of a vehicle.
Definition: vehicle_base.h:496
static const byte RV_OVERTAKE_TIMEOUT
The number of ticks a vehicle has for overtaking.
Definition: roadveh.h:80
The vehicle is in a drive-through road stop.
Definition: roadveh.h:52
uint Crash(bool flooded) override
Common code executed for crashed ground vehicles.
static void OnNewDay()
Runs various procedures that have to be done daily.
Definition: date.cpp:244
Base class for engines.
int GetAccelerationType() const
Allows to know the acceleration type of a vehicle.
Definition: roadveh.h:256
Only bits 0 and 3 are used to encode the trackdir for road stops.
Definition: roadveh.h:58
void RoadVehUpdateCache(RoadVehicle *v, bool same_length=false)
Update the cache of a road vehicle.
uint32 GetRollingFriction() const
Returns the rolling friction coefficient of this vehicle.
Definition: roadveh.h:242
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:117
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
Only set when a vehicle has entered the stop.
Definition: roadveh.h:44
static TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition: track_func.h:371
void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a road vehicle sprite heading west (used for lists).
Transport by road vehicle.
The vehicle is in a road stop.
Definition: roadveh.h:50
RoadTypes compatible_roadtypes
Roadtypes this consist is powered on.
Definition: roadveh.h:118
Types/functions related to cargoes.
Coordinates of a point in 2D.
The mask used to extract track dirs.
Definition: roadveh.h:57
Tractive effort coefficient in 1/256.
virtual Trackdir GetVehicleTrackdir() const
Returns the Trackdir on which the vehicle is currently located.
Definition: vehicle_base.h:552
RoadVehPathCache path
Cached path.
Definition: roadveh.h:108
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:286
virtual bool Tick()
Calls the tick handler of the vehicle.
Definition: vehicle_base.h:526
uint8 roadveh_slope_steepness
Steepness of hills for road vehicles when using realistic acceleration.
Income from road vehicles.
Definition: economy_type.h:157
bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: roadveh.h:130
Different conversion functions from one kind of track to another.
int GetDisplaySpeed() const
Gets the speed in km-ish/h that can be sent into SetDParam for string processing. ...
Definition: roadveh.h:132
Base class for all vehicles that move through ground.
Running costs road vehicles.
Definition: economy_type.h:152
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:328
ExpensesType
Types of expenses.
Definition: economy_type.h:148
Y-axis track.
Definition: track_type.h:41
Base class and functions for all vehicles that move through ground.
GroundVehicleCache gcache
Cache of often calculated values.
byte overtaking_ctr
The length of the current overtake attempt.
Definition: roadveh.h:113
uint16 GetCurrentSpeed() const
Calculates the current speed of this vehicle.
Definition: roadveh.h:233
uint16 GetWeight() const
Allows to know the weight value that this vehicle will use.
Definition: roadveh.h:179