# station_sl.cpp

Go to the documentation of this file.

    00001 /* $Id: station_sl.cpp 18404 2009-12-04 20:52:19Z rubidium $ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #include "../stdafx.h"
    00013 #include "../station_base.h"
    00014 #include "../waypoint_base.h"
    00015 #include "../roadstop_base.h"
    00016 #include "../vehicle_base.h"
    00017 #include "../newgrf_station.h"
    00018 #include "../station_map.h"
    00019
    00020 #include "saveload.h"
    00021 #include "table/strings.h"
    00022
    00027 static void UpdateWaypointOrder(Order *o)
    00028 {
    00029   if (!o->IsType(OT_GOTO_STATION)) return;
    00030
    00031   const Station *st = Station::Get(o->GetDestination());
    00032   if ((st->had_vehicle_of_type & HVOT_WAYPOINT) == 0) return;
    00033
    00034   o->MakeGoToWaypoint(o->GetDestination());
    00035 }
    00036
    00041 void MoveBuoysToWaypoints()
    00042 {
    00043   /* Buoy orders become waypoint orders */
    00044   OrderList *ol;
    00045   FOR_ALL_ORDER_LISTS(ol) {
    00046     if (ol->GetFirstSharedVehicle()->type != VEH_SHIP) continue;
    00047
    00048     for (Order *o = ol->GetFirstOrder(); o != NULL; o = o->next) UpdateWaypointOrder(o);
    00049   }
    00050
    00051   Vehicle *v;
    00052   FOR_ALL_VEHICLES(v) {
    00053     if (v->type != VEH_SHIP) continue;
    00054
    00055     UpdateWaypointOrder(&v->current_order);
    00056   }
    00057
    00058   /* Now make the stations waypoints */
    00059   Station *st;
    00060   FOR_ALL_STATIONS(st) {
    00061     if ((st->had_vehicle_of_type & HVOT_WAYPOINT) == 0) continue;
    00062
    00063     StationID index    = st->index;
    00064     TileIndex xy       = st->xy;
    00065     Town *town         = st->town;
    00066     StringID string_id = st->string_id;
    00067     char *name         = st->name;
    00068     Date build_date    = st->build_date;
    00069
    00070     /* Delete the station, so we can make it a real waypoint. */
    00071     delete st;
    00072
    00073     Waypoint *wp = new (index) Waypoint(xy);
    00074     wp->town       = town;
    00075     wp->string_id  = STR_SV_STNAME_BUOY;
    00076     wp->name       = name;
    00077     wp->delete_ctr = 0; // Just reset delete counter for once.
    00078     wp->build_date = build_date;
    00079     wp->owner      = OWNER_NONE;
    00080
    00081     if (IsInsideBS(string_id, STR_SV_STNAME_BUOY, 9)) wp->town_cn = string_id - STR_SV_STNAME_BUOY;
    00082
    00083     if (IsBuoyTile(xy) && GetStationIndex(xy) == index) {
    00084       wp->facilities |= FACIL_DOCK;
    00085     }
    00086
    00087     wp->rect.BeforeAddTile(xy, StationRect::ADD_FORCE);
    00088   }
    00089 }
    00090
    00091 void AfterLoadStations()
    00092 {
    00093   /* Update the speclists of all stations to point to the currently loaded custom stations. */
    00094   BaseStation *st;
    00095   FOR_ALL_BASE_STATIONS(st) {
    00096     for (uint i = 0; i < st->num_specs; i++) {
    00097       if (st->speclist[i].grfid == 0) continue;
    00098
    00099       st->speclist[i].spec = GetCustomStationSpecByGrf(st->speclist[i].grfid, st->speclist[i].localidx, NULL);
    00100     }
    00101
    00102     if (Station::IsExpected(st)) {
    00103       Station *sta = Station::From(st);
    00104       for (const RoadStop *rs = sta->bus_stops; rs != NULL; rs = rs->next) sta->bus_station.Add(rs->xy);
    00105       for (const RoadStop *rs = sta->truck_stops; rs != NULL; rs = rs->next) sta->truck_station.Add(rs->xy);
    00106     }
    00107
    00108     StationUpdateAnimTriggers(st);
    00109   }
    00110 }
    00111
    00115 void AfterLoadRoadStops()
    00116 {
    00117   /* First construct the drive through entries */
    00118   RoadStop *rs;
    00119   FOR_ALL_ROADSTOPS(rs) {
    00120     if (IsDriveThroughStopTile(rs->xy)) rs->MakeDriveThrough();
    00121   }
    00122   /* And then rebuild the data in those entries */
    00123   FOR_ALL_ROADSTOPS(rs) {
    00124     if (!HasBit(rs->status, RoadStop::RSSFB_BASE_ENTRY)) continue;
    00125
    00126     rs->GetEntry(DIAGDIR_NE)->Rebuild(rs);
    00127     rs->GetEntry(DIAGDIR_NW)->Rebuild(rs);
    00128   }
    00129 }
    00130
    00131 static const SaveLoad _roadstop_desc[] = {
    00132   SLE_VAR(RoadStop, xy,           SLE_UINT32),
    00133   SLE_CONDNULL(1, 0, 44),
    00134   SLE_VAR(RoadStop, status,       SLE_UINT8),
    00135   /* Index was saved in some versions, but this is not needed */
    00136   SLE_CONDNULL(4, 0, 8),
    00137   SLE_CONDNULL(2, 0, 44),
    00138   SLE_CONDNULL(1, 0, 25),
    00139
    00140   SLE_REF(RoadStop, next,         REF_ROADSTOPS),
    00141   SLE_CONDNULL(2, 0, 44),
    00142
    00143   SLE_CONDNULL(4, 0, 24),
    00144   SLE_CONDNULL(1, 25, 25),
    00145
    00146   SLE_END()
    00147 };
    00148
    00149 static const SaveLoad _old_station_desc[] = {
    00150   SLE_CONDVAR(Station, xy,                         SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
    00151   SLE_CONDVAR(Station, xy,                         SLE_UINT32,                  6, SL_MAX_VERSION),
    00152   SLE_CONDNULL(4, 0, 5),
    00153   SLE_CONDVAR(Station, train_station.tile,         SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
    00154   SLE_CONDVAR(Station, train_station.tile,         SLE_UINT32,                  6, SL_MAX_VERSION),
    00155   SLE_CONDVAR(Station, airport_tile,               SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
    00156   SLE_CONDVAR(Station, airport_tile,               SLE_UINT32,                  6, SL_MAX_VERSION),
    00157   SLE_CONDVAR(Station, dock_tile,                  SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
    00158   SLE_CONDVAR(Station, dock_tile,                  SLE_UINT32,                  6, SL_MAX_VERSION),
    00159       SLE_REF(Station, town,                       REF_TOWN),
    00160       SLE_VAR(Station, train_station.w,            SLE_UINT8),
    00161   SLE_CONDVAR(Station, train_station.h,            SLE_UINT8,                   2, SL_MAX_VERSION),
    00162
    00163   SLE_CONDNULL(1, 0, 3),
    00164
    00165       SLE_VAR(Station, string_id,                  SLE_STRINGID),
    00166   SLE_CONDSTR(Station, name,                       SLE_STR, 0,                 84, SL_MAX_VERSION),
    00167   SLE_CONDVAR(Station, indtype,                    SLE_UINT8,                 103, SL_MAX_VERSION),
    00168   SLE_CONDVAR(Station, had_vehicle_of_type,        SLE_FILE_U16 | SLE_VAR_U8,   0, 121),
    00169   SLE_CONDVAR(Station, had_vehicle_of_type,        SLE_UINT8,                 122, SL_MAX_VERSION),
    00170
    00171       SLE_VAR(Station, time_since_load,            SLE_UINT8),
    00172       SLE_VAR(Station, time_since_unload,          SLE_UINT8),
    00173       SLE_VAR(Station, delete_ctr,                 SLE_UINT8),
    00174       SLE_VAR(Station, owner,                      SLE_UINT8),
    00175       SLE_VAR(Station, facilities,                 SLE_UINT8),
    00176       SLE_VAR(Station, airport_type,               SLE_UINT8),
    00177
    00178   SLE_CONDNULL(2, 0, 5),
    00179   SLE_CONDNULL(1, 0, 4),
    00180
    00181   SLE_CONDVAR(Station, airport_flags,              SLE_VAR_U64 | SLE_FILE_U16,  0,  2),
    00182   SLE_CONDVAR(Station, airport_flags,              SLE_VAR_U64 | SLE_FILE_U32,  3, 45),
    00183   SLE_CONDVAR(Station, airport_flags,              SLE_UINT64,                 46, SL_MAX_VERSION),
    00184
    00185   SLE_CONDNULL(2, 0, 25),
    00186   SLE_CONDVAR(Station, last_vehicle_type,          SLE_UINT8,                  26, SL_MAX_VERSION),
    00187
    00188   SLE_CONDNULL(2, 3, 25),
    00189   SLE_CONDVAR(Station, build_date,                 SLE_FILE_U16 | SLE_VAR_I32,  3, 30),
    00190   SLE_CONDVAR(Station, build_date,                 SLE_INT32,                  31, SL_MAX_VERSION),
    00191
    00192   SLE_CONDREF(Station, bus_stops,                  REF_ROADSTOPS,               6, SL_MAX_VERSION),
    00193   SLE_CONDREF(Station, truck_stops,                REF_ROADSTOPS,               6, SL_MAX_VERSION),
    00194
    00195   /* Used by newstations for graphic variations */
    00196   SLE_CONDVAR(Station, random_bits,                SLE_UINT16,                 27, SL_MAX_VERSION),
    00197   SLE_CONDVAR(Station, waiting_triggers,           SLE_UINT8,                  27, SL_MAX_VERSION),
    00198   SLE_CONDVAR(Station, num_specs,                  SLE_UINT8,                  27, SL_MAX_VERSION),
    00199
    00200   SLE_CONDLST(Station, loading_vehicles,           REF_VEHICLE,                57, SL_MAX_VERSION),
    00201
    00202   /* reserve extra space in savegame here. (currently 32 bytes) */
    00203   SLE_CONDNULL(32, 2, SL_MAX_VERSION),
    00204
    00205   SLE_END()
    00206 };
    00207
    00208 static uint16 _waiting_acceptance;
    00209 static uint16 _cargo_source;
    00210 static uint32 _cargo_source_xy;
    00211 static uint16 _cargo_days;
    00212 static Money  _cargo_feeder_share;
    00213
    00214 static const SaveLoad _station_speclist_desc[] = {
    00215   SLE_CONDVAR(StationSpecList, grfid,    SLE_UINT32, 27, SL_MAX_VERSION),
    00216   SLE_CONDVAR(StationSpecList, localidx, SLE_UINT8,  27, SL_MAX_VERSION),
    00217
    00218   SLE_END()
    00219 };
    00220
    00226 const SaveLoad *GetGoodsDesc()
    00227 {
    00228   static const SaveLoad goods_desc[] = {
    00229     SLEG_CONDVAR(            _waiting_acceptance, SLE_UINT16,                  0, 67),
    00230      SLE_CONDVAR(GoodsEntry, acceptance_pickup,   SLE_UINT8,                  68, SL_MAX_VERSION),
    00231     SLE_CONDNULL(2,                                                           51, 67),
    00232          SLE_VAR(GoodsEntry, days_since_pickup,   SLE_UINT8),
    00233          SLE_VAR(GoodsEntry, rating,              SLE_UINT8),
    00234     SLEG_CONDVAR(            _cargo_source,       SLE_FILE_U8 | SLE_VAR_U16,   0, 6),
    00235     SLEG_CONDVAR(            _cargo_source,       SLE_UINT16,                  7, 67),
    00236     SLEG_CONDVAR(            _cargo_source_xy,    SLE_UINT32,                 44, 67),
    00237     SLEG_CONDVAR(            _cargo_days,         SLE_UINT8,                   0, 67),
    00238          SLE_VAR(GoodsEntry, last_speed,          SLE_UINT8),
    00239          SLE_VAR(GoodsEntry, last_age,            SLE_UINT8),
    00240     SLEG_CONDVAR(            _cargo_feeder_share, SLE_FILE_U32 | SLE_VAR_I64, 14, 64),
    00241     SLEG_CONDVAR(            _cargo_feeder_share, SLE_INT64,                  65, 67),
    00242      SLE_CONDLST(GoodsEntry, cargo.packets,       REF_CARGO_PACKET,           68, SL_MAX_VERSION),
    00243
    00244     SLE_END()
    00245   };
    00246
    00247   return goods_desc;
    00248 }
    00249
    00250
    00251 static void Load_STNS()
    00252 {
    00253   int index;
    00254   while ((index = SlIterateArray()) != -1) {
    00255     Station *st = new (index) Station();
    00256
    00257     SlObject(st, _old_station_desc);
    00258
    00259     _waiting_acceptance = 0;
    00260
    00261     uint num_cargo = CheckSavegameVersion(55) ? 12 : NUM_CARGO;
    00262     for (CargoID i = 0; i < num_cargo; i++) {
    00263       GoodsEntry *ge = &st->goods[i];
    00264       SlObject(ge, GetGoodsDesc());
    00265       if (CheckSavegameVersion(68)) {
    00266         SB(ge->acceptance_pickup, GoodsEntry::ACCEPTANCE, 1, HasBit(_waiting_acceptance, 15));
    00267         if (GB(_waiting_acceptance, 0, 12) != 0) {
    00268           /* In old versions, enroute_from used 0xFF as INVALID_STATION */
    00269           StationID source = (CheckSavegameVersion(7) && _cargo_source == 0xFF) ? INVALID_STATION : _cargo_source;
    00270
    00271           /* Don't construct the packet with station here, because that'll fail with old savegames */
    00272           ge->cargo.Append(new CargoPacket(GB(_waiting_acceptance, 0, 12), _cargo_days, source, _cargo_source_xy, _cargo_source_xy, _cargo_feeder_share));
    00273           SB(ge->acceptance_pickup, GoodsEntry::PICKUP, 1, 1);
    00274         }
    00275       }
    00276     }
    00277
    00278     if (st->num_specs != 0) {
    00279       /* Allocate speclist memory when loading a game */
    00280       st->speclist = CallocT<StationSpecList>(st->num_specs);
    00281       for (uint i = 0; i < st->num_specs; i++) {
    00282         SlObject(&st->speclist[i], _station_speclist_desc);
    00283       }
    00284     }
    00285   }
    00286 }
    00287
    00288 static void Ptrs_STNS()
    00289 {
    00290   /* Don't run when savegame version is higher than or equal to 123. */
    00291   if (!CheckSavegameVersion(123)) return;
    00292
    00293   Station *st;
    00294   FOR_ALL_STATIONS(st) {
    00295     if (!CheckSavegameVersion(68)) {
    00296       for (CargoID i = 0; i < NUM_CARGO; i++) {
    00297         GoodsEntry *ge = &st->goods[i];
    00298         SlObject(ge, GetGoodsDesc());
    00299       }
    00300     }
    00301     SlObject(st, _old_station_desc);
    00302   }
    00303 }
    00304
    00305
    00306 static const SaveLoad _base_station_desc[] = {
    00307         SLE_VAR(BaseStation, xy,                     SLE_UINT32),
    00308         SLE_REF(BaseStation, town,                   REF_TOWN),
    00309         SLE_VAR(BaseStation, string_id,              SLE_STRINGID),
    00310         SLE_STR(BaseStation, name,                   SLE_STR, 0),
    00311         SLE_VAR(BaseStation, delete_ctr,             SLE_UINT8),
    00312         SLE_VAR(BaseStation, owner,                  SLE_UINT8),
    00313         SLE_VAR(BaseStation, facilities,             SLE_UINT8),
    00314         SLE_VAR(BaseStation, build_date,             SLE_INT32),
    00315
    00316   /* Used by newstations for graphic variations */
    00317         SLE_VAR(BaseStation, random_bits,            SLE_UINT16),
    00318         SLE_VAR(BaseStation, waiting_triggers,       SLE_UINT8),
    00319         SLE_VAR(BaseStation, num_specs,              SLE_UINT8),
    00320
    00321         SLE_END()
    00322 };
    00323
    00324 static const SaveLoad _station_desc[] = {
    00325   SLE_WRITEBYTE(Station, facilities,                 FACIL_NONE),
    00326   SLE_ST_INCLUDE(),
    00327
    00328         SLE_VAR(Station, train_station.tile,         SLE_UINT32),
    00329         SLE_VAR(Station, train_station.w,            SLE_UINT8),
    00330         SLE_VAR(Station, train_station.h,            SLE_UINT8),
    00331
    00332         SLE_REF(Station, bus_stops,                  REF_ROADSTOPS),
    00333         SLE_REF(Station, truck_stops,                REF_ROADSTOPS),
    00334         SLE_VAR(Station, dock_tile,                  SLE_UINT32),
    00335         SLE_VAR(Station, airport_tile,               SLE_UINT32),
    00336         SLE_VAR(Station, airport_type,               SLE_UINT8),
    00337         SLE_VAR(Station, airport_flags,              SLE_UINT64),
    00338
    00339         SLE_VAR(Station, indtype,                    SLE_UINT8),
    00340
    00341         SLE_VAR(Station, time_since_load,            SLE_UINT8),
    00342         SLE_VAR(Station, time_since_unload,          SLE_UINT8),
    00343         SLE_VAR(Station, last_vehicle_type,          SLE_UINT8),
    00344         SLE_VAR(Station, had_vehicle_of_type,        SLE_UINT8),
    00345         SLE_LST(Station, loading_vehicles,           REF_VEHICLE),
    00346     SLE_CONDVAR(Station, always_accepted,            SLE_UINT32, 127, SL_MAX_VERSION),
    00347
    00348         SLE_END()
    00349 };
    00350
    00351 static const SaveLoad _waypoint_desc[] = {
    00352   SLE_WRITEBYTE(Waypoint, facilities,                FACIL_WAYPOINT),
    00353   SLE_ST_INCLUDE(),
    00354
    00355         SLE_VAR(Waypoint, town_cn,                   SLE_UINT16),
    00356
    00357     SLE_CONDVAR(Waypoint, train_station.tile,        SLE_UINT32,                  124, SL_MAX_VERSION),
    00358     SLE_CONDVAR(Waypoint, train_station.w,           SLE_UINT8,                   124, SL_MAX_VERSION),
    00359     SLE_CONDVAR(Waypoint, train_station.h,           SLE_UINT8,                   124, SL_MAX_VERSION),
    00360
    00361         SLE_END()
    00362 };
    00363
    00368 const SaveLoad *GetBaseStationDescription()
    00369 {
    00370   return _base_station_desc;
    00371 }
    00372
    00373 static void RealSave_STNN(BaseStation *bst)
    00374 {
    00375   bool waypoint = (bst->facilities & FACIL_WAYPOINT) != 0;
    00376   SlObject(bst, waypoint ? _waypoint_desc : _station_desc);
    00377
    00378   if (!waypoint) {
    00379     Station *st = Station::From(bst);
    00380     for (CargoID i = 0; i < NUM_CARGO; i++) {
    00381       SlObject(&st->goods[i], GetGoodsDesc());
    00382     }
    00383   }
    00384
    00385   for (uint i = 0; i < bst->num_specs; i++) {
    00386     SlObject(&bst->speclist[i], _station_speclist_desc);
    00387   }
    00388 }
    00389
    00390 static void Save_STNN()
    00391 {
    00392   BaseStation *st;
    00393   /* Write the stations */
    00394   FOR_ALL_BASE_STATIONS(st) {
    00395     SlSetArrayIndex(st->index);
    00396     SlAutolength((AutolengthProc*)RealSave_STNN, st);
    00397   }
    00398 }
    00399
    00400 static void Load_STNN()
    00401 {
    00402   int index;
    00403
    00404   while ((index = SlIterateArray()) != -1) {
    00405     bool waypoint = (SlReadByte() & FACIL_WAYPOINT) != 0;
    00406
    00407     BaseStation *bst = waypoint ? (BaseStation *)new (index) Waypoint() : new (index) Station();
    00408     SlObject(bst, waypoint ? _waypoint_desc : _station_desc);
    00409
    00410     if (!waypoint) {
    00411       Station *st = Station::From(bst);
    00412       for (CargoID i = 0; i < NUM_CARGO; i++) {
    00413         SlObject(&st->goods[i], GetGoodsDesc());
    00414       }
    00415     }
    00416
    00417     if (bst->num_specs != 0) {
    00418       /* Allocate speclist memory when loading a game */
    00419       bst->speclist = CallocT<StationSpecList>(bst->num_specs);
    00420       for (uint i = 0; i < bst->num_specs; i++) {
    00421         SlObject(&bst->speclist[i], _station_speclist_desc);
    00422       }
    00423     }
    00424   }
    00425 }
    00426
    00427 static void Ptrs_STNN()
    00428 {
    00429   /* Don't run when savegame version lower than 123. */
    00430   if (CheckSavegameVersion(123)) return;
    00431
    00432   Station *st;
    00433   FOR_ALL_STATIONS(st) {
    00434     for (CargoID i = 0; i < NUM_CARGO; i++) {
    00435       GoodsEntry *ge = &st->goods[i];
    00436       SlObject(ge, GetGoodsDesc());
    00437     }
    00438     SlObject(st, _station_desc);
    00439   }
    00440
    00441   Waypoint *wp;
    00442   FOR_ALL_WAYPOINTS(wp) {
    00443     SlObject(wp, _waypoint_desc);
    00444   }
    00445 }
    00446
    00447 static void Save_ROADSTOP()
    00448 {
    00449   RoadStop *rs;
    00450
    00451   FOR_ALL_ROADSTOPS(rs) {
    00452     SlSetArrayIndex(rs->index);
    00453     SlObject(rs, _roadstop_desc);
    00454   }
    00455 }
    00456
    00457 static void Load_ROADSTOP()
    00458 {
    00459   int index;
    00460
    00461   while ((index = SlIterateArray()) != -1) {
    00462     RoadStop *rs = new (index) RoadStop(INVALID_TILE);
    00463
    00464     SlObject(rs, _roadstop_desc);
    00465   }
    00466 }
    00467
    00468 static void Ptrs_ROADSTOP()
    00469 {
    00470   RoadStop *rs;
    00471   FOR_ALL_ROADSTOPS(rs) {
    00472     SlObject(rs, _roadstop_desc);
    00473   }
    00474 }
    00475
    00476 extern const ChunkHandler _station_chunk_handlers[] = {
    00477   { 'STNS', NULL,          Load_STNS,     Ptrs_STNS,     CH_ARRAY },
    00478   { 'STNN', Save_STNN,     Load_STNN,     Ptrs_STNN,     CH_ARRAY },
    00479   { 'ROAD', Save_ROADSTOP, Load_ROADSTOP, Ptrs_ROADSTOP, CH_ARRAY | CH_LAST},
    00480 };