town_sl.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "../stdafx.h"
 
#include "saveload.h"
#include "compat/town_sl_compat.h"
 
#include "newgrf_sl.h"
#include "../newgrf_house.h"
#include "../town.h"
#include "../landscape.h"
#include "../subsidy_func.h"
#include "../strings_func.h"
#include "../misc/history_func.hpp"
 
#include "../safeguards.h"

void RebuildTownCaches()
{
  InitializeBuildingCounts();
  RebuildTownKdtree();
 
  /* Reset town population and num_houses */
  for (Town *town : Town::Iterate()) {
    town->cache.population = 0;
    town->cache.num_houses = 0;
  }
 
  for (const auto t : Map::Iterate()) {
    if (!IsTileType(t, TileType::House)) continue;
 
    HouseID house_id = GetHouseType(t);
    Town *town = Town::GetByTile(t);
    IncreaseBuildingCount(town, house_id);
    if (IsHouseCompleted(t)) town->cache.population += HouseSpec::Get(house_id)->population;
 
    /* Increase the number of houses for every house, but only once. */
    if (GetHouseNorthPart(house_id) == TileDiffXY(0, 0)) town->cache.num_houses++;
  }
 
  /* Update the population and num_house dependent values */
  for (Town *town : Town::Iterate()) {
    UpdateTownRadius(town);
  }
}

void UpdateHousesAndTowns()
{
  for (const auto t : Map::Iterate()) {
    if (!IsTileType(t, TileType::House)) continue;
 
    HouseID house_id = GetCleanHouseType(t);
    if (!HouseSpec::Get(house_id)->enabled && house_id >= NEW_HOUSE_OFFSET) {
      /* The specs for this type of house are not available any more, so
       * replace it with the substitute original house type. */
      house_id = _house_mngr.GetSubstituteID(house_id);
      SetHouseType(t, house_id);
    }
  }
 
  /* Check for cases when a NewGRF has set a wrong house substitute type. */
  for (const TileIndex &t : Map::Iterate()) {
    if (!IsTileType(t, TileType::House)) continue;
 
    HouseID house_type = GetCleanHouseType(t);
    TileIndex north_tile = t + GetHouseNorthPart(house_type); // modifies 'house_type'!
    if (t == north_tile) {
      const HouseSpec *hs = HouseSpec::Get(house_type);
      bool valid_house = true;
      if (hs->building_flags.Test(BuildingFlag::Size2x1)) {
        TileIndex tile = t + TileDiffXY(1, 0);
        if (!IsTileType(tile, TileType::House) || GetCleanHouseType(tile) != house_type + 1) valid_house = false;
      } else if (hs->building_flags.Test(BuildingFlag::Size1x2)) {
        TileIndex tile = t + TileDiffXY(0, 1);
        if (!IsTileType(tile, TileType::House) || GetCleanHouseType(tile) != house_type + 1) valid_house = false;
      } else if (hs->building_flags.Test(BuildingFlag::Size2x2)) {
        TileIndex tile = t + TileDiffXY(0, 1);
        if (!IsTileType(tile, TileType::House) || GetCleanHouseType(tile) != house_type + 1) valid_house = false;
        tile = t + TileDiffXY(1, 0);
        if (!IsTileType(tile, TileType::House) || GetCleanHouseType(tile) != house_type + 2) valid_house = false;
        tile = t + TileDiffXY(1, 1);
        if (!IsTileType(tile, TileType::House) || GetCleanHouseType(tile) != house_type + 3) valid_house = false;
      }
      /* If not all tiles of this house are present remove the house.
       * The other tiles will get removed later in this loop because
       * their north tile is not the correct type anymore. */
      if (!valid_house) DoClearSquare(t);
    } else if (!IsTileType(north_tile, TileType::House) || GetCleanHouseType(north_tile) != house_type) {
      /* This tile should be part of a multi-tile building but the
       * north tile of this house isn't on the map. */
      DoClearSquare(t);
    }
  }
 
  RebuildTownCaches();
}
 
 
class SlTownOldSupplied : public DefaultSaveLoadHandler<SlTownOldSupplied, Town> {
public:
  static inline const SaveLoad description[] = {
    SLE_CONDVAR(TransportedCargoStat<uint32_t>, old_max, SLE_UINT32, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint32_t>, new_max, SLE_UINT32, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint32_t>, old_act, SLE_UINT32, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint32_t>, new_act, SLE_UINT32, SLV_165, SL_MAX_VERSION),
  };
  static inline const SaveLoadCompatTable compat_description = _town_supplied_sl_compat;

