station_sl.cpp

Go to the documentation of this file.
00001 /* $Id: station_sl.cpp 21284 2010-11-21 12:47:04Z alberth $ */
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 
00019 #include "saveload.h"
00020 #include "table/strings.h"
00021 
00026 static void UpdateWaypointOrder(Order *o)
00027 {
00028   if (!o->IsType(OT_GOTO_STATION)) return;
00029 
00030   const Station *st = Station::Get(o->GetDestination());
00031   if ((st->had_vehicle_of_type & HVOT_WAYPOINT) == 0) return;
00032 
00033   o->MakeGoToWaypoint(o->GetDestination());
00034 }
00035 
00040 void MoveBuoysToWaypoints()
00041 {
00042   /* Buoy orders become waypoint orders */
00043   OrderList *ol;
00044   FOR_ALL_ORDER_LISTS(ol) {
00045     if (ol->GetFirstSharedVehicle()->type != VEH_SHIP) continue;
00046 
00047     for (Order *o = ol->GetFirstOrder(); o != NULL; o = o->next) UpdateWaypointOrder(o);
00048   }
00049 
00050   Vehicle *v;
00051   FOR_ALL_VEHICLES(v) {
00052     if (v->type != VEH_SHIP) continue;
00053 
00054     UpdateWaypointOrder(&v->current_order);
00055   }
00056 
00057   /* Now make the stations waypoints */
00058   Station *st;
00059   FOR_ALL_STATIONS(st) {
00060     if ((st->had_vehicle_of_type & HVOT_WAYPOINT) == 0) continue;
00061 
00062     StationID index    = st->index;
00063     TileIndex xy       = st->xy;
00064     Town *town         = st->town;
00065     StringID string_id = st->string_id;
00066     char *name         = st->name;
00067     Date build_date    = st->build_date;
00068 
00069     /* Delete the station, so we can make it a real waypoint. */
00070     delete st;
00071 
00072     Waypoint *wp = new (index) Waypoint(xy);
00073     wp->town       = town;
00074     wp->string_id  = STR_SV_STNAME_BUOY;
00075     wp->name       = name;
00076     wp->delete_ctr = 0; // Just reset delete counter for once.
00077     wp->build_date = build_date;
00078     wp->owner      = OWNER_NONE;
00079 
00080     if (IsInsideBS(string_id, STR_SV_STNAME_BUOY, 9)) wp->town_cn = string_id - STR_SV_STNAME_BUOY;
00081 
00082     if (IsBuoyTile(xy) && GetStationIndex(xy) == index) {
00083       wp->facilities |= FACIL_DOCK;
00084     }
00085 
00086     wp->rect.BeforeAddTile(xy, StationRect::ADD_FORCE);
00087   }
00088 }
00089 
00090 void AfterLoadStations()
00091 {
00092   /* Update the speclists of all stations to point to the currently loaded custom stations. */
00093   BaseStation *st;
00094   FOR_ALL_BASE_STATIONS(st) {
00095     for (uint i = 0; i < st->num_specs; i++) {
00096       if (st->speclist[i].grfid == 0) continue;
00097 
00098       st->speclist[i].spec = StationClass::GetByGrf(st->speclist[i].grfid, st->speclist[i].localidx, NULL);
00099     }
00100 
00101     if (Station::IsExpected(st)) {
00102       Station *sta = Station::From(st);
00103       for (const RoadStop *rs = sta->bus_stops; rs != NULL; rs = rs->next) sta->bus_station.Add(rs->xy);
00104       for (const RoadStop *rs = sta->truck_stops; rs != NULL; rs = rs->next) sta->truck_station.Add(rs->xy);
00105     }
00106 
00107     StationUpdateAnimTriggers(st);
00108   }
00109 }
00110 
00114 void AfterLoadRoadStops()
00115 {
00116   /* First construct the drive through entries */
00117   RoadStop *rs;
00118   FOR_ALL_ROADSTOPS(rs) {
00119     if (IsDriveThroughStopTile(rs->xy)) rs->MakeDriveThrough();
00120   }
00121   /* And then rebuild the data in those entries */
00122   FOR_ALL_ROADSTOPS(rs) {
00123     if (!HasBit(rs->status, RoadStop::RSSFB_BASE_ENTRY)) continue;
00124 
00125     rs->GetEntry(DIAGDIR_NE)->Rebuild(rs);
00126     rs->GetEntry(DIAGDIR_NW)->Rebuild(rs);
00127   }
00128 }
00129 
00130 static const SaveLoad _roadstop_desc[] = {
00131   SLE_VAR(RoadStop, xy,           SLE_UINT32),
00132   SLE_CONDNULL(1, 0, 44),
00133   SLE_VAR(RoadStop, status,       SLE_UINT8),
00134   /* Index was saved in some versions, but this is not needed */
00135   SLE_CONDNULL(4, 0, 8),
00136   SLE_CONDNULL(2, 0, 44),
00137   SLE_CONDNULL(1, 0, 25),
00138 
00139   SLE_REF(RoadStop, next,         REF_ROADSTOPS),
00140   SLE_CONDNULL(2, 0, 44),
00141 
00142   SLE_CONDNULL(4, 0, 24),
00143   SLE_CONDNULL(1, 25, 25),
00144 
00145   SLE_END()
00146 };
00147 
00148 static const SaveLoad _old_station_desc[] = {
00149   SLE_CONDVAR(Station, xy,                         SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
00150   SLE_CONDVAR(Station, xy,                         SLE_UINT32,                  6, SL_MAX_VERSION),
00151   SLE_CONDNULL(4, 0, 5),  
00152   SLE_CONDVAR(Station, train_station.tile,         SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
00153   SLE_CONDVAR(Station, train_station.tile,         SLE_UINT32,                  6, SL_MAX_VERSION),
00154   SLE_CONDVAR(Station, airport.tile,               SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
00155   SLE_CONDVAR(Station, airport.tile,               SLE_UINT32,                  6, SL_MAX_VERSION),
00156   SLE_CONDVAR(Station, dock_tile,                  SLE_FILE_U16 | SLE_VAR_U32,  0, 5),
00157   SLE_CONDVAR(Station, dock_tile,                  SLE_UINT32,                  6, SL_MAX_VERSION),
00158       SLE_REF(Station, town,                       REF_TOWN),
00159       SLE_VAR(Station, train_station.w,            SLE_FILE_U8 | SLE_VAR_U16),
00160   SLE_CONDVAR(Station, train_station.h,            SLE_FILE_U8 | SLE_VAR_U16,   2, SL_MAX_VERSION),
00161 
00162   SLE_CONDNULL(1, 0, 3),  
00163 
00164       SLE_VAR(Station, string_id,                  SLE_STRINGID),
00165   SLE_CONDSTR(Station, name,                       SLE_STR, 0,                 84, SL_MAX_VERSION),
00166   SLE_CONDVAR(Station, indtype,                    SLE_UINT8,                 103, SL_MAX_VERSION),
00167   SLE_CONDVAR(Station, had_vehicle_of_type,        SLE_FILE_U16 | SLE_VAR_U8,   0, 121),
00168   SLE_CONDVAR(Station, had_vehicle_of_type,        SLE_UINT8,                 122, SL_MAX_VERSION),
00169 
00170       SLE_VAR(Station, time_since_load,            SLE_UINT8),
00171       SLE_VAR(Station, time_since_unload,          SLE_UINT8),
00172       SLE_VAR(Station, delete_ctr,                 SLE_UINT8),
00173       SLE_VAR(Station, owner,                      SLE_UINT8),
00174       SLE_VAR(Station, facilities,                 SLE_UINT8),
00175       SLE_VAR(Station, airport.type,               SLE_UINT8),
00176 
00177   SLE_CONDNULL(2, 0, 5),  
00178   SLE_CONDNULL(1, 0, 4),  
00179 
00180   SLE_CONDVAR(Station, airport.flags,              SLE_VAR_U64 | SLE_FILE_U16,  0,  2),
00181   SLE_CONDVAR(Station, airport.flags,              SLE_VAR_U64 | SLE_FILE_U32,  3, 45),
00182   SLE_CONDVAR(Station, airport.flags,              SLE_UINT64,                 46, SL_MAX_VERSION),
00183 
00184   SLE_CONDNULL(2, 0, 25), 
00185   SLE_CONDVAR(Station, last_vehicle_type,          SLE_UINT8,                  26, SL_MAX_VERSION),
00186 
00187   SLE_CONDNULL(2, 3, 25), 
00188   SLE_CONDVAR(Station, build_date,                 SLE_FILE_U16 | SLE_VAR_I32,  3, 30),
00189   SLE_CONDVAR(Station, build_date,                 SLE_INT32,                  31, SL_MAX_VERSION),
00190 
00191   SLE_CONDREF(Station, bus_stops,                  REF_ROADSTOPS,               6, SL_MAX_VERSION),
00192   SLE_CONDREF(Station, truck_stops,                REF_ROADSTOPS,               6, SL_MAX_VERSION),
00193 
00194   /* Used by newstations for graphic variations */
00195   SLE_CONDVAR(Station, random_bits,                SLE_UINT16,                 27, SL_MAX_VERSION),
00196   SLE_CONDVAR(Station, waiting_triggers,           SLE_UINT8,                  27, SL_MAX_VERSION),
00197   SLE_CONDVAR(Station, num_specs,                  SLE_UINT8,                  27, SL_MAX_VERSION),
00198 
00199   SLE_CONDLST(Station, loading_vehicles,           REF_VEHICLE,                57, SL_MAX_VERSION),
00200 
00201   /* reserve extra space in savegame here. (currently 32 bytes) */
00202   SLE_CONDNULL(32, 2, SL_MAX_VERSION),
00203 
00204   SLE_END()
00205 };
00206 
00207 static uint16 _waiting_acceptance;
00208 static uint16 _cargo_source;
00209 static uint32 _cargo_source_xy;
00210 static uint16 _cargo_days;
00211 static Money  _cargo_feeder_share;
00212 
00213 static const SaveLoad _station_speclist_desc[] = {
00214   SLE_CONDVAR(StationSpecList, grfid,    SLE_UINT32, 27, SL_MAX_VERSION),
00215   SLE_CONDVAR(StationSpecList, localidx, SLE_UINT8,  27, SL_MAX_VERSION),
00216 
00217   SLE_END()
00218 };
00219 
00225 const SaveLoad *GetGoodsDesc()
00226 {
00227   static const SaveLoad goods_desc[] = {
00228     SLEG_CONDVAR(            _waiting_acceptance, SLE_UINT16,                  0, 67),
00229      SLE_CONDVAR(GoodsEntry, acceptance_pickup,   SLE_UINT8,                  68, SL_MAX_VERSION),
00230     SLE_CONDNULL(2,                                                           51, 67),
00231          SLE_VAR(GoodsEntry, days_since_pickup,   SLE_UINT8),
00232          SLE_VAR(GoodsEntry, rating,              SLE_UINT8),
00233     SLEG_CONDVAR(            _cargo_source,       SLE_FILE_U8 | SLE_VAR_U16,   0, 6),
00234     SLEG_CONDVAR(            _cargo_source,       SLE_UINT16,                  7, 67),
00235     SLEG_CONDVAR(            _cargo_source_xy,    SLE_UINT32,                 44, 67),
00236     SLEG_CONDVAR(            _cargo_days,         SLE_UINT8,                   0, 67),
00237          SLE_VAR(GoodsEntry, last_speed,          SLE_UINT8),
00238          SLE_VAR(GoodsEntry, last_age,            SLE_UINT8),
00239     SLEG_CONDVAR(            _cargo_feeder_share, SLE_FILE_U32 | SLE_VAR_I64, 14, 64),
00240     SLEG_CONDVAR(            _cargo_feeder_share, SLE_INT64,                  65, 67),
00241      SLE_CONDVAR(GoodsEntry, amount_fract,        SLE_UINT8,                 150, SL_MAX_VERSION),
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 = IsSavegameVersionBefore(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 (IsSavegameVersionBefore(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 = (IsSavegameVersionBefore(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 (!IsSavegameVersionBefore(123)) return;
00292 
00293   Station *st;
00294   FOR_ALL_STATIONS(st) {
00295     if (!IsSavegameVersionBefore(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_FILE_U8 | SLE_VAR_U16),
00330         SLE_VAR(Station, train_station.h,            SLE_FILE_U8 | SLE_VAR_U16),
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_CONDVAR(Station, airport.w,                  SLE_FILE_U8 | SLE_VAR_U16, 140, SL_MAX_VERSION),
00337     SLE_CONDVAR(Station, airport.h,                  SLE_FILE_U8 | SLE_VAR_U16, 140, SL_MAX_VERSION),
00338         SLE_VAR(Station, airport.type,               SLE_UINT8),
00339     SLE_CONDVAR(Station, airport.layout,             SLE_UINT8,                 145, SL_MAX_VERSION),
00340         SLE_VAR(Station, airport.flags,              SLE_UINT64),
00341     SLE_CONDVAR(Station, airport.rotation,           SLE_UINT8,                 145, SL_MAX_VERSION),
00342     SLE_CONDARR(Station, airport.psa.storage,        SLE_UINT32, 16,            145, SL_MAX_VERSION),
00343 
00344         SLE_VAR(Station, indtype,                    SLE_UINT8),
00345 
00346         SLE_VAR(Station, time_since_load,            SLE_UINT8),
00347         SLE_VAR(Station, time_since_unload,          SLE_UINT8),
00348         SLE_VAR(Station, last_vehicle_type,          SLE_UINT8),
00349         SLE_VAR(Station, had_vehicle_of_type,        SLE_UINT8),
00350         SLE_LST(Station, loading_vehicles,           REF_VEHICLE),
00351     SLE_CONDVAR(Station, always_accepted,            SLE_UINT32, 127, SL_MAX_VERSION),
00352 
00353         SLE_END()
00354 };
00355 
00356 static const SaveLoad _waypoint_desc[] = {
00357   SLE_WRITEBYTE(Waypoint, facilities,                FACIL_WAYPOINT),
00358   SLE_ST_INCLUDE(),
00359 
00360         SLE_VAR(Waypoint, town_cn,                   SLE_UINT16),
00361 
00362     SLE_CONDVAR(Waypoint, train_station.tile,        SLE_UINT32,                  124, SL_MAX_VERSION),
00363     SLE_CONDVAR(Waypoint, train_station.w,           SLE_FILE_U8 | SLE_VAR_U16,   124, SL_MAX_VERSION),
00364     SLE_CONDVAR(Waypoint, train_station.h,           SLE_FILE_U8 | SLE_VAR_U16,   124, SL_MAX_VERSION),
00365 
00366         SLE_END()
00367 };
00368 
00373 const SaveLoad *GetBaseStationDescription()
00374 {
00375   return _base_station_desc;
00376 }
00377 
00378 static void RealSave_STNN(BaseStation *bst)
00379 {
00380   bool waypoint = (bst->facilities & FACIL_WAYPOINT) != 0;
00381   SlObject(bst, waypoint ? _waypoint_desc : _station_desc);
00382 
00383   if (!waypoint) {
00384     Station *st = Station::From(bst);
00385     for (CargoID i = 0; i < NUM_CARGO; i++) {
00386       SlObject(&st->goods[i], GetGoodsDesc());
00387     }
00388   }
00389 
00390   for (uint i = 0; i < bst->num_specs; i++) {
00391     SlObject(&bst->speclist[i], _station_speclist_desc);
00392   }
00393 }
00394 
00395 static void Save_STNN()
00396 {
00397   BaseStation *st;
00398   /* Write the stations */
00399   FOR_ALL_BASE_STATIONS(st) {
00400     SlSetArrayIndex(st->index);
00401     SlAutolength((AutolengthProc*)RealSave_STNN, st);
00402   }
00403 }
00404 
00405 static void Load_STNN()
00406 {
00407   int index;
00408 
00409   while ((index = SlIterateArray()) != -1) {
00410     bool waypoint = (SlReadByte() & FACIL_WAYPOINT) != 0;
00411 
00412     BaseStation *bst = waypoint ? (BaseStation *)new (index) Waypoint() : new (index) Station();
00413     SlObject(bst, waypoint ? _waypoint_desc : _station_desc);
00414 
00415     if (!waypoint) {
00416       Station *st = Station::From(bst);
00417       for (CargoID i = 0; i < NUM_CARGO; i++) {
00418         SlObject(&st->goods[i], GetGoodsDesc());
00419       }
00420     }
00421 
00422     if (bst->num_specs != 0) {
00423       /* Allocate speclist memory when loading a game */
00424       bst->speclist = CallocT<StationSpecList>(bst->num_specs);
00425       for (uint i = 0; i < bst->num_specs; i++) {
00426         SlObject(&bst->speclist[i], _station_speclist_desc);
00427       }
00428     }
00429   }
00430 }
00431 
00432 static void Ptrs_STNN()
00433 {
00434   /* Don't run when savegame version lower than 123. */
00435   if (IsSavegameVersionBefore(123)) return;
00436 
00437   Station *st;
00438   FOR_ALL_STATIONS(st) {
00439     for (CargoID i = 0; i < NUM_CARGO; i++) {
00440       GoodsEntry *ge = &st->goods[i];
00441       SlObject(ge, GetGoodsDesc());
00442     }
00443     SlObject(st, _station_desc);
00444   }
00445 
00446   Waypoint *wp;
00447   FOR_ALL_WAYPOINTS(wp) {
00448     SlObject(wp, _waypoint_desc);
00449   }
00450 }
00451 
00452 static void Save_ROADSTOP()
00453 {
00454   RoadStop *rs;
00455 
00456   FOR_ALL_ROADSTOPS(rs) {
00457     SlSetArrayIndex(rs->index);
00458     SlObject(rs, _roadstop_desc);
00459   }
00460 }
00461 
00462 static void Load_ROADSTOP()
00463 {
00464   int index;
00465 
00466   while ((index = SlIterateArray()) != -1) {
00467     RoadStop *rs = new (index) RoadStop(INVALID_TILE);
00468 
00469     SlObject(rs, _roadstop_desc);
00470   }
00471 }
00472 
00473 static void Ptrs_ROADSTOP()
00474 {
00475   RoadStop *rs;
00476   FOR_ALL_ROADSTOPS(rs) {
00477     SlObject(rs, _roadstop_desc);
00478   }
00479 }
00480 
00481 extern const ChunkHandler _station_chunk_handlers[] = {
00482   { 'STNS', NULL,          Load_STNS,     Ptrs_STNS,     NULL, CH_ARRAY },
00483   { 'STNN', Save_STNN,     Load_STNN,     Ptrs_STNN,     NULL, CH_ARRAY },
00484   { 'ROAD', Save_ROADSTOP, Load_ROADSTOP, Ptrs_ROADSTOP, NULL, CH_ARRAY | CH_LAST},
00485 };

Generated on Sun Jan 9 16:02:00 2011 for OpenTTD by  doxygen 1.6.1