src/newgrf_industries.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_industries.cpp Handling of NewGRF industries. */
   9
  10 #include "stdafx.h"
  11 #include "debug.h"
  12 #include "industry.h"
  13 #include "newgrf_industries.h"
  14 #include "newgrf_town.h"
  15 #include "newgrf_cargo.h"
  16 #include "window_func.h"
  17 #include "town.h"
  18 #include "company_base.h"
  19 #include "error.h"
  20 #include "strings_func.h"
  21 #include "core/random_func.hpp"
  22 #include "timer/timer_game_calendar.h"
  23
  24 #include "table/strings.h"
  25
  26 #include "safeguards.h"
  27
  28 /* Since the industry IDs defined by the GRF file don't necessarily correlate
  29  * to those used by the game, the IDs used for overriding old industries must be
  30  * translated when the idustry spec is set. */
  31 IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);
  32 IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);
  33
  34 /**
  35  * Map the GRF local type to an industry type.
  36  * @param grf_type The GRF local type.
  37  * @param grf_id The GRF of the local type.
  38  * @return The industry type in the global scope.
  39  */
  40 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id)
  41 {
  42         if (grf_type == IT_INVALID) return IT_INVALID;
  43         if (!HasBit(grf_type, 7)) return GB(grf_type, 0, 7);
  44
  45         return _industry_mngr.GetID(GB(grf_type, 0, 7), grf_id);
  46 }
  47
  48 /**
  49  * Make an analysis of a tile and check for its belonging to the same
  50  * industry, and/or the same grf file
  51  * @param tile TileIndex of the tile to query
  52  * @param i Industry to which to compare the tile to
  53  * @param cur_grfid GRFID of the current callback chain
  54  * @return value encoded as per NFO specs
  55  */
  56 uint32_t GetIndustryIDAtOffset(TileIndex tile, const Industry *i, uint32_t cur_grfid)
  57 {
  58         if (!i->TileBelongsToIndustry(tile)) {
  59                 /* No industry and/or the tile does not have the same industry as the one we match it with */
  60                 return 0xFFFF;
  61         }
  62
  63         IndustryGfx gfx = GetCleanIndustryGfx(tile);
  64         const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);
  65
  66         if (gfx < NEW_INDUSTRYTILEOFFSET) { // Does it belongs to an old type?
  67                 /* It is an old tile.  We have to see if it's been overridden */
  68                 if (indtsp->grf_prop.override == INVALID_INDUSTRYTILE) { // has it been overridden?
  69                         return 0xFF << 8 | gfx; // no. Tag FF + the gfx id of that tile
  70                 }
  71                 /* Overridden */
  72                 const IndustryTileSpec *tile_ovr = GetIndustryTileSpec(indtsp->grf_prop.override);
  73
  74                 if (tile_ovr->grf_prop.grffile->grfid == cur_grfid) {
  75                         return tile_ovr->grf_prop.local_id; // same grf file
  76                 } else {
  77                         return 0xFFFE; // not the same grf file
  78                 }
  79         }
  80         /* Not an 'old type' tile */
  81         if (indtsp->grf_prop.spritegroup[0] != nullptr) { // tile has a spritegroup ?
  82                 if (indtsp->grf_prop.grffile->grfid == cur_grfid) { // same industry, same grf ?
  83                         return indtsp->grf_prop.local_id;
  84                 } else {
  85                         return 0xFFFE; // Defined in another grf file
  86                 }
  87         }
  88         /* The tile has no spritegroup */
  89         return 0xFF << 8 | indtsp->grf_prop.subst_id; // so just give it the substitute
  90 }
  91
  92 static uint32_t GetClosestIndustry(TileIndex tile, IndustryType type, const Industry *current)
  93 {
  94         uint32_t best_dist = UINT32_MAX;
  95         for (const Industry *i : Industry::Iterate()) {
  96                 if (i->type != type || i == current) continue;
  97
  98                 best_dist = std::min(best_dist, DistanceManhattan(tile, i->location.tile));
  99         }
 100
 101         return best_dist;
 102 }
 103
 104 /**
 105  * Implementation of both var 67 and 68
 106  * since the mechanism is almost the same, it is easier to regroup them on the same
 107  * function.
 108  * @param param_setID parameter given to the callback, which is the set id, or the local id, in our terminology
 109  * @param layout_filter on what layout do we filter?
 110  * @param town_filter Do we filter on the same town as the current industry?
 111  * @param current Industry for which the inquiry is made
 112  * @return the formatted answer to the callback : rr(reserved) cc(count) dddd(manhattan distance of closest sister)
 113  */
 114 static uint32_t GetCountAndDistanceOfClosestInstance(uint8_t param_setID, uint8_t layout_filter, bool town_filter, const Industry *current)
 115 {
 116         uint32_t GrfID = GetRegister(0x100);  ///< Get the GRFID of the definition to look for in register 100h
 117         IndustryType ind_index;
 118         uint32_t closest_dist = UINT32_MAX;
 119         uint8_t count = 0;
 120
 121         /* Determine what will be the industry type to look for */
 122         switch (GrfID) {
 123                 case 0:  // this is a default industry type
 124                         ind_index = param_setID;
 125                         break;
 126
 127                 case 0xFFFFFFFF: // current grf
 128                         GrfID = GetIndustrySpec(current->type)->grf_prop.grffile->grfid;
 129                         [[fallthrough]];
 130
 131                 default: // use the grfid specified in register 100h
 132                         SetBit(param_setID, 7); // bit 7 means it is not an old type
 133                         ind_index = MapNewGRFIndustryType(param_setID, GrfID);
 134                         break;
 135         }
 136
 137         /* If the industry type is invalid, there is none and the closest is far away. */
 138         if (ind_index >= NUM_INDUSTRYTYPES) return 0 | 0xFFFF;
 139
 140         if (layout_filter == 0 && !town_filter) {
 141                 /* If the filter is 0, it could be because none was specified as well as being really a 0.
 142                  * In either case, just do the regular var67 */
 143                 closest_dist = GetClosestIndustry(current->location.tile, ind_index, current);
 144                 count = ClampTo<uint8_t>(Industry::GetIndustryTypeCount(ind_index));
 145         } else {
 146                 /* Count only those who match the same industry type and layout filter
 147                  * Unfortunately, we have to do it manually */
 148                 for (const Industry *i : Industry::Iterate()) {
 149                         if (i->type == ind_index && i != current && (i->selected_layout == layout_filter || layout_filter == 0) && (!town_filter || i->town == current->town)) {
 150                                 closest_dist = std::min(closest_dist, DistanceManhattan(current->location.tile, i->location.tile));
 151                                 count++;
 152                         }
 153                 }
 154         }
 155
 156         return count << 16 | GB(closest_dist, 0, 16);
 157 }
 158
 159 /* virtual */ uint32_t IndustriesScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
 160 {
 161         if (this->ro.callback == CBID_INDUSTRY_LOCATION) {
 162                 /* Variables available during construction check. */
 163
 164                 switch (variable) {
 165                         case 0x80: return this->tile.base();
 166                         case 0x81: return GB(this->tile.base(), 8, 8);
 167
 168                         /* Pointer to the town the industry is associated with */
 169                         case 0x82: return this->industry->town->index;
 170                         case 0x83:
 171                         case 0x84:
 172                         case 0x85: Debug(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported
 173
 174                         /* Number of the layout */
 175                         case 0x86: return this->industry->selected_layout;
 176
 177                         /* Ground type */
 178                         case 0x87: return GetTerrainType(this->tile);
 179
 180                         /* Town zone */
 181                         case 0x88: return GetTownRadiusGroup(this->industry->town, this->tile);
 182
 183                         /* Manhattan distance of the closest town */
 184                         case 0x89: return ClampTo<uint8_t>(DistanceManhattan(this->industry->town->xy, this->tile));
 185
 186                         /* Lowest height of the tile */
 187                         case 0x8A: return ClampTo<uint8_t>(GetTileZ(this->tile) * (this->ro.grffile->grf_version >= 8 ? 1 : TILE_HEIGHT));
 188
 189                         /* Distance to the nearest water/land tile */
 190                         case 0x8B: return GetClosestWaterDistance(this->tile, (GetIndustrySpec(this->industry->type)->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);
 191
 192                         /* Square of Euclidian distance from town */
 193                         case 0x8D: return ClampTo<uint16_t>(DistanceSquare(this->industry->town->xy, this->tile));
 194
 195                         /* 32 random bits */
 196                         case 0x8F: return this->random_bits;
 197                 }
 198         }
 199
 200         const IndustrySpec *indspec = GetIndustrySpec(this->type);
 201
 202         if (this->industry == nullptr) {
 203                 Debug(grf, 1, "Unhandled variable 0x{:X} (no available industry) in callback 0x{:x}", variable, this->ro.callback);
 204
 205                 available = false;
 206                 return UINT_MAX;
 207         }
 208
 209         switch (variable) {
 210                 case 0x40:
 211                 case 0x41:
 212                 case 0x42: { // waiting cargo, but only if those two callback flags are set
 213                         uint16_t callback = indspec->callback_mask;
 214                         if (HasBit(callback, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HasBit(callback, CBM_IND_PRODUCTION_256_TICKS)) {
 215                                 if ((indspec->behaviour & INDUSTRYBEH_PROD_MULTI_HNDLING) != 0) {
 216                                         if (this->industry->prod_level == 0) return 0;
 217                                         return ClampTo<uint16_t>(this->industry->GetAccepted(variable - 0x40).waiting / this->industry->prod_level);
 218                                 } else {
 219                                         return ClampTo<uint16_t>(this->industry->GetAccepted(variable - 0x40).waiting);
 220                                 }
 221                         } else {
 222                                 return 0;
 223                         }
 224                 }
 225
 226                 /* Manhattan distance of closes dry/water tile */
 227                 case 0x43:
 228                         if (this->tile == INVALID_TILE) break;
 229                         return GetClosestWaterDistance(this->tile, (indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);
 230
 231                 /* Layout number */
 232                 case 0x44: return this->industry->selected_layout;
 233
 234                 /* Company info */
 235                 case 0x45: {
 236                         uint8_t colours = 0;
 237                         bool is_ai = false;
 238
 239                         const Company *c = Company::GetIfValid(this->industry->founder);
 240                         if (c != nullptr) {
 241                                 const Livery *l = &c->livery[LS_DEFAULT];
 242
 243                                 is_ai = c->is_ai;
 244                                 colours = l->colour1 + l->colour2 * 16;
 245                         }
 246
 247                         return this->industry->founder | (is_ai ? 0x10000 : 0) | (colours << 24);
 248                 }
 249
 250                 case 0x46: return this->industry->construction_date.base(); // Date when built - long format - (in days)
 251
 252                 /* Override flags from GS */
 253                 case 0x47: return this->industry->ctlflags;
 254
 255                 /* Get industry ID at offset param */
 256                 case 0x60: return GetIndustryIDAtOffset(GetNearbyTile(parameter, this->industry->location.tile, false), this->industry, this->ro.grffile->grfid);
 257
 258                 /* Get random tile bits at offset param */
 259                 case 0x61: {
 260                         if (this->tile == INVALID_TILE) break;
 261                         TileIndex tile = GetNearbyTile(parameter, this->tile, false);
 262                         return this->industry->TileBelongsToIndustry(tile) ? GetIndustryRandomBits(tile) : 0;
 263                 }
 264
 265                 /* Land info of nearby tiles */
 266                 case 0x62:
 267                         if (this->tile == INVALID_TILE) break;
 268                         return GetNearbyIndustryTileInformation(parameter, this->tile, INVALID_INDUSTRY, false, this->ro.grffile->grf_version >= 8);
 269
 270                 /* Animation stage of nearby tiles */
 271                 case 0x63: {
 272                         if (this->tile == INVALID_TILE) break;
 273                         TileIndex tile = GetNearbyTile(parameter, this->tile, false);
 274                         if (this->industry->TileBelongsToIndustry(tile)) {
 275                                 return GetAnimationFrame(tile);
 276                         }
 277                         return 0xFFFFFFFF;
 278                 }
 279
 280                 /* Distance of nearest industry of given type */
 281                 case 0x64:
 282                         if (this->tile == INVALID_TILE) break;
 283                         return GetClosestIndustry(this->tile, MapNewGRFIndustryType(parameter, indspec->grf_prop.grffile->grfid), this->industry);
 284                 /* Get town zone and Manhattan distance of closest town */
 285                 case 0x65: {
 286                         if (this->tile == INVALID_TILE) break;
 287                         TileIndex tile = GetNearbyTile(parameter, this->tile, true);
 288                         return GetTownRadiusGroup(this->industry->town, tile) << 16 | ClampTo<uint16_t>(DistanceManhattan(tile, this->industry->town->xy));
 289                 }
 290                 /* Get square of Euclidian distance of closest town */
 291                 case 0x66: {
 292                         if (this->tile == INVALID_TILE) break;
 293                         TileIndex tile = GetNearbyTile(parameter, this->tile, true);
 294                         return DistanceSquare(tile, this->industry->town->xy);
 295                 }
 296
 297                 /* Count of industry, distance of closest instance
 298                  * 68 is the same as 67, but with a filtering on selected layout */
 299                 case 0x67:
 300                 case 0x68: {
 301                         uint8_t layout_filter = 0;
 302                         bool town_filter = false;
 303                         if (variable == 0x68) {
 304                                 uint32_t reg = GetRegister(0x101);
 305                                 layout_filter = GB(reg, 0, 8);
 306                                 town_filter = HasBit(reg, 8);
 307                         }
 308                         return GetCountAndDistanceOfClosestInstance(parameter, layout_filter, town_filter, this->industry);
 309                 }
 310
 311                 case 0x69:
 312                 case 0x6A:
 313                 case 0x6B:
 314                 case 0x6C:
 315                 case 0x6D:
 316                 case 0x70:
 317                 case 0x71: {
 318                         CargoID cargo = GetCargoTranslation(parameter, this->ro.grffile);
 319                         if (!IsValidCargoID(cargo)) return 0;
 320                         auto it = this->industry->GetCargoProduced(cargo);
 321                         if (it == std::end(this->industry->produced)) return 0; // invalid cargo
 322                         switch (variable) {
 323                                 case 0x69: return it->waiting;
 324                                 case 0x6A: return it->history[THIS_MONTH].production;
 325                                 case 0x6B: return it->history[THIS_MONTH].transported;
 326                                 case 0x6C: return it->history[LAST_MONTH].production;
 327                                 case 0x6D: return it->history[LAST_MONTH].transported;
 328                                 case 0x70: return it->rate;
 329                                 case 0x71: return it->history[LAST_MONTH].PctTransported();
 330                                 default: NOT_REACHED();
 331                         }
 332                 }
 333
 334
 335                 case 0x6E:
 336                 case 0x6F: {
 337                         CargoID cargo = GetCargoTranslation(parameter, this->ro.grffile);
 338                         if (!IsValidCargoID(cargo)) return 0;
 339                         auto it = this->industry->GetCargoAccepted(cargo);
 340                         if (it == std::end(this->industry->accepted)) return 0; // invalid cargo
 341                         if (variable == 0x6E) return it->last_accepted.base();
 342                         if (variable == 0x6F) return it->waiting;
 343                         NOT_REACHED();
 344                 }
 345
 346                 /* Get a variable from the persistent storage */
 347                 case 0x7C: return (this->industry->psa != nullptr) ? this->industry->psa->GetValue(parameter) : 0;
 348
 349                 /* Industry structure access*/
 350                 case 0x80: return this->industry->location.tile.base();
 351                 case 0x81: return GB(this->industry->location.tile.base(), 8, 8);
 352                 /* Pointer to the town the industry is associated with */
 353                 case 0x82: return this->industry->town->index;
 354                 case 0x83:
 355                 case 0x84:
 356                 case 0x85: Debug(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported
 357                 case 0x86: return this->industry->location.w;
 358                 case 0x87: return this->industry->location.h;// xy dimensions
 359
 360                 case 0x88:
 361                 case 0x89: return this->industry->GetProduced(variable - 0x88).cargo;
 362                 case 0x8A: return this->industry->GetProduced(0).waiting;
 363                 case 0x8B: return GB(this->industry->GetProduced(0).waiting, 8, 8);
 364                 case 0x8C: return this->industry->GetProduced(1).waiting;
 365                 case 0x8D: return GB(this->industry->GetProduced(1).waiting, 8, 8);
 366                 case 0x8E:
 367                 case 0x8F: return this->industry->GetProduced(variable - 0x8E).rate;
 368                 case 0x90:
 369                 case 0x91:
 370                 case 0x92: return this->industry->GetAccepted(variable - 0x90).cargo;
 371                 case 0x93: return this->industry->prod_level;
 372                 /* amount of cargo produced so far THIS month. */
 373                 case 0x94: return this->industry->GetProduced(0).history[THIS_MONTH].production;
 374                 case 0x95: return GB(this->industry->GetProduced(0).history[THIS_MONTH].production, 8, 8);
 375                 case 0x96: return this->industry->GetProduced(1).history[THIS_MONTH].production;
 376                 case 0x97: return GB(this->industry->GetProduced(1).history[THIS_MONTH].production, 8, 8);
 377                 /* amount of cargo transported so far THIS month. */
 378                 case 0x98: return this->industry->GetProduced(0).history[THIS_MONTH].transported;
 379                 case 0x99: return GB(this->industry->GetProduced(0).history[THIS_MONTH].transported, 8, 8);
 380                 case 0x9A: return this->industry->GetProduced(1).history[THIS_MONTH].transported;
 381                 case 0x9B: return GB(this->industry->GetProduced(1).history[THIS_MONTH].transported, 8, 8);
 382                 /* fraction of cargo transported LAST month. */
 383                 case 0x9C:
 384                 case 0x9D: return this->industry->GetProduced(variable - 0x9C).history[LAST_MONTH].PctTransported();
 385                 /* amount of cargo produced LAST month. */
 386                 case 0x9E: return this->industry->GetProduced(0).history[LAST_MONTH].production;
 387                 case 0x9F: return GB(this->industry->GetProduced(0).history[LAST_MONTH].production, 8, 8);
 388                 case 0xA0: return this->industry->GetProduced(1).history[LAST_MONTH].production;
 389                 case 0xA1: return GB(this->industry->GetProduced(1).history[LAST_MONTH].production, 8, 8);
 390                 /* amount of cargo transported last month. */
 391                 case 0xA2: return this->industry->GetProduced(0).history[LAST_MONTH].transported;
 392                 case 0xA3: return GB(this->industry->GetProduced(0).history[LAST_MONTH].transported, 8, 8);
 393                 case 0xA4: return this->industry->GetProduced(1).history[LAST_MONTH].transported;
 394                 case 0xA5: return GB(this->industry->GetProduced(1).history[LAST_MONTH].transported, 8, 8);
 395
 396                 case 0xA6: return indspec->grf_prop.local_id;
 397                 case 0xA7: return this->industry->founder;
 398                 case 0xA8: return this->industry->random_colour;
 399                 case 0xA9: return ClampTo<uint8_t>(this->industry->last_prod_year - EconomyTime::ORIGINAL_BASE_YEAR);
 400                 case 0xAA: return this->industry->counter;
 401                 case 0xAB: return GB(this->industry->counter, 8, 8);
 402                 case 0xAC: return this->industry->was_cargo_delivered;
 403
 404                 case 0xB0: return ClampTo<uint16_t>(this->industry->construction_date - CalendarTime::DAYS_TILL_ORIGINAL_BASE_YEAR); // Date when built since 1920 (in days)
 405                 case 0xB3: return this->industry->construction_type; // Construction type
 406                 case 0xB4: {
 407                         auto it = std::max_element(std::begin(this->industry->accepted), std::end(this->industry->accepted), [](const auto &a, const auto &b) { return a.last_accepted < b.last_accepted; });
 408                         return ClampTo<uint16_t>(it->last_accepted - EconomyTime::DAYS_TILL_ORIGINAL_BASE_YEAR); // Date last cargo accepted since 1920 (in days)
 409                 }
 410         }
 411
 412         Debug(grf, 1, "Unhandled industry variable 0x{:X}", variable);
 413
 414         available = false;
 415         return UINT_MAX;
 416 }
 417
 418 /* virtual */ uint32_t IndustriesScopeResolver::GetRandomBits() const
 419 {
 420         return this->industry != nullptr ? this->industry->random : 0;
 421 }
 422
 423 /* virtual */ uint32_t IndustriesScopeResolver::GetTriggers() const
 424 {
 425         return 0;
 426 }
 427
 428 /* virtual */ void IndustriesScopeResolver::StorePSA(uint pos, int32_t value)
 429 {
 430         if (this->industry->index == INVALID_INDUSTRY) return;
 431
 432         if (this->industry->psa == nullptr) {
 433                 /* There is no need to create a storage if the value is zero. */
 434                 if (value == 0) return;
 435
 436                 /* Create storage on first modification. */
 437                 const IndustrySpec *indsp = GetIndustrySpec(this->industry->type);
 438                 uint32_t grfid = (indsp->grf_prop.grffile != nullptr) ? indsp->grf_prop.grffile->grfid : 0;
 439                 assert(PersistentStorage::CanAllocateItem());
 440                 this->industry->psa = new PersistentStorage(grfid, GSF_INDUSTRIES, this->industry->location.tile);
 441         }
 442
 443         this->industry->psa->StoreValue(pos, value);
 444 }
 445
 446 /**
 447  * Get the grf file associated with the given industry type.
 448  * @param type Industry type to query.
 449  * @return The associated GRF file, if any.
 450  */
 451 static const GRFFile *GetGrffile(IndustryType type)
 452 {
 453         const IndustrySpec *indspec = GetIndustrySpec(type);
 454         return (indspec != nullptr) ? indspec->grf_prop.grffile : nullptr;
 455 }
 456
 457 /**
 458  * Constructor of the industries resolver.
 459  * @param tile %Tile owned by the industry.
 460  * @param indus %Industry being resolved.
 461  * @param type Type of the industry.
 462  * @param random_bits Random bits of the new industry.
 463  * @param callback Callback ID.
 464  * @param callback_param1 First parameter (var 10) of the callback.
 465  * @param callback_param2 Second parameter (var 18) of the callback.
 466  */
 467 IndustriesResolverObject::IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32_t random_bits,
 468                 CallbackID callback, uint32_t callback_param1, uint32_t callback_param2)
 469         : ResolverObject(GetGrffile(type), callback, callback_param1, callback_param2),
 470         industries_scope(*this, tile, indus, type, random_bits)
 471 {
 472         this->root_spritegroup = GetIndustrySpec(type)->grf_prop.spritegroup[0];
 473 }
 474
 475 /**
 476  * Get or create the town scope object associated with the industry.
 477  * @return The associated town scope, if it exists.
 478  */
 479 TownScopeResolver *IndustriesResolverObject::GetTown()
 480 {
 481         if (!this->town_scope.has_value()) {
 482                 Town *t = nullptr;
 483                 bool readonly = true;
 484                 if (this->industries_scope.industry != nullptr) {
 485                         t = this->industries_scope.industry->town;
 486                         readonly = this->industries_scope.industry->index == INVALID_INDUSTRY;
 487                 } else if (this->industries_scope.tile != INVALID_TILE) {
 488                         t = ClosestTownFromTile(this->industries_scope.tile, UINT_MAX);
 489                 }
 490                 if (t == nullptr) return nullptr;
 491                 this->town_scope.emplace(*this, t, readonly);
 492         }
 493         return &*this->town_scope;
 494 }
 495
 496 GrfSpecFeature IndustriesResolverObject::GetFeature() const
 497 {
 498         return GSF_INDUSTRIES;
 499 }
 500
 501 uint32_t IndustriesResolverObject::GetDebugID() const
 502 {
 503         return GetIndustrySpec(this->industries_scope.type)->grf_prop.local_id;
 504 }
 505
 506 /**
 507  * Perform an industry callback.
 508  * @param callback The callback to perform.
 509  * @param param1 The first parameter.
 510  * @param param2 The second parameter.
 511  * @param industry The industry to do the callback for.
 512  * @param type The type of industry to do the callback for.
 513  * @param tile The tile associated with the callback.
 514  * @return The callback result.
 515  */
 516 uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile)
 517 {
 518         IndustriesResolverObject object(tile, industry, type, 0, callback, param1, param2);
 519         return object.ResolveCallback();
 520 }
 521
 522 /**
 523  * Check that the industry callback allows creation of the industry.
 524  * @param tile %Tile to build the industry.
 525  * @param type Type of industry to build.
 526  * @param layout Layout number.
 527  * @param seed Seed for the random generator.
 528  * @param initial_random_bits The random bits the industry is going to have after construction.
 529  * @param founder Industry founder
 530  * @param creation_type The circumstances the industry is created under.
 531  * @return Succeeded or failed command.
 532  */
 533 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
 534 {
 535         const IndustrySpec *indspec = GetIndustrySpec(type);
 536
 537         Industry ind;
 538         ind.index = INVALID_INDUSTRY;
 539         ind.location.tile = tile;
 540         ind.location.w = 0; // important to mark the industry invalid
 541         ind.type = type;
 542         ind.selected_layout = (uint8_t)layout;
 543         ind.town = ClosestTownFromTile(tile, UINT_MAX);
 544         ind.random = initial_random_bits;
 545         ind.founder = founder;
 546         ind.psa = nullptr;
 547
 548         IndustriesResolverObject object(tile, &ind, type, seed, CBID_INDUSTRY_LOCATION, 0, creation_type);
 549         uint16_t result = object.ResolveCallback();
 550
 551         /* Unlike the "normal" cases, not having a valid result means we allow
 552          * the building of the industry, as that's how it's done in TTDP. */
 553         if (result == CALLBACK_FAILED) return CommandCost();
 554
 555         return GetErrorMessageFromLocationCallbackResult(result, indspec->grf_prop.grffile, STR_ERROR_SITE_UNSUITABLE);
 556 }
 557
 558 /**
 559  * Check with callback #CBID_INDUSTRY_PROBABILITY whether the industry can be built.
 560  * @param type Industry type to check.
 561  * @param creation_type Reason to construct a new industry.
 562  * @return If the industry has no callback or allows building, \c true is returned. Otherwise, \c false is returned.
 563  */
 564 uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob)
 565 {
 566         const IndustrySpec *indspec = GetIndustrySpec(type);
 567
 568         if (HasBit(indspec->callback_mask, CBM_IND_PROBABILITY)) {
 569                 uint16_t res = GetIndustryCallback(CBID_INDUSTRY_PROBABILITY, 0, creation_type, nullptr, type, INVALID_TILE);
 570                 if (res != CALLBACK_FAILED) {
 571                         if (indspec->grf_prop.grffile->grf_version < 8) {
 572                                 /* Disallow if result != 0 */
 573                                 if (res != 0) default_prob = 0;
 574                         } else {
 575                                 /* Use returned probability. 0x100 to use default */
 576                                 if (res < 0x100) {
 577                                         default_prob = res;
 578                                 } else if (res > 0x100) {
 579                                         ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_PROBABILITY, res);
 580                                 }
 581                         }
 582                 }
 583         }
 584         return default_prob;
 585 }
 586
 587 static int32_t DerefIndProd(int field, bool use_register)
 588 {
 589         return use_register ? (int32_t)GetRegister(field) : field;
 590 }
 591
 592 /**
 593  * Get the industry production callback and apply it to the industry.
 594  * @param ind    the industry this callback has to be called for
 595  * @param reason the reason it is called (0 = incoming cargo, 1 = periodic tick callback)
 596  */
 597 void IndustryProductionCallback(Industry *ind, int reason)
 598 {
 599         const IndustrySpec *spec = GetIndustrySpec(ind->type);
 600         IndustriesResolverObject object(ind->location.tile, ind, ind->type);
 601         if ((spec->behaviour & INDUSTRYBEH_PRODCALLBACK_RANDOM) != 0) object.callback_param1 = Random();
 602         int multiplier = 1;
 603         if ((spec->behaviour & INDUSTRYBEH_PROD_MULTI_HNDLING) != 0) multiplier = ind->prod_level;
 604         object.callback_param2 = reason;
 605
 606         for (uint loop = 0;; loop++) {
 607                 /* limit the number of calls to break infinite loops.
 608                  * 'loop' is provided as 16 bits to the newgrf, so abort when those are exceeded. */
 609                 if (loop >= 0x10000) {
 610                         /* display error message */
 611                         SetDParamStr(0, spec->grf_prop.grffile->filename);
 612                         SetDParam(1, spec->name);
 613                         ShowErrorMessage(STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_ENDLESS_PRODUCTION_CALLBACK, WL_WARNING);
 614
 615                         /* abort the function early, this error isn't critical and will allow the game to continue to run */
 616                         break;
 617                 }
 618
 619                 SB(object.callback_param2, 8, 16, loop);
 620                 const SpriteGroup *tgroup = object.Resolve();
 621                 if (tgroup == nullptr || tgroup->type != SGT_INDUSTRY_PRODUCTION) break;
 622                 const IndustryProductionSpriteGroup *group = (const IndustryProductionSpriteGroup *)tgroup;
 623
 624                 if (group->version == 0xFF) {
 625                         /* Result was marked invalid on load, display error message */
 626                         SetDParamStr(0, spec->grf_prop.grffile->filename);
 627                         SetDParam(1, spec->name);
 628                         SetDParam(2, ind->location.tile);
 629                         ShowErrorMessage(STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_INVALID_CARGO_PRODUCTION_CALLBACK, WL_WARNING);
 630
 631                         /* abort the function early, this error isn't critical and will allow the game to continue to run */
 632                         break;
 633                 }
 634
 635                 bool deref = (group->version >= 1);
 636
 637                 if (group->version < 2) {
 638                         /* Callback parameters map directly to industry cargo slot indices */
 639                         for (uint i = 0; i < group->num_input && i < ind->accepted.size(); i++) {
 640                                 if (!IsValidCargoID(ind->accepted[i].cargo)) continue;
 641                                 ind->accepted[i].waiting = ClampTo<uint16_t>(ind->accepted[i].waiting - DerefIndProd(group->subtract_input[i], deref) * multiplier);
 642                         }
 643                         for (uint i = 0; i < group->num_output && i < ind->produced.size(); i++) {
 644                                 if (!IsValidCargoID(ind->produced[i].cargo)) continue;
 645                                 ind->produced[i].waiting = ClampTo<uint16_t>(ind->produced[i].waiting + std::max(DerefIndProd(group->add_output[i], deref), 0) * multiplier);
 646                         }
 647                 } else {
 648                         /* Callback receives list of cargos to apply for, which need to have their cargo slots in industry looked up */
 649                         for (uint i = 0; i < group->num_input; i++) {
 650                                 auto it = ind->GetCargoAccepted(group->cargo_input[i]);
 651                                 if (it == std::end(ind->accepted)) continue;
 652                                 it->waiting = ClampTo<uint16_t>(it->waiting - DerefIndProd(group->subtract_input[i], deref) * multiplier);
 653                         }
 654                         for (uint i = 0; i < group->num_output; i++) {
 655                                 auto it = ind->GetCargoProduced(group->cargo_output[i]);
 656                                 if (it == std::end(ind->produced)) continue;
 657                                 it->waiting = ClampTo<uint16_t>(it->waiting + std::max(DerefIndProd(group->add_output[i], deref), 0) * multiplier);
 658                         }
 659                 }
 660
 661                 int32_t again = DerefIndProd(group->again, deref);
 662                 if (again == 0) break;
 663
 664                 SB(object.callback_param2, 24, 8, again);
 665         }
 666
 667         SetWindowDirty(WC_INDUSTRY_VIEW, ind->index);
 668 }
 669
 670 /**
 671  * Check whether an industry temporarily refuses to accept a certain cargo.
 672  * @param ind The industry to query.
 673  * @param cargo_type The cargo to get information about.
 674  * @pre cargo_type is in ind->accepts_cargo.
 675  * @return Whether the given industry refuses to accept this cargo type.
 676  */
 677 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type)
 678 {
 679         assert(ind->IsCargoAccepted(cargo_type));
 680
 681         const IndustrySpec *indspec = GetIndustrySpec(ind->type);
 682         if (HasBit(indspec->callback_mask, CBM_IND_REFUSE_CARGO)) {
 683                 uint16_t res = GetIndustryCallback(CBID_INDUSTRY_REFUSE_CARGO,
 684                                 0, indspec->grf_prop.grffile->cargo_map[cargo_type],
 685                                 ind, ind->type, ind->location.tile);
 686                 if (res != CALLBACK_FAILED) return !ConvertBooleanCallback(indspec->grf_prop.grffile, CBID_INDUSTRY_REFUSE_CARGO, res);
 687         }
 688         return false;
 689 }