  size_t GetNumCargo() const
  {
    if (IsSavegameVersionBefore(SLV_EXTEND_CARGOTYPES)) return 32;
    if (IsSavegameVersionBefore(SLV_SAVELOAD_LIST_LENGTH)) return NUM_CARGO;
    /* Read from the savegame how long the list is. */
    return SlGetStructListLength(NUM_CARGO);
  }
 
  void Load(Town *t) const override
  {
    size_t num_cargo = this->GetNumCargo();
    for (size_t i = 0; i < num_cargo; i++) {
      TransportedCargoStat<uint32_t> cargo_stat;
      SlObject(&cargo_stat, this->GetLoadDescription());
 
      /* Ignore empty statistics. */
      if (cargo_stat.new_act == 0 && cargo_stat.new_max == 0 && cargo_stat.old_act == 0 && cargo_stat.old_max == 0) continue;
 
      auto &s = t->supplied.emplace_back(static_cast<CargoType>(i));
      s.history[LAST_MONTH].production = cargo_stat.old_max;
      s.history[LAST_MONTH].transported = cargo_stat.old_act;
      s.history[THIS_MONTH].production = cargo_stat.new_max;
      s.history[THIS_MONTH].transported = cargo_stat.new_act;
    }
  }
};
 
class SlTownSuppliedHistory : public DefaultSaveLoadHandler<SlTownSuppliedHistory, Town::SuppliedCargo> {
public:
  static inline const SaveLoad description[] = {
     SLE_VAR(Town::SuppliedHistory, production, SLE_UINT32),
     SLE_VAR(Town::SuppliedHistory, transported, SLE_UINT32),
  };
  static inline const SaveLoadCompatTable compat_description = {};
 
  void Save(Town::SuppliedCargo *p) const override
  {
    SlSetStructListLength(p->history.size());
 
    for (auto &h : p->history) {
      SlObject(&h, this->GetDescription());
    }
  }
 
  void Load(Town::SuppliedCargo *p) const override
  {
    size_t len = SlGetStructListLength(p->history.size());
 
    for (auto &h : p->history) {
      if (--len > p->history.size()) break; // unsigned so wraps after hitting zero.
      SlObject(&h, this->GetLoadDescription());
    }
  }
};
 
class SlTownSupplied : public VectorSaveLoadHandler<SlTownSupplied, Town, Town::SuppliedCargo> {
public:
  inline static const SaveLoad description[] = {
    SLE_VAR(Town::SuppliedCargo, cargo, SLE_UINT8),
    SLEG_STRUCTLIST("history", SlTownSuppliedHistory),
  };
  inline const static SaveLoadCompatTable compat_description = {};
 
  std::vector<Town::SuppliedCargo> &GetVector(Town *t) const override { return t->supplied; }
};

class SlTownAcceptedHistory : public DefaultSaveLoadHandler<SlTownAcceptedHistory, Town::AcceptedCargo> {
public:
  static inline const SaveLoad description[] = {
     SLE_VAR(Town::AcceptedHistory, accepted, SLE_UINT32),
  };

  static inline const SaveLoadCompatTable compat_description = {};
 
  void Save(Town::AcceptedCargo *p) const override
  {
    SlSetStructListLength(p->history.size());
 
    for (auto &h : p->history) {
      SlObject(&h, this->GetDescription());
    }
  }
 
  void Load(Town::AcceptedCargo *p) const override
  {
    size_t len = SlGetStructListLength(p->history.size());
 
    for (auto &h : p->history) {
      if (--len > p->history.size()) break; // unsigned so wraps after hitting zero.
      SlObject(&h, this->GetLoadDescription());
    }
  }
};

class SlTownAccepted : public VectorSaveLoadHandler<SlTownAccepted, Town, Town::AcceptedCargo> {
public:
  inline static const SaveLoad description[] = {
    SLE_VAR(Town::AcceptedCargo, cargo, SLE_UINT8),
    SLEG_STRUCTLIST("history", SlTownAcceptedHistory),
  };

