OpenTTD
newgrf_industries.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_industries.cpp 27279 2015-05-09 10:21:55Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "industry.h"
15 #include "newgrf_industries.h"
16 #include "newgrf_town.h"
17 #include "newgrf_cargo.h"
18 #include "window_func.h"
19 #include "town.h"
20 #include "company_base.h"
21 #include "error.h"
22 #include "strings_func.h"
23 #include "core/random_func.hpp"
24 
25 #include "table/strings.h"
26 
27 #include "safeguards.h"
28 
29 /* Since the industry IDs defined by the GRF file don't necessarily correlate
30  * to those used by the game, the IDs used for overriding old industries must be
31  * translated when the idustry spec is set. */
34 
41 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)
42 {
43  if (grf_type == IT_INVALID) return IT_INVALID;
44  if (!HasBit(grf_type, 7)) return GB(grf_type, 0, 7);
45 
46  return _industry_mngr.GetID(GB(grf_type, 0, 7), grf_id);
47 }
48 
57 uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i, uint32 cur_grfid)
58 {
59  if (!i->TileBelongsToIndustry(tile)) {
60  /* No industry and/or the tile does not have the same industry as the one we match it with */
61  return 0xFFFF;
62  }
63 
64  IndustryGfx gfx = GetCleanIndustryGfx(tile);
65  const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);
66 
67  if (gfx < NEW_INDUSTRYTILEOFFSET) { // Does it belongs to an old type?
68  /* It is an old tile. We have to see if it's been overridden */
69  if (indtsp->grf_prop.override == INVALID_INDUSTRYTILE) { // has it been overridden?
70  return 0xFF << 8 | gfx; // no. Tag FF + the gfx id of that tile
71  }
72  /* Overridden */
73  const IndustryTileSpec *tile_ovr = GetIndustryTileSpec(indtsp->grf_prop.override);
74 
75  if (tile_ovr->grf_prop.grffile->grfid == cur_grfid) {
76  return tile_ovr->grf_prop.local_id; // same grf file
77  } else {
78  return 0xFFFE; // not the same grf file
79  }
80  }
81  /* Not an 'old type' tile */
82  if (indtsp->grf_prop.spritegroup[0] != NULL) { // tile has a spritegroup ?
83  if (indtsp->grf_prop.grffile->grfid == cur_grfid) { // same industry, same grf ?
84  return indtsp->grf_prop.local_id;
85  } else {
86  return 0xFFFE; // Defined in another grf file
87  }
88  }
89  /* The tile has no spritegroup */
90  return 0xFF << 8 | indtsp->grf_prop.subst_id; // so just give him the substitute
91 }
92 
93 static uint32 GetClosestIndustry(TileIndex tile, IndustryType type, const Industry *current)
94 {
95  uint32 best_dist = UINT32_MAX;
96  const Industry *i;
97  FOR_ALL_INDUSTRIES(i) {
98  if (i->type != type || i == current) continue;
99 
100  best_dist = min(best_dist, DistanceManhattan(tile, i->location.tile));
101  }
102 
103  return best_dist;
104 }
105 
116 static uint32 GetCountAndDistanceOfClosestInstance(byte param_setID, byte layout_filter, bool town_filter, const Industry *current)
117 {
118  uint32 GrfID = GetRegister(0x100);
119  IndustryType ind_index;
120  uint32 closest_dist = UINT32_MAX;
121  byte count = 0;
122 
123  /* Determine what will be the industry type to look for */
124  switch (GrfID) {
125  case 0: // this is a default industry type
126  ind_index = param_setID;
127  break;
128 
129  case 0xFFFFFFFF: // current grf
130  GrfID = GetIndustrySpec(current->type)->grf_prop.grffile->grfid;
131  /* FALL THROUGH */
132 
133  default: // use the grfid specified in register 100h
134  SetBit(param_setID, 7); // bit 7 means it is not an old type
135  ind_index = MapNewGRFIndustryType(param_setID, GrfID);
136  break;
137  }
138 
139  /* If the industry type is invalid, there is none and the closest is far away. */
140  if (ind_index >= NUM_INDUSTRYTYPES) return 0 | 0xFFFF;
141 
142  if (layout_filter == 0 && !town_filter) {
143  /* If the filter is 0, it could be because none was specified as well as being really a 0.
144  * In either case, just do the regular var67 */
145  closest_dist = GetClosestIndustry(current->location.tile, ind_index, current);
146  count = min(Industry::GetIndustryTypeCount(ind_index), UINT8_MAX); // clamp to 8 bit
147  } else {
148  /* Count only those who match the same industry type and layout filter
149  * Unfortunately, we have to do it manually */
150  const Industry *i;
151  FOR_ALL_INDUSTRIES(i) {
152  if (i->type == ind_index && i != current && (i->selected_layout == layout_filter || layout_filter == 0) && (!town_filter || i->town == current->town)) {
153  closest_dist = min(closest_dist, DistanceManhattan(current->location.tile, i->location.tile));
154  count++;
155  }
156  }
157  }
158 
159  return count << 16 | GB(closest_dist, 0, 16);
160 }
161 
162 /* virtual */ uint32 IndustriesScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
163 {
164  if (this->ro.callback == CBID_INDUSTRY_LOCATION) {
165  /* Variables available during construction check. */
166 
167  switch (variable) {
168  case 0x80: return this->tile;
169  case 0x81: return GB(this->tile, 8, 8);
170 
171  /* Pointer to the town the industry is associated with */
172  case 0x82: return this->industry->town->index;
173  case 0x83:
174  case 0x84:
175  case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported
176 
177  /* Number of the layout */
178  case 0x86: return this->industry->selected_layout;
179 
180  /* Ground type */
181  case 0x87: return GetTerrainType(this->tile);
182 
183  /* Town zone */
184  case 0x88: return GetTownRadiusGroup(this->industry->town, this->tile);
185 
186  /* Manhattan distance of the closest town */
187  case 0x89: return min(DistanceManhattan(this->industry->town->xy, this->tile), 255);
188 
189  /* Lowest height of the tile */
190  case 0x8A: return Clamp(GetTileZ(this->tile) * (this->ro.grffile->grf_version >= 8 ? 1 : TILE_HEIGHT), 0, 0xFF);
191 
192  /* Distance to the nearest water/land tile */
193  case 0x8B: return GetClosestWaterDistance(this->tile, (GetIndustrySpec(this->industry->type)->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);
194 
195  /* Square of Euclidian distance from town */
196  case 0x8D: return min(DistanceSquare(this->industry->town->xy, this->tile), 65535);
197 
198  /* 32 random bits */
199  case 0x8F: return this->random_bits;
200  }
201  }
202 
203  const IndustrySpec *indspec = GetIndustrySpec(this->type);
204 
205  if (this->industry == NULL) {
206  DEBUG(grf, 1, "Unhandled variable 0x%X (no available industry) in callback 0x%x", variable, this->ro.callback);
207 
208  *available = false;
209  return UINT_MAX;
210  }
211 
212  switch (variable) {
213  case 0x40:
214  case 0x41:
215  case 0x42: { // waiting cargo, but only if those two callback flags are set
216  uint16 callback = indspec->callback_mask;
218  if ((indspec->behaviour & INDUSTRYBEH_PROD_MULTI_HNDLING) != 0) {
219  if (this->industry->prod_level == 0) return 0;
220  return min(this->industry->incoming_cargo_waiting[variable - 0x40] / this->industry->prod_level, (uint16)0xFFFF);
221  } else {
222  return min(this->industry->incoming_cargo_waiting[variable - 0x40], (uint16)0xFFFF);
223  }
224  } else {
225  return 0;
226  }
227  }
228 
229  /* Manhattan distance of closes dry/water tile */
230  case 0x43:
231  if (this->tile == INVALID_TILE) break;
232  return GetClosestWaterDistance(this->tile, (indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);
233 
234  /* Layout number */
235  case 0x44: return this->industry->selected_layout;
236 
237  /* Company info */
238  case 0x45: {
239  byte colours = 0;
240  bool is_ai = false;
241 
242  const Company *c = Company::GetIfValid(this->industry->founder);
243  if (c != NULL) {
244  const Livery *l = &c->livery[LS_DEFAULT];
245 
246  is_ai = c->is_ai;
247  colours = l->colour1 + l->colour2 * 16;
248  }
249 
250  return this->industry->founder | (is_ai ? 0x10000 : 0) | (colours << 24);
251  }
252 
253  case 0x46: return this->industry->construction_date; // Date when built - long format - (in days)
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  return GetTownRadiusGroup(this->industry->town, this->tile) << 16 | min(DistanceManhattan(this->tile, this->industry->town->xy), 0xFFFF);
288  /* Get square of Euclidian distance of closes town */
289  case 0x66:
290  if (this->tile == INVALID_TILE) break;
291  return GetTownRadiusGroup(this->industry->town, this->tile) << 16 | min(DistanceSquare(this->tile, this->industry->town->xy), 0xFFFF);
292 
293  /* Count of industry, distance of closest instance
294  * 68 is the same as 67, but with a filtering on selected layout */
295  case 0x67:
296  case 0x68: {
297  byte layout_filter = 0;
298  bool town_filter = false;
299  if (variable == 0x68) {
300  uint32 reg = GetRegister(0x101);
301  layout_filter = GB(reg, 0, 8);
302  town_filter = HasBit(reg, 8);
303  }
304  return GetCountAndDistanceOfClosestInstance(parameter, layout_filter, town_filter, this->industry);
305  }
306 
307  /* Get a variable from the persistent storage */
308  case 0x7C: return (this->industry->psa != NULL) ? this->industry->psa->GetValue(parameter) : 0;
309 
310  /* Industry structure access*/
311  case 0x80: return this->industry->location.tile;
312  case 0x81: return GB(this->industry->location.tile, 8, 8);
313  /* Pointer to the town the industry is associated with */
314  case 0x82: return this->industry->town->index;
315  case 0x83:
316  case 0x84:
317  case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported
318  case 0x86: return this->industry->location.w;
319  case 0x87: return this->industry->location.h;// xy dimensions
320 
321  case 0x88:
322  case 0x89: return this->industry->produced_cargo[variable - 0x88];
323  case 0x8A: return this->industry->produced_cargo_waiting[0];
324  case 0x8B: return GB(this->industry->produced_cargo_waiting[0], 8, 8);
325  case 0x8C: return this->industry->produced_cargo_waiting[1];
326  case 0x8D: return GB(this->industry->produced_cargo_waiting[1], 8, 8);
327  case 0x8E:
328  case 0x8F: return this->industry->production_rate[variable - 0x8E];
329  case 0x90:
330  case 0x91:
331  case 0x92: return this->industry->accepts_cargo[variable - 0x90];
332  case 0x93: return this->industry->prod_level;
333  /* amount of cargo produced so far THIS month. */
334  case 0x94: return this->industry->this_month_production[0];
335  case 0x95: return GB(this->industry->this_month_production[0], 8, 8);
336  case 0x96: return this->industry->this_month_production[1];
337  case 0x97: return GB(this->industry->this_month_production[1], 8, 8);
338  /* amount of cargo transported so far THIS month. */
339  case 0x98: return this->industry->this_month_transported[0];
340  case 0x99: return GB(this->industry->this_month_transported[0], 8, 8);
341  case 0x9A: return this->industry->this_month_transported[1];
342  case 0x9B: return GB(this->industry->this_month_transported[1], 8, 8);
343  /* fraction of cargo transported LAST month. */
344  case 0x9C:
345  case 0x9D: return this->industry->last_month_pct_transported[variable - 0x9C];
346  /* amount of cargo produced LAST month. */
347  case 0x9E: return this->industry->last_month_production[0];
348  case 0x9F: return GB(this->industry->last_month_production[0], 8, 8);
349  case 0xA0: return this->industry->last_month_production[1];
350  case 0xA1: return GB(this->industry->last_month_production[1], 8, 8);
351  /* amount of cargo transported last month. */
352  case 0xA2: return this->industry->last_month_transported[0];
353  case 0xA3: return GB(this->industry->last_month_transported[0], 8, 8);
354  case 0xA4: return this->industry->last_month_transported[1];
355  case 0xA5: return GB(this->industry->last_month_transported[1], 8, 8);
356 
357  case 0xA6: return indspec->grf_prop.local_id;
358  case 0xA7: return this->industry->founder;
359  case 0xA8: return this->industry->random_colour;
360  case 0xA9: return Clamp(this->industry->last_prod_year - ORIGINAL_BASE_YEAR, 0, 255);
361  case 0xAA: return this->industry->counter;
362  case 0xAB: return GB(this->industry->counter, 8, 8);
363  case 0xAC: return this->industry->was_cargo_delivered;
364 
365  case 0xB0: return Clamp(this->industry->construction_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Date when built since 1920 (in days)
366  case 0xB3: return this->industry->construction_type; // Construction type
367  case 0xB4: return Clamp(this->industry->last_cargo_accepted_at - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Date last cargo accepted since 1920 (in days)
368  }
369 
370  DEBUG(grf, 1, "Unhandled industry variable 0x%X", variable);
371 
372  *available = false;
373  return UINT_MAX;
374 }
375 
376 /* virtual */ uint32 IndustriesScopeResolver::GetRandomBits() const
377 {
378  return this->industry != NULL ? this->industry->random : 0;
379 }
380 
381 /* virtual */ uint32 IndustriesScopeResolver::GetTriggers() const
382 {
383  return this->industry != NULL ? this->industry->random_triggers : 0;
384 }
385 
386 /* virtual */ void IndustriesScopeResolver::SetTriggers(int triggers) const
387 {
388  assert(this->industry != NULL && this->industry->index != INVALID_INDUSTRY);
389  this->industry->random_triggers = triggers;
390 }
391 
392 /* virtual */ void IndustriesScopeResolver::StorePSA(uint pos, int32 value)
393 {
394  if (this->industry->index == INVALID_INDUSTRY) return;
395 
396  if (this->industry->psa == NULL) {
397  /* There is no need to create a storage if the value is zero. */
398  if (value == 0) return;
399 
400  /* Create storage on first modification. */
401  const IndustrySpec *indsp = GetIndustrySpec(this->industry->type);
402  uint32 grfid = (indsp->grf_prop.grffile != NULL) ? indsp->grf_prop.grffile->grfid : 0;
404  this->industry->psa = new PersistentStorage(grfid, GSF_INDUSTRIES, this->industry->location.tile);
405  }
406 
407  this->industry->psa->StoreValue(pos, value);
408 }
409 
415 static const GRFFile *GetGrffile(IndustryType type)
416 {
417  const IndustrySpec *indspec = GetIndustrySpec(type);
418  return (indspec != NULL) ? indspec->grf_prop.grffile : NULL;
419 }
420 
431 IndustriesResolverObject::IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits,
432  CallbackID callback, uint32 callback_param1, uint32 callback_param2)
433  : ResolverObject(GetGrffile(type), callback, callback_param1, callback_param2),
434  industries_scope(*this, tile, indus, type, random_bits),
435  town_scope(NULL)
436 {
438 }
439 
440 IndustriesResolverObject::~IndustriesResolverObject()
441 {
442  delete this->town_scope;
443 }
444 
450 {
451  if (this->town_scope == NULL) {
452  Town *t = NULL;
453  bool readonly = true;
454  if (this->industries_scope.industry != NULL) {
455  t = this->industries_scope.industry->town;
456  readonly = this->industries_scope.industry->index == INVALID_INDUSTRY;
457  } else if (this->industries_scope.tile != INVALID_TILE) {
458  t = ClosestTownFromTile(this->industries_scope.tile, UINT_MAX);
459  }
460  if (t == NULL) return NULL;
461  this->town_scope = new TownScopeResolver(*this, t, readonly);
462  }
463  return this->town_scope;
464 }
465 
474 IndustriesScopeResolver::IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits)
475  : ScopeResolver(ro)
476 {
477  this->tile = tile;
478  this->industry = industry;
479  this->type = type;
480  this->random_bits = random_bits;
481 }
482 
493 uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile)
494 {
495  IndustriesResolverObject object(tile, industry, type, 0, callback, param1, param2);
496  return object.ResolveCallback();
497 }
498 
510 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
511 {
512  const IndustrySpec *indspec = GetIndustrySpec(type);
513 
514  Industry ind;
515  ind.index = INVALID_INDUSTRY;
516  ind.location.tile = tile;
517  ind.location.w = 0; // important to mark the industry invalid
518  ind.type = type;
519  ind.selected_layout = layout;
520  ind.town = ClosestTownFromTile(tile, UINT_MAX);
521  ind.random = initial_random_bits;
522  ind.founder = founder;
523  ind.psa = NULL;
524 
525  IndustriesResolverObject object(tile, &ind, type, seed, CBID_INDUSTRY_LOCATION, 0, creation_type);
526  uint16 result = object.ResolveCallback();
527 
528  /* Unlike the "normal" cases, not having a valid result means we allow
529  * the building of the industry, as that's how it's done in TTDP. */
530  if (result == CALLBACK_FAILED) return CommandCost();
531 
532  return GetErrorMessageFromLocationCallbackResult(result, indspec->grf_prop.grffile, STR_ERROR_SITE_UNSUITABLE);
533 }
534 
541 uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob)
542 {
543  const IndustrySpec *indspec = GetIndustrySpec(type);
544 
545  if (HasBit(indspec->callback_mask, CBM_IND_PROBABILITY)) {
546  uint16 res = GetIndustryCallback(CBID_INDUSTRY_PROBABILITY, 0, creation_type, NULL, type, INVALID_TILE);
547  if (res != CALLBACK_FAILED) {
548  if (indspec->grf_prop.grffile->grf_version < 8) {
549  /* Disallow if result != 0 */
550  if (res != 0) default_prob = 0;
551  } else {
552  /* Use returned probability. 0x100 to use default */
553  if (res < 0x100) {
554  default_prob = res;
555  } else if (res > 0x100) {
557  }
558  }
559  }
560  }
561  return default_prob;
562 }
563 
564 static int32 DerefIndProd(int field, bool use_register)
565 {
566  return use_register ? (int32)GetRegister(field) : field;
567 }
568 
574 void IndustryProductionCallback(Industry *ind, int reason)
575 {
576  const IndustrySpec *spec = GetIndustrySpec(ind->type);
577  IndustriesResolverObject object(ind->location.tile, ind, ind->type);
578  if ((spec->behaviour & INDUSTRYBEH_PRODCALLBACK_RANDOM) != 0) object.callback_param1 = Random();
579  int multiplier = 1;
580  if ((spec->behaviour & INDUSTRYBEH_PROD_MULTI_HNDLING) != 0) multiplier = ind->prod_level;
581  object.callback_param2 = reason;
582 
583  for (uint loop = 0;; loop++) {
584  /* limit the number of calls to break infinite loops.
585  * 'loop' is provided as 16 bits to the newgrf, so abort when those are exceeded. */
586  if (loop >= 0x10000) {
587  /* display error message */
588  SetDParamStr(0, spec->grf_prop.grffile->filename);
589  SetDParam(1, spec->name);
590  ShowErrorMessage(STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_ENDLESS_PRODUCTION_CALLBACK, WL_WARNING);
591 
592  /* abort the function early, this error isn't critical and will allow the game to continue to run */
593  break;
594  }
595 
596  SB(object.callback_param2, 8, 16, loop);
597  const SpriteGroup *tgroup = object.Resolve();
598  if (tgroup == NULL || tgroup->type != SGT_INDUSTRY_PRODUCTION) break;
599  const IndustryProductionSpriteGroup *group = (const IndustryProductionSpriteGroup *)tgroup;
600 
601  bool deref = (group->version == 1);
602 
603  for (uint i = 0; i < 3; i++) {
604  ind->incoming_cargo_waiting[i] = Clamp(ind->incoming_cargo_waiting[i] - DerefIndProd(group->subtract_input[i], deref) * multiplier, 0, 0xFFFF);
605  }
606  for (uint i = 0; i < 2; i++) {
607  ind->produced_cargo_waiting[i] = Clamp(ind->produced_cargo_waiting[i] + max(DerefIndProd(group->add_output[i], deref), 0) * multiplier, 0, 0xFFFF);
608  }
609 
610  int32 again = DerefIndProd(group->again, deref);
611  if (again == 0) break;
612 
613  SB(object.callback_param2, 24, 8, again);
614  }
615 
617 }
618 
627 {
628  assert(cargo_type == ind->accepts_cargo[0] || cargo_type == ind->accepts_cargo[1] || cargo_type == ind->accepts_cargo[2]);
629 
630  const IndustrySpec *indspec = GetIndustrySpec(ind->type);
631  if (HasBit(indspec->callback_mask, CBM_IND_REFUSE_CARGO)) {
633  0, indspec->grf_prop.grffile->cargo_map[cargo_type],
634  ind, ind->type, ind->location.tile);
636  }
637  return false;
638 }