src/roadveh.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 src/roadveh.h Road vehicle states */
   9
  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
  21 struct RoadVehicle;
  22
  23 /** Road vehicle states */
  24 enum RoadVehicleStates {
  25         /*
  26          * Lower 4 bits are used for vehicle track direction. (Trackdirs)
  27          * When in a road stop (bit 5 or bit 6 set) these bits give the
  28          * track direction of the entry to the road stop.
  29          * As the entry direction will always be a diagonal
  30          * direction (X_NE, Y_SE, X_SW or Y_NW) only bits 0 and 3
  31          * are needed to hold this direction. Bit 1 is then used to show
  32          * that the vehicle is using the second road stop bay.
  33          * Bit 2 is then used for drive-through stops to show the vehicle
  34          * is stopping at this road stop.
  35          */
  36
  37         /* Numeric values */
  38         RVSB_IN_DEPOT                = 0xFE,                      ///< The vehicle is in a depot
  39         RVSB_WORMHOLE                = 0xFF,                      ///< The vehicle is in a tunnel and/or bridge
  40
  41         /* Bit numbers */
  42         RVS_USING_SECOND_BAY         =    1,                      ///< Only used while in a road stop
  43         RVS_ENTERED_STOP             =    2,                      ///< Only set when a vehicle has entered the stop
  44         RVS_DRIVE_SIDE               =    4,                      ///< Only used when retrieving move data
  45         RVS_IN_ROAD_STOP             =    5,                      ///< The vehicle is in a road stop
  46         RVS_IN_DT_ROAD_STOP          =    6,                      ///< The vehicle is in a drive-through road stop
  47
  48         /* Bit sets of the above specified bits */
  49         RVSB_IN_ROAD_STOP            = 1 << RVS_IN_ROAD_STOP,     ///< The vehicle is in a road stop
  50         RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,
  51         RVSB_IN_DT_ROAD_STOP         = 1 << RVS_IN_DT_ROAD_STOP,  ///< The vehicle is in a drive-through road stop
  52         RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,
  53
  54         RVSB_DRIVE_SIDE              = 1 << RVS_DRIVE_SIDE,       ///< The vehicle is at the opposite side of the road
  55
  56         RVSB_TRACKDIR_MASK           = 0x0F,                      ///< The mask used to extract track dirs
  57         RVSB_ROAD_STOP_TRACKDIR_MASK = 0x09,                      ///< Only bits 0 and 3 are used to encode the trackdir for road stops
  58 };
  59
  60 /** State information about the Road Vehicle controller */
  61 static const uint RDE_NEXT_TILE = 0x80; ///< We should enter the next tile
  62 static const uint RDE_TURNED    = 0x40; ///< We just finished turning
  63
  64 /* Start frames for when a vehicle enters a tile/changes its state.
  65  * The start frame is different for vehicles that turned around or
  66  * are leaving the depot as the do not start at the edge of the tile.
  67  * For trams there are a few different start frames as there are two
  68  * places where trams can turn. */
  69 static const uint RVC_DEFAULT_START_FRAME                =  0;
  70 static const uint RVC_TURN_AROUND_START_FRAME            =  1;
  71 static const uint RVC_DEPOT_START_FRAME                  =  6;
  72 static const uint RVC_START_FRAME_AFTER_LONG_TRAM        = 21;
  73 static const uint RVC_TURN_AROUND_START_FRAME_SHORT_TRAM = 16;
  74 /* Stop frame for a vehicle in a drive-through stop */
  75 static const uint RVC_DRIVE_THROUGH_STOP_FRAME           = 11;
  76 static const uint RVC_DEPOT_STOP_FRAME                   = 11;
  77
  78 /** The number of ticks a vehicle has for overtaking. */
  79 static const uint8_t RV_OVERTAKE_TIMEOUT = 35;
  80
  81 void RoadVehUpdateCache(RoadVehicle *v, bool same_length = false);
  82 void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
  83
  84 struct RoadVehPathCache {
  85         std::deque<Trackdir> td;
  86         std::deque<TileIndex> tile;
  87
  88         inline bool empty() const { return this->td.empty(); }
  89
  90         inline size_t size() const
  91         {
  92                 assert(this->td.size() == this->tile.size());
  93                 return this->td.size();
  94         }
  95
  96         inline void clear()
  97         {
  98                 this->td.clear();
  99                 this->tile.clear();
 100         }
 101 };
 102
 103 /**
 104  * Buses, trucks and trams belong to this class.
 105  */
 106 struct RoadVehicle final : public GroundVehicle<RoadVehicle, VEH_ROAD> {
 107         RoadVehPathCache path;  ///< Cached path.
 108         uint8_t state;             ///< @see RoadVehicleStates
 109         uint8_t frame;
 110         uint16_t blocked_ctr;
 111         uint8_t overtaking;        ///< Set to #RVSB_DRIVE_SIDE when overtaking, otherwise 0.
 112         uint8_t overtaking_ctr;    ///< The length of the current overtake attempt.
 113         uint16_t crashed_ctr;     ///< Animation counter when the vehicle has crashed. @see RoadVehIsCrashed
 114         uint8_t reverse_ctr;
 115
 116         RoadType roadtype; ///< NOSAVE: Roadtype of this vehicle.
 117         VehicleID disaster_vehicle = INVALID_VEHICLE; ///< NOSAVE: Disaster vehicle targetting this vehicle.
 118         RoadTypes compatible_roadtypes; ///< NOSAVE: Roadtypes this consist is powered on.
 119
 120         /** We don't want GCC to zero our struct! It already is zeroed and has an index! */
 121         RoadVehicle() : GroundVehicleBase() {}
 122         /** We want to 'destruct' the right class. */
 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() override;
 128         void UpdateDeltaXY() override;
 129         ExpensesType GetExpenseType(bool income) const override { return income ? EXPENSES_ROADVEH_REVENUE : EXPENSES_ROADVEH_RUN; }
 130         bool IsPrimaryVehicle() const override { return this->IsFrontEngine(); }
 131         void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override;
 132         int GetDisplaySpeed() const override { return this->gcache.last_speed / 2; }
 133         int GetDisplayMaxSpeed() const override { return this->vcache.cached_max_speed / 2; }
 134         Money GetRunningCost() const override;
 135         int GetDisplayImageWidth(Point *offset = nullptr) const;
 136         bool IsInDepot() const override { return this->state == RVSB_IN_DEPOT; }
 137         bool Tick() override;
 138         void OnNewCalendarDay() override;
 139         void OnNewEconomyDay() override;
 140         uint Crash(bool flooded = false) override;
 141         Trackdir GetVehicleTrackdir() const override;
 142         TileIndex GetOrderStationLocation(StationID station) override;
 143         ClosestDepot FindClosestDepot() override;
 144
 145         bool IsBus() const;
 146
 147         int GetCurrentMaxSpeed() const override;
 148         int UpdateSpeed();
 149         void SetDestTile(TileIndex tile) override;
 150
 151 protected: // These functions should not be called outside acceleration code.
 152
 153         /**
 154          * Allows to know the power value that this vehicle will use.
 155          * @return Power value from the engine in HP, or zero if the vehicle is not powered.
 156          */
 157         inline uint16_t GetPower() const
 158         {
 159                 /* Power is not added for articulated parts */
 160                 if (!this->IsArticulatedPart()) {
 161                         /* Road vehicle power is in units of 10 HP. */
 162                         return 10 * GetVehicleProperty(this, PROP_ROADVEH_POWER, RoadVehInfo(this->engine_type)->power);
 163                 }
 164                 return 0;
 165         }
 166
 167         /**
 168          * Returns a value if this articulated part is powered.
 169          * @return Zero, because road vehicles don't have powered parts.
 170          */
 171         inline uint16_t GetPoweredPartPower(const RoadVehicle *) const
 172         {
 173                 return 0;
 174         }
 175
 176         /**
 177          * Allows to know the weight value that this vehicle will use.
 178          * @return Weight value from the engine in tonnes.
 179          */
 180         inline uint16_t GetWeight() const
 181         {
 182                 uint16_t weight = CargoSpec::Get(this->cargo_type)->WeightOfNUnits(this->cargo.StoredCount());
 183
 184                 /* Vehicle weight is not added for articulated parts. */
 185                 if (!this->IsArticulatedPart()) {
 186                         /* Road vehicle weight is in units of 1/4 t. */
 187                         weight += GetVehicleProperty(this, PROP_ROADVEH_WEIGHT, RoadVehInfo(this->engine_type)->weight) / 4;
 188                 }
 189
 190                 return weight;
 191         }
 192
 193         /**
 194          * Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
 195          * @return Weight value in tonnes.
 196          */
 197         uint16_t GetMaxWeight() const override;
 198
 199         /**
 200          * Allows to know the tractive effort value that this vehicle will use.
 201          * @return Tractive effort value from the engine.
 202          */
 203         inline uint8_t GetTractiveEffort() const
 204         {
 205                 /* The tractive effort coefficient is in units of 1/256.  */
 206                 return GetVehicleProperty(this, PROP_ROADVEH_TRACTIVE_EFFORT, RoadVehInfo(this->engine_type)->tractive_effort);
 207         }
 208
 209         /**
 210          * Gets the area used for calculating air drag.
 211          * @return Area of the engine in m^2.
 212          */
 213         inline uint8_t GetAirDragArea() const
 214         {
 215                 return 6;
 216         }
 217
 218         /**
 219          * Gets the air drag coefficient of this vehicle.
 220          * @return Air drag value from the engine.
 221          */
 222         inline uint8_t GetAirDrag() const
 223         {
 224                 return RoadVehInfo(this->engine_type)->air_drag;
 225         }
 226
 227         /**
 228          * Checks the current acceleration status of this vehicle.
 229          * @return Acceleration status.
 230          */
 231         inline AccelStatus GetAccelerationStatus() const
 232         {
 233                 return (this->vehstatus & VS_STOPPED) ? AS_BRAKE : AS_ACCEL;
 234         }
 235
 236         /**
 237          * Calculates the current speed of this vehicle.
 238          * @return Current speed in km/h-ish.
 239          */
 240         inline uint16_t GetCurrentSpeed() const
 241         {
 242                 return this->cur_speed / 2;
 243         }
 244
 245         /**
 246          * Returns the rolling friction coefficient of this vehicle.
 247          * @return Rolling friction coefficient in [1e-4].
 248          */
 249         inline uint32_t GetRollingFriction() const
 250         {
 251                 /* Trams have a slightly greater friction coefficient than trains.
 252                  * The rest of road vehicles have bigger values. */
 253                 uint32_t coeff = RoadTypeIsTram(this->roadtype) ? 40 : 75;
 254                 /* The friction coefficient increases with speed in a way that
 255                  * it doubles at 128 km/h, triples at 256 km/h and so on. */
 256                 return coeff * (128 + this->GetCurrentSpeed()) / 128;
 257         }
 258
 259         /**
 260          * Allows to know the acceleration type of a vehicle.
 261          * @return Zero, road vehicles always use a normal acceleration method.
 262          */
 263         inline int GetAccelerationType() const
 264         {
 265                 return 0;
 266         }
 267
 268         /**
 269          * Returns the slope steepness used by this vehicle.
 270          * @return Slope steepness used by the vehicle.
 271          */
 272         inline uint32_t GetSlopeSteepness() const
 273         {
 274                 return _settings_game.vehicle.roadveh_slope_steepness;
 275         }
 276
 277         /**
 278          * Gets the maximum speed allowed by the track for this vehicle.
 279          * @return Since roads don't limit road vehicle speed, it returns always zero.
 280          */
 281         inline uint16_t GetMaxTrackSpeed() const
 282         {
 283                 return GetRoadTypeInfo(GetRoadType(this->tile, GetRoadTramType(this->roadtype)))->max_speed;
 284         }
 285
 286         /**
 287          * Checks if the vehicle is at a tile that can be sloped.
 288          * @return True if the tile can be sloped.
 289          */
 290         inline bool TileMayHaveSlopedTrack() const
 291         {
 292                 TrackStatus ts = GetTileTrackStatus(this->tile, TRANSPORT_ROAD, GetRoadTramType(this->roadtype));
 293                 TrackBits trackbits = TrackStatusToTrackBits(ts);
 294
 295                 return trackbits == TRACK_BIT_X || trackbits == TRACK_BIT_Y;
 296         }
 297
 298         /**
 299          * Road vehicles have to use GetSlopePixelZ() to compute their height
 300          * if they are reversing because in that case, their direction
 301          * is not parallel with the road. It is safe to return \c true
 302          * even if it is not reversing.
 303          * @return are we (possibly) reversing?
 304          */
 305         inline bool HasToUseGetSlopePixelZ()
 306         {
 307                 const RoadVehicle *rv = this->First();
 308
 309                 /* Check if this vehicle is in the same direction as the road under.
 310                  * We already know it has either GVF_GOINGUP_BIT or GVF_GOINGDOWN_BIT set. */
 311
 312                 if (rv->state <= RVSB_TRACKDIR_MASK && IsReversingRoadTrackdir((Trackdir)rv->state)) {
 313                         /* If the first vehicle is reversing, this vehicle may be reversing too
 314                          * (especially if this is the first, and maybe the only, vehicle).*/
 315                         return true;
 316                 }
 317
 318                 while (rv != this) {
 319                         /* If any previous vehicle has different direction,
 320                          * we may be in the middle of reversing. */
 321                         if (this->direction != rv->direction) return true;
 322                         rv = rv->Next();
 323                 }
 324
 325                 return false;
 326         }
 327 };
 328
 329 #endif /* ROADVEH_H */