  inline const static SaveLoadCompatTable compat_description = {};
 
  std::vector<Town::AcceptedCargo> &GetVector(Town *t) const override { return t->accepted; }
};
 
class SlTownReceived : public DefaultSaveLoadHandler<SlTownReceived, Town> {
public:
  static inline const SaveLoad description[] = {
    SLE_CONDVAR(TransportedCargoStat<uint16_t>, old_max, SLE_UINT16, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint16_t>, new_max, SLE_UINT16, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint16_t>, old_act, SLE_UINT16, SLV_165, SL_MAX_VERSION),
    SLE_CONDVAR(TransportedCargoStat<uint16_t>, new_act, SLE_UINT16, SLV_165, SL_MAX_VERSION),
  };
  static inline const SaveLoadCompatTable compat_description = _town_received_sl_compat;
 
  void Save(Town *t) const override
  {
    SlSetStructListLength(std::size(t->received));
    for (auto &received : t->received) {
      SlObject(&received, this->GetDescription());
    }
  }
 
  void Load(Town *t) const override
  {
    size_t length = IsSavegameVersionBefore(SLV_SAVELOAD_LIST_LENGTH) ? static_cast<size_t>(TAE_END) : SlGetStructListLength(TAE_END);
    for (size_t i = 0; i < length; i++) {
      SlObject(&t->received[i], this->GetLoadDescription());
    }
  }
};
 
class SlTownAcceptanceMatrix : public DefaultSaveLoadHandler<SlTownAcceptanceMatrix, Town> {
private:
  struct AcceptanceMatrix {
    TileArea area;
    static const uint GRID = 4;
  };
public:
  static inline const SaveLoad description[] = {
    SLE_VAR(AcceptanceMatrix, area.tile, SLE_UINT32),
    SLE_VAR(AcceptanceMatrix, area.w,    SLE_UINT16),
    SLE_VAR(AcceptanceMatrix, area.h,    SLE_UINT16),
  };
  static inline const SaveLoadCompatTable compat_description = _town_acceptance_matrix_sl_compat;
 
  void Load(Town *) const override
  {
    /* Discard now unused acceptance matrix. */
    AcceptanceMatrix dummy;
    SlObject(&dummy, this->GetLoadDescription());
    if (dummy.area.w != 0) {
      uint arr_len = dummy.area.w / AcceptanceMatrix::GRID * dummy.area.h / AcceptanceMatrix::GRID;
      SlSkipBytes(4 * arr_len);
    }
  }
};
 
static std::array<Town::SuppliedHistory, 2> _old_pass_supplied{};
static std::array<Town::SuppliedHistory, 2> _old_mail_supplied{};
 
static const SaveLoad _town_desc[] = {
  SLE_CONDVAR(Town, xy,                    SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_6),
  SLE_CONDVAR(Town, xy,                    SLE_UINT32,                 SLV_6, SL_MAX_VERSION),
 
  SLE_CONDVAR(Town, townnamegrfid,         SLE_UINT32, SLV_66, SL_MAX_VERSION),
      SLE_VAR(Town, townnametype,          SLE_UINT16),
      SLE_VAR(Town, townnameparts,         SLE_UINT32),
  SLE_CONDSSTR(Town, name,                 SLE_STR | SLF_ALLOW_CONTROL, SLV_84, SL_MAX_VERSION),
 
      SLE_VAR(Town, flags,                 SLE_UINT8),
  SLE_CONDVAR(Town, statues,               SLE_FILE_U8  | SLE_VAR_U16, SL_MIN_VERSION, SLV_104),
  SLE_CONDVAR(Town, statues,               SLE_UINT16,               SLV_104, SL_MAX_VERSION),
 
  SLE_CONDVAR(Town, have_ratings,          SLE_FILE_U8  | SLE_VAR_U16, SL_MIN_VERSION, SLV_104),
  SLE_CONDVAR(Town, have_ratings,          SLE_UINT16,               SLV_104, SL_MAX_VERSION),
  SLE_CONDARR(Town, ratings,               SLE_INT16, 8,               SL_MIN_VERSION, SLV_104),
  SLE_CONDARR(Town, ratings,               SLE_INT16, MAX_COMPANIES, SLV_104, SL_MAX_VERSION),
  SLE_CONDARR(Town, unwanted,              SLE_INT8,  8,               SLV_4, SLV_104),
  SLE_CONDARR(Town, unwanted,              SLE_INT8,  MAX_COMPANIES, SLV_104, SL_MAX_VERSION),
 
  /* Slots 0 and 2 are passengers and mail respectively for old saves. */
  SLEG_CONDVAR("supplied[CT_PASSENGERS].old_max", _old_pass_supplied[LAST_MONTH].production, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].old_max", _old_pass_supplied[LAST_MONTH].production, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR(      "supplied[CT_MAIL].old_max", _old_mail_supplied[LAST_MONTH].production, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR(      "supplied[CT_MAIL].old_max", _old_mail_supplied[LAST_MONTH].production, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].new_max", _old_pass_supplied[THIS_MONTH].production, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].new_max", _old_pass_supplied[THIS_MONTH].production, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR(      "supplied[CT_MAIL].new_max", _old_mail_supplied[THIS_MONTH].production, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR(      "supplied[CT_MAIL].new_max", _old_mail_supplied[THIS_MONTH].production, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].old_act", _old_pass_supplied[LAST_MONTH].transported, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].old_act", _old_pass_supplied[LAST_MONTH].transported, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR(      "supplied[CT_MAIL].old_act", _old_mail_supplied[LAST_MONTH].transported, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR(      "supplied[CT_MAIL].old_act", _old_mail_supplied[LAST_MONTH].transported, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].new_act", _old_pass_supplied[THIS_MONTH].transported, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR("supplied[CT_PASSENGERS].new_act", _old_pass_supplied[THIS_MONTH].transported, SLE_UINT32,                 SLV_9, SLV_165),
  SLEG_CONDVAR(      "supplied[CT_MAIL].new_act", _old_mail_supplied[THIS_MONTH].transported, SLE_FILE_U16 | SLE_VAR_U32, SL_MIN_VERSION, SLV_9),
  SLEG_CONDVAR(      "supplied[CT_MAIL].new_act", _old_mail_supplied[THIS_MONTH].transported, SLE_UINT32,                 SLV_9, SLV_165),
 
  SLE_CONDVARNAME(Town, received[TAE_FOOD].old_act,  "received[TE_FOOD].old_act",  SLE_UINT16,                 SL_MIN_VERSION, SLV_165),
  SLE_CONDVARNAME(Town, received[TAE_WATER].old_act, "received[TE_WATER].old_act", SLE_UINT16,                 SL_MIN_VERSION, SLV_165),
  SLE_CONDVARNAME(Town, received[TAE_FOOD].new_act,  "received[TE_FOOD].new_act",  SLE_UINT16,                 SL_MIN_VERSION, SLV_165),
  SLE_CONDVARNAME(Town, received[TAE_WATER].new_act, "received[TE_WATER].new_act", SLE_UINT16,                 SL_MIN_VERSION, SLV_165),
 
  SLE_CONDARR(Town, goal, SLE_UINT32, NUM_TAE, SLV_165, SL_MAX_VERSION),
 
  SLE_CONDSSTR(Town, text,                 SLE_STR | SLF_ALLOW_CONTROL, SLV_168, SL_MAX_VERSION),
 
  SLE_CONDVAR(Town, time_until_rebuild,    SLE_FILE_U8 | SLE_VAR_U16,  SL_MIN_VERSION, SLV_54),
  SLE_CONDVAR(Town, time_until_rebuild,    SLE_UINT16,                SLV_54, SL_MAX_VERSION),
  SLE_CONDVAR(Town, grow_counter,          SLE_FILE_U8 | SLE_VAR_U16,  SL_MIN_VERSION, SLV_54),
  SLE_CONDVAR(Town, grow_counter,          SLE_UINT16,                SLV_54, SL_MAX_VERSION),
  SLE_CONDVAR(Town, growth_rate,           SLE_FILE_U8 | SLE_VAR_I16,  SL_MIN_VERSION, SLV_54),
  SLE_CONDVAR(Town, growth_rate,           SLE_FILE_I16 | SLE_VAR_U16, SLV_54, SLV_165),
  SLE_CONDVAR(Town, growth_rate,           SLE_UINT16,                 SLV_165, SL_MAX_VERSION),
 
      SLE_VAR(Town, fund_buildings_months, SLE_UINT8),
      SLE_VAR(Town, road_build_months,     SLE_UINT8),
 
  SLE_CONDVAR(Town, exclusivity,           SLE_UINT8,                  SLV_2, SL_MAX_VERSION),
  SLE_CONDVAR(Town, exclusive_counter,     SLE_UINT8,                  SLV_2, SL_MAX_VERSION),
 
  SLE_CONDVAR(Town, larger_town,           SLE_BOOL,                  SLV_56, SL_MAX_VERSION),
  SLE_CONDVAR(Town, layout,                SLE_UINT8,                SLV_113, SL_MAX_VERSION),
  SLE_CONDVAR(Town, valid_history, SLE_UINT64, SLV_TOWN_SUPPLY_HISTORY, SL_MAX_VERSION),
 
  SLE_CONDREFVECTOR(Town, psa_list,        REF_STORAGE,              SLV_161, SL_MAX_VERSION),
 
  SLEG_CONDSTRUCTLIST("supplied", SlTownOldSupplied,                 SLV_165, SLV_TOWN_SUPPLY_HISTORY),
  SLEG_CONDSTRUCTLIST("supplied", SlTownSupplied,                    SLV_TOWN_SUPPLY_HISTORY, SL_MAX_VERSION),
  SLEG_STRUCTLIST("accepted", SlTownAccepted),
  SLEG_CONDSTRUCTLIST("received", SlTownReceived,                    SLV_165, SL_MAX_VERSION),
  SLEG_CONDSTRUCTLIST("acceptance_matrix", SlTownAcceptanceMatrix,   SLV_166, SLV_REMOVE_TOWN_CARGO_CACHE),
};
 
struct HIDSChunkHandler : NewGRFMappingChunkHandler {
  HIDSChunkHandler() : NewGRFMappingChunkHandler('HIDS', _house_mngr) {}
};
 
struct CITYChunkHandler : ChunkHandler {
  CITYChunkHandler() : ChunkHandler('CITY', CH_TABLE) {}
 
  void Save() const override
  {
    SlTableHeader(_town_desc);
 
    for (Town *t : Town::Iterate()) {
      SlSetArrayIndex(t->index);
      SlObject(t, _town_desc);
    }
  }
 
  void Load() const override
  {
    const std::vector<SaveLoad> slt = SlCompatTableHeader(_town_desc, _town_sl_compat);
 
    int index;
 
    while ((index = SlIterateArray()) != -1) {
      Town *t = Town::CreateAtIndex(TownID(index));
      SlObject(t, slt);
 
      if (IsSavegameVersionBefore(SLV_165)) {
        /* Passengers and mail were always treated as slots 0 and 2 in older saves. */
        auto &pass = t->supplied.emplace_back(0);
        pass.history[LAST_MONTH] = _old_pass_supplied[LAST_MONTH];
        pass.history[THIS_MONTH] = _old_pass_supplied[THIS_MONTH];
        auto &mail = t->supplied.emplace_back(2);
        mail.history[LAST_MONTH] = _old_mail_supplied[LAST_MONTH];
        mail.history[THIS_MONTH] = _old_mail_supplied[THIS_MONTH];
      }
 
      if (IsSavegameVersionBefore(SLV_TOWN_SUPPLY_HISTORY)) {
        t->valid_history = 1U << LAST_MONTH;
      }
 
      if (t->townnamegrfid == 0 && !IsInsideMM(t->townnametype, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_END) && GetStringTab(t->townnametype) != TEXT_TAB_OLD_CUSTOM) {
        SlErrorCorrupt("Invalid town name generator");
      }
    }
  }
 
  void FixPointers() const override
  {
    if (IsSavegameVersionBefore(SLV_161)) return;
 
    for (Town *t : Town::Iterate()) {
      SlObject(t, _town_desc);
    }
  }
};
 
static const HIDSChunkHandler HIDS;
static const CITYChunkHandler CITY;
static const ChunkHandlerRef town_chunk_handlers[] = {
  HIDS,
  CITY,
};
 
extern const ChunkHandlerTable _town_chunk_handlers(town_chunk_handlers);