src/newgrf_town.cpp

   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  */
   7
   8 /** @file newgrf_town.cpp Implementation of the town part of NewGRF houses. */
   9
  10 #include "stdafx.h"
  11 #include "debug.h"
  12 #include "town.h"
  13 #include "newgrf_town.h"
  14
  15 #include "safeguards.h"
  16
  17 /* virtual */ uint32 TownScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
  18 {
  19         switch (variable) {
  20                 /* Larger towns */
  21                 case 0x40:
  22                         if (_settings_game.economy.larger_towns == 0) return 2;
  23                         if (this->t->larger_town) return 1;
  24                         return 0;
  25
  26                 /* Town index */
  27                 case 0x41: return this->t->index;
  28
  29                 /* Get a variable from the persistent storage */
  30                 case 0x7C: {
  31                         /* Check the persistent storage for the GrfID stored in register 100h. */
  32                         uint32 grfid = GetRegister(0x100);
  33                         if (grfid == 0xFFFFFFFF) {
  34                                 if (this->ro.grffile == nullptr) return 0;
  35                                 grfid = this->ro.grffile->grfid;
  36                         }
  37
  38                         std::list<PersistentStorage *>::iterator iter;
  39                         for (iter = this->t->psa_list.begin(); iter != this->t->psa_list.end(); iter++) {
  40                                 if ((*iter)->grfid == grfid) return (*iter)->GetValue(parameter);
  41                         }
  42
  43                         return 0;
  44                 }
  45
  46                 /* Town properties */
  47                 case 0x80: return this->t->xy;
  48                 case 0x81: return GB(this->t->xy, 8, 8);
  49                 case 0x82: return ClampToU16(this->t->cache.population);
  50                 case 0x83: return GB(ClampToU16(this->t->cache.population), 8, 8);
  51                 case 0x8A: return this->t->grow_counter / TOWN_GROWTH_TICKS;
  52                 case 0x92: return this->t->flags;  // In original game, 0x92 and 0x93 are really one word. Since flags is a byte, this is to adjust
  53                 case 0x93: return 0;
  54                 case 0x94: return ClampToU16(this->t->cache.squared_town_zone_radius[0]);
  55                 case 0x95: return GB(ClampToU16(this->t->cache.squared_town_zone_radius[0]), 8, 8);
  56                 case 0x96: return ClampToU16(this->t->cache.squared_town_zone_radius[1]);
  57                 case 0x97: return GB(ClampToU16(this->t->cache.squared_town_zone_radius[1]), 8, 8);
  58                 case 0x98: return ClampToU16(this->t->cache.squared_town_zone_radius[2]);
  59                 case 0x99: return GB(ClampToU16(this->t->cache.squared_town_zone_radius[2]), 8, 8);
  60                 case 0x9A: return ClampToU16(this->t->cache.squared_town_zone_radius[3]);
  61                 case 0x9B: return GB(ClampToU16(this->t->cache.squared_town_zone_radius[3]), 8, 8);
  62                 case 0x9C: return ClampToU16(this->t->cache.squared_town_zone_radius[4]);
  63                 case 0x9D: return GB(ClampToU16(this->t->cache.squared_town_zone_radius[4]), 8, 8);
  64                 case 0x9E: return this->t->ratings[0];
  65                 case 0x9F: return GB(this->t->ratings[0], 8, 8);
  66                 case 0xA0: return this->t->ratings[1];
  67                 case 0xA1: return GB(this->t->ratings[1], 8, 8);
  68                 case 0xA2: return this->t->ratings[2];
  69                 case 0xA3: return GB(this->t->ratings[2], 8, 8);
  70                 case 0xA4: return this->t->ratings[3];
  71                 case 0xA5: return GB(this->t->ratings[3], 8, 8);
  72                 case 0xA6: return this->t->ratings[4];
  73                 case 0xA7: return GB(this->t->ratings[4], 8, 8);
  74                 case 0xA8: return this->t->ratings[5];
  75                 case 0xA9: return GB(this->t->ratings[5], 8, 8);
  76                 case 0xAA: return this->t->ratings[6];
  77                 case 0xAB: return GB(this->t->ratings[6], 8, 8);
  78                 case 0xAC: return this->t->ratings[7];
  79                 case 0xAD: return GB(this->t->ratings[7], 8, 8);
  80                 case 0xAE: return this->t->have_ratings;
  81                 case 0xB2: return this->t->statues;
  82                 case 0xB6: return ClampToU16(this->t->cache.num_houses);
  83                 case 0xB9: return this->t->growth_rate / TOWN_GROWTH_TICKS;
  84                 case 0xBA: return ClampToU16(this->t->supplied[CT_PASSENGERS].new_max);
  85                 case 0xBB: return GB(ClampToU16(this->t->supplied[CT_PASSENGERS].new_max), 8, 8);
  86                 case 0xBC: return ClampToU16(this->t->supplied[CT_MAIL].new_max);
  87                 case 0xBD: return GB(ClampToU16(this->t->supplied[CT_MAIL].new_max), 8, 8);
  88                 case 0xBE: return ClampToU16(this->t->supplied[CT_PASSENGERS].new_act);
  89                 case 0xBF: return GB(ClampToU16(this->t->supplied[CT_PASSENGERS].new_act), 8, 8);
  90                 case 0xC0: return ClampToU16(this->t->supplied[CT_MAIL].new_act);
  91                 case 0xC1: return GB(ClampToU16(this->t->supplied[CT_MAIL].new_act), 8, 8);
  92                 case 0xC2: return ClampToU16(this->t->supplied[CT_PASSENGERS].old_max);
  93                 case 0xC3: return GB(ClampToU16(this->t->supplied[CT_PASSENGERS].old_max), 8, 8);
  94                 case 0xC4: return ClampToU16(this->t->supplied[CT_MAIL].old_max);
  95                 case 0xC5: return GB(ClampToU16(this->t->supplied[CT_MAIL].old_max), 8, 8);
  96                 case 0xC6: return ClampToU16(this->t->supplied[CT_PASSENGERS].old_act);
  97                 case 0xC7: return GB(ClampToU16(this->t->supplied[CT_PASSENGERS].old_act), 8, 8);
  98                 case 0xC8: return ClampToU16(this->t->supplied[CT_MAIL].old_act);
  99                 case 0xC9: return GB(ClampToU16(this->t->supplied[CT_MAIL].old_act), 8, 8);
 100                 case 0xCA: return this->t->GetPercentTransported(CT_PASSENGERS);
 101                 case 0xCB: return this->t->GetPercentTransported(CT_MAIL);
 102                 case 0xCC: return this->t->received[TE_FOOD].new_act;
 103                 case 0xCD: return GB(this->t->received[TE_FOOD].new_act, 8, 8);
 104                 case 0xCE: return this->t->received[TE_WATER].new_act;
 105                 case 0xCF: return GB(this->t->received[TE_WATER].new_act, 8, 8);
 106                 case 0xD0: return this->t->received[TE_FOOD].old_act;
 107                 case 0xD1: return GB(this->t->received[TE_FOOD].old_act, 8, 8);
 108                 case 0xD2: return this->t->received[TE_WATER].old_act;
 109                 case 0xD3: return GB(this->t->received[TE_WATER].old_act, 8, 8);
 110                 case 0xD4: return this->t->road_build_months;
 111                 case 0xD5: return this->t->fund_buildings_months;
 112         }
 113
 114         Debug(grf, 1, "Unhandled town variable 0x{:X}", variable);
 115
 116         *available = false;
 117         return UINT_MAX;
 118 }
 119
 120 /* virtual */ void TownScopeResolver::StorePSA(uint pos, int32 value)
 121 {
 122         if (this->readonly) return;
 123
 124         assert(this->t != nullptr);
 125         /* We can't store anything if the caller has no #GRFFile. */
 126         if (this->ro.grffile == nullptr) return;
 127
 128         /* Check the persistent storage for the GrfID stored in register 100h. */
 129         uint32 grfid = GetRegister(0x100);
 130
 131         /* A NewGRF can only write in the persistent storage associated to its own GRFID. */
 132         if (grfid == 0xFFFFFFFF) grfid = this->ro.grffile->grfid;
 133         if (grfid != this->ro.grffile->grfid) return;
 134
 135         /* Check if the storage exists. */
 136         std::list<PersistentStorage *>::iterator iter;
 137         for (iter = t->psa_list.begin(); iter != t->psa_list.end(); iter++) {
 138                 if ((*iter)->grfid == grfid) {
 139                         (*iter)->StoreValue(pos, value);
 140                         return;
 141                 }
 142         }
 143
 144         /* Create a new storage. */
 145         assert(PersistentStorage::CanAllocateItem());
 146         PersistentStorage *psa = new PersistentStorage(grfid, GSF_FAKE_TOWNS, this->t->xy);
 147         psa->StoreValue(pos, value);
 148         t->psa_list.push_back(psa);
 149 }
 150
 151 /**
 152  * Resolver for a town.
 153  * @param grffile NewGRF file associated with the town.
 154  * @param t %Town of the scope.
 155  * @param readonly Scope may change persistent storage of the town.
 156  */
 157 TownResolverObject::TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly)
 158                 : ResolverObject(grffile), town_scope(*this, t, readonly)
 159 {
 160 }
 161