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