| blob | fb1d2b1ee43aa0144871ef67073eedd581b9cb7a |
1 /* $Id$ */
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 */
10 /** @file train_cmd.cpp Handling of trains. */
44 static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck);
46 bool TrainController(Train *v, Vehicle *nomove, bool reverse = true); // Also used in vehicle_sl.cpp.
56 {
58 }
60 /**
61 * Determine the side in which the train will leave the tile
62 *
63 * @param direction vehicle direction
64 * @param track vehicle track bits
65 * @return side of tile the train will leave
66 */
68 {
69 static const TrackBits state_dir_table[DIAGDIR_END] = { TRACK_BIT_RIGHT, TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER };
73 /* Determine the diagonal direction in which we will exit this tile */
76 }
79 }
82 /**
83 * Return the cargo weight multiplier to use for a rail vehicle
84 * @param cargo Cargo type to get multiplier for
85 * @return Cargo weight multiplier
86 */
88 {
91 }
93 /** Checks if lengths of all rail vehicles are valid. If not, shows an error message. */
95 {
113 }
114 /* Break so we warn only once for each train. */
116 }
117 }
118 }
119 }
120 }
121 }
123 /**
124 * Recalculates the cached stuff of a train. Should be called each time a vehicle is added
125 * to/removed from the chain, and when the game is loaded.
126 * Note: this needs to be called too for 'wagon chains' (in the depot, without an engine)
127 * @param allowed_changes Stuff that is allowed to change.
128 */
130 {
145 /* Check the this->first cache. */
148 /* update the 'first engine' */
154 /* Set user defined data to its default value */
158 }
161 /* Update user defined data (must be done before other properties) */
165 }
173 /* Cache wagon override sprite group. NULL is returned if there is none */
174 u->tcache.cached_override = GetWagonOverrideSpriteSet(u->engine_type, u->cargo_type, u->gcache.first_engine);
176 /* Reset colour map */
179 /* Update powered-wagon-status and visual effect */
184 /* wagon is powered */
188 }
191 /* Do not count powered wagons for the compatible railtypes, as wagons always
192 have railtype normal */
195 }
197 /* Some electric engines can be allowed to run on normal rail. It happens to all
198 * existing electric engines when elrails are disabled and then re-enabled */
202 }
204 /* max speed is the minimum of the speed limits of all vehicles in the consist */
205 if ((rvi_u->railveh_type != RAILVEH_WAGON || _settings_game.vehicle.wagon_speed_limits) && !UsesWagonOverride(u)) {
208 }
209 }
213 /* Update vehicle capacity. */
218 /* Verify capacity hasn't changed. */
219 if (new_cap != u->cargo_cap) ShowNewGrfVehicleError(u->engine_type, STR_NEWGRF_BROKEN, STR_NEWGRF_BROKEN_CAPACITY, GBUG_VEH_CAPACITY, true);
220 }
221 u->vcache.cached_cargo_age_period = GetVehicleProperty(u, PROP_TRAIN_CARGO_AGE_PERIOD, e_u->info.cargo_age_period);
223 /* check the vehicle length (callback) */
226 /* Use callback 36 */
231 }
233 /* Use callback 11 */
235 }
240 /* Update vehicle length. */
243 /* Verify length hasn't changed. */
245 }
250 }
252 /* store consist weight/max speed in cache */
257 /* recalculate cached weights and power too (we do this *after* the rest, so it is known which wagons are powered and need extra weight added) */
266 }
267 }
269 /**
270 * Get the stop location of (the center) of the front vehicle of a train at
271 * a platform of a station.
272 * @param station_id the ID of the station where we're stopping
273 * @param tile the tile where the vehicle currently is
274 * @param v the vehicle to get the stop location of
275 * @param station_ahead 'return' the amount of 1/16th tiles in front of the train
276 * @param station_length 'return' the station length in 1/16th tiles
277 * @return the location, calculated from the begin of the station to stop at.
278 */
279 int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length)
280 {
285 /* Default to the middle of the station for stations stops that are not in
286 * the order list like intermediate stations when non-stop is disabled */
289 /* The train is longer than the station, make it stop at the far end of the platform */
291 } else if (v->current_order.IsType(OT_GOTO_STATION) && v->current_order.GetDestination() == station_id) {
293 }
295 /* The stop location of the FRONT! of the train */
311 }
313 /* Subtract half the front vehicle length of the train so we get the real
314 * stop location of the train. */
316 }
319 /**
320 * Computes train speed limit caused by curves
321 * @return imposed speed limit
322 */
324 {
334 /* first find the curve speed limit */
350 numcurve++;
354 }
355 }
357 }
359 /* if we have a 90 degree turn, fix the speed limit to 60 */
362 }
363 }
371 }
372 }
375 /* Apply the engine's rail type curve speed advantage, if it slowed by curves */
380 /* Apply max_speed bonus of 20% for a tilting train */
382 }
383 }
386 }
388 /**
389 * Calculates the maximum speed of the vehicle under its current conditions.
390 * @return Maximum speed of the vehicle.
391 */
393 {
398 if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && IsRailStationTile(this->tile)) {
405 /* The distance to go is whatever is still ahead of the train minus the
406 * distance from the train's stop location to the end of the platform */
415 }
419 }
420 }
421 }
424 if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && u->track == TRACK_BIT_DEPOT) {
427 }
429 /* Vehicle is on the middle part of a bridge. */
432 }
433 }
437 }
439 /** Update acceleration of the train from the cached power and weight. */
441 {
448 }
450 /**
451 * Get the width of a train vehicle image in the GUI.
452 * @param offset Additional offset for positioning the sprite; set to NULL if not needed
453 * @return Width in pixels
454 */
456 {
464 }
469 }
471 }
474 {
476 return ((direction + _engine_sprite_add[spritenum]) & _engine_sprite_and[spritenum]) + _engine_sprite_base[spritenum];
477 }
479 /**
480 * Get the sprite to display the train.
481 * @param direction Direction of view/travel.
482 * @param image_type Visualisation context.
483 * @return Sprite to display.
484 */
485 void Train::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
486 {
492 GetCustomVehicleSprite(this, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(spritenum)), image_type, result);
496 }
504 }
506 static void GetRailIcon(EngineID engine, bool rear_head, int &y, EngineImageType image_type, VehicleSpriteSeq *result)
507 {
517 }
519 }
522 }
527 }
529 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
530 {
550 VehicleSpriteSeq seq;
553 Rect rect;
560 }
561 }
563 /**
564 * Get the size of the sprite of a train sprite heading west, or both heads (used for lists).
565 * @param engine The engine to get the sprite from.
566 * @param[out] width The width of the sprite.
567 * @param[out] height The height of the sprite.
568 * @param[out] xoffs Number of pixels to shift the sprite to the right.
569 * @param[out] yoffs Number of pixels to shift the sprite downwards.
570 * @param image_type Context the sprite is used in.
571 */
572 void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
573 {
576 VehicleSpriteSeq seq;
579 Rect rect;
591 /* Calculate values relative to an imaginary center between the two sprites. */
596 }
597 }
599 /**
600 * Build a railroad wagon.
601 * @param tile tile of the depot where rail-vehicle is built.
602 * @param flags type of operation.
603 * @param e the engine to build.
604 * @param ret[out] the vehicle that has been built.
605 * @return the cost of this operation or an error.
606 */
607 static CommandCost CmdBuildRailWagon(TileIndex tile, DoCommandFlag flags, const Engine *e, Vehicle **ret)
608 {
611 /* Check that the wagon can drive on the track in question */
665 /* Try to connect the vehicle to one of free chains of wagons. */
675 }
676 }
677 }
680 }
682 /** Move all free vehicles in the depot to the train */
684 {
692 }
693 }
694 }
697 {
725 /* Now we need to link the front and rear engines together */
728 }
730 /**
731 * Build a railroad vehicle.
732 * @param tile tile of the depot where rail-vehicle is built.
733 * @param flags type of operation.
734 * @param e the engine to build.
735 * @param data bit 0 prevents any free cars from being added to the train.
736 * @param ret[out] the vehicle that has been built.
737 * @return the cost of this operation or an error.
738 */
739 CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
740 {
745 /* Check if depot and new engine uses the same kind of tracks *
746 * We need to see if the engine got power on the tile to avoid electric engines in non-electric depots */
788 v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
801 }
806 if (!HasBit(data, 0) && !(flags & DC_AUTOREPLACE)) { // check if the cars should be added to the new vehicle
808 }
811 }
814 }
817 {
824 /* check so all vehicles in the line have the same engine. */
829 }
830 }
831 }
834 }
836 /** Helper type for lists/vectors of trains */
839 /**
840 * Make a backup of a train into a train list.
841 * @param list to make the backup in
842 * @param t the train to make the backup of
843 */
845 {
847 }
849 /**
850 * Restore the train from the backup list.
851 * @param list the train to restore.
852 */
854 {
855 /* No train, nothing to do. */
859 /* Iterate over the list and rebuild it. */
865 /* Make sure the head of the train is always the first in the chain. */
867 }
869 }
870 }
872 /**
873 * Remove the given wagon from its consist.
874 * @param part the part of the train to remove.
875 * @param chain whether to remove the whole chain.
876 */
878 {
881 /* Unlink at the front, but make it point to the next
882 * vehicle after the to be remove part. */
885 /* Unlink at the back */
887 }
889 /**
890 * Inserts a chain into the train at dst.
891 * @param dst the place where to append after.
892 * @param chain the chain to actually add.
893 */
895 {
896 /* We do not want to add something in the middle of an articulated part. */
901 }
903 /**
904 * Normalise the dual heads in the train, i.e. if one is
905 * missing move that one to this train.
906 * @param t the train to normalise.
907 */
909 {
913 /* Make sure that there are no free cars before next engine */
919 /* Remove the part from the 'wrong' train */
921 /* And add it to the 'right' train */
923 }
924 }
926 /**
927 * Normalise the sub types of the parts in this chain.
928 * @param chain the chain to normalise.
929 */
931 {
932 /* Nothing to do */
935 /* We must be the first in the chain. */
938 /* Set the appropriate bits for the first in the chain. */
944 }
946 /* Now clear the bits for the rest of the chain */
950 }
951 }
953 /**
954 * Check/validate whether we may actually build a new train.
955 * @note All vehicles are/were 'heads' of their chains.
956 * @param original_dst The original destination chain.
957 * @param dst The destination chain after constructing the train.
958 * @param original_dst The original source chain.
959 * @param dst The source chain after constructing the train.
960 * @return possible error of this command.
961 */
962 static CommandCost CheckNewTrain(Train *original_dst, Train *dst, Train *original_src, Train *src)
963 {
964 /* Just add 'new' engines and subtract the original ones.
965 * If that's less than or equal to 0 we can be sure we did
966 * not add any engines (read: trains) along the way. */
972 }
974 /* Get a free unit number and check whether it's within the bounds.
975 * There will always be a maximum of one new train. */
979 }
981 /**
982 * Check whether the train parts can be attached.
983 * @param t the train to check
984 * @return possible error of this command.
985 */
987 {
988 /* No multi-part train, no need to check. */
991 /* The maximum length for a train. For each part we decrease this by one
992 * and if the result is negative the train is simply too long. */
993 int allowed_len = _settings_game.vehicle.max_train_length * TILE_SIZE - t->gcache.cached_veh_length;
998 /* Break the prev -> t link so it always holds within the loop. */
1002 /* Make sure the cache is cleared. */
1010 /* Unlink the to-be-added piece; it is already unlinked from the previous
1011 * part due to the fact that the prev -> t link is broken. */
1014 /* Don't check callback for articulated or rear dual headed parts */
1016 /* Back up and clear the first_engine data to avoid using wagon override group */
1020 /* We don't want the cache to interfere. head's cache is cleared before
1021 * the loop and after each callback does not need to be cleared here. */
1024 uint16 callback = GetVehicleCallbackParent(CBID_TRAIN_ALLOW_WAGON_ATTACH, 0, 0, head->engine_type, t, head);
1026 /* Restore original first_engine data */
1029 /* We do not want to remember any cached variables from the test run */
1034 /* A failing callback means everything is okay */
1040 if (callback >= 0x100) ErrorUnknownCallbackResult(head->GetGRFID(), CBID_TRAIN_ALLOW_WAGON_ATTACH, callback);
1054 }
1055 }
1056 }
1059 }
1060 }
1062 /* And link it to the new part. */
1066 }
1070 }
1072 /**
1073 * Validate whether we are going to create valid trains.
1074 * @note All vehicles are/were 'heads' of their chains.
1075 * @param original_dst The original destination chain.
1076 * @param dst The destination chain after constructing the train.
1077 * @param original_dst The original source chain.
1078 * @param dst The source chain after constructing the train.
1079 * @param check_limit Whether to check the vehicle limit.
1080 * @return possible error of this command.
1081 */
1082 static CommandCost ValidateTrains(Train *original_dst, Train *dst, Train *original_src, Train *src, bool check_limit)
1083 {
1084 /* Check whether we may actually construct the trains. */
1090 /* Check whether we need to build a new train. */
1092 }
1094 /**
1095 * Arrange the trains in the wanted way.
1096 * @param dst_head The destination chain of the to be moved vehicle.
1097 * @param dst The destination for the to be moved vehicle.
1098 * @param src_head The source chain of the to be moved vehicle.
1099 * @param src The to be moved vehicle.
1100 * @param move_chain Whether to move all vehicles after src or not.
1101 */
1102 static void ArrangeTrains(Train **dst_head, Train *dst, Train **src_head, Train *src, bool move_chain)
1103 {
1104 /* First determine the front of the two resulting trains */
1106 /* If we aren't moving part(s) to a new train, we are just moving the
1107 * front back and there is not destination head. */
1110 /* If we are moving to a new train the head of the move train would become
1111 * the head of the new vehicle. */
1113 }
1116 /* If we are moving the front of a train then we are, in effect, creating
1117 * a new head for the train. Point to that. Unless we are moving the whole
1118 * train in which case there is not 'source' train anymore.
1119 * In case we are a multiheaded part we want the complete thing to come
1120 * with us, so src->GetNextUnit(), however... when we are e.g. a wagon
1121 * that is followed by a rear multihead we do not want to include that. */
1124 }
1126 /* Now it's just simply removing the part that we are going to move from the
1127 * source train and *if* the destination is a not a new train add the chain
1128 * at the destination location. */
1132 /* Now normalise the dual heads, that is move the dual heads around in such
1133 * a way that the head and rear of a dual head are in the same train */
1136 }
1138 /**
1139 * Normalise the head of the train again, i.e. that is tell the world that
1140 * we have changed and update all kinds of variables.
1141 * @param head the train to update.
1142 */
1144 {
1145 /* Not much to do! */
1148 /* Tell the 'world' the train changed. */
1152 /* Not a front engine, i.e. a free wagon chain. No need to do more. */
1155 /* Update the refit button and window */
1159 /* If we don't have a unit number yet, set one. */
1162 }
1164 /**
1165 * Move a rail vehicle around inside the depot.
1166 * @param tile unused
1167 * @param flags type of operation
1168 * Note: DC_AUTOREPLACE is set when autoreplace tries to undo its modifications or moves vehicles to temporary locations inside the depot.
1169 * @param p1 various bitstuffed elements
1170 * - p1 (bit 0 - 19) source vehicle index
1171 * - p1 (bit 20) move all vehicles following the source vehicle
1172 * @param p2 what wagon to put the source wagon AFTER, XXX - INVALID_VEHICLE to make a new line
1173 * @param text unused
1174 * @return the cost of this operation or an error
1175 */
1176 CommandCost CmdMoveRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1177 {
1188 /* Do not allow moving crashed vehicles inside the depot, it is likely to cause asserts later */
1191 /* if nothing is selected as destination, try and find a matching vehicle to drag to. */
1202 /* Do not allow appending to crashed vehicles, too */
1204 }
1206 /* if an articulated part is being handled, deal with its parent vehicle */
1210 }
1212 /* don't move the same vehicle.. */
1215 /* locate the head of the two chains */
1221 /* Now deal with articulated part of destination wagon */
1225 }
1229 /* When moving all wagons, we can't have the same src_head and dst_head */
1232 /* When moving a multiheaded part to be place after itself, bail out. */
1233 if (!move_chain && dst != NULL && dst->IsRearDualheaded() && src == dst->other_multiheaded_part) return CommandCost();
1235 /* Check if all vehicles in the source train are stopped inside a depot. */
1236 if (!src_head->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1238 /* Check if all vehicles in the destination train are stopped inside a depot. */
1239 if (dst_head != NULL && !dst_head->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1241 /* First make a backup of the order of the trains. That way we can do
1242 * whatever we want with the order and later on easily revert. */
1243 TrainList original_src;
1244 TrainList original_dst;
1249 /* Also make backup of the original heads as ArrangeTrains can change them.
1250 * For the destination head we do not care if it is the same as the source
1251 * head because in that case it's just a copy. */
1255 /* We want this information from before the rearrangement, but execute this after the validation.
1256 * original_src_head can't be NULL; src is by definition != NULL, so src_head can't be NULL as
1257 * src->GetFirst() always yields non-NULL, so eventually original_src_head != NULL as well. */
1259 bool original_dst_head_front_engine = original_dst_head != NULL && original_dst_head->IsFrontEngine();
1261 /* (Re)arrange the trains in the wanted arrangement. */
1265 /* If the autoreplace flag is set we do not need to test for the validity
1266 * because we are going to revert the train to its original state. As we
1267 * assume the original state was correct autoreplace can skip this. */
1268 CommandCost ret = ValidateTrains(original_dst_head, dst_head, original_src_head, src_head, true);
1270 /* Restore the train we had. */
1274 }
1275 }
1277 /* do it? */
1279 /* Remove old heads from the statistics */
1283 /* First normalise the sub types of the chains. */
1287 /* There are 14 different cases:
1288 * 1) front engine gets moved to a new train, it stays a front engine.
1289 * a) the 'next' part is a wagon that becomes a free wagon chain.
1290 * b) the 'next' part is an engine that becomes a front engine.
1291 * c) there is no 'next' part, nothing else happens
1292 * 2) front engine gets moved to another train, it is not a front engine anymore
1293 * a) the 'next' part is a wagon that becomes a free wagon chain.
1294 * b) the 'next' part is an engine that becomes a front engine.
1295 * c) there is no 'next' part, nothing else happens
1296 * 3) front engine gets moved to later in the current train, it is not a front engine anymore.
1297 * a) the 'next' part is a wagon that becomes a free wagon chain.
1298 * b) the 'next' part is an engine that becomes a front engine.
1299 * 4) free wagon gets moved
1300 * a) the 'next' part is a wagon that becomes a free wagon chain.
1301 * b) the 'next' part is an engine that becomes a front engine.
1302 * c) there is no 'next' part, nothing else happens
1303 * 5) non front engine gets moved and becomes a new train, nothing else happens
1304 * 6) non front engine gets moved within a train / to another train, nothing hapens
1305 * 7) wagon gets moved, nothing happens
1306 */
1308 /* Cases #2 and #3: the front engine gets trashed. */
1317 /* Delete orders, group stuff and the unit number as we're not the
1318 * front of any vehicle anymore. */
1322 }
1324 /* We weren't a front engine but are becoming one. So
1325 * we should be put in the default group. */
1329 }
1331 /* Add new heads to statistics */
1335 /* Handle 'new engine' part of cases #1b, #2b, #3b, #4b and #5 in NormaliseTrainHead. */
1342 }
1347 /* We are undoubtedly changing something in the depot and train list. */
1351 /* We don't want to execute what we're just tried. */
1354 }
1357 }
1359 /**
1360 * Sell a (single) train wagon/engine.
1361 * @param flags type of operation
1362 * @param t the train wagon to sell
1363 * @param data the selling mode
1364 * - data = 0: only sell the single dragged wagon/engine (and any belonging rear-engines)
1365 * - data = 1: sell the vehicle and all vehicles following it in the chain
1366 * if the wagon is dragged, don't delete the possibly belonging rear-engine to some front
1367 * @param user the user for the order backup.
1368 * @return the cost of this operation or an error
1369 */
1371 {
1372 /* Sell a chain of vehicles or not? */
1380 /* First make a backup of the order of the train. That way we can do
1381 * whatever we want with the order and later on easily revert. */
1382 TrainList original;
1385 /* We need to keep track of the new head and the head of what we're going to sell. */
1389 /* Split the train in the wanted way. */
1392 /* We don't need to validate the second train; it's going to be sold. */
1395 /* Restore the train we had. */
1398 }
1401 /* Restore the train we had. */
1404 }
1409 /* do it? */
1411 /* First normalise the sub types of the chain. */
1414 if (v == first && v->IsEngine() && !sell_chain && new_head != NULL && new_head->IsFrontEngine()) {
1415 /* We are selling the front engine. In this case we want to
1416 * 'give' the order, unit number and such to the new head. */
1421 /* Copy other important data from the front engine */
1426 }
1428 /* We need to update the information about the train. */
1431 /* We are undoubtedly changing something in the depot and train list. */
1435 /* Actually delete the sold 'goods' */
1438 /* We don't want to execute what we're just tried. */
1440 }
1443 }
1446 {
1447 /* Set common defaults. */
1458 {
1459 /* x, y */
1464 };
1468 /* For all straight directions, move the bound box to the centre of the vehicle, but keep the size. */
1475 /* Shorten southern corner of the bounding box according the vehicle length
1476 * and center the bounding box on the vehicle. */
1489 /* Move northern corner of the bounding box down according to vehicle length
1490 * and center the bounding box on the vehicle. */
1505 }
1506 }
1507 }
1509 /**
1510 * Mark a train as stuck and stop it if it isn't stopped right now.
1511 * @param v %Train to mark as being stuck.
1512 */
1514 {
1516 /* It is the first time the problem occurred, set the "train stuck" flag. */
1521 /* Stop train */
1527 }
1528 }
1530 /**
1531 * Swap the two up/down flags in two ways:
1532 * - Swap values of \a swap_flag1 and \a swap_flag2, and
1533 * - If going up previously (#GVF_GOINGUP_BIT set), the #GVF_GOINGDOWN_BIT is set, and vice versa.
1534 * @param swap_flag1 [inout] First train flag.
1535 * @param swap_flag2 [inout] Second train flag.
1536 */
1538 {
1542 /* Clear the flags */
1548 /* Reverse the rail-flags (if needed) */
1553 }
1558 }
1559 }
1561 /**
1562 * Updates some variables after swapping the vehicle.
1563 * @param v swapped vehicle
1564 */
1566 {
1567 /* Reverse the direction. */
1570 /* Call the proper EnterTile function unless we are in a wormhole. */
1574 /* VehicleEnter_TunnelBridge() sets TRACK_BIT_WORMHOLE when the vehicle
1575 * is on the last bit of the bridge head (frame == TILE_SIZE - 1).
1576 * If we were swapped with such a vehicle, we have set TRACK_BIT_WORMHOLE,
1577 * when we shouldn't have. Check if this is the case. */
1582 /* We have just left the wormhole, possibly set the
1583 * "goingdown" bit. UpdateInclination() can be used
1584 * because we are at the border of the tile. */
1588 }
1589 }
1590 }
1594 }
1596 /**
1597 * Swap vehicles \a l and \a r in consist \a v, and reverse their direction.
1598 * @param v Consist to change.
1599 * @param l %Vehicle index in the consist of the first vehicle.
1600 * @param r %Vehicle index in the consist of the second vehicle.
1601 */
1603 {
1606 /* locate vehicles to swap */
1611 /* swap the hidden bits */
1612 {
1616 }
1630 /* Swap GVF_GOINGUP_BIT/GVF_GOINGDOWN_BIT.
1631 * This is a little bit redundant way, a->gv_flags will
1632 * be (re)set twice, but it reduces code duplication */
1635 }
1636 }
1639 /**
1640 * Check if the vehicle is a train
1641 * @param v vehicle on tile
1642 * @return v if it is a train, NULL otherwise
1643 */
1645 {
1647 }
1650 /**
1651 * Checks if a train is approaching a rail-road crossing
1652 * @param v vehicle on tile
1653 * @param data tile with crossing we are testing
1654 * @return v if it is approaching a crossing, NULL otherwise
1655 */
1657 {
1668 }
1671 /**
1672 * Finds a vehicle approaching rail-road crossing
1673 * @param tile tile to test
1674 * @return true if a vehicle is approaching the crossing
1675 * @pre tile is a rail-road crossing
1676 */
1678 {
1690 }
1693 /**
1694 * Sets correct crossing state
1695 * @param tile tile to update
1696 * @param sound should we play sound?
1697 * @pre tile is a rail-road crossing
1698 */
1700 {
1703 /* reserved || train on crossing || train approaching crossing */
1704 bool new_state = HasCrossingReservation(tile) || HasVehicleOnPos(tile, NULL, &TrainOnTileEnum) || TrainApproachingCrossing(tile);
1709 }
1712 }
1713 }
1716 /**
1717 * Bars crossing and plays ding-ding sound if not barred already
1718 * @param tile tile with crossing
1719 * @pre tile is a rail-road crossing
1720 */
1722 {
1727 }
1728 }
1731 /**
1732 * Advances wagons for train reversing, needed for variable length wagons.
1733 * This one is called before the train is reversed.
1734 * @param v First vehicle in chain
1735 */
1737 {
1749 /* do not update images now
1750 * negative differential will be handled in AdvanceWagonsAfterSwap() */
1755 }
1756 }
1759 /**
1760 * Advances wagons for train reversing, needed for variable length wagons.
1761 * This one is called after the train is reversed.
1762 * @param v First vehicle in chain
1763 */
1765 {
1766 /* first of all, fix the situation when the train was entering a depot */
1768 while (dep->Next() != NULL && (dep->track == TRACK_BIT_DEPOT || dep->Next()->track != TRACK_BIT_DEPOT)) {
1770 }
1775 /* 'pull' next wagon out of the depot, so we won't miss it (it could stay in depot forever) */
1781 for (int i = 0; i >= d; i--) TrainController(leave, NULL); // maybe move it, and maybe let another wagon leave
1782 }
1785 }
1792 /* We have to make sure all wagons that leave a depot because of train reversing are moved correctly
1793 * they have already correct spacing, so we have to make sure they are moved how they should */
1794 bool nomove = (dep == NULL); // If there is no vehicle leaving a depot, limit the number of wagons moved immediately.
1797 /* we reached vehicle (originally) in front of a depot, stop now
1798 * (we would move wagons that are already moved with new wagon length). */
1801 /* the last wagon was that one leaving a depot, so do not move it anymore */
1809 /* do not update images now */
1814 }
1815 }
1817 /**
1818 * Turn a train around.
1819 * @param v %Train to turn around.
1820 */
1822 {
1825 }
1827 /* Clear path reservation in front if train is not stuck. */
1830 /* Check if we were approaching a rail/road-crossing */
1833 /* count number of vehicles */
1838 /* swap start<>end, start+1<>end-1, ... */
1848 }
1854 /* recalculate cached data */
1857 /* update all images */
1860 /* update crossing we were approaching */
1863 /* maybe we are approaching crossing now, after reversal */
1867 /* If we are inside a depot after reversing, don't bother with path reserving. */
1869 /* Can't be stuck here as inside a depot is always a safe tile. */
1870 if (HasBit(v->flags, VRF_TRAIN_STUCK)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
1873 }
1875 /* TrainExitDir does not always produce the desired dir for depots and
1876 * tunnels/bridges that is needed for UpdateSignalsOnSegment. */
1880 if (UpdateSignalsOnSegment(v->tile, dir, v->owner) == SIGSEG_PBS || _settings_game.pf.reserve_paths) {
1881 /* If we are currently on a tile with conventional signals, we can't treat the
1882 * current tile as a safe tile or we would enter a PBS block without a reservation. */
1887 /* If we are on a depot tile facing outwards, do not treat the current tile as safe. */
1888 if (IsRailDepotTile(v->tile) && TrackdirToExitdir(v->GetVehicleTrackdir()) == GetRailDepotDirection(v->tile)) first_tile_okay = false;
1890 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true);
1892 /* Do a look-ahead now in case our current tile was already a safe tile. */
1895 /* Do not wait for a way out when we're still loading */
1897 }
1899 /* A train not inside a PBS block can't be stuck. */
1902 }
1903 }
1905 /**
1906 * Reverse train.
1907 * @param tile unused
1908 * @param flags type of operation
1909 * @param p1 train to reverse
1910 * @param p2 if true, reverse a unit in a train (needs to be in a depot)
1911 * @param text unused
1912 * @return the cost of this operation or an error
1913 */
1914 CommandCost CmdReverseTrainDirection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1915 {
1923 /* turn a single unit around */
1925 if (v->IsMultiheaded() || HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_ARTIC_ENGINE)) {
1927 }
1931 /* make sure the vehicle is stopped in the depot */
1934 }
1944 }
1946 /* turn the whole train around */
1950 /* Properly leave the station if we are loading and won't be loading anymore */
1955 /* not a station || different station --> leave the station */
1956 if (!IsTileType(last->tile, MP_STATION) || GetStationIndex(last->tile) != GetStationIndex(v->tile)) {
1958 }
1959 }
1961 /* We cancel any 'skip signal at dangers' here */
1972 }
1973 }
1974 }
1976 }
1978 /**
1979 * Force a train through a red signal
1980 * @param tile unused
1981 * @param flags type of operation
1982 * @param p1 train to ignore the red signal
1983 * @param p2 unused
1984 * @param text unused
1985 * @return the cost of this operation or an error
1986 */
1987 CommandCost CmdForceTrainProceed(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1988 {
1999 /* If we are forced to proceed, cancel that order.
2000 * If we are marked stuck we would want to force the train
2001 * to proceed to the next signal. In the other cases we
2002 * would like to pass the signal at danger and run till the
2003 * next signal we encounter. */
2004 t->force_proceed = t->force_proceed == TFP_SIGNAL ? TFP_NONE : HasBit(t->flags, VRF_TRAIN_STUCK) || t->IsChainInDepot() ? TFP_STUCK : TFP_SIGNAL;
2006 }
2009 }
2011 /**
2012 * Try to find a depot nearby.
2013 * @param v %Train that wants a depot.
2014 * @param max_distance Maximal search distance.
2015 * @return Information where the closest train depot is located.
2016 * @pre The given vehicle must not be crashed!
2017 */
2019 {
2032 }
2033 }
2035 /**
2036 * Locate the closest depot for this consist, and return the information to the caller.
2037 * @param location [out] If not \c NULL and a depot is found, store its location in the given address.
2038 * @param destination [out] If not \c NULL and a depot is found, store its index in the given address.
2039 * @param reverse [out] If not \c NULL and a depot is found, store reversal information in the given address.
2040 * @return A depot has been found.
2041 */
2043 {
2052 }
2054 /** Play a sound for a train leaving the station. */
2056 {
2058 SND_04_TRAIN,
2059 SND_0A_TRAIN_HORN,
2060 SND_0A_TRAIN_HORN,
2061 SND_47_MAGLEV_2,
2062 SND_41_MAGLEV
2063 };
2069 }
2071 /**
2072 * Check if the train is on the last reserved tile and try to extend the path then.
2073 * @param v %Train that needs its path extended.
2074 */
2076 {
2077 /* Don't do any look-ahead if path_backoff_interval is 255. */
2080 /* Exit if we are inside a depot. */
2084 /* Exit if we reached our destination depot. */
2090 /* If we reached our waypoint, make sure we see that. */
2091 if (IsRailWaypointTile(v->tile) && GetStationIndex(v->tile) == v->current_order.GetDestination()) ProcessOrders(v);
2097 /* Exit if the current order doesn't have a destination, but the train has orders. */
2103 }
2104 /* Exit if we are on a station tile and are going to stop. */
2105 if (IsRailStationTile(v->tile) && v->current_order.ShouldStopAtStation(v, GetStationIndex(v->tile))) return;
2109 /* On a tile with a red non-pbs signal, don't look ahead. */
2118 /* Next tile is not reserved. */
2121 /* If the next tile is a PBS signal, try to make a reservation. */
2125 }
2127 }
2128 }
2129 }
2130 }
2132 /**
2133 * Will the train stay in the depot the next tick?
2134 * @param v %Train to check.
2135 * @return True if it stays in the depot, false otherwise.
2136 */
2138 {
2139 /* bail out if not all wagons are in the same depot or not in a depot at all */
2142 }
2144 /* if the train got no power, then keep it in the depot */
2149 }
2151 SigSegState seg_state;
2154 /* force proceed was not pressed */
2158 }
2162 seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner);
2164 /* Full and no PBS signal in block or depot reserved, can't exit. */
2167 }
2169 seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner);
2170 }
2172 /* We are leaving a depot, but have to go to the exact same one; re-enter */
2174 /* We need to have a reservation for this to work. */
2179 }
2181 /* Only leave when we can reserve a path to our destination. */
2183 /* No path and no force proceed. */
2187 }
2209 }
2211 /**
2212 * Clear the reservation of \a tile that was just left by a wagon on \a track_dir.
2213 * @param v %Train owning the reservation.
2214 * @param tile Tile with reservation to clear.
2215 * @param track_dir Track direction to clear.
2216 */
2218 {
2222 /* Are we just leaving a tunnel/bridge? */
2227 /* Free the reservation only if no other train is on the tiles. */
2237 }
2238 }
2239 }
2240 }
2243 /* If the new tile is not a further tile of the same station, we
2244 * clear the reservation for the whole platform. */
2247 }
2249 /* Any other tile */
2251 }
2252 }
2254 /**
2255 * Free the reserved path in front of a vehicle.
2256 * @param v %Train owning the reserved path.
2257 */
2259 {
2265 StationID station_id = IsRailStationTile(v->tile) ? GetStationIndex(v->tile) : INVALID_STATION;
2267 /* Can't be holding a reservation if we enter a depot. */
2270 /* Front engine is in a depot. We enter if some part is not in the depot. */
2273 }
2274 }
2275 /* Don't free reservation if it's not ours. */
2289 /* Conventional signal along trackdir: remove reservation and stop. */
2292 }
2295 /* Red PBS signal? Can't be our reservation, would be green then. */
2298 /* Turn the signal back to red. */
2301 }
2302 } else if (HasSignalOnTrackdir(tile, ReverseTrackdir(td)) && IsOnewaySignal(tile, TrackdirToTrack(td))) {
2304 }
2305 }
2307 /* Don't free first station/bridge/tunnel if we are on it. */
2308 if (free_tile || (!(ft.m_is_station && GetStationIndex(ft.m_new_tile) == station_id) && !ft.m_is_tunnel && !ft.m_is_bridge)) ClearPathReservation(v, tile, td);
2311 }
2312 }
2321 };
2323 /**
2324 * Perform pathfinding for a train.
2325 *
2326 * @param v The train
2327 * @param tile The tile the train is about to enter
2328 * @param enterdir Diagonal direction the train is coming from
2329 * @param tracks Usable tracks on the new tile
2330 * @param path_found [out] Whether a path has been found or not.
2331 * @param do_track_reservation Path reservation is requested
2332 * @param dest [out] State and destination of the requested path
2333 * @return The best track the train should follow
2334 */
2335 static Track DoTrainPathfind(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool do_track_reservation, PBSTileInfo *dest)
2336 {
2338 case VPF_NPF: return NPFTrainChooseTrack(v, tile, enterdir, tracks, path_found, do_track_reservation, dest);
2339 case VPF_YAPF: return YapfTrainChooseTrack(v, tile, enterdir, tracks, path_found, do_track_reservation, dest);
2342 }
2343 }
2345 /**
2346 * Extend a train path as far as possible. Stops on encountering a safe tile,
2347 * another reservation or a track choice.
2348 * @return INVALID_TILE indicates that the reservation failed.
2349 */
2350 static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir)
2351 {
2360 /* Possible signal tile. */
2361 if (HasOnewaySignalBlockingTrackdir(ft.m_new_tile, FindFirstTrackdir(ft.m_new_td_bits))) break;
2362 }
2367 }
2369 /* Station, depot or waypoint are a possible target. */
2370 bool target_seen = ft.m_is_station || (IsTileType(ft.m_new_tile, MP_RAILWAY) && !IsPlainRail(ft.m_new_tile));
2372 /* Choice found or possible target encountered.
2373 * On finding a possible target, we need to stop and let the pathfinder handle the
2374 * remaining path. This is because we don't know if this target is in one of our
2375 * orders, so we might cause pathfinding to fail later on if we find a choice.
2376 * This failure would cause a bogous call to TryReserveSafePath which might reserve
2377 * a wrong path not leading to our next destination. */
2378 if (HasReservedTracks(ft.m_new_tile, TrackdirBitsToTrackBits(TrackdirReachesTrackdirs(ft.m_old_td)))) break;
2380 /* If we did skip some tiles, backtrack to the first skipped tile so the pathfinder
2381 * actually starts its search at the first unreserved tile. */
2382 if (ft.m_tiles_skipped != 0) ft.m_new_tile -= TileOffsByDiagDir(ft.m_exitdir) * ft.m_tiles_skipped;
2384 /* Choice found, path valid but not okay. Save info about the choice tile as well. */
2388 }
2396 /* Safe position is all good, path valid and okay. */
2398 }
2401 }
2404 /* End of line, path valid and okay. */
2406 }
2408 /* Sorry, can't reserve path, back out. */
2419 }
2426 }
2428 /* Path invalid. */
2430 }
2432 /**
2433 * Try to reserve any path to a safe tile, ignoring the vehicle's destination.
2434 * Safe tiles are tiles in front of a signal, depots and station tiles at end of line.
2435 *
2436 * @param v The vehicle.
2437 * @param tile The tile the search should start from.
2438 * @param td The trackdir the search should start from.
2439 * @param override_railtype Whether all physically compatible railtypes should be followed.
2440 * @return True if a path to a safe stopping tile could be reserved.
2441 */
2442 static bool TryReserveSafeTrack(const Train *v, TileIndex tile, Trackdir td, bool override_tailtype)
2443 {
2449 }
2450 }
2452 /** This class will save the current order of a vehicle and restore it on destruction. */
2456 Order old_order;
2457 TileIndex old_dest_tile;
2458 StationID old_last_station_visited;
2459 VehicleOrderID index;
2470 {
2471 }
2474 {
2479 }
2481 /**
2482 * Set the current vehicle order to the next order in the order list.
2483 * @param skip_first Shall the first (i.e. active) order be skipped?
2484 * @return True if a suitable next order could be found.
2485 */
2487 {
2495 /* Wrap around. */
2503 /* Skip service in depot orders when the train doesn't need service. */
2505 FALLTHROUGH;
2513 depth++;
2515 /* Don't increment next, so no break here. */
2517 }
2519 }
2522 }
2523 /* Don't increment inside the while because otherwise conditional
2524 * orders can lead to an infinite loop. */
2526 depth++;
2530 }
2531 };
2533 /* choose a track */
2534 static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck)
2535 {
2544 /* Don't use tracks here as the setting to forbid 90 deg turns might have been switched between reservation and now. */
2545 TrackBits res_tracks = (TrackBits)(GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir));
2546 /* Do we have a suitable reserved track? */
2549 /* Quick return in case only one possible track is available */
2552 /* We need to check for signals only here, as a junction tile can't have signals. */
2553 if (track != INVALID_TRACK && HasPbsSignalOnTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir))) {
2559 }
2561 }
2568 /* Reservation failed? */
2570 if (changed_signal) SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(best_track, enterdir), SIGNAL_STATE_RED);
2572 }
2574 /* Got a valid reservation that ends at a safe target, quick exit. */
2579 }
2581 /* Check if the train needs service here, so it has a chance to always find a depot.
2582 * Also check if the current order is a service order so we don't reserve a path to
2583 * the destination but instead to the next one if service isn't needed. */
2585 if (v->current_order.IsType(OT_DUMMY) || v->current_order.IsType(OT_CONDITIONAL) || v->current_order.IsType(OT_GOTO_DEPOT)) ProcessOrders(v);
2586 }
2588 /* Save the current train order. The destructor will restore the old order on function exit. */
2591 /* If the current tile is the destination of the current order and
2592 * a reservation was requested, advance to the next order.
2593 * Don't advance on a depot order as depots are always safe end points
2594 * for a path and no look-ahead is necessary. This also avoids a
2595 * problem with depot orders not part of the order list when the
2596 * order list itself is empty. */
2599 } else if (v->current_order.IsType(OT_LOADING) || (!v->current_order.IsType(OT_GOTO_DEPOT) && (
2604 }
2607 /* Pathfinders are able to tell that route was only 'guessed'. */
2611 Track next_track = DoTrainPathfind(v, new_tile, dest_enterdir, tracks, path_found, do_track_reservation, &res_dest);
2614 }
2616 /* No track reservation requested -> finished. */
2619 /* A path was found, but could not be reserved. */
2624 }
2626 /* No possible reservation target found, we are probably lost. */
2628 /* Try to find any safe destination. */
2639 }
2641 }
2645 /* Reservation target found and free, check if it is safe. */
2646 while (!IsSafeWaitingPosition(v, res_dest.tile, res_dest.trackdir, true, _settings_game.pf.forbid_90_deg)) {
2647 /* Extend reservation until we have found a safe position. */
2650 TrackBits reachable = TrackdirBitsToTrackBits((TrackdirBits)(GetTileTrackStatus(next_tile, TRANSPORT_RAIL, 0))) & DiagdirReachesTracks(exitdir);
2653 }
2655 /* Get next order with destination. */
2657 PBSTileInfo cur_dest;
2663 /* Path found, but could not be reserved. */
2669 }
2670 }
2671 /* No order or no safe position found, try any position. */
2677 }
2679 }
2686 }
2688 /**
2689 * Try to reserve a path to a safe position.
2690 *
2691 * @param v The vehicle
2692 * @param mark_as_stuck Should the train be marked as stuck on a failed reservation?
2693 * @param first_tile_okay True if no path should be reserved if the current tile is a safe position.
2694 * @return True if a path could be reserved.
2695 */
2697 {
2700 /* We have to handle depots specially as the track follower won't look
2701 * at the depot tile itself but starts from the next tile. If we are still
2702 * inside the depot, a depot reservation can never be ours. */
2708 /* Depot not reserved, but the next tile might be. */
2710 if (HasReservedTracks(next_tile, DiagdirReachesTracks(GetRailDepotDirection(v->tile)))) return false;
2711 }
2712 }
2716 /* The path we are driving on is already blocked by some other train.
2717 * This can only happen in certain situations when mixing path and
2718 * block signals or when changing tracks and/or signals.
2719 * Exit here as doing any further reservations will probably just
2720 * make matters worse. */
2724 }
2725 /* If we have a reserved path and the path ends at a safe tile, we are finished already. */
2727 /* Can't be stuck then. */
2728 if (HasBit(v->flags, VRF_TRAIN_STUCK)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
2731 }
2733 /* If we are in a depot, tentatively reserve the depot. */
2737 }
2741 TrackBits reachable = TrackdirBitsToTrackBits(TrackStatusToTrackdirBits(GetTileTrackStatus(new_tile, TRANSPORT_RAIL, 0)) & DiagdirReachesTrackdirs(exitdir));
2743 if (_settings_game.pf.forbid_90_deg) reachable &= ~TrackCrossesTracks(TrackdirToTrack(origin.trackdir));
2749 /* Free the depot reservation as well. */
2752 }
2757 }
2760 }
2764 {
2769 }
2778 }
2779 }
2781 /**
2782 * Get the location of the next station to visit.
2783 * @param station Next station to visit.
2784 * @return Location of the new station.
2785 */
2787 {
2792 /* The destination station has no trainstation tiles. */
2795 }
2798 }
2800 /** Goods at the consist have changed, update the graphics, cargo, and acceleration. */
2802 {
2809 /* need to update acceleration and cached values since the goods on the train changed. */
2812 }
2814 /**
2815 * This function looks at the vehicle and updates its speed (cur_speed
2816 * and subspeed) variables. Furthermore, it returns the distance that
2817 * the train can drive this tick. #Vehicle::GetAdvanceDistance() determines
2818 * the distance to drive before moving a step on the map.
2819 * @return distance to drive.
2820 */
2822 {
2826 return this->DoUpdateSpeed(this->acceleration * (this->GetAccelerationStatus() == AS_BRAKE ? -4 : 2), 0, this->GetCurrentMaxSpeed());
2829 return this->DoUpdateSpeed(this->GetAcceleration(), this->GetAccelerationStatus() == AS_BRAKE ? 0 : 2, this->GetCurrentMaxSpeed());
2830 }
2831 }
2833 /**
2834 * Trains enters a station, send out a news item if it is the first train, and start loading.
2835 * @param v Train that entered the station.
2836 * @param station Station visited.
2837 */
2839 {
2842 /* check if a train ever visited this station before */
2848 STR_NEWS_FIRST_TRAIN_ARRIVAL,
2851 st->index
2852 );
2855 }
2864 }
2866 /* Check if the vehicle is compatible with the specified tile */
2868 {
2871 }
2873 /** Data structure for storing engine speed changes of an acceleration type. */
2879 };
2881 /** Speed update fractions for each acceleration type. */
2883 /* normal accel */
2887 };
2889 /**
2890 * Modify the speed of the vehicle due to a change in altitude.
2891 * @param v %Train to update.
2892 * @param old_z Previous height.
2893 */
2895 {
2896 if (old_z == v->z_pos || _settings_game.vehicle.train_acceleration_model != AM_ORIGINAL) return;
2898 const AccelerationSlowdownParams *asp = &_accel_slowdown[GetRailTypeInfo(v->railtype)->acceleration_type];
2905 }
2906 }
2909 {
2912 TrackdirBits tracks = TrackBitsToTrackdirBits(GetTrackBits(tile)) & DiagdirReachesTrackdirs(dir);
2914 if (UpdateSignalsOnSegment(tile, TrackdirToExitdir(trackdir), GetTileOwner(tile)) == SIGSEG_PBS && HasSignalOnTrackdir(tile, trackdir)) {
2915 /* A PBS block with a non-PBS signal facing us? */
2917 }
2918 }
2920 }
2922 /** Tries to reserve track under whole train consist. */
2924 {
2935 }
2936 }
2937 }
2939 /**
2940 * The train vehicle crashed!
2941 * Update its status and other parts around it.
2942 * @param flooded Crash was caused by flooding.
2943 * @return Number of people killed.
2944 */
2946 {
2951 /* Remove the reserved path in front of the train if it is not stuck.
2952 * Also clear all reserved tracks the train is currently on. */
2957 /* ClearPathReservation will not free the wormhole exit
2958 * if the train has just entered the wormhole. */
2960 }
2961 }
2963 /* we may need to update crossing we were approaching,
2964 * but must be updated after the train has been marked crashed */
2968 /* Remove the loading indicators (if any) */
2970 }
2976 }
2978 /**
2979 * Marks train as crashed and creates an AI event.
2980 * Doesn't do anything if the train is crashed already.
2981 * @param v first vehicle of chain
2982 * @return number of victims (including 2 drivers; zero if train was already crashed)
2983 */
2985 {
2988 /* do not crash train twice */
2991 AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN));
2992 Game::NewEvent(new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN));
2993 }
2995 /* Try to re-reserve track under already crashed train too.
2996 * Crash() clears the reservation! */
3000 }
3002 /** Temporary data storage for testing collisions. */
3006 };
3008 /**
3009 * Collision test function.
3010 * @param v %Train vehicle to test collision with.
3011 * @param data %Train being examined.
3012 * @return \c NULL (always continue search)
3013 */
3015 {
3018 /* not a train or in depot */
3021 /* do not crash into trains of another company. */
3024 /* get first vehicle now to make most usual checks faster */
3027 /* can't collide with own wagons */
3033 /* Do fast calculation to check whether trains are not in close vicinity
3034 * and quickly reject trains distant enough for any collision.
3035 * Differences are shifted by 7, mapping range [-7 .. 8] into [0 .. 15]
3036 * Differences are then ORed and then we check for any higher bits */
3040 /* Slower check using multiplication */
3041 int min_diff = (Train::From(v)->gcache.cached_veh_length + 1) / 2 + (tcc->v->gcache.cached_veh_length + 1) / 2 - 1;
3044 /* Happens when there is a train under bridge next to bridge head */
3047 /* crash both trains */
3052 }
3054 /**
3055 * Checks whether the specified train has a collision with another vehicle. If
3056 * so, destroys this vehicle, and the other vehicle if its subtype has TS_Front.
3057 * Reports the incident in a flashy news item, modifies station ratings and
3058 * plays a sound.
3059 * @param v %Train to test.
3060 */
3062 {
3063 /* can't collide in depot */
3068 TrainCollideChecker tcc;
3072 /* find colliding vehicles */
3078 }
3080 /* any dead -> no crash */
3089 }
3092 {
3098 /* not front engine of a train, inside wormhole or depot, crashed */
3104 }
3106 /**
3107 * Move a vehicle chain one movement stop forwards.
3108 * @param v First vehicle to move.
3109 * @param nomove Stop moving this and all following vehicles.
3110 * @param reverse Set to false to not execute the vehicle reversing. This does not change any other logic.
3111 * @return True if the vehicle could be moved forward, false otherwise.
3112 */
3114 {
3119 /* For every vehicle after and including the given vehicle */
3126 /* Not inside tunnel */
3128 /* Staying in the old tile */
3130 /* Inside depot */
3134 /* Not inside depot */
3136 /* Reverse when we are at the end of the track already, do not move to the new position */
3142 }
3144 /* The new position is the end of the platform */
3146 }
3147 }
3149 /* A new tile is about to be entered. */
3151 /* Determine what direction we're entering the new tile from */
3155 /* Get the status of the tracks in the new tile and mask
3156 * away the bits that aren't reachable. */
3161 TrackBits red_signals = TrackdirBitsToTrackBits(TrackStatusToRedSignals(ts) & reachable_trackdirs);
3165 /* We allow wagons to make 90 deg turns, because forbid_90_deg
3166 * can be switched on halfway a turn */
3168 }
3172 /* Check if the new tile constrains tracks that are compatible
3173 * with the current train, if not, bail out. */
3176 TrackBits chosen_track;
3178 /* Currently the locomotive is active. Determine which one of the
3179 * available tracks to choose */
3180 chosen_track = TrackToTrackBits(ChooseTrainTrack(v, gp.new_tile, enterdir, bits, false, NULL, true));
3184 /* For each signal we find decrease the counter by one.
3185 * We start at two, so the first signal we pass decreases
3186 * this to one, then if we reach the next signal it is
3187 * decreased to zero and we won't pass that new signal. */
3192 /* However, we do not want to be stopped by PBS signals
3193 * entered via the back. */
3196 }
3197 }
3199 /* Check if it's a red signal and that force proceed is not clicked. */
3201 /* In front of a red signal */
3204 /* Don't handle stuck trains here. */
3211 if (!_settings_game.pf.reverse_at_signals || ++v->wait_counter < _settings_game.pf.wait_oneway_signal * 20) return false;
3216 if (!_settings_game.pf.reverse_at_signals || ++v->wait_counter < _settings_game.pf.wait_twoway_signal * 73) {
3222 /* check if a train is waiting on the other side */
3224 }
3225 }
3227 /* If we would reverse but are currently in a PBS block and
3228 * reversing of stuck trains is disabled, don't reverse.
3229 * This does not apply if the reason for reversing is a one-way
3230 * signal blocking us, because a train would then be stuck forever. */
3231 if (!_settings_game.pf.reverse_at_signals && !HasOnewaySignalBlockingTrackdir(gp.new_tile, i) &&
3235 }
3239 }
3241 /* The wagon is active, simply follow the prev vehicle. */
3243 /* Choose the same track as prev */
3245 /* Vehicles entering tunnels enter the wormhole earlier than for bridges.
3246 * However, just choose the track into the wormhole. */
3251 }
3253 /* Choose the track that leads to the tile where prev is.
3254 * This case is active if 'prev' is already on the second next tile, when 'v' just enters the next tile.
3255 * I.e. when the tile between them has only space for a single vehicle like
3256 * 1) horizontal/vertical track tiles and
3257 * 2) some orientations of tunnel entries, where the vehicle is already inside the wormhole at 8/16 from the tile edge.
3258 * Is also the train just reversing, the wagon inside the tunnel is 'on' the tile of the opposite tunnel entry.
3259 */
3265 };
3269 }
3271 }
3273 /* Make sure chosen track is a valid track */
3279 /* Update XY to reflect the entrance to the new tile, and select the direction to use */
3285 /* Call the landscape function and tell it that the vehicle entered the tile */
3289 }
3297 }
3299 /* Clear any track reservation when the last vehicle leaves the tile */
3306 }
3310 }
3312 /* We need to update signal status, but after the vehicle position hash
3313 * has been updated by UpdateInclination() */
3318 const AccelerationSlowdownParams *asp = &_accel_slowdown[GetRailTypeInfo(v->railtype)->acceleration_type];
3320 v->cur_speed -= (diff == DIRDIFF_45RIGHT || diff == DIRDIFF_45LEFT ? asp->small_turn : asp->large_turn) * v->cur_speed >> 8;
3321 }
3324 }
3329 /* If we are approaching a crossing that is reserved, play the sound now. */
3331 if (crossing != INVALID_TILE && HasCrossingReservation(crossing) && _settings_client.sound.ambient) SndPlayTileFx(SND_0E_LEVEL_CROSSING, crossing);
3333 /* Always try to extend the reservation when entering a tile. */
3335 }
3338 /* The new position is the location where we want to stop */
3340 }
3341 }
3343 if (IsTileType(gp.new_tile, MP_TUNNELBRIDGE) && HasBit(VehicleEnterTile(v, gp.new_tile, gp.x, gp.y), VETS_ENTERED_WORMHOLE)) {
3344 /* Perform look-ahead on tunnel exit. */
3348 }
3349 /* Prevent v->UpdateInclination() being called with wrong parameters.
3350 * This could happen if the train was reversed inside the tunnel/bridge. */
3353 }
3360 }
3361 }
3363 /* update image of train, as well as delta XY */
3370 /* update the Z position of the vehicle */
3374 /* This is the first vehicle in the train */
3376 }
3381 /* We are entering a block with PBS signals right now, but
3382 * not through a PBS signal. This means we don't have a
3383 * reservation right now. As a conventional signal will only
3384 * ever be green if no other train is in the block, getting
3385 * a path should always be possible. If the player built
3386 * such a strange network that it is not possible, the train
3387 * will be marked as stuck and the player has to deal with
3388 * the problem. */
3393 }
3394 }
3395 }
3397 /* Signals can only change when the first
3398 * (above) or the last vehicle moves. */
3402 }
3403 }
3405 /* Do not check on every tick to save some computing time. */
3406 if (v->IsFrontEngine() && v->tick_counter % _settings_game.pf.path_backoff_interval == 0) CheckNextTrainTile(v);
3407 }
3413 invalid_rail:
3414 /* We've reached end of line?? */
3417 reverse_train_direction:
3423 }
3426 }
3428 /**
3429 * Collect trackbits of all crashed train vehicles on a tile
3430 * @param v Vehicle passed from Find/HasVehicleOnPos()
3431 * @param data trackdirbits for the result
3432 * @return NULL to iterate over all vehicles on the tile.
3433 */
3435 {
3441 /* Vehicle is inside a wormhole, v->track contains no useful value then. */
3445 }
3446 }
3449 }
3451 /**
3452 * Deletes/Clears the last wagon of a crashed train. It takes the engine of the
3453 * train, then goes to the last wagon and deletes that. Each call to this function
3454 * will remove the last wagon of a crashed train. If this wagon was on a crossing,
3455 * or inside a tunnel/bridge, recalculate the signals as they might need updating
3456 * @param v the Vehicle of which last wagon is to be removed
3457 */
3459 {
3462 /* Go to the last wagon and delete the link pointing there
3463 * *u is then the one-before-last wagon, and *v the last
3464 * one which will physically be removed */
3470 /* Recalculate cached train properties */
3472 /* Update the depot window if the first vehicle is in depot -
3473 * if v == first, then it is updated in PreDestructor() */
3476 }
3478 }
3480 /* 'v' shouldn't be accessed after it has been deleted */
3489 /* Vehicle is inside a wormhole, v->track contains no useful value then. */
3491 }
3497 /* If there are still crashed vehicles on the tile, give the track reservation to them */
3501 /* It is important that these two are the first in the loop, as reservation cannot deal with every trackbit combination */
3503 Track t;
3505 }
3507 /* check if the wagon was on a road/rail-crossing */
3510 /* Update signals */
3515 }
3516 }
3518 /**
3519 * Rotate all vehicles of a (crashed) train chain randomly to animate the crash.
3520 * @param v First crashed vehicle.
3521 */
3523 {
3526 };
3529 /* We don't need to twist around vehicles if they're not visible */
3532 /* Refrain from updating the z position of the vehicle when on
3533 * a bridge, because UpdateInclination() will put the vehicle under
3534 * the bridge in that case */
3540 }
3541 }
3543 }
3545 /**
3546 * Handle a crashed train.
3547 * @param v First train vehicle.
3548 * @return %Vehicle chain still exists.
3549 */
3551 {
3556 }
3558 uint32 r;
3571 EV_EXPLOSION_SMALL);
3573 }
3575 }
3583 }
3586 }
3588 /** Maximum speeds for train that is broken down or approaching line end */
3591 };
3594 /**
3595 * Train is approaching line end, slow down and possibly reverse
3596 *
3597 * @param v front train engine
3598 * @param signal not line end, just a red signal
3599 * @param reverse Set to false to not execute the vehicle reversing. This does not change any other logic.
3600 * @return true iff we did NOT have to reverse
3601 */
3603 {
3604 /* Calc position within the current tile */
3608 /* for diagonal directions, 'x' will be 0..15 -
3609 * for other directions, it will be 1, 3, 5, ..., 15 */
3619 }
3621 /* Do not reverse when approaching red signal. Make sure the vehicle's front
3622 * does not cross the tile boundary when we do reverse, but as the vehicle's
3623 * location is based on their center, use half a vehicle's length as offset.
3624 * Multiply the half-length by two for straight directions to compensate that
3625 * we only get odd x offsets there. */
3626 if (!signal && x + (v->gcache.cached_veh_length + 1) / 2 * (IsDiagonalDirection(v->direction) ? 1 : 2) >= TILE_SIZE) {
3627 /* we are too near the tile end, reverse now */
3631 }
3633 /* slow down */
3639 }
3642 /**
3643 * Determines whether train would like to leave the tile
3644 * @param v train to test
3645 * @return true iff vehicle is NOT entering or inside a depot or tunnel/bridge
3646 */
3648 {
3649 /* Exit if inside a tunnel/bridge or a depot */
3654 /* entering a tunnel/bridge? */
3658 }
3660 /* entering a depot? */
3664 }
3667 }
3670 /**
3671 * Determines whether train is approaching a rail-road crossing
3672 * (thus making it barred)
3673 * @param v front engine of train
3674 * @return TileIndex of crossing the train is approaching, else INVALID_TILE
3675 * @pre v in non-crashed front engine
3676 */
3678 {
3687 /* not a crossing || wrong axis || unusable rail (wrong type or owner) */
3691 }
3694 }
3697 /**
3698 * Checks for line end. Also, bars crossing at next tile if needed
3699 *
3700 * @param v vehicle we are checking
3701 * @param reverse Set to false to not execute the vehicle reversing. This does not change any other logic.
3702 * @return true iff we did NOT have to reverse
3703 */
3705 {
3706 /* First, handle broken down train */
3716 }
3720 /* Determine the non-diagonal direction in which we will exit this tile */
3722 /* Calculate next tile */
3725 /* Determine the track status on the next tile */
3732 /* We are sure the train is not entering a depot, it is detected above */
3734 /* mask unreachable track bits if we are forbidden to do 90deg turns */
3738 }
3740 /* no suitable trackbits at all || unusable rail (wrong type or owner) */
3743 }
3745 /* approaching red signal */
3748 /* approaching a rail/road crossing? then make it red */
3752 }
3756 {
3757 /* train has crashed? */
3760 }
3765 }
3767 /* train is broken down? */
3772 }
3774 /* exit if train is stopped */
3777 bool valid_order = !v->current_order.IsType(OT_NOTHING) && v->current_order.GetType() != OT_CONDITIONAL;
3786 /* Try to reserve a path when leaving the station as we
3787 * might not be marked as wanting a reservation, e.g.
3788 * when an overlength train gets turned around in a station. */
3792 if (UpdateSignalsOnSegment(v->tile, dir, v->owner) == SIGSEG_PBS || _settings_game.pf.reserve_paths) {
3794 }
3796 }
3806 /* We had no order but have an order now, do look ahead. */
3809 }
3811 /* Handle stuck trains. */
3815 /* Should we try reversing this tick if still stuck? */
3816 bool turn_around = v->wait_counter % (_settings_game.pf.wait_for_pbs_path * DAY_TICKS) == 0 && _settings_game.pf.reverse_at_signals;
3818 if (!turn_around && v->wait_counter % _settings_game.pf.path_backoff_interval != 0 && v->force_proceed == TFP_NONE) return true;
3820 /* Still stuck. */
3823 if (HasBit(v->flags, VRF_TRAIN_STUCK) && v->wait_counter > 2 * _settings_game.pf.wait_for_pbs_path * DAY_TICKS) {
3824 /* Show message to player. */
3828 }
3830 }
3831 /* Exit if force proceed not pressed, else reset stuck flag anyway. */
3836 }
3837 }
3843 }
3847 /* we need to invalidate the widget if we are stopping from 'Stopping 0 km/h' to 'Stopped' */
3849 /* If we manually stopped, we're not force-proceeding anymore. */
3852 }
3856 /* if the vehicle has speed 0, update the last_speed field. */
3860 /* Loop until the train has finished moving. */
3864 /* Don't continue to move if the train crashed. */
3866 /* Determine distance to next map position */
3869 /* No more moving this tick */
3873 /* Do not skip waypoints (incl. 'via' stations) when passing through at full speed. */
3879 }
3880 }
3882 }
3888 }
3890 if (v->progress == 0) v->progress = j; // Save unused spd for next time, if TrainController didn't set progress
3893 }
3895 /**
3896 * Get running cost for the train consist.
3897 * @return Yearly running costs.
3898 */
3900 {
3908 uint cost_factor = GetVehicleProperty(v, PROP_TRAIN_RUNNING_COST_FACTOR, e->u.rail.running_cost);
3911 /* Halve running cost for multiheaded parts */
3918 }
3920 /**
3921 * Update train vehicle data for a tick.
3922 * @return True if the vehicle still exists, false if it has ceased to exist (front of consists only).
3923 */
3925 {
3937 /* Delete flooded standalone wagon chain */
3941 }
3942 }
3945 }
3947 /**
3948 * Check whether a train needs service, and if so, find a depot or service it.
3949 * @return v %Train to check.
3950 */
3952 {
3953 if (Company::Get(v->owner)->settings.vehicle.servint_trains == 0 || !v->NeedsAutomaticServicing()) return;
3957 }
3959 uint max_penalty;
3964 }
3967 /* Only go to the depot if it is not too far out of our way. */
3970 /* If we were already heading for a depot but it has
3971 * suddenly moved farther away, we continue our normal
3972 * schedule? */
3975 }
3977 }
3985 }
3991 }
3993 /** Update day counters of the train vehicle. */
3995 {
4007 /* update destination */
4011 }
4014 /* running costs */
4015 CommandCost cost(EXPENSES_TRAIN_RUN, this->GetRunningCost() * this->running_ticks / (DAYS_IN_YEAR * DAY_TICKS));
4024 }
4025 }
4026 }
4028 /**
4029 * Get the tracks of the train vehicle.
4030 * @return Current tracks of the vehicle.
4031 */
4033 {
4037 /* We'll assume the train is facing outwards */
4039 }
4042 /* train in tunnel or on bridge, so just use his direction and assume a diagonal track */
4044 }
4047 }