Files
@ r20313:782ea1fbc479
Branch filter:
Location: cpp/openttd-patchpack/source/src/train.h - annotation
r20313:782ea1fbc479
10.7 KiB
text/x-c
(svn r25323) -Update from WebTranslator v3.0:
traditional_chinese - 34 changes by siu238X
hungarian - 5 changes by Brumi
traditional_chinese - 34 changes by siu238X
hungarian - 5 changes by Brumi
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6422:5983361e241a r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14739:f991a219ff8a r5475:3f5cd13d1b63 r11980:193f7a6b6e37 r5475:3f5cd13d1b63 r17176:4980e04e5764 r11981:3840cc07cbe4 r17176:4980e04e5764 r17176:4980e04e5764 r17176:4980e04e5764 r11981:3840cc07cbe4 r17176:4980e04e5764 r17176:4980e04e5764 r17176:4980e04e5764 r17176:4980e04e5764 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r15352:61cc54bb72c5 r15352:61cc54bb72c5 r15352:61cc54bb72c5 r15352:61cc54bb72c5 r19944:25a78576fb5e r15352:61cc54bb72c5 r15352:61cc54bb72c5 r15352:61cc54bb72c5 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r9704:108fa337b182 r7490:4e86e893fa7f r11980:193f7a6b6e37 r11980:193f7a6b6e37 r9810:a537c0857d3f r11980:193f7a6b6e37 r11980:193f7a6b6e37 r19884:a1593074c6b8 r19884:a1593074c6b8 r11982:ff4390b32b95 r14740:9c3af6ca7b4c r11982:ff4390b32b95 r11982:ff4390b32b95 r11982:ff4390b32b95 r11982:ff4390b32b95 r14393:2a8179560351 r11982:ff4390b32b95 r16778:660bd976d69f r16778:660bd976d69f r12080:8115dddfc1a2 r12080:8115dddfc1a2 r11982:ff4390b32b95 r11982:ff4390b32b95 r6552:7cade7798fcb r12033:6a560c929ec8 r6552:7cade7798fcb r18730:83ef302fe140 r11982:ff4390b32b95 r11982:ff4390b32b95 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r17226:04f59d7fdf18 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r15352:61cc54bb72c5 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r11981:3840cc07cbe4 r14203:aea88883737e r14203:aea88883737e r14203:aea88883737e r12090:c20f83257241 r17128:d4dca9b2b250 r6552:7cade7798fcb r7412:e5f07529a093 r6552:7cade7798fcb r14741:668486b3d9e3 r14741:668486b3d9e3 r6553:04028e73a0f7 r6558:469828caa298 r6563:67c636a8e3d4 r6593:469af92ae569 r12290:442d5d533a57 r18234:0d83ef81cba4 r17162:6666b029cd97 r16371:f5faec1bbc26 r7488:e5f4cea230c4 r12423:199e8b46a11b r19467:47fa1346a132 r11965:2b94ac4aa35a r8467:0ea88f22d4aa r13863:252b1a5c4f87 r11971:ac7eb21a00e4 r8827:6ee5217ef94b r8890:02179c54681e r12290:442d5d533a57 r12413:18cb483f6737 r12296:564aa4953d26 r14251:3ca1b5f41119 r14251:3ca1b5f41119 r14251:3ca1b5f41119 r14251:3ca1b5f41119 r14274:562f45526a0b r14274:562f45526a0b r14251:3ca1b5f41119 r14251:3ca1b5f41119 r14276:fe74de3c3311 r14276:fe74de3c3311 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r18782:6453522c2154 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r18782:6453522c2154 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r12296:564aa4953d26 r14276:fe74de3c3311 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r18436:92d461597905 r14276:fe74de3c3311 r14509:7fa74c77b7ed r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r15814:8b3ad56fa493 r15814:8b3ad56fa493 r16778:660bd976d69f r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r20188:c7660e0c9b5b r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r16778:660bd976d69f r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r15625:2ee9e0168398 r16380:aa3ab792f276 r15625:2ee9e0168398 r18782:6453522c2154 r15625:2ee9e0168398 r16380:aa3ab792f276 r16380:aa3ab792f276 r15625:2ee9e0168398 r15625:2ee9e0168398 r15625:2ee9e0168398 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r18782:6453522c2154 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r15628:ca75f7a370e8 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r14292:0a897b68b658 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r16380:aa3ab792f276 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r16380:aa3ab792f276 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r16380:aa3ab792f276 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r16966:66f5058d69bb r16380:aa3ab792f276 r16380:aa3ab792f276 r16966:66f5058d69bb r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r18782:6453522c2154 r14276:fe74de3c3311 r14276:fe74de3c3311 r14276:fe74de3c3311 r14372:c020b32eb5e4 r14372:c020b32eb5e4 r14372:c020b32eb5e4 r14372:c020b32eb5e4 r14372:c020b32eb5e4 r18782:6453522c2154 r14372:c020b32eb5e4 r16380:aa3ab792f276 r14372:c020b32eb5e4 r14738:57a777833535 r14738:57a777833535 r14738:57a777833535 r14738:57a777833535 r14738:57a777833535 r18782:6453522c2154 r14738:57a777833535 r14738:57a777833535 r14738:57a777833535 r14744:20a253ef5af6 r14744:20a253ef5af6 r14744:20a253ef5af6 r14744:20a253ef5af6 r14744:20a253ef5af6 r18782:6453522c2154 r14744:20a253ef5af6 r14744:20a253ef5af6 r14744:20a253ef5af6 r14744:20a253ef5af6 r17135:4ba298586dc1 r17135:4ba298586dc1 r17135:4ba298586dc1 r17135:4ba298586dc1 r17135:4ba298586dc1 r17135:4ba298586dc1 r18782:6453522c2154 r17135:4ba298586dc1 r17135:4ba298586dc1 r17135:4ba298586dc1 r6552:7cade7798fcb r6552:7cade7798fcb r12029:5b077ec055c0 r12029:5b077ec055c0 r5475:3f5cd13d1b63 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file train.h Base for the train class. */
#ifndef TRAIN_H
#define TRAIN_H
#include "newgrf_engine.h"
#include "cargotype.h"
#include "rail.h"
#include "engine_base.h"
#include "rail_map.h"
#include "ground_vehicle.hpp"
struct Train;
/** Rail vehicle flags. */
enum VehicleRailFlags {
VRF_REVERSING = 0,
VRF_POWEREDWAGON = 3, ///< Wagon is powered.
VRF_REVERSE_DIRECTION = 4, ///< Reverse the visible direction of the vehicle.
VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6, ///< Electric train engine is allowed to run on normal rail. */
VRF_TOGGLE_REVERSE = 7, ///< Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle only).
VRF_TRAIN_STUCK = 8, ///< Train can't get a path reservation.
VRF_LEAVING_STATION = 9, ///< Train is just leaving a station.
};
/** Modes for ignoring signals. */
enum TrainForceProceeding {
TFP_NONE = 0, ///< Normal operation.
TFP_STUCK = 1, ///< Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
TFP_SIGNAL = 2, ///< Ignore next signal, after the signal ignore being stuck.
};
typedef SimpleTinyEnumT<TrainForceProceeding, byte> TrainForceProceedingByte;
byte FreightWagonMult(CargoID cargo);
void CheckTrainsLengths();
void FreeTrainTrackReservation(const Train *v, TileIndex origin = INVALID_TILE, Trackdir orig_td = INVALID_TRACKDIR);
bool TryPathReserve(Train *v, bool mark_as_stuck = false, bool first_tile_okay = false);
int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length);
void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
/** Variables that are cached to improve performance and such */
struct TrainCache {
/* Cached wagon override spritegroup */
const struct SpriteGroup *cached_override;
/* cached values, recalculated on load and each time a vehicle is added to/removed from the consist. */
bool cached_tilt; ///< train can tilt; feature provides a bonus in curves
byte user_def_data; ///< Cached property 0x25. Can be set by Callback 0x36.
/* cached max. speed / acceleration data */
int cached_max_curve_speed; ///< max consist speed limited by curves
};
/**
* 'Train' is either a loco or a wagon.
*/
struct Train FINAL : public GroundVehicle<Train, VEH_TRAIN> {
TrainCache tcache;
/* Link between the two ends of a multiheaded engine */
Train *other_multiheaded_part;
uint16 crash_anim_pos; ///< Crash animation counter.
uint16 flags;
TrackBitsByte track;
TrainForceProceedingByte force_proceed;
RailTypeByte railtype;
RailTypes compatible_railtypes;
/** Ticks waiting in front of a signal, ticks being stuck or a counter for forced proceeding through signals. */
uint16 wait_counter;
/** We don't want GCC to zero our struct! It already is zeroed and has an index! */
Train() : GroundVehicleBase() {}
/** We want to 'destruct' the right class. */
virtual ~Train() { this->PreDestructor(); }
friend struct GroundVehicle<Train, VEH_TRAIN>; // GroundVehicle needs to use the acceleration functions defined at Train.
void MarkDirty();
void UpdateDeltaXY(Direction direction);
ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_TRAIN_INC : EXPENSES_TRAIN_RUN; }
void PlayLeaveStationSound() const;
bool IsPrimaryVehicle() const { return this->IsFrontEngine(); }
SpriteID GetImage(Direction direction, EngineImageType image_type) const;
int GetDisplaySpeed() const { return this->gcache.last_speed; }
int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed; }
Money GetRunningCost() const;
int GetDisplayImageWidth(Point *offset = NULL) const;
bool IsInDepot() const { return this->track == TRACK_BIT_DEPOT; }
bool Tick();
void OnNewDay();
uint Crash(bool flooded = false);
Trackdir GetVehicleTrackdir() const;
TileIndex GetOrderStationLocation(StationID station);
bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
void ReserveTrackUnderConsist() const;
int GetCurveSpeedLimit() const;
void ConsistChanged(bool same_length);
int UpdateSpeed();
void UpdateAcceleration();
int GetCurrentMaxSpeed() const;
/**
* Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consist.
* @return Next vehicle in the consist.
*/
inline Train *GetNextUnit() const
{
Train *v = this->GetNextVehicle();
if (v != NULL && v->IsRearDualheaded()) v = v->GetNextVehicle();
return v;
}
/**
* Get the previous real (non-articulated part and non rear part of dualheaded engine) vehicle in the consist.
* @return Previous vehicle in the consist.
*/
inline Train *GetPrevUnit()
{
Train *v = this->GetPrevVehicle();
if (v != NULL && v->IsRearDualheaded()) v = v->GetPrevVehicle();
return v;
}
/**
* Calculate the offset from this vehicle's center to the following center taking the vehicle lengths into account.
* @return Offset from center to center.
*/
int CalcNextVehicleOffset() const
{
/* For vehicles with odd lengths the part before the center will be one unit
* longer than the part after the center. This means we have to round up the
* length of the next vehicle but may not round the length of the current
* vehicle. */
return this->gcache.cached_veh_length / 2 + (this->Next() != NULL ? this->Next()->gcache.cached_veh_length + 1 : 0) / 2;
}
protected: // These functions should not be called outside acceleration code.
/**
* Allows to know the power value that this vehicle will use.
* @return Power value from the engine in HP, or zero if the vehicle is not powered.
*/
inline uint16 GetPower() const
{
/* Power is not added for articulated parts */
if (!this->IsArticulatedPart() && HasPowerOnRail(this->railtype, GetRailType(this->tile))) {
uint16 power = GetVehicleProperty(this, PROP_TRAIN_POWER, RailVehInfo(this->engine_type)->power);
/* Halve power for multiheaded parts */
if (this->IsMultiheaded()) power /= 2;
return power;
}
return 0;
}
/**
* Returns a value if this articulated part is powered.
* @return Power value from the articulated part in HP, or zero if it is not powered.
*/
inline uint16 GetPoweredPartPower(const Train *head) const
{
/* For powered wagons the engine defines the type of engine (i.e. railtype) */
if (HasBit(this->flags, VRF_POWEREDWAGON) && HasPowerOnRail(head->railtype, GetRailType(this->tile))) {
return RailVehInfo(this->gcache.first_engine)->pow_wag_power;
}
return 0;
}
/**
* Allows to know the weight value that this vehicle will use.
* @return Weight value from the engine in tonnes.
*/
inline uint16 GetWeight() const
{
uint16 weight = (CargoSpec::Get(this->cargo_type)->weight * this->cargo.StoredCount() * FreightWagonMult(this->cargo_type)) / 16;
/* Vehicle weight is not added for articulated parts. */
if (!this->IsArticulatedPart()) {
weight += GetVehicleProperty(this, PROP_TRAIN_WEIGHT, RailVehInfo(this->engine_type)->weight);
}
/* Powered wagons have extra weight added. */
if (HasBit(this->flags, VRF_POWEREDWAGON)) {
weight += RailVehInfo(this->gcache.first_engine)->pow_wag_weight;
}
return weight;
}
/**
* Allows to know the tractive effort value that this vehicle will use.
* @return Tractive effort value from the engine.
*/
inline byte GetTractiveEffort() const
{
return GetVehicleProperty(this, PROP_TRAIN_TRACTIVE_EFFORT, RailVehInfo(this->engine_type)->tractive_effort);
}
/**
* Gets the area used for calculating air drag.
* @return Area of the engine in m^2.
*/
inline byte GetAirDragArea() const
{
/* Air drag is higher in tunnels due to the limited cross-section. */
return (this->track == TRACK_BIT_WORMHOLE && this->vehstatus & VS_HIDDEN) ? 28 : 14;
}
/**
* Gets the air drag coefficient of this vehicle.
* @return Air drag value from the engine.
*/
inline byte GetAirDrag() const
{
return RailVehInfo(this->engine_type)->air_drag;
}
/**
* Checks the current acceleration status of this vehicle.
* @return Acceleration status.
*/
inline AccelStatus GetAccelerationStatus() const
{
return (this->vehstatus & VS_STOPPED) || HasBit(this->flags, VRF_REVERSING) || HasBit(this->flags, VRF_TRAIN_STUCK) ? AS_BRAKE : AS_ACCEL;
}
/**
* Calculates the current speed of this vehicle.
* @return Current speed in km/h-ish.
*/
inline uint16 GetCurrentSpeed() const
{
return this->cur_speed;
}
/**
* Returns the rolling friction coefficient of this vehicle.
* @return Rolling friction coefficient in [1e-4].
*/
inline uint32 GetRollingFriction() const
{
/* Rolling friction for steel on steel is between 0.1% and 0.2%.
* The friction coefficient increases with speed in a way that
* it doubles at 512 km/h, triples at 1024 km/h and so on. */
return 15 * (512 + this->GetCurrentSpeed()) / 512;
}
/**
* Allows to know the acceleration type of a vehicle.
* @return Acceleration type of the vehicle.
*/
inline int GetAccelerationType() const
{
return GetRailTypeInfo(this->railtype)->acceleration_type;
}
/**
* Returns the slope steepness used by this vehicle.
* @return Slope steepness used by the vehicle.
*/
inline uint32 GetSlopeSteepness() const
{
return _settings_game.vehicle.train_slope_steepness;
}
/**
* Gets the maximum speed allowed by the track for this vehicle.
* @return Maximum speed allowed.
*/
inline uint16 GetMaxTrackSpeed() const
{
return GetRailTypeInfo(GetRailType(this->tile))->max_speed;
}
/**
* Checks if the vehicle is at a tile that can be sloped.
* @return True if the tile can be sloped.
*/
inline bool TileMayHaveSlopedTrack() const
{
/* Any track that isn't TRACK_BIT_X or TRACK_BIT_Y cannot be sloped. */
return this->track == TRACK_BIT_X || this->track == TRACK_BIT_Y;
}
/**
* Trains can always use the faster algorithm because they
* have always the same direction as the track under them.
* @return false
*/
inline bool HasToUseGetSlopePixelZ()
{
return false;
}
};
#define FOR_ALL_TRAINS(var) FOR_ALL_VEHICLES_OF_TYPE(Train, var)
#endif /* TRAIN_H */
|