src/train.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file train.h Base for the train class. */
  11
  12 #ifndef TRAIN_H
  13 #define TRAIN_H
  14
  15 #include "core/enum_type.hpp"
  16
  17 #include "newgrf_engine.h"
  18 #include "cargotype.h"
  19 #include "rail.h"
  20 #include "engine_base.h"
  21 #include "rail_map.h"
  22 #include "ground_vehicle.hpp"
  23
  24 struct Train;
  25
  26 /** Rail vehicle flags. */
  27 enum VehicleRailFlags {
  28         VRF_REVERSING                     = 0,
  29         VRF_POWEREDWAGON                  = 3, ///< Wagon is powered.
  30         VRF_REVERSE_DIRECTION             = 4, ///< Reverse the visible direction of the vehicle.
  31
  32         VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6, ///< Electric train engine is allowed to run on normal rail. */
  33         VRF_TOGGLE_REVERSE                = 7, ///< Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle only).
  34         VRF_TRAIN_STUCK                   = 8, ///< Train can't get a path reservation.
  35         VRF_LEAVING_STATION               = 9, ///< Train is just leaving a station.
  36 };
  37
  38 /** Modes for ignoring signals. */
  39 enum TrainForceProceeding {
  40         TFP_NONE   = 0,    ///< Normal operation.
  41         TFP_STUCK  = 1,    ///< Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
  42         TFP_SIGNAL = 2,    ///< Ignore next signal, after the signal ignore being stuck.
  43 };
  44 typedef SimpleTinyEnumT<TrainForceProceeding, byte> TrainForceProceedingByte;
  45
  46 /** Flags for Train::ConsistChanged */
  47 enum ConsistChangeFlags {
  48         CCF_LENGTH     = 0x01,     ///< Allow vehicles to change length.
  49         CCF_CAPACITY   = 0x02,     ///< Allow vehicles to change capacity.
  50
  51         CCF_TRACK      = 0,                          ///< Valid changes while vehicle is driving, and possibly changing tracks.
  52         CCF_LOADUNLOAD = 0,                          ///< Valid changes while vehicle is loading/unloading.
  53         CCF_AUTOREFIT  = CCF_CAPACITY,               ///< Valid changes for autorefitting in stations.
  54         CCF_REFIT      = CCF_LENGTH | CCF_CAPACITY,  ///< Valid changes for refitting in a depot.
  55         CCF_ARRANGE    = CCF_LENGTH | CCF_CAPACITY,  ///< Valid changes for arranging the consist in a depot.
  56         CCF_SAVELOAD   = CCF_LENGTH,                 ///< Valid changes when loading a savegame. (Everything that is not stored in the save.)
  57 };
  58 DECLARE_ENUM_AS_BIT_SET(ConsistChangeFlags)
  59
  60 byte FreightWagonMult(CargoID cargo);
  61
  62 void CheckTrainsLengths();
  63
  64 void FreeTrainTrackReservation(const Train *v);
  65 bool TryPathReserve(Train *v, bool mark_as_stuck = false, bool first_tile_okay = false);
  66
  67 int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length);
  68
  69 void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
  70
  71 /** Variables that are cached to improve performance and such */
  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;           ///< train can tilt; feature provides a bonus in curves
  78
  79         byte user_def_data;         ///< Cached property 0x25. Can be set by Callback 0x36.
  80
  81         /* cached max. speed / acceleration data */
  82         int cached_max_curve_speed; ///< max consist speed limited by curves
  83 };
  84
  85 /**
  86  * 'Train' is either a loco or a wagon.
  87  */
  88 struct Train FINAL : public GroundVehicle<Train, VEH_TRAIN> {
  89         TrainCache tcache;
  90
  91         /* Link between the two ends of a multiheaded engine */
  92         Train *other_multiheaded_part;
  93
  94         uint16 crash_anim_pos; ///< Crash animation counter.
  95
  96         uint16 flags;
  97         TrackBitsByte track;
  98         TrainForceProceedingByte force_proceed;
  99         RailTypeByte railtype;
 100         RailTypes compatible_railtypes;
 101
 102         /** Ticks waiting in front of a signal, ticks being stuck or a counter for forced proceeding through signals. */
 103         uint16 wait_counter;
 104
 105         /** We don't want GCC to zero our struct! It already is zeroed and has an index! */
 106         Train() : GroundVehicleBase() {}
 107         /** We want to 'destruct' the right class. */
 108         virtual ~Train() { this->PreDestructor(); }
 109
 110         friend struct GroundVehicle<Train, VEH_TRAIN>; // GroundVehicle needs to use the acceleration functions defined at Train.
 111
 112         void MarkDirty();
 113         void UpdateDeltaXY(Direction direction);
 114         ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_TRAIN_INC : EXPENSES_TRAIN_RUN; }
 115         void PlayLeaveStationSound() const;
 116         bool IsPrimaryVehicle() const { return this->IsFrontEngine(); }
 117         void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const;
 118         int GetDisplaySpeed() const { return this->gcache.last_speed; }
 119         int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed; }
 120         Money GetRunningCost() const;
 121         int GetDisplayImageWidth(Point *offset = NULL) const;
 122         bool IsInDepot() const { return this->track == TRACK_BIT_DEPOT; }
 123         bool Tick();
 124         void OnNewDay();
 125         uint Crash(bool flooded = false);
 126         Trackdir GetVehicleTrackdir() const;
 127         TileIndex GetOrderStationLocation(StationID station);
 128         bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
 129
 130         void ReserveTrackUnderConsist() const;
 131
 132         int GetCurveSpeedLimit() const;
 133
 134         void ConsistChanged(ConsistChangeFlags allowed_changes);
 135
 136         int UpdateSpeed();
 137
 138         void UpdateAcceleration();
 139
 140         int GetCurrentMaxSpeed() const;
 141
 142         /**
 143          * Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consist.
 144          * @return Next vehicle in the consist.
 145          */
 146         inline Train *GetNextUnit() const
 147         {
 148                 Train *v = this->GetNextVehicle();
 149                 if (v != NULL && v->IsRearDualheaded()) v = v->GetNextVehicle();
 150
 151                 return v;
 152         }
 153
 154         /**
 155          * Get the previous real (non-articulated part and non rear part of dualheaded engine) vehicle in the consist.
 156          * @return Previous vehicle in the consist.
 157          */
 158         inline Train *GetPrevUnit()
 159         {
 160                 Train *v = this->GetPrevVehicle();
 161                 if (v != NULL && v->IsRearDualheaded()) v = v->GetPrevVehicle();
 162
 163                 return v;
 164         }
 165
 166         /**
 167          * Calculate the offset from this vehicle's center to the following center taking the vehicle lengths into account.
 168          * @return Offset from center to center.
 169          */
 170         int CalcNextVehicleOffset() const
 171         {
 172                 /* For vehicles with odd lengths the part before the center will be one unit
 173                  * longer than the part after the center. This means we have to round up the
 174                  * length of the next vehicle but may not round the length of the current
 175                  * vehicle. */
 176                 return this->gcache.cached_veh_length / 2 + (this->Next() != NULL ? this->Next()->gcache.cached_veh_length + 1 : 0) / 2;
 177         }
 178
 179 protected: // These functions should not be called outside acceleration code.
 180
 181         /**
 182          * Allows to know the power value that this vehicle will use.
 183          * @return Power value from the engine in HP, or zero if the vehicle is not powered.
 184          */
 185         inline uint16 GetPower() const
 186         {
 187                 /* Power is not added for articulated parts */
 188                 if (!this->IsArticulatedPart() && HasPowerOnRail(this->railtype, GetRailType(this->tile))) {
 189                         uint16 power = GetVehicleProperty(this, PROP_TRAIN_POWER, RailVehInfo(this->engine_type)->power);
 190                         /* Halve power for multiheaded parts */
 191                         if (this->IsMultiheaded()) power /= 2;
 192                         return power;
 193                 }
 194
 195                 return 0;
 196         }
 197
 198         /**
 199          * Returns a value if this articulated part is powered.
 200          * @return Power value from the articulated part in HP, or zero if it is not powered.
 201          */
 202         inline uint16 GetPoweredPartPower(const Train *head) const
 203         {
 204                 /* For powered wagons the engine defines the type of engine (i.e. railtype) */
 205                 if (HasBit(this->flags, VRF_POWEREDWAGON) && HasPowerOnRail(head->railtype, GetRailType(this->tile))) {
 206                         return RailVehInfo(this->gcache.first_engine)->pow_wag_power;
 207                 }
 208
 209                 return 0;
 210         }
 211
 212         /**
 213          * Allows to know the weight value that this vehicle will use.
 214          * @return Weight value from the engine in tonnes.
 215          */
 216         inline uint16 GetWeight() const
 217         {
 218                 uint16 weight = (CargoSpec::Get(this->cargo_type)->weight * this->cargo.StoredCount() * FreightWagonMult(this->cargo_type)) / 16;
 219
 220                 /* Vehicle weight is not added for articulated parts. */
 221                 if (!this->IsArticulatedPart()) {
 222                         weight += GetVehicleProperty(this, PROP_TRAIN_WEIGHT, RailVehInfo(this->engine_type)->weight);
 223                 }
 224
 225                 /* Powered wagons have extra weight added. */
 226                 if (HasBit(this->flags, VRF_POWEREDWAGON)) {
 227                         weight += RailVehInfo(this->gcache.first_engine)->pow_wag_weight;
 228                 }
 229
 230                 return weight;
 231         }
 232
 233         /**
 234          * Allows to know the tractive effort value that this vehicle will use.
 235          * @return Tractive effort value from the engine.
 236          */
 237         inline byte GetTractiveEffort() const
 238         {
 239                 return GetVehicleProperty(this, PROP_TRAIN_TRACTIVE_EFFORT, RailVehInfo(this->engine_type)->tractive_effort);
 240         }
 241
 242         /**
 243          * Gets the area used for calculating air drag.
 244          * @return Area of the engine in m^2.
 245          */
 246         inline byte GetAirDragArea() const
 247         {
 248                 /* Air drag is higher in tunnels due to the limited cross-section. */
 249                 return (this->track == TRACK_BIT_WORMHOLE && this->vehstatus & VS_HIDDEN) ? 28 : 14;
 250         }
 251
 252         /**
 253          * Gets the air drag coefficient of this vehicle.
 254          * @return Air drag value from the engine.
 255          */
 256         inline byte GetAirDrag() const
 257         {
 258                 return RailVehInfo(this->engine_type)->air_drag;
 259         }
 260
 261         /**
 262          * Checks the current acceleration status of this vehicle.
 263          * @return Acceleration status.
 264          */
 265         inline AccelStatus GetAccelerationStatus() const
 266         {
 267                 return (this->vehstatus & VS_STOPPED) || HasBit(this->flags, VRF_REVERSING) || HasBit(this->flags, VRF_TRAIN_STUCK) ? AS_BRAKE : AS_ACCEL;
 268         }
 269
 270         /**
 271          * Calculates the current speed of this vehicle.
 272          * @return Current speed in km/h-ish.
 273          */
 274         inline uint16 GetCurrentSpeed() const
 275         {
 276                 return this->cur_speed;
 277         }
 278
 279         /**
 280          * Returns the rolling friction coefficient of this vehicle.
 281          * @return Rolling friction coefficient in [1e-4].
 282          */
 283         inline uint32 GetRollingFriction() const
 284         {
 285                 /* Rolling friction for steel on steel is between 0.1% and 0.2%.
 286                  * The friction coefficient increases with speed in a way that
 287                  * it doubles at 512 km/h, triples at 1024 km/h and so on. */
 288                 return 15 * (512 + this->GetCurrentSpeed()) / 512;
 289         }
 290
 291         /**
 292          * Allows to know the acceleration type of a vehicle.
 293          * @return Acceleration type of the vehicle.
 294          */
 295         inline int GetAccelerationType() const
 296         {
 297                 return GetRailTypeInfo(this->railtype)->acceleration_type;
 298         }
 299
 300         /**
 301          * Returns the slope steepness used by this vehicle.
 302          * @return Slope steepness used by the vehicle.
 303          */
 304         inline uint32 GetSlopeSteepness() const
 305         {
 306                 return _settings_game.vehicle.train_slope_steepness;
 307         }
 308
 309         /**
 310          * Gets the maximum speed allowed by the track for this vehicle.
 311          * @return Maximum speed allowed.
 312          */
 313         inline uint16 GetMaxTrackSpeed() const
 314         {
 315                 return GetRailTypeInfo(GetRailType(this->tile))->max_speed;
 316         }
 317
 318         /**
 319          * Checks if the vehicle is at a tile that can be sloped.
 320          * @return True if the tile can be sloped.
 321          */
 322         inline bool TileMayHaveSlopedTrack() const
 323         {
 324                 /* Any track that isn't TRACK_BIT_X or TRACK_BIT_Y cannot be sloped. */
 325                 return this->track == TRACK_BIT_X || this->track == TRACK_BIT_Y;
 326         }
 327
 328         /**
 329          * Trains can always use the faster algorithm because they
 330          * have always the same direction as the track under them.
 331          * @return false
 332          */
 333         inline bool HasToUseGetSlopePixelZ()
 334         {
 335                 return false;
 336         }
 337 };
 338
 339 #define FOR_ALL_TRAINS(var) FOR_ALL_VEHICLES_OF_TYPE(Train, var)
 340
 341 #endif /* TRAIN_H */