| blob | c0603da2c00684a5c0b80a42a2cd0c5cf64e9bbf |
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file afterload.cpp Code updating data after game load */
68 #include <signal.h>
75 /**
76 * Makes a tile canal or water depending on the surroundings.
77 *
78 * Must only be used for converting old savegames. Use WaterClass now.
79 *
80 * This as for example docks and shipdepots do not store
81 * whether the tile used to be canal or 'normal' water.
82 * @param t the tile to change.
83 * @param include_invalid_water_class Also consider WATER_CLASS_INVALID, i.e. industry tiles on land
84 */
86 {
87 /* If the slope is not flat, we always assume 'land' (if allowed). Also for one-corner-raised-shores.
88 * Note: Wrt. autosloping under industry tiles this is the most fool-proof behaviour. */
95 }
96 }
98 /* Mark tile dirty in all cases */
101 if (TileX(t) == 0 || TileY(t) == 0 || TileX(t) == Map::MaxX() - 1 || TileY(t) == Map::MaxY() - 1) {
102 /* tiles at map borders are always WATER_CLASS_SEA */
105 }
115 /* clear water and shipdepots have already a WaterClass associated */
124 }
125 }
129 /* Shore or flooded halftile */
134 /* trees on shore */
139 }
140 }
145 }
153 }
154 }
157 {
163 }
171 }
172 }
173 }
175 /* since savegame version 4.1, exclusive transport rights are stored at towns */
177 {
180 }
182 /* FIXME old exclusive rights status is not being imported (stored in s->blocked_months_obsolete)
183 * could be implemented this way:
184 * 1.) Go through all stations
185 * Build an array town_blocked[ town_id ][ company_id ]
186 * that stores if at least one station in that town is blocked for a company
187 * 2.) Go through that array, if you find a town that is not blocked for
188 * one company, but for all others, then give it exclusivity.
189 */
190 }
198 };
200 /* since savegame version 4.2 the currencies are arranged differently */
202 {
204 }
206 /* Up to revision 1413 the invisible tiles at the southern border have not been
207 * MP_VOID, even though they should have. This is fixed by this function
208 */
210 {
213 }
216 {
218 }
220 /**
221 * Update the viewport coordinates of all signs.
222 */
224 {
230 }
233 {
237 }
239 /**
240 * Initialization of the windows and several kinds of caches.
241 * This is not done directly in AfterLoadGame because these
242 * functions require that all saveload conversions have been
243 * done. As people tend to add savegame conversion stuff after
244 * the initialization of the windows and caches quite some bugs
245 * had been made.
246 * Moving this out of there is both cleaner and less bug-prone.
247 */
249 {
250 /* Initialize windows */
254 /* Update coordinates of the signs. */
260 /* For each company, verify (while loading a scenario) that the inauguration date is the current year and set it
261 * accordingly if it is not the case. No need to set it on companies that are not been used already,
262 * thus the MIN_YEAR (which is really nothing more than Zero, initialized value) test */
263 if (_file_to_saveload.abstract_ftype == FT_SCENARIO && c->inaugurated_year != EconomyTime::MIN_YEAR) {
265 }
266 }
268 /* Count number of objects per type */
271 }
273 /* Identify owners of persistent storage arrays */
278 }
279 }
284 }
285 }
290 }
291 }
295 }
296 }
304 /* Towns have a noise controlled number of airports system
305 * So each airport's noise value must be added to the town->noise_reached value
306 * Reset each town's noise_reached value to '0' before. */
312 /* Rebuild the smallmap list of owners. */
314 }
323 /**
324 * Replaces signal handlers of SIGSEGV and SIGABRT
325 * and stores pointers to original handlers in memory.
326 */
328 {
332 }
334 /**
335 * Resets signal handlers back to original handlers.
336 */
338 {
342 }
344 /** Was the saveload crash because of missing NewGRFs? */
347 /**
348 * Did loading the savegame cause a crash? If so,
349 * were NewGRFs missing?
350 * @return when the saveload crashed due to missing NewGRFs.
351 */
353 {
355 }
357 /**
358 * Signal handler used to give a user a more useful report for crashes during
359 * the savegame loading process; especially when there's problems with the
360 * NewGRFs that are required by the savegame.
361 * @param signum received signal
362 */
364 {
371 for (const GRFConfig *c = _grfconfig; !_saveload_crash_with_missing_newgrfs && c != nullptr; c = c->next) {
372 _saveload_crash_with_missing_newgrfs = HasBit(c->flags, GCF_COMPATIBLE) || c->status == GCS_NOT_FOUND;
373 }
376 message +=
392 fmt::format_to(std::back_inserter(message), "NewGRF {:08X} (checksum {}) not found.\n Loaded NewGRF \"{}\" (checksum {}) with same GRF ID instead.\n",
393 BSWAP32(c->ident.grfid), FormatArrayAsHex(c->original_md5sum), c->filename, FormatArrayAsHex(replaced->md5sum));
394 }
398 }
399 }
401 message +=
404 }
414 }
416 }
418 /**
419 * Tries to change owner of this rail tile to a valid owner. In very old versions it could happen that
420 * a rail track had an invalid owner. When conversion isn't possible, track is removed.
421 * @param t tile to update
422 */
424 {
427 /* remove leftover rail piece from crossing (from very old savegames) */
433 }
434 }
437 /* when there is a train on crossing (it could happen in TTD), set owner of crossing to train owner */
440 }
442 /* try to find any connected rail */
450 }
451 }
454 /* else change the crossing to normal road (road vehicles won't care) */
461 /* MakeRoadNormal */
469 }
471 /* if it's not a crossing, make it clean land */
473 }
475 /**
476 * Fixes inclination of a vehicle. Older OpenTTD versions didn't update the bits correctly.
477 * @param v vehicle
478 * @param dir vehicle's direction, or # INVALID_DIR if it can be ignored
479 * @return inclination bits to set
480 */
482 {
483 /* Compute place where this vehicle entered the tile */
493 }
496 /* Compute middle of the tile. */
501 /* middle_z == entry_z, no height change. */
504 /* middle_z < entry_z, we are going downwards. */
507 /* middle_z > entry_z, we are going upwards. */
509 }
511 /**
512 * Check whether the ground vehicles are at the correct Z-coordinate. When they
513 * are not, this will cause all kinds of problems later on as the vehicle might
514 * not get onto bridges and so on.
515 */
517 {
520 /*
521 * Either the vehicle is not actually on the given tile, i.e. it is
522 * in the wormhole of a bridge or a tunnel, or the Z-coordinate must
523 * be the same as when it would be recalculated right now.
524 */
525 assert(v->tile != TileVirtXY(v->x_pos, v->y_pos) || v->z_pos == GetSlopePixelZ(v->x_pos, v->y_pos, true));
526 }
527 }
528 }
530 /**
531 * Checks for the possibility that a bridge may be on this tile
532 * These are in fact all the tile types on which a bridge can be found
533 * @param t The tile to analyze
534 * @return True if a bridge might have been present prior to savegame 194.
535 */
537 {
540 }
542 /**
543 * Start the scripts.
544 */
546 {
547 /* Script debug window requires AIs to be started before trying to start GameScript. */
549 /* Start the AIs. */
552 }
554 /* Start the GameScript. */
558 }
560 /**
561 * Perform a (large) amount of savegame conversion *magic* in order to
562 * load older savegames and to fill the caches for various purposes.
563 * @return True iff conversion went without a problem.
564 */
566 {
570 /* The LFSR used in RunTileLoop iteration cannot have a zeroed state, make it non-zeroed. */
580 /* This needs to be done even before conversion, because some conversions will destroy objects
581 * that otherwise won't exist in the tree. */
591 /* Restore the signals */
595 /* If we are in singleplayer mode, i.e. not networking, and loading the
596 * savegame or we are loading the savegame as network server we do
597 * not want to be bothered by being paused because of the automatic
598 * reason of a network server, e.g. joining clients or too few
599 * active clients. Note that resetting these values for a network
600 * client are very bad because then the client is going to execute
601 * the game loop when the server is not, i.e. it desyncs. */
603 }
605 /* In very old versions, size of train stations was stored differently.
606 * They had swapped width and height if station was built along the Y axis.
607 * TTO and TTD used 3 bits for width/height, while OpenTTD used 4.
608 * Because the data stored by TTDPatch are unusable for rail stations > 7x7,
609 * recompute the width and height. Doing this unconditionally for all old
610 * savegames simplifies the code. */
614 }
625 }
626 }
631 /* In old savegame versions, the heightlevel was coded in bits 0..3 of the type field */
641 }
642 }
643 }
645 /* in version 2.1 of the savegame, town owner was unified. */
648 /* from version 4.1 of the savegame, exclusive rights are stored at towns */
651 /* from version 4.2 of the savegame, currencies are in a different order */
654 /* In old version there seems to be a problem that water is owned by
655 * OWNER_NONE, not OWNER_WATER.. I can't replicate it for the current
656 * (4.3) version, so I just check when versions are older, and then
657 * walk through the whole map.. */
662 }
663 }
664 }
672 }
676 /* generating new name would be too much work for little effect, use the station name fallback */
678 }
682 if (!t->name.empty()) t->townnametype = SPECSTR_TOWNNAME_START + _settings_game.game_creation.town_name;
683 }
684 }
686 /* From this point the old names array is cleared. */
690 /* no station is determined by 'tile == INVALID_TILE' now (instead of '0') */
694 }
696 /* the same applies to Company::location_of_HQ */
698 if (c->location_of_HQ == 0 || (IsSavegameVersionBefore(SLV_4) && c->location_of_HQ == 0xFFFF)) {
700 }
701 }
702 }
704 /* convert road side to my format. */
707 /* Check if all NewGRFs are present, we are very strict in MP mode */
714 }
715 }
719 /* Restore the signals */
722 }
725 case GLC_COMPATIBLE: ShowErrorMessage(STR_NEWGRF_COMPATIBLE_LOAD_WARNING, INVALID_STRING_ID, WL_CRITICAL); break;
726 case GLC_NOT_FOUND: ShowErrorMessage(STR_NEWGRF_DISABLED_WARNING, INVALID_STRING_ID, WL_CRITICAL); _pause_mode = PM_PAUSED_ERROR; break;
728 }
730 /* The value of TimerGameCalendar::date_fract got divided, so make sure that old games are converted correctly. */
731 if (IsSavegameVersionBefore(SLV_11, 1) || (IsSavegameVersionBefore(SLV_147) && TimerGameCalendar::date_fract > Ticks::DAY_TICKS)) TimerGameCalendar::date_fract /= 885;
733 /* Update current year
734 * must be done before loading sprites as some newgrfs check it */
737 /* Only new games can use wallclock units. */
738 if (IsSavegameVersionBefore(SLV_ECONOMY_MODE_TIMEKEEPING_UNITS)) _settings_game.economy.timekeeping_units = TKU_CALENDAR;
740 /* Update economy year. If we don't have a separate economy date saved, follow the calendar date. */
745 }
747 /*
748 * Force the old behaviour for compatibility reasons with old savegames. As new
749 * settings can only be loaded from new savegames loading old savegames with new
750 * versions of OpenTTD will normally initialize settings newer than the savegame
751 * version with "new game" defaults which the player can define to their liking.
752 * For some settings we override that to keep the behaviour the same as when the
753 * game was saved.
754 *
755 * Note that there is no non-stop in here. This is because the setting could have
756 * either value in TTDPatch. To convert it properly the user has to make sure the
757 * right value has been chosen in the settings. Otherwise we will be converting
758 * it incorrectly in half of the times without a means to correct that.
759 */
768 }
774 }
780 }
781 if (IsSavegameVersionBefore(SLV_166)) _settings_game.economy.infrastructure_maintenance = false;
787 }
791 }
793 /* Convert linkgraph update settings from days to seconds. */
797 }
799 /* Load the sprites */
803 /* Copy temporary data to Engine pool */
806 /* Connect front and rear engines of multiheaded trains and converts
807 * subtype to the new format */
810 /* Connect front and rear engines of multiheaded trains */
813 /* Fix the CargoPackets *and* fix the caches of CargoLists.
814 * If this isn't done before Stations and especially Vehicles are
815 * running their AfterLoad we might get in trouble. In the case of
816 * vehicles we could give the wrong (cached) count of items in a
817 * vehicle which causes different results when getting their caches
818 * filled; and that could eventually lead to desyncs. */
821 /* Update all vehicles: Phase 1 */
824 /* make sure there is a town in the game */
827 /* Restore the signals */
830 }
832 /* The void tiles on the southern border used to belong to a wrong class (pre 4.3).
833 * This problem appears in savegame version 21 too, see r3455. But after loading the
834 * savegame and saving again, the buggy map array could be converted to new savegame
835 * version. It didn't show up before r12070. */
838 /* Fix the cache for cargo payments. */
842 }
846 /* Prior to SLV_WATER_TILE_TYPE, the water tile type was stored differently from the enumeration. This has to be
847 * converted before SLV_72 and SLV_82 conversions which use GetWaterTileType. */
861 }
862 }
863 }
866 /* Locks in very old savegames had OWNER_WATER as owner */
872 if (GetWaterTileType(t) == WATER_TILE_LOCK && GetTileOwner(t) == OWNER_WATER) SetTileOwner(t, OWNER_NONE);
878 StationType st;
910 /* Restore the signals */
913 }
916 }
917 }
918 }
919 }
922 /* Expansion of station type field in m6 */
926 }
927 }
928 }
935 /* Sanity check */
936 if (!IsBuoy(t) && bst->owner != GetTileOwner(t)) SlErrorCorrupt("Wrong owner for station tile");
938 /* Set up station spread */
941 /* Waypoints don't have road stops/oil rigs in the old format */
949 /* Before version 5 you could not have more than 250 stations.
950 * Version 6 adds large maps, so you could only place 253*253
951 * road stops on a map (no freeform edges) = 64009. So, yes
952 * someone could in theory create such a full map to trigger
953 * this assertion, it's safe to assume that's only something
954 * theoretical and does not happen in normal games. */
957 /* From this version on there can be multiple road stops of the
958 * same type per station. Convert the existing stops to the new
959 * internal data structure. */
965 }
969 /* The internal encoding of oil rigs was changed twice.
970 * It was 3 (till 2.2) and later 5 (till 5.1).
971 * DeleteOilRig asserts on the correct type, and
972 * setting it unconditionally does not hurt.
973 */
976 /* Very old savegames sometimes have phantom oil rigs, i.e.
977 * an oil rig which got shut down, but not completely removed from
978 * the map
979 */
983 }
985 }
988 }
990 }
993 }
994 }
996 /* In version 6.1 we put the town index in the map-array. To do this, we need
997 * to use m2 (16bit big), so we need to clean m2, and that is where this is
998 * all about ;) */
1009 if ((GB(t.m5(), 4, 2) == ROAD_TILE_CROSSING ? (Owner)t.m3() : GetTileOwner(t)) == OWNER_TOWN) {
1013 }
1017 }
1018 }
1019 }
1021 /* Force the freeform edges to false for old savegames. */
1024 }
1026 /* From version 9.0, we update the max passengers of a town (was sometimes negative
1027 * before that. */
1030 }
1032 /* From version 16.0, we included autorenew on engines, which are now saved, but
1033 * of course, we do need to initialize them for older savegames. */
1040 }
1042 /* When loading a game, _local_company is not yet set to the correct value.
1043 * However, in a dedicated server we are a spectator, so nothing needs to
1044 * happen. In case we are not a dedicated server, the local company always
1045 * becomes the first available company, unless we are in the scenario editor
1046 * where all the companies are 'invalid'.
1047 */
1051 }
1052 }
1059 /* Swap ground type and signal type for plain rail tiles, so the
1060 * ground type uses the same bits as for depots and waypoints. */
1065 /* Split waypoint and depot rail type and remove the subtype. */
1068 }
1072 /* Swap m3 and m4, so the track type for rail crossings is the
1073 * same as for normal rail. */
1078 }
1079 }
1080 }
1083 /* Added the RoadType */
1100 }
1109 /* Middle part of "old" bridges */
1111 if (((old_bridge && IsBridge(t)) ? (TransportType)GB(t.m5(), 1, 2) : GetTunnelBridgeTransportType(t)) == TRANSPORT_ROAD) {
1113 }
1117 }
1118 }
1119 }
1150 }
1154 }
1169 if (((old_bridge && IsBridge(t)) ? (TransportType)GB(t.m5(), 1, 2) : GetTunnelBridgeTransportType(t)) == TRANSPORT_ROAD) {
1175 }
1184 }
1185 }
1186 }
1188 /* Railtype moved from m3 to m8 in version SLV_EXTEND_RAILTYPES. */
1199 }
1205 }
1211 }
1216 }
1217 }
1218 }
1230 t,
1234 );
1238 /* MakeRoadNormal */
1246 }
1258 }
1259 }
1260 }
1261 }
1270 }
1271 }
1272 }
1286 }
1292 }
1297 }
1298 }
1299 }
1302 /* Add road subtypes */
1317 }
1326 }
1327 }
1328 }
1330 /* Elrails got added in rev 24 */
1339 }
1341 /* .. so we convert the entire map from normal to elrail (so maintain "fairness") */
1351 }
1357 }
1363 }
1368 }
1369 }
1370 }
1372 /* In version 16.1 of the savegame a company can decide if trains, which get
1373 * replaced, shall keep their old length. In all prior versions, just default
1374 * to false */
1377 }
1380 /* Waypoints became subclasses of stations ... */
1382 /* ... and buoys were moved to waypoints. */
1384 }
1386 /* From version 15, we moved a semaphore bit from bit 2 to bit 3 in m4, making
1387 * room for PBS. Now in version 21 move it back :P. */
1393 /* Original signal type/variant was stored in m4 but since saveload
1394 * version 48 they are in m2. The bits has been already moved to m2
1395 * (see the code somewhere above) so don't use m4, use m2 instead. */
1397 /* convert PBS signals to combo-signals */
1400 /* move the signal variant back */
1403 }
1405 /* Clear PBS reservation on track */
1410 }
1418 }
1419 }
1420 }
1425 }
1426 }
1431 }
1432 }
1438 }
1443 }
1447 /* Time starts at 0 instead of 1920.
1448 * Account for this in older games by adding an offset */
1455 for (Station *st : Station::Iterate()) st->build_date += CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR;
1456 for (Waypoint *wp : Waypoint::Iterate()) wp->build_date += CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR;
1457 for (Engine *e : Engine::Iterate()) e->intro_date += CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR;
1464 }
1465 }
1467 /* From 32 on we save the industry who made the farmland.
1468 * To give this prettiness to old savegames, we remove all farmfields and
1469 * plant new ones. */
1473 /* remove fields */
1475 }
1476 }
1479 uint j;
1483 }
1484 }
1485 }
1487 /* Setting no refit flags to all orders in savegames from before refit in orders were added */
1491 }
1495 }
1496 }
1498 /* from version 38 we have optional elrails, since we cannot know the
1499 * preference of a user, let elrails enabled; it can be disabled manually */
1501 /* do the same as when elrails were enabled/disabled manually just now */
1505 /* From version 53, the map array was changed for house tiles to allow
1506 * space for newhouses grf features. A new byte, m7, was also added. */
1511 /* Move the construction stage from m3[7..6] to m5[5..4].
1512 * The construction counter does not have to move. */
1516 /* The "house is completed" bit is now in m6[2]. */
1519 /* The "lift has destination" bit has been moved from
1520 * m5[7] to m7[0]. */
1524 /* The "lift is moving" bit has been removed, as it does
1525 * the same job as the "lift has destination" bit. */
1528 /* The position of the lift goes from m1[7..0] to m6[7..2],
1529 * making m1 totally free, now. The lift position does not
1530 * have to be a full byte since the maximum value is 36. */
1536 }
1537 }
1538 }
1539 }
1541 /* Check and update house and town values */
1566 }
1567 }
1568 }
1569 }
1572 /* Originally just the fact that some cargo had been paid for was
1573 * stored to stop people cheating and cashing in several times. This
1574 * wasn't enough though as it was cleared when the vehicle started
1575 * loading again, even if it didn't actually load anything, so now the
1576 * amount that has been paid is stored. */
1579 }
1580 }
1582 /* Buoys do now store the owner of the previous water tile, which can never
1583 * be OWNER_NONE. So replace OWNER_NONE with OWNER_WATER. */
1586 if ((wp->facilities & FACIL_DOCK) != 0 && IsTileOwner(wp->xy, OWNER_NONE) && TileHeight(wp->xy) == 0) SetTileOwner(wp->xy, OWNER_WATER);
1587 }
1588 }
1591 /* Aircraft units changed from 8 mph to 1 km-ish/h */
1598 }
1599 }
1600 }
1602 if (IsSavegameVersionBefore(SLV_49)) for (Company *c : Company::Iterate()) c->face = ConvertFromOldCompanyManagerFace(c->face);
1608 }
1609 }
1610 }
1612 /* A setting containing the proportion of towns that grow twice as
1613 * fast was added in version 54. From version 56 this is now saved in the
1614 * town as cities can be built specifically in the scenario editor. */
1617 if (_settings_game.economy.larger_towns != 0 && (t->index % _settings_game.economy.larger_towns) == 0) {
1619 }
1620 }
1621 }
1624 /* Added a FIFO queue of vehicles loading at stations */
1631 /* The loading finished flag is *only* set when actually completely
1632 * finished. Because the vehicle is loading, it is not finished. */
1634 }
1635 }
1637 /* For some reason non-loading vehicles could be in the station's loading vehicle list */
1640 for (auto iter = st->loading_vehicles.begin(); iter != st->loading_vehicles.end(); /* nothing */) {
1646 }
1647 }
1648 }
1649 }
1652 /* Setting difficulty industry_density other than zero get bumped to +1
1653 * since a new option (very low at position 1) has been added */
1656 }
1658 /* Same goes for number of towns, although no test is needed, just an increment */
1660 }
1663 /* Since now we allow different signal types and variants on a single tile.
1664 * Move signal states to m4 to make room and clone the signal type/variant. */
1667 /* move signal states */
1670 /* clone signal type and variant */
1672 }
1673 }
1674 }
1677 /* In some old savegames a bit was cleared when it should not be cleared */
1681 }
1682 }
1683 }
1686 /* Added variables to support newindustries */
1688 }
1690 /* From version 82, old style canals (above sealevel (0), WATER owner) are no longer supported.
1691 Replace the owner for those by OWNER_NONE. */
1699 }
1700 }
1701 }
1703 /*
1704 * Add the 'previous' owner to the ship depots so we can reset it with
1705 * the correct values when it gets destroyed. This prevents that
1706 * someone can remove canals owned by somebody else and it prevents
1707 * making floods using the removal of ship depots.
1708 */
1713 }
1714 }
1715 }
1722 }
1723 }
1724 }
1726 /* At version 78, industry cargo types can be changed, and are stored with the industry. For older save versions
1727 * copy the IndustrySpec's cargo types over to the Industry. */
1733 }
1736 }
1737 }
1738 }
1740 /* Industry cargo slots were fixed size before (and including) SLV_VEHICLE_ECONOMY_AGE (either 2/3 or 16/16),
1741 * after this they are dynamic. Trim excess slots. */
1745 }
1746 }
1748 /* Before version 81, the density of grass was always stored as zero, and
1749 * grassy trees were always drawn fully grassy. Furthermore, trees on rough
1750 * land used to have zero density, now they have full density. Therefore,
1751 * make all grassy/rough land trees have a density of 3. */
1757 }
1758 }
1759 }
1763 /* Rework of orders. */
1767 if (v->orders != nullptr && v->orders->GetFirstOrder() != nullptr && v->orders->GetFirstOrder()->IsType(OT_NOTHING)) {
1770 }
1775 }
1776 }
1778 /* Unload and transfer are now mutual exclusive. */
1780 if ((order->GetUnloadType() & (OUFB_UNLOAD | OUFB_TRANSFER)) == (OUFB_UNLOAD | OUFB_TRANSFER)) {
1783 }
1784 }
1787 if ((v->current_order.GetUnloadType() & (OUFB_UNLOAD | OUFB_TRANSFER)) == (OUFB_UNLOAD | OUFB_TRANSFER)) {
1790 }
1791 }
1793 /* OrderDepotActionFlags were moved, instead of starting at bit 4 they now start at bit 3. */
1797 }
1801 v->current_order.SetDepotActionType((OrderDepotActionFlags)(v->current_order.GetDepotActionType() >> 1));
1802 }
1803 }
1805 /* The water class was moved/unified. */
1821 }
1834 /* No water class. */
1836 }
1837 }
1838 }
1842 /* Move river flag and update canals to use water class */
1851 }
1855 }
1856 }
1857 }
1858 }
1860 /* Update locks, depots, docks and buoys to have a water class based
1861 * on its neighbouring tiles. Done after river and canal updates to
1862 * ensure neighbours are correct. */
1867 if (IsTileType(t, MP_STATION) && (IsDock(t) || IsBuoy(t))) SetWaterClassDependingOnSurroundings(t, false);
1868 }
1869 }
1873 /* skip oil rigs at borders! */
1875 (TileX(t) == 0 || TileY(t) == 0 || TileX(t) == Map::MaxX() - 1 || TileY(t) == Map::MaxY() - 1)) {
1876 /* Some version 86 savegames have wrong water class at map borders (under buoy, or after removing buoy).
1877 * This conversion has to be done before buoys with invalid owner are removed. */
1879 }
1887 }
1889 /* reset buoy owner to OWNER_NONE in the station struct
1890 * (even if it is owned by active company) */
1892 }
1894 /* works for all RoadTileType */
1896 /* update even non-existing road types to update tile owner too */
1899 }
1902 }
1905 }
1906 }
1907 }
1910 /* Profits are now with 8 bit fract */
1915 }
1916 }
1919 /* Increase HouseAnimationFrame from 5 to 7 bits */
1924 }
1925 }
1926 }
1929 GroupStatistics::UpdateAfterLoad(); // Ensure statistics pool is initialised before trying to delete vehicles
1930 /* Remove all trams from savegames without tram support.
1931 * There would be trams without tram track under causing crashes sooner or later. */
1936 }
1937 }
1938 }
1942 /* Set newly introduced WaterClass of industry tiles */
1945 }
1951 }
1952 }
1954 /* Replace "house construction year" with "house age" */
1956 t.m5() = ClampTo<uint8_t>(TimerGameCalendar::year - (t.m5() + CalendarTime::ORIGINAL_BASE_YEAR));
1957 }
1958 }
1959 }
1961 /* Move the signal variant back up one bit for PBS. We don't convert the old PBS
1962 * format here, as an old layout wouldn't work properly anyway. To be safe, we
1963 * clear any possible PBS reservations as well. */
1969 /* move the signal variant */
1974 }
1976 /* Clear PBS reservation on track */
1981 }
1997 }
1998 }
1999 }
2001 /* Reserve all tracks trains are currently on. */
2005 }
2006 }
2009 /* Non-town-owned roads now store the closest town */
2012 /* signs with invalid owner left from older savegames */
2015 }
2017 /* Station can get named based on an industry type, but the current ones
2018 * are not, so mark them as if they are not named by an industry. */
2021 }
2022 }
2026 /* Set engine_type of shadow and rotor */
2029 }
2030 }
2032 /* More companies ... */
2035 }
2039 }
2044 }
2045 }
2049 /* Check for HQ bit being set, instead of using map accessor,
2050 * since we've already changed it code-wise */
2052 /* Move size and part identification of HQ out of the m5 attribute,
2053 * on new locations */
2056 }
2057 }
2058 }
2063 /* Reordering/generalisation of the object bits. */
2068 /* Make sure those bits are clear as well! */
2071 }
2072 }
2075 /* Make real objects for object tiles. */
2080 /* No towns, so remove all objects! */
2085 /* Also move the animation state. */
2090 /* No offset, so make the object. */
2095 /* Nice... you managed to place 64k lighthouses and
2096 * antennae on the map... boohoo. */
2098 }
2109 /* We're at an offset, so get the ID from our "root". */
2113 }
2114 }
2115 }
2116 }
2119 /* allow_town_roads is added, set it if town_layout wasn't TL_NO_ROADS */
2125 _settings_game.economy.town_layout = static_cast<TownLayout>(_settings_game.economy.town_layout - 1);
2126 }
2128 /* Initialize layout of all towns. Older versions were using different
2129 * generator for random town layout, use it if needed. */
2134 }
2136 /* Use old layout randomizer code */
2142 }
2144 }
2145 }
2148 /* There could be (deleted) stations with invalid owner, set owner to OWNER NONE.
2149 * The conversion affects oil rigs and buoys too, but it doesn't matter as
2150 * they have st->owner == OWNER_NONE already. */
2153 }
2154 }
2156 /* Trains could now stop in a specific location. */
2160 }
2161 }
2167 }
2168 }
2171 /* Delete small ufos heading for non-existing vehicles */
2177 }
2178 }
2179 }
2181 /* We didn't store cargo payment yet, so make them for vehicles that are
2182 * currently at a station and loading/unloading. If they don't get any
2183 * payment anymore they just removed in the next load/unload cycle.
2184 * However, some 0.7 versions might have cargo payment. For those we just
2185 * add cargopayment for the vehicles that don't have it.
2186 */
2189 /* There are always as many CargoPayments as Vehicles. We need to make the
2190 * assert() in Pool::GetNew() happy by calling CanAllocateItem(). */
2194 }
2195 }
2196 }
2199 /* Animated tiles would sometimes not be actually animated or
2200 * in case of old savegames duplicate. */
2205 /* Remove if tile is not animated */
2208 /* and remove if duplicate */
2211 }
2216 tile++;
2217 }
2218 }
2219 }
2222 /* The train station tile area was added, but for really old (TTDPatch) it's already valid. */
2232 }
2233 }
2234 }
2237 /* Convert old subsidies */
2240 /* Converting nonawarded subsidy */
2247 /* Town -> Town */
2253 /* Industry -> Town */
2259 /* Industry -> Industry */
2263 }
2265 /* Do our best for awarded subsidies. The original source or destination industry
2266 * can't be determined anymore for awarded subsidies, so invalidate them.
2267 * Town -> Town subsidies are converted using simple heuristic */
2273 /* Town -> Town */
2283 }
2285 }
2288 }
2289 }
2290 /* Awarded non-town subsidy or invalid source/destination, invalidate */
2292 }
2293 }
2296 /* Recompute inflation based on old unround loan limit
2297 * Note: Max loan is 500000. With an inflation of 4% across 170 years
2298 * that results in a max loan of about 0.7 * 2^31.
2299 * So taking the 16 bit fractional part into account there are plenty of bits left
2300 * for unmodified savegames ...
2301 */
2302 uint64_t aimed_inflation = (_economy.old_max_loan_unround << 16 | _economy.old_max_loan_unround_fract) / _settings_game.difficulty.max_loan;
2304 /* ... well, just clamp it then. */
2307 /* Simulate the inflation, so we also get the payment inflation */
2310 }
2311 }
2316 /* At some point, invalid depots were saved into the game (possibly those removed in the past?)
2317 * Remove them here, so they don't cause issues further down the line */
2323 }
2326 }
2327 }
2329 /* The behaviour of force_proceed has been changed. Now
2330 * it counts signals instead of some random time out. */
2335 }
2336 }
2337 }
2339 /* The bits for the tree ground and tree density have
2340 * been swapped (m2 bits 7..6 and 5..4. */
2349 }
2350 }
2355 }
2356 }
2357 }
2359 /* Wait counter and load/unload ticks got split. */
2363 }
2367 }
2368 }
2370 /* Airport tile animation uses animation frame instead of other graphics id */
2375 };
2386 };
2395 }
2400 }
2402 }
2403 }
2404 }
2405 }
2407 /* Oilrig was moved from id 15 to 9. */
2412 }
2413 }
2414 }
2421 }
2422 }
2423 }
2427 /* Reset tropic zone for VOID tiles, they shall not have any. */
2429 }
2431 /* We need to properly number/name the depots.
2432 * The first step is making sure none of the depots uses the
2433 * 'default' names, after that we can assign the names. */
2437 }
2441 }
2443 /* In old versions it was possible to remove an airport while a plane was
2444 * taking off or landing. This gives all kind of problems when building
2445 * another airport in the same station so we don't allow that anymore.
2446 * For old savegames with such aircraft we just throw them in the air and
2447 * treat the aircraft like they were flying already. */
2456 /* get aircraft back on running altitude */
2460 }
2461 }
2462 }
2463 }
2465 /* Move the animation frame to the same location (m7) for all objects. */
2475 }
2483 }
2491 /* For stations/airports it's already at m7 */
2493 }
2494 }
2495 }
2497 /* Add (random) colour to all objects. */
2501 o->colour = (owner == OWNER_NONE) ? static_cast<Colours>(GB(Random(), 0, 4)) : Company::Get(owner)->livery->colour1;
2502 }
2503 }
2510 }
2511 }
2513 /* Waypoints with custom name may have a non-unique town_cn,
2514 * renumber those. First set all affected waypoints to the
2515 * highest possible number to get them numbered in the
2516 * order they have in the pool. */
2519 }
2523 }
2524 }
2529 /* The moment vehicles go from hidden to visible changed. This means
2530 * that vehicles don't always get visible anymore causing things to
2531 * get messed up just after loading the savegame. This fixes that. */
2533 /* Not all vehicle types can be inside a tunnel. Furthermore,
2534 * testing IsTunnelTile() for invalid tiles causes a crash. */
2537 /* Is the vehicle in a tunnel? */
2540 /* Is the vehicle actually at a tunnel entrance/exit? */
2544 /* Are we actually in this tunnel? Or maybe a lower tunnel? */
2547 /* What way are we going? */
2551 /* Have we passed the visibility "switch" state already? */
2556 /* Should the vehicle be hidden or not? */
2563 /* v->tile changes at the moment when the vehicle leaves the tunnel. */
2566 /* We could get here in two cases:
2567 * - for road vehicles, it is reversing at the end of the tunnel
2568 * - it is crashed in the tunnel entry (both train or RV destroyed by UFO)
2569 * Whatever case it is, do not change anything and use the old values.
2570 * Especially changing RV's state would break its reversing in the middle. */
2572 }
2581 }
2587 case VEH_ROAD: RoadVehicle::From(v)->state = DiagDirToDiagTrackdir(vdir); RoadVehicle::From(v)->frame = frame; break;
2589 }
2590 }
2591 }
2592 }
2598 bool loading = rv->current_order.IsType(OT_LOADING) || rv->current_order.IsType(OT_LEAVESTATION);
2601 SB(rv->state, RVS_ENTERED_STOP, 1, loading || rv->frame > _road_stop_stop_frame[rv->state - RVSB_IN_ROAD_STOP + (_settings_game.vehicle.road_side << RVS_DRIVE_SIDE)]);
2604 }
2605 }
2606 }
2609 /* The train's pathfinder lost flag got moved. */
2615 }
2617 /* Introduced terraform/clear limits. */
2621 }
2622 }
2626 /*
2627 * The logic of GetPartialPixelZ has been changed, so the resulting Zs on
2628 * the map are consistent. This requires that the Z position of some
2629 * vehicles is updated to reflect this new situation.
2630 *
2631 * This needs to be before SLV_158, because that performs asserts using
2632 * GetSlopePixelZ which internally uses GetPartialPixelZ.
2633 */
2636 /* Vehicle is on the ground, and not in a wormhole. */
2638 }
2639 }
2640 }
2648 /* Clear old GOINGUP / GOINGDOWN flags.
2649 * It was changed in savegame version 139, but savegame
2650 * version 158 doesn't use these bits, so it doesn't hurt
2651 * to clear them unconditionally. */
2655 /* Clear both bits first. */
2659 /* Crashed vehicles can't be going up/down. */
2662 /* Only X/Y tracks can be sloped. */
2667 }
2673 /* Crashed vehicles can't be going up/down. */
2681 /* Only X/Y tracks can be sloped. */
2686 /* Test if we are reversing. */
2690 /* When reversing, the road vehicle is on the edge of the tile,
2691 * so it can be safely compared to the middle of the tile. */
2693 }
2697 }
2703 }
2706 /* In old versions, z_pos was 1 unit lower on bridge heads.
2707 * However, this invalid state could be converted to new savegames
2708 * by loading and saving the game in a new version. */
2713 /* If the train has left the bridge, it shouldn't have
2714 * track == TRACK_BIT_WORMHOLE - this could happen
2715 * when the train was reversed while on the last "tick"
2716 * on the ramp before leaving the ramp to the bridge. */
2718 }
2719 }
2721 /* If the vehicle is really above v->tile (not in a wormhole),
2722 * it should have set v->z_pos correctly. */
2723 assert(v->tile != TileVirtXY(v->x_pos, v->y_pos) || v->z_pos == GetSlopePixelZ(v->x_pos, v->y_pos, true));
2724 }
2726 /* Fill Vehicle::cur_real_order_index */
2730 /* Older versions are less strict with indices being in range and fix them on the fly */
2735 }
2736 }
2739 /* If the savegame is old (before version 100), then the value of 255
2740 * for these settings did not mean "disabled". As such everything
2741 * before then did reverse.
2742 * To simplify stuff we disable all turning around or we do not
2743 * disable anything at all. So, if some reversing was disabled we
2744 * will keep reversing disabled, otherwise it'll be turned on. */
2745 _settings_game.pf.reverse_at_signals = IsSavegameVersionBefore(SLV_100) || (_settings_game.pf.wait_oneway_signal != 255 && _settings_game.pf.wait_twoway_signal != 255 && _settings_game.pf.wait_for_pbs_path != 255);
2748 _settings_game.vehicle.max_train_length = std::max<uint8_t>(_settings_game.vehicle.max_train_length, CeilDiv(t->gcache.cached_total_length, TILE_SIZE));
2749 }
2750 }
2753 /* Setting difficulty industry_density other than zero get bumped to +1
2754 * since a new option (minimal at position 1) has been added */
2757 }
2758 }
2761 /* Before savegame version 161, persistent storages were not stored in a pool. */
2767 /* Check if the old storage was empty. */
2773 }
2774 }
2781 }
2782 }
2783 }
2790 /* Check if the old storage was empty. */
2796 }
2797 }
2805 }
2806 }
2807 }
2808 }
2810 /* This triggers only when old snow_lines were copied into the snow_line_height. */
2811 if (IsSavegameVersionBefore(SLV_164) && _settings_game.game_creation.snow_line_height >= MIN_SNOWLINE_HEIGHT * TILE_HEIGHT) {
2813 }
2816 /* We store 4 fences in the field tiles instead of only SE and SW. */
2821 if (fence != 0 && IsTileType(TileAddXY(t, 1, 0), MP_CLEAR) && IsClearGround(TileAddXY(t, 1, 0), CLEAR_FIELDS)) {
2823 }
2825 if (fence != 0 && IsTileType(TileAddXY(t, 0, 1), MP_CLEAR) && IsClearGround(TileAddXY(t, 0, 1), CLEAR_FIELDS)) {
2827 }
2830 }
2831 }
2835 /* Set the default cargo requirement for town growth */
2838 if (FindFirstCargoWithTownAcceptanceEffect(TAE_FOOD) != nullptr) t->goal[TAE_FOOD] = TOWN_GROWTH_WINTER;
2842 if (FindFirstCargoWithTownAcceptanceEffect(TAE_FOOD) != nullptr) t->goal[TAE_FOOD] = TOWN_GROWTH_DESERT;
2843 if (FindFirstCargoWithTownAcceptanceEffect(TAE_WATER) != nullptr) t->goal[TAE_WATER] = TOWN_GROWTH_DESERT;
2845 }
2846 }
2847 }
2850 /* Adjust zoom level to account for new levels */
2854 }
2856 /* When any NewGRF has been changed the availability of some vehicles might
2857 * have been changed too. e->company_avail must be set to 0 in that case
2858 * which is done by StartupEngines(). */
2861 /* The road owner of standard road stops was not properly accounted for. */
2868 }
2869 }
2872 /* Introduced tree planting limit. */
2873 for (Company *c : Company::Iterate()) c->tree_limit = _settings_game.construction.tree_frame_burst << 16;
2874 }
2877 /* Fix too high inflation rates */
2881 /* We have to convert the quarters of bankruptcy into months of bankruptcy */
2884 }
2885 }
2887 {
2888 /* Station blocked, wires and pylon flags need to be stored in the map. This is effectively cached data, so no
2889 * version check is necessary. This is done here as the SLV_182 check below needs the blocked status. */
2892 }
2893 }
2896 /* Aircraft acceleration variable was bonkers */
2901 }
2902 }
2904 /* Blocked tiles could be reserved due to a bug, which causes
2905 * other places to assert upon e.g. station reconstruction. */
2909 }
2910 }
2911 }
2914 /* The global units configuration is split up in multiple configurations. */
2922 }
2925 /* Match nautical velocity with land velocity units. */
2927 }
2930 /* Move ObjectType from map to pool */
2936 }
2937 }
2938 }
2940 /* Beyond this point, tile types which can be accessed by vehicles must be in a valid state. */
2942 /* Update all vehicles: Phase 2 */
2945 /* The center of train vehicles was changed, fix up spacing. */
2948 /* In version 2.2 of the savegame, we have new airports, so status of all aircraft is reset.
2949 * This has to be called after all map array updates */
2953 /* Fix articulated road vehicles.
2954 * Some curves were shorter than other curves.
2955 * Now they have the same length, but that means that trailing articulated parts will
2956 * take longer to go through the curve than the parts in front which already left the courve.
2957 * So, make articulated parts catch up. */
2972 }
2976 /* The following 3 curves now take longer than before */
2979 cur_skip++;
2984 cur_skip++;
2989 cur_skip++;
2995 }
2996 }
3005 }
3006 cur_skip--;
3007 }
3008 }
3009 }
3015 }
3018 }
3019 }
3021 /*
3022 * Only keep order-backups for network clients (and when replaying).
3023 * If we are a network server or not networking, then we just loaded a previously
3024 * saved-by-server savegame. There are no clients with a backup, so clear it.
3025 * Furthermore before savegame version SLV_192 the actual content was always corrupt.
3026 */
3028 #ifndef DEBUG_DUMP_COMMANDS
3029 /* Note: We cannot use CleanPool since that skips part of the destructor
3030 * and then leaks un-reachable Orders in the order pool. */
3033 }
3034 #endif
3035 }
3038 /* Convert towns growth_rate and grow_counter to ticks */
3040 /* 0x8000 = TOWN_GROWTH_RATE_CUSTOM previously */
3044 }
3045 /* Add t->index % TOWN_GROWTH_TICKS to spread growth across ticks. */
3047 }
3048 }
3051 /* Make sure added industry cargo slots are cleared */
3053 /* Make sure last_cargo_accepted_at is copied to elements for every valid input cargo.
3054 * The loading routine should put the original singular value into the first array element. */
3060 }
3061 }
3062 }
3063 }
3066 /* Move ships from lock slope to upper or lower position. */
3068 /* Suitable tile? */
3069 if (!IsTileType(s->tile, MP_WATER) || !IsLock(s->tile) || GetLockPart(s->tile) != LOCK_PART_MIDDLE) continue;
3071 /* We don't need to adjust position when at the tile centre */
3076 /* Test if ship is on the second half of the tile */
3085 }
3089 /* Heading up slope == passed half way */
3091 /* On top half of lock */
3094 /* On lower half of lock */
3096 }
3097 }
3098 }
3101 /* Ensure the original cargo generation mode is used */
3103 }
3106 /* Ensure the original neutral industry/station behaviour is used */
3109 /* Link oil rigs to their industry and back. */
3112 /* Industry tile is always adjacent during construction by TileDiffXY(0, 1) */
3115 }
3116 }
3118 /* Link neutral station back to industry, as this is not saved. */
3119 for (Industry *ind : Industry::Iterate()) if (ind->neutral_station != nullptr) ind->neutral_station->industry = ind;
3120 }
3123 /* Update water class for trees. */
3125 if (IsTileType(t, MP_TREES)) SetWaterClass(t, GetTreeGround(t) == TREE_GROUND_SHORE ? WATER_CLASS_SEA : WATER_CLASS_INVALID);
3126 }
3127 }
3129 /* Update structures for multitile docks */
3132 /* Clear docking tile flag from relevant tiles as it
3133 * was not previously cleared. */
3134 if (IsTileType(t, MP_WATER) || IsTileType(t, MP_RAILWAY) || IsTileType(t, MP_STATION) || IsTileType(t, MP_TUNNELBRIDGE)) {
3136 }
3137 /* Add docks and oilrigs to Station::ship_station. */
3140 }
3141 }
3142 }
3145 /* Placing objects on docking tiles was not updating adjacent station's docking tiles. */
3148 }
3149 }
3152 /* Reset roadtype/streetcartype info for non-road bridges. */
3156 }
3157 }
3158 }
3160 /* Make sure all industries exclusive supplier/consumer set correctly. */
3165 }
3166 }
3169 /* Propagate wagon removal flag for compatibility */
3170 /* Temporary bitmask of company wagon removal setting */
3174 }
3177 /* Convert old replace_protection value to flag. */
3180 }
3182 }
3183 }
3185 /* Use current order time to approximate last loading time */
3188 v->last_loading_tick = std::max(TimerGameTick::counter, static_cast<uint64_t>(v->current_order_time)) - v->current_order_time;
3189 }
3190 }
3192 /* Road stops is 'only' updating some caches, but they are needed for PF calls in SLV_MULTITRACK_LEVEL_CROSSINGS teleporting. */
3195 /* Road vehicles stopped on multitrack level crossings need teleporting to a depot
3196 * to avoid crashing into the side of the train they're waiting for. */
3198 /* Teleport road vehicles to the nearest depot. */
3200 /* Ignore trailers of articulated vehicles. */
3203 /* Ignore moving vehicles. */
3206 /* Ignore crashed vehicles. */
3209 /* Ignore vehicles not on level crossings. */
3215 /* Try to find a depot with a distance limit of 512 tiles (Manhattan distance). */
3217 /* Teleport all parts of articulated vehicles. */
3229 }
3231 }
3232 }
3235 /* Reset unused tree counters to reduce the savegame size. */
3239 }
3240 }
3241 }
3243 /* Refresh all level crossings to bar adjacent crossing tiles, if needed. */
3246 }
3247 }
3249 /* Compute station catchment areas. This is needed here in case UpdateStationAcceptance is called below. */
3252 /* Station acceptance is some kind of cache */
3255 }
3259 }
3262 /* For older savegames, we don't now the actual interval; so set it to the newgame value. */
3263 _settings_game.difficulty.competitors_interval = _settings_newgame.difficulty.competitors_interval;
3265 /* We did load the "period" of the timer, but not the fired/elapsed. We can deduce that here. */
3269 }
3272 /* Set service date provided to NewGRF. */
3275 }
3276 }
3279 /* NewGRF acceleration information was added to ships. */
3282 }
3283 }
3288 }
3289 }
3293 }
3298 }
3299 }
3303 }
3305 /* Update free group numbers data for each company, required regardless of savegame version. */
3309 /* Use the index as group number when converting old savegames. */
3313 }
3314 }
3323 /* Restore the signals */
3330 /* Start the scripts. This MUST happen after everything else except
3331 * starting a new company. */
3334 /* If Load Scenario / New (Scenario) Game is used,
3335 * a company does not exist yet. So create one here.
3336 * 1 exception: network-games. Those can have 0 companies
3337 * But this exception is not true for non-dedicated network servers! */
3343 }
3344 }
3347 }
3349 /**
3350 * Reload all NewGRF files during a running game. This is a cut-down
3351 * version of AfterLoadGame().
3352 * XXX - We need to reset the vehicle position hash because with a non-empty
3353 * hash AfterLoadVehicles() will loop infinitely. We need AfterLoadVehicles()
3354 * to recalculate vehicle data as some NewGRF vehicle sets could have been
3355 * removed or added and changed statistics
3356 */
3358 {
3359 /* reload grf data */
3363 /* reload vehicles */
3369 /* update station graphics */
3371 /* Update company statistics. */
3373 /* Check and update house and town values */
3375 /* Delete news referring to no longer existing entities */
3377 /* Update livery selection windows */
3378 for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) InvalidateWindowData(WC_COMPANY_COLOUR, i);
3379 /* Update company infrastructure counts. */
3382 /* redraw the whole screen */
3385 }