OpenTTD Source  13.0-RC1
newgrf.cpp
Go to the documentation of this file.
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 
10 #include "stdafx.h"
11 
12 #include <stdarg.h>
13 
14 #include "debug.h"
15 #include "fileio_func.h"
16 #include "engine_func.h"
17 #include "engine_base.h"
18 #include "bridge.h"
19 #include "town.h"
20 #include "newgrf_engine.h"
21 #include "newgrf_text.h"
22 #include "fontcache.h"
23 #include "currency.h"
24 #include "landscape.h"
25 #include "newgrf_cargo.h"
26 #include "newgrf_house.h"
27 #include "newgrf_sound.h"
28 #include "newgrf_station.h"
29 #include "industrytype.h"
30 #include "industry_map.h"
31 #include "newgrf_canal.h"
32 #include "newgrf_townname.h"
33 #include "newgrf_industries.h"
34 #include "newgrf_airporttiles.h"
35 #include "newgrf_airport.h"
36 #include "newgrf_object.h"
37 #include "rev.h"
38 #include "fios.h"
39 #include "strings_func.h"
40 #include "date_func.h"
41 #include "string_func.h"
42 #include "network/core/config.h"
43 #include <map>
44 #include "smallmap_gui.h"
45 #include "genworld.h"
46 #include "error.h"
47 #include "vehicle_func.h"
48 #include "language.h"
49 #include "vehicle_base.h"
50 #include "road.h"
51 
52 #include "table/strings.h"
53 #include "table/build_industry.h"
54 
55 #include "safeguards.h"
56 
57 /* TTDPatch extended GRF format codec
58  * (c) Petr Baudis 2004 (GPL'd)
59  * Changes by Florian octo Forster are (c) by the OpenTTD development team.
60  *
61  * Contains portions of documentation by TTDPatch team.
62  * Thanks especially to Josef Drexler for the documentation as well as a lot
63  * of help at #tycoon. Also thanks to Michael Blunck for his GRF files which
64  * served as subject to the initial testing of this codec. */
65 
67 static std::vector<GRFFile *> _grf_files;
68 
69 const std::vector<GRFFile *> &GetAllGRFFiles()
70 {
71  return _grf_files;
72 }
73 
76 
78 static uint32 _ttdpatch_flags[8];
79 
82 
83 static const uint MAX_SPRITEGROUP = UINT8_MAX;
84 
87 private:
89  struct SpriteSet {
91  uint num_sprites;
92  };
93 
95  std::map<uint, SpriteSet> spritesets[GSF_END];
96 
97 public:
98  /* Global state */
99  GrfLoadingStage stage;
101 
102  /* Local state in the file */
106  uint32 nfo_line;
107 
108  /* Kind of return values when processing certain actions */
110 
111  /* Currently referenceable spritegroups */
112  const SpriteGroup *spritegroups[MAX_SPRITEGROUP + 1];
113 
116  {
117  this->nfo_line = 0;
118  this->skip_sprites = 0;
119 
120  for (uint i = 0; i < GSF_END; i++) {
121  this->spritesets[i].clear();
122  }
123 
124  memset(this->spritegroups, 0, sizeof(this->spritegroups));
125  }
126 
135  void AddSpriteSets(byte feature, SpriteID first_sprite, uint first_set, uint numsets, uint numents)
136  {
137  assert(feature < GSF_END);
138  for (uint i = 0; i < numsets; i++) {
139  SpriteSet &set = this->spritesets[feature][first_set + i];
140  set.sprite = first_sprite + i * numents;
141  set.num_sprites = numents;
142  }
143  }
144 
151  bool HasValidSpriteSets(byte feature) const
152  {
153  assert(feature < GSF_END);
154  return !this->spritesets[feature].empty();
155  }
156 
164  bool IsValidSpriteSet(byte feature, uint set) const
165  {
166  assert(feature < GSF_END);
167  return this->spritesets[feature].find(set) != this->spritesets[feature].end();
168  }
169 
176  SpriteID GetSprite(byte feature, uint set) const
177  {
178  assert(IsValidSpriteSet(feature, set));
179  return this->spritesets[feature].find(set)->second.sprite;
180  }
181 
188  uint GetNumEnts(byte feature, uint set) const
189  {
190  assert(IsValidSpriteSet(feature, set));
191  return this->spritesets[feature].find(set)->second.num_sprites;
192  }
193 };
194 
195 static GrfProcessingState _cur;
196 
197 
204 template <VehicleType T>
205 static inline bool IsValidNewGRFImageIndex(uint8 image_index)
206 {
207  return image_index == 0xFD || IsValidImageIndex<T>(image_index);
208 }
209 
211 
213 class ByteReader {
214 protected:
215  byte *data;
216  byte *end;
217 
218 public:
219  ByteReader(byte *data, byte *end) : data(data), end(end) { }
220 
221  inline byte *ReadBytes(size_t size)
222  {
223  if (data + size >= end) {
224  /* Put data at the end, as would happen if every byte had been individually read. */
225  data = end;
226  throw OTTDByteReaderSignal();
227  }
228 
229  byte *ret = data;
230  data += size;
231  return ret;
232  }
233 
234  inline byte ReadByte()
235  {
236  if (data < end) return *(data)++;
237  throw OTTDByteReaderSignal();
238  }
239 
240  uint16 ReadWord()
241  {
242  uint16 val = ReadByte();
243  return val | (ReadByte() << 8);
244  }
245 
246  uint16 ReadExtendedByte()
247  {
248  uint16 val = ReadByte();
249  return val == 0xFF ? ReadWord() : val;
250  }
251 
252  uint32 ReadDWord()
253  {
254  uint32 val = ReadWord();
255  return val | (ReadWord() << 16);
256  }
257 
258  uint32 ReadVarSize(byte size)
259  {
260  switch (size) {
261  case 1: return ReadByte();
262  case 2: return ReadWord();
263  case 4: return ReadDWord();
264  default:
265  NOT_REACHED();
266  return 0;
267  }
268  }
269 
270  const char *ReadString()
271  {
272  char *string = reinterpret_cast<char *>(data);
273  size_t string_length = ttd_strnlen(string, Remaining());
274 
275  if (string_length == Remaining()) {
276  /* String was not NUL terminated, so make sure it is now. */
277  string[string_length - 1] = '\0';
278  grfmsg(7, "String was not terminated with a zero byte.");
279  } else {
280  /* Increase the string length to include the NUL byte. */
281  string_length++;
282  }
283  Skip(string_length);
284 
285  return string;
286  }
287 
288  inline size_t Remaining() const
289  {
290  return end - data;
291  }
292 
293  inline bool HasData(size_t count = 1) const
294  {
295  return data + count <= end;
296  }
297 
298  inline byte *Data()
299  {
300  return data;
301  }
302 
303  inline void Skip(size_t len)
304  {
305  data += len;
306  /* It is valid to move the buffer to exactly the end of the data,
307  * as there may not be any more data read. */
308  if (data > end) throw OTTDByteReaderSignal();
309  }
310 };
311 
312 typedef void (*SpecialSpriteHandler)(ByteReader *buf);
313 
314 static const uint NUM_STATIONS_PER_GRF = 255;
315 
320  UNSET = 0,
323  };
324 
325  uint16 cargo_allowed;
326  uint16 cargo_disallowed;
327  RailTypeLabel railtypelabel;
328  uint8 roadtramtype;
331  uint8 rv_max_speed;
332  CargoTypes ctt_include_mask;
333  CargoTypes ctt_exclude_mask;
334 
339  void UpdateRefittability(bool non_empty)
340  {
341  if (non_empty) {
342  this->refittability = NONEMPTY;
343  } else if (this->refittability == UNSET) {
344  this->refittability = EMPTY;
345  }
346  }
347 };
348 
350 
355 static uint32 _grm_engines[256];
356 
358 static uint32 _grm_cargoes[NUM_CARGO * 2];
359 
360 struct GRFLocation {
361  uint32 grfid;
362  uint32 nfoline;
363 
364  GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { }
365 
366  bool operator<(const GRFLocation &other) const
367  {
368  return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline);
369  }
370 
371  bool operator == (const GRFLocation &other) const
372  {
373  return this->grfid == other.grfid && this->nfoline == other.nfoline;
374  }
375 };
376 
377 static std::map<GRFLocation, SpriteID> _grm_sprites;
378 typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride;
379 static GRFLineToSpriteOverride _grf_line_to_action6_sprite_override;
380 
391 void CDECL grfmsg(int severity, const char *str, ...)
392 {
393  char buf[1024];
394  va_list va;
395 
396  va_start(va, str);
397  vseprintf(buf, lastof(buf), str, va);
398  va_end(va);
399 
400  Debug(grf, severity, "[{}:{}] {}", _cur.grfconfig->filename, _cur.nfo_line, buf);
401 }
402 
408 static GRFFile *GetFileByGRFID(uint32 grfid)
409 {
410  for (GRFFile * const file : _grf_files) {
411  if (file->grfid == grfid) return file;
412  }
413  return nullptr;
414 }
415 
421 static GRFFile *GetFileByFilename(const char *filename)
422 {
423  for (GRFFile * const file : _grf_files) {
424  if (strcmp(file->filename, filename) == 0) return file;
425  }
426  return nullptr;
427 }
428 
431 {
432  gf->labels.clear();
433 }
434 
441 static GRFError *DisableGrf(StringID message = STR_NULL, GRFConfig *config = nullptr)
442 {
443  GRFFile *file;
444  if (config != nullptr) {
445  file = GetFileByGRFID(config->ident.grfid);
446  } else {
447  config = _cur.grfconfig;
448  file = _cur.grffile;
449  }
450 
451  config->status = GCS_DISABLED;
452  if (file != nullptr) ClearTemporaryNewGRFData(file);
453  if (config == _cur.grfconfig) _cur.skip_sprites = -1;
454 
455  if (message != STR_NULL) {
456  delete config->error;
457  config->error = new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, message);
458  if (config == _cur.grfconfig) config->error->param_value[0] = _cur.nfo_line;
459  }
460 
461  return config->error;
462 }
463 
468  uint32 grfid;
471 };
472 typedef std::vector<StringIDMapping> StringIDMappingVector;
473 static StringIDMappingVector _string_to_grf_mapping;
474 
480 static void AddStringForMapping(StringID source, StringID *target)
481 {
482  *target = STR_UNDEFINED;
483  _string_to_grf_mapping.push_back({_cur.grffile->grfid, source, target});
484 }
485 
494 {
495  /* StringID table for TextIDs 0x4E->0x6D */
496  static const StringID units_volume[] = {
497  STR_ITEMS, STR_PASSENGERS, STR_TONS, STR_BAGS,
498  STR_LITERS, STR_ITEMS, STR_CRATES, STR_TONS,
499  STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
500  STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
501  STR_TONS, STR_TONS, STR_BAGS, STR_LITERS,
502  STR_TONS, STR_LITERS, STR_TONS, STR_ITEMS,
503  STR_BAGS, STR_LITERS, STR_TONS, STR_ITEMS,
504  STR_TONS, STR_ITEMS, STR_LITERS, STR_ITEMS
505  };
506 
507  /* A string straight from a NewGRF; this was already translated by MapGRFStringID(). */
508  assert(!IsInsideMM(str, 0xD000, 0xD7FF));
509 
510 #define TEXTID_TO_STRINGID(begin, end, stringid, stringend) \
511  static_assert(stringend - stringid == end - begin); \
512  if (str >= begin && str <= end) return str + (stringid - begin)
513 
514  /* We have some changes in our cargo strings, resulting in some missing. */
515  TEXTID_TO_STRINGID(0x000E, 0x002D, STR_CARGO_PLURAL_NOTHING, STR_CARGO_PLURAL_FIZZY_DRINKS);
516  TEXTID_TO_STRINGID(0x002E, 0x004D, STR_CARGO_SINGULAR_NOTHING, STR_CARGO_SINGULAR_FIZZY_DRINK);
517  if (str >= 0x004E && str <= 0x006D) return units_volume[str - 0x004E];
518  TEXTID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING, STR_QUANTITY_FIZZY_DRINKS);
519  TEXTID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING, STR_ABBREV_FIZZY_DRINKS);
520  TEXTID_TO_STRINGID(0x00D1, 0x00E0, STR_COLOUR_DARK_BLUE, STR_COLOUR_WHITE);
521 
522  /* Map building names according to our lang file changes. There are several
523  * ranges of house ids, all of which need to be remapped to allow newgrfs
524  * to use original house names. */
525  TEXTID_TO_STRINGID(0x200F, 0x201F, STR_TOWN_BUILDING_NAME_TALL_OFFICE_BLOCK_1, STR_TOWN_BUILDING_NAME_OLD_HOUSES_1);
526  TEXTID_TO_STRINGID(0x2036, 0x2041, STR_TOWN_BUILDING_NAME_COTTAGES_1, STR_TOWN_BUILDING_NAME_SHOPPING_MALL_1);
527  TEXTID_TO_STRINGID(0x2059, 0x205C, STR_TOWN_BUILDING_NAME_IGLOO_1, STR_TOWN_BUILDING_NAME_PIGGY_BANK_1);
528 
529  /* Same thing for industries */
530  TEXTID_TO_STRINGID(0x4802, 0x4826, STR_INDUSTRY_NAME_COAL_MINE, STR_INDUSTRY_NAME_SUGAR_MINE);
531  TEXTID_TO_STRINGID(0x482D, 0x482E, STR_NEWS_INDUSTRY_CONSTRUCTION, STR_NEWS_INDUSTRY_PLANTED);
532  TEXTID_TO_STRINGID(0x4832, 0x4834, STR_NEWS_INDUSTRY_CLOSURE_GENERAL, STR_NEWS_INDUSTRY_CLOSURE_LACK_OF_TREES);
533  TEXTID_TO_STRINGID(0x4835, 0x4838, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_FARM);
534  TEXTID_TO_STRINGID(0x4839, 0x483A, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_FARM);
535 
536  switch (str) {
537  case 0x4830: return STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY;
538  case 0x4831: return STR_ERROR_FOREST_CAN_ONLY_BE_PLANTED;
539  case 0x483B: return STR_ERROR_CAN_ONLY_BE_POSITIONED;
540  }
541 #undef TEXTID_TO_STRINGID
542 
543  if (str == STR_NULL) return STR_EMPTY;
544 
545  Debug(grf, 0, "Unknown StringID 0x{:04X} remapped to STR_EMPTY. Please open a Feature Request if you need it", str);
546 
547  return STR_EMPTY;
548 }
549 
557 StringID MapGRFStringID(uint32 grfid, StringID str)
558 {
559  if (IsInsideMM(str, 0xD800, 0xE000)) {
560  /* General text provided by NewGRF.
561  * In the specs this is called the 0xDCxx range (misc persistent texts),
562  * but we meanwhile extended the range to 0xD800-0xDFFF.
563  * Note: We are not involved in the "persistent" business, since we do not store
564  * any NewGRF strings in savegames. */
565  return GetGRFStringID(grfid, str);
566  } else if (IsInsideMM(str, 0xD000, 0xD800)) {
567  /* Callback text provided by NewGRF.
568  * In the specs this is called the 0xD0xx range (misc graphics texts).
569  * These texts can be returned by various callbacks.
570  *
571  * Due to how TTDP implements the GRF-local- to global-textid translation
572  * texts included via 0x80 or 0x81 control codes have to add 0x400 to the textid.
573  * We do not care about that difference and just mask out the 0x400 bit.
574  */
575  str &= ~0x400;
576  return GetGRFStringID(grfid, str);
577  } else {
578  /* The NewGRF wants to include/reference an original TTD string.
579  * Try our best to find an equivalent one. */
581  }
582 }
583 
584 static std::map<uint32, uint32> _grf_id_overrides;
585 
591 static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)
592 {
593  _grf_id_overrides[source_grfid] = target_grfid;
594  grfmsg(5, "SetNewGRFOverride: Added override of 0x%X to 0x%X", BSWAP32(source_grfid), BSWAP32(target_grfid));
595 }
596 
605 static Engine *GetNewEngine(const GRFFile *file, VehicleType type, uint16 internal_id, bool static_access = false)
606 {
607  /* Hack for add-on GRFs that need to modify another GRF's engines. This lets
608  * them use the same engine slots. */
609  uint32 scope_grfid = INVALID_GRFID; // If not using dynamic_engines, all newgrfs share their ID range
611  /* If dynamic_engies is enabled, there can be multiple independent ID ranges. */
612  scope_grfid = file->grfid;
613  uint32 override = _grf_id_overrides[file->grfid];
614  if (override != 0) {
615  scope_grfid = override;
616  const GRFFile *grf_match = GetFileByGRFID(override);
617  if (grf_match == nullptr) {
618  grfmsg(5, "Tried mapping from GRFID %x to %x but target is not loaded", BSWAP32(file->grfid), BSWAP32(override));
619  } else {
620  grfmsg(5, "Mapping from GRFID %x to %x", BSWAP32(file->grfid), BSWAP32(override));
621  }
622  }
623 
624  /* Check if the engine is registered in the override manager */
625  EngineID engine = _engine_mngr.GetID(type, internal_id, scope_grfid);
626  if (engine != INVALID_ENGINE) {
627  Engine *e = Engine::Get(engine);
628  if (e->grf_prop.grffile == nullptr) e->grf_prop.grffile = file;
629  return e;
630  }
631  }
632 
633  /* Check if there is an unreserved slot */
634  EngineID engine = _engine_mngr.GetID(type, internal_id, INVALID_GRFID);
635  if (engine != INVALID_ENGINE) {
636  Engine *e = Engine::Get(engine);
637 
638  if (e->grf_prop.grffile == nullptr) {
639  e->grf_prop.grffile = file;
640  grfmsg(5, "Replaced engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);
641  }
642 
643  /* Reserve the engine slot */
644  if (!static_access) {
645  EngineIDMapping *eid = _engine_mngr.data() + engine;
646  eid->grfid = scope_grfid; // Note: this is INVALID_GRFID if dynamic_engines is disabled, so no reservation
647  }
648 
649  return e;
650  }
651 
652  if (static_access) return nullptr;
653 
654  if (!Engine::CanAllocateItem()) {
655  grfmsg(0, "Can't allocate any more engines");
656  return nullptr;
657  }
658 
659  size_t engine_pool_size = Engine::GetPoolSize();
660 
661  /* ... it's not, so create a new one based off an existing engine */
662  Engine *e = new Engine(type, internal_id);
663  e->grf_prop.grffile = file;
664 
665  /* Reserve the engine slot */
666  assert(_engine_mngr.size() == e->index);
667  _engine_mngr.push_back({
668  scope_grfid, // Note: this is INVALID_GRFID if dynamic_engines is disabled, so no reservation
669  internal_id,
670  type,
671  std::min<uint8>(internal_id, _engine_counts[type]) // substitute_id == _engine_counts[subtype] means "no substitute"
672  });
673 
674  if (engine_pool_size != Engine::GetPoolSize()) {
675  /* Resize temporary engine data ... */
677 
678  /* and blank the new block. */
679  size_t len = (Engine::GetPoolSize() - engine_pool_size) * sizeof(*_gted);
680  memset(_gted + engine_pool_size, 0, len);
681  }
682  if (type == VEH_TRAIN) {
683  _gted[e->index].railtypelabel = GetRailTypeInfo(e->u.rail.railtype)->label;
684  }
685 
686  grfmsg(5, "Created new engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);
687 
688  return e;
689 }
690 
701 EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
702 {
703  uint32 scope_grfid = INVALID_GRFID; // If not using dynamic_engines, all newgrfs share their ID range
705  scope_grfid = file->grfid;
706  uint32 override = _grf_id_overrides[file->grfid];
707  if (override != 0) scope_grfid = override;
708  }
709 
710  return _engine_mngr.GetID(type, internal_id, scope_grfid);
711 }
712 
717 static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)
718 {
719  if (HasBit(grf_sprite->pal, 14)) {
720  ClrBit(grf_sprite->pal, 14);
721  SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);
722  }
723 
724  if (HasBit(grf_sprite->sprite, 14)) {
725  ClrBit(grf_sprite->sprite, 14);
727  }
728 
729  if (HasBit(grf_sprite->sprite, 15)) {
730  ClrBit(grf_sprite->sprite, 15);
731  SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOUR);
732  }
733 }
734 
748 static TileLayoutFlags ReadSpriteLayoutSprite(ByteReader *buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, int feature, PalSpriteID *grf_sprite, uint16 *max_sprite_offset = nullptr, uint16 *max_palette_offset = nullptr)
749 {
750  grf_sprite->sprite = buf->ReadWord();
751  grf_sprite->pal = buf->ReadWord();
752  TileLayoutFlags flags = read_flags ? (TileLayoutFlags)buf->ReadWord() : TLF_NOTHING;
753 
754  MapSpriteMappingRecolour(grf_sprite);
755 
756  bool custom_sprite = HasBit(grf_sprite->pal, 15) != invert_action1_flag;
757  ClrBit(grf_sprite->pal, 15);
758  if (custom_sprite) {
759  /* Use sprite from Action 1 */
760  uint index = GB(grf_sprite->sprite, 0, 14);
761  if (use_cur_spritesets && (!_cur.IsValidSpriteSet(feature, index) || _cur.GetNumEnts(feature, index) == 0)) {
762  grfmsg(1, "ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d", index);
763  grf_sprite->sprite = SPR_IMG_QUERY;
764  grf_sprite->pal = PAL_NONE;
765  } else {
766  SpriteID sprite = use_cur_spritesets ? _cur.GetSprite(feature, index) : index;
767  if (max_sprite_offset != nullptr) *max_sprite_offset = use_cur_spritesets ? _cur.GetNumEnts(feature, index) : UINT16_MAX;
768  SB(grf_sprite->sprite, 0, SPRITE_WIDTH, sprite);
770  }
771  } else if ((flags & TLF_SPRITE_VAR10) && !(flags & TLF_SPRITE_REG_FLAGS)) {
772  grfmsg(1, "ReadSpriteLayoutSprite: Spritelayout specifies var10 value for non-action-1 sprite");
773  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
774  return flags;
775  }
776 
777  if (flags & TLF_CUSTOM_PALETTE) {
778  /* Use palette from Action 1 */
779  uint index = GB(grf_sprite->pal, 0, 14);
780  if (use_cur_spritesets && (!_cur.IsValidSpriteSet(feature, index) || _cur.GetNumEnts(feature, index) == 0)) {
781  grfmsg(1, "ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d for 'palette'", index);
782  grf_sprite->pal = PAL_NONE;
783  } else {
784  SpriteID sprite = use_cur_spritesets ? _cur.GetSprite(feature, index) : index;
785  if (max_palette_offset != nullptr) *max_palette_offset = use_cur_spritesets ? _cur.GetNumEnts(feature, index) : UINT16_MAX;
786  SB(grf_sprite->pal, 0, SPRITE_WIDTH, sprite);
788  }
789  } else if ((flags & TLF_PALETTE_VAR10) && !(flags & TLF_PALETTE_REG_FLAGS)) {
790  grfmsg(1, "ReadSpriteLayoutRegisters: Spritelayout specifies var10 value for non-action-1 palette");
791  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
792  return flags;
793  }
794 
795  return flags;
796 }
797 
806 static void ReadSpriteLayoutRegisters(ByteReader *buf, TileLayoutFlags flags, bool is_parent, NewGRFSpriteLayout *dts, uint index)
807 {
808  if (!(flags & TLF_DRAWING_FLAGS)) return;
809 
810  if (dts->registers == nullptr) dts->AllocateRegisters();
811  TileLayoutRegisters &regs = const_cast<TileLayoutRegisters&>(dts->registers[index]);
812  regs.flags = flags & TLF_DRAWING_FLAGS;
813 
814  if (flags & TLF_DODRAW) regs.dodraw = buf->ReadByte();
815  if (flags & TLF_SPRITE) regs.sprite = buf->ReadByte();
816  if (flags & TLF_PALETTE) regs.palette = buf->ReadByte();
817 
818  if (is_parent) {
819  if (flags & TLF_BB_XY_OFFSET) {
820  regs.delta.parent[0] = buf->ReadByte();
821  regs.delta.parent[1] = buf->ReadByte();
822  }
823  if (flags & TLF_BB_Z_OFFSET) regs.delta.parent[2] = buf->ReadByte();
824  } else {
825  if (flags & TLF_CHILD_X_OFFSET) regs.delta.child[0] = buf->ReadByte();
826  if (flags & TLF_CHILD_Y_OFFSET) regs.delta.child[1] = buf->ReadByte();
827  }
828 
829  if (flags & TLF_SPRITE_VAR10) {
830  regs.sprite_var10 = buf->ReadByte();
831  if (regs.sprite_var10 > TLR_MAX_VAR10) {
832  grfmsg(1, "ReadSpriteLayoutRegisters: Spritelayout specifies var10 (%d) exceeding the maximal allowed value %d", regs.sprite_var10, TLR_MAX_VAR10);
833  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
834  return;
835  }
836  }
837 
838  if (flags & TLF_PALETTE_VAR10) {
839  regs.palette_var10 = buf->ReadByte();
840  if (regs.palette_var10 > TLR_MAX_VAR10) {
841  grfmsg(1, "ReadSpriteLayoutRegisters: Spritelayout specifies var10 (%d) exceeding the maximal allowed value %d", regs.palette_var10, TLR_MAX_VAR10);
842  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
843  return;
844  }
845  }
846 }
847 
859 static bool ReadSpriteLayout(ByteReader *buf, uint num_building_sprites, bool use_cur_spritesets, byte feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts)
860 {
861  bool has_flags = HasBit(num_building_sprites, 6);
862  ClrBit(num_building_sprites, 6);
863  TileLayoutFlags valid_flags = TLF_KNOWN_FLAGS;
864  if (!allow_var10) valid_flags &= ~TLF_VAR10_FLAGS;
865  dts->Allocate(num_building_sprites); // allocate before reading groundsprite flags
866 
867  uint16 *max_sprite_offset = AllocaM(uint16, num_building_sprites + 1);
868  uint16 *max_palette_offset = AllocaM(uint16, num_building_sprites + 1);
869  MemSetT(max_sprite_offset, 0, num_building_sprites + 1);
870  MemSetT(max_palette_offset, 0, num_building_sprites + 1);
871 
872  /* Groundsprite */
873  TileLayoutFlags flags = ReadSpriteLayoutSprite(buf, has_flags, false, use_cur_spritesets, feature, &dts->ground, max_sprite_offset, max_palette_offset);
874  if (_cur.skip_sprites < 0) return true;
875 
876  if (flags & ~(valid_flags & ~TLF_NON_GROUND_FLAGS)) {
877  grfmsg(1, "ReadSpriteLayout: Spritelayout uses invalid flag 0x%x for ground sprite", flags & ~(valid_flags & ~TLF_NON_GROUND_FLAGS));
878  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
879  return true;
880  }
881 
882  ReadSpriteLayoutRegisters(buf, flags, false, dts, 0);
883  if (_cur.skip_sprites < 0) return true;
884 
885  for (uint i = 0; i < num_building_sprites; i++) {
886  DrawTileSeqStruct *seq = const_cast<DrawTileSeqStruct*>(&dts->seq[i]);
887 
888  flags = ReadSpriteLayoutSprite(buf, has_flags, false, use_cur_spritesets, feature, &seq->image, max_sprite_offset + i + 1, max_palette_offset + i + 1);
889  if (_cur.skip_sprites < 0) return true;
890 
891  if (flags & ~valid_flags) {
892  grfmsg(1, "ReadSpriteLayout: Spritelayout uses unknown flag 0x%x", flags & ~valid_flags);
893  DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
894  return true;
895  }
896 
897  seq->delta_x = buf->ReadByte();
898  seq->delta_y = buf->ReadByte();
899 
900  if (!no_z_position) seq->delta_z = buf->ReadByte();
901 
902  if (seq->IsParentSprite()) {
903  seq->size_x = buf->ReadByte();
904  seq->size_y = buf->ReadByte();
905  seq->size_z = buf->ReadByte();
906  }
907 
908  ReadSpriteLayoutRegisters(buf, flags, seq->IsParentSprite(), dts, i + 1);
909  if (_cur.skip_sprites < 0) return true;
910  }
911 
912  /* Check if the number of sprites per spriteset is consistent */
913  bool is_consistent = true;
914  dts->consistent_max_offset = 0;
915  for (uint i = 0; i < num_building_sprites + 1; i++) {
916  if (max_sprite_offset[i] > 0) {
917  if (dts->consistent_max_offset == 0) {
918  dts->consistent_max_offset = max_sprite_offset[i];
919  } else if (dts->consistent_max_offset != max_sprite_offset[i]) {
920  is_consistent = false;
921  break;
922  }
923  }
924  if (max_palette_offset[i] > 0) {
925  if (dts->consistent_max_offset == 0) {
926  dts->consistent_max_offset = max_palette_offset[i];
927  } else if (dts->consistent_max_offset != max_palette_offset[i]) {
928  is_consistent = false;
929  break;
930  }
931  }
932  }
933 
934  /* When the Action1 sets are unknown, everything should be 0 (no spriteset usage) or UINT16_MAX (some spriteset usage) */
935  assert(use_cur_spritesets || (is_consistent && (dts->consistent_max_offset == 0 || dts->consistent_max_offset == UINT16_MAX)));
936 
937  if (!is_consistent || dts->registers != nullptr) {
938  dts->consistent_max_offset = 0;
939  if (dts->registers == nullptr) dts->AllocateRegisters();
940 
941  for (uint i = 0; i < num_building_sprites + 1; i++) {
942  TileLayoutRegisters &regs = const_cast<TileLayoutRegisters&>(dts->registers[i]);
943  regs.max_sprite_offset = max_sprite_offset[i];
944  regs.max_palette_offset = max_palette_offset[i];
945  }
946  }
947 
948  return false;
949 }
950 
954 static CargoTypes TranslateRefitMask(uint32 refit_mask)
955 {
956  CargoTypes result = 0;
957  for (uint8 bit : SetBitIterator(refit_mask)) {
958  CargoID cargo = GetCargoTranslation(bit, _cur.grffile, true);
959  if (cargo != CT_INVALID) SetBit(result, cargo);
960  }
961  return result;
962 }
963 
971 static void ConvertTTDBasePrice(uint32 base_pointer, const char *error_location, Price *index)
972 {
973  /* Special value for 'none' */
974  if (base_pointer == 0) {
975  *index = INVALID_PRICE;
976  return;
977  }
978 
979  static const uint32 start = 0x4B34;
980  static const uint32 size = 6;
981 
982  if (base_pointer < start || (base_pointer - start) % size != 0 || (base_pointer - start) / size >= PR_END) {
983  grfmsg(1, "%s: Unsupported running cost base 0x%04X, ignoring", error_location, base_pointer);
984  return;
985  }
986 
987  *index = (Price)((base_pointer - start) / size);
988 }
989 
997 };
998 
999 typedef ChangeInfoResult (*VCI_Handler)(uint engine, int numinfo, int prop, ByteReader *buf);
1000 
1009 {
1010  switch (prop) {
1011  case 0x00: // Introduction date
1012  ei->base_intro = buf->ReadWord() + DAYS_TILL_ORIGINAL_BASE_YEAR;
1013  break;
1014 
1015  case 0x02: // Decay speed
1016  ei->decay_speed = buf->ReadByte();
1017  break;
1018 
1019  case 0x03: // Vehicle life
1020  ei->lifelength = buf->ReadByte();
1021  break;
1022 
1023  case 0x04: // Model life
1024  ei->base_life = buf->ReadByte();
1025  break;
1026 
1027  case 0x06: // Climates available
1028  ei->climates = buf->ReadByte();
1029  break;
1030 
1031  case PROP_VEHICLE_LOAD_AMOUNT: // 0x07 Loading speed
1032  /* Amount of cargo loaded during a vehicle's "loading tick" */
1033  ei->load_amount = buf->ReadByte();
1034  break;
1035 
1036  default:
1037  return CIR_UNKNOWN;
1038  }
1039 
1040  return CIR_SUCCESS;
1041 }
1042 
1051 static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
1052 {
1054 
1055  for (int i = 0; i < numinfo; i++) {
1056  Engine *e = GetNewEngine(_cur.grffile, VEH_TRAIN, engine + i);
1057  if (e == nullptr) return CIR_INVALID_ID; // No engine could be allocated, so neither can any next vehicles
1058 
1059  EngineInfo *ei = &e->info;
1060  RailVehicleInfo *rvi = &e->u.rail;
1061 
1062  switch (prop) {
1063  case 0x05: { // Track type
1064  uint8 tracktype = buf->ReadByte();
1065 
1066  if (tracktype < _cur.grffile->railtype_list.size()) {
1067  _gted[e->index].railtypelabel = _cur.grffile->railtype_list[tracktype];
1068  break;
1069  }
1070 
1071  switch (tracktype) {
1072  case 0: _gted[e->index].railtypelabel = rvi->engclass >= 2 ? RAILTYPE_ELECTRIC_LABEL : RAILTYPE_RAIL_LABEL; break;
1073  case 1: _gted[e->index].railtypelabel = RAILTYPE_MONO_LABEL; break;
1074  case 2: _gted[e->index].railtypelabel = RAILTYPE_MAGLEV_LABEL; break;
1075  default:
1076  grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);
1077  break;
1078  }
1079  break;
1080  }
1081 
1082  case 0x08: // AI passenger service
1083  /* Tells the AI that this engine is designed for
1084  * passenger services and shouldn't be used for freight. */
1085  rvi->ai_passenger_only = buf->ReadByte();
1086  break;
1087 
1088  case PROP_TRAIN_SPEED: { // 0x09 Speed (1 unit is 1 km-ish/h)
1089  uint16 speed = buf->ReadWord();
1090  if (speed == 0xFFFF) speed = 0;
1091 
1092  rvi->max_speed = speed;
1093  break;
1094  }
1095 
1096  case PROP_TRAIN_POWER: // 0x0B Power
1097  rvi->power = buf->ReadWord();
1098 
1099  /* Set engine / wagon state based on power */
1100  if (rvi->power != 0) {
1101  if (rvi->railveh_type == RAILVEH_WAGON) {
1102  rvi->railveh_type = RAILVEH_SINGLEHEAD;
1103  }
1104  } else {
1105  rvi->railveh_type = RAILVEH_WAGON;
1106  }
1107  break;
1108 
1109  case PROP_TRAIN_RUNNING_COST_FACTOR: // 0x0D Running cost factor
1110  rvi->running_cost = buf->ReadByte();
1111  break;
1112 
1113  case 0x0E: // Running cost base
1114  ConvertTTDBasePrice(buf->ReadDWord(), "RailVehicleChangeInfo", &rvi->running_cost_class);
1115  break;
1116 
1117  case 0x12: { // Sprite ID
1118  uint8 spriteid = buf->ReadByte();
1119  uint8 orig_spriteid = spriteid;
1120 
1121  /* TTD sprite IDs point to a location in a 16bit array, but we use it
1122  * as an array index, so we need it to be half the original value. */
1123  if (spriteid < 0xFD) spriteid >>= 1;
1124 
1125  if (IsValidNewGRFImageIndex<VEH_TRAIN>(spriteid)) {
1126  rvi->image_index = spriteid;
1127  } else {
1128  grfmsg(1, "RailVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1129  rvi->image_index = 0;
1130  }
1131  break;
1132  }
1133 
1134  case 0x13: { // Dual-headed
1135  uint8 dual = buf->ReadByte();
1136 
1137  if (dual != 0) {
1138  rvi->railveh_type = RAILVEH_MULTIHEAD;
1139  } else {
1140  rvi->railveh_type = rvi->power == 0 ?
1142  }
1143  break;
1144  }
1145 
1146  case PROP_TRAIN_CARGO_CAPACITY: // 0x14 Cargo capacity
1147  rvi->capacity = buf->ReadByte();
1148  break;
1149 
1150  case 0x15: { // Cargo type
1151  _gted[e->index].defaultcargo_grf = _cur.grffile;
1152  uint8 ctype = buf->ReadByte();
1153 
1154  if (ctype == 0xFF) {
1155  /* 0xFF is specified as 'use first refittable' */
1156  ei->cargo_type = CT_INVALID;
1157  } else if (_cur.grffile->grf_version >= 8) {
1158  /* Use translated cargo. Might result in CT_INVALID (first refittable), if cargo is not defined. */
1159  ei->cargo_type = GetCargoTranslation(ctype, _cur.grffile);
1160  } else if (ctype < NUM_CARGO) {
1161  /* Use untranslated cargo. */
1162  ei->cargo_type = ctype;
1163  } else {
1164  ei->cargo_type = CT_INVALID;
1165  grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1166  }
1167  break;
1168  }
1169 
1170  case PROP_TRAIN_WEIGHT: // 0x16 Weight
1171  SB(rvi->weight, 0, 8, buf->ReadByte());
1172  break;
1173 
1174  case PROP_TRAIN_COST_FACTOR: // 0x17 Cost factor
1175  rvi->cost_factor = buf->ReadByte();
1176  break;
1177 
1178  case 0x18: // AI rank
1179  grfmsg(2, "RailVehicleChangeInfo: Property 0x18 'AI rank' not used by NoAI, ignored.");
1180  buf->ReadByte();
1181  break;
1182 
1183  case 0x19: { // Engine traction type
1184  /* What do the individual numbers mean?
1185  * 0x00 .. 0x07: Steam
1186  * 0x08 .. 0x27: Diesel
1187  * 0x28 .. 0x31: Electric
1188  * 0x32 .. 0x37: Monorail
1189  * 0x38 .. 0x41: Maglev
1190  */
1191  uint8 traction = buf->ReadByte();
1192  EngineClass engclass;
1193 
1194  if (traction <= 0x07) {
1195  engclass = EC_STEAM;
1196  } else if (traction <= 0x27) {
1197  engclass = EC_DIESEL;
1198  } else if (traction <= 0x31) {
1199  engclass = EC_ELECTRIC;
1200  } else if (traction <= 0x37) {
1201  engclass = EC_MONORAIL;
1202  } else if (traction <= 0x41) {
1203  engclass = EC_MAGLEV;
1204  } else {
1205  break;
1206  }
1207 
1208  if (_cur.grffile->railtype_list.size() == 0) {
1209  /* Use traction type to select between normal and electrified
1210  * rail only when no translation list is in place. */
1211  if (_gted[e->index].railtypelabel == RAILTYPE_RAIL_LABEL && engclass >= EC_ELECTRIC) _gted[e->index].railtypelabel = RAILTYPE_ELECTRIC_LABEL;
1212  if (_gted[e->index].railtypelabel == RAILTYPE_ELECTRIC_LABEL && engclass < EC_ELECTRIC) _gted[e->index].railtypelabel = RAILTYPE_RAIL_LABEL;
1213  }
1214 
1215  rvi->engclass = engclass;
1216  break;
1217  }
1218 
1219  case 0x1A: // Alter purchase list sort order
1220  AlterVehicleListOrder(e->index, buf->ReadExtendedByte());
1221  break;
1222 
1223  case 0x1B: // Powered wagons power bonus
1224  rvi->pow_wag_power = buf->ReadWord();
1225  break;
1226 
1227  case 0x1C: // Refit cost
1228  ei->refit_cost = buf->ReadByte();
1229  break;
1230 
1231  case 0x1D: { // Refit cargo
1232  uint32 mask = buf->ReadDWord();
1233  _gted[e->index].UpdateRefittability(mask != 0);
1234  ei->refit_mask = TranslateRefitMask(mask);
1235  _gted[e->index].defaultcargo_grf = _cur.grffile;
1236  break;
1237  }
1238 
1239  case 0x1E: // Callback
1240  ei->callback_mask = buf->ReadByte();
1241  break;
1242 
1243  case PROP_TRAIN_TRACTIVE_EFFORT: // 0x1F Tractive effort coefficient
1244  rvi->tractive_effort = buf->ReadByte();
1245  break;
1246 
1247  case 0x20: // Air drag
1248  rvi->air_drag = buf->ReadByte();
1249  break;
1250 
1251  case PROP_TRAIN_SHORTEN_FACTOR: // 0x21 Shorter vehicle
1252  rvi->shorten_factor = buf->ReadByte();
1253  break;
1254 
1255  case 0x22: // Visual effect
1256  rvi->visual_effect = buf->ReadByte();
1257  /* Avoid accidentally setting visual_effect to the default value
1258  * Since bit 6 (disable effects) is set anyways, we can safely erase some bits. */
1259  if (rvi->visual_effect == VE_DEFAULT) {
1260  assert(HasBit(rvi->visual_effect, VE_DISABLE_EFFECT));
1262  }
1263  break;
1264 
1265  case 0x23: // Powered wagons weight bonus
1266  rvi->pow_wag_weight = buf->ReadByte();
1267  break;
1268 
1269  case 0x24: { // High byte of vehicle weight
1270  byte weight = buf->ReadByte();
1271 
1272  if (weight > 4) {
1273  grfmsg(2, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8);
1274  } else {
1275  SB(rvi->weight, 8, 8, weight);
1276  }
1277  break;
1278  }
1279 
1280  case PROP_TRAIN_USER_DATA: // 0x25 User-defined bit mask to set when checking veh. var. 42
1281  rvi->user_def_data = buf->ReadByte();
1282  break;
1283 
1284  case 0x26: // Retire vehicle early
1285  ei->retire_early = buf->ReadByte();
1286  break;
1287 
1288  case 0x27: // Miscellaneous flags
1289  ei->misc_flags = buf->ReadByte();
1291  break;
1292 
1293  case 0x28: // Cargo classes allowed
1294  _gted[e->index].cargo_allowed = buf->ReadWord();
1295  _gted[e->index].UpdateRefittability(_gted[e->index].cargo_allowed != 0);
1296  _gted[e->index].defaultcargo_grf = _cur.grffile;
1297  break;
1298 
1299  case 0x29: // Cargo classes disallowed
1300  _gted[e->index].cargo_disallowed = buf->ReadWord();
1301  _gted[e->index].UpdateRefittability(false);
1302  break;
1303 
1304  case 0x2A: // Long format introduction date (days since year 0)
1305  ei->base_intro = buf->ReadDWord();
1306  break;
1307 
1308  case PROP_TRAIN_CARGO_AGE_PERIOD: // 0x2B Cargo aging period
1309  ei->cargo_age_period = buf->ReadWord();
1310  break;
1311 
1312  case 0x2C: // CTT refit include list
1313  case 0x2D: { // CTT refit exclude list
1314  uint8 count = buf->ReadByte();
1315  _gted[e->index].UpdateRefittability(prop == 0x2C && count != 0);
1316  if (prop == 0x2C) _gted[e->index].defaultcargo_grf = _cur.grffile;
1317  CargoTypes &ctt = prop == 0x2C ? _gted[e->index].ctt_include_mask : _gted[e->index].ctt_exclude_mask;
1318  ctt = 0;
1319  while (count--) {
1320  CargoID ctype = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
1321  if (ctype == CT_INVALID) continue;
1322  SetBit(ctt, ctype);
1323  }
1324  break;
1325  }
1326 
1327  case PROP_TRAIN_CURVE_SPEED_MOD: // 0x2E Curve speed modifier
1328  rvi->curve_speed_mod = buf->ReadWord();
1329  break;
1330 
1331  case 0x2F: // Engine variant
1332  ei->variant_id = GetNewEngineID(_cur.grffile, VEH_TRAIN, buf->ReadWord());
1333  break;
1334 
1335  case 0x30: // Extra miscellaneous flags
1336  ei->extra_flags = static_cast<ExtraEngineFlags>(buf->ReadDWord());
1337  break;
1338 
1339  default:
1340  ret = CommonVehicleChangeInfo(ei, prop, buf);
1341  break;
1342  }
1343  }
1344 
1345  return ret;
1346 }
1347 
1356 static ChangeInfoResult RoadVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
1357 {
1359 
1360  for (int i = 0; i < numinfo; i++) {
1361  Engine *e = GetNewEngine(_cur.grffile, VEH_ROAD, engine + i);
1362  if (e == nullptr) return CIR_INVALID_ID; // No engine could be allocated, so neither can any next vehicles
1363 
1364  EngineInfo *ei = &e->info;
1365  RoadVehicleInfo *rvi = &e->u.road;
1366 
1367  switch (prop) {
1368  case 0x05: // Road/tram type
1369  /* RoadTypeLabel is looked up later after the engine's road/tram
1370  * flag is set, however 0 means the value has not been set. */
1371  _gted[e->index].roadtramtype = buf->ReadByte() + 1;
1372  break;
1373 
1374  case 0x08: // Speed (1 unit is 0.5 kmh)
1375  rvi->max_speed = buf->ReadByte();
1376  break;
1377 
1378  case PROP_ROADVEH_RUNNING_COST_FACTOR: // 0x09 Running cost factor
1379  rvi->running_cost = buf->ReadByte();
1380  break;
1381 
1382  case 0x0A: // Running cost base
1383  ConvertTTDBasePrice(buf->ReadDWord(), "RoadVehicleChangeInfo", &rvi->running_cost_class);
1384  break;
1385 
1386  case 0x0E: { // Sprite ID
1387  uint8 spriteid = buf->ReadByte();
1388  uint8 orig_spriteid = spriteid;
1389 
1390  /* cars have different custom id in the GRF file */
1391  if (spriteid == 0xFF) spriteid = 0xFD;
1392 
1393  if (spriteid < 0xFD) spriteid >>= 1;
1394 
1395  if (IsValidNewGRFImageIndex<VEH_ROAD>(spriteid)) {
1396  rvi->image_index = spriteid;
1397  } else {
1398  grfmsg(1, "RoadVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1399  rvi->image_index = 0;
1400  }
1401  break;
1402  }
1403 
1404  case PROP_ROADVEH_CARGO_CAPACITY: // 0x0F Cargo capacity
1405  rvi->capacity = buf->ReadByte();
1406  break;
1407 
1408  case 0x10: { // Cargo type
1409  _gted[e->index].defaultcargo_grf = _cur.grffile;
1410  uint8 ctype = buf->ReadByte();
1411 
1412  if (ctype == 0xFF) {
1413  /* 0xFF is specified as 'use first refittable' */
1414  ei->cargo_type = CT_INVALID;
1415  } else if (_cur.grffile->grf_version >= 8) {
1416  /* Use translated cargo. Might result in CT_INVALID (first refittable), if cargo is not defined. */
1417  ei->cargo_type = GetCargoTranslation(ctype, _cur.grffile);
1418  } else if (ctype < NUM_CARGO) {
1419  /* Use untranslated cargo. */
1420  ei->cargo_type = ctype;
1421  } else {
1422  ei->cargo_type = CT_INVALID;
1423  grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1424  }
1425  break;
1426  }
1427 
1428  case PROP_ROADVEH_COST_FACTOR: // 0x11 Cost factor
1429  rvi->cost_factor = buf->ReadByte();
1430  break;
1431 
1432  case 0x12: // SFX
1433  rvi->sfx = GetNewGRFSoundID(_cur.grffile, buf->ReadByte());
1434  break;
1435 
1436  case PROP_ROADVEH_POWER: // Power in units of 10 HP.
1437  rvi->power = buf->ReadByte();
1438  break;
1439 
1440  case PROP_ROADVEH_WEIGHT: // Weight in units of 1/4 tons.
1441  rvi->weight = buf->ReadByte();
1442  break;
1443 
1444  case PROP_ROADVEH_SPEED: // Speed in mph/0.8
1445  _gted[e->index].rv_max_speed = buf->ReadByte();
1446  break;
1447 
1448  case 0x16: { // Cargoes available for refitting
1449  uint32 mask = buf->ReadDWord();
1450  _gted[e->index].UpdateRefittability(mask != 0);
1451  ei->refit_mask = TranslateRefitMask(mask);
1452  _gted[e->index].defaultcargo_grf = _cur.grffile;
1453  break;
1454  }
1455 
1456  case 0x17: // Callback mask
1457  ei->callback_mask = buf->ReadByte();
1458  break;
1459 
1460  case PROP_ROADVEH_TRACTIVE_EFFORT: // Tractive effort coefficient in 1/256.
1461  rvi->tractive_effort = buf->ReadByte();
1462  break;
1463 
1464  case 0x19: // Air drag
1465  rvi->air_drag = buf->ReadByte();
1466  break;
1467 
1468  case 0x1A: // Refit cost
1469  ei->refit_cost = buf->ReadByte();
1470  break;
1471 
1472  case 0x1B: // Retire vehicle early
1473  ei->retire_early = buf->ReadByte();
1474  break;
1475 
1476  case 0x1C: // Miscellaneous flags
1477  ei->misc_flags = buf->ReadByte();
1479  break;
1480 
1481  case 0x1D: // Cargo classes allowed
1482  _gted[e->index].cargo_allowed = buf->ReadWord();
1483  _gted[e->index].UpdateRefittability(_gted[e->index].cargo_allowed != 0);
1484  _gted[e->index].defaultcargo_grf = _cur.grffile;
1485  break;
1486 
1487  case 0x1E: // Cargo classes disallowed
1488  _gted[e->index].cargo_disallowed = buf->ReadWord();
1489  _gted[e->index].UpdateRefittability(false);
1490  break;
1491 
1492  case 0x1F: // Long format introduction date (days since year 0)
1493  ei->base_intro = buf->ReadDWord();
1494  break;
1495 
1496  case 0x20: // Alter purchase list sort order
1497  AlterVehicleListOrder(e->index, buf->ReadExtendedByte());
1498  break;
1499 
1500  case 0x21: // Visual effect
1501  rvi->visual_effect = buf->ReadByte();
1502  /* Avoid accidentally setting visual_effect to the default value
1503  * Since bit 6 (disable effects) is set anyways, we can safely erase some bits. */
1504  if (rvi->visual_effect == VE_DEFAULT) {
1505  assert(HasBit(rvi->visual_effect, VE_DISABLE_EFFECT));
1507  }
1508  break;
1509 
1510  case PROP_ROADVEH_CARGO_AGE_PERIOD: // 0x22 Cargo aging period
1511  ei->cargo_age_period = buf->ReadWord();
1512  break;
1513 
1514  case PROP_ROADVEH_SHORTEN_FACTOR: // 0x23 Shorter vehicle
1515  rvi->shorten_factor = buf->ReadByte();
1516  break;
1517 
1518  case 0x24: // CTT refit include list
1519  case 0x25: { // CTT refit exclude list
1520  uint8 count = buf->ReadByte();
1521  _gted[e->index].UpdateRefittability(prop == 0x24 && count != 0);
1522  if (prop == 0x24) _gted[e->index].defaultcargo_grf = _cur.grffile;
1523  CargoTypes &ctt = prop == 0x24 ? _gted[e->index].ctt_include_mask : _gted[e->index].ctt_exclude_mask;
1524  ctt = 0;
1525  while (count--) {
1526  CargoID ctype = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
1527  if (ctype == CT_INVALID) continue;
1528  SetBit(ctt, ctype);
1529  }
1530  break;
1531  }
1532 
1533  case 0x26: // Engine variant
1534  ei->variant_id = GetNewEngineID(_cur.grffile, VEH_ROAD, buf->ReadWord());
1535  break;
1536 
1537  case 0x27: // Extra miscellaneous flags
1538  ei->extra_flags = static_cast<ExtraEngineFlags>(buf->ReadDWord());
1539  break;
1540 
1541  default:
1542  ret = CommonVehicleChangeInfo(ei, prop, buf);
1543  break;
1544  }
1545  }
1546 
1547  return ret;
1548 }
1549 
1558 static ChangeInfoResult ShipVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
1559 {
1561 
1562  for (int i = 0; i < numinfo; i++) {
1563  Engine *e = GetNewEngine(_cur.grffile, VEH_SHIP, engine + i);
1564  if (e == nullptr) return CIR_INVALID_ID; // No engine could be allocated, so neither can any next vehicles
1565 
1566  EngineInfo *ei = &e->info;
1567  ShipVehicleInfo *svi = &e->u.ship;
1568 
1569  switch (prop) {
1570  case 0x08: { // Sprite ID
1571  uint8 spriteid = buf->ReadByte();
1572  uint8 orig_spriteid = spriteid;
1573 
1574  /* ships have different custom id in the GRF file */
1575  if (spriteid == 0xFF) spriteid = 0xFD;
1576 
1577  if (spriteid < 0xFD) spriteid >>= 1;
1578 
1579  if (IsValidNewGRFImageIndex<VEH_SHIP>(spriteid)) {
1580  svi->image_index = spriteid;
1581  } else {
1582  grfmsg(1, "ShipVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1583  svi->image_index = 0;
1584  }
1585  break;
1586  }
1587 
1588  case 0x09: // Refittable
1589  svi->old_refittable = (buf->ReadByte() != 0);
1590  break;
1591 
1592  case PROP_SHIP_COST_FACTOR: // 0x0A Cost factor
1593  svi->cost_factor = buf->ReadByte();
1594  break;
1595 
1596  case PROP_SHIP_SPEED: // 0x0B Speed (1 unit is 0.5 km-ish/h)
1597  svi->max_speed = buf->ReadByte();
1598  break;
1599 
1600  case 0x0C: { // Cargo type
1601  _gted[e->index].defaultcargo_grf = _cur.grffile;
1602  uint8 ctype = buf->ReadByte();
1603 
1604  if (ctype == 0xFF) {
1605  /* 0xFF is specified as 'use first refittable' */
1606  ei->cargo_type = CT_INVALID;
1607  } else if (_cur.grffile->grf_version >= 8) {
1608  /* Use translated cargo. Might result in CT_INVALID (first refittable), if cargo is not defined. */
1609  ei->cargo_type = GetCargoTranslation(ctype, _cur.grffile);
1610  } else if (ctype < NUM_CARGO) {
1611  /* Use untranslated cargo. */
1612  ei->cargo_type = ctype;
1613  } else {
1614  ei->cargo_type = CT_INVALID;
1615  grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1616  }
1617  break;
1618  }
1619 
1620  case PROP_SHIP_CARGO_CAPACITY: // 0x0D Cargo capacity
1621  svi->capacity = buf->ReadWord();
1622  break;
1623 
1624  case PROP_SHIP_RUNNING_COST_FACTOR: // 0x0F Running cost factor
1625  svi->running_cost = buf->ReadByte();
1626  break;
1627 
1628  case 0x10: // SFX
1629  svi->sfx = GetNewGRFSoundID(_cur.grffile, buf->ReadByte());
1630  break;
1631 
1632  case 0x11: { // Cargoes available for refitting
1633  uint32 mask = buf->ReadDWord();
1634  _gted[e->index].UpdateRefittability(mask != 0);
1635  ei->refit_mask = TranslateRefitMask(mask);
1636  _gted[e->index].defaultcargo_grf = _cur.grffile;
1637  break;
1638  }
1639 
1640  case 0x12: // Callback mask
1641  ei->callback_mask = buf->ReadByte();
1642  break;
1643 
1644  case 0x13: // Refit cost
1645  ei->refit_cost = buf->ReadByte();
1646  break;
1647 
1648  case 0x14: // Ocean speed fraction
1649  svi->ocean_speed_frac = buf->ReadByte();
1650  break;
1651 
1652  case 0x15: // Canal speed fraction
1653  svi->canal_speed_frac = buf->ReadByte();
1654  break;
1655 
1656  case 0x16: // Retire vehicle early
1657  ei->retire_early = buf->ReadByte();
1658  break;
1659 
1660  case 0x17: // Miscellaneous flags
1661  ei->misc_flags = buf->ReadByte();
1663  break;
1664 
1665  case 0x18: // Cargo classes allowed
1666  _gted[e->index].cargo_allowed = buf->ReadWord();
1667  _gted[e->index].UpdateRefittability(_gted[e->index].cargo_allowed != 0);
1668  _gted[e->index].defaultcargo_grf = _cur.grffile;
1669  break;
1670 
1671  case 0x19: // Cargo classes disallowed
1672  _gted[e->index].cargo_disallowed = buf->ReadWord();
1673  _gted[e->index].UpdateRefittability(false);
1674  break;
1675 
1676  case 0x1A: // Long format introduction date (days since year 0)
1677  ei->base_intro = buf->ReadDWord();
1678  break;
1679 
1680  case 0x1B: // Alter purchase list sort order
1681  AlterVehicleListOrder(e->index, buf->ReadExtendedByte());
1682  break;
1683 
1684  case 0x1C: // Visual effect
1685  svi->visual_effect = buf->ReadByte();
1686  /* Avoid accidentally setting visual_effect to the default value
1687  * Since bit 6 (disable effects) is set anyways, we can safely erase some bits. */
1688  if (svi->visual_effect == VE_DEFAULT) {
1689  assert(HasBit(svi->visual_effect, VE_DISABLE_EFFECT));
1691  }
1692  break;
1693 
1694  case PROP_SHIP_CARGO_AGE_PERIOD: // 0x1D Cargo aging period
1695  ei->cargo_age_period = buf->ReadWord();
1696  break;
1697 
1698  case 0x1E: // CTT refit include list
1699  case 0x1F: { // CTT refit exclude list
1700  uint8 count = buf->ReadByte();
1701  _gted[e->index].UpdateRefittability(prop == 0x1E && count != 0);
1702  if (prop == 0x1E) _gted[e->index].defaultcargo_grf = _cur.grffile;
1703  CargoTypes &ctt = prop == 0x1E ? _gted[e->index].ctt_include_mask : _gted[e->index].ctt_exclude_mask;
1704  ctt = 0;
1705  while (count--) {
1706  CargoID ctype = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
1707  if (ctype == CT_INVALID) continue;
1708  SetBit(ctt, ctype);
1709  }
1710  break;
1711  }
1712 
1713  case 0x20: // Engine variant
1714  ei->variant_id = GetNewEngineID(_cur.grffile, VEH_SHIP, buf->ReadWord());
1715  break;
1716 
1717  case 0x21: // Extra miscellaneous flags
1718  ei->extra_flags = static_cast<ExtraEngineFlags>(buf->ReadDWord());
1719  break;
1720 
1721  default:
1722  ret = CommonVehicleChangeInfo(ei, prop, buf);
1723  break;
1724  }
1725  }
1726 
1727  return ret;
1728 }
1729 
1738 static ChangeInfoResult AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
1739 {
1741 
1742  for (int i = 0; i < numinfo; i++) {
1743  Engine *e = GetNewEngine(_cur.grffile, VEH_AIRCRAFT, engine + i);
1744  if (e == nullptr) return CIR_INVALID_ID; // No engine could be allocated, so neither can any next vehicles
1745 
1746  EngineInfo *ei = &e->info;
1747  AircraftVehicleInfo *avi = &e->u.air;
1748 
1749  switch (prop) {
1750  case 0x08: { // Sprite ID
1751  uint8 spriteid = buf->ReadByte();
1752  uint8 orig_spriteid = spriteid;
1753 
1754  /* aircraft have different custom id in the GRF file */
1755  if (spriteid == 0xFF) spriteid = 0xFD;
1756 
1757  if (spriteid < 0xFD) spriteid >>= 1;
1758 
1759  if (IsValidNewGRFImageIndex<VEH_AIRCRAFT>(spriteid)) {
1760  avi->image_index = spriteid;
1761  } else {
1762  grfmsg(1, "AircraftVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1763  avi->image_index = 0;
1764  }
1765  break;
1766  }
1767 
1768  case 0x09: // Helicopter
1769  if (buf->ReadByte() == 0) {
1770  avi->subtype = AIR_HELI;
1771  } else {
1772  SB(avi->subtype, 0, 1, 1); // AIR_CTOL
1773  }
1774  break;
1775 
1776  case 0x0A: // Large
1777  SB(avi->subtype, 1, 1, (buf->ReadByte() != 0 ? 1 : 0)); // AIR_FAST
1778  break;
1779 
1780  case PROP_AIRCRAFT_COST_FACTOR: // 0x0B Cost factor
1781  avi->cost_factor = buf->ReadByte();
1782  break;
1783 
1784  case PROP_AIRCRAFT_SPEED: // 0x0C Speed (1 unit is 8 mph, we translate to 1 unit is 1 km-ish/h)
1785  avi->max_speed = (buf->ReadByte() * 128) / 10;
1786  break;
1787 
1788  case 0x0D: // Acceleration
1789  avi->acceleration = buf->ReadByte();
1790  break;
1791 
1792  case PROP_AIRCRAFT_RUNNING_COST_FACTOR: // 0x0E Running cost factor
1793  avi->running_cost = buf->ReadByte();
1794  break;
1795 
1796  case PROP_AIRCRAFT_PASSENGER_CAPACITY: // 0x0F Passenger capacity
1797  avi->passenger_capacity = buf->ReadWord();
1798  break;
1799 
1800  case PROP_AIRCRAFT_MAIL_CAPACITY: // 0x11 Mail capacity
1801  avi->mail_capacity = buf->ReadByte();
1802  break;
1803 
1804  case 0x12: // SFX
1805  avi->sfx = GetNewGRFSoundID(_cur.grffile, buf->ReadByte());
1806  break;
1807 
1808  case 0x13: { // Cargoes available for refitting
1809  uint32 mask = buf->ReadDWord();
1810  _gted[e->index].UpdateRefittability(mask != 0);
1811  ei->refit_mask = TranslateRefitMask(mask);
1812  _gted[e->index].defaultcargo_grf = _cur.grffile;
1813  break;
1814  }
1815 
1816  case 0x14: // Callback mask
1817  ei->callback_mask = buf->ReadByte();
1818  break;
1819 
1820  case 0x15: // Refit cost
1821  ei->refit_cost = buf->ReadByte();
1822  break;
1823 
1824  case 0x16: // Retire vehicle early
1825  ei->retire_early = buf->ReadByte();
1826  break;
1827 
1828  case 0x17: // Miscellaneous flags
1829  ei->misc_flags = buf->ReadByte();
1831  break;
1832 
1833  case 0x18: // Cargo classes allowed
1834  _gted[e->index].cargo_allowed = buf->ReadWord();
1835  _gted[e->index].UpdateRefittability(_gted[e->index].cargo_allowed != 0);
1836  _gted[e->index].defaultcargo_grf = _cur.grffile;
1837  break;
1838 
1839  case 0x19: // Cargo classes disallowed
1840  _gted[e->index].cargo_disallowed = buf->ReadWord();
1841  _gted[e->index].UpdateRefittability(false);
1842  break;
1843 
1844  case 0x1A: // Long format introduction date (days since year 0)
1845  ei->base_intro = buf->ReadDWord();
1846  break;
1847 
1848  case 0x1B: // Alter purchase list sort order
1849  AlterVehicleListOrder(e->index, buf->ReadExtendedByte());
1850  break;
1851 
1852  case PROP_AIRCRAFT_CARGO_AGE_PERIOD: // 0x1C Cargo aging period
1853  ei->cargo_age_period = buf->ReadWord();
1854  break;
1855 
1856  case 0x1D: // CTT refit include list
1857  case 0x1E: { // CTT refit exclude list
1858  uint8 count = buf->ReadByte();
1859  _gted[e->index].UpdateRefittability(prop == 0x1D && count != 0);
1860  if (prop == 0x1D) _gted[e->index].defaultcargo_grf = _cur.grffile;
1861  CargoTypes &ctt = prop == 0x1D ? _gted[e->index].ctt_include_mask : _gted[e->index].ctt_exclude_mask;
1862  ctt = 0;
1863  while (count--) {
1864  CargoID ctype = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
1865  if (ctype == CT_INVALID) continue;
1866  SetBit(ctt, ctype);
1867  }
1868  break;
1869  }
1870 
1871  case PROP_AIRCRAFT_RANGE: // 0x1F Max aircraft range
1872  avi->max_range = buf->ReadWord();
1873  break;
1874 
1875  case 0x20: // Engine variant
1876  ei->variant_id = GetNewEngineID(_cur.grffile, VEH_AIRCRAFT, buf->ReadWord());
1877  break;
1878 
1879  case 0x21: // Extra miscellaneous flags
1880  ei->extra_flags = static_cast<ExtraEngineFlags>(buf->ReadDWord());
1881  break;
1882 
1883  default:
1884  ret = CommonVehicleChangeInfo(ei, prop, buf);
1885  break;
1886  }
1887  }
1888 
1889  return ret;
1890 }
1891 
1900 static ChangeInfoResult StationChangeInfo(uint stid, int numinfo, int prop, ByteReader *buf)
1901 {
1903 
1904  if (stid + numinfo > NUM_STATIONS_PER_GRF) {
1905  grfmsg(1, "StationChangeInfo: Station %u is invalid, max %u, ignoring", stid + numinfo, NUM_STATIONS_PER_GRF);
1906  return CIR_INVALID_ID;
1907  }
1908 
1909  /* Allocate station specs if necessary */
1910  if (_cur.grffile->stations == nullptr) _cur.grffile->stations = CallocT<StationSpec*>(NUM_STATIONS_PER_GRF);
1911 
1912  for (int i = 0; i < numinfo; i++) {
1913  StationSpec *statspec = _cur.grffile->stations[stid + i];
1914 
1915  /* Check that the station we are modifying is defined. */
1916  if (statspec == nullptr && prop != 0x08) {
1917  grfmsg(2, "StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i);
1918  return CIR_INVALID_ID;
1919  }
1920 
1921  switch (prop) {
1922  case 0x08: { // Class ID
1923  StationSpec **spec = &_cur.grffile->stations[stid + i];
1924 
1925  /* Property 0x08 is special; it is where the station is allocated */
1926  if (*spec == nullptr) *spec = new StationSpec();
1927 
1928  /* Swap classid because we read it in BE meaning WAYP or DFLT */
1929  uint32 classid = buf->ReadDWord();
1930  (*spec)->cls_id = StationClass::Allocate(BSWAP32(classid));
1931  break;
1932  }
1933 
1934  case 0x09: { // Define sprite layout
1935  uint16 tiles = buf->ReadExtendedByte();
1936  statspec->renderdata.clear(); // delete earlier loaded stuff
1937  statspec->renderdata.reserve(tiles);
1938 
1939  for (uint t = 0; t < tiles; t++) {
1940  NewGRFSpriteLayout *dts = &statspec->renderdata.emplace_back();
1941  dts->consistent_max_offset = UINT16_MAX; // Spritesets are unknown, so no limit.
1942 
1943  if (buf->HasData(4) && *(uint32*)buf->Data() == 0) {
1944  buf->Skip(4);
1945  extern const DrawTileSprites _station_display_datas_rail[8];
1946  dts->Clone(&_station_display_datas_rail[t % 8]);
1947  continue;
1948  }
1949 
1950  ReadSpriteLayoutSprite(buf, false, false, false, GSF_STATIONS, &dts->ground);
1951  /* On error, bail out immediately. Temporary GRF data was already freed */
1952  if (_cur.skip_sprites < 0) return CIR_DISABLED;
1953 
1954  static std::vector<DrawTileSeqStruct> tmp_layout;
1955  tmp_layout.clear();
1956  for (;;) {
1957  /* no relative bounding box support */
1958  DrawTileSeqStruct &dtss = tmp_layout.emplace_back();
1959  MemSetT(&dtss, 0);
1960 
1961  dtss.delta_x = buf->ReadByte();
1962  if (dtss.IsTerminator()) break;
1963  dtss.delta_y = buf->ReadByte();
1964  dtss.delta_z = buf->ReadByte();
1965  dtss.size_x = buf->ReadByte();
1966  dtss.size_y = buf->ReadByte();
1967  dtss.size_z = buf->ReadByte();
1968 
1969  ReadSpriteLayoutSprite(buf, false, true, false, GSF_STATIONS, &dtss.image);
1970  /* On error, bail out immediately. Temporary GRF data was already freed */
1971  if (_cur.skip_sprites < 0) return CIR_DISABLED;
1972  }
1973  dts->Clone(tmp_layout.data());
1974  }
1975 
1976  /* Number of layouts must be even, alternating X and Y */
1977  if (statspec->renderdata.size() & 1) {
1978  grfmsg(1, "StationChangeInfo: Station %u defines an odd number of sprite layouts, dropping the last item", stid + i);
1979  statspec->renderdata.pop_back();
1980  }
1981  break;
1982  }
1983 
1984  case 0x0A: { // Copy sprite layout
1985  byte srcid = buf->ReadByte();
1986  const StationSpec *srcstatspec = _cur.grffile->stations[srcid];
1987 
1988  if (srcstatspec == nullptr) {
1989  grfmsg(1, "StationChangeInfo: Station %u is not defined, cannot copy sprite layout to %u.", srcid, stid + i);
1990  continue;
1991  }
1992 
1993  statspec->renderdata.clear(); // delete earlier loaded stuff
1994  statspec->renderdata.reserve(srcstatspec->renderdata.size());
1995 
1996  for (const auto &it : srcstatspec->renderdata) {
1997  NewGRFSpriteLayout *dts = &statspec->renderdata.emplace_back();
1998  dts->Clone(&it);
1999  }
2000  break;
2001  }
2002 
2003  case 0x0B: // Callback mask
2004  statspec->callback_mask = buf->ReadByte();
2005  break;
2006 
2007  case 0x0C: // Disallowed number of platforms
2008  statspec->disallowed_platforms = buf->ReadByte();
2009  break;
2010 
2011  case 0x0D: // Disallowed platform lengths
2012  statspec->disallowed_lengths = buf->ReadByte();
2013  break;
2014 
2015  case 0x0E: // Define custom layout
2016  while (buf->HasData()) {
2017  byte length = buf->ReadByte();
2018  byte number = buf->ReadByte();
2019 
2020  if (length == 0 || number == 0) break;
2021 
2022  if (statspec->layouts.size() < length) statspec->layouts.resize(length);
2023  if (statspec->layouts[length - 1].size() < number) statspec->layouts[length - 1].resize(number);
2024 
2025  const byte *layout = buf->ReadBytes(length * number);
2026  statspec->layouts[length - 1][number - 1].assign(layout, layout + length * number);
2027 
2028  /* Validate tile values are only the permitted 00, 02, 04 and 06. */
2029  for (auto &tile : statspec->layouts[length - 1][number - 1]) {
2030  if ((tile & 6) != tile) {
2031  grfmsg(1, "StationChangeInfo: Invalid tile %u in layout %ux%u", tile, length, number);
2032  tile &= 6;
2033  }
2034  }
2035  }
2036  break;
2037 
2038  case 0x0F: { // Copy custom layout
2039  byte srcid = buf->ReadByte();
2040  const StationSpec *srcstatspec = _cur.grffile->stations[srcid];
2041 
2042  if (srcstatspec == nullptr) {
2043  grfmsg(1, "StationChangeInfo: Station %u is not defined, cannot copy tile layout to %u.", srcid, stid + i);
2044  continue;
2045  }
2046 
2047  statspec->layouts = srcstatspec->layouts;
2048  break;
2049  }
2050 
2051  case 0x10: // Little/lots cargo threshold
2052  statspec->cargo_threshold = buf->ReadWord();
2053  break;
2054 
2055  case 0x11: // Pylon placement
2056  statspec->pylons = buf->ReadByte();
2057  break;
2058 
2059  case 0x12: // Cargo types for random triggers
2060  if (_cur.grffile->grf_version >= 7) {
2061  statspec->cargo_triggers = TranslateRefitMask(buf->ReadDWord());
2062  } else {
2063  statspec->cargo_triggers = (CargoTypes)buf->ReadDWord();
2064  }
2065  break;
2066 
2067  case 0x13: // General flags
2068  statspec->flags = buf->ReadByte();
2069  break;
2070 
2071  case 0x14: // Overhead wire placement
2072  statspec->wires = buf->ReadByte();
2073  break;
2074 
2075  case 0x15: // Blocked tiles
2076  statspec->blocked = buf->ReadByte();
2077  break;
2078 
2079  case 0x16: // Animation info
2080  statspec->animation.frames = buf->ReadByte();
2081  statspec->animation.status = buf->ReadByte();
2082  break;
2083 
2084  case 0x17: // Animation speed
2085  statspec->animation.speed = buf->ReadByte();
2086  break;
2087 
2088  case 0x18: // Animation triggers
2089  statspec->animation.triggers = buf->ReadWord();
2090  break;
2091 
2092  case 0x1A: { // Advanced sprite layout
2093  uint16 tiles = buf->ReadExtendedByte();
2094  statspec->renderdata.clear(); // delete earlier loaded stuff
2095  statspec->renderdata.reserve(tiles);
2096 
2097  for (uint t = 0; t < tiles; t++) {
2098  NewGRFSpriteLayout *dts = &statspec->renderdata.emplace_back();
2099  uint num_building_sprites = buf->ReadByte();
2100  /* On error, bail out immediately. Temporary GRF data was already freed */
2101  if (ReadSpriteLayout(buf, num_building_sprites, false, GSF_STATIONS, true, false, dts)) return CIR_DISABLED;
2102  }
2103 
2104  /* Number of layouts must be even, alternating X and Y */
2105  if (statspec->renderdata.size() & 1) {
2106  grfmsg(1, "StationChangeInfo: Station %u defines an odd number of sprite layouts, dropping the last item", stid + i);
2107  statspec->renderdata.pop_back();
2108  }
2109  break;
2110  }
2111 
2112  default:
2113  ret = CIR_UNKNOWN;
2114  break;
2115  }
2116  }
2117 
2118  return ret;
2119 }
2120 
2129 static ChangeInfoResult CanalChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
2130 {
2132 
2133  if (id + numinfo > CF_END) {
2134  grfmsg(1, "CanalChangeInfo: Canal feature 0x%02X is invalid, max %u, ignoring", id + numinfo, CF_END);
2135  return CIR_INVALID_ID;
2136  }
2137 
2138  for (int i = 0; i < numinfo; i++) {
2139  CanalProperties *cp = &_cur.grffile->canal_local_properties[id + i];
2140 
2141  switch (prop) {
2142  case 0x08:
2143  cp->callback_mask = buf->ReadByte();
2144  break;
2145 
2146  case 0x09:
2147  cp->flags = buf->ReadByte();
2148  break;
2149 
2150  default:
2151  ret = CIR_UNKNOWN;
2152  break;
2153  }
2154  }
2155 
2156  return ret;
2157 }
2158 
2167 static ChangeInfoResult BridgeChangeInfo(uint brid, int numinfo, int prop, ByteReader *buf)
2168 {
2170 
2171  if (brid + numinfo > MAX_BRIDGES) {
2172  grfmsg(1, "BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo, MAX_BRIDGES);
2173  return CIR_INVALID_ID;
2174  }
2175 
2176  for (int i = 0; i < numinfo; i++) {
2177  BridgeSpec *bridge = &_bridge[brid + i];
2178 
2179  switch (prop) {
2180  case 0x08: { // Year of availability
2181  /* We treat '0' as always available */
2182  byte year = buf->ReadByte();
2183  bridge->avail_year = (year > 0 ? ORIGINAL_BASE_YEAR + year : 0);
2184  break;
2185  }
2186 
2187  case 0x09: // Minimum length
2188  bridge->min_length = buf->ReadByte();
2189  break;
2190 
2191  case 0x0A: // Maximum length
2192  bridge->max_length = buf->ReadByte();
2193  if (bridge->max_length > 16) bridge->max_length = 0xFFFF;
2194  break;
2195 
2196  case 0x0B: // Cost factor
2197  bridge->price = buf->ReadByte();
2198  break;
2199 
2200  case 0x0C: // Maximum speed
2201  bridge->speed = buf->ReadWord();
2202  break;
2203 
2204  case 0x0D: { // Bridge sprite tables
2205  byte tableid = buf->ReadByte();
2206  byte numtables = buf->ReadByte();
2207 
2208  if (bridge->sprite_table == nullptr) {
2209  /* Allocate memory for sprite table pointers and zero out */
2210  bridge->sprite_table = CallocT<PalSpriteID*>(7);
2211  }
2212 
2213  for (; numtables-- != 0; tableid++) {
2214  if (tableid >= 7) { // skip invalid data
2215  grfmsg(1, "BridgeChangeInfo: Table %d >= 7, skipping", tableid);
2216  for (byte sprite = 0; sprite < 32; sprite++) buf->ReadDWord();
2217  continue;
2218  }
2219 
2220  if (bridge->sprite_table[tableid] == nullptr) {
2221  bridge->sprite_table[tableid] = MallocT<PalSpriteID>(32);
2222  }
2223 
2224  for (byte sprite = 0; sprite < 32; sprite++) {
2225  SpriteID image = buf->ReadWord();
2226  PaletteID pal = buf->ReadWord();
2227 
2228  bridge->sprite_table[tableid][sprite].sprite = image;
2229  bridge->sprite_table[tableid][sprite].pal = pal;
2230 
2231  MapSpriteMappingRecolour(&bridge->sprite_table[tableid][sprite]);
2232  }
2233  }
2234  break;
2235  }
2236 
2237  case 0x0E: // Flags; bit 0 - disable far pillars
2238  bridge->flags = buf->ReadByte();
2239  break;
2240 
2241  case 0x0F: // Long format year of availability (year since year 0)
2242  bridge->avail_year = Clamp(buf->ReadDWord(), MIN_YEAR, MAX_YEAR);
2243  break;
2244 
2245  case 0x10: { // purchase string
2246  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2247  if (newone != STR_UNDEFINED) bridge->material = newone;
2248  break;
2249  }
2250 
2251  case 0x11: // description of bridge with rails or roads
2252  case 0x12: {
2253  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2254  if (newone != STR_UNDEFINED) bridge->transport_name[prop - 0x11] = newone;
2255  break;
2256  }
2257 
2258  case 0x13: // 16 bits cost multiplier
2259  bridge->price = buf->ReadWord();
2260  break;
2261 
2262  default:
2263  ret = CIR_UNKNOWN;
2264  break;
2265  }
2266  }
2267 
2268  return ret;
2269 }
2270 
2278 {
2280 
2281  switch (prop) {
2282  case 0x09:
2283  case 0x0B:
2284  case 0x0C:
2285  case 0x0D:
2286  case 0x0E:
2287  case 0x0F:
2288  case 0x11:
2289  case 0x14:
2290  case 0x15:
2291  case 0x16:
2292  case 0x18:
2293  case 0x19:
2294  case 0x1A:
2295  case 0x1B:
2296  case 0x1C:
2297  case 0x1D:
2298  case 0x1F:
2299  buf->ReadByte();
2300  break;
2301 
2302  case 0x0A:
2303  case 0x10:
2304  case 0x12:
2305  case 0x13:
2306  case 0x21:
2307  case 0x22:
2308  buf->ReadWord();
2309  break;
2310 
2311  case 0x1E:
2312  buf->ReadDWord();
2313  break;
2314 
2315  case 0x17:
2316  for (uint j = 0; j < 4; j++) buf->ReadByte();
2317  break;
2318 
2319  case 0x20: {
2320  byte count = buf->ReadByte();
2321  for (byte j = 0; j < count; j++) buf->ReadByte();
2322  break;
2323  }
2324 
2325  case 0x23:
2326  buf->Skip(buf->ReadByte() * 2);
2327  break;
2328 
2329  default:
2330  ret = CIR_UNKNOWN;
2331  break;
2332  }
2333  return ret;
2334 }
2335 
2344 static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, ByteReader *buf)
2345 {
2347 
2348  if (hid + numinfo > NUM_HOUSES_PER_GRF) {
2349  grfmsg(1, "TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo, NUM_HOUSES_PER_GRF);
2350  return CIR_INVALID_ID;
2351  }
2352 
2353  /* Allocate house specs if they haven't been allocated already. */
2354  if (_cur.grffile->housespec == nullptr) {
2355  _cur.grffile->housespec = CallocT<HouseSpec*>(NUM_HOUSES_PER_GRF);
2356  }
2357 
2358  for (int i = 0; i < numinfo; i++) {
2359  HouseSpec *housespec = _cur.grffile->housespec[hid + i];
2360 
2361  if (prop != 0x08 && housespec == nullptr) {
2362  /* If the house property 08 is not yet set, ignore this property */
2363  ChangeInfoResult cir = IgnoreTownHouseProperty(prop, buf);
2364  if (cir > ret) ret = cir;
2365  continue;
2366  }
2367 
2368  switch (prop) {
2369  case 0x08: { // Substitute building type, and definition of a new house
2370  HouseSpec **house = &_cur.grffile->housespec[hid + i];
2371  byte subs_id = buf->ReadByte();
2372 
2373  if (subs_id == 0xFF) {
2374  /* Instead of defining a new house, a substitute house id
2375  * of 0xFF disables the old house with the current id. */
2376  HouseSpec::Get(hid + i)->enabled = false;
2377  continue;
2378  } else if (subs_id >= NEW_HOUSE_OFFSET) {
2379  /* The substitute id must be one of the original houses. */
2380  grfmsg(2, "TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i);
2381  continue;
2382  }
2383 
2384  /* Allocate space for this house. */
2385  if (*house == nullptr) *house = CallocT<HouseSpec>(1);
2386 
2387  housespec = *house;
2388 
2389  MemCpyT(housespec, HouseSpec::Get(subs_id));
2390 
2391  housespec->enabled = true;
2392  housespec->grf_prop.local_id = hid + i;
2393  housespec->grf_prop.subst_id = subs_id;
2394  housespec->grf_prop.grffile = _cur.grffile;
2395  housespec->random_colour[0] = 0x04; // those 4 random colours are the base colour
2396  housespec->random_colour[1] = 0x08; // for all new houses
2397  housespec->random_colour[2] = 0x0C; // they stand for red, blue, orange and green
2398  housespec->random_colour[3] = 0x06;
2399 
2400  /* Make sure that the third cargo type is valid in this
2401  * climate. This can cause problems when copying the properties
2402  * of a house that accepts food, where the new house is valid
2403  * in the temperate climate. */
2404  if (!CargoSpec::Get(housespec->accepts_cargo[2])->IsValid()) {
2405  housespec->cargo_acceptance[2] = 0;
2406  }
2407  break;
2408  }
2409 
2410  case 0x09: // Building flags
2411  housespec->building_flags = (BuildingFlags)buf->ReadByte();
2412  break;
2413 
2414  case 0x0A: { // Availability years
2415  uint16 years = buf->ReadWord();
2416  housespec->min_year = GB(years, 0, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 0, 8);
2417  housespec->max_year = GB(years, 8, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 8, 8);
2418  break;
2419  }
2420 
2421  case 0x0B: // Population
2422  housespec->population = buf->ReadByte();
2423  break;
2424 
2425  case 0x0C: // Mail generation multiplier
2426  housespec->mail_generation = buf->ReadByte();
2427  break;
2428 
2429  case 0x0D: // Passenger acceptance
2430  case 0x0E: // Mail acceptance
2431  housespec->cargo_acceptance[prop - 0x0D] = buf->ReadByte();
2432  break;
2433 
2434  case 0x0F: { // Goods/candy, food/fizzy drinks acceptance
2435  int8 goods = buf->ReadByte();
2436 
2437  /* If value of goods is negative, it means in fact food or, if in toyland, fizzy_drink acceptance.
2438  * Else, we have "standard" 3rd cargo type, goods or candy, for toyland once more */
2439  CargoID cid = (goods >= 0) ? ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_CANDY : CT_GOODS) :
2440  ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_FIZZY_DRINKS : CT_FOOD);
2441 
2442  /* Make sure the cargo type is valid in this climate. */
2443  if (!CargoSpec::Get(cid)->IsValid()) goods = 0;
2444 
2445  housespec->accepts_cargo[2] = cid;
2446  housespec->cargo_acceptance[2] = abs(goods); // but we do need positive value here
2447  break;
2448  }
2449 
2450  case 0x10: // Local authority rating decrease on removal
2451  housespec->remove_rating_decrease = buf->ReadWord();
2452  break;
2453 
2454  case 0x11: // Removal cost multiplier
2455  housespec->removal_cost = buf->ReadByte();
2456  break;
2457 
2458  case 0x12: // Building name ID
2459  AddStringForMapping(buf->ReadWord(), &housespec->building_name);
2460  break;
2461 
2462  case 0x13: // Building availability mask
2463  housespec->building_availability = (HouseZones)buf->ReadWord();
2464  break;
2465 
2466  case 0x14: // House callback mask
2467  housespec->callback_mask |= buf->ReadByte();
2468  break;
2469 
2470  case 0x15: { // House override byte
2471  byte override = buf->ReadByte();
2472 
2473  /* The house being overridden must be an original house. */
2474  if (override >= NEW_HOUSE_OFFSET) {
2475  grfmsg(2, "TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.", override, hid + i);
2476  continue;
2477  }
2478 
2479  _house_mngr.Add(hid + i, _cur.grffile->grfid, override);
2480  break;
2481  }
2482 
2483  case 0x16: // Periodic refresh multiplier
2484  housespec->processing_time = std::min<byte>(buf->ReadByte(), 63u);
2485  break;
2486 
2487  case 0x17: // Four random colours to use
2488  for (uint j = 0; j < 4; j++) housespec->random_colour[j] = buf->ReadByte();
2489  break;
2490 
2491  case 0x18: // Relative probability of appearing
2492  housespec->probability = buf->ReadByte();
2493  break;
2494 
2495  case 0x19: // Extra flags
2496  housespec->extra_flags = (HouseExtraFlags)buf->ReadByte();
2497  break;
2498 
2499  case 0x1A: // Animation frames
2500  housespec->animation.frames = buf->ReadByte();
2501  housespec->animation.status = GB(housespec->animation.frames, 7, 1);
2502  SB(housespec->animation.frames, 7, 1, 0);
2503  break;
2504 
2505  case 0x1B: // Animation speed
2506  housespec->animation.speed = Clamp(buf->ReadByte(), 2, 16);
2507  break;
2508 
2509  case 0x1C: // Class of the building type
2510  housespec->class_id = AllocateHouseClassID(buf->ReadByte(), _cur.grffile->grfid);
2511  break;
2512 
2513  case 0x1D: // Callback mask part 2
2514  housespec->callback_mask |= (buf->ReadByte() << 8);
2515  break;
2516 
2517  case 0x1E: { // Accepted cargo types
2518  uint32 cargotypes = buf->ReadDWord();
2519 
2520  /* Check if the cargo types should not be changed */
2521  if (cargotypes == 0xFFFFFFFF) break;
2522 
2523  for (uint j = 0; j < 3; j++) {
2524  /* Get the cargo number from the 'list' */
2525  uint8 cargo_part = GB(cargotypes, 8 * j, 8);
2526  CargoID cargo = GetCargoTranslation(cargo_part, _cur.grffile);
2527 
2528  if (cargo == CT_INVALID) {
2529  /* Disable acceptance of invalid cargo type */
2530  housespec->cargo_acceptance[j] = 0;
2531  } else {
2532  housespec->accepts_cargo[j] = cargo;
2533  }
2534  }
2535  break;
2536  }
2537 
2538  case 0x1F: // Minimum life span
2539  housespec->minimum_life = buf->ReadByte();
2540  break;
2541 
2542  case 0x20: { // Cargo acceptance watch list
2543  byte count = buf->ReadByte();
2544  for (byte j = 0; j < count; j++) {
2545  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
2546  if (cargo != CT_INVALID) SetBit(housespec->watched_cargoes, cargo);
2547  }
2548  break;
2549  }
2550 
2551  case 0x21: // long introduction year
2552  housespec->min_year = buf->ReadWord();
2553  break;
2554 
2555  case 0x22: // long maximum year
2556  housespec->max_year = buf->ReadWord();
2557  break;
2558 
2559  case 0x23: { // variable length cargo types accepted
2560  uint count = buf->ReadByte();
2561  if (count > lengthof(housespec->accepts_cargo)) {
2562  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
2563  error->param_value[1] = prop;
2564  return CIR_DISABLED;
2565  }
2566  /* Always write the full accepts_cargo array, and check each index for being inside the
2567  * provided data. This ensures all values are properly initialized, and also avoids
2568  * any risks of array overrun. */
2569  for (uint i = 0; i < lengthof(housespec->accepts_cargo); i++) {
2570  if (i < count) {
2571  housespec->accepts_cargo[i] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
2572  housespec->cargo_acceptance[i] = buf->ReadByte();
2573  } else {
2574  housespec->accepts_cargo[i] = CT_INVALID;
2575  housespec->cargo_acceptance[i] = 0;
2576  }
2577  }
2578  break;
2579  }
2580 
2581  default:
2582  ret = CIR_UNKNOWN;
2583  break;
2584  }
2585  }
2586 
2587  return ret;
2588 }
2589 
2596 /* static */ const LanguageMap *LanguageMap::GetLanguageMap(uint32 grfid, uint8 language_id)
2597 {
2598  /* LanguageID "MAX_LANG", i.e. 7F is any. This language can't have a gender/case mapping, but has to be handled gracefully. */
2599  const GRFFile *grffile = GetFileByGRFID(grfid);
2600  return (grffile != nullptr && grffile->language_map != nullptr && language_id < MAX_LANG) ? &grffile->language_map[language_id] : nullptr;
2601 }
2602 
2612 template <typename T>
2613 static ChangeInfoResult LoadTranslationTable(uint gvid, int numinfo, ByteReader *buf, T &translation_table, const char *name)
2614 {
2615  if (gvid != 0) {
2616  grfmsg(1, "LoadTranslationTable: %s translation table must start at zero", name);
2617  return CIR_INVALID_ID;
2618  }
2619 
2620  translation_table.clear();
2621  for (int i = 0; i < numinfo; i++) {
2622  uint32 item = buf->ReadDWord();
2623  translation_table.push_back(BSWAP32(item));
2624  }
2625 
2626  return CIR_SUCCESS;
2627 }
2628 
2635 static std::string ReadDWordAsString(ByteReader *reader)
2636 {
2637  char output[5];
2638  for (int i = 0; i < 4; i++) output[i] = reader->ReadByte();
2639  output[4] = '\0';
2640  StrMakeValidInPlace(output, lastof(output));
2641 
2642  return std::string(output);
2643 }
2644 
2653 static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
2654 {
2655  /* Properties which are handled as a whole */
2656  switch (prop) {
2657  case 0x09: // Cargo Translation Table; loading during both reservation and activation stage (in case it is selected depending on defined cargos)
2658  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->cargo_list, "Cargo");
2659 
2660  case 0x12: // Rail type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2661  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->railtype_list, "Rail type");
2662 
2663  case 0x16: // Road type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2664  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->roadtype_list, "Road type");
2665 
2666  case 0x17: // Tram type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2667  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->tramtype_list, "Tram type");
2668 
2669  default:
2670  break;
2671  }
2672 
2673  /* Properties which are handled per item */
2675  for (int i = 0; i < numinfo; i++) {
2676  switch (prop) {
2677  case 0x08: { // Cost base factor
2678  int factor = buf->ReadByte();
2679  uint price = gvid + i;
2680 
2681  if (price < PR_END) {
2682  _cur.grffile->price_base_multipliers[price] = std::min<int>(factor - 8, MAX_PRICE_MODIFIER);
2683  } else {
2684  grfmsg(1, "GlobalVarChangeInfo: Price %d out of range, ignoring", price);
2685  }
2686  break;
2687  }
2688 
2689  case 0x0A: { // Currency display names
2690  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2691  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2692 
2693  if ((newone != STR_UNDEFINED) && (curidx < CURRENCY_END)) {
2694  _currency_specs[curidx].name = newone;
2695  }
2696  break;
2697  }
2698 
2699  case 0x0B: { // Currency multipliers
2700  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2701  uint32 rate = buf->ReadDWord();
2702 
2703  if (curidx < CURRENCY_END) {
2704  /* TTDPatch uses a multiple of 1000 for its conversion calculations,
2705  * which OTTD does not. For this reason, divide grf value by 1000,
2706  * to be compatible */
2707  _currency_specs[curidx].rate = rate / 1000;
2708  } else {
2709  grfmsg(1, "GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx);
2710  }
2711  break;
2712  }
2713 
2714  case 0x0C: { // Currency options
2715  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2716  uint16 options = buf->ReadWord();
2717 
2718  if (curidx < CURRENCY_END) {
2719  _currency_specs[curidx].separator.clear();
2720  _currency_specs[curidx].separator.push_back(GB(options, 0, 8));
2721  /* By specifying only one bit, we prevent errors,
2722  * since newgrf specs said that only 0 and 1 can be set for symbol_pos */
2723  _currency_specs[curidx].symbol_pos = GB(options, 8, 1);
2724  } else {
2725  grfmsg(1, "GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx);
2726  }
2727  break;
2728  }
2729 
2730  case 0x0D: { // Currency prefix symbol
2731  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2732  std::string prefix = ReadDWordAsString(buf);
2733 
2734  if (curidx < CURRENCY_END) {
2735  _currency_specs[curidx].prefix = prefix;
2736  } else {
2737  grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2738  }
2739  break;
2740  }
2741 
2742  case 0x0E: { // Currency suffix symbol
2743  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2744  std::string suffix = ReadDWordAsString(buf);
2745 
2746  if (curidx < CURRENCY_END) {
2747  _currency_specs[curidx].suffix = suffix;
2748  } else {
2749  grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2750  }
2751  break;
2752  }
2753 
2754  case 0x0F: { // Euro introduction dates
2755  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2756  Year year_euro = buf->ReadWord();
2757 
2758  if (curidx < CURRENCY_END) {
2759  _currency_specs[curidx].to_euro = year_euro;
2760  } else {
2761  grfmsg(1, "GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx);
2762  }
2763  break;
2764  }
2765 
2766  case 0x10: // Snow line height table
2767  if (numinfo > 1 || IsSnowLineSet()) {
2768  grfmsg(1, "GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo);
2769  } else if (buf->Remaining() < SNOW_LINE_MONTHS * SNOW_LINE_DAYS) {
2770  grfmsg(1, "GlobalVarChangeInfo: Not enough entries set in the snowline table (" PRINTF_SIZE ")", buf->Remaining());
2771  } else {
2772  byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS];
2773 
2774  for (uint i = 0; i < SNOW_LINE_MONTHS; i++) {
2775  for (uint j = 0; j < SNOW_LINE_DAYS; j++) {
2776  table[i][j] = buf->ReadByte();
2777  if (_cur.grffile->grf_version >= 8) {
2778  if (table[i][j] != 0xFF) table[i][j] = table[i][j] * (1 + _settings_game.construction.map_height_limit) / 256;
2779  } else {
2780  if (table[i][j] >= 128) {
2781  /* no snow */
2782  table[i][j] = 0xFF;
2783  } else {
2784  table[i][j] = table[i][j] * (1 + _settings_game.construction.map_height_limit) / 128;
2785  }
2786  }
2787  }
2788  }
2789  SetSnowLine(table);
2790  }
2791  break;
2792 
2793  case 0x11: // GRF match for engine allocation
2794  /* This is loaded during the reservation stage, so just skip it here. */
2795  /* Each entry is 8 bytes. */
2796  buf->Skip(8);
2797  break;
2798 
2799  case 0x13: // Gender translation table
2800  case 0x14: // Case translation table
2801  case 0x15: { // Plural form translation
2802  uint curidx = gvid + i; // The current index, i.e. language.
2803  const LanguageMetadata *lang = curidx < MAX_LANG ? GetLanguage(curidx) : nullptr;
2804  if (lang == nullptr) {
2805  grfmsg(1, "GlobalVarChangeInfo: Language %d is not known, ignoring", curidx);
2806  /* Skip over the data. */
2807  if (prop == 0x15) {
2808  buf->ReadByte();
2809  } else {
2810  while (buf->ReadByte() != 0) {
2811  buf->ReadString();
2812  }
2813  }
2814  break;
2815  }
2816 
2817  if (_cur.grffile->language_map == nullptr) _cur.grffile->language_map = new LanguageMap[MAX_LANG];
2818 
2819  if (prop == 0x15) {
2820  uint plural_form = buf->ReadByte();
2821  if (plural_form >= LANGUAGE_MAX_PLURAL) {
2822  grfmsg(1, "GlobalVarChanceInfo: Plural form %d is out of range, ignoring", plural_form);
2823  } else {
2824  _cur.grffile->language_map[curidx].plural_form = plural_form;
2825  }
2826  break;
2827  }
2828 
2829  byte newgrf_id = buf->ReadByte(); // The NewGRF (custom) identifier.
2830  while (newgrf_id != 0) {
2831  const char *name = buf->ReadString(); // The name for the OpenTTD identifier.
2832 
2833  /* We'll just ignore the UTF8 identifier character. This is (fairly)
2834  * safe as OpenTTD's strings gender/cases are usually in ASCII which
2835  * is just a subset of UTF8, or they need the bigger UTF8 characters
2836  * such as Cyrillic. Thus we will simply assume they're all UTF8. */
2837  WChar c;
2838  size_t len = Utf8Decode(&c, name);
2839  if (c == NFO_UTF8_IDENTIFIER) name += len;
2840 
2842  map.newgrf_id = newgrf_id;
2843  if (prop == 0x13) {
2844  map.openttd_id = lang->GetGenderIndex(name);
2845  if (map.openttd_id >= MAX_NUM_GENDERS) {
2846  grfmsg(1, "GlobalVarChangeInfo: Gender name %s is not known, ignoring", name);
2847  } else {
2848  _cur.grffile->language_map[curidx].gender_map.push_back(map);
2849  }
2850  } else {
2851  map.openttd_id = lang->GetCaseIndex(name);
2852  if (map.openttd_id >= MAX_NUM_CASES) {
2853  grfmsg(1, "GlobalVarChangeInfo: Case name %s is not known, ignoring", name);
2854  } else {
2855  _cur.grffile->language_map[curidx].case_map.push_back(map);
2856  }
2857  }
2858  newgrf_id = buf->ReadByte();
2859  }
2860  break;
2861  }
2862 
2863  default:
2864  ret = CIR_UNKNOWN;
2865  break;
2866  }
2867  }
2868 
2869  return ret;
2870 }
2871 
2872 static ChangeInfoResult GlobalVarReserveInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
2873 {
2874  /* Properties which are handled as a whole */
2875  switch (prop) {
2876  case 0x09: // Cargo Translation Table; loading during both reservation and activation stage (in case it is selected depending on defined cargos)
2877  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->cargo_list, "Cargo");
2878 
2879  case 0x12: // Rail type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2880  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->railtype_list, "Rail type");
2881 
2882  case 0x16: // Road type translation table; loading during both reservation and activation stage (in case it is selected depending on defined roadtypes)
2883  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->roadtype_list, "Road type");
2884 
2885  case 0x17: // Tram type translation table; loading during both reservation and activation stage (in case it is selected depending on defined tramtypes)
2886  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->tramtype_list, "Tram type");
2887 
2888  default:
2889  break;
2890  }
2891 
2892  /* Properties which are handled per item */
2894  for (int i = 0; i < numinfo; i++) {
2895  switch (prop) {
2896  case 0x08: // Cost base factor
2897  case 0x15: // Plural form translation
2898  buf->ReadByte();
2899  break;
2900 
2901  case 0x0A: // Currency display names
2902  case 0x0C: // Currency options
2903  case 0x0F: // Euro introduction dates
2904  buf->ReadWord();
2905  break;
2906 
2907  case 0x0B: // Currency multipliers
2908  case 0x0D: // Currency prefix symbol
2909  case 0x0E: // Currency suffix symbol
2910  buf->ReadDWord();
2911  break;
2912 
2913  case 0x10: // Snow line height table
2914  buf->Skip(SNOW_LINE_MONTHS * SNOW_LINE_DAYS);
2915  break;
2916 
2917  case 0x11: { // GRF match for engine allocation
2918  uint32 s = buf->ReadDWord();
2919  uint32 t = buf->ReadDWord();
2920  SetNewGRFOverride(s, t);
2921  break;
2922  }
2923 
2924  case 0x13: // Gender translation table
2925  case 0x14: // Case translation table
2926  while (buf->ReadByte() != 0) {
2927  buf->ReadString();
2928  }
2929  break;
2930 
2931  default:
2932  ret = CIR_UNKNOWN;
2933  break;
2934  }
2935  }
2936 
2937  return ret;
2938 }
2939 
2940 
2949 static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, ByteReader *buf)
2950 {
2952 
2953  if (cid + numinfo > NUM_CARGO) {
2954  grfmsg(2, "CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo, NUM_CARGO - 1);
2955  return CIR_INVALID_ID;
2956  }
2957 
2958  for (int i = 0; i < numinfo; i++) {
2959  CargoSpec *cs = CargoSpec::Get(cid + i);
2960 
2961  switch (prop) {
2962  case 0x08: // Bit number of cargo
2963  cs->bitnum = buf->ReadByte();
2964  if (cs->IsValid()) {
2965  cs->grffile = _cur.grffile;
2966  SetBit(_cargo_mask, cid + i);
2967  } else {
2968  ClrBit(_cargo_mask, cid + i);
2969  }
2970  break;
2971 
2972  case 0x09: // String ID for cargo type name
2973  AddStringForMapping(buf->ReadWord(), &cs->name);
2974  break;
2975 
2976  case 0x0A: // String for 1 unit of cargo
2977  AddStringForMapping(buf->ReadWord(), &cs->name_single);
2978  break;
2979 
2980  case 0x0B: // String for singular quantity of cargo (e.g. 1 tonne of coal)
2981  case 0x1B: // String for cargo units
2982  /* String for units of cargo. This is different in OpenTTD
2983  * (e.g. tonnes) to TTDPatch (e.g. {COMMA} tonne of coal).
2984  * Property 1B is used to set OpenTTD's behaviour. */
2985  AddStringForMapping(buf->ReadWord(), &cs->units_volume);
2986  break;
2987 
2988  case 0x0C: // String for plural quantity of cargo (e.g. 10 tonnes of coal)
2989  case 0x1C: // String for any amount of cargo
2990  /* Strings for an amount of cargo. This is different in OpenTTD
2991  * (e.g. {WEIGHT} of coal) to TTDPatch (e.g. {COMMA} tonnes of coal).
2992  * Property 1C is used to set OpenTTD's behaviour. */
2993  AddStringForMapping(buf->ReadWord(), &cs->quantifier);
2994  break;
2995 
2996  case 0x0D: // String for two letter cargo abbreviation
2997  AddStringForMapping(buf->ReadWord(), &cs->abbrev);
2998  break;
2999 
3000  case 0x0E: // Sprite ID for cargo icon
3001  cs->sprite = buf->ReadWord();
3002  break;
3003 
3004  case 0x0F: // Weight of one unit of cargo
3005  cs->weight = buf->ReadByte();
3006  break;
3007 
3008  case 0x10: // Used for payment calculation
3009  cs->transit_days[0] = buf->ReadByte();
3010  break;
3011 
3012  case 0x11: // Used for payment calculation
3013  cs->transit_days[1] = buf->ReadByte();
3014  break;
3015 
3016  case 0x12: // Base cargo price
3017  cs->initial_payment = buf->ReadDWord();
3018  break;
3019 
3020  case 0x13: // Colour for station rating bars
3021  cs->rating_colour = buf->ReadByte();
3022  break;
3023 
3024  case 0x14: // Colour for cargo graph
3025  cs->legend_colour = buf->ReadByte();
3026  break;
3027 
3028  case 0x15: // Freight status
3029  cs->is_freight = (buf->ReadByte() != 0);
3030  break;
3031 
3032  case 0x16: // Cargo classes
3033  cs->classes = buf->ReadWord();
3034  break;
3035 
3036  case 0x17: // Cargo label
3037  cs->label = buf->ReadDWord();
3038  cs->label = BSWAP32(cs->label);
3039  break;
3040 
3041  case 0x18: { // Town growth substitute type
3042  uint8 substitute_type = buf->ReadByte();
3043 
3044  switch (substitute_type) {
3045  case 0x00: cs->town_effect = TE_PASSENGERS; break;
3046  case 0x02: cs->town_effect = TE_MAIL; break;
3047  case 0x05: cs->town_effect = TE_GOODS; break;
3048  case 0x09: cs->town_effect = TE_WATER; break;
3049  case 0x0B: cs->town_effect = TE_FOOD; break;
3050  default:
3051  grfmsg(1, "CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type);
3052  FALLTHROUGH;
3053  case 0xFF: cs->town_effect = TE_NONE; break;
3054  }
3055  break;
3056  }
3057 
3058  case 0x19: // Town growth coefficient
3059  buf->ReadWord();
3060  break;
3061 
3062  case 0x1A: // Bitmask of callbacks to use
3063  cs->callback_mask = buf->ReadByte();
3064  break;
3065 
3066  case 0x1D: // Vehicle capacity muliplier
3067  cs->multiplier = std::max<uint16>(1u, buf->ReadWord());
3068  break;
3069 
3070  default:
3071  ret = CIR_UNKNOWN;
3072  break;
3073  }
3074  }
3075 
3076  return ret;
3077 }
3078 
3079 
3088 static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, ByteReader *buf)
3089 {
3091 
3092  if (_cur.grffile->sound_offset == 0) {
3093  grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping");
3094  return CIR_INVALID_ID;
3095  }
3096 
3097  if (sid + numinfo - ORIGINAL_SAMPLE_COUNT > _cur.grffile->num_sounds) {
3098  grfmsg(1, "SoundEffectChangeInfo: Attempting to change undefined sound effect (%u), max (%u). Ignoring.", sid + numinfo, ORIGINAL_SAMPLE_COUNT + _cur.grffile->num_sounds);
3099  return CIR_INVALID_ID;
3100  }
3101 
3102  for (int i = 0; i < numinfo; i++) {
3103  SoundEntry *sound = GetSound(sid + i + _cur.grffile->sound_offset - ORIGINAL_SAMPLE_COUNT);
3104 
3105  switch (prop) {
3106  case 0x08: // Relative volume
3107  sound->volume = buf->ReadByte();
3108  break;
3109 
3110  case 0x09: // Priority
3111  sound->priority = buf->ReadByte();
3112  break;
3113 
3114  case 0x0A: { // Override old sound
3115  SoundID orig_sound = buf->ReadByte();
3116 
3117  if (orig_sound >= ORIGINAL_SAMPLE_COUNT) {
3118  grfmsg(1, "SoundEffectChangeInfo: Original sound %d not defined (max %d)", orig_sound, ORIGINAL_SAMPLE_COUNT);
3119  } else {
3120  SoundEntry *old_sound = GetSound(orig_sound);
3121 
3122  /* Literally copy the data of the new sound over the original */
3123  *old_sound = *sound;
3124  }
3125  break;
3126  }
3127 
3128  default:
3129  ret = CIR_UNKNOWN;
3130  break;
3131  }
3132  }
3133 
3134  return ret;
3135 }
3136 
3144 {
3146 
3147  switch (prop) {
3148  case 0x09:
3149  case 0x0D:
3150  case 0x0E:
3151  case 0x10:
3152  case 0x11:
3153  case 0x12:
3154  buf->ReadByte();
3155  break;
3156 
3157  case 0x0A:
3158  case 0x0B:
3159  case 0x0C:
3160  case 0x0F:
3161  buf->ReadWord();
3162  break;
3163 
3164  case 0x13:
3165  buf->Skip(buf->ReadByte() * 2);
3166  break;
3167 
3168  default:
3169  ret = CIR_UNKNOWN;
3170  break;
3171  }
3172  return ret;
3173 }
3174 
3183 static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, ByteReader *buf)
3184 {
3186 
3187  if (indtid + numinfo > NUM_INDUSTRYTILES_PER_GRF) {
3188  grfmsg(1, "IndustryTilesChangeInfo: Too many industry tiles loaded (%u), max (%u). Ignoring.", indtid + numinfo, NUM_INDUSTRYTILES_PER_GRF);
3189  return CIR_INVALID_ID;
3190  }
3191 
3192  /* Allocate industry tile specs if they haven't been allocated already. */
3193  if (_cur.grffile->indtspec == nullptr) {
3194  _cur.grffile->indtspec = CallocT<IndustryTileSpec*>(NUM_INDUSTRYTILES_PER_GRF);
3195  }
3196 
3197  for (int i = 0; i < numinfo; i++) {
3198  IndustryTileSpec *tsp = _cur.grffile->indtspec[indtid + i];
3199 
3200  if (prop != 0x08 && tsp == nullptr) {
3202  if (cir > ret) ret = cir;
3203  continue;
3204  }
3205 
3206  switch (prop) {
3207  case 0x08: { // Substitute industry tile type
3208  IndustryTileSpec **tilespec = &_cur.grffile->indtspec[indtid + i];
3209  byte subs_id = buf->ReadByte();
3210 
3211  if (subs_id >= NEW_INDUSTRYTILEOFFSET) {
3212  /* The substitute id must be one of the original industry tile. */
3213  grfmsg(2, "IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i);
3214  continue;
3215  }
3216 
3217  /* Allocate space for this industry. */
3218  if (*tilespec == nullptr) {
3219  *tilespec = CallocT<IndustryTileSpec>(1);
3220  tsp = *tilespec;
3221 
3222  memcpy(tsp, &_industry_tile_specs[subs_id], sizeof(_industry_tile_specs[subs_id]));
3223  tsp->enabled = true;
3224 
3225  /* A copied tile should not have the animation infos copied too.
3226  * The anim_state should be left untouched, though
3227  * It is up to the author to animate them */
3230 
3231  tsp->grf_prop.local_id = indtid + i;
3232  tsp->grf_prop.subst_id = subs_id;
3233  tsp->grf_prop.grffile = _cur.grffile;
3234  _industile_mngr.AddEntityID(indtid + i, _cur.grffile->grfid, subs_id); // pre-reserve the tile slot
3235  }
3236  break;
3237  }
3238 
3239  case 0x09: { // Industry tile override
3240  byte ovrid = buf->ReadByte();
3241 
3242  /* The industry being overridden must be an original industry. */
3243  if (ovrid >= NEW_INDUSTRYTILEOFFSET) {
3244  grfmsg(2, "IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i);
3245  continue;
3246  }
3247 
3248  _industile_mngr.Add(indtid + i, _cur.grffile->grfid, ovrid);
3249  break;
3250  }
3251 
3252  case 0x0A: // Tile acceptance
3253  case 0x0B:
3254  case 0x0C: {
3255  uint16 acctp = buf->ReadWord();
3256  tsp->accepts_cargo[prop - 0x0A] = GetCargoTranslation(GB(acctp, 0, 8), _cur.grffile);
3257  tsp->acceptance[prop - 0x0A] = Clamp(GB(acctp, 8, 8), 0, 16);
3258  break;
3259  }
3260 
3261  case 0x0D: // Land shape flags
3262  tsp->slopes_refused = (Slope)buf->ReadByte();
3263  break;
3264 
3265  case 0x0E: // Callback mask
3266  tsp->callback_mask = buf->ReadByte();
3267  break;
3268 
3269  case 0x0F: // Animation information
3270  tsp->animation.frames = buf->ReadByte();
3271  tsp->animation.status = buf->ReadByte();
3272  break;
3273 
3274  case 0x10: // Animation speed
3275  tsp->animation.speed = buf->ReadByte();
3276  break;
3277 
3278  case 0x11: // Triggers for callback 25
3279  tsp->animation.triggers = buf->ReadByte();
3280  break;
3281 
3282  case 0x12: // Special flags
3283  tsp->special_flags = (IndustryTileSpecialFlags)buf->ReadByte();
3284  break;
3285 
3286  case 0x13: { // variable length cargo acceptance
3287  byte num_cargoes = buf->ReadByte();
3288  if (num_cargoes > lengthof(tsp->acceptance)) {
3289  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3290  error->param_value[1] = prop;
3291  return CIR_DISABLED;
3292  }
3293  for (uint i = 0; i < lengthof(tsp->acceptance); i++) {
3294  if (i < num_cargoes) {
3295  tsp->accepts_cargo[i] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3296  /* Tile acceptance can be negative to counteract the INDTILE_SPECIAL_ACCEPTS_ALL_CARGO flag */
3297  tsp->acceptance[i] = (int8)buf->ReadByte();
3298  } else {
3299  tsp->accepts_cargo[i] = CT_INVALID;
3300  tsp->acceptance[i] = 0;
3301  }
3302  }
3303  break;
3304  }
3305 
3306  default:
3307  ret = CIR_UNKNOWN;
3308  break;
3309  }
3310  }
3311 
3312  return ret;
3313 }
3314 
3322 {
3324 
3325  switch (prop) {
3326  case 0x09:
3327  case 0x0B:
3328  case 0x0F:
3329  case 0x12:
3330  case 0x13:
3331  case 0x14:
3332  case 0x17:
3333  case 0x18:
3334  case 0x19:
3335  case 0x21:
3336  case 0x22:
3337  buf->ReadByte();
3338  break;
3339 
3340  case 0x0C:
3341  case 0x0D:
3342  case 0x0E:
3343  case 0x10:
3344  case 0x1B:
3345  case 0x1F:
3346  case 0x24:
3347  buf->ReadWord();
3348  break;
3349 
3350  case 0x11:
3351  case 0x1A:
3352  case 0x1C:
3353  case 0x1D:
3354  case 0x1E:
3355  case 0x20:
3356  case 0x23:
3357  buf->ReadDWord();
3358  break;
3359 
3360  case 0x0A: {
3361  byte num_table = buf->ReadByte();
3362  for (byte j = 0; j < num_table; j++) {
3363  for (uint k = 0;; k++) {
3364  byte x = buf->ReadByte();
3365  if (x == 0xFE && k == 0) {
3366  buf->ReadByte();
3367  buf->ReadByte();
3368  break;
3369  }
3370 
3371  byte y = buf->ReadByte();
3372  if (x == 0 && y == 0x80) break;
3373 
3374  byte gfx = buf->ReadByte();
3375  if (gfx == 0xFE) buf->ReadWord();
3376  }
3377  }
3378  break;
3379  }
3380 
3381  case 0x16:
3382  for (byte j = 0; j < 3; j++) buf->ReadByte();
3383  break;
3384 
3385  case 0x15:
3386  case 0x25:
3387  case 0x26:
3388  case 0x27:
3389  buf->Skip(buf->ReadByte());
3390  break;
3391 
3392  case 0x28: {
3393  int num_inputs = buf->ReadByte();
3394  int num_outputs = buf->ReadByte();
3395  buf->Skip(num_inputs * num_outputs * 2);
3396  break;
3397  }
3398 
3399  default:
3400  ret = CIR_UNKNOWN;
3401  break;
3402  }
3403  return ret;
3404 }
3405 
3411 static bool ValidateIndustryLayout(const IndustryTileLayout &layout)
3412 {
3413  const size_t size = layout.size();
3414  if (size == 0) return false;
3415 
3416  for (size_t i = 0; i < size - 1; i++) {
3417  for (size_t j = i + 1; j < size; j++) {
3418  if (layout[i].ti.x == layout[j].ti.x &&
3419  layout[i].ti.y == layout[j].ti.y) {
3420  return false;
3421  }
3422  }
3423  }
3424 
3425  bool have_regular_tile = false;
3426  for (size_t i = 0; i < size; i++) {
3427  if (layout[i].gfx != GFX_WATERTILE_SPECIALCHECK) {
3428  have_regular_tile = true;
3429  break;
3430  }
3431  }
3432 
3433  return have_regular_tile;
3434 }
3435 
3444 static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, ByteReader *buf)
3445 {
3447 
3448  if (indid + numinfo > NUM_INDUSTRYTYPES_PER_GRF) {
3449  grfmsg(1, "IndustriesChangeInfo: Too many industries loaded (%u), max (%u). Ignoring.", indid + numinfo, NUM_INDUSTRYTYPES_PER_GRF);
3450  return CIR_INVALID_ID;
3451  }
3452 
3453  /* Allocate industry specs if they haven't been allocated already. */
3454  if (_cur.grffile->industryspec == nullptr) {
3455  _cur.grffile->industryspec = CallocT<IndustrySpec*>(NUM_INDUSTRYTYPES_PER_GRF);
3456  }
3457 
3458  for (int i = 0; i < numinfo; i++) {
3459  IndustrySpec *indsp = _cur.grffile->industryspec[indid + i];
3460 
3461  if (prop != 0x08 && indsp == nullptr) {
3462  ChangeInfoResult cir = IgnoreIndustryProperty(prop, buf);
3463  if (cir > ret) ret = cir;
3464  continue;
3465  }
3466 
3467  switch (prop) {
3468  case 0x08: { // Substitute industry type
3469  IndustrySpec **indspec = &_cur.grffile->industryspec[indid + i];
3470  byte subs_id = buf->ReadByte();
3471 
3472  if (subs_id == 0xFF) {
3473  /* Instead of defining a new industry, a substitute industry id
3474  * of 0xFF disables the old industry with the current id. */
3475  _industry_specs[indid + i].enabled = false;
3476  continue;
3477  } else if (subs_id >= NEW_INDUSTRYOFFSET) {
3478  /* The substitute id must be one of the original industry. */
3479  grfmsg(2, "_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i);
3480  continue;
3481  }
3482 
3483  /* Allocate space for this industry.
3484  * Only need to do it once. If ever it is called again, it should not
3485  * do anything */
3486  if (*indspec == nullptr) {
3487  *indspec = new IndustrySpec;
3488  indsp = *indspec;
3489 
3490  *indsp = _origin_industry_specs[subs_id];
3491  indsp->enabled = true;
3492  indsp->grf_prop.local_id = indid + i;
3493  indsp->grf_prop.subst_id = subs_id;
3494  indsp->grf_prop.grffile = _cur.grffile;
3495  /* If the grf industry needs to check its surrounding upon creation, it should
3496  * rely on callbacks, not on the original placement functions */
3497  indsp->check_proc = CHECK_NOTHING;
3498  }
3499  break;
3500  }
3501 
3502  case 0x09: { // Industry type override
3503  byte ovrid = buf->ReadByte();
3504 
3505  /* The industry being overridden must be an original industry. */
3506  if (ovrid >= NEW_INDUSTRYOFFSET) {
3507  grfmsg(2, "IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i);
3508  continue;
3509  }
3510  indsp->grf_prop.override = ovrid;
3511  _industry_mngr.Add(indid + i, _cur.grffile->grfid, ovrid);
3512  break;
3513  }
3514 
3515  case 0x0A: { // Set industry layout(s)
3516  byte new_num_layouts = buf->ReadByte();
3517  uint32 definition_size = buf->ReadDWord();
3518  uint32 bytes_read = 0;
3519  std::vector<IndustryTileLayout> new_layouts;
3520  IndustryTileLayout layout;
3521 
3522  for (byte j = 0; j < new_num_layouts; j++) {
3523  layout.clear();
3524 
3525  for (uint k = 0;; k++) {
3526  if (bytes_read >= definition_size) {
3527  grfmsg(3, "IndustriesChangeInfo: Incorrect size for industry tile layout definition for industry %u.", indid);
3528  /* Avoid warning twice */
3529  definition_size = UINT32_MAX;
3530  }
3531 
3532  layout.push_back(IndustryTileLayoutTile{});
3533  IndustryTileLayoutTile &it = layout.back();
3534 
3535  it.ti.x = buf->ReadByte(); // Offsets from northermost tile
3536  ++bytes_read;
3537 
3538  if (it.ti.x == 0xFE && k == 0) {
3539  /* This means we have to borrow the layout from an old industry */
3540  IndustryType type = buf->ReadByte();
3541  byte laynbr = buf->ReadByte();
3542  bytes_read += 2;
3543 
3544  if (type >= lengthof(_origin_industry_specs)) {
3545  grfmsg(1, "IndustriesChangeInfo: Invalid original industry number for layout import, industry %u", indid);
3546  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
3547  return CIR_DISABLED;
3548  }
3549  if (laynbr >= _origin_industry_specs[type].layouts.size()) {
3550  grfmsg(1, "IndustriesChangeInfo: Invalid original industry layout index for layout import, industry %u", indid);
3551  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
3552  return CIR_DISABLED;
3553  }
3554  layout = _origin_industry_specs[type].layouts[laynbr];
3555  break;
3556  }
3557 
3558  it.ti.y = buf->ReadByte(); // Or table definition finalisation
3559  ++bytes_read;
3560 
3561  if (it.ti.x == 0 && it.ti.y == 0x80) {
3562  /* Terminator, remove and finish up */
3563  layout.pop_back();
3564  break;
3565  }
3566 
3567  it.gfx = buf->ReadByte();
3568  ++bytes_read;
3569 
3570  if (it.gfx == 0xFE) {
3571  /* Use a new tile from this GRF */
3572  int local_tile_id = buf->ReadWord();
3573  bytes_read += 2;
3574 
3575  /* Read the ID from the _industile_mngr. */
3576  int tempid = _industile_mngr.GetID(local_tile_id, _cur.grffile->grfid);
3577 
3578  if (tempid == INVALID_INDUSTRYTILE) {
3579  grfmsg(2, "IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid);
3580  } else {
3581  /* Declared as been valid, can be used */
3582  it.gfx = tempid;
3583  }
3584  } else if (it.gfx == GFX_WATERTILE_SPECIALCHECK) {
3585  it.ti.x = (int8)GB(it.ti.x, 0, 8);
3586  it.ti.y = (int8)GB(it.ti.y, 0, 8);
3587 
3588  /* When there were only 256x256 maps, TileIndex was a uint16 and
3589  * it.ti was just a TileIndexDiff that was added to it.
3590  * As such negative "x" values were shifted into the "y" position.
3591  * x = -1, y = 1 -> x = 255, y = 0
3592  * Since GRF version 8 the position is interpreted as pair of independent int8.
3593  * For GRF version < 8 we need to emulate the old shifting behaviour.
3594  */
3595  if (_cur.grffile->grf_version < 8 && it.ti.x < 0) it.ti.y += 1;
3596  }
3597  }
3598 
3599  if (!ValidateIndustryLayout(layout)) {
3600  /* The industry layout was not valid, so skip this one. */
3601  grfmsg(1, "IndustriesChangeInfo: Invalid industry layout for industry id %u. Ignoring", indid);
3602  new_num_layouts--;
3603  j--;
3604  } else {
3605  new_layouts.push_back(layout);
3606  }
3607  }
3608 
3609  /* Install final layout construction in the industry spec */
3610  indsp->layouts = new_layouts;
3611  break;
3612  }
3613 
3614  case 0x0B: // Industry production flags
3615  indsp->life_type = (IndustryLifeType)buf->ReadByte();
3616  break;
3617 
3618  case 0x0C: // Industry closure message
3619  AddStringForMapping(buf->ReadWord(), &indsp->closure_text);
3620  break;
3621 
3622  case 0x0D: // Production increase message
3623  AddStringForMapping(buf->ReadWord(), &indsp->production_up_text);
3624  break;
3625 
3626  case 0x0E: // Production decrease message
3627  AddStringForMapping(buf->ReadWord(), &indsp->production_down_text);
3628  break;
3629 
3630  case 0x0F: // Fund cost multiplier
3631  indsp->cost_multiplier = buf->ReadByte();
3632  break;
3633 
3634  case 0x10: // Production cargo types
3635  for (byte j = 0; j < 2; j++) {
3636  indsp->produced_cargo[j] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3637  }
3638  break;
3639 
3640  case 0x11: // Acceptance cargo types
3641  for (byte j = 0; j < 3; j++) {
3642  indsp->accepts_cargo[j] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3643  }
3644  buf->ReadByte(); // Unnused, eat it up
3645  break;
3646 
3647  case 0x12: // Production multipliers
3648  case 0x13:
3649  indsp->production_rate[prop - 0x12] = buf->ReadByte();
3650  break;
3651 
3652  case 0x14: // Minimal amount of cargo distributed
3653  indsp->minimal_cargo = buf->ReadByte();
3654  break;
3655 
3656  case 0x15: { // Random sound effects
3657  indsp->number_of_sounds = buf->ReadByte();
3658  uint8 *sounds = MallocT<uint8>(indsp->number_of_sounds);
3659 
3660  try {
3661  for (uint8 j = 0; j < indsp->number_of_sounds; j++) {
3662  sounds[j] = buf->ReadByte();
3663  }
3664  } catch (...) {
3665  free(sounds);
3666  throw;
3667  }
3668 
3669  if (HasBit(indsp->cleanup_flag, CLEAN_RANDOMSOUNDS)) {
3670  free(indsp->random_sounds);
3671  }
3672  indsp->random_sounds = sounds;
3674  break;
3675  }
3676 
3677  case 0x16: // Conflicting industry types
3678  for (byte j = 0; j < 3; j++) indsp->conflicting[j] = buf->ReadByte();
3679  break;
3680 
3681  case 0x17: // Probability in random game
3682  indsp->appear_creation[_settings_game.game_creation.landscape] = buf->ReadByte();
3683  break;
3684 
3685  case 0x18: // Probability during gameplay
3686  indsp->appear_ingame[_settings_game.game_creation.landscape] = buf->ReadByte();
3687  break;
3688 
3689  case 0x19: // Map colour
3690  indsp->map_colour = buf->ReadByte();
3691  break;
3692 
3693  case 0x1A: // Special industry flags to define special behavior
3694  indsp->behaviour = (IndustryBehaviour)buf->ReadDWord();
3695  break;
3696 
3697  case 0x1B: // New industry text ID
3698  AddStringForMapping(buf->ReadWord(), &indsp->new_industry_text);
3699  break;
3700 
3701  case 0x1C: // Input cargo multipliers for the three input cargo types
3702  case 0x1D:
3703  case 0x1E: {
3704  uint32 multiples = buf->ReadDWord();
3705  indsp->input_cargo_multiplier[prop - 0x1C][0] = GB(multiples, 0, 16);
3706  indsp->input_cargo_multiplier[prop - 0x1C][1] = GB(multiples, 16, 16);
3707  break;
3708  }
3709 
3710  case 0x1F: // Industry name
3711  AddStringForMapping(buf->ReadWord(), &indsp->name);
3712  break;
3713 
3714  case 0x20: // Prospecting success chance
3715  indsp->prospecting_chance = buf->ReadDWord();
3716  break;
3717 
3718  case 0x21: // Callback mask
3719  case 0x22: { // Callback additional mask
3720  byte aflag = buf->ReadByte();
3721  SB(indsp->callback_mask, (prop - 0x21) * 8, 8, aflag);
3722  break;
3723  }
3724 
3725  case 0x23: // removal cost multiplier
3726  indsp->removal_cost_multiplier = buf->ReadDWord();
3727  break;
3728 
3729  case 0x24: { // name for nearby station
3730  uint16 str = buf->ReadWord();
3731  if (str == 0) {
3732  indsp->station_name = STR_NULL;
3733  } else {
3734  AddStringForMapping(str, &indsp->station_name);
3735  }
3736  break;
3737  }
3738 
3739  case 0x25: { // variable length produced cargoes
3740  byte num_cargoes = buf->ReadByte();
3741  if (num_cargoes > lengthof(indsp->produced_cargo)) {
3742  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3743  error->param_value[1] = prop;
3744  return CIR_DISABLED;
3745  }
3746  for (uint i = 0; i < lengthof(indsp->produced_cargo); i++) {
3747  if (i < num_cargoes) {
3748  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3749  indsp->produced_cargo[i] = cargo;
3750  } else {
3751  indsp->produced_cargo[i] = CT_INVALID;
3752  }
3753  }
3754  break;
3755  }
3756 
3757  case 0x26: { // variable length accepted cargoes
3758  byte num_cargoes = buf->ReadByte();
3759  if (num_cargoes > lengthof(indsp->accepts_cargo)) {
3760  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3761  error->param_value[1] = prop;
3762  return CIR_DISABLED;
3763  }
3764  for (uint i = 0; i < lengthof(indsp->accepts_cargo); i++) {
3765  if (i < num_cargoes) {
3766  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3767  indsp->accepts_cargo[i] = cargo;
3768  } else {
3769  indsp->accepts_cargo[i] = CT_INVALID;
3770  }
3771  }
3772  break;
3773  }
3774 
3775  case 0x27: { // variable length production rates
3776  byte num_cargoes = buf->ReadByte();
3777  if (num_cargoes > lengthof(indsp->production_rate)) {
3778  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3779  error->param_value[1] = prop;
3780  return CIR_DISABLED;
3781  }
3782  for (uint i = 0; i < lengthof(indsp->production_rate); i++) {
3783  if (i < num_cargoes) {
3784  indsp->production_rate[i] = buf->ReadByte();
3785  } else {
3786  indsp->production_rate[i] = 0;
3787  }
3788  }
3789  break;
3790  }
3791 
3792  case 0x28: { // variable size input/output production multiplier table
3793  byte num_inputs = buf->ReadByte();
3794  byte num_outputs = buf->ReadByte();
3795  if (num_inputs > lengthof(indsp->accepts_cargo) || num_outputs > lengthof(indsp->produced_cargo)) {
3796  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3797  error->param_value[1] = prop;
3798  return CIR_DISABLED;
3799  }
3800  for (uint i = 0; i < lengthof(indsp->accepts_cargo); i++) {
3801  for (uint j = 0; j < lengthof(indsp->produced_cargo); j++) {
3802  uint16 mult = 0;
3803  if (i < num_inputs && j < num_outputs) mult = buf->ReadWord();
3804  indsp->input_cargo_multiplier[i][j] = mult;
3805  }
3806  }
3807  break;
3808  }
3809 
3810  default:
3811  ret = CIR_UNKNOWN;
3812  break;
3813  }
3814  }
3815 
3816  return ret;
3817 }
3818 
3825 {
3826  AirportTileTable **table_list = MallocT<AirportTileTable*>(as->num_table);
3827  for (int i = 0; i < as->num_table; i++) {
3828  uint num_tiles = 1;
3829  const AirportTileTable *it = as->table[0];
3830  do {
3831  num_tiles++;
3832  } while ((++it)->ti.x != -0x80);
3833  table_list[i] = MallocT<AirportTileTable>(num_tiles);
3834  MemCpyT(table_list[i], as->table[i], num_tiles);
3835  }
3836  as->table = table_list;
3837  HangarTileTable *depot_table = MallocT<HangarTileTable>(as->nof_depots);
3838  MemCpyT(depot_table, as->depot_table, as->nof_depots);
3839  as->depot_table = depot_table;
3840  Direction *rotation = MallocT<Direction>(as->num_table);
3841  MemCpyT(rotation, as->rotation, as->num_table);
3842  as->rotation = rotation;
3843 }
3844 
3853 static ChangeInfoResult AirportChangeInfo(uint airport, int numinfo, int prop, ByteReader *buf)
3854 {
3856 
3857  if (airport + numinfo > NUM_AIRPORTS_PER_GRF) {
3858  grfmsg(1, "AirportChangeInfo: Too many airports, trying id (%u), max (%u). Ignoring.", airport + numinfo, NUM_AIRPORTS_PER_GRF);
3859  return CIR_INVALID_ID;
3860  }
3861 
3862  /* Allocate industry specs if they haven't been allocated already. */
3863  if (_cur.grffile->airportspec == nullptr) {
3864  _cur.grffile->airportspec = CallocT<AirportSpec*>(NUM_AIRPORTS_PER_GRF);
3865  }
3866 
3867  for (int i = 0; i < numinfo; i++) {
3868  AirportSpec *as = _cur.grffile->airportspec[airport + i];
3869 
3870  if (as == nullptr && prop != 0x08 && prop != 0x09) {
3871  grfmsg(2, "AirportChangeInfo: Attempt to modify undefined airport %u, ignoring", airport + i);
3872  return CIR_INVALID_ID;
3873  }
3874 
3875  switch (prop) {
3876  case 0x08: { // Modify original airport
3877  byte subs_id = buf->ReadByte();
3878 
3879  if (subs_id == 0xFF) {
3880  /* Instead of defining a new airport, an airport id
3881  * of 0xFF disables the old airport with the current id. */
3882  AirportSpec::GetWithoutOverride(airport + i)->enabled = false;
3883  continue;
3884  } else if (subs_id >= NEW_AIRPORT_OFFSET) {
3885  /* The substitute id must be one of the original airports. */
3886  grfmsg(2, "AirportChangeInfo: Attempt to use new airport %u as substitute airport for %u. Ignoring.", subs_id, airport + i);
3887  continue;
3888  }
3889 
3890  AirportSpec **spec = &_cur.grffile->airportspec[airport + i];
3891  /* Allocate space for this airport.
3892  * Only need to do it once. If ever it is called again, it should not
3893  * do anything */
3894  if (*spec == nullptr) {
3895  *spec = MallocT<AirportSpec>(1);
3896  as = *spec;
3897 
3898  memcpy(as, AirportSpec::GetWithoutOverride(subs_id), sizeof(*as));
3899  as->enabled = true;
3900  as->grf_prop.local_id = airport + i;
3901  as->grf_prop.subst_id = subs_id;
3902  as->grf_prop.grffile = _cur.grffile;
3903  /* override the default airport */
3904  _airport_mngr.Add(airport + i, _cur.grffile->grfid, subs_id);
3905  /* Create a copy of the original tiletable so it can be freed later. */
3906  DuplicateTileTable(as);
3907  }
3908  break;
3909  }
3910 
3911  case 0x0A: { // Set airport layout
3912  byte old_num_table = as->num_table;
3913  free(as->rotation);
3914  as->num_table = buf->ReadByte(); // Number of layaouts
3915  as->rotation = MallocT<Direction>(as->num_table);
3916  uint32 defsize = buf->ReadDWord(); // Total size of the definition
3917  AirportTileTable **tile_table = CallocT<AirportTileTable*>(as->num_table); // Table with tiles to compose the airport
3918  AirportTileTable *att = CallocT<AirportTileTable>(defsize); // Temporary array to read the tile layouts from the GRF
3919  int size;
3920  const AirportTileTable *copy_from;
3921  try {
3922  for (byte j = 0; j < as->num_table; j++) {
3923  const_cast<Direction&>(as->rotation[j]) = (Direction)buf->ReadByte();
3924  for (int k = 0;; k++) {
3925  att[k].ti.x = buf->ReadByte(); // Offsets from northermost tile
3926  att[k].ti.y = buf->ReadByte();
3927 
3928  if (att[k].ti.x == 0 && att[k].ti.y == 0x80) {
3929  /* Not the same terminator. The one we are using is rather
3930  * x = -80, y = 0 . So, adjust it. */
3931  att[k].ti.x = -0x80;
3932  att[k].ti.y = 0;
3933  att[k].gfx = 0;
3934 
3935  size = k + 1;
3936  copy_from = att;
3937  break;
3938  }
3939 
3940  att[k].gfx = buf->ReadByte();
3941 
3942  if (att[k].gfx == 0xFE) {
3943  /* Use a new tile from this GRF */
3944  int local_tile_id = buf->ReadWord();
3945 
3946  /* Read the ID from the _airporttile_mngr. */
3947  uint16 tempid = _airporttile_mngr.GetID(local_tile_id, _cur.grffile->grfid);
3948 
3949  if (tempid == INVALID_AIRPORTTILE) {
3950  grfmsg(2, "AirportChangeInfo: Attempt to use airport tile %u with airport id %u, not yet defined. Ignoring.", local_tile_id, airport + i);
3951  } else {
3952  /* Declared as been valid, can be used */
3953  att[k].gfx = tempid;
3954  }
3955  } else if (att[k].gfx == 0xFF) {
3956  att[k].ti.x = (int8)GB(att[k].ti.x, 0, 8);
3957  att[k].ti.y = (int8)GB(att[k].ti.y, 0, 8);
3958  }
3959 
3960  if (as->rotation[j] == DIR_E || as->rotation[j] == DIR_W) {
3961  as->size_x = std::max<byte>(as->size_x, att[k].ti.y + 1);
3962  as->size_y = std::max<byte>(as->size_y, att[k].ti.x + 1);
3963  } else {
3964  as->size_x = std::max<byte>(as->size_x, att[k].ti.x + 1);
3965  as->size_y = std::max<byte>(as->size_y, att[k].ti.y + 1);
3966  }
3967  }
3968  tile_table[j] = CallocT<AirportTileTable>(size);
3969  memcpy(tile_table[j], copy_from, sizeof(*copy_from) * size);
3970  }
3971  /* Free old layouts in the airport spec */
3972  for (int j = 0; j < old_num_table; j++) {
3973  /* remove the individual layouts */
3974  free(as->table[j]);
3975  }
3976  free(as->table);
3977  /* Install final layout construction in the airport spec */
3978  as->table = tile_table;
3979  free(att);
3980  } catch (...) {
3981  for (int i = 0; i < as->num_table; i++) {
3982  free(tile_table[i]);
3983  }
3984  free(tile_table);
3985  free(att);
3986  throw;
3987  }
3988  break;
3989  }
3990 
3991  case 0x0C:
3992  as->min_year = buf->ReadWord();
3993  as->max_year = buf->ReadWord();
3994  if (as->max_year == 0xFFFF) as->max_year = MAX_YEAR;
3995  break;
3996 
3997  case 0x0D:
3998  as->ttd_airport_type = (TTDPAirportType)buf->ReadByte();
3999  break;
4000 
4001  case 0x0E:
4002  as->catchment = Clamp(buf->ReadByte(), 1, MAX_CATCHMENT);
4003  break;
4004 
4005  case 0x0F:
4006  as->noise_level = buf->ReadByte();
4007  break;
4008 
4009  case 0x10:
4010  AddStringForMapping(buf->ReadWord(), &as->name);
4011  break;
4012 
4013  case 0x11: // Maintenance cost factor
4014  as->maintenance_cost = buf->ReadWord();
4015  break;
4016 
4017  default:
4018  ret = CIR_UNKNOWN;
4019  break;
4020  }
4021  }
4022 
4023  return ret;
4024 }
4025 
4033 {
4035 
4036  switch (prop) {
4037  case 0x0B:
4038  case 0x0C:
4039  case 0x0D:
4040  case 0x12:
4041  case 0x14:
4042  case 0x16:
4043  case 0x17:
4044  buf->ReadByte();
4045  break;
4046 
4047  case 0x09:
4048  case 0x0A:
4049  case 0x10:
4050  case 0x11:
4051  case 0x13:
4052  case 0x15:
4053  buf->ReadWord();
4054  break;
4055 
4056  case 0x08:
4057  case 0x0E:
4058  case 0x0F:
4059  buf->ReadDWord();
4060  break;
4061 
4062  default:
4063  ret = CIR_UNKNOWN;
4064  break;
4065  }
4066 
4067  return ret;
4068 }
4069 
4078 static ChangeInfoResult ObjectChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4079 {
4081 
4082  if (id + numinfo > NUM_OBJECTS_PER_GRF) {
4083  grfmsg(1, "ObjectChangeInfo: Too many objects loaded (%u), max (%u). Ignoring.", id + numinfo, NUM_OBJECTS_PER_GRF);
4084  return CIR_INVALID_ID;
4085  }
4086 
4087  /* Allocate object specs if they haven't been allocated already. */
4088  if (_cur.grffile->objectspec == nullptr) {
4089  _cur.grffile->objectspec = CallocT<ObjectSpec*>(NUM_OBJECTS_PER_GRF);
4090  }
4091 
4092  for (int i = 0; i < numinfo; i++) {
4093  ObjectSpec *spec = _cur.grffile->objectspec[id + i];
4094 
4095  if (prop != 0x08 && spec == nullptr) {
4096  /* If the object property 08 is not yet set, ignore this property */
4097  ChangeInfoResult cir = IgnoreObjectProperty(prop, buf);
4098  if (cir > ret) ret = cir;
4099  continue;
4100  }
4101 
4102  switch (prop) {
4103  case 0x08: { // Class ID
4104  ObjectSpec **ospec = &_cur.grffile->objectspec[id + i];
4105 
4106  /* Allocate space for this object. */
4107  if (*ospec == nullptr) {
4108  *ospec = CallocT<ObjectSpec>(1);
4109  (*ospec)->views = 1; // Default for NewGRFs that don't set it.
4110  (*ospec)->size = OBJECT_SIZE_1X1; // Default for NewGRFs that manage to not set it (1x1)
4111  }
4112 
4113  /* Swap classid because we read it in BE. */
4114  uint32 classid = buf->ReadDWord();
4115  (*ospec)->cls_id = ObjectClass::Allocate(BSWAP32(classid));
4116  (*ospec)->enabled = true;
4117  break;
4118  }
4119 
4120  case 0x09: { // Class name
4121  ObjectClass *objclass = ObjectClass::Get(spec->cls_id);
4122  AddStringForMapping(buf->ReadWord(), &objclass->name);
4123  break;
4124  }
4125 
4126  case 0x0A: // Object name
4127  AddStringForMapping(buf->ReadWord(), &spec->name);
4128  break;
4129 
4130  case 0x0B: // Climate mask
4131  spec->climate = buf->ReadByte();
4132  break;
4133 
4134  case 0x0C: // Size
4135  spec->size = buf->ReadByte();
4136  if (GB(spec->size, 0, 4) == 0 || GB(spec->size, 4, 4) == 0) {
4137  grfmsg(0, "ObjectChangeInfo: Invalid object size requested (0x%x) for object id %u. Ignoring.", spec->size, id + i);
4138  spec->size = OBJECT_SIZE_1X1;
4139  }
4140  break;
4141 
4142  case 0x0D: // Build cost multipler
4143  spec->build_cost_multiplier = buf->ReadByte();
4145  break;
4146 
4147  case 0x0E: // Introduction date
4148  spec->introduction_date = buf->ReadDWord();
4149  break;
4150 
4151  case 0x0F: // End of life
4152  spec->end_of_life_date = buf->ReadDWord();
4153  break;
4154 
4155  case 0x10: // Flags
4156  spec->flags = (ObjectFlags)buf->ReadWord();
4158  break;
4159 
4160  case 0x11: // Animation info
4161  spec->animation.frames = buf->ReadByte();
4162  spec->animation.status = buf->ReadByte();
4163  break;
4164 
4165  case 0x12: // Animation speed
4166  spec->animation.speed = buf->ReadByte();
4167  break;
4168 
4169  case 0x13: // Animation triggers
4170  spec->animation.triggers = buf->ReadWord();
4171  break;
4172 
4173  case 0x14: // Removal cost multiplier
4174  spec->clear_cost_multiplier = buf->ReadByte();
4175  break;
4176 
4177  case 0x15: // Callback mask
4178  spec->callback_mask = buf->ReadWord();
4179  break;
4180 
4181  case 0x16: // Building height
4182  spec->height = buf->ReadByte();
4183  break;
4184 
4185  case 0x17: // Views
4186  spec->views = buf->ReadByte();
4187  if (spec->views != 1 && spec->views != 2 && spec->views != 4) {
4188  grfmsg(2, "ObjectChangeInfo: Invalid number of views (%u) for object id %u. Ignoring.", spec->views, id + i);
4189  spec->views = 1;
4190  }
4191  break;
4192 
4193  case 0x18: // Amount placed on 256^2 map on map creation
4194  spec->generate_amount = buf->ReadByte();
4195  break;
4196 
4197  default:
4198  ret = CIR_UNKNOWN;
4199  break;
4200  }
4201  }
4202 
4203  return ret;
4204 }
4205 
4214 static ChangeInfoResult RailTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4215 {
4217 
4218  extern RailtypeInfo _railtypes[RAILTYPE_END];
4219 
4220  if (id + numinfo > RAILTYPE_END) {
4221  grfmsg(1, "RailTypeChangeInfo: Rail type %u is invalid, max %u, ignoring", id + numinfo, RAILTYPE_END);
4222  return CIR_INVALID_ID;
4223  }
4224 
4225  for (int i = 0; i < numinfo; i++) {
4226  RailType rt = _cur.grffile->railtype_map[id + i];
4227  if (rt == INVALID_RAILTYPE) return CIR_INVALID_ID;
4228 
4229  RailtypeInfo *rti = &_railtypes[rt];
4230 
4231  switch (prop) {
4232  case 0x08: // Label of rail type
4233  /* Skipped here as this is loaded during reservation stage. */
4234  buf->ReadDWord();
4235  break;
4236 
4237  case 0x09: { // Toolbar caption of railtype (sets name as well for backwards compatibility for grf ver < 8)
4238  uint16 str = buf->ReadWord();
4240  if (_cur.grffile->grf_version < 8) {
4241  AddStringForMapping(str, &rti->strings.name);
4242  }
4243  break;
4244  }
4245 
4246  case 0x0A: // Menu text of railtype
4247  AddStringForMapping(buf->ReadWord(), &rti->strings.menu_text);
4248  break;
4249 
4250  case 0x0B: // Build window caption
4251  AddStringForMapping(buf->ReadWord(), &rti->strings.build_caption);
4252  break;
4253 
4254  case 0x0C: // Autoreplace text
4255  AddStringForMapping(buf->ReadWord(), &rti->strings.replace_text);
4256  break;
4257 
4258  case 0x0D: // New locomotive text
4259  AddStringForMapping(buf->ReadWord(), &rti->strings.new_loco);
4260  break;
4261 
4262  case 0x0E: // Compatible railtype list
4263  case 0x0F: // Powered railtype list
4264  case 0x18: // Railtype list required for date introduction
4265  case 0x19: // Introduced railtype list
4266  {
4267  /* Rail type compatibility bits are added to the existing bits
4268  * to allow multiple GRFs to modify compatibility with the
4269  * default rail types. */
4270  int n = buf->ReadByte();
4271  for (int j = 0; j != n; j++) {
4272  RailTypeLabel label = buf->ReadDWord();
4273  RailType rt = GetRailTypeByLabel(BSWAP32(label), false);
4274  if (rt != INVALID_RAILTYPE) {
4275  switch (prop) {
4276  case 0x0F: SetBit(rti->powered_railtypes, rt); FALLTHROUGH; // Powered implies compatible.
4277  case 0x0E: SetBit(rti->compatible_railtypes, rt); break;
4278  case 0x18: SetBit(rti->introduction_required_railtypes, rt); break;
4279  case 0x19: SetBit(rti->introduces_railtypes, rt); break;
4280  }
4281  }
4282  }
4283  break;
4284  }
4285 
4286  case 0x10: // Rail Type flags
4287  rti->flags = (RailTypeFlags)buf->ReadByte();
4288  break;
4289 
4290  case 0x11: // Curve speed advantage
4291  rti->curve_speed = buf->ReadByte();
4292  break;
4293 
4294  case 0x12: // Station graphic
4295  rti->fallback_railtype = Clamp(buf->ReadByte(), 0, 2);
4296  break;
4297 
4298  case 0x13: // Construction cost factor
4299  rti->cost_multiplier = buf->ReadWord();
4300  break;
4301 
4302  case 0x14: // Speed limit
4303  rti->max_speed = buf->ReadWord();
4304  break;
4305 
4306  case 0x15: // Acceleration model
4307  rti->acceleration_type = Clamp(buf->ReadByte(), 0, 2);
4308  break;
4309 
4310  case 0x16: // Map colour
4311  rti->map_colour = buf->ReadByte();
4312  break;
4313 
4314  case 0x17: // Introduction date
4315  rti->introduction_date = buf->ReadDWord();
4316  break;
4317 
4318  case 0x1A: // Sort order
4319  rti->sorting_order = buf->ReadByte();
4320  break;
4321 
4322  case 0x1B: // Name of railtype (overridden by prop 09 for grf ver < 8)
4323  AddStringForMapping(buf->ReadWord(), &rti->strings.name);
4324  break;
4325 
4326  case 0x1C: // Maintenance cost factor
4327  rti->maintenance_multiplier = buf->ReadWord();
4328  break;
4329 
4330  case 0x1D: // Alternate rail type label list
4331  /* Skipped here as this is loaded during reservation stage. */
4332  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4333  break;
4334 
4335  default:
4336  ret = CIR_UNKNOWN;
4337  break;
4338  }
4339  }
4340 
4341  return ret;
4342 }
4343 
4344 static ChangeInfoResult RailTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4345 {
4347 
4348  extern RailtypeInfo _railtypes[RAILTYPE_END];
4349 
4350  if (id + numinfo > RAILTYPE_END) {
4351  grfmsg(1, "RailTypeReserveInfo: Rail type %u is invalid, max %u, ignoring", id + numinfo, RAILTYPE_END);
4352  return CIR_INVALID_ID;
4353  }
4354 
4355  for (int i = 0; i < numinfo; i++) {
4356  switch (prop) {
4357  case 0x08: // Label of rail type
4358  {
4359  RailTypeLabel rtl = buf->ReadDWord();
4360  rtl = BSWAP32(rtl);
4361 
4362  RailType rt = GetRailTypeByLabel(rtl, false);
4363  if (rt == INVALID_RAILTYPE) {
4364  /* Set up new rail type */
4365  rt = AllocateRailType(rtl);
4366  }
4367 
4368  _cur.grffile->railtype_map[id + i] = rt;
4369  break;
4370  }
4371 
4372  case 0x09: // Toolbar caption of railtype
4373  case 0x0A: // Menu text
4374  case 0x0B: // Build window caption
4375  case 0x0C: // Autoreplace text
4376  case 0x0D: // New loco
4377  case 0x13: // Construction cost
4378  case 0x14: // Speed limit
4379  case 0x1B: // Name of railtype
4380  case 0x1C: // Maintenance cost factor
4381  buf->ReadWord();
4382  break;
4383 
4384  case 0x1D: // Alternate rail type label list
4385  if (_cur.grffile->railtype_map[id + i] != INVALID_RAILTYPE) {
4386  int n = buf->ReadByte();
4387  for (int j = 0; j != n; j++) {
4388  _railtypes[_cur.grffile->railtype_map[id + i]].alternate_labels.push_back(BSWAP32(buf->ReadDWord()));
4389  }
4390  break;
4391  }
4392  grfmsg(1, "RailTypeReserveInfo: Ignoring property 1D for rail type %u because no label was set", id + i);
4393  FALLTHROUGH;
4394 
4395  case 0x0E: // Compatible railtype list
4396  case 0x0F: // Powered railtype list
4397  case 0x18: // Railtype list required for date introduction
4398  case 0x19: // Introduced railtype list
4399  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4400  break;
4401 
4402  case 0x10: // Rail Type flags
4403  case 0x11: // Curve speed advantage
4404  case 0x12: // Station graphic
4405  case 0x15: // Acceleration model
4406  case 0x16: // Map colour
4407  case 0x1A: // Sort order
4408  buf->ReadByte();
4409  break;
4410 
4411  case 0x17: // Introduction date
4412  buf->ReadDWord();
4413  break;
4414 
4415  default:
4416  ret = CIR_UNKNOWN;
4417  break;
4418  }
4419  }
4420 
4421  return ret;
4422 }
4423 
4432 static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
4433 {
4435 
4436  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
4437  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
4438 
4439  if (id + numinfo > ROADTYPE_END) {
4440  grfmsg(1, "RoadTypeChangeInfo: Road type %u is invalid, max %u, ignoring", id + numinfo, ROADTYPE_END);
4441  return CIR_INVALID_ID;
4442  }
4443 
4444  for (int i = 0; i < numinfo; i++) {
4445  RoadType rt = type_map[id + i];
4446  if (rt == INVALID_ROADTYPE) return CIR_INVALID_ID;
4447 
4448  RoadTypeInfo *rti = &_roadtypes[rt];
4449 
4450  switch (prop) {
4451  case 0x08: // Label of road type
4452  /* Skipped here as this is loaded during reservation stage. */
4453  buf->ReadDWord();
4454  break;
4455 
4456  case 0x09: { // Toolbar caption of roadtype (sets name as well for backwards compatibility for grf ver < 8)
4457  uint16 str = buf->ReadWord();
4459  break;
4460  }
4461 
4462  case 0x0A: // Menu text of roadtype
4463  AddStringForMapping(buf->ReadWord(), &rti->strings.menu_text);
4464  break;
4465 
4466  case 0x0B: // Build window caption
4467  AddStringForMapping(buf->ReadWord(), &rti->strings.build_caption);
4468  break;
4469 
4470  case 0x0C: // Autoreplace text
4471  AddStringForMapping(buf->ReadWord(), &rti->strings.replace_text);
4472  break;
4473 
4474  case 0x0D: // New engine text
4475  AddStringForMapping(buf->ReadWord(), &rti->strings.new_engine);
4476  break;
4477 
4478  case 0x0F: // Powered roadtype list
4479  case 0x18: // Roadtype list required for date introduction
4480  case 0x19: { // Introduced roadtype list
4481  /* Road type compatibility bits are added to the existing bits
4482  * to allow multiple GRFs to modify compatibility with the
4483  * default road types. */
4484  int n = buf->ReadByte();
4485  for (int j = 0; j != n; j++) {
4486  RoadTypeLabel label = buf->ReadDWord();
4487  RoadType rt = GetRoadTypeByLabel(BSWAP32(label), false);
4488  if (rt != INVALID_ROADTYPE) {
4489  switch (prop) {
4490  case 0x0F: SetBit(rti->powered_roadtypes, rt); break;
4491  case 0x18: SetBit(rti->introduction_required_roadtypes, rt); break;
4492  case 0x19: SetBit(rti->introduces_roadtypes, rt); break;
4493  }
4494  }
4495  }
4496  break;
4497  }
4498 
4499  case 0x10: // Road Type flags
4500  rti->flags = (RoadTypeFlags)buf->ReadByte();
4501  break;
4502 
4503  case 0x13: // Construction cost factor
4504  rti->cost_multiplier = buf->ReadWord();
4505  break;
4506 
4507  case 0x14: // Speed limit
4508  rti->max_speed = buf->ReadWord();
4509  break;
4510 
4511  case 0x16: // Map colour
4512  rti->map_colour = buf->ReadByte();
4513  break;
4514 
4515  case 0x17: // Introduction date
4516  rti->introduction_date = buf->ReadDWord();
4517  break;
4518 
4519  case 0x1A: // Sort order
4520  rti->sorting_order = buf->ReadByte();
4521  break;
4522 
4523  case 0x1B: // Name of roadtype
4524  AddStringForMapping(buf->ReadWord(), &rti->strings.name);
4525  break;
4526 
4527  case 0x1C: // Maintenance cost factor
4528  rti->maintenance_multiplier = buf->ReadWord();
4529  break;
4530 
4531  case 0x1D: // Alternate road type label list
4532  /* Skipped here as this is loaded during reservation stage. */
4533  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4534  break;
4535 
4536  default:
4537  ret = CIR_UNKNOWN;
4538  break;
4539  }
4540  }
4541 
4542  return ret;
4543 }
4544 
4545 static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4546 {
4547  return RoadTypeChangeInfo(id, numinfo, prop, buf, RTT_ROAD);
4548 }
4549 
4550 static ChangeInfoResult TramTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4551 {
4552  return RoadTypeChangeInfo(id, numinfo, prop, buf, RTT_TRAM);
4553 }
4554 
4555 
4556 static ChangeInfoResult RoadTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
4557 {
4559 
4560  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
4561  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
4562 
4563  if (id + numinfo > ROADTYPE_END) {
4564  grfmsg(1, "RoadTypeReserveInfo: Road type %u is invalid, max %u, ignoring", id + numinfo, ROADTYPE_END);
4565  return CIR_INVALID_ID;
4566  }
4567 
4568  for (int i = 0; i < numinfo; i++) {
4569  switch (prop) {
4570  case 0x08: { // Label of road type
4571  RoadTypeLabel rtl = buf->ReadDWord();
4572  rtl = BSWAP32(rtl);
4573 
4574  RoadType rt = GetRoadTypeByLabel(rtl, false);
4575  if (rt == INVALID_ROADTYPE) {
4576  /* Set up new road type */
4577  rt = AllocateRoadType(rtl, rtt);
4578  } else if (GetRoadTramType(rt) != rtt) {
4579  grfmsg(1, "RoadTypeReserveInfo: Road type %u is invalid type (road/tram), ignoring", id + numinfo);
4580  return CIR_INVALID_ID;
4581  }
4582 
4583  type_map[id + i] = rt;
4584  break;
4585  }
4586  case 0x09: // Toolbar caption of roadtype
4587  case 0x0A: // Menu text
4588  case 0x0B: // Build window caption
4589  case 0x0C: // Autoreplace text
4590  case 0x0D: // New loco
4591  case 0x13: // Construction cost
4592  case 0x14: // Speed limit
4593  case 0x1B: // Name of roadtype
4594  case 0x1C: // Maintenance cost factor
4595  buf->ReadWord();
4596  break;
4597 
4598  case 0x1D: // Alternate road type label list
4599  if (type_map[id + i] != INVALID_ROADTYPE) {
4600  int n = buf->ReadByte();
4601  for (int j = 0; j != n; j++) {
4602  _roadtypes[type_map[id + i]].alternate_labels.push_back(BSWAP32(buf->ReadDWord()));
4603  }
4604  break;
4605  }
4606  grfmsg(1, "RoadTypeReserveInfo: Ignoring property 1D for road type %u because no label was set", id + i);
4607  /* FALL THROUGH */
4608 
4609  case 0x0F: // Powered roadtype list
4610  case 0x18: // Roadtype list required for date introduction
4611  case 0x19: // Introduced roadtype list
4612  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4613  break;
4614 
4615  case 0x10: // Road Type flags
4616  case 0x16: // Map colour
4617  case 0x1A: // Sort order
4618  buf->ReadByte();
4619  break;
4620 
4621  case 0x17: // Introduction date
4622  buf->ReadDWord();
4623  break;
4624 
4625  default:
4626  ret = CIR_UNKNOWN;
4627  break;
4628  }
4629  }
4630 
4631  return ret;
4632 }
4633 
4634 static ChangeInfoResult RoadTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4635 {
4636  return RoadTypeReserveInfo(id, numinfo, prop, buf, RTT_ROAD);
4637 }
4638 
4639 static ChangeInfoResult TramTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4640 {
4641  return RoadTypeReserveInfo(id, numinfo, prop, buf, RTT_TRAM);
4642 }
4643 
4644 static ChangeInfoResult AirportTilesChangeInfo(uint airtid, int numinfo, int prop, ByteReader *buf)
4645 {
4647 
4648  if (airtid + numinfo > NUM_AIRPORTTILES_PER_GRF) {
4649  grfmsg(1, "AirportTileChangeInfo: Too many airport tiles loaded (%u), max (%u). Ignoring.", airtid + numinfo, NUM_AIRPORTTILES_PER_GRF);
4650  return CIR_INVALID_ID;
4651  }
4652 
4653  /* Allocate airport tile specs if they haven't been allocated already. */
4654  if (_cur.grffile->airtspec == nullptr) {
4655  _cur.grffile->airtspec = CallocT<AirportTileSpec*>(NUM_AIRPORTTILES_PER_GRF);
4656  }
4657 
4658  for (int i = 0; i < numinfo; i++) {
4659  AirportTileSpec *tsp = _cur.grffile->airtspec[airtid + i];
4660 
4661  if (prop != 0x08 && tsp == nullptr) {
4662  grfmsg(2, "AirportTileChangeInfo: Attempt to modify undefined airport tile %u. Ignoring.", airtid + i);
4663  return CIR_INVALID_ID;
4664  }
4665 
4666  switch (prop) {
4667  case 0x08: { // Substitute airport tile type
4668  AirportTileSpec **tilespec = &_cur.grffile->airtspec[airtid + i];
4669  byte subs_id = buf->ReadByte();
4670 
4671  if (subs_id >= NEW_AIRPORTTILE_OFFSET) {
4672  /* The substitute id must be one of the original airport tiles. */
4673  grfmsg(2, "AirportTileChangeInfo: Attempt to use new airport tile %u as substitute airport tile for %u. Ignoring.", subs_id, airtid + i);
4674  continue;
4675  }
4676 
4677  /* Allocate space for this airport tile. */
4678  if (*tilespec == nullptr) {
4679  *tilespec = CallocT<AirportTileSpec>(1);
4680  tsp = *tilespec;
4681 
4682  memcpy(tsp, AirportTileSpec::Get(subs_id), sizeof(AirportTileSpec));
4683  tsp->enabled = true;
4684 
4686 
4687  tsp->grf_prop.local_id = airtid + i;
4688  tsp->grf_prop.subst_id = subs_id;
4689  tsp->grf_prop.grffile = _cur.grffile;
4690  _airporttile_mngr.AddEntityID(airtid + i, _cur.grffile->grfid, subs_id); // pre-reserve the tile slot
4691  }
4692  break;
4693  }
4694 
4695  case 0x09: { // Airport tile override
4696  byte override = buf->ReadByte();
4697 
4698  /* The airport tile being overridden must be an original airport tile. */
4699  if (override >= NEW_AIRPORTTILE_OFFSET) {
4700  grfmsg(2, "AirportTileChangeInfo: Attempt to override new airport tile %u with airport tile id %u. Ignoring.", override, airtid + i);
4701  continue;
4702  }
4703 
4704  _airporttile_mngr.Add(airtid + i, _cur.grffile->grfid, override);
4705  break;
4706  }
4707 
4708  case 0x0E: // Callback mask
4709  tsp->callback_mask = buf->ReadByte();
4710  break;
4711 
4712  case 0x0F: // Animation information
4713  tsp->animation.frames = buf->ReadByte();
4714  tsp->animation.status = buf->ReadByte();
4715  break;
4716 
4717  case 0x10: // Animation speed
4718  tsp->animation.speed = buf->ReadByte();
4719  break;
4720 
4721  case 0x11: // Animation triggers
4722  tsp->animation.triggers = buf->ReadByte();
4723  break;
4724 
4725  default:
4726  ret = CIR_UNKNOWN;
4727  break;
4728  }
4729  }
4730 
4731  return ret;
4732 }
4733 
4734 static bool HandleChangeInfoResult(const char *caller, ChangeInfoResult cir, uint8 feature, uint8 property)
4735 {
4736  switch (cir) {
4737  default: NOT_REACHED();
4738 
4739  case CIR_DISABLED:
4740  /* Error has already been printed; just stop parsing */
4741  return true;
4742 
4743  case CIR_SUCCESS:
4744  return false;
4745 
4746  case CIR_UNHANDLED:
4747  grfmsg(1, "%s: Ignoring property 0x%02X of feature 0x%02X (not implemented)", caller, property, feature);
4748  return false;
4749 
4750  case CIR_UNKNOWN:
4751  grfmsg(0, "%s: Unknown property 0x%02X of feature 0x%02X, disabling", caller, property, feature);
4752  FALLTHROUGH;
4753 
4754  case CIR_INVALID_ID: {
4755  /* No debug message for an invalid ID, as it has already been output */
4756  GRFError *error = DisableGrf(cir == CIR_INVALID_ID ? STR_NEWGRF_ERROR_INVALID_ID : STR_NEWGRF_ERROR_UNKNOWN_PROPERTY);
4757  if (cir != CIR_INVALID_ID) error->param_value[1] = property;
4758  return true;
4759  }
4760  }
4761 }
4762 
4763 /* Action 0x00 */
4764 static void FeatureChangeInfo(ByteReader *buf)
4765 {
4766  /* <00> <feature> <num-props> <num-info> <id> (<property <new-info>)...
4767  *
4768  * B feature
4769  * B num-props how many properties to change per vehicle/station
4770  * B num-info how many vehicles/stations to change
4771  * E id ID of first vehicle/station to change, if num-info is
4772  * greater than one, this one and the following
4773  * vehicles/stations will be changed
4774  * B property what property to change, depends on the feature
4775  * V new-info new bytes of info (variable size; depends on properties) */
4776 
4777  static const VCI_Handler handler[] = {
4778  /* GSF_TRAINS */ RailVehicleChangeInfo,
4779  /* GSF_ROADVEHICLES */ RoadVehicleChangeInfo,
4780  /* GSF_SHIPS */ ShipVehicleChangeInfo,
4781  /* GSF_AIRCRAFT */ AircraftVehicleChangeInfo,
4782  /* GSF_STATIONS */ StationChangeInfo,
4783  /* GSF_CANALS */ CanalChangeInfo,
4784  /* GSF_BRIDGES */ BridgeChangeInfo,
4785  /* GSF_HOUSES */ TownHouseChangeInfo,
4786  /* GSF_GLOBALVAR */ GlobalVarChangeInfo,
4787  /* GSF_INDUSTRYTILES */ IndustrytilesChangeInfo,
4788  /* GSF_INDUSTRIES */ IndustriesChangeInfo,
4789  /* GSF_CARGOES */ nullptr, // Cargo is handled during reservation
4790  /* GSF_SOUNDFX */ SoundEffectChangeInfo,
4791  /* GSF_AIRPORTS */ AirportChangeInfo,
4792  /* GSF_SIGNALS */ nullptr,
4793  /* GSF_OBJECTS */ ObjectChangeInfo,
4794  /* GSF_RAILTYPES */ RailTypeChangeInfo,
4795  /* GSF_AIRPORTTILES */ AirportTilesChangeInfo,
4796  /* GSF_ROADTYPES */ RoadTypeChangeInfo,
4797  /* GSF_TRAMTYPES */ TramTypeChangeInfo,
4798  };
4799  static_assert(GSF_END == lengthof(handler));
4800 
4801  uint8 feature = buf->ReadByte();
4802  uint8 numprops = buf->ReadByte();
4803  uint numinfo = buf->ReadByte();
4804  uint engine = buf->ReadExtendedByte();
4805 
4806  if (feature >= GSF_END) {
4807  grfmsg(1, "FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4808  return;
4809  }
4810 
4811  grfmsg(6, "FeatureChangeInfo: Feature 0x%02X, %d properties, to apply to %d+%d",
4812  feature, numprops, engine, numinfo);
4813 
4814  if (handler[feature] == nullptr) {
4815  if (feature != GSF_CARGOES) grfmsg(1, "FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4816  return;
4817  }
4818 
4819  /* Mark the feature as used by the grf */
4820  SetBit(_cur.grffile->grf_features, feature);
4821 
4822  while (numprops-- && buf->HasData()) {
4823  uint8 prop = buf->ReadByte();
4824 
4825  ChangeInfoResult cir = handler[feature](engine, numinfo, prop, buf);
4826  if (HandleChangeInfoResult("FeatureChangeInfo", cir, feature, prop)) return;
4827  }
4828 }
4829 
4830 /* Action 0x00 (GLS_SAFETYSCAN) */
4831 static void SafeChangeInfo(ByteReader *buf)
4832 {
4833  uint8 feature = buf->ReadByte();
4834  uint8 numprops = buf->ReadByte();
4835  uint numinfo = buf->ReadByte();
4836  buf->ReadExtendedByte(); // id
4837 
4838  if (feature == GSF_BRIDGES && numprops == 1) {
4839  uint8 prop = buf->ReadByte();
4840  /* Bridge property 0x0D is redefinition of sprite layout tables, which
4841  * is considered safe. */
4842  if (prop == 0x0D) return;
4843  } else if (feature == GSF_GLOBALVAR && numprops == 1) {
4844  uint8 prop = buf->ReadByte();
4845  /* Engine ID Mappings are safe, if the source is static */
4846  if (prop == 0x11) {
4847  bool is_safe = true;
4848  for (uint i = 0; i < numinfo; i++) {
4849  uint32 s = buf->ReadDWord();
4850  buf->ReadDWord(); // dest
4851  const GRFConfig *grfconfig = GetGRFConfig(s);
4852  if (grfconfig != nullptr && !HasBit(grfconfig->flags, GCF_STATIC)) {
4853  is_safe = false;
4854  break;
4855  }
4856  }
4857  if (is_safe) return;
4858  }
4859  }
4860 
4861  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
4862 
4863  /* Skip remainder of GRF */
4864  _cur.skip_sprites = -1;
4865 }
4866 
4867 /* Action 0x00 (GLS_RESERVE) */
4868 static void ReserveChangeInfo(ByteReader *buf)
4869 {
4870  uint8 feature = buf->ReadByte();
4871 
4872  if (feature != GSF_CARGOES && feature != GSF_GLOBALVAR && feature != GSF_RAILTYPES && feature != GSF_ROADTYPES && feature != GSF_TRAMTYPES) return;
4873 
4874  uint8 numprops = buf->ReadByte();
4875  uint8 numinfo = buf->ReadByte();
4876  uint8 index = buf->ReadExtendedByte();
4877 
4878  while (numprops-- && buf->HasData()) {
4879  uint8 prop = buf->ReadByte();
4881 
4882  switch (feature) {
4883  default: NOT_REACHED();
4884  case GSF_CARGOES:
4885  cir = CargoChangeInfo(index, numinfo, prop, buf);
4886  break;
4887 
4888  case GSF_GLOBALVAR:
4889  cir = GlobalVarReserveInfo(index, numinfo, prop, buf);
4890  break;
4891 
4892  case GSF_RAILTYPES:
4893  cir = RailTypeReserveInfo(index, numinfo, prop, buf);
4894  break;
4895 
4896  case GSF_ROADTYPES:
4897  cir = RoadTypeReserveInfo(index, numinfo, prop, buf);
4898  break;
4899 
4900  case GSF_TRAMTYPES:
4901  cir = TramTypeReserveInfo(index, numinfo, prop, buf);
4902  break;
4903  }
4904 
4905  if (HandleChangeInfoResult("ReserveChangeInfo", cir, feature, prop)) return;
4906  }
4907 }
4908 
4909 /* Action 0x01 */
4910 static void NewSpriteSet(ByteReader *buf)
4911 {
4912  /* Basic format: <01> <feature> <num-sets> <num-ent>
4913  * Extended format: <01> <feature> 00 <first-set> <num-sets> <num-ent>
4914  *
4915  * B feature feature to define sprites for
4916  * 0, 1, 2, 3: veh-type, 4: train stations
4917  * E first-set first sprite set to define
4918  * B num-sets number of sprite sets (extended byte in extended format)
4919  * E num-ent how many entries per sprite set
4920  * For vehicles, this is the number of different
4921  * vehicle directions in each sprite set
4922  * Set num-dirs=8, unless your sprites are symmetric.
4923  * In that case, use num-dirs=4.
4924  */
4925 
4926  uint8 feature = buf->ReadByte();
4927  uint16 num_sets = buf->ReadByte();
4928  uint16 first_set = 0;
4929 
4930  if (num_sets == 0 && buf->HasData(3)) {
4931  /* Extended Action1 format.
4932  * Some GRFs define zero sets of zero sprites, though there is actually no use in that. Ignore them. */
4933  first_set = buf->ReadExtendedByte();
4934  num_sets = buf->ReadExtendedByte();
4935  }
4936  uint16 num_ents = buf->ReadExtendedByte();
4937 
4938  if (feature >= GSF_END) {
4939  _cur.skip_sprites = num_sets * num_ents;
4940  grfmsg(1, "NewSpriteSet: Unsupported feature 0x%02X, skipping %d sprites", feature, _cur.skip_sprites);
4941  return;
4942  }
4943 
4944  _cur.AddSpriteSets(feature, _cur.spriteid, first_set, num_sets, num_ents);
4945 
4946  grfmsg(7, "New sprite set at %d of feature 0x%02X, consisting of %d sets with %d views each (total %d)",
4947  _cur.spriteid, feature, num_sets, num_ents, num_sets * num_ents
4948  );
4949 
4950  for (int i = 0; i < num_sets * num_ents; i++) {
4951  _cur.nfo_line++;
4952  LoadNextSprite(_cur.spriteid++, *_cur.file, _cur.nfo_line);
4953  }
4954 }
4955 
4956 /* Action 0x01 (SKIP) */
4957 static void SkipAct1(ByteReader *buf)
4958 {
4959  buf->ReadByte();
4960  uint16 num_sets = buf->ReadByte();
4961 
4962  if (num_sets == 0 && buf->HasData(3)) {
4963  /* Extended Action1 format.
4964  * Some GRFs define zero sets of zero sprites, though there is actually no use in that. Ignore them. */
4965  buf->ReadExtendedByte(); // first_set
4966  num_sets = buf->ReadExtendedByte();
4967  }
4968  uint16 num_ents = buf->ReadExtendedByte();
4969 
4970  _cur.skip_sprites = num_sets * num_ents;
4971 
4972  grfmsg(3, "SkipAct1: Skipping %d sprites", _cur.skip_sprites);
4973 }
4974 
4975 /* Helper function to either create a callback or link to a previously
4976  * defined spritegroup. */
4977 static const SpriteGroup *GetGroupFromGroupID(byte setid, byte type, uint16 groupid)
4978 {
4979  if (HasBit(groupid, 15)) {
4981  return new CallbackResultSpriteGroup(groupid, _cur.grffile->grf_version >= 8);
4982  }
4983 
4984  if (groupid > MAX_SPRITEGROUP || _cur.spritegroups[groupid] == nullptr) {
4985  grfmsg(1, "GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid);
4986  return nullptr;
4987  }
4988 
4989  return _cur.spritegroups[groupid];
4990 }
4991 
5000 static const SpriteGroup *CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid)
5001 {
5002  if (HasBit(spriteid, 15)) {
5004  return new CallbackResultSpriteGroup(spriteid, _cur.grffile->grf_version >= 8);
5005  }
5006 
5007  if (!_cur.IsValidSpriteSet(feature, spriteid)) {
5008  grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid", setid, type, spriteid);
5009  return nullptr;
5010  }
5011 
5012  SpriteID spriteset_start = _cur.GetSprite(feature, spriteid);
5013  uint num_sprites = _cur.GetNumEnts(feature, spriteid);
5014 
5015  /* Ensure that the sprites are loeded */
5016  assert(spriteset_start + num_sprites <= _cur.spriteid);
5017 
5019  return new ResultSpriteGroup(spriteset_start, num_sprites);
5020 }
5021 
5022 /* Action 0x02 */
5023 static void NewSpriteGroup(ByteReader *buf)
5024 {
5025  /* <02> <feature> <set-id> <type/num-entries> <feature-specific-data...>
5026  *
5027  * B feature see action 1
5028  * B set-id ID of this particular definition
5029  * B type/num-entries
5030  * if 80 or greater, this is a randomized or variational
5031  * list definition, see below
5032  * otherwise it specifies a number of entries, the exact
5033  * meaning depends on the feature
5034  * V feature-specific-data (huge mess, don't even look it up --pasky) */
5035  const SpriteGroup *act_group = nullptr;
5036 
5037  uint8 feature = buf->ReadByte();
5038  if (feature >= GSF_END) {
5039  grfmsg(1, "NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5040  return;
5041  }
5042 
5043  uint8 setid = buf->ReadByte();
5044  uint8 type = buf->ReadByte();
5045 
5046  /* Sprite Groups are created here but they are allocated from a pool, so
5047  * we do not need to delete anything if there is an exception from the
5048  * ByteReader. */
5049 
5050  switch (type) {
5051  /* Deterministic Sprite Group */
5052  case 0x81: // Self scope, byte
5053  case 0x82: // Parent scope, byte
5054  case 0x85: // Self scope, word
5055  case 0x86: // Parent scope, word
5056  case 0x89: // Self scope, dword
5057  case 0x8A: // Parent scope, dword
5058  {
5059  byte varadjust;
5060  byte varsize;
5061 
5064  group->nfo_line = _cur.nfo_line;
5065  act_group = group;
5066  group->var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
5067 
5068  switch (GB(type, 2, 2)) {
5069  default: NOT_REACHED();
5070  case 0: group->size = DSG_SIZE_BYTE; varsize = 1; break;
5071  case 1: group->size = DSG_SIZE_WORD; varsize = 2; break;
5072  case 2: group->size = DSG_SIZE_DWORD; varsize = 4; break;
5073  }
5074 
5075  /* Loop through the var adjusts. Unfortunately we don't know how many we have
5076  * from the outset, so we shall have to keep reallocing. */
5077  do {
5078  DeterministicSpriteGroupAdjust &adjust = group->adjusts.emplace_back();
5079 
5080  /* The first var adjust doesn't have an operation specified, so we set it to add. */
5081  adjust.operation = group->adjusts.size() == 1 ? DSGA_OP_ADD : (DeterministicSpriteGroupAdjustOperation)buf->ReadByte();
5082  adjust.variable = buf->ReadByte();
5083  if (adjust.variable == 0x7E) {
5084  /* Link subroutine group */
5085  adjust.subroutine = GetGroupFromGroupID(setid, type, buf->ReadByte());
5086  } else {
5087  adjust.parameter = IsInsideMM(adjust.variable, 0x60, 0x80) ? buf->ReadByte() : 0;
5088  }
5089 
5090  varadjust = buf->ReadByte();
5091  adjust.shift_num = GB(varadjust, 0, 5);
5092  adjust.type = (DeterministicSpriteGroupAdjustType)GB(varadjust, 6, 2);
5093  adjust.and_mask = buf->ReadVarSize(varsize);
5094 
5095  if (adjust.type != DSGA_TYPE_NONE) {
5096  adjust.add_val = buf->ReadVarSize(varsize);
5097  adjust.divmod_val = buf->ReadVarSize(varsize);
5098  } else {
5099  adjust.add_val = 0;
5100  adjust.divmod_val = 0;
5101  }
5102 
5103  /* Continue reading var adjusts while bit 5 is set. */
5104  } while (HasBit(varadjust, 5));
5105 
5106  std::vector<DeterministicSpriteGroupRange> ranges;
5107  ranges.resize(buf->ReadByte());
5108  for (uint i = 0; i < ranges.size(); i++) {
5109  ranges[i].group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5110  ranges[i].low = buf->ReadVarSize(varsize);
5111  ranges[i].high = buf->ReadVarSize(varsize);
5112  }
5113 
5114  group->default_group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5115  group->error_group = ranges.size() > 0 ? ranges[0].group : group->default_group;
5116  /* nvar == 0 is a special case -- we turn our value into a callback result */
5117  group->calculated_result = ranges.size() == 0;
5118 
5119  /* Sort ranges ascending. When ranges overlap, this may required clamping or splitting them */
5120  std::vector<uint32> bounds;
5121  for (uint i = 0; i < ranges.size(); i++) {
5122  bounds.push_back(ranges[i].low);
5123  if (ranges[i].high != UINT32_MAX) bounds.push_back(ranges[i].high + 1);
5124  }
5125  std::sort(bounds.begin(), bounds.end());
5126  bounds.erase(std::unique(bounds.begin(), bounds.end()), bounds.end());
5127 
5128  std::vector<const SpriteGroup *> target;
5129  for (uint j = 0; j < bounds.size(); ++j) {
5130  uint32 v = bounds[j];
5131  const SpriteGroup *t = group->default_group;
5132  for (uint i = 0; i < ranges.size(); i++) {
5133  if (ranges[i].low <= v && v <= ranges[i].high) {
5134  t = ranges[i].group;
5135  break;
5136  }
5137  }
5138  target.push_back(t);
5139  }
5140  assert(target.size() == bounds.size());
5141 
5142  for (uint j = 0; j < bounds.size(); ) {
5143  if (target[j] != group->default_group) {
5144  DeterministicSpriteGroupRange &r = group->ranges.emplace_back();
5145  r.group = target[j];
5146  r.low = bounds[j];
5147  while (j < bounds.size() && target[j] == r.group) {
5148  j++;
5149  }
5150  r.high = j < bounds.size() ? bounds[j] - 1 : UINT32_MAX;
5151  } else {
5152  j++;
5153  }
5154  }
5155 
5156  break;
5157  }
5158 
5159  /* Randomized Sprite Group */
5160  case 0x80: // Self scope
5161  case 0x83: // Parent scope
5162  case 0x84: // Relative scope
5163  {
5166  group->nfo_line = _cur.nfo_line;
5167  act_group = group;
5168  group->var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
5169 
5170  if (HasBit(type, 2)) {
5171  if (feature <= GSF_AIRCRAFT) group->var_scope = VSG_SCOPE_RELATIVE;
5172  group->count = buf->ReadByte();
5173  }
5174 
5175  uint8 triggers = buf->ReadByte();
5176  group->triggers = GB(triggers, 0, 7);
5177  group->cmp_mode = HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY;
5178  group->lowest_randbit = buf->ReadByte();
5179 
5180  byte num_groups = buf->ReadByte();
5181  if (!HasExactlyOneBit(num_groups)) {
5182  grfmsg(1, "NewSpriteGroup: Random Action 2 nrand should be power of 2");
5183  }
5184 
5185  for (uint i = 0; i < num_groups; i++) {
5186  group->groups.push_back(GetGroupFromGroupID(setid, type, buf->ReadWord()));
5187  }
5188 
5189  break;
5190  }
5191 
5192  /* Neither a variable or randomized sprite group... must be a real group */
5193  default:
5194  {
5195  switch (feature) {
5196  case GSF_TRAINS:
5197  case GSF_ROADVEHICLES:
5198  case GSF_SHIPS:
5199  case GSF_AIRCRAFT:
5200  case GSF_STATIONS:
5201  case GSF_CANALS:
5202  case GSF_CARGOES:
5203  case GSF_AIRPORTS:
5204  case GSF_RAILTYPES:
5205  case GSF_ROADTYPES:
5206  case GSF_TRAMTYPES:
5207  {
5208  byte num_loaded = type;
5209  byte num_loading = buf->ReadByte();
5210 
5211  if (!_cur.HasValidSpriteSets(feature)) {
5212  grfmsg(0, "NewSpriteGroup: No sprite set to work on! Skipping");
5213  return;
5214  }
5215 
5216  grfmsg(6, "NewSpriteGroup: New SpriteGroup 0x%02X, %u loaded, %u loading",
5217  setid, num_loaded, num_loading);
5218 
5219  if (num_loaded + num_loading == 0) {
5220  grfmsg(1, "NewSpriteGroup: no result, skipping invalid RealSpriteGroup");
5221  break;
5222  }
5223 
5224  if (num_loaded + num_loading == 1) {
5225  /* Avoid creating 'Real' sprite group if only one option. */
5226  uint16 spriteid = buf->ReadWord();
5227  act_group = CreateGroupFromGroupID(feature, setid, type, spriteid);
5228  grfmsg(8, "NewSpriteGroup: one result, skipping RealSpriteGroup = subset %u", spriteid);
5229  break;
5230  }
5231 
5232  std::vector<uint16> loaded;
5233  std::vector<uint16> loading;
5234 
5235  for (uint i = 0; i < num_loaded; i++) {
5236  loaded.push_back(buf->ReadWord());
5237  grfmsg(8, "NewSpriteGroup: + rg->loaded[%i] = subset %u", i, loaded[i]);
5238  }
5239 
5240  for (uint i = 0; i < num_loading; i++) {
5241  loading.push_back(buf->ReadWord());
5242  grfmsg(8, "NewSpriteGroup: + rg->loading[%i] = subset %u", i, loading[i]);
5243  }
5244 
5245  if (std::adjacent_find(loaded.begin(), loaded.end(), std::not_equal_to<>()) == loaded.end() &&
5246  std::adjacent_find(loading.begin(), loading.end(), std::not_equal_to<>()) == loading.end() &&
5247  loaded[0] == loading[0])
5248  {
5249  /* Both lists only contain the same value, so don't create 'Real' sprite group */
5250  act_group = CreateGroupFromGroupID(feature, setid, type, loaded[0]);
5251  grfmsg(8, "NewSpriteGroup: same result, skipping RealSpriteGroup = subset %u", loaded[0]);
5252  break;
5253  }
5254 
5256  RealSpriteGroup *group = new RealSpriteGroup();
5257  group->nfo_line = _cur.nfo_line;
5258  act_group = group;
5259 
5260  for (uint16 spriteid : loaded) {
5261  const SpriteGroup *t = CreateGroupFromGroupID(feature, setid, type, spriteid);
5262  group->loaded.push_back(t);
5263  }
5264 
5265  for (uint16 spriteid : loading) {
5266  const SpriteGroup *t = CreateGroupFromGroupID(feature, setid, type, spriteid);
5267  group->loading.push_back(t);
5268  }
5269 
5270  break;
5271  }
5272 
5273  case GSF_HOUSES:
5274  case GSF_AIRPORTTILES:
5275  case GSF_OBJECTS:
5276  case GSF_INDUSTRYTILES: {
5277  byte num_building_sprites = std::max((uint8)1, type);
5278 
5281  group->nfo_line = _cur.nfo_line;
5282  act_group = group;
5283 
5284  /* On error, bail out immediately. Temporary GRF data was already freed */
5285  if (ReadSpriteLayout(buf, num_building_sprites, true, feature, false, type == 0, &group->dts)) return;
5286  break;
5287  }
5288 
5289  case GSF_INDUSTRIES: {
5290  if (type > 2) {
5291  grfmsg(1, "NewSpriteGroup: Unsupported industry production version %d, skipping", type);
5292  break;
5293  }
5294 
5297  group->nfo_line = _cur.nfo_line;
5298  act_group = group;
5299  group->version = type;
5300  if (type == 0) {
5301  group->num_input = 3;
5302  for (uint i = 0; i < 3; i++) {
5303  group->subtract_input[i] = (int16)buf->ReadWord(); // signed
5304  }
5305  group->num_output = 2;
5306  for (uint i = 0; i < 2; i++) {
5307  group->add_output[i] = buf->ReadWord(); // unsigned
5308  }
5309  group->again = buf->ReadByte();
5310  } else if (type == 1) {
5311  group->num_input = 3;
5312  for (uint i = 0; i < 3; i++) {
5313  group->subtract_input[i] = buf->ReadByte();
5314  }
5315  group->num_output = 2;
5316  for (uint i = 0; i < 2; i++) {
5317  group->add_output[i] = buf->ReadByte();
5318  }
5319  group->again = buf->ReadByte();
5320  } else if (type == 2) {
5321  group->num_input = buf->ReadByte();
5322  if (group->num_input > lengthof(group->subtract_input)) {
5323  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5324  error->data = "too many inputs (max 16)";
5325  return;
5326  }
5327  for (uint i = 0; i < group->num_input; i++) {
5328  byte rawcargo = buf->ReadByte();
5329  CargoID cargo = GetCargoTranslation(rawcargo, _cur.grffile);
5330  if (cargo == CT_INVALID) {
5331  /* The mapped cargo is invalid. This is permitted at this point,
5332  * as long as the result is not used. Mark it invalid so this
5333  * can be tested later. */
5334  group->version = 0xFF;
5335  } else if (std::find(group->cargo_input, group->cargo_input + i, cargo) != group->cargo_input + i) {
5336  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5337  error->data = "duplicate input cargo";
5338  return;
5339  }
5340  group->cargo_input[i] = cargo;
5341  group->subtract_input[i] = buf->ReadByte();
5342  }
5343  group->num_output = buf->ReadByte();
5344  if (group->num_output > lengthof(group->add_output)) {
5345  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5346  error->data = "too many outputs (max 16)";
5347  return;
5348  }
5349  for (uint i = 0; i < group->num_output; i++) {
5350  byte rawcargo = buf->ReadByte();
5351  CargoID cargo = GetCargoTranslation(rawcargo, _cur.grffile);
5352  if (cargo == CT_INVALID) {
5353  /* Mark this result as invalid to use */
5354  group->version = 0xFF;
5355  } else if (std::find(group->cargo_output, group->cargo_output + i, cargo) != group->cargo_output + i) {
5356  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5357  error->data = "duplicate output cargo";
5358  return;
5359  }
5360  group->cargo_output[i] = cargo;
5361  group->add_output[i] = buf->ReadByte();
5362  }
5363  group->again = buf->ReadByte();
5364  } else {
5365  NOT_REACHED();
5366  }
5367  break;
5368  }
5369 
5370  /* Loading of Tile Layout and Production Callback groups would happen here */
5371  default: grfmsg(1, "NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5372  }
5373  }
5374  }
5375 
5376  _cur.spritegroups[setid] = act_group;
5377 }
5378 
5379 static CargoID TranslateCargo(uint8 feature, uint8 ctype)
5380 {
5381  if (feature == GSF_OBJECTS) {
5382  switch (ctype) {
5383  case 0: return 0;
5384  case 0xFF: return CT_PURCHASE_OBJECT;
5385  default:
5386  grfmsg(1, "TranslateCargo: Invalid cargo bitnum %d for objects, skipping.", ctype);
5387  return CT_INVALID;
5388  }
5389  }
5390  /* Special cargo types for purchase list and stations */
5391  if (feature == GSF_STATIONS && ctype == 0xFE) return CT_DEFAULT_NA;
5392  if (ctype == 0xFF) return CT_PURCHASE;
5393 
5394  if (_cur.grffile->cargo_list.size() == 0) {
5395  /* No cargo table, so use bitnum values */
5396  if (ctype >= 32) {
5397  grfmsg(1, "TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype);
5398  return CT_INVALID;
5399  }
5400 
5401  for (const CargoSpec *cs : CargoSpec::Iterate()) {
5402  if (cs->bitnum == ctype) {
5403  grfmsg(6, "TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, cs->Index());
5404  return cs->Index();
5405  }
5406  }
5407 
5408  grfmsg(5, "TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype);
5409  return CT_INVALID;
5410  }
5411 
5412  /* Check if the cargo type is out of bounds of the cargo translation table */
5413  if (ctype >= _cur.grffile->cargo_list.size()) {
5414  grfmsg(1, "TranslateCargo: Cargo type %d out of range (max %d), skipping.", ctype, (unsigned int)_cur.grffile->cargo_list.size() - 1);
5415  return CT_INVALID;
5416  }
5417 
5418  /* Look up the cargo label from the translation table */
5419  CargoLabel cl = _cur.grffile->cargo_list[ctype];
5420  if (cl == 0) {
5421  grfmsg(5, "TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype);
5422  return CT_INVALID;
5423  }
5424 
5425  ctype = GetCargoIDByLabel(cl);
5426  if (ctype == CT_INVALID) {
5427  grfmsg(5, "TranslateCargo: Cargo '%c%c%c%c' unsupported, skipping.", GB(cl, 24, 8), GB(cl, 16, 8), GB(cl, 8, 8), GB(cl, 0, 8));
5428  return CT_INVALID;
5429  }
5430 
5431  grfmsg(6, "TranslateCargo: Cargo '%c%c%c%c' mapped to cargo type %d.", GB(cl, 24, 8), GB(cl, 16, 8), GB(cl, 8, 8), GB(cl, 0, 8), ctype);
5432  return ctype;
5433 }
5434 
5435 
5436 static bool IsValidGroupID(uint16 groupid, const char *function)
5437 {
5438  if (groupid > MAX_SPRITEGROUP || _cur.spritegroups[groupid] == nullptr) {
5439  grfmsg(1, "%s: Spritegroup 0x%04X out of range or empty, skipping.", function, groupid);
5440  return false;
5441  }
5442 
5443  return true;
5444 }
5445 
5446 static void VehicleMapSpriteGroup(ByteReader *buf, byte feature, uint8 idcount)
5447 {
5448  static EngineID *last_engines;
5449  static uint last_engines_count;
5450  bool wagover = false;
5451 
5452  /* Test for 'wagon override' flag */
5453  if (HasBit(idcount, 7)) {
5454  wagover = true;
5455  /* Strip off the flag */
5456  idcount = GB(idcount, 0, 7);
5457 
5458  if (last_engines_count == 0) {
5459  grfmsg(0, "VehicleMapSpriteGroup: WagonOverride: No engine to do override with");
5460  return;
5461  }
5462 
5463  grfmsg(6, "VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons",
5464  last_engines_count, idcount);
5465  } else {
5466  if (last_engines_count != idcount) {
5467  last_engines = ReallocT(last_engines, idcount);
5468  last_engines_count = idcount;
5469  }
5470  }
5471 
5472  EngineID *engines = AllocaM(EngineID, idcount);
5473  for (uint i = 0; i < idcount; i++) {
5474  Engine *e = GetNewEngine(_cur.grffile, (VehicleType)feature, buf->ReadExtendedByte());
5475  if (e == nullptr) {
5476  /* No engine could be allocated?!? Deal with it. Okay,
5477  * this might look bad. Also make sure this NewGRF
5478  * gets disabled, as a half loaded one is bad. */
5479  HandleChangeInfoResult("VehicleMapSpriteGroup", CIR_INVALID_ID, 0, 0);
5480  return;
5481  }
5482 
5483  engines[i] = e->index;
5484  if (!wagover) last_engines[i] = engines[i];
5485  }
5486 
5487  uint8 cidcount = buf->ReadByte();
5488  for (uint c = 0; c < cidcount; c++) {
5489  uint8 ctype = buf->ReadByte();
5490  uint16 groupid = buf->ReadWord();
5491  if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) continue;
5492 
5493  grfmsg(8, "VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid);
5494 
5495  ctype = TranslateCargo(feature, ctype);
5496  if (ctype == CT_INVALID) continue;
5497 
5498  for (uint i = 0; i < idcount; i++) {
5499  EngineID engine = engines[i];
5500 
5501  grfmsg(7, "VehicleMapSpriteGroup: [%d] Engine %d...", i, engine);
5502 
5503  if (wagover) {
5504  SetWagonOverrideSprites(engine, ctype, _cur.spritegroups[groupid], last_engines, last_engines_count);
5505  } else {
5506  SetCustomEngineSprites(engine, ctype, _cur.spritegroups[groupid]);
5507  }
5508  }
5509  }
5510 
5511  uint16 groupid = buf->ReadWord();
5512  if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) return;
5513 
5514  grfmsg(8, "-- Default group id 0x%04X", groupid);
5515 
5516  for (uint i = 0; i < idcount; i++) {
5517  EngineID engine = engines[i];
5518 
5519  if (wagover) {
5520  SetWagonOverrideSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid], last_engines, last_engines_count);
5521  } else {
5522  SetCustomEngineSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid]);
5523  SetEngineGRF(engine, _cur.grffile);
5524  }
5525  }
5526 }
5527 
5528 
5529 static void CanalMapSpriteGroup(ByteReader *buf, uint8 idcount)
5530 {
5531  CanalFeature *cfs = AllocaM(CanalFeature, idcount);
5532  for (uint i = 0; i < idcount; i++) {
5533  cfs[i] = (CanalFeature)buf->ReadByte();
5534  }
5535 
5536  uint8 cidcount = buf->ReadByte();
5537  buf->Skip(cidcount * 3);
5538 
5539  uint16 groupid = buf->ReadWord();
5540  if (!IsValidGroupID(groupid, "CanalMapSpriteGroup")) return;
5541 
5542  for (uint i = 0; i < idcount; i++) {
5543  CanalFeature cf = cfs[i];
5544 
5545  if (cf >= CF_END) {
5546  grfmsg(1, "CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf);
5547  continue;
5548  }
5549 
5550  _water_feature[cf].grffile = _cur.grffile;
5551  _water_feature[cf].group = _cur.spritegroups[groupid];
5552  }
5553 }
5554 
5555 
5556 static void StationMapSpriteGroup(ByteReader *buf, uint8 idcount)
5557 {
5558  uint8 *stations = AllocaM(uint8, idcount);
5559  for (uint i = 0; i < idcount; i++) {
5560  stations[i] = buf->ReadByte();
5561  }
5562 
5563  uint8 cidcount = buf->ReadByte();
5564  for (uint c = 0; c < cidcount; c++) {
5565  uint8 ctype = buf->ReadByte();
5566  uint16 groupid = buf->ReadWord();
5567  if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) continue;
5568 
5569  ctype = TranslateCargo(GSF_STATIONS, ctype);
5570  if (ctype == CT_INVALID) continue;
5571 
5572  for (uint i = 0; i < idcount; i++) {
5573  StationSpec *statspec = _cur.grffile->stations == nullptr ? nullptr : _cur.grffile->stations[stations[i]];
5574 
5575  if (statspec == nullptr) {
5576  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5577  continue;
5578  }
5579 
5580  statspec->grf_prop.spritegroup[ctype] = _cur.spritegroups[groupid];
5581  }
5582  }
5583 
5584  uint16 groupid = buf->ReadWord();
5585  if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) return;
5586 
5587  for (uint i = 0; i < idcount; i++) {
5588  StationSpec *statspec = _cur.grffile->stations == nullptr ? nullptr : _cur.grffile->stations[stations[i]];
5589 
5590  if (statspec == nullptr) {
5591  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5592  continue;
5593  }
5594 
5595  if (statspec->grf_prop.grffile != nullptr) {
5596  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X mapped multiple times, skipping", stations[i]);
5597  continue;
5598  }
5599 
5600  statspec->grf_prop.spritegroup[CT_DEFAULT] = _cur.spritegroups[groupid];
5601  statspec->grf_prop.grffile = _cur.grffile;
5602  statspec->grf_prop.local_id = stations[i];
5603  StationClass::Assign(statspec);
5604  }
5605 }
5606 
5607 
5608 static void TownHouseMapSpriteGroup(ByteReader *buf, uint8 idcount)
5609 {
5610  uint8 *houses = AllocaM(uint8, idcount);
5611  for (uint i = 0; i < idcount; i++) {
5612  houses[i] = buf->ReadByte();
5613  }
5614 
5615  /* Skip the cargo type section, we only care about the default group */
5616  uint8 cidcount = buf->ReadByte();
5617  buf->Skip(cidcount * 3);
5618 
5619  uint16 groupid = buf->ReadWord();
5620  if (!IsValidGroupID(groupid, "TownHouseMapSpriteGroup")) return;
5621 
5622  if (_cur.grffile->housespec == nullptr) {
5623  grfmsg(1, "TownHouseMapSpriteGroup: No houses defined, skipping");
5624  return;
5625  }
5626 
5627  for (uint i = 0; i < idcount; i++) {
5628  HouseSpec *hs = _cur.grffile->housespec[houses[i]];
5629 
5630  if (hs == nullptr) {
5631  grfmsg(1, "TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]);
5632  continue;
5633  }
5634 
5635  hs->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5636  }
5637 }
5638 
5639 static void IndustryMapSpriteGroup(ByteReader *buf, uint8 idcount)
5640 {
5641  uint8 *industries = AllocaM(uint8, idcount);
5642  for (uint i = 0; i < idcount; i++) {
5643  industries[i] = buf->ReadByte();
5644  }
5645 
5646  /* Skip the cargo type section, we only care about the default group */
5647  uint8 cidcount = buf->ReadByte();
5648  buf->Skip(cidcount * 3);
5649 
5650  uint16 groupid = buf->ReadWord();
5651  if (!IsValidGroupID(groupid, "IndustryMapSpriteGroup")) return;
5652 
5653  if (_cur.grffile->industryspec == nullptr) {
5654  grfmsg(1, "IndustryMapSpriteGroup: No industries defined, skipping");
5655  return;
5656  }
5657 
5658  for (uint i = 0; i < idcount; i++) {
5659  IndustrySpec *indsp = _cur.grffile->industryspec[industries[i]];
5660 
5661  if (indsp == nullptr) {
5662  grfmsg(1, "IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]);
5663  continue;
5664  }
5665 
5666  indsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5667  }
5668 }
5669 
5670 static void IndustrytileMapSpriteGroup(ByteReader *buf, uint8 idcount)
5671 {
5672  uint8 *indtiles = AllocaM(uint8, idcount);
5673  for (uint i = 0; i < idcount; i++) {
5674  indtiles[i] = buf->ReadByte();
5675  }
5676 
5677  /* Skip the cargo type section, we only care about the default group */
5678  uint8 cidcount = buf->ReadByte();
5679  buf->Skip(cidcount * 3);
5680 
5681  uint16 groupid = buf->ReadWord();
5682  if (!IsValidGroupID(groupid, "IndustrytileMapSpriteGroup")) return;
5683 
5684  if (_cur.grffile->indtspec == nullptr) {
5685  grfmsg(1, "IndustrytileMapSpriteGroup: No industry tiles defined, skipping");
5686  return;
5687  }
5688 
5689  for (uint i = 0; i < idcount; i++) {
5690  IndustryTileSpec *indtsp = _cur.grffile->indtspec[indtiles[i]];
5691 
5692  if (indtsp == nullptr) {
5693  grfmsg(1, "IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]);
5694  continue;
5695  }
5696 
5697  indtsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5698  }
5699 }
5700 
5701 static void CargoMapSpriteGroup(ByteReader *buf, uint8 idcount)
5702 {
5703  CargoID *cargoes = AllocaM(CargoID, idcount);
5704  for (uint i = 0; i < idcount; i++) {
5705  cargoes[i] = buf->ReadByte();
5706  }
5707 
5708  /* Skip the cargo type section, we only care about the default group */
5709  uint8 cidcount = buf->ReadByte();
5710  buf->Skip(cidcount * 3);
5711 
5712  uint16 groupid = buf->ReadWord();
5713  if (!IsValidGroupID(groupid, "CargoMapSpriteGroup")) return;
5714 
5715  for (uint i = 0; i < idcount; i++) {
5716  CargoID cid = cargoes[i];
5717 
5718  if (cid >= NUM_CARGO) {
5719  grfmsg(1, "CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid);
5720  continue;
5721  }
5722 
5723  CargoSpec *cs = CargoSpec::Get(cid);
5724  cs->grffile = _cur.grffile;
5725  cs->group = _cur.spritegroups[groupid];
5726  }
5727 }
5728 
5729 static void ObjectMapSpriteGroup(ByteReader *buf, uint8 idcount)
5730 {
5731  if (_cur.grffile->objectspec == nullptr) {
5732  grfmsg(1, "ObjectMapSpriteGroup: No object tiles defined, skipping");
5733  return;
5734  }
5735 
5736  uint8 *objects = AllocaM(uint8, idcount);
5737  for (uint i = 0; i < idcount; i++) {
5738  objects[i] = buf->ReadByte();
5739  }
5740 
5741  uint8 cidcount = buf->ReadByte();
5742  for (uint c = 0; c < cidcount; c++) {
5743  uint8 ctype = buf->ReadByte();
5744  uint16 groupid = buf->ReadWord();
5745  if (!IsValidGroupID(groupid, "ObjectMapSpriteGroup")) continue;
5746 
5747  ctype = TranslateCargo(GSF_OBJECTS, ctype);
5748  if (ctype == CT_INVALID) continue;
5749 
5750  for (uint i = 0; i < idcount; i++) {
5751  ObjectSpec *spec = _cur.grffile->objectspec[objects[i]];
5752 
5753  if (spec == nullptr) {
5754  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5755  continue;
5756  }
5757 
5758  spec->grf_prop.spritegroup[ctype] = _cur.spritegroups[groupid];
5759  }
5760  }
5761 
5762  uint16 groupid = buf->ReadWord();
5763  if (!IsValidGroupID(groupid, "ObjectMapSpriteGroup")) return;
5764 
5765  for (uint i = 0; i < idcount; i++) {
5766  ObjectSpec *spec = _cur.grffile->objectspec[objects[i]];
5767 
5768  if (spec == nullptr) {
5769  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5770  continue;
5771  }
5772 
5773  if (spec->grf_prop.grffile != nullptr) {
5774  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X mapped multiple times, skipping", objects[i]);
5775  continue;
5776  }
5777 
5778  spec->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5779  spec->grf_prop.grffile = _cur.grffile;
5780  spec->grf_prop.local_id = objects[i];
5781  }
5782 }
5783 
5784 static void RailTypeMapSpriteGroup(ByteReader *buf, uint8 idcount)
5785 {
5786  uint8 *railtypes = AllocaM(uint8, idcount);
5787  for (uint i = 0; i < idcount; i++) {
5788  uint8 id = buf->ReadByte();
5789  railtypes[i] = id < RAILTYPE_END ? _cur.grffile->railtype_map[id] : INVALID_RAILTYPE;
5790  }
5791 
5792  uint8 cidcount = buf->ReadByte();
5793  for (uint c = 0; c < cidcount; c++) {
5794  uint8 ctype = buf->ReadByte();
5795  uint16 groupid = buf->ReadWord();
5796  if (!IsValidGroupID(groupid, "RailTypeMapSpriteGroup")) continue;
5797 
5798  if (ctype >= RTSG_END) continue;
5799 
5800  extern RailtypeInfo _railtypes[RAILTYPE_END];
5801  for (uint i = 0; i < idcount; i++) {
5802  if (railtypes[i] != INVALID_RAILTYPE) {
5803  RailtypeInfo *rti = &_railtypes[railtypes[i]];
5804 
5805  rti->grffile[ctype] = _cur.grffile;
5806  rti->group[ctype] = _cur.spritegroups[groupid];
5807  }
5808  }
5809  }
5810 
5811  /* Railtypes do not use the default group. */
5812  buf->ReadWord();
5813 }
5814 
5815 static void RoadTypeMapSpriteGroup(ByteReader *buf, uint8 idcount, RoadTramType rtt)
5816 {
5817  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
5818 
5819  uint8 *roadtypes = AllocaM(uint8, idcount);
5820  for (uint i = 0; i < idcount; i++) {
5821  uint8 id = buf->ReadByte();
5822  roadtypes[i] = id < ROADTYPE_END ? type_map[id] : INVALID_ROADTYPE;
5823  }
5824 
5825  uint8 cidcount = buf->ReadByte();
5826  for (uint c = 0; c < cidcount; c++) {
5827  uint8 ctype = buf->ReadByte();
5828  uint16 groupid = buf->ReadWord();
5829  if (!IsValidGroupID(groupid, "RoadTypeMapSpriteGroup")) continue;
5830 
5831  if (ctype >= ROTSG_END) continue;
5832 
5833  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
5834  for (uint i = 0; i < idcount; i++) {
5835  if (roadtypes[i] != INVALID_ROADTYPE) {
5836  RoadTypeInfo *rti = &_roadtypes[roadtypes[i]];
5837 
5838  rti->grffile[ctype] = _cur.grffile;
5839  rti->group[ctype] = _cur.spritegroups[groupid];
5840  }
5841  }
5842  }
5843 
5844  /* Roadtypes do not use the default group. */
5845  buf->ReadWord();
5846 }
5847 
5848 static void AirportMapSpriteGroup(ByteReader *buf, uint8 idcount)
5849 {
5850  uint8 *airports = AllocaM(uint8, idcount);
5851  for (uint i = 0; i < idcount; i++) {
5852  airports[i] = buf->ReadByte();
5853  }
5854 
5855  /* Skip the cargo type section, we only care about the default group */
5856  uint8 cidcount = buf->ReadByte();
5857  buf->Skip(cidcount * 3);
5858 
5859  uint16 groupid = buf->ReadWord();
5860  if (!IsValidGroupID(groupid, "AirportMapSpriteGroup")) return;
5861 
5862  if (_cur.grffile->airportspec == nullptr) {
5863  grfmsg(1, "AirportMapSpriteGroup: No airports defined, skipping");
5864  return;
5865  }
5866 
5867  for (uint i = 0; i < idcount; i++) {
5868  AirportSpec *as = _cur.grffile->airportspec[airports[i]];
5869 
5870  if (as == nullptr) {
5871  grfmsg(1, "AirportMapSpriteGroup: Airport %d undefined, skipping", airports[i]);
5872  continue;
5873  }
5874 
5875  as->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5876  }
5877 }
5878 
5879 static void AirportTileMapSpriteGroup(ByteReader *buf, uint8 idcount)
5880 {
5881  uint8 *airptiles = AllocaM(uint8, idcount);
5882  for (uint i = 0; i < idcount; i++) {
5883  airptiles[i] = buf->ReadByte();
5884  }
5885 
5886  /* Skip the cargo type section, we only care about the default group */
5887  uint8 cidcount = buf->ReadByte();
5888  buf->Skip(cidcount * 3);
5889 
5890  uint16 groupid = buf->ReadWord();
5891  if (!IsValidGroupID(groupid, "AirportTileMapSpriteGroup")) return;
5892 
5893  if (_cur.grffile->airtspec == nullptr) {
5894  grfmsg(1, "AirportTileMapSpriteGroup: No airport tiles defined, skipping");
5895  return;
5896  }
5897 
5898  for (uint i = 0; i < idcount; i++) {
5899  AirportTileSpec *airtsp = _cur.grffile->airtspec[airptiles[i]];
5900 
5901  if (airtsp == nullptr) {
5902  grfmsg(1, "AirportTileMapSpriteGroup: Airport tile %d undefined, skipping", airptiles[i]);
5903  continue;
5904  }
5905 
5906  airtsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5907  }
5908 }
5909 
5910 
5911 /* Action 0x03 */
5912 static void FeatureMapSpriteGroup(ByteReader *buf)
5913 {
5914  /* <03> <feature> <n-id> <ids>... <num-cid> [<cargo-type> <cid>]... <def-cid>
5915  * id-list := [<id>] [id-list]
5916  * cargo-list := <cargo-type> <cid> [cargo-list]
5917  *
5918  * B feature see action 0
5919  * B n-id bits 0-6: how many IDs this definition applies to
5920  * bit 7: if set, this is a wagon override definition (see below)
5921  * B ids the IDs for which this definition applies
5922  * B num-cid number of cargo IDs (sprite group IDs) in this definition
5923  * can be zero, in that case the def-cid is used always
5924  * B cargo-type type of this cargo type (e.g. mail=2, wood=7, see below)
5925  * W cid cargo ID (sprite group ID) for this type of cargo
5926  * W def-cid default cargo ID (sprite group ID) */
5927 
5928  uint8 feature = buf->ReadByte();
5929  uint8 idcount = buf->ReadByte();
5930 
5931  if (feature >= GSF_END) {
5932  grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5933  return;
5934  }
5935 
5936  /* If idcount is zero, this is a feature callback */
5937  if (idcount == 0) {
5938  /* Skip number of cargo ids? */
5939  buf->ReadByte();
5940  uint16 groupid = buf->ReadWord();
5941  if (!IsValidGroupID(groupid, "FeatureMapSpriteGroup")) return;
5942 
5943  grfmsg(6, "FeatureMapSpriteGroup: Adding generic feature callback for feature 0x%02X", feature);
5944 
5945  AddGenericCallback(feature, _cur.grffile, _cur.spritegroups[groupid]);
5946  return;
5947  }
5948 
5949  /* Mark the feature as used by the grf (generic callbacks do not count) */
5950  SetBit(_cur.grffile->grf_features, feature);
5951 
5952  grfmsg(6, "FeatureMapSpriteGroup: Feature 0x%02X, %d ids", feature, idcount);
5953 
5954  switch (feature) {
5955  case GSF_TRAINS:
5956  case GSF_ROADVEHICLES:
5957  case GSF_SHIPS:
5958  case GSF_AIRCRAFT:
5959  VehicleMapSpriteGroup(buf, feature, idcount);
5960  return;
5961 
5962  case GSF_CANALS:
5963  CanalMapSpriteGroup(buf, idcount);
5964  return;
5965 
5966  case GSF_STATIONS:
5967  StationMapSpriteGroup(buf, idcount);
5968  return;
5969 
5970  case GSF_HOUSES:
5971  TownHouseMapSpriteGroup(buf, idcount);
5972  return;
5973 
5974  case GSF_INDUSTRIES:
5975  IndustryMapSpriteGroup(buf, idcount);
5976  return;
5977 
5978  case GSF_INDUSTRYTILES:
5979  IndustrytileMapSpriteGroup(buf, idcount);
5980  return;
5981 
5982  case GSF_CARGOES:
5983  CargoMapSpriteGroup(buf, idcount);
5984  return;
5985 
5986  case GSF_AIRPORTS:
5987  AirportMapSpriteGroup(buf, idcount);
5988  return;
5989 
5990  case GSF_OBJECTS:
5991  ObjectMapSpriteGroup(buf, idcount);
5992  break;
5993 
5994  case GSF_RAILTYPES:
5995  RailTypeMapSpriteGroup(buf, idcount);
5996  break;
5997 
5998  case GSF_ROADTYPES:
5999  RoadTypeMapSpriteGroup(buf, idcount, RTT_ROAD);
6000  break;
6001 
6002  case GSF_TRAMTYPES:
6003  RoadTypeMapSpriteGroup(buf, idcount, RTT_TRAM);
6004  break;
6005 
6006  case GSF_AIRPORTTILES:
6007  AirportTileMapSpriteGroup(buf, idcount);
6008  return;
6009 
6010  default:
6011  grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
6012  return;
6013  }
6014 }
6015 
6016 /* Action 0x04 */
6017 static void FeatureNewName(ByteReader *buf)
6018 {
6019  /* <04> <veh-type> <language-id> <num-veh> <offset> <data...>
6020  *
6021  * B veh-type see action 0 (as 00..07, + 0A
6022  * But IF veh-type = 48, then generic text
6023  * B language-id If bit 6 is set, This is the extended language scheme,
6024  * with up to 64 language.
6025  * Otherwise, it is a mapping where set bits have meaning
6026  * 0 = american, 1 = english, 2 = german, 3 = french, 4 = spanish
6027  * Bit 7 set means this is a generic text, not a vehicle one (or else)
6028  * B num-veh number of vehicles which are getting a new name
6029  * B/W offset number of the first vehicle that gets a new name
6030  * Byte : ID of vehicle to change
6031  * Word : ID of string to change/add
6032  * S data new texts, each of them zero-terminated, after
6033  * which the next name begins. */
6034 
6035  bool new_scheme = _cur.grffile->grf_version >= 7;
6036 
6037  uint8 feature = buf->ReadByte();
6038  if (feature >= GSF_END && feature != 0x48) {
6039  grfmsg(1, "FeatureNewName: Unsupported feature 0x%02X, skipping", feature);
6040  return;
6041  }
6042 
6043  uint8 lang = buf->ReadByte();
6044  uint8 num = buf->ReadByte();
6045  bool generic = HasBit(lang, 7);
6046  uint16 id;
6047  if (generic) {
6048  id = buf->ReadWord();
6049  } else if (feature <= GSF_AIRCRAFT) {
6050  id = buf->ReadExtendedByte();
6051  } else {
6052  id = buf->ReadByte();
6053  }
6054 
6055  ClrBit(lang, 7);
6056 
6057  uint16 endid = id + num;
6058 
6059  grfmsg(6, "FeatureNewName: About to rename engines %d..%d (feature 0x%02X) in language 0x%02X",
6060  id, endid, feature, lang);
6061 
6062  for (; id < endid && buf->HasData(); id++) {
6063  const char *name = buf->ReadString();
6064  grfmsg(8, "FeatureNewName: 0x%04X <- %s", id, name);
6065 
6066  switch (feature) {
6067  case GSF_TRAINS:
6068  case GSF_ROADVEHICLES:
6069  case GSF_SHIPS:
6070  case GSF_AIRCRAFT:
6071  if (!generic) {
6072  Engine *e = GetNewEngine(_cur.grffile, (VehicleType)feature, id, HasBit(_cur.grfconfig->flags, GCF_STATIC));
6073  if (e == nullptr) break;
6074  StringID string = AddGRFString(_cur.grffile->grfid, e->index, lang, new_scheme, false, name, e->info.string_id);
6075  e->info.string_id = string;
6076  } else {
6077  AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, true, name, STR_UNDEFINED);
6078  }
6079  break;
6080 
6081  default:
6082  if (IsInsideMM(id, 0xD000, 0xD400) || IsInsideMM(id, 0xD800, 0xE000)) {
6083  AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, true, name, STR_UNDEFINED);
6084  break;
6085  }
6086 
6087  switch (GB(id, 8, 8)) {
6088  case 0xC4: // Station class name
6089  if (_cur.grffile->stations == nullptr || _cur.grffile->stations[GB(id, 0, 8)] == nullptr) {
6090  grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
6091  } else {
6092  StationClassID cls_id = _cur.grffile->stations[GB(id, 0, 8)]->cls_id;
6093  StationClass::Get(cls_id)->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6094  }
6095  break;
6096 
6097  case 0xC5: // Station name
6098  if (_cur.grffile->stations == nullptr || _cur.grffile->stations[GB(id, 0, 8)] == nullptr) {
6099  grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
6100  } else {
6101  _cur.grffile->stations[GB(id, 0, 8)]->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6102  }
6103  break;
6104 
6105  case 0xC7: // Airporttile name
6106  if (_cur.grffile->airtspec == nullptr || _cur.grffile->airtspec[GB(id, 0, 8)] == nullptr) {
6107  grfmsg(1, "FeatureNewName: Attempt to name undefined airport tile 0x%X, ignoring", GB(id, 0, 8));
6108  } else {
6109  _cur.grffile->airtspec[GB(id, 0, 8)]->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6110  }
6111  break;
6112 
6113  case 0xC9: // House name
6114  if (_cur.grffile->housespec == nullptr || _cur.grffile->housespec[GB(id, 0, 8)] == nullptr) {
6115  grfmsg(1, "FeatureNewName: Attempt to name undefined house 0x%X, ignoring.", GB(id, 0, 8));
6116  } else {
6117  _cur.grffile->housespec[GB(id, 0, 8)]->building_name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6118  }
6119  break;
6120 
6121  default:
6122  grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id);
6123  break;
6124  }
6125  break;
6126  }
6127  }
6128 }
6129 
6138 static uint16 SanitizeSpriteOffset(uint16& num, uint16 offset, int max_sprites, const char *name)
6139 {
6140 
6141  if (offset >= max_sprites) {
6142  grfmsg(1, "GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites);
6143  uint orig_num = num;
6144  num = 0;
6145  return orig_num;
6146  }
6147 
6148  if (offset + num > max_sprites) {
6149  grfmsg(4, "GraphicsNew: %s sprite overflow, truncating...", name);
6150  uint orig_num = num;
6151  num = std::max(max_sprites - offset, 0);
6152  return orig_num - num;
6153  }
6154 
6155  return 0;
6156 }
6157 
6158 
6164 };
6166 struct Action5Type {
6169  uint16 min_sprites;
6170  uint16 max_sprites;
6171  const char *name;
6172 };
6173 
6175 static const Action5Type _action5_types[] = {
6176  /* Note: min_sprites should not be changed. Therefore these constants are directly here and not in sprites.h */
6177  /* 0x00 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x00" },
6178  /* 0x01 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x01" },
6179  /* 0x02 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x02" },
6180  /* 0x03 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x03" },
6181  /* 0x04 */ { A5BLOCK_ALLOW_OFFSET, SPR_SIGNALS_BASE, 1, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT, "Signal graphics" },
6182  /* 0x05 */ { A5BLOCK_ALLOW_OFFSET, SPR_ELRAIL_BASE, 1, ELRAIL_SPRITE_COUNT, "Rail catenary graphics" },
6183  /* 0x06 */ { A5BLOCK_ALLOW_OFFSET, SPR_SLOPES_BASE, 1, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT, "Foundation graphics" },
6184  /* 0x07 */ { A5BLOCK_INVALID, 0, 75, 0, "TTDP GUI graphics" }, // Not used by OTTD.
6185  /* 0x08 */ { A5BLOCK_ALLOW_OFFSET, SPR_CANALS_BASE, 1, CANALS_SPRITE_COUNT, "Canal graphics" },
6186  /* 0x09 */ { A5BLOCK_ALLOW_OFFSET, SPR_ONEWAY_BASE, 1, ONEWAY_SPRITE_COUNT, "One way road graphics" },
6187  /* 0x0A */ { A5BLOCK_ALLOW_OFFSET, SPR_2CCMAP_BASE, 1, TWOCCMAP_SPRITE_COUNT, "2CC colour maps" },
6188  /* 0x0B */ { A5BLOCK_ALLOW_OFFSET, SPR_TRAMWAY_BASE, 1, TRAMWAY_SPRITE_COUNT, "Tramway graphics" },
6189  /* 0x0C */ { A5BLOCK_INVALID, 0, 133, 0, "Snowy temperate tree" }, // Not yet used by OTTD.
6190  /* 0x0D */ { A5BLOCK_FIXED, SPR_SHORE_BASE, 16, SPR_SHORE_SPRITE_COUNT, "Shore graphics" },
6191  /* 0x0E */ { A5BLOCK_INVALID, 0, 0, 0, "New Signals graphics" }, // Not yet used by OTTD.
6192  /* 0x0F */ { A5BLOCK_ALLOW_OFFSET, SPR_TRACKS_FOR_SLOPES_BASE, 1, TRACKS_FOR_SLOPES_SPRITE_COUNT, "Sloped rail track" },
6193  /* 0x10 */ { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORTX_BASE, 1, AIRPORTX_SPRITE_COUNT, "Airport graphics" },
6194  /* 0x11 */ { A5BLOCK_ALLOW_OFFSET, SPR_ROADSTOP_BASE, 1, ROADSTOP_SPRITE_COUNT, "Road stop graphics" },
6195  /* 0x12 */ { A5BLOCK_ALLOW_OFFSET, SPR_AQUEDUCT_BASE, 1, AQUEDUCT_SPRITE_COUNT, "Aqueduct graphics" },
6196  /* 0x13 */ { A5BLOCK_ALLOW_OFFSET, SPR_AUTORAIL_BASE, 1, AUTORAIL_SPRITE_COUNT, "Autorail graphics" },
6197  /* 0x14 */ { A5BLOCK_INVALID, 0, 1, 0, "Flag graphics" }, // deprecated, no longer used.
6198  /* 0x15 */ { A5BLOCK_ALLOW_OFFSET, SPR_OPENTTD_BASE, 1, OPENTTD_SPRITE_COUNT, "OpenTTD GUI graphics" },
6199  /* 0x16 */ { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORT_PREVIEW_BASE, 1, SPR_AIRPORT_PREVIEW_COUNT, "Airport preview graphics" },
6200  /* 0x17 */ { A5BLOCK_ALLOW_OFFSET, SPR_RAILTYPE_TUNNEL_BASE, 1, RAILTYPE_TUNNEL_BASE_COUNT, "Railtype tunnel base" },
6201  /* 0x18 */ { A5BLOCK_ALLOW_OFFSET, SPR_PALETTE_BASE, 1, PALETTE_SPRITE_COUNT, "Palette" },
6202 };
6203 
6204 /* Action 0x05 */
6205 static void GraphicsNew(ByteReader *buf)
6206 {
6207  /* <05> <graphics-type> <num-sprites> <other data...>
6208  *
6209  * B graphics-type What set of graphics the sprites define.
6210  * E num-sprites How many sprites are in this set?
6211  * V other data Graphics type specific data. Currently unused. */
6212 
6213  uint8 type = buf->ReadByte();
6214  uint16 num = buf->ReadExtendedByte();
6215  uint16 offset = HasBit(type, 7) ? buf->ReadExtendedByte() : 0;
6216  ClrBit(type, 7); // Clear the high bit as that only indicates whether there is an offset.
6217 
6218  if ((type == 0x0D) && (num == 10) && HasBit(_cur.grfconfig->flags, GCF_SYSTEM)) {
6219  /* Special not-TTDP-compatible case used in openttd.grf
6220  * Missing shore sprites and initialisation of SPR_SHORE_BASE */
6221  grfmsg(2, "GraphicsNew: Loading 10 missing shore sprites from extra grf.");
6222  LoadNextSprite(SPR_SHORE_BASE + 0, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_S
6223  LoadNextSprite(SPR_SHORE_BASE + 5, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_W
6224  LoadNextSprite(SPR_SHORE_BASE + 7, *_cur.file, _cur.nfo_line++); // SLOPE_WSE
6225  LoadNextSprite(SPR_SHORE_BASE + 10, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_N
6226  LoadNextSprite(SPR_SHORE_BASE + 11, *_cur.file, _cur.nfo_line++); // SLOPE_NWS
6227  LoadNextSprite(SPR_SHORE_BASE + 13, *_cur.file, _cur.nfo_line++); // SLOPE_ENW
6228  LoadNextSprite(SPR_SHORE_BASE + 14, *_cur.file, _cur.nfo_line++); // SLOPE_SEN
6229  LoadNextSprite(SPR_SHORE_BASE + 15, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_E
6230  LoadNextSprite(SPR_SHORE_BASE + 16, *_cur.file, _cur.nfo_line++); // SLOPE_EW
6231  LoadNextSprite(SPR_SHORE_BASE + 17, *_cur.file, _cur.nfo_line++); // SLOPE_NS
6233  return;
6234  }
6235 
6236  /* Supported type? */
6237  if ((type >= lengthof(_action5_types)) || (_action5_types[type].block_type == A5BLOCK_INVALID)) {
6238  grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num);
6239  _cur.skip_sprites = num;
6240  return;
6241  }
6242 
6243  const Action5Type *action5_type = &_action5_types[type];
6244 
6245  /* Contrary to TTDP we allow always to specify too few sprites as we allow always an offset,
6246  * except for the long version of the shore type:
6247  * Ignore offset if not allowed */
6248  if ((action5_type->block_type != A5BLOCK_ALLOW_OFFSET) && (offset != 0)) {
6249  grfmsg(1, "GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->name, type);
6250  offset = 0;
6251  }
6252 
6253  /* Ignore action5 if too few sprites are specified. (for TTDP compatibility)
6254  * This does not make sense, if <offset> is allowed */
6255  if ((action5_type->block_type == A5BLOCK_FIXED) && (num < action5_type->min_sprites)) {
6256  grfmsg(1, "GraphicsNew: %s (type 0x%02X) count must be at least %d. Only %d were specified. Skipping.", action5_type->name, type, action5_type->min_sprites, num);
6257  _cur.skip_sprites = num;
6258  return;
6259  }
6260 
6261  /* Load at most max_sprites sprites. Skip remaining sprites. (for compatibility with TTDP and future extensions) */
6262  uint16 skip_num = SanitizeSpriteOffset(num, offset, action5_type->max_sprites, action5_type->name);
6263  SpriteID replace = action5_type->sprite_base + offset;
6264 
6265  /* Load <num> sprites starting from <replace>, then skip <skip_num> sprites. */
6266  grfmsg(2, "GraphicsNew: Replacing sprites %d to %d of %s (type 0x%02X) at SpriteID 0x%04X", offset, offset + num - 1, action5_type->name, type, replace);
6267 
6269 
6270  if (type == 0x0B) {
6271  static const SpriteID depot_with_track_offset = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_TRAMWAY_BASE;
6272  static const SpriteID depot_no_track_offset = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_TRAMWAY_BASE;
6273  if (offset <= depot_with_track_offset && offset + num > depot_with_track_offset) _loaded_newgrf_features.tram = TRAMWAY_REPLACE_DEPOT_WITH_TRACK;
6274  if (offset <= depot_no_track_offset && offset + num > depot_no_track_offset) _loaded_newgrf_features.tram = TRAMWAY_REPLACE_DEPOT_NO_TRACK;
6275  }
6276 
6277  /* If the baseset or grf only provides sprites for flat tiles (pre #10282), duplicate those for use on slopes. */
6278  bool dup_oneway_sprites = ((type == 0x09) && (offset + num <= SPR_ONEWAY_SLOPE_N_OFFSET));
6279 
6280  for (; num > 0; num--) {
6281  _cur.nfo_line++;
6282  int load_index = (replace == 0 ? _cur.spriteid++ : replace++);
6283  LoadNextSprite(load_index, *_cur.file, _cur.nfo_line);
6284  if (dup_oneway_sprites) {
6285  DupSprite(load_index, load_index + SPR_ONEWAY_SLOPE_N_OFFSET);
6286  DupSprite(load_index, load_index + SPR_ONEWAY_SLOPE_S_OFFSET);
6287  }
6288  }
6289 
6290  _cur.skip_sprites = skip_num;
6291 }
6292 
6293 /* Action 0x05 (SKIP) */
6294 static void SkipAct5(ByteReader *buf)
6295 {
6296  /* Ignore type byte */
6297  buf->ReadByte();
6298 
6299  /* Skip the sprites of this action */
6300  _cur.skip_sprites = buf->ReadExtendedByte();
6301 
6302  grfmsg(3, "SkipAct5: Skipping %d sprites", _cur.skip_sprites);
6303 }
6304 
6316 bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile)
6317 {
6318  switch (param) {
6319  case 0x00: // current date
6320  *value = std::max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);
6321  return true;
6322 
6323  case 0x01: // current year
6325  return true;
6326 
6327  case 0x02: { // detailed date information: month of year (bit 0-7), day of month (bit 8-12), leap year (bit 15), day of year (bit 16-24)
6328  YearMonthDay ymd;
6329  ConvertDateToYMD(_date, &ymd);
6330  Date start_of_year = ConvertYMDToDate(ymd.year, 0, 1);
6331  *value = ymd.month | (ymd.day - 1) << 8 | (IsLeapYear(ymd.year) ? 1 << 15 : 0) | (_date - start_of_year) << 16;
6332  return true;
6333  }
6334 
6335  case 0x03: // current climate, 0=temp, 1=arctic, 2=trop, 3=toyland
6337  return true;
6338 
6339  case 0x06: // road traffic side, bit 4 clear=left, set=right
6340  *value = _settings_game.vehicle.road_side << 4;
6341  return true;
6342 
6343  case 0x09: // date fraction
6344  *value = _date_fract * 885;
6345  return true;
6346 
6347  case 0x0A: // animation counter
6348  *value = GB(_tick_counter, 0, 16);
6349  return true;
6350 
6351  case 0x0B: { // TTDPatch version
6352  uint major = 2;
6353  uint minor = 6;
6354  uint revision = 1; // special case: 2.0.1 is 2.0.10
6355  uint build = 1382;
6356  *value = (major << 24) | (minor << 20) | (revision << 16) | build;
6357  return true;
6358  }
6359 
6360  case 0x0D: // TTD Version, 00=DOS, 01=Windows
6361  *value = _cur.grfconfig->palette & GRFP_USE_MASK;
6362  return true;
6363 
6364  case 0x0E: // Y-offset for train sprites
6365  *value = _cur.grffile->traininfo_vehicle_pitch;
6366  return true;
6367 
6368  case 0x0F: // Rail track type cost factors
6369  *value = 0;
6370  SB(*value, 0, 8, GetRailTypeInfo(RAILTYPE_RAIL)->cost_multiplier); // normal rail
6372  /* skip elrail multiplier - disabled */
6373  SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_MONO)->cost_multiplier); // monorail
6374  } else {
6375  SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_ELECTRIC)->cost_multiplier); // electified railway
6376  /* Skip monorail multiplier - no space in result */
6377  }
6378  SB(*value, 16, 8, GetRailTypeInfo(RAILTYPE_MAGLEV)->cost_multiplier); // maglev
6379  return true;
6380 
6381  case 0x11: // current rail tool type
6382  *value = 0; // constant fake value to avoid desync
6383  return true;
6384 
6385  case 0x12: // Game mode
6386  *value = _game_mode;
6387  return true;
6388 
6389  /* case 0x13: // Tile refresh offset to left not implemented */
6390  /* case 0x14: // Tile refresh offset to right not implemented */
6391  /* case 0x15: // Tile refresh offset upwards not implemented */
6392  /* case 0x16: // Tile refresh offset downwards not implemented */
6393  /* case 0x17: // temperate snow line not implemented */
6394 
6395  case 0x1A: // Always -1
6396  *value = UINT_MAX;
6397  return true;
6398 
6399  case 0x1B: // Display options
6400  *value = 0x3F; // constant fake value to avoid desync
6401  return true;
6402 
6403  case 0x1D: // TTD Platform, 00=TTDPatch, 01=OpenTTD
6404  *value = 1;
6405  return true;
6406 
6407  case 0x1E: // Miscellaneous GRF features
6408  *value = _misc_grf_features;
6409 
6410  /* Add the local flags */
6411  assert(!HasBit(*value, GMB_TRAIN_WIDTH_32_PIXELS));
6412  if (_cur.grffile->traininfo_vehicle_width == VEHICLEINFO_FULL_VEHICLE_WIDTH) SetBit(*value, GMB_TRAIN_WIDTH_32_PIXELS);
6413  return true;
6414 
6415  /* case 0x1F: // locale dependent settings not implemented to avoid desync */
6416 
6417  case 0x20: { // snow line height
6418  byte snowline = GetSnowLine();
6420  *value = Clamp(snowline * (grffile->grf_version >= 8 ? 1 : TILE_HEIGHT), 0, 0xFE);
6421  } else {
6422  /* No snow */
6423  *value = 0xFF;
6424  }
6425  return true;
6426  }
6427 
6428  case 0x21: // OpenTTD version
6429  *value = _openttd_newgrf_version;
6430  return true;
6431 
6432  case 0x22: // difficulty level
6433  *value = SP_CUSTOM;
6434  return true;
6435 
6436  case 0x23: // long format date
6437  *value = _date;
6438  return true;
6439 
6440  case 0x24: // long format year
6441  *value = _cur_year;
6442  return true;
6443 
6444  default: return false;
6445  }
6446 }
6447 
6448 static uint32 GetParamVal(byte param, uint32 *cond_val)
6449 {
6450  /* First handle variable common with VarAction2 */
6451  uint32 value;
6452  if (GetGlobalVariable(param - 0x80, &value, _cur.grffile)) return value;
6453 
6454  /* Non-common variable */
6455  switch (param) {
6456  case 0x84: { // GRF loading stage
6457  uint32 res = 0;
6458 
6459  if (_cur.stage > GLS_INIT) SetBit(res, 0);
6460  if (_cur.stage == GLS_RESERVE) SetBit(res, 8);
6461  if (_cur.stage == GLS_ACTIVATION) SetBit(res, 9);
6462  return res;
6463  }
6464 
6465  case 0x85: // TTDPatch flags, only for bit tests
6466  if (cond_val == nullptr) {
6467  /* Supported in Action 0x07 and 0x09, not 0x0D */
6468  return 0;
6469  } else {
6470  uint32 index = *cond_val / 0x20;
6471  uint32 param_val = index < lengthof(_ttdpatch_flags) ? _ttdpatch_flags[index] : 0;
6472  *cond_val %= 0x20;
6473  return param_val;
6474  }
6475 
6476  case 0x88: // GRF ID check
6477  return 0;
6478 
6479  /* case 0x99: Global ID offset not implemented */
6480 
6481  default:
6482  /* GRF Parameter */
6483  if (param < 0x80) return _cur.grffile->GetParam(param);
6484 
6485  /* In-game variable. */
6486  grfmsg(1, "Unsupported in-game variable 0x%02X", param);
6487  return UINT_MAX;
6488  }
6489 }
6490 
6491 /* Action 0x06 */
6492 static void CfgApply(ByteReader *buf)
6493 {
6494  /* <06> <param-num> <param-size> <offset> ... <FF>
6495  *
6496  * B param-num Number of parameter to substitute (First = "zero")
6497  * Ignored if that parameter was not specified in newgrf.cfg
6498  * B param-size How many bytes to replace. If larger than 4, the
6499  * bytes of the following parameter are used. In that
6500  * case, nothing is applied unless *all* parameters
6501  * were specified.
6502  * B offset Offset into data from beginning of next sprite
6503  * to place where parameter is to be stored. */
6504 
6505  /* Preload the next sprite */
6506  SpriteFile &file = *_cur.file;
6507  size_t pos = file.GetPos();
6508  uint32 num = file.GetContainerVersion() >= 2 ? file.ReadDword() : file.ReadWord();
6509  uint8 type = file.ReadByte();
6510  byte *preload_sprite = nullptr;
6511 
6512  /* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */
6513  if (type == 0xFF) {
6514  preload_sprite = MallocT<byte>(num);
6515  file.ReadBlock(preload_sprite, num);
6516  }
6517 
6518  /* Reset the file position to the start of the next sprite */
6519  file.SeekTo(pos, SEEK_SET);
6520 
6521  if (type != 0xFF) {
6522  grfmsg(2, "CfgApply: Ignoring (next sprite is real, unsupported)");
6523  free(preload_sprite);
6524  return;
6525  }
6526 
6527  GRFLocation location(_cur.grfconfig->ident.grfid, _cur.nfo_line + 1);
6528  GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
6529  if (it != _grf_line_to_action6_sprite_override.end()) {
6530  free(preload_sprite);
6531  preload_sprite = _grf_line_to_action6_sprite_override[location];
6532  } else {
6533  _grf_line_to_action6_sprite_override[location] = preload_sprite;
6534  }
6535 
6536  /* Now perform the Action 0x06 on our data. */
6537 
6538  for (;;) {
6539  uint i;
6540  uint param_num;
6541  uint param_size;
6542  uint offset;
6543  bool add_value;
6544 
6545  /* Read the parameter to apply. 0xFF indicates no more data to change. */
6546  param_num = buf->ReadByte();
6547  if (param_num == 0xFF) break;
6548 
6549  /* Get the size of the parameter to use. If the size covers multiple
6550  * double words, sequential parameter values are used. */
6551  param_size = buf->ReadByte();
6552 
6553  /* Bit 7 of param_size indicates we should add to the original value
6554  * instead of replacing it. */
6555  add_value = HasBit(param_size, 7);
6556  param_size = GB(param_size, 0, 7);
6557 
6558  /* Where to apply the data to within the pseudo sprite data. */
6559  offset = buf->ReadExtendedByte();
6560 
6561  /* If the parameter is a GRF parameter (not an internal variable) check
6562  * if it (and all further sequential parameters) has been defined. */
6563  if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur.grffile->param_end) {
6564  grfmsg(2, "CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4));
6565  break;
6566  }
6567 
6568  grfmsg(8, "CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset);
6569 
6570  bool carry = false;
6571  for (i = 0; i < param_size && offset + i < num; i++) {
6572  uint32 value = GetParamVal(param_num + i / 4, nullptr);
6573  /* Reset carry flag for each iteration of the variable (only really
6574  * matters if param_size is greater than 4) */
6575  if (i % 4 == 0) carry = false;
6576 
6577  if (add_value) {
6578  uint new_value = preload_sprite[offset + i] + GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0);
6579  preload_sprite[offset + i] = GB(new_value, 0, 8);
6580  /* Check if the addition overflowed */
6581  carry = new_value >= 256;
6582  } else {
6583  preload_sprite[offset + i] = GB(value, (i % 4) * 8, 8);
6584  }
6585  }
6586  }
6587 }
6588 
6599 {
6600  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_STATIC_GRF_CAUSES_DESYNC, c);
6601  error->data = _cur.grfconfig->GetName();
6602 }
6603 
6604 /* Action 0x07
6605  * Action 0x09 */
6606 static void SkipIf(ByteReader *buf)
6607 {
6608  /* <07/09> <param-num> <param-size> <condition-type> <value> <num-sprites>
6609  *
6610  * B param-num
6611  * B param-size
6612  * B condition-type
6613  * V value
6614  * B num-sprites */
6615  uint32 cond_val = 0;
6616  uint32 mask = 0;
6617  bool result;
6618 
6619  uint8 param = buf->ReadByte();
6620  uint8 paramsize = buf->ReadByte();
6621  uint8 condtype = buf->ReadByte();
6622 
6623  if (condtype < 2) {
6624  /* Always 1 for bit tests, the given value should be ignored. */
6625  paramsize = 1;
6626  }
6627 
6628  switch (paramsize) {
6629  case 8: cond_val = buf->ReadDWord(); mask = buf->ReadDWord(); break;
6630  case 4: cond_val = buf->ReadDWord(); mask = 0xFFFFFFFF; break;
6631  case 2: cond_val = buf->ReadWord(); mask = 0x0000FFFF; break;
6632  case 1: cond_val = buf->ReadByte(); mask = 0x000000FF; break;
6633  default: break;
6634  }
6635 
6636  if (param < 0x80 && _cur.grffile->param_end <= param) {
6637  grfmsg(7, "SkipIf: Param %d undefined, skipping test", param);
6638  return;
6639  }
6640 
6641  grfmsg(7, "SkipIf: Test condtype %d, param 0x%02X, condval 0x%08X", condtype, param, cond_val);
6642 
6643  /* condtypes that do not use 'param' are always valid.
6644  * condtypes that use 'param' are either not valid for param 0x88, or they are only valid for param 0x88.
6645  */
6646  if (condtype >= 0x0B) {
6647  /* Tests that ignore 'param' */
6648  switch (condtype) {
6649  case 0x0B: result = GetCargoIDByLabel(BSWAP32(cond_val)) == CT_INVALID;
6650  break;
6651  case 0x0C: result = GetCargoIDByLabel(BSWAP32(cond_val)) != CT_INVALID;
6652  break;
6653  case 0x0D: result = GetRailTypeByLabel(BSWAP32(cond_val)) == INVALID_RAILTYPE;
6654  break;
6655  case 0x0E: result = GetRailTypeByLabel(BSWAP32(cond_val)) != INVALID_RAILTYPE;
6656  break;
6657  case 0x0F: {
6658  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6659  result = rt == INVALID_ROADTYPE || !RoadTypeIsRoad(rt);
6660  break;
6661  }
6662  case 0x10: {
6663  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6664  result = rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt);
6665  break;
6666  }
6667  case 0x11: {
6668  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6669  result = rt == INVALID_ROADTYPE || !RoadTypeIsTram(rt);
6670  break;
6671  }
6672  case 0x12: {
6673  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6674  result = rt != INVALID_ROADTYPE && RoadTypeIsTram(rt);
6675  break;
6676  }
6677  default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return;
6678  }
6679  } else if (param == 0x88) {
6680  /* GRF ID checks */
6681 
6682  GRFConfig *c = GetGRFConfig(cond_val, mask);
6683 
6684  if (c != nullptr && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur.grfconfig->flags, GCF_STATIC) && _networking) {
6686  c = nullptr;
6687  }
6688 
6689  if (condtype != 10 && c == nullptr) {
6690  grfmsg(7, "SkipIf: GRFID 0x%08X unknown, skipping test", BSWAP32(cond_val));
6691  return;
6692  }
6693 
6694  switch (condtype) {
6695  /* Tests 0x06 to 0x0A are only for param 0x88, GRFID checks */
6696  case 0x06: // Is GRFID active?
6697  result = c->status == GCS_ACTIVATED;
6698  break;
6699 
6700  case 0x07: // Is GRFID non-active?
6701  result = c->status != GCS_ACTIVATED;
6702  break;
6703 
6704  case 0x08: // GRFID is not but will be active?
6705  result = c->status == GCS_INITIALISED;
6706  break;
6707 
6708  case 0x09: // GRFID is or will be active?
6709  result = c->status == GCS_ACTIVATED || c->status == GCS_INITIALISED;
6710  break;
6711 
6712  case 0x0A: // GRFID is not nor will be active
6713  /* This is the only condtype that doesn't get ignored if the GRFID is not found */
6714  result = c == nullptr || c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND;
6715  break;
6716 
6717  default: grfmsg(1, "SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype); return;
6718  }
6719  } else {
6720  /* Tests that use 'param' and are not GRF ID checks. */
6721  uint32 param_val = GetParamVal(param, &cond_val); // cond_val is modified for param == 0x85
6722  switch (condtype) {
6723  case 0x00: result = !!(param_val & (1 << cond_val));
6724  break;
6725  case 0x01: result = !(param_val & (1 << cond_val));
6726  break;
6727  case 0x02: result = (param_val & mask) == cond_val;
6728  break;
6729  case 0x03: result = (param_val & mask) != cond_val;
6730  break;
6731  case 0x04: result = (param_val & mask) < cond_val;
6732  break;
6733  case 0x05: result = (param_val & mask) > cond_val;
6734  break;
6735  default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return;
6736  }
6737  }
6738 
6739  if (!result) {
6740  grfmsg(2, "SkipIf: Not skipping sprites, test was false");
6741  return;
6742  }
6743 
6744  uint8 numsprites = buf->ReadByte();
6745 
6746  /* numsprites can be a GOTO label if it has been defined in the GRF
6747  * file. The jump will always be the first matching label that follows
6748  * the current nfo_line. If no matching label is found, the first matching
6749  * label in the file is used. */
6750  const GRFLabel *choice = nullptr;
6751  for (const auto &label : _cur.grffile->labels) {
6752  if (label.label != numsprites) continue;
6753 
6754  /* Remember a goto before the current line */
6755  if (choice == nullptr) choice = &label;
6756  /* If we find a label here, this is definitely good */
6757  if (label.nfo_line > _cur.nfo_line) {
6758  choice = &label;
6759  break;
6760  }
6761  }
6762 
6763  if (choice != nullptr) {
6764  grfmsg(2, "SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line);
6765  _cur.file->SeekTo(choice->pos, SEEK_SET);
6766  _cur.nfo_line = choice->nfo_line;
6767  return;
6768  }
6769 
6770  grfmsg(2, "SkipIf: Skipping %d sprites, test was true", numsprites);
6771  _cur.skip_sprites = numsprites;
6772  if (_cur.skip_sprites == 0) {
6773  /* Zero means there are no sprites to skip, so
6774  * we use -1 to indicate that all further
6775  * sprites should be skipped. */
6776  _cur.skip_sprites = -1;
6777 
6778  /* If an action 8 hasn't been encountered yet, disable the grf. */
6779  if (_cur.grfconfig->status != (_cur.stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED)) {
6780  DisableGrf();
6781  }
6782  }
6783 }
6784 
6785 
6786 /* Action 0x08 (GLS_FILESCAN) */
6787 static void ScanInfo(ByteReader *buf)
6788 {
6789  uint8 grf_version = buf->ReadByte();
6790  uint32 grfid = buf->ReadDWord();
6791  const char *name = buf->ReadString();
6792 
6793  _cur.grfconfig->ident.grfid = grfid;
6794 
6795  if (grf_version < 2 || grf_version > 8) {
6797  Debug(grf, 0, "{}: NewGRF \"{}\" (GRFID {:08X}) uses GRF version {}, which is incompatible with this version of OpenTTD.", _cur.grfconfig->filename, name, BSWAP32(grfid), grf_version);
6798  }
6799 
6800  /* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */
6801  if (GB(grfid, 0, 8) == 0xFF) SetBit(_cur.grfconfig->flags, GCF_SYSTEM);
6802 
6803  AddGRFTextToList(_cur.grfconfig->name, 0x7F, grfid, false, name);
6804 
6805  if (buf->HasData()) {
6806  const char *info = buf->ReadString();
6807  AddGRFTextToList(_cur.grfconfig->info, 0x7F, grfid, true, info);
6808  }
6809 
6810  /* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */
6811  _cur.skip_sprites = -1;
6812 }
6813 
6814 /* Action 0x08 */
6815 static void GRFInfo(ByteReader *buf)
6816 {
6817  /* <08> <version> <grf-id> <name> <info>
6818  *
6819  * B version newgrf version, currently 06
6820  * 4*B grf-id globally unique ID of this .grf file
6821  * S name name of this .grf set
6822  * S info string describing the set, and e.g. author and copyright */
6823 
6824  uint8 version = buf->ReadByte();
6825  uint32 grfid = buf->ReadDWord();
6826  const char *name = buf->ReadString();
6827 
6828  if (_cur.stage < GLS_RESERVE && _cur.grfconfig->status != GCS_UNKNOWN) {
6829  DisableGrf(STR_NEWGRF_ERROR_MULTIPLE_ACTION_8);
6830  return;
6831  }
6832 
6833  if (_cur.grffile->grfid != grfid) {
6834  Debug(grf, 0, "GRFInfo: GRFID {:08X} in FILESCAN stage does not match GRFID {:08X} in INIT/RESERVE/ACTIVATION stage", BSWAP32(_cur.grffile->grfid), BSWAP32(grfid));
6835  _cur.grffile->grfid = grfid;
6836  }
6837 
6838  _cur.grffile->grf_version = version;
6839  _cur.grfconfig->status = _cur.stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED;
6840 
6841  /* Do swap the GRFID for displaying purposes since people expect that */
6842  Debug(grf, 1, "GRFInfo: Loaded GRFv{} set {:08X} - {} (palette: {}, version: {})", version, BSWAP32(grfid), name, (_cur.grfconfig->palette & GRFP_USE_MASK) ? "Windows" : "DOS", _cur.grfconfig->version);
6843 }
6844 
6845 /* Action 0x0A */
6846 static void SpriteReplace(ByteReader *buf)
6847 {
6848  /* <0A> <num-sets> <set1> [<set2> ...]
6849  * <set>: <num-sprites> <first-sprite>
6850  *
6851  * B num-sets How many sets of sprites to replace.
6852  * Each set:
6853  * B num-sprites How many sprites are in this set
6854  * W first-sprite First sprite number to replace */
6855 
6856  uint8 num_sets = buf->ReadByte();
6857 
6858  for (uint i = 0; i < num_sets; i++) {
6859  uint8 num_sprites = buf->ReadByte();
6860  uint16 first_sprite = buf->ReadWord();
6861 
6862  grfmsg(2, "SpriteReplace: [Set %d] Changing %d sprites, beginning with %d",
6863  i, num_sprites, first_sprite
6864  );
6865 
6866  for (uint j = 0; j < num_sprites; j++) {
6867  int load_index = first_sprite + j;
6868  _cur.nfo_line++;
6869  LoadNextSprite(load_index, *_cur.file, _cur.nfo_line); // XXX
6870 
6871  /* Shore sprites now located at different addresses.
6872  * So detect when the old ones get replaced. */
6873  if (IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) {
6875  }
6876  }
6877  }
6878 }
6879 
6880 /* Action 0x0A (SKIP) */
6881 static void SkipActA(ByteReader *buf)
6882 {
6883  uint8 num_sets = buf->ReadByte();
6884 
6885  for (uint i = 0; i < num_sets; i++) {
6886  /* Skip the sprites this replaces */
6887  _cur.skip_sprites += buf->ReadByte();
6888  /* But ignore where they go */
6889  buf->ReadWord();
6890  }
6891 
6892  grfmsg(3, "SkipActA: Skipping %d sprites", _cur.skip_sprites);
6893 }
6894 
6895 /* Action 0x0B */
6896 static void GRFLoadError(ByteReader *buf)
6897 {
6898  /* <0B> <severity> <language-id> <message-id> [<message...> 00] [<data...>] 00 [<parnum>]
6899  *
6900  * B severity 00: notice, continue loading grf file
6901  * 01: warning, continue loading grf file
6902  * 02: error, but continue loading grf file, and attempt
6903  * loading grf again when loading or starting next game
6904  * 03: error, abort loading and prevent loading again in
6905  * the future (only when restarting the patch)
6906  * B language-id see action 4, use 1F for built-in error messages
6907  * B message-id message to show, see below
6908  * S message for custom messages (message-id FF), text of the message
6909  * not present for built-in messages.
6910  * V data additional data for built-in (or custom) messages
6911  * B parnum parameter numbers to be shown in the message (maximum of 2) */
6912 
6913  static const StringID msgstr[] = {
6914  STR_NEWGRF_ERROR_VERSION_NUMBER,
6915  STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
6916  STR_NEWGRF_ERROR_UNSET_SWITCH,
6917  STR_NEWGRF_ERROR_INVALID_PARAMETER,
6918  STR_NEWGRF_ERROR_LOAD_BEFORE,
6919  STR_NEWGRF_ERROR_LOAD_AFTER,
6920  STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
6921  };
6922 
6923  static const StringID sevstr[] = {
6924  STR_NEWGRF_ERROR_MSG_INFO,
6925  STR_NEWGRF_ERROR_MSG_WARNING,
6926  STR_NEWGRF_ERROR_MSG_ERROR,
6927  STR_NEWGRF_ERROR_MSG_FATAL
6928  };
6929 
6930  byte severity = buf->ReadByte();
6931  byte lang = buf->ReadByte();
6932  byte message_id = buf->ReadByte();
6933 
6934  /* Skip the error if it isn't valid for the current language. */
6935  if (!CheckGrfLangID(lang, _cur.grffile->grf_version)) return;
6936 
6937  /* Skip the error until the activation stage unless bit 7 of the severity
6938  * is set. */
6939  if (!HasBit(severity, 7) && _cur.stage == GLS_INIT) {
6940  grfmsg(7, "GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur.stage);
6941  return;
6942  }
6943  ClrBit(severity, 7);
6944 
6945  if (severity >= lengthof(sevstr)) {
6946  grfmsg(7, "GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity);
6947  severity = 2;
6948  } else if (severity == 3) {
6949  /* This is a fatal error, so make sure the GRF is deactivated and no
6950  * more of it gets loaded. */
6951  DisableGrf();
6952 
6953  /* Make sure we show fatal errors, instead of silly infos from before */
6954  delete _cur.grfconfig->error;
6955  _cur.grfconfig->error = nullptr;
6956  }
6957 
6958  if (message_id >= lengthof(msgstr) && message_id != 0xFF) {
6959  grfmsg(7, "GRFLoadError: Invalid message id.");
6960  return;
6961  }
6962 
6963  if (buf->Remaining() <= 1) {
6964  grfmsg(7, "GRFLoadError: No message data supplied.");
6965  return;
6966  }
6967 
6968  /* For now we can only show one message per newgrf file. */
6969  if (_cur.grfconfig->error != nullptr) return;
6970 
6971  GRFError *error = new GRFError(sevstr[severity]);
6972 
6973  if (message_id == 0xFF) {
6974  /* This is a custom error message. */
6975  if (buf->HasData()) {
6976  const char *message = buf->ReadString();
6977 
6978  error->custom_message = TranslateTTDPatchCodes(_cur.grffile->grfid, lang, true, message, SCC_RAW_STRING_POINTER);
6979  } else {
6980  grfmsg(7, "GRFLoadError: No custom message supplied.");
6981  error->custom_message.clear();
6982  }
6983  } else {
6984  error->message = msgstr[message_id];
6985  }
6986 
6987  if (buf->HasData()) {
6988  const char *data = buf->ReadString();
6989 
6990  error->data = TranslateTTDPatchCodes(_cur.grffile->grfid, lang, true, data);
6991  } else {
6992  grfmsg(7, "GRFLoadError: No message data supplied.");
6993  error->data.clear();
6994  }
6995 
6996  /* Only two parameter numbers can be used in the string. */
6997  for (uint i = 0; i < lengthof(error->param_value) && buf->HasData(); i++) {
6998  uint param_number = buf->ReadByte();
6999  error->param_value[i] = _cur.grffile->GetParam(param_number);
7000  }
7001 
7002  _cur.grfconfig->error = error;
7003 }
7004 
7005 /* Action 0x0C */
7006 static void GRFComment(ByteReader *buf)
7007 {
7008  /* <0C> [<ignored...>]
7009  *
7010  * V ignored Anything following the 0C is ignored */
7011 
7012  if (!buf->HasData()) return;
7013 
7014  const char *text = buf->ReadString();
7015  grfmsg(2, "GRFComment: %s", text);
7016 }
7017 
7018 /* Action 0x0D (GLS_SAFETYSCAN) */
7019 static void SafeParamSet(ByteReader *buf)
7020 {
7021  uint8 target = buf->ReadByte();
7022 
7023  /* Writing GRF parameters and some bits of 'misc GRF features' are safe. */
7024  if (target < 0x80 || target == 0x9E) return;
7025 
7026  /* GRM could be unsafe, but as here it can only happen after other GRFs
7027  * are loaded, it should be okay. If the GRF tried to use the slots it
7028  * reserved, it would be marked unsafe anyway. GRM for (e.g. bridge)
7029  * sprites is considered safe. */
7030 
7031  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
7032 
7033  /* Skip remainder of GRF */
7034  _cur.skip_sprites = -1;
7035 }
7036 
7037 
7038 static uint32 GetPatchVariable(uint8 param)
7039 {
7040  switch (param) {
7041  /* start year - 1920 */
7043 
7044  /* freight trains weight factor */
7045  case 0x0E: return _settings_game.vehicle.freight_trains;
7046 
7047  /* empty wagon speed increase */
7048  case 0x0F: return 0;
7049 
7050  /* plane speed factor; our patch option is reversed from TTDPatch's,
7051  * the following is good for 1x, 2x and 4x (most common?) and...
7052  * well not really for 3x. */
7053  case 0x10:
7055  default:
7056  case 4: return 1;
7057  case 3: return 2;
7058  case 2: return 2;
7059  case 1: return 4;
7060  }
7061 
7062 
7063  /* 2CC colourmap base sprite */
7064  case 0x11: return SPR_2CCMAP_BASE;
7065 
7066  /* map size: format = -MABXYSS
7067  * M : the type of map
7068  * bit 0 : set : squared map. Bit 1 is now not relevant
7069  * clear : rectangle map. Bit 1 will indicate the bigger edge of the map
7070  * bit 1 : set : Y is the bigger edge. Bit 0 is clear
7071  * clear : X is the bigger edge.
7072  * A : minimum edge(log2) of the map
7073  * B : maximum edge(log2) of the map
7074  * XY : edges(log2) of each side of the map.
7075  * SS : combination of both X and Y, thus giving the size(log2) of the map
7076  */
7077  case 0x13: {
7078  byte map_bits = 0;
7079  byte log_X = MapLogX() - 6; // subtraction is required to make the minimal size (64) zero based
7080  byte log_Y = MapLogY() - 6;
7081  byte max_edge = std::max(log_X, log_Y);
7082 
7083  if (log_X == log_Y) { // we have a squared map, since both edges are identical
7084  SetBit(map_bits, 0);
7085  } else {
7086  if (max_edge == log_Y) SetBit(map_bits, 1); // edge Y been the biggest, mark it
7087  }
7088 
7089  return (map_bits << 24) | (std::min(log_X, log_Y) << 20) | (max_edge << 16) |
7090  (log_X << 12) | (log_Y << 8) | (log_X + log_Y);
7091  }
7092 
7093  /* The maximum height of the map. */
7094  case 0x14:
7096 
7097  /* Extra foundations base sprite */
7098  case 0x15:
7099  return SPR_SLOPES_BASE;
7100 
7101  /* Shore base sprite */
7102  case 0x16:
7103  return SPR_SHORE_BASE;
7104 
7105  /* Game map seed */
7106  case 0x17:
7108 
7109  default:
7110  grfmsg(2, "ParamSet: Unknown Patch variable 0x%02X.", param);
7111  return 0;
7112  }
7113 }
7114 
7115 
7116 static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target, const char *type)
7117 {
7118  uint start = 0;
7119  uint size = 0;
7120 
7121  if (op == 6) {
7122  /* Return GRFID of set that reserved ID */
7123  return grm[_cur.grffile->GetParam(target)];
7124  }
7125 
7126  /* With an operation of 2 or 3, we want to reserve a specific block of IDs */
7127  if (op == 2 || op == 3) start = _cur.grffile->GetParam(target);
7128 
7129  for (uint i = start; i < num_ids; i++) {
7130  if (grm[i] == 0) {
7131  size++;
7132  } else {
7133  if (op == 2 || op == 3) break;
7134  start = i + 1;
7135  size = 0;
7136  }
7137 
7138  if (size == count) break;
7139  }
7140 
7141  if (size == count) {
7142  /* Got the slot... */
7143  if (op == 0 || op == 3) {
7144  grfmsg(2, "ParamSet: GRM: Reserving %d %s at %d", count, type, start);
7145  for (uint i = 0; i < count; i++) grm[start + i] = _cur.grffile->grfid;
7146  }
7147  return start;
7148  }
7149 
7150  /* Unable to allocate */
7151  if (op != 4 && op != 5) {
7152  /* Deactivate GRF */
7153  grfmsg(0, "ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type);
7154  DisableGrf(STR_NEWGRF_ERROR_GRM_FAILED);
7155  return UINT_MAX;
7156  }
7157 
7158  grfmsg(1, "ParamSet: GRM: Unable to allocate %d %s", count, type);
7159  return UINT_MAX;
7160 }
7161 
7162 
7164 static void ParamSet(ByteReader *buf)
7165 {
7166  /* <0D> <target> <operation> <source1> <source2> [<data>]
7167  *
7168  * B target parameter number where result is stored
7169  * B operation operation to perform, see below
7170  * B source1 first source operand
7171  * B source2 second source operand
7172  * D data data to use in the calculation, not necessary
7173  * if both source1 and source2 refer to actual parameters
7174  *
7175  * Operations
7176  * 00 Set parameter equal to source1
7177  * 01 Addition, source1 + source2
7178  * 02 Subtraction, source1 - source2
7179  * 03 Unsigned multiplication, source1 * source2 (both unsigned)
7180  * 04 Signed multiplication, source1 * source2 (both signed)
7181  * 05 Unsigned bit shift, source1 by source2 (source2 taken to be a
7182  * signed quantity; left shift if positive and right shift if
7183  * negative, source1 is unsigned)
7184  * 06 Signed bit shift, source1 by source2
7185  * (source2 like in 05, and source1 as well)
7186  */
7187 
7188  uint8 target = buf->ReadByte();
7189  uint8 oper = buf->ReadByte();
7190  uint32 src1 = buf->ReadByte();
7191  uint32 src2 = buf->ReadByte();
7192 
7193  uint32 data = 0;
7194  if (buf->Remaining() >= 4) data = buf->ReadDWord();
7195 
7196  /* You can add 80 to the operation to make it apply only if the target
7197  * is not defined yet. In this respect, a parameter is taken to be
7198  * defined if any of the following applies:
7199  * - it has been set to any value in the newgrf(w).cfg parameter list
7200  * - it OR A PARAMETER WITH HIGHER NUMBER has been set to any value by
7201  * an earlier action D */
7202  if (HasBit(oper, 7)) {
7203  if (target < 0x80 && target < _cur.grffile->param_end) {
7204  grfmsg(7, "ParamSet: Param %u already defined, skipping", target);
7205  return;
7206  }
7207 
7208  oper = GB(oper, 0, 7);
7209  }
7210 
7211  if (src2 == 0xFE) {
7212  if (GB(data, 0, 8) == 0xFF) {
7213  if (data == 0x0000FFFF) {
7214  /* Patch variables */
7215  src1 = GetPatchVariable(src1);
7216  } else {
7217  /* GRF Resource Management */
7218  uint8 op = src1;
7219  uint8 feature = GB(data, 8, 8);
7220  uint16 count = GB(data, 16, 16);
7221 
7222  if (_cur.stage == GLS_RESERVE) {
7223  if (feature == 0x08) {
7224  /* General sprites */
7225  if (op == 0) {
7226  /* Check if the allocated sprites will fit below the original sprite limit */
7227  if (_cur.spriteid + count >= 16384) {
7228  grfmsg(0, "ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count);
7229  DisableGrf(STR_NEWGRF_ERROR_GRM_FAILED);
7230  return;
7231  }
7232 
7233  /* Reserve space at the current sprite ID */
7234  grfmsg(4, "ParamSet: GRM: Allocated %d sprites at %d", count, _cur.spriteid);
7235  _grm_sprites[GRFLocation(_cur.grffile->grfid, _cur.nfo_line)] = _cur.spriteid;
7236  _cur.spriteid += count;
7237  }
7238  }
7239  /* Ignore GRM result during reservation */
7240  src1 = 0;
7241  } else if (_cur.stage == GLS_ACTIVATION) {
7242  switch (feature) {
7243  case 0x00: // Trains
7244  case 0x01: // Road Vehicles
7245  case 0x02: // Ships
7246  case 0x03: // Aircraft
7248  src1 = PerformGRM(&_grm_engines[_engine_offsets[feature]], _engine_counts[feature], count, op, target, "vehicles");
7249  if (_cur.skip_sprites == -1) return;
7250  } else {
7251  /* GRM does not apply for dynamic engine allocation. */
7252  switch (op) {
7253  case 2:
7254  case 3:
7255  src1 = _cur.grffile->GetParam(target);
7256  break;
7257 
7258  default:
7259  src1 = 0;
7260  break;
7261  }
7262  }
7263  break;
7264 
7265  case 0x08: // General sprites
7266  switch (op) {
7267  case 0:
7268  /* Return space reserved during reservation stage */
7269  src1 = _grm_sprites[GRFLocation(_cur.grffile->grfid, _cur.nfo_line)];
7270  grfmsg(4, "ParamSet: GRM: Using pre-allocated sprites at %d", src1);
7271  break;
7272 
7273  case 1:
7274  src1 = _cur.spriteid;
7275  break;
7276 
7277  default:
7278  grfmsg(1, "ParamSet: GRM: Unsupported operation %d for general sprites", op);
7279  return;
7280  }
7281  break;
7282 
7283  case 0x0B: // Cargo
7284  /* There are two ranges: one for cargo IDs and one for cargo bitmasks */
7285  src1 = PerformGRM(_grm_cargoes, NUM_CARGO * 2, count, op, target, "cargoes");
7286  if (_cur.skip_sprites == -1) return;
7287  break;
7288 
7289  default: grfmsg(1, "ParamSet: GRM: Unsupported feature 0x%X", feature); return;
7290  }
7291  } else {
7292  /* Ignore GRM during initialization */
7293  src1 = 0;
7294  }
7295  }
7296  } else {
7297  /* Read another GRF File's parameter */
7298  const GRFFile *file = GetFileByGRFID(data);
7299  GRFConfig *c = GetGRFConfig(data);
7300  if (c != nullptr && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur.grfconfig->flags, GCF_STATIC) && _networking) {
7301  /* Disable the read GRF if it is a static NewGRF. */
7303  src1 = 0;
7304  } else if (file == nullptr || c == nullptr || c->status == GCS_DISABLED) {
7305  src1 = 0;
7306  } else if (src1 == 0xFE) {
7307  src1 = c->version;
7308  } else {
7309  src1 = file->GetParam(src1);
7310  }
7311  }
7312  } else {
7313  /* The source1 and source2 operands refer to the grf parameter number
7314  * like in action 6 and 7. In addition, they can refer to the special
7315  * variables available in action 7, or they can be FF to use the value
7316  * of <data>. If referring to parameters that are undefined, a value
7317  * of 0 is used instead. */
7318  src1 = (src1 == 0xFF) ? data : GetParamVal(src1, nullptr);
7319  src2 = (src2 == 0xFF) ? data : GetParamVal(src2, nullptr);
7320  }
7321 
7322  uint32 res;
7323  switch (oper) {
7324  case 0x00:
7325  res = src1;
7326  break;
7327 
7328  case 0x01:
7329  res = src1 + src2;
7330  break;
7331 
7332  case 0x02:
7333  res = src1 - src2;
7334  break;
7335 
7336  case 0x03:
7337  res = src1 * src2;
7338  break;
7339 
7340  case 0x04:
7341  res = (int32)src1 * (int32)src2;
7342  break;
7343 
7344  case 0x05:
7345  if ((int32)src2 < 0) {
7346  res = src1 >> -(int32)src2;
7347  } else {
7348  res = src1 << (src2 & 0x1F); // Same behaviour as in EvalAdjustT, mask 'value' to 5 bits, which should behave the same on all architectures.
7349  }
7350  break;
7351 
7352  case 0x06:
7353  if ((int32)src2 < 0) {
7354  res = (int32)src1 >> -(int32)src2;
7355  } else {
7356  res = (int32)src1 << (src2 & 0x1F); // Same behaviour as in EvalAdjustT, mask 'value' to 5 bits, which should behave the same on all architectures.
7357  }
7358  break;
7359 
7360  case 0x07: // Bitwise AND
7361  res = src1 & src2;
7362  break;
7363 
7364  case 0x08: // Bitwise OR
7365  res = src1 | src2;
7366  break;
7367 
7368  case 0x09: // Unsigned division
7369  if (src2 == 0) {
7370  res = src1;
7371  } else {
7372  res = src1 / src2;
7373  }
7374  break;
7375 
7376  case 0x0A: // Signed division
7377  if (src2 == 0) {
7378  res = src1;
7379  } else {
7380  res = (int32)src1 / (int32)src2;
7381  }
7382  break;
7383 
7384  case 0x0B: // Unsigned modulo
7385  if (src2 == 0) {
7386  res = src1;
7387  } else {
7388  res = src1 % src2;
7389  }
7390  break;
7391 
7392  case 0x0C: // Signed modulo
7393  if (src2 == 0) {
7394  res = src1;
7395  } else {
7396  res = (int32)src1 % (int32)src2;
7397  }
7398  break;
7399 
7400  default: grfmsg(0, "ParamSet: Unknown operation %d, skipping", oper); return;
7401  }
7402 
7403  switch (target) {
7404  case 0x8E: // Y-Offset for train sprites
7405  _cur.grffile->traininfo_vehicle_pitch = res;
7406  break;
7407 
7408  case 0x8F: { // Rail track type cost factors
7409  extern RailtypeInfo _railtypes[RAILTYPE_END];
7410  _railtypes[RAILTYPE_RAIL].cost_multiplier = GB(res, 0, 8);
7412  _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 0, 8);
7413  _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 8, 8);
7414  } else {
7415  _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 8, 8);
7416  _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 16, 8);
7417  }
7418  _railtypes[RAILTYPE_MAGLEV].cost_multiplier = GB(res, 16, 8);
7419  break;
7420  }
7421 
7422  /* not implemented */
7423  case 0x93: // Tile refresh offset to left -- Intended to allow support for larger sprites, not necessary for OTTD
7424  case 0x94: // Tile refresh offset to right
7425  case 0x95: // Tile refresh offset upwards
7426  case 0x96: // Tile refresh offset downwards
7427  case 0x97: // Snow line height -- Better supported by feature 8 property 10h (snow line table) TODO: implement by filling the entire snow line table with the given value
7428  case 0x99: // Global ID offset -- Not necessary since IDs are remapped automatically
7429  grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
7430  break;
7431 
7432  case 0x9E: // Miscellaneous GRF features
7433  /* Set train list engine width */
7434  _cur.grffile->traininfo_vehicle_width = HasBit(res, GMB_TRAIN_WIDTH_32_PIXELS) ? VEHICLEINFO_FULL_VEHICLE_WIDTH : TRAININFO_DEFAULT_VEHICLE_WIDTH;
7435  /* Remove the local flags from the global flags */
7437 
7438  /* Only copy safe bits for static grfs */
7439  if (HasBit(_cur.grfconfig->flags, GCF_STATIC)) {
7440  uint32 safe_bits = 0;
7441  SetBit(safe_bits, GMB_SECOND_ROCKY_TILE_SET);
7442 
7443  _misc_grf_features = (_misc_grf_features & ~safe_bits) | (res & safe_bits);
7444  } else {
7445  _misc_grf_features = res;
7446  }
7447  break;
7448 
7449  case 0x9F: // locale-dependent settings
7450  grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
7451  break;
7452 
7453  default:
7454  if (target < 0x80) {
7455  _cur.grffile->param[target] = res;
7456  /* param is zeroed by default */
7457  if (target + 1U > _cur.grffile->param_end) _cur.grffile->param_end = target + 1;
7458  } else {
7459  grfmsg(7, "ParamSet: Skipping unknown target 0x%02X", target);
7460  }
7461  break;
7462  }
7463 }
7464 
7465 /* Action 0x0E (GLS_SAFETYSCAN) */
7466 static void SafeGRFInhibit(ByteReader *buf)
7467 {
7468  /* <0E> <num> <grfids...>
7469  *
7470  * B num Number of GRFIDs that follow
7471  * D grfids GRFIDs of the files to deactivate */
7472 
7473  uint8 num = buf->ReadByte();
7474 
7475  for (uint i = 0; i < num; i++) {
7476  uint32 grfid = buf->ReadDWord();
7477 
7478  /* GRF is unsafe it if tries to deactivate other GRFs */
7479  if (grfid != _cur.grfconfig->ident.grfid) {
7480  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
7481 
7482  /* Skip remainder of GRF */
7483  _cur.skip_sprites = -1;
7484 
7485  return;
7486  }
7487  }
7488 }
7489 
7490 /* Action 0x0E */
7491 static void GRFInhibit(ByteReader *buf)
7492 {
7493  /* <0E> <num> <grfids...>
7494  *
7495  * B num Number of GRFIDs that follow
7496  * D grfids GRFIDs of the files to deactivate */
7497 
7498  uint8 num = buf->ReadByte();
7499 
7500  for (uint i = 0; i < num; i++) {
7501  uint32 grfid = buf->ReadDWord();
7502  GRFConfig *file = GetGRFConfig(grfid);
7503 
7504  /* Unset activation flag */
7505  if (file != nullptr && file != _cur.grfconfig) {
7506  grfmsg(2, "GRFInhibit: Deactivating file '%s'", file->filename);
7507  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_FORCEFULLY_DISABLED, file);
7508  error->data = _cur.grfconfig->GetName();
7509  }
7510  }
7511 }
7512 
7514 static void FeatureTownName(ByteReader *buf)
7515 {
7516  /* <0F> <id> <style-name> <num-parts> <parts>
7517  *
7518  * B id ID of this definition in bottom 7 bits (final definition if bit 7 set)
7519  * V style-name Name of the style (only for final definition)
7520  * B num-parts Number of parts in this definition
7521  * V parts The parts */
7522 
7523  uint32 grfid = _cur.grffile->grfid;
7524 
7525  GRFTownName *townname = AddGRFTownName(grfid);
7526 
7527  byte id = buf->ReadByte();
7528  grfmsg(6, "FeatureTownName: definition 0x%02X", id & 0x7F);
7529 
7530  if (HasBit(id, 7)) {
7531  /* Final definition */
7532  ClrBit(id, 7);
7533  bool new_scheme = _cur.grffile->grf_version >= 7;
7534 
7535  byte lang = buf->ReadByte();
7536 
7537  byte nb_gen = townname->nb_gen;
7538  do {
7539  ClrBit(lang, 7);
7540 
7541  const char *name = buf->ReadString();
7542 
7543  std::string lang_name = TranslateTTDPatchCodes(grfid, lang, false, name);
7544  grfmsg(6, "FeatureTownName: lang 0x%X -> '%s'", lang, lang_name.c_str());
7545 
7546  townname->name[nb_gen] = AddGRFString(grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
7547 
7548  lang = buf->ReadByte();
7549  } while (lang != 0);
7550  townname->id[nb_gen] = id;
7551  townname->nb_gen++;
7552  }
7553 
7554  byte nb = buf->ReadByte();
7555  grfmsg(6, "FeatureTownName: %u parts", nb);
7556 
7557  townname->nbparts[id] = nb;
7558  townname->partlist[id] = CallocT<NamePartList>(nb);
7559 
7560  for (int i = 0; i < nb; i++) {
7561  byte nbtext = buf->ReadByte();
7562  townname->partlist[id][i].bitstart = buf->ReadByte();
7563  townname->partlist[id][i].bitcount = buf->ReadByte();
7564  townname->partlist[id][i].maxprob = 0;
7565  townname->partlist[id][i].partcount = nbtext;
7566  townname->partlist[id][i].parts = CallocT<NamePart>(nbtext);
7567  grfmsg(6, "FeatureTownName: part %d contains %d texts and will use GB(seed, %d, %d)", i, nbtext, townname->partlist[id][i].bitstart, townname->partlist[id][i].bitcount);
7568 
7569  for (int j = 0; j < nbtext; j++) {
7570  byte prob = buf->ReadByte();
7571 
7572  if (HasBit(prob, 7)) {
7573  byte ref_id = buf->ReadByte();
7574 
7575  if (townname->nbparts[ref_id] == 0) {
7576  grfmsg(0, "FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id);
7577  DelGRFTownName(grfid);
7578  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
7579  return;
7580  }
7581 
7582  grfmsg(6, "FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F);
7583  townname->partlist[id][i].parts[j].data.id = ref_id;
7584  } else {
7585  const char *text = buf->ReadString();
7586  townname->partlist[id][i].parts[j].data.text = stredup(TranslateTTDPatchCodes(grfid, 0, false, text).c_str());
7587  grfmsg(6, "FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[id][i].parts[j].data.text, prob);
7588  }
7589  townname->partlist[id][i].parts[j].prob = prob;
7590  townname->partlist[id][i].maxprob += GB(prob, 0, 7);
7591  }
7592  grfmsg(6, "FeatureTownName: part %d, total probability %d", i, townname->partlist[id][i].maxprob);
7593  }
7594 }
7595 
7597 static void DefineGotoLabel(ByteReader *buf)
7598 {
7599  /* <10> <label> [<comment>]
7600  *
7601  * B label The label to define
7602  * V comment Optional comment - ignored */
7603 
7604  byte nfo_label = buf->ReadByte();
7605 
7606  _cur.grffile->labels.emplace_back(nfo_label, _cur.nfo_line, _cur.file->GetPos());
7607 
7608  grfmsg(2, "DefineGotoLabel: GOTO target with label 0x%02X", nfo_label);
7609 }
7610 
7615 static void ImportGRFSound(SoundEntry *sound)
7616 {
7617  const GRFFile *file;
7618  uint32 grfid = _cur.file->ReadDword();
7619  SoundID sound_id = _cur.file->ReadWord();
7620 
7621  file = GetFileByGRFID(grfid);
7622  if (file == nullptr || file->sound_offset == 0) {
7623  grfmsg(1, "ImportGRFSound: Source file not available");
7624  return;
7625  }
7626 
7627  if (sound_id >= file->num_sounds) {
7628  grfmsg(1, "ImportGRFSound: Sound effect %d is invalid", sound_id);
7629  return;
7630  }
7631 
7632  grfmsg(2, "ImportGRFSound: Copying sound %d (%d) from file %X", sound_id, file->sound_offset + sound_id, grfid);
7633 
7634  *sound = *GetSound(file->sound_offset + sound_id);
7635 
7636  /* Reset volume and priority, which TTDPatch doesn't copy */
7637  sound->volume = 128;
7638  sound->priority = 0;
7639 }
7640 
7646 static void LoadGRFSound(size_t offs, SoundEntry *sound)
7647 {
7648  /* Set default volume and priority */
7649  sound->volume = 0x80;
7650  sound->priority = 0;
7651 
7652  if (offs != SIZE_MAX) {
7653  /* Sound is present in the NewGRF. */
7654  sound->file = _cur.file;
7655  sound->file_offset = offs;
7656  sound->grf_container_ver = _cur.file->GetContainerVersion();
7657  }
7658 }
7659 
7660 /* Action 0x11 */
7661 static void GRFSound(ByteReader *buf)
7662 {
7663  /* <11> <num>
7664  *
7665  * W num Number of sound files that follow */
7666 
7667  uint16 num = buf->ReadWord();
7668  if (num == 0) return;
7669 
7670  SoundEntry *sound;
7671  if (_cur.grffile->sound_offset == 0) {
7672  _cur.grffile->sound_offset = GetNumSounds();
7673  _cur.grffile->num_sounds = num;
7674  sound = AllocateSound(num);
7675  } else {
7676  sound = GetSound(_cur.grffile->sound_offset);
7677  }
7678 
7679  SpriteFile &file = *_cur.file;
7680  byte grf_container_version = file.GetContainerVersion();
7681  for (int i = 0; i < num; i++) {
7682  _cur.nfo_line++;
7683 
7684  /* Check whether the index is in range. This might happen if multiple action 11 are present.
7685  * While this is invalid, we do not check for this. But we should prevent it from causing bigger trouble */
7686  bool invalid = i >= _cur.grffile->num_sounds;
7687 
7688  size_t offs = file.GetPos();
7689 
7690  uint32 len = grf_container_version >= 2 ? file.ReadDword() : file.ReadWord();
7691  byte type = file.ReadByte();
7692 
7693  if (grf_container_version >= 2 && type == 0xFD) {
7694  /* Reference to sprite section. */
7695  if (invalid) {
7696  grfmsg(1, "GRFSound: Sound index out of range (multiple Action 11?)");
7697  file.SkipBytes(len);
7698  } else if (len != 4) {
7699  grfmsg(1, "GRFSound: Invalid sprite section import");
7700  file.SkipBytes(len);
7701  } else {
7702  uint32 id = file.ReadDword();
7703  if (_cur.stage == GLS_INIT) LoadGRFSound(GetGRFSpriteOffset(id), sound + i);
7704  }
7705  continue;
7706  }
7707 
7708  if (type != 0xFF) {
7709  grfmsg(1, "GRFSound: Unexpected RealSprite found, skipping");
7710  file.SkipBytes(7);
7711  SkipSpriteData(*_cur.file, type, len - 8);
7712  continue;
7713  }
7714 
7715  if (invalid) {
7716  grfmsg(1, "GRFSound: Sound index out of range (multiple Action 11?)");
7717  file.SkipBytes(len);
7718  }
7719 
7720  byte action = file.ReadByte();
7721  switch (action) {
7722  case 0xFF:
7723  /* Allocate sound only in init stage. */
7724  if (_cur.stage == GLS_INIT) {
7725  if (grf_container_version >= 2) {
7726  grfmsg(1, "GRFSound: Inline sounds are not supported for container version >= 2");
7727  } else {
7728  LoadGRFSound(offs, sound + i);
7729  }
7730  }
7731  file.SkipBytes(len - 1); // already read <action>
7732  break;
7733 
7734  case 0xFE:
7735  if (_cur.stage == GLS_ACTIVATION) {
7736  /* XXX 'Action 0xFE' isn't really specified. It is only mentioned for
7737  * importing sounds, so this is probably all wrong... */
7738  if (file.ReadByte() != 0) grfmsg(1, "GRFSound: Import type mismatch");
7739  ImportGRFSound(sound + i);
7740  } else {
7741  file.SkipBytes(len - 1); // already read <action>
7742  }
7743  break;
7744 
7745  default:
7746  grfmsg(1, "GRFSound: Unexpected Action %x found, skipping", action);
7747  file.SkipBytes(len - 1); // already read <action>
7748  break;
7749  }
7750  }
7751 }
7752 
7753 /* Action 0x11 (SKIP) */
7754 static void SkipAct11(ByteReader *buf)
7755 {
7756  /* <11> <num>
7757  *
7758  * W num Number of sound files that follow */
7759 
7760  _cur.skip_sprites = buf->ReadWord();
7761 
7762  grfmsg(3, "SkipAct11: Skipping %d sprites", _cur.skip_sprites);
7763 }
7764 
7766 static void LoadFontGlyph(ByteReader *buf)
7767 {
7768  /* <12> <num_def> <font_size> <num_char> <base_char>
7769  *
7770  * B num_def Number of definitions
7771  * B font_size Size of font (0 = normal, 1 = small, 2 = large, 3 = mono)
7772  * B num_char Number of consecutive glyphs
7773  * W base_char First character index */
7774 
7775  uint8 num_def = buf->ReadByte();
7776 
7777  for (uint i = 0; i < num_def; i++) {
7778  FontSize size = (FontSize)buf->ReadByte();
7779  uint8 num_char = buf->ReadByte();
7780  uint16 base_char = buf->ReadWord();
7781 
7782  if (size >= FS_END) {
7783  grfmsg(1, "LoadFontGlyph: Size %u is not supported, ignoring", size);
7784  }
7785 
7786  grfmsg(7, "LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size);
7787 
7788  for (uint c = 0; c < num_char; c++) {
7789  if (size < FS_END) SetUnicodeGlyph(size, base_char + c, _cur.spriteid);
7790  _cur.nfo_line++;
7791  LoadNextSprite(_cur.spriteid++, *_cur.file, _cur.nfo_line);
7792  }
7793  }
7794 }
7795 
7797 static void SkipAct12(ByteReader *buf)
7798 {
7799  /* <12> <num_def> <font_size> <num_char> <base_char>
7800  *
7801  * B num_def Number of definitions
7802  * B font_size Size of font (0 = normal, 1 = small, 2 = large)
7803  * B num_char Number of consecutive glyphs
7804  * W base_char First character index */
7805 
7806  uint8 num_def = buf->ReadByte();
7807 
7808  for (uint i = 0; i < num_def; i++) {
7809  /* Ignore 'size' byte */
7810  buf->ReadByte();
7811 
7812  /* Sum up number of characters */
7813  _cur.skip_sprites += buf->ReadByte();
7814 
7815  /* Ignore 'base_char' word */
7816  buf->ReadWord();
7817  }
7818 
7819  grfmsg(3, "SkipAct12: Skipping %d sprites", _cur.skip_sprites);
7820 }
7821 
7824 {
7825  /* <13> <grfid> <num-ent> <offset> <text...>
7826  *
7827  * 4*B grfid The GRFID of the file whose texts are to be translated
7828  * B num-ent Number of strings
7829  * W offset First text ID
7830  * S text... Zero-terminated strings */
7831 
7832  uint32 grfid = buf->ReadDWord();
7833  const GRFConfig *c = GetGRFConfig(grfid);
7834  if (c == nullptr || (c->status != GCS_INITIALISED && c->status != GCS_ACTIVATED)) {
7835  grfmsg(7, "TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13", BSWAP32(grfid));
7836  return;
7837  }
7838 
7839  if (c->status == GCS_INITIALISED) {
7840  /* If the file is not active but will be activated later, give an error
7841  * and disable this file. */
7842  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LOAD_AFTER);
7843 
7844  error->data = GetString(STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE);
7845 
7846  return;
7847  }
7848 
7849  /* Since no language id is supplied for with version 7 and lower NewGRFs, this string has
7850  * to be added as a generic string, thus the language id of 0x7F. For this to work
7851  * new_scheme has to be true as well, which will also be implicitly the case for version 8
7852  * and higher. A language id of 0x7F will be overridden by a non-generic id, so this will
7853  * not change anything if a string has been provided specifically for this language. */
7854  byte language = _cur.grffile->grf_version >= 8 ? buf->ReadByte() : 0x7F;
7855  byte num_strings = buf->ReadByte();
7856  uint16 first_id = buf->ReadWord();
7857 
7858  if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD400) || (first_id >= 0xD800 && first_id + num_strings <= 0xE000))) {
7859  grfmsg(7, "TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings);
7860  return;
7861  }
7862 
7863  for (uint i = 0; i < num_strings && buf->HasData(); i++) {
7864  const char *string = buf->ReadString();
7865 
7866  if (StrEmpty(string)) {
7867  grfmsg(7, "TranslateGRFString: Ignoring empty string.");
7868  continue;
7869  }
7870 
7871  AddGRFString(grfid, first_id + i, language, true, true, string, STR_UNDEFINED);
7872  }
7873 }
7874 
7876 static bool ChangeGRFName(byte langid, const char *str)
7877 {
7878  AddGRFTextToList(_cur.grfconfig->name, langid, _cur.grfconfig->ident.grfid, false, str);
7879  return true;
7880 }
7881 
7883 static bool ChangeGRFDescription(byte langid, const char *str)
7884 {
7885  AddGRFTextToList(_cur.grfconfig->info, langid, _cur.grfconfig->ident.grfid, true, str);
7886  return true;
7887 }
7888 
7890 static bool ChangeGRFURL(byte langid, const char *str)
7891 {
7892  AddGRFTextToList(_cur.grfconfig->url, langid, _cur.grfconfig->ident.grfid, false, str);
7893  return true;
7894 }
7895 
7897 static bool ChangeGRFNumUsedParams(size_t len, ByteReader *buf)
7898 {
7899  if (len != 1) {
7900  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'NPAR' but got " PRINTF_SIZE ", ignoring this field", len);
7901  buf->Skip(len);
7902  } else {
7903  _cur.grfconfig->num_valid_params = std::min<byte>(buf->ReadByte(), lengthof(_cur.grfconfig->param));
7904  }
7905  return true;
7906 }
7907 
7909 static bool ChangeGRFPalette(size_t len, ByteReader *buf)
7910 {
7911  if (len != 1) {
7912  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'PALS' but got " PRINTF_SIZE ", ignoring this field", len);
7913  buf->Skip(len);
7914  } else {
7915  char data = buf->ReadByte();
7916  GRFPalette pal = GRFP_GRF_UNSET;
7917  switch (data) {
7918  case '*':
7919  case 'A': pal = GRFP_GRF_ANY; break;
7920  case 'W': pal = GRFP_GRF_WINDOWS; break;
7921  case 'D': pal = GRFP_GRF_DOS; break;
7922  default:
7923  grfmsg(2, "StaticGRFInfo: unexpected value '%02x' for 'INFO'->'PALS', ignoring this field", data);
7924  break;
7925  }
7926  if (pal != GRFP_GRF_UNSET) {
7927  _cur.grfconfig->palette &= ~GRFP_GRF_MASK;
7928  _cur.grfconfig->palette |= pal;
7929  }
7930  }
7931  return true;
7932 }
7933 
7935 static bool ChangeGRFBlitter(size_t len, ByteReader *buf)
7936 {
7937  if (len != 1) {
7938  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'BLTR' but got " PRINTF_SIZE ", ignoring this field", len);
7939  buf->Skip(len);
7940  } else {
7941  char data = buf->ReadByte();
7942  GRFPalette pal = GRFP_BLT_UNSET;
7943  switch (data) {
7944  case '8': pal = GRFP_BLT_UNSET; break;
7945  case '3': pal = GRFP_BLT_32BPP; break;
7946  default:
7947  grfmsg(2, "StaticGRFInfo: unexpected value '%02x' for 'INFO'->'BLTR', ignoring this field", data);
7948  return true;
7949  }
7950  _cur.grfconfig->palette &= ~GRFP_BLT_MASK;
7951  _cur.grfconfig->palette |= pal;
7952  }
7953  return true;
7954 }
7955 
7957 static bool ChangeGRFVersion(size_t len, ByteReader *buf)
7958 {
7959  if (len != 4) {
7960  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'VRSN' but got " PRINTF_SIZE ", ignoring this field", len);
7961  buf->Skip(len);
7962  } else {
7963  /* Set min_loadable_version as well (default to minimal compatibility) */
7964  _cur.grfconfig->version = _cur.grfconfig->min_loadable_version = buf->ReadDWord();
7965  }
7966  return true;
7967 }
7968 
7970 static bool ChangeGRFMinVersion(size_t len, ByteReader *buf)
7971 {
7972  if (len != 4) {
7973  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'MINV' but got " PRINTF_SIZE ", ignoring this field", len);
7974  buf->Skip(len);
7975  } else {
7976  _cur.grfconfig->min_loadable_version = buf->ReadDWord();
7977  if (_cur.grfconfig->version == 0) {
7978  grfmsg(2, "StaticGRFInfo: 'MINV' defined before 'VRSN' or 'VRSN' set to 0, ignoring this field");
7979  _cur.grfconfig->min_loadable_version = 0;
7980  }
7981  if (_cur.grfconfig->version < _cur.grfconfig->min_loadable_version) {
7982  grfmsg(2, "StaticGRFInfo: 'MINV' defined as %d, limiting it to 'VRSN'", _cur.grfconfig->min_loadable_version);
7984  }
7985  }
7986  return true;
7987 }
7988 
7990 
7992 static bool ChangeGRFParamName(byte langid, const char *str)
7993 {
7994  AddGRFTextToList(_cur_parameter->name, langid, _cur.grfconfig->ident.grfid, false, str);
7995  return true;
7996 }
7997 
7999 static bool ChangeGRFParamDescription(byte langid, const char *str)
8000 {
8001  AddGRFTextToList(_cur_parameter->desc, langid, _cur.grfconfig->ident.grfid, true, str);
8002  return true;
8003 }
8004 
8006 static bool ChangeGRFParamType(size_t len, ByteReader *buf)
8007 {
8008  if (len != 1) {
8009  grfmsg(2, "StaticGRFInfo: expected 1 byte for 'INFO'->'PARA'->'TYPE' but got " PRINTF_SIZE ", ignoring this field", len);
8010  buf->Skip(len);
8011  } else {
8012  GRFParameterType type = (GRFParameterType)buf->ReadByte();
8013  if (type < PTYPE_END) {
8014  _cur_parameter->type = type;
8015  } else {
8016  grfmsg(3, "StaticGRFInfo: unknown parameter type %d, ignoring this field", type);
8017  }
8018  }
8019  return true;
8020 }
8021 
8023 static bool ChangeGRFParamLimits(size_t len, ByteReader *buf)
8024 {
8026  grfmsg(2, "StaticGRFInfo: 'INFO'->'PARA'->'LIMI' is only valid for parameters with type uint/enum, ignoring this field");
8027  buf->Skip(len);
8028  } else if (len != 8) {
8029  grfmsg(2, "StaticGRFInfo: expected 8 bytes for 'INFO'->'PARA'->'LIMI' but got " PRINTF_SIZE ", ignoring this field", len);
8030  buf->Skip(len);
8031  } else {
8032  uint32 min_value = buf->ReadDWord();
8033  uint32 max_value = buf->ReadDWord();
8034  if (min_value <= max_value) {
8035  _cur_parameter->min_value = min_value;
8036  _cur_parameter->max_value = max_value;
8037  } else {
8038  grfmsg(2, "StaticGRFInfo: 'INFO'->'PARA'->'LIMI' values are incoherent, ignoring this field");
8039  }
8040  }
8041  return true;
8042 }
8043 
8045 static bool ChangeGRFParamMask(size_t len, ByteReader *buf)
8046 {
8047  if (len < 1 || len > 3) {
8048  grfmsg(2, "StaticGRFInfo: expected 1 to 3 bytes for 'INFO'->'PARA'->'MASK' but got " PRINTF_SIZE ", ignoring this field", len);
8049  buf->Skip(len);
8050  } else {
8051  byte param_nr = buf->ReadByte();
8052  if (param_nr >= lengthof(_cur.grfconfig->param)) {
8053  grfmsg(2, "StaticGRFInfo: invalid parameter number in 'INFO'->'PARA'->'MASK', param %d, ignoring this field", param_nr);
8054  buf->Skip(len - 1);
8055  } else {
8056  _cur_parameter->param_nr = param_nr;
8057  if (len >= 2) _cur_parameter->first_bit = std::min<byte>(buf->ReadByte(), 31);
8058  if (len >= 3) _cur_parameter->num_bit = std::min<byte>(buf->ReadByte(), 32 - _cur_parameter->first_bit);
8059  }
8060  }
8061 
8062  return true;
8063 }
8064 
8066 static bool ChangeGRFParamDefault(size_t len, ByteReader *buf)
8067 {
8068  if (len != 4) {
8069  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'PARA'->'DEFA' but got " PRINTF_SIZE ", ignoring this field", len);
8070  buf->Skip(len);
8071  } else {
8072  _cur_parameter->def_value = buf->ReadDWord();
8073  }
8074  _cur.grfconfig->has_param_defaults = true;
8075  return true;
8076 }
8077 
8078 typedef bool (*DataHandler)(size_t, ByteReader *);
8079 typedef bool (*TextHandler)(byte, const char *str);
8080 typedef bool (*BranchHandler)(ByteReader *);
8081 
8092  id(0),
8093  type(0)
8094  {}
8095 
8101  AllowedSubtags(uint32 id, DataHandler handler) :
8102  id(id),
8103  type('B')
8104  {
8105  this->handler.data = handler;
8106  }
8107 
8113  AllowedSubtags(uint32 id, TextHandler handler) :
8114  id(id),
8115  type('T')
8116  {
8117  this->handler.text = handler;
8118  }
8119 
8125  AllowedSubtags(uint32 id, BranchHandler handler) :
8126  id(id),
8127  type('C')
8128  {
8129  this->handler.call_handler = true;
8130  this->handler.u.branch = handler;
8131  }
8132 
8139  id(id),
8140  type('C')
8141  {
8142  this->handler.call_handler = false;
8143  this->handler.u.subtags = subtags;
8144  }
8145 
8146  uint32 id;
8147  byte type;
8148  union {
8151  struct {
8152  union {
8155  } u;
8157  };
8158  } handler;
8159 };
8160 
8161 static bool SkipUnknownInfo(ByteReader *buf, byte type);
8162 static bool HandleNodes(ByteReader *buf, AllowedSubtags *tags);
8163 
8171 {
8172  byte type = buf->ReadByte();
8173  while (type != 0) {
8174  uint32 id = buf->ReadDWord();
8175  if (type != 'T' || id > _cur_parameter->max_value) {
8176  grfmsg(2, "StaticGRFInfo: all child nodes of 'INFO'->'PARA'->param_num->'VALU' should have type 't' and the value/bit number as id");
8177  if (!SkipUnknownInfo(buf, type)) return false;
8178  type = buf->ReadByte();
8179  continue;
8180  }
8181 
8182  byte langid = buf->ReadByte();
8183  const char *name_string = buf->ReadString();
8184 
8185  std::pair<uint32, GRFTextList> *val_name = _cur_parameter->value_names.Find(id);
8186  if (val_name != _cur_parameter->value_names.End()) {
8187  AddGRFTextToList(val_name->second, langid, _cur.grfconfig->ident.grfid, false, name_string);
8188  } else {
8189  GRFTextList list;
8190  AddGRFTextToList(list, langid, _cur.grfconfig->ident.grfid, false, name_string);
8191  _cur_parameter->value_names.Insert(id, list);
8192  }
8193 
8194  type = buf->ReadByte();
8195  }
8196  return true;
8197 }
8198 
8208  AllowedSubtags()
8209 };
8210 
8218 {
8219  byte type = buf->ReadByte();
8220  while (type != 0) {
8221  uint32 id = buf->ReadDWord();
8222  if (type != 'C' || id >= _cur.grfconfig->num_valid_params) {
8223  grfmsg(2, "StaticGRFInfo: all child nodes of 'INFO'->'PARA' should have type 'C' and their parameter number as id");
8224  if (!SkipUnknownInfo(buf, type)) return false;
8225  type = buf->ReadByte();
8226  continue;
8227  }
8228 
8229  if (id >= _cur.grfconfig->param_info.size()) {
8230  _cur.grfconfig->param_info.resize(id + 1);
8231  }
8232  if (_cur.grfconfig->param_info[id] == nullptr) {
8233  _cur.grfconfig->param_info[id] = new GRFParameterInfo(id);
8234  }
8235  _cur_parameter = _cur.grfconfig->param_info[id];
8236  /* Read all parameter-data and process each node. */
8237  if (!HandleNodes(buf, _tags_parameters)) return false;
8238  type = buf->ReadByte();
8239  }
8240  return true;
8241 }
8242 
8245  AllowedSubtags('NAME', ChangeGRFName),
8247  AllowedSubtags('URL_', ChangeGRFURL),
8254  AllowedSubtags()
8255 };
8256 
8259  AllowedSubtags('INFO', _tags_info),
8260  AllowedSubtags()
8261 };
8262 
8263 
8270 static bool SkipUnknownInfo(ByteReader *buf, byte type)
8271 {
8272  /* type and id are already read */
8273  switch (type) {
8274  case 'C': {
8275  byte new_type = buf->ReadByte();
8276  while (new_type != 0) {
8277  buf->ReadDWord(); // skip the id
8278  if (!SkipUnknownInfo(buf, new_type)) return false;
8279  new_type = buf->ReadByte();
8280  }
8281  break;
8282  }
8283 
8284  case 'T':
8285  buf->ReadByte(); // lang
8286  buf->ReadString(); // actual text
8287  break;
8288 
8289  case 'B': {
8290  uint16 size = buf->ReadWord();
8291  buf->Skip(size);
8292  break;
8293  }
8294 
8295  default:
8296  return false;
8297  }
8298 
8299  return true;
8300 }
8301 
8310 static bool HandleNode(byte type, uint32 id, ByteReader *buf, AllowedSubtags subtags[])
8311 {
8312  uint i = 0;
8313  AllowedSubtags *tag;
8314  while ((tag = &subtags[i++])->type != 0) {
8315  if (tag->id != BSWAP32(id) || tag->type != type) continue;
8316  switch (type) {
8317  default: NOT_REACHED();
8318 
8319  case 'T': {
8320  byte langid = buf->ReadByte();
8321  return tag->handler.text(langid, buf->ReadString());
8322  }
8323 
8324  case 'B': {
8325  size_t len = buf->ReadWord();
8326  if (buf->Remaining() < len) return false;
8327  return tag->handler.data(len, buf);
8328  }
8329 
8330  case 'C': {
8331  if (tag->handler.call_handler) {
8332  return tag->handler.u.branch(buf);
8333  }
8334  return HandleNodes(buf, tag->handler.u.subtags);
8335  }
8336  }
8337  }
8338  grfmsg(2, "StaticGRFInfo: unknown type/id combination found, type=%c, id=%x", type, id);
8339  return SkipUnknownInfo(buf, type);
8340 }
8341 
8348 static bool HandleNodes(ByteReader *buf, AllowedSubtags subtags[])
8349 {
8350  byte type = buf->ReadByte();
8351  while (type != 0) {
8352  uint32 id = buf->ReadDWord();
8353  if (!HandleNode(type, id, buf, subtags)) return false;
8354  type = buf->ReadByte();
8355  }
8356  return true;
8357 }
8358 
8363 static void StaticGRFInfo(ByteReader *buf)
8364 {
8365  /* <14> <type> <id> <text/data...> */
8366  HandleNodes(buf, _tags_root);
8367 }
8368 
8374 static void GRFUnsafe(ByteReader *buf)
8375 {
8376  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
8377 
8378  /* Skip remainder of GRF */
8379  _cur.skip_sprites = -1;
8380 }
8381 
8382 
8385 {
8386  _ttdpatch_flags[0] = ((_settings_game.station.never_expire_airports ? 1U : 0U) << 0x0C) // keepsmallairport
8387  | (1U << 0x0D) // newairports
8388  | (1U << 0x0E) // largestations
8389  | ((_settings_game.construction.max_bridge_length > 16 ? 1U : 0U) << 0x0F) // longbridges
8390  | (0U << 0x10) // loadtime
8391  | (1U << 0x12) // presignals
8392  | (1U << 0x13) // extpresignals
8393  | ((_settings_game.vehicle.never_expire_vehicles ? 1U : 0U) << 0x16) // enginespersist
8394  | (1U << 0x1B) // multihead
8395  | (1U << 0x1D) // lowmemory
8396  | (1U << 0x1E); // generalfixes
8397 
8398  _ttdpatch_flags[1] = ((_settings_game.economy.station_noise_level ? 1U : 0U) << 0x07) // moreairports - based on units of noise
8399  | (1U << 0x08) // mammothtrains
8400  | (1U << 0x09) // trainrefit
8401  | (0U << 0x0B) // subsidiaries
8402  | ((_settings_game.order.gradual_loading ? 1U : 0U) << 0x0C) // gradualloading
8403  | (1U << 0x12) // unifiedmaglevmode - set bit 0 mode. Not revelant to OTTD
8404  | (1U << 0x13) // unifiedmaglevmode - set bit 1 mode
8405  | (1U << 0x14) // bridgespeedlimits
8406  | (1U << 0x16) // eternalgame
8407  | (1U << 0x17) // newtrains
8408  | (1U << 0x18) // newrvs
8409  | (1U << 0x19) // newships
8410  | (1U << 0x1A) // newplanes
8411  | ((_settings_game.construction.train_signal_side == 1 ? 1U : 0U) << 0x1B) // signalsontrafficside
8412  | ((_settings_game.vehicle.disable_elrails ? 0U : 1U) << 0x1C); // electrifiedrailway
8413 
8414  _ttdpatch_flags[2] = (1U << 0x01) // loadallgraphics - obsolote
8415  | (1U << 0x03) // semaphores
8416  | (1U << 0x0A) // newobjects
8417  | (0U << 0x0B) // enhancedgui
8418  | (0U << 0x0C) // newagerating
8419  | ((_settings_game.construction.build_on_slopes ? 1U : 0U) << 0x0D) // buildonslopes
8420  | (1U << 0x0E) // fullloadany
8421  | (1U << 0x0F) // planespeed
8422  | (0U << 0x10) // moreindustriesperclimate - obsolete
8423  | (0U << 0x11) // moretoylandfeatures
8424  | (1U << 0x12) // newstations
8425  | (1U << 0x13) // tracktypecostdiff
8426  | (1U << 0x14) // manualconvert
8427  | ((_settings_game.construction.build_on_slopes ? 1U : 0U) << 0x15) // buildoncoasts
8428  | (1U << 0x16) // canals
8429  | (1U << 0x17) // newstartyear
8430  | ((_settings_game.vehicle.freight_trains > 1 ? 1U : 0U) << 0x18) // freighttrains
8431  | (1U << 0x19) // newhouses
8432  | (1U << 0x1A) // newbridges
8433  | (1U << 0x1B) // newtownnames
8434  | (1U << 0x1C) // moreanimation
8435  | ((_settings_game.vehicle.wagon_speed_limits ? 1U : 0U) << 0x1D) // wagonspeedlimits
8436  | (1U << 0x1E) // newshistory
8437  | (0U << 0x1F); // custombridgeheads
8438 
8439  _ttdpatch_flags[3] = (0U << 0x00) // newcargodistribution
8440  | (1U << 0x01) // windowsnap
8441  | ((_settings_game.economy.allow_town_roads || _generating_world ? 0U : 1U) << 0x02) // townbuildnoroad
8442  | (1U << 0x03) // pathbasedsignalling
8443  | (0U << 0x04) // aichoosechance
8444  | (1U << 0x05) // resolutionwidth
8445  | (1U << 0x06) // resolutionheight
8446  | (1U << 0x07) // newindustries
8447  | ((_settings_game.order.improved_load ? 1U : 0U) << 0x08) // fifoloading
8448  | (0U << 0x09) // townroadbranchprob
8449  | (0U << 0x0A) // tempsnowline
8450  | (1U << 0x0B) // newcargo
8451  | (1U << 0x0C) // enhancemultiplayer
8452  | (1U << 0x0D) // onewayroads
8453  | (1U << 0x0E) // irregularstations
8454  | (1U << 0x0F) // statistics
8455  | (1U << 0x10) // newsounds
8456  | (1U << 0x11) // autoreplace
8457  | (1U << 0x12) // autoslope
8458  | (0U << 0x13) // followvehicle
8459  | (1U << 0x14) // trams
8460  | (0U << 0x15) // enhancetunnels
8461  | (1U << 0x16) // shortrvs
8462  | (1U << 0x17) // articulatedrvs
8463  | ((_settings_game.vehicle.dynamic_engines ? 1U : 0U) << 0x18) // dynamic engines
8464  | (1U << 0x1E) // variablerunningcosts
8465  | (1U << 0x1F); // any switch is on
8466 
8467  _ttdpatch_flags[4] = (1U << 0x00) // larger persistent storage
8468  | ((_settings_game.economy.inflation ? 1U : 0U) << 0x01); // inflation is on
8469 }
8470 
8472 static void ResetCustomStations()
8473 {
8474  for (GRFFile * const file : _grf_files) {
8475  StationSpec **&stations = file->stations;
8476  if (stations == nullptr) continue;
8477  for (uint i = 0; i < NUM_STATIONS_PER_GRF; i++) {
8478  if (stations[i] == nullptr) continue;
8479  StationSpec *statspec = stations[i];
8480 
8481  /* Release this station */
8482  delete statspec;
8483  }
8484 
8485  /* Free and reset the station data */
8486  free(stations);
8487  stations = nullptr;
8488  }
8489 }
8490 
8492 static void ResetCustomHouses()
8493 {
8494  for (GRFFile * const file : _grf_files) {
8495  HouseSpec **&housespec = file->housespec;
8496  if (housespec == nullptr) continue;
8497  for (uint i = 0; i < NUM_HOUSES_PER_GRF; i++) {
8498  free(housespec[i]);
8499  }
8500 
8501  free(housespec);
8502  housespec = nullptr;
8503  }
8504 }
8505 
8507 static void ResetCustomAirports()
8508 {
8509  for (GRFFile * const file : _grf_files) {
8510  AirportSpec **aslist = file->airportspec;
8511  if (aslist != nullptr) {
8512  for (uint i = 0; i < NUM_AIRPORTS_PER_GRF; i++) {
8513  AirportSpec *as = aslist[i];
8514 
8515  if (as != nullptr) {
8516  /* We need to remove the tiles layouts */
8517  for (int j = 0; j < as->num_table; j++) {
8518  /* remove the individual layouts */
8519  free(as->table[j]);
8520  }
8521  free(as->table);
8522  free(as->depot_table);
8523  free(as->rotation);
8524 
8525  free(as);
8526  }
8527  }
8528  free(aslist);
8529  file->airportspec = nullptr;
8530  }
8531 
8532  AirportTileSpec **&airporttilespec = file->airtspec;
8533  if (airporttilespec != nullptr) {
8534  for (uint i = 0; i < NUM_AIRPORTTILES_PER_GRF; i++) {
8535  free(airporttilespec[i]);
8536  }
8537  free(airporttilespec);
8538  airporttilespec = nullptr;
8539  }
8540  }
8541 }
8542 
8545 {
8546  for (GRFFile * const file : _grf_files) {
8547  IndustrySpec **&industryspec = file->industryspec;
8548  IndustryTileSpec **&indtspec = file->indtspec;
8549 
8550  /* We are verifiying both tiles and industries specs loaded from the grf file
8551  * First, let's deal with industryspec */
8552  if (industryspec != nullptr) {
8553  for (uint i = 0; i < NUM_INDUSTRYTYPES_PER_GRF; i++) {
8554  IndustrySpec *ind = industryspec[i];
8555  delete ind;
8556  }
8557 
8558  free(industryspec);
8559  industryspec = nullptr;
8560  }
8561 
8562  if (indtspec == nullptr) continue;
8563  for (uint i = 0; i < NUM_INDUSTRYTILES_PER_GRF; i++) {
8564  free(indtspec[i]);
8565  }
8566 
8567  free(indtspec);
8568  indtspec = nullptr;
8569  }
8570 }
8571 
8573 static void ResetCustomObjects()
8574 {
8575  for (GRFFile * const file : _grf_files) {
8576  ObjectSpec **&objectspec = file->objectspec;
8577  if (objectspec == nullptr) continue;
8578  for (uint i = 0; i < NUM_OBJECTS_PER_GRF; i++) {
8579  free(objectspec[i]);
8580  }
8581 
8582  free(objectspec);
8583  objectspec = nullptr;
8584  }
8585 }
8586 
8588 static void ResetNewGRF()
8589 {
8590  for (GRFFile * const file : _grf_files) {
8591  delete file;
8592  }
8593 
8594  _grf_files.clear();
8595  _cur.grffile = nullptr;
8596 }
8597 
8599 static void ResetNewGRFErrors()
8600 {
8601  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
8602  if (!HasBit(c->flags, GCF_COPY) && c->error != nullptr) {
8603  delete c->error;
8604  c->error = nullptr;
8605  }
8606  }
8607 }
8608 
8613 {
8614  CleanUpStrings();
8615  CleanUpGRFTownNames();
8616 
8617  /* Copy/reset original engine info data */
8618  SetupEngines();
8619 
8620  /* Copy/reset original bridge info data */
8621  ResetBridges();
8622 
8623  /* Reset rail type information */
8624  ResetRailTypes();
8625 
8626  /* Copy/reset original road type info data */
8627  ResetRoadTypes();
8628 
8629  /* Allocate temporary refit/cargo class data */
8630  _gted = CallocT<GRFTempEngineData>(Engine::GetPoolSize());
8631 
8632  /* Fill rail type label temporary data for default trains */
8633  for (const Engine *e : Engine::IterateType(VEH_TRAIN)) {
8634  _gted[e->index].railtypelabel = GetRailTypeInfo(e->u.rail.railtype)->label;
8635  }
8636 
8637  /* Reset GRM reservations */
8638  memset(&_grm_engines, 0, sizeof(_grm_engines));
8639  memset(&_grm_cargoes, 0, sizeof(_grm_cargoes));
8640 
8641  /* Reset generic feature callback lists */
8643 
8644  /* Reset price base data */
8646 
8647  /* Reset the curencies array */
8648  ResetCurrencies();
8649 
8650  /* Reset the house array */
8652  ResetHouses();
8653 
8654  /* Reset the industries structures*/
8656  ResetIndustries();
8657 
8658  /* Reset the objects. */
8659  ObjectClass::Reset();
8661  ResetObjects();
8662 
8663  /* Reset station classes */
8664  StationClass::Reset();
8666 
8667  /* Reset airport-related structures */
8668  AirportClass::Reset();
8672 
8673  /* Reset canal sprite groups and flags */
8674  memset(_water_feature, 0, sizeof(_water_feature));
8675 
8676  /* Reset the snowline table. */
8677  ClearSnowLine();
8678 
8679  /* Reset NewGRF files */
8680  ResetNewGRF();
8681 
8682  /* Reset NewGRF errors. */
8684 
8685  /* Set up the default cargo types */
8687 
8688  /* Reset misc GRF features and train list display variables */
8689  _misc_grf_features = 0;
8690 
8692  _loaded_newgrf_features.used_liveries = 1 << LS_DEFAULT;
8695 
8696  /* Clear all GRF overrides */
8697  _grf_id_overrides.clear();
8698 
8699  InitializeSoundPool();
8700  _spritegroup_pool.CleanPool();
8701 }
8702 
8707 {
8708  /* Reset override managers */
8709  _engine_mngr.ResetToDefaultMapping();
8710  _house_mngr.ResetMapping();
8711  _industry_mngr.ResetMapping();
8712  _industile_mngr.ResetMapping();
8713  _airport_mngr.ResetMapping();
8714  _airporttile_mngr.ResetMapping();
8715 }
8716 
8722 {
8723  memset(_cur.grffile->cargo_map, 0xFF, sizeof(_cur.grffile->cargo_map));
8724 
8725  for (CargoID c = 0; c < NUM_CARGO; c++) {
8726  const CargoSpec *cs = CargoSpec::Get(c);
8727  if (!cs->IsValid()) continue;
8728 
8729  if (_cur.grffile->cargo_list.size() == 0) {
8730  /* Default translation table, so just a straight mapping to bitnum */
8731  _cur.grffile->cargo_map[c] = cs->bitnum;
8732  } else {
8733  /* Check the translation table for this cargo's label */
8734  int idx = find_index(_cur.grffile->cargo_list, {cs->label});
8735  if (idx >= 0) _cur.grffile->cargo_map[c] = idx;
8736  }
8737  }
8738 }
8739 
8744 static void InitNewGRFFile(const GRFConfig *config)
8745 {
8746  GRFFile *newfile = GetFileByFilename(config->filename);
8747  if (newfile != nullptr) {
8748  /* We already loaded it once. */
8749  _cur.grffile = newfile;
8750  return;
8751  }
8752 
8753  newfile = new GRFFile(config);
8754  _grf_files.push_back(_cur.grffile = newfile);
8755 }
8756 
8762 {
8763  this->filename = stredup(config->filename);
8764  this->grfid = config->ident.grfid;
8765 
8766  /* Initialise local settings to defaults */
8767  this->traininfo_vehicle_pitch = 0;
8768  this->traininfo_vehicle_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
8769 
8770  /* Mark price_base_multipliers as 'not set' */
8771  for (Price i = PR_BEGIN; i < PR_END; i++) {
8772  this->price_base_multipliers[i] = INVALID_PRICE_MODIFIER;
8773  }
8774 
8775  /* Initialise rail type map with default rail types */
8776  std::fill(std::begin(this->railtype_map), std::end(this->railtype_map), INVALID_RAILTYPE);
8777  this->railtype_map[0] = RAILTYPE_RAIL;
8778  this->railtype_map[1] = RAILTYPE_ELECTRIC;
8779  this->railtype_map[2] = RAILTYPE_MONO;
8780  this->railtype_map[3] = RAILTYPE_MAGLEV;
8781 
8782  /* Initialise road type map with default road types */
8783  std::fill(std::begin(this->roadtype_map), std::end(this->roadtype_map), INVALID_ROADTYPE);
8784  this->roadtype_map[0] = ROADTYPE_ROAD;
8785 
8786  /* Initialise tram type map with default tram types */
8787  std::fill(std::begin(this->tramtype_map), std::end(this->tramtype_map), INVALID_ROADTYPE);
8788  this->tramtype_map[0] = ROADTYPE_TRAM;
8789 
8790  /* Copy the initial parameter list
8791  * 'Uninitialised' parameters are zeroed as that is their default value when dynamically creating them. */
8792  static_assert(lengthof(this->param) == lengthof(config->param) && lengthof(this->param) == 0x80);
8793 
8794  assert(config->num_params <= lengthof(config->param));
8795  this->param_end = config->num_params;
8796  if (this->param_end > 0) {
8797  MemCpyT(this->param, config->param, this->param_end);
8798  }
8799 }
8800 
8801 GRFFile::~GRFFile()
8802 {
8803  free(this->filename);
8804  delete[] this->language_map;
8805 }
8806 
8807 
8811 static void CalculateRefitMasks()
8812 {
8813  CargoTypes original_known_cargoes = 0;
8814  for (int ct = 0; ct != NUM_ORIGINAL_CARGO; ++ct) {
8816  if (cid != CT_INVALID) SetBit(original_known_cargoes, cid);
8817  }
8818 
8819  for (Engine *e : Engine::Iterate()) {
8820  EngineID engine = e->index;
8821  EngineInfo *ei = &e->info;
8822  bool only_defaultcargo;
8823 
8824  /* If the NewGRF did not set any cargo properties, we apply default values. */
8825  if (_gted[engine].defaultcargo_grf == nullptr) {
8826  /* If the vehicle has any capacity, apply the default refit masks */
8827  if (e->type != VEH_TRAIN || e->u.rail.capacity != 0) {
8828  static constexpr byte T = 1 << LT_TEMPERATE;
8829  static constexpr byte A = 1 << LT_ARCTIC;
8830  static constexpr byte S = 1 << LT_TROPIC;
8831  static constexpr byte Y = 1 << LT_TOYLAND;
8832  static const struct DefaultRefitMasks {
8833  byte climate;
8834  CargoType cargo_type;
8835  CargoTypes cargo_allowed;
8836  CargoTypes cargo_disallowed;
8837  } _default_refit_masks[] = {
8838  {T | A | S | Y, CT_PASSENGERS, CC_PASSENGERS, 0},
8839  {T | A | S , CT_MAIL, CC_MAIL, 0},
8840  {T | A | S , CT_VALUABLES, CC_ARMOURED, CC_LIQUID},
8841  { Y, CT_MAIL, CC_MAIL | CC_ARMOURED, CC_LIQUID},
8842  {T | A , CT_COAL, CC_BULK, 0},
8843  { S , CT_COPPER_ORE, CC_BULK, 0},
8844  { Y, CT_SUGAR, CC_BULK, 0},
8845  {T | A | S , CT_OIL, CC_LIQUID, 0},
8846  { Y, CT_COLA, CC_LIQUID, 0},
8847  {T , CT_GOODS, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS},
8848  { A | S , CT_GOODS, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS | CC_REFRIGERATED},
8849  { A | S , CT_FOOD, CC_REFRIGERATED, 0},
8850  { Y, CT_CANDY, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS},
8851  };
8852 
8853  if (e->type == VEH_AIRCRAFT) {
8854  /* Aircraft default to "light" cargoes */
8855  _gted[engine].cargo_allowed = CC_PASSENGERS | CC_MAIL | CC_ARMOURED | CC_EXPRESS;
8856  _gted[engine].cargo_disallowed = CC_LIQUID;
8857  } else if (e->type == VEH_SHIP) {
8858  switch (ei->cargo_type) {
8859  case CT_PASSENGERS:
8860  /* Ferries */
8861  _gted[engine].cargo_allowed = CC_PASSENGERS;
8862  _gted[engine].cargo_disallowed = 0;
8863  break;
8864  case CT_OIL:
8865  /* Tankers */
8866  _gted[engine].cargo_allowed = CC_LIQUID;
8867  _gted[engine].cargo_disallowed = 0;
8868  break;
8869  default:
8870  /* Cargo ships */
8871  if (_settings_game.game_creation.landscape == LT_TOYLAND) {
8872  /* No tanker in toyland :( */
8873  _gted[engine].cargo_allowed = CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS | CC_LIQUID;
8874  _gted[engine].cargo_disallowed = CC_PASSENGERS;
8875  } else {
8876  _gted[engine].cargo_allowed = CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS;
8877  _gted[engine].cargo_disallowed = CC_LIQUID | CC_PASSENGERS;
8878  }
8879  break;
8880  }
8881  e->u.ship.old_refittable = true;
8882  } else if (e->type == VEH_TRAIN && e->u.rail.railveh_type != RAILVEH_WAGON) {
8883  /* Train engines default to all cargoes, so you can build single-cargo consists with fast engines.
8884  * Trains loading multiple cargoes may start stations accepting unwanted cargoes. */
8885  _gted[engine].cargo_allowed = CC_PASSENGERS | CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS | CC_LIQUID;
8886  _gted[engine].cargo_disallowed = 0;
8887  } else {
8888  /* Train wagons and road vehicles are classified by their default cargo type */
8889  for (const auto &drm : _default_refit_masks) {
8890  if (!HasBit(drm.climate, _settings_game.game_creation.landscape)) continue;
8891  if (drm.cargo_type != ei->cargo_type) continue;
8892 
8893  _gted[engine].cargo_allowed = drm.cargo_allowed;
8894  _gted[engine].cargo_disallowed = drm.cargo_disallowed;
8895  break;
8896  }
8897 
8898  /* All original cargoes have specialised vehicles, so exclude them */
8899  _gted[engine].ctt_exclude_mask = original_known_cargoes;
8900  }
8901  }
8902  _gted[engine].UpdateRefittability(_gted[engine].cargo_allowed != 0);
8903 
8904  /* Translate cargo_type using the original climate-specific cargo table. */
8905  ei->cargo_type = GetDefaultCargoID(_settings_game.game_creation.landscape, static_cast<CargoType>(ei->cargo_type));
8906  if (ei->cargo_type != CT_INVALID) ClrBit(_gted[engine].ctt_exclude_mask, ei->cargo_type);
8907  }
8908 
8909  /* Compute refittability */
8910  {
8911  CargoTypes mask = 0;
8912  CargoTypes not_mask = 0;
8913  CargoTypes xor_mask = ei->refit_mask;
8914 
8915  /* If the original masks set by the grf are zero, the vehicle shall only carry the default cargo.
8916  * Note: After applying the translations, the vehicle may end up carrying no defined cargo. It becomes unavailable in that case. */
8917  only_defaultcargo = _gted[engine].refittability != GRFTempEngineData::NONEMPTY;
8918 
8919  if (_gted[engine].cargo_allowed != 0) {
8920  /* Build up the list of cargo types from the set cargo classes. */
8921  for (const CargoSpec *cs : CargoSpec::Iterate()) {
8922  if (_gted[engine].cargo_allowed & cs->classes) SetBit(mask, cs->Index());
8923  if (_gted[engine].cargo_disallowed & cs->classes) SetBit(not_mask, cs->Index());
8924  }
8925  }
8926 
8927  ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) & _cargo_mask;
8928 
8929  /* Apply explicit refit includes/excludes. */
8930  ei->refit_mask |= _gted[engine].ctt_include_mask;
8931  ei->refit_mask &= ~_gted[engine].ctt_exclude_mask;
8932  }
8933 
8934  /* Clear invalid cargoslots (from default vehicles or pre-NewCargo GRFs) */
8935  if (ei->cargo_type != CT_INVALID && !HasBit(_cargo_mask, ei->cargo_type)) ei->cargo_type = CT_INVALID;
8936 
8937  /* Ensure that the vehicle is either not refittable, or that the default cargo is one of the refittable cargoes.
8938  * Note: Vehicles refittable to no cargo are handle differently to vehicle refittable to a single cargo. The latter might have subtypes. */
8939  if (!only_defaultcargo && (e->type != VEH_SHIP || e->u.ship.old_refittable) && ei->cargo_type != CT_INVALID && !HasBit(ei->refit_mask, ei->cargo_type)) {
8940  ei->cargo_type = CT_INVALID;
8941  }
8942 
8943  /* Check if this engine's cargo type is valid. If not, set to the first refittable
8944  * cargo type. Finally disable the vehicle, if there is still no cargo. */
8945  if (ei->cargo_type == CT_INVALID && ei->refit_mask != 0) {
8946  /* Figure out which CTT to use for the default cargo, if it is 'first refittable'. */
8947  const uint8 *cargo_map_for_first_refittable = nullptr;
8948  {
8949  const GRFFile *file = _gted[engine].defaultcargo_grf;
8950  if (file == nullptr) file = e->GetGRF();
8951  if (file != nullptr && file->grf_version >= 8 && file->cargo_list.size() != 0) {
8952  cargo_map_for_first_refittable = file->cargo_map;
8953  }
8954  }
8955 
8956  if (cargo_map_for_first_refittable != nullptr) {
8957  /* Use first refittable cargo from cargo translation table */
8958  byte best_local_slot = 0xFF;
8959  for (CargoID cargo_type : SetCargoBitIterator(ei->refit_mask)) {
8960  byte local_slot = cargo_map_for_first_refittable[cargo_type];
8961  if (local_slot < best_local_slot) {
8962  best_local_slot = local_slot;
8963  ei->cargo_type = cargo_type;
8964  }
8965  }
8966  }
8967 
8968  if (ei->cargo_type == CT_INVALID) {
8969  /* Use first refittable cargo slot */
8970  ei->cargo_type = (CargoID)FindFirstBit(ei->refit_mask);
8971  }
8972  }
8973  if (ei->cargo_type == CT_INVALID) ei->climates = 0;
8974 
8975  /* Clear refit_mask for not refittable ships */
8976  if (e->type == VEH_SHIP && !e->u.ship.old_refittable) {
8977  ei->refit_mask = 0;
8978  }
8979  }
8980 }
8981 
8983 static void FinaliseCanals()
8984 {
8985  for (uint i = 0; i < CF_END; i++) {
8986  if (_water_feature[i].grffile != nullptr) {
8989  }
8990  }
8991 }
8992 
8994 static void FinaliseEngineArray()
8995 {
8996  for (Engine *e : Engine::Iterate()) {
8997  if (e->GetGRF() == nullptr) {
8998  const EngineIDMapping &eid = _engine_mngr[e->index];
8999  if (eid.grfid != INVALID_GRFID || eid.internal_id != eid.substitute_id) {
9000  e->info.string_id = STR_NEWGRF_INVALID_ENGINE;
9001  }
9002  }
9003 
9004  if (!HasBit(e->info.climates, _settings_game.game_creation.landscape)) continue;
9005 
9006  /* Set appropriate flags on variant engine */
9007  if (e->info.variant_id != INVALID_ENGINE) {
9009  }
9010 
9011  /* Skip wagons, there livery is defined via the engine */
9012  if (e->type != VEH_TRAIN || e->u.rail.railveh_type != RAILVEH_WAGON) {
9015  /* Note: For ships and roadvehicles we assume that they cannot be refitted between passenger and freight */
9016 
9017  if (e->type == VEH_TRAIN) {
9018  SetBit(_loaded_newgrf_features.used_liveries, LS_FREIGHT_WAGON);
9019  switch (ls) {
9020  case LS_STEAM:
9021  case LS_DIESEL:
9022  case LS_ELECTRIC:
9023  case LS_MONORAIL:
9024  case LS_MAGLEV:
9025  SetBit(_loaded_newgrf_features.used_liveries, LS_PASSENGER_WAGON_STEAM + ls - LS_STEAM);
9026  break;
9027 
9028  case LS_DMU:
9029  case LS_EMU:
9030  SetBit(_loaded_newgrf_features.used_liveries, LS_PASSENGER_WAGON_DIESEL + ls - LS_DMU);
9031  break;
9032 
9033  default: NOT_REACHED();
9034  }
9035  }
9036  }
9037  }
9038 }
9039 
9041 static void FinaliseCargoArray()
9042 {
9043  for (CargoID c = 0; c < NUM_CARGO; c++) {
9044  CargoSpec *cs = CargoSpec::Get(c);
9045  if (!cs->IsValid()) {
9046  cs->name = cs->name_single = cs->units_volume = STR_NEWGRF_INVALID_CARGO;
9047  cs->quantifier = STR_NEWGRF_INVALID_CARGO_QUANTITY;
9048  cs->abbrev = STR_NEWGRF_INVALID_CARGO_ABBREV;
9049  }
9050  }
9051 }
9052 
9064 static bool IsHouseSpecValid(HouseSpec *hs, const HouseSpec *next1, const HouseSpec *next2, const HouseSpec *next3, const char *filename)
9065 {
9066  if (((hs->building_flags & BUILDING_HAS_2_TILES) != 0 &&
9067  (next1 == nullptr || !next1->enabled || (next1->building_flags & BUILDING_HAS_1_TILE) != 0)) ||
9068  ((hs->building_flags & BUILDING_HAS_4_TILES) != 0 &&
9069  (next2 == nullptr || !next2->enabled || (next2->building_flags & BUILDING_HAS_1_TILE) != 0 ||
9070  next3 == nullptr || !next3->enabled || (next3->building_flags & BUILDING_HAS_1_TILE) != 0))) {
9071  hs->enabled = false;
9072  if (filename != nullptr) Debug(grf, 1, "FinaliseHouseArray: {} defines house {} as multitile, but no suitable tiles follow. Disabling house.", filename, hs->grf_prop.local_id);
9073  return false;
9074  }
9075 
9076  /* Some places sum population by only counting north tiles. Other places use all tiles causing desyncs.
9077  * As the newgrf specs define population to be zero for non-north tiles, we just disable the offending house.
9078  * If you want to allow non-zero populations somewhen, make sure to sum the population of all tiles in all places. */
9079  if (((hs->building_flags & BUILDING_HAS_2_TILES) != 0 && next1->population != 0) ||
9080  ((hs->building_flags & BUILDING_HAS_4_TILES) != 0 && (next2->population != 0 || next3->population != 0))) {
9081  hs->enabled = false;
9082  if (filename != nullptr) Debug(grf, 1, "FinaliseHouseArray: {} defines multitile house {} with non-zero population on additional tiles. Disabling house.", filename, hs->grf_prop.local_id);
9083  return false;
9084  }
9085 
9086  /* Substitute type is also used for override, and having an override with a different size causes crashes.
9087  * This check should only be done for NewGRF houses because grf_prop.subst_id is not set for original houses.*/
9088  if (filename != nullptr && (hs->building_flags & BUILDING_HAS_1_TILE) != (HouseSpec::Get(hs->grf_prop.subst_id)->building_flags & BUILDING_HAS_1_TILE)) {
9089  hs->enabled = false;
9090  Debug(grf, 1, "FinaliseHouseArray: {} defines house {} with different house size then it's substitute type. Disabling house.", filename, hs->grf_prop.local_id);
9091  return false;
9092  }
9093 
9094  /* Make sure that additional parts of multitile houses are not available. */
9095  if ((hs->building_flags & BUILDING_HAS_1_TILE) == 0 && (hs->building_availability & HZ_ZONALL) != 0 && (hs->building_availability & HZ_CLIMALL) != 0) {
9096  hs->enabled = false;
9097  if (filename != nullptr) Debug(grf, 1, "FinaliseHouseArray: {} defines house {} without a size but marked it as available. Disabling house.", filename, hs->grf_prop.local_id);
9098  return false;
9099  }
9100 
9101  return true;
9102 }
9103 
9110 static void EnsureEarlyHouse(HouseZones bitmask)
9111 {
9112  Year min_year = MAX_YEAR;
9113 
9114  for (int i = 0; i < NUM_HOUSES; i++) {
9115  HouseSpec *hs = HouseSpec::Get(i);
9116  if (hs == nullptr || !hs->enabled) continue;
9117  if ((hs->building_availability & bitmask) != bitmask) continue;
9118  if (hs->min_year < min_year) min_year = hs->min_year;
9119  }
9120 
9121  if (min_year == 0) return;
9122 
9123  for (int i = 0; i < NUM_HOUSES; i++) {
9124  HouseSpec *hs = HouseSpec::Get(i);
9125  if (hs == nullptr || !hs->enabled) continue;
9126  if ((hs->building_availability & bitmask) != bitmask) continue;
9127  if (hs->min_year == min_year) hs->min_year = 0;
9128  }
9129 }
9130 
9137 static void FinaliseHouseArray()
9138 {
9139  /* If there are no houses with start dates before 1930, then all houses
9140  * with start dates of 1930 have them reset to 0. This is in order to be
9141  * compatible with TTDPatch, where if no houses have start dates before
9142  * 1930 and the date is before 1930, the game pretends that this is 1930.
9143  * If there have been any houses defined with start dates before 1930 then
9144  * the dates are left alone.
9145  * On the other hand, why 1930? Just 'fix' the houses with the lowest
9146  * minimum introduction date to 0.
9147  */
9148  for (GRFFile * const file : _grf_files) {
9149  HouseSpec **&housespec = file->housespec;
9150  if (housespec == nullptr) continue;
9151 
9152  for (int i = 0; i < NUM_HOUSES_PER_GRF; i++) {
9153  HouseSpec *hs = housespec[i];
9154 
9155  if (hs == nullptr) continue;
9156 
9157  const HouseSpec *next1 = (i + 1 < NUM_HOUSES_PER_GRF ? housespec[i + 1] : nullptr);
9158  const HouseSpec *next2 = (i + 2 < NUM_HOUSES_PER_GRF ? housespec[i + 2] : nullptr);
9159  const HouseSpec *next3 = (i + 3 < NUM_HOUSES_PER_GRF ? housespec[i + 3] : nullptr);
9160 
9161  if (!IsHouseSpecValid(hs, next1, next2, next3, file->filename)) continue;
9162 
9163  _house_mngr.SetEntitySpec(hs);
9164  }
9165  }
9166 
9167  for (int i = 0; i < NUM_HOUSES; i++) {
9168  HouseSpec *hs = HouseSpec::Get(i);
9169  const HouseSpec *next1 = (i + 1 < NUM_HOUSES ? HouseSpec::Get(i + 1) : nullptr);
9170  const HouseSpec *next2 = (i + 2 < NUM_HOUSES ? HouseSpec::Get(i + 2) : nullptr);
9171  const HouseSpec *next3 = (i + 3 < NUM_HOUSES ? HouseSpec::Get(i + 3) : nullptr);
9172 
9173  /* We need to check all houses again to we are sure that multitile houses
9174  * did get consecutive IDs and none of the parts are missing. */
9175  if (!IsHouseSpecValid(hs, next1, next2, next3, nullptr)) {
9176  /* GetHouseNorthPart checks 3 houses that are directly before
9177  * it in the house pool. If any of those houses have multi-tile
9178  * flags set it assumes it's part of a multitile house. Since
9179  * we can have invalid houses in the pool marked as disabled, we
9180  * don't want to have them influencing valid tiles. As such set
9181  * building_flags to zero here to make sure any house following
9182  * this one in the pool is properly handled as 1x1 house. */
9183  hs->building_flags = TILE_NO_FLAG;
9184  }
9185  }
9186 
9187  HouseZones climate_mask = (HouseZones)(1 << (_settings_game.game_creation.landscape + 12));
9188  EnsureEarlyHouse(HZ_ZON1 | climate_mask);
9189  EnsureEarlyHouse(HZ_ZON2 | climate_mask);
9190  EnsureEarlyHouse(HZ_ZON3 | climate_mask);
9191  EnsureEarlyHouse(HZ_ZON4 | climate_mask);
9192  EnsureEarlyHouse(HZ_ZON5 | climate_mask);
9193 
9194  if (_settings_game.game_creation.landscape == LT_ARCTIC) {
9200  }
9201 }
9202 
9209 {
9210  for (GRFFile * const file : _grf_files) {
9211  IndustrySpec **&industryspec = file->industryspec;
9212  IndustryTileSpec **&indtspec = file->indtspec;
9213  if (industryspec != nullptr) {
9214  for (int i = 0; i < NUM_INDUSTRYTYPES_PER_GRF; i++) {
9215  IndustrySpec *indsp = industryspec[i];
9216 
9217  if (indsp != nullptr && indsp->enabled) {
9218  StringID strid;
9219  /* process the conversion of text at the end, so to be sure everything will be fine
9220  * and available. Check if it does not return undefind marker, which is a very good sign of a
9221  * substitute industry who has not changed the string been examined, thus using it as such */
9222  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->name);
9223  if (strid != STR_UNDEFINED) indsp->name = strid;
9224 
9225  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->closure_text);
9226  if (strid != STR_UNDEFINED) indsp->closure_text = strid;
9227 
9228  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_up_text);
9229  if (strid != STR_UNDEFINED) indsp->production_up_text = strid;
9230 
9231  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_down_text);
9232  if (strid != STR_UNDEFINED) indsp->production_down_text = strid;
9233 
9234  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->new_industry_text);
9235  if (strid != STR_UNDEFINED) indsp->new_industry_text = strid;
9236 
9237  if (indsp->station_name != STR_NULL) {
9238  /* STR_NULL (0) can be set by grf. It has a meaning regarding assignation of the
9239  * station's name. Don't want to lose the value, therefore, do not process. */
9240  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->station_name);
9241  if (strid != STR_UNDEFINED) indsp->station_name = strid;
9242  }
9243 
9244  _industry_mngr.SetEntitySpec(indsp);
9245  }
9246  }
9247  }
9248 
9249  if (indtspec != nullptr) {
9250  for (int i = 0; i < NUM_INDUSTRYTILES_PER_GRF; i++) {
9251  IndustryTileSpec *indtsp = indtspec[i];
9252  if (indtsp != nullptr) {
9253  _industile_mngr.SetEntitySpec(indtsp);
9254  }
9255  }
9256  }
9257  }
9258 
9259  for (uint j = 0; j < NUM_INDUSTRYTYPES; j++) {
9260  IndustrySpec *indsp = &_industry_specs[j];
9261  if (indsp->enabled && indsp->grf_prop.grffile != nullptr) {
9262  for (uint i = 0; i < 3; i++) {
9263  indsp->conflicting[i] = MapNewGRFIndustryType(indsp->conflicting[i], indsp->grf_prop.grffile->grfid);
9264  }
9265  }
9266  if (!indsp->enabled) {
9267  indsp->name = STR_NEWGRF_INVALID_INDUSTRYTYPE;
9268  }
9269  }
9270 }
9271 
9278 {
9279  for (GRFFile * const file : _grf_files) {
9280  ObjectSpec **&objectspec = file->objectspec;
9281  if (objectspec != nullptr) {
9282  for (int i = 0; i < NUM_OBJECTS_PER_GRF; i++) {
9283  if (objectspec[i] != nullptr && objectspec[i]->grf_prop.grffile != nullptr && objectspec[i]->enabled) {
9284  _object_mngr.SetEntitySpec(objectspec[i]);
9285  }
9286  }
9287  }
9288  }
9289 }
9290 
9297 {
9298  for (GRFFile * const file : _grf_files) {
9299  AirportSpec **&airportspec = file->airportspec;
9300  if (airportspec != nullptr) {
9301  for (int i = 0; i < NUM_AIRPORTS_PER_GRF; i++) {
9302  if (airportspec[i] != nullptr && airportspec[i]->enabled) {
9303  _airport_mngr.SetEntitySpec(airportspec[i]);
9304  }
9305  }
9306  }
9307 
9308  AirportTileSpec **&airporttilespec = file->airtspec;
9309  if (airporttilespec != nullptr) {
9310  for (uint i = 0; i < NUM_AIRPORTTILES_PER_GRF; i++) {
9311  if (airporttilespec[i] != nullptr && airporttilespec[i]->enabled) {
9312  _airporttile_mngr.SetEntitySpec(airporttilespec[i]);
9313  }
9314  }
9315  }
9316  }
9317 }
9318 
9319 /* Here we perform initial decoding of some special sprites (as are they
9320  * described at http://www.ttdpatch.net/src/newgrf.txt, but this is only a very
9321  * partial implementation yet).
9322  * XXX: We consider GRF files trusted. It would be trivial to exploit OTTD by
9323  * a crafted invalid GRF file. We should tell that to the user somehow, or
9324  * better make this more robust in the future. */
9325 static void DecodeSpecialSprite(byte *buf, uint num, GrfLoadingStage stage)
9326 {
9327  /* XXX: There is a difference between staged loading in TTDPatch and
9328  * here. In TTDPatch, for some reason actions 1 and 2 are carried out
9329  * during stage 1, whilst action 3 is carried out during stage 2 (to
9330  * "resolve" cargo IDs... wtf). This is a little problem, because cargo
9331  * IDs are valid only within a given set (action 1) block, and may be
9332  * overwritten after action 3 associates them. But overwriting happens
9333  * in an earlier stage than associating, so... We just process actions
9334  * 1 and 2 in stage 2 now, let's hope that won't get us into problems.
9335  * --pasky
9336  * We need a pre-stage to set up GOTO labels of Action 0x10 because the grf
9337  * is not in memory and scanning the file every time would be too expensive.
9338  * In other stages we skip action 0x10 since it's already dealt with. */
9339  static const SpecialSpriteHandler handlers[][GLS_END] = {
9340  /* 0x00 */ { nullptr, SafeChangeInfo, nullptr, nullptr, ReserveChangeInfo, FeatureChangeInfo, },
9341  /* 0x01 */ { SkipAct1, SkipAct1, SkipAct1, SkipAct1, SkipAct1, NewSpriteSet, },
9342  /* 0x02 */ { nullptr, nullptr, nullptr, nullptr, nullptr, NewSpriteGroup, },
9343  /* 0x03 */ { nullptr, GRFUnsafe, nullptr, nullptr, nullptr, FeatureMapSpriteGroup, },
9344  /* 0x04 */ { nullptr, nullptr, nullptr, nullptr, nullptr, FeatureNewName, },
9345  /* 0x05 */ { SkipAct5, SkipAct5, SkipAct5, SkipAct5, SkipAct5, GraphicsNew, },
9346  /* 0x06 */ { nullptr, nullptr, nullptr, CfgApply, CfgApply, CfgApply, },
9347  /* 0x07 */ { nullptr, nullptr, nullptr, nullptr, SkipIf, SkipIf, },
9348  /* 0x08 */ { ScanInfo, nullptr, nullptr, GRFInfo, GRFInfo, GRFInfo, },
9349  /* 0x09 */ { nullptr, nullptr, nullptr, SkipIf, SkipIf, SkipIf, },
9350  /* 0x0A */ { SkipActA, SkipActA, SkipActA, SkipActA, SkipActA, SpriteReplace, },
9351  /* 0x0B */ { nullptr, nullptr, nullptr, GRFLoadError, GRFLoadError, GRFLoadError, },
9352  /* 0x0C */ { nullptr, nullptr, nullptr, GRFComment, nullptr, GRFComment, },
9353  /* 0x0D */ { nullptr, SafeParamSet, nullptr, ParamSet, ParamSet, ParamSet, },
9354  /* 0x0E */ { nullptr, SafeGRFInhibit, nullptr, GRFInhibit, GRFInhibit, GRFInhibit, },
9355  /* 0x0F */ { nullptr, GRFUnsafe, nullptr, FeatureTownName, nullptr, nullptr, },
9356  /* 0x10 */ { nullptr, nullptr, DefineGotoLabel, nullptr, nullptr, nullptr, },
9357  /* 0x11 */ { SkipAct11, GRFUnsafe, SkipAct11, GRFSound, SkipAct11, GRFSound, },
9359  /* 0x13 */ { nullptr, nullptr, nullptr, nullptr, nullptr, TranslateGRFStrings, },
9360  /* 0x14 */ { StaticGRFInfo, nullptr, nullptr, nullptr, nullptr, nullptr, },
9361  };
9362 
9363  GRFLocation location(_cur.grfconfig->ident.grfid, _cur.nfo_line);
9364 
9365  GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
9366  if (it == _grf_line_to_action6_sprite_override.end()) {
9367  /* No preloaded sprite to work with; read the
9368  * pseudo sprite content. */
9369  _cur.file->ReadBlock(buf, num);
9370  } else {
9371  /* Use the preloaded sprite data. */
9372  buf = _grf_line_to_action6_sprite_override[location];
9373  grfmsg(7, "DecodeSpecialSprite: Using preloaded pseudo sprite data");
9374 
9375  /* Skip the real (original) content of this action. */
9376  _cur.file->SeekTo(num, SEEK_CUR);
9377  }
9378 
9379  ByteReader br(buf, buf + num);
9380  ByteReader *bufp = &br;
9381 
9382  try {
9383  byte action = bufp->ReadByte();
9384 
9385  if (action == 0xFF) {
9386  grfmsg(2, "DecodeSpecialSprite: Unexpected data block, skipping");
9387  } else if (action == 0xFE) {
9388  grfmsg(2, "DecodeSpecialSprite: Unexpected import block, skipping");
9389  } else if (action >= lengthof(handlers)) {
9390  grfmsg(7, "DecodeSpecialSprite: Skipping unknown action 0x%02X", action);
9391  } else if (handlers[action][stage] == nullptr) {
9392  grfmsg(7, "DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage);
9393  } else {
9394  grfmsg(7, "DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage);
9395  handlers[action][stage](bufp);
9396  }
9397  } catch (...) {
9398  grfmsg(1, "DecodeSpecialSprite: Tried to read past end of pseudo-sprite data");
9399  DisableGrf(STR_NEWGRF_ERROR_READ_BOUNDS);
9400  }
9401 }
9402 
9409 static void LoadNewGRFFileFromFile(GRFConfig *config, GrfLoadingStage stage, SpriteFile &file)
9410 {
9411  _cur.file = &file;
9412  _cur.grfconfig = config;
9413 
9414  Debug(grf, 2, "LoadNewGRFFile: Reading NewGRF-file '{}'", config->filename);
9415 
9416  byte grf_container_version = file.GetContainerVersion();
9417  if (grf_container_version == 0) {
9418  Debug(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format");
9419  return;
9420  }
9421 
9422  if (stage == GLS_INIT || stage == GLS_ACTIVATION) {
9423  /* We need the sprite offsets in the init stage for NewGRF sounds
9424  * and in the activation stage for real sprites. */
9425  ReadGRFSpriteOffsets(file);
9426  } else {
9427  /* Skip sprite section offset if present. */
9428  if (grf_container_version >= 2) file.ReadDword();
9429  }
9430 
9431  if (grf_container_version >= 2) {
9432  /* Read compression value. */
9433  byte compression = file.ReadByte();
9434  if (compression != 0) {
9435  Debug(grf, 7, "LoadNewGRFFile: Unsupported compression format");
9436  return;
9437  }
9438  }
9439 
9440  /* Skip the first sprite; we don't care about how many sprites this
9441  * does contain; newest TTDPatches and George's longvehicles don't
9442  * neither, apparently. */
9443  uint32 num = grf_container_version >= 2 ? file.ReadDword() : file.ReadWord();
9444  if (num == 4 && file.ReadByte() == 0xFF) {
9445  file.ReadDword();
9446  } else {
9447  Debug(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format");
9448  return;
9449  }
9450 
9451  _cur.ClearDataForNextFile();
9452 
9454 
9455  while ((num = (grf_container_version >= 2 ? file.ReadDword() : file.ReadWord())) != 0) {
9456  byte type = file.ReadByte();
9457  _cur.nfo_line++;
9458 
9459  if (type == 0xFF) {
9460  if (_cur.skip_sprites == 0) {
9461  DecodeSpecialSprite(buf.Allocate(num), num, stage);
9462 
9463  /* Stop all processing if we are to skip the remaining sprites */
9464  if (_cur.skip_sprites == -1) break;
9465 
9466  continue;
9467  } else {
9468  file.SkipBytes(num);
9469  }
9470  } else {
9471  if (_cur.skip_sprites == 0) {
9472  grfmsg(0, "LoadNewGRFFile: Unexpected sprite, disabling");
9473  DisableGrf(STR_NEWGRF_ERROR_UNEXPECTED_SPRITE);
9474  break;
9475  }
9476 
9477  if (grf_container_version >= 2 && type == 0xFD) {
9478  /* Reference to data section. Container version >= 2 only. */
9479  file.SkipBytes(num);
9480  } else {
9481  file.SkipBytes(7);
9482  SkipSpriteData(file, type, num - 8);
9483  }
9484  }
9485 
9486  if (_cur.skip_sprites > 0) _cur.skip_sprites--;
9487  }
9488 }
9489 
9498 void LoadNewGRFFile(GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary)
9499 {
9500  const char *filename = config->filename;
9501 
9502  /* A .grf file is activated only if it was active when the game was
9503  * started. If a game is loaded, only its active .grfs will be
9504  * reactivated, unless "loadallgraphics on" is used. A .grf file is
9505  * considered active if its action 8 has been processed, i.e. its
9506  * action 8 hasn't been skipped using an action 7.
9507  *
9508  * During activation, only actions 0, 1, 2, 3, 4, 5, 7, 8, 9, 0A and 0B are
9509  * carried out. All others are ignored, because they only need to be
9510  * processed once at initialization. */
9511  if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) {
9512  _cur.grffile = GetFileByFilename(filename);
9513  if (_cur.grffile == nullptr) usererror("File '%s' lost in cache.\n", filename);
9514  if (stage == GLS_RESERVE && config->status != GCS_INITIALISED) return;
9515  if (stage == GLS_ACTIVATION && !HasBit(config->flags, GCF_RESERVED)) return;
9516  }
9517 
9518  bool needs_palette_remap = config->palette & GRFP_USE_MASK;
9519  if (temporary) {
9520  SpriteFile temporarySpriteFile(filename, subdir, needs_palette_remap);
9521  LoadNewGRFFileFromFile(config, stage, temporarySpriteFile);
9522  } else {
9523  LoadNewGRFFileFromFile(config, stage, OpenCachedSpriteFile(filename, subdir, needs_palette_remap));
9524  }
9525 }
9526 
9534 static void ActivateOldShore()
9535 {
9536  /* Use default graphics, if no shore sprites were loaded.
9537  * Should not happen, as the base set's extra grf should include some. */
9539 
9541  DupSprite(SPR_ORIGINALSHORE_START + 1, SPR_SHORE_BASE + 1); // SLOPE_W
9542  DupSprite(SPR_ORIGINALSHORE_START + 2, SPR_SHORE_BASE + 2); // SLOPE_S
9543  DupSprite(SPR_ORIGINALSHORE_START + 6, SPR_SHORE_BASE + 3); // SLOPE_SW
9544  DupSprite(SPR_ORIGINALSHORE_START + 0, SPR_SHORE_BASE + 4); // SLOPE_E
9545  DupSprite(SPR_ORIGINALSHORE_START + 4, SPR_SHORE_BASE + 6); // SLOPE_SE
9546  DupSprite(SPR_ORIGINALSHORE_START + 3, SPR_SHORE_BASE + 8); // SLOPE_N
9547  DupSprite(SPR_ORIGINALSHORE_START + 7, SPR_SHORE_BASE + 9); // SLOPE_NW
9548  DupSprite(SPR_ORIGINALSHORE_START + 5, SPR_SHORE_BASE + 12); // SLOPE_NE
9549  }
9550 
9552  DupSprite(SPR_FLAT_GRASS_TILE + 16, SPR_SHORE_BASE + 0); // SLOPE_STEEP_S
9553  DupSprite(SPR_FLAT_GRASS_TILE + 17, SPR_SHORE_BASE + 5); // SLOPE_STEEP_W
9554  DupSprite(SPR_FLAT_GRASS_TILE + 7, SPR_SHORE_BASE + 7); // SLOPE_WSE
9555  DupSprite(SPR_FLAT_GRASS_TILE + 15, SPR_SHORE_BASE + 10); // SLOPE_STEEP_N
9556  DupSprite(SPR_FLAT_GRASS_TILE + 11, SPR_SHORE_BASE + 11); // SLOPE_NWS
9557  DupSprite(SPR_FLAT_GRASS_TILE + 13, SPR_SHORE_BASE + 13); // SLOPE_ENW
9558  DupSprite(SPR_FLAT_GRASS_TILE + 14, SPR_SHORE_BASE + 14); // SLOPE_SEN
9559  DupSprite(SPR_FLAT_GRASS_TILE + 18, SPR_SHORE_BASE + 15); // SLOPE_STEEP_E
9560 
9561  /* XXX - SLOPE_EW, SLOPE_NS are currently not used.
9562  * If they would be used somewhen, then these grass tiles will most like not look as needed */
9563  DupSprite(SPR_FLAT_GRASS_TILE + 5, SPR_SHORE_BASE + 16); // SLOPE_EW
9564  DupSprite(SPR_FLAT_GRASS_TILE + 10, SPR_SHORE_BASE + 17); // SLOPE_NS
9565  }
9566 }
9567 
9572 {
9574  DupSprite(SPR_ROAD_DEPOT + 0, SPR_TRAMWAY_DEPOT_NO_TRACK + 0); // use road depot graphics for "no tracks"
9575  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 1, SPR_TRAMWAY_DEPOT_NO_TRACK + 1);
9576  DupSprite(SPR_ROAD_DEPOT + 2, SPR_TRAMWAY_DEPOT_NO_TRACK + 2); // use road depot graphics for "no tracks"
9577  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 3, SPR_TRAMWAY_DEPOT_NO_TRACK + 3);
9578  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 4, SPR_TRAMWAY_DEPOT_NO_TRACK + 4);
9579  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 5, SPR_TRAMWAY_DEPOT_NO_TRACK + 5);
9580  }
9581 }
9582 
9587 {
9588  extern const PriceBaseSpec _price_base_specs[];
9590  static const uint32 override_features = (1 << GSF_TRAINS) | (1 << GSF_ROADVEHICLES) | (1 << GSF_SHIPS) | (1 << GSF_AIRCRAFT);
9591 
9592  /* Evaluate grf overrides */
9593  int num_grfs = (uint)_grf_files.size();
9594  int *grf_overrides = AllocaM(int, num_grfs);
9595  for (int i = 0; i < num_grfs; i++) {
9596  grf_overrides[i] = -1;
9597 
9598  GRFFile *source = _grf_files[i];
9599  uint32 override = _grf_id_overrides[source->grfid];
9600  if (override == 0) continue;
9601 
9602  GRFFile *dest = GetFileByGRFID(override);
9603  if (dest == nullptr) continue;
9604 
9605  grf_overrides[i] = find_index(_grf_files, dest);
9606  assert(grf_overrides[i] >= 0);
9607  }
9608 
9609  /* Override features and price base multipliers of earlier loaded grfs */
9610  for (int i = 0; i < num_grfs; i++) {
9611  if (grf_overrides[i] < 0 || grf_overrides[i] >= i) continue;
9612  GRFFile *source = _grf_files[i];
9613  GRFFile *dest = _grf_files[grf_overrides[i]];
9614 
9615  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9616  source->grf_features |= features;
9617  dest->grf_features |= features;
9618 
9619  for (Price p = PR_BEGIN; p < PR_END; p++) {
9620  /* No price defined -> nothing to do */
9621  if (!HasBit(features, _price_base_specs[p].grf_feature) || source->price_base_multipliers[p] == INVALID_PRICE_MODIFIER) continue;
9622  Debug(grf, 3, "'{}' overrides price base multiplier {} of '{}'", source->filename, p, dest->filename);
9623  dest->price_base_multipliers[p] = source->price_base_multipliers[p];
9624  }
9625  }
9626 
9627  /* Propagate features and price base multipliers of afterwards loaded grfs, if none is present yet */
9628  for (int i = num_grfs - 1; i >= 0; i--) {
9629  if (grf_overrides[i] < 0 || grf_overrides[i] <= i) continue;
9630  GRFFile *source = _grf_files[i];
9631  GRFFile *dest = _grf_files[grf_overrides[i]];
9632 
9633  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9634  source->grf_features |= features;
9635  dest->grf_features |= features;
9636 
9637  for (Price p = PR_BEGIN; p < PR_END; p++) {
9638  /* Already a price defined -> nothing to do */
9639  if (!HasBit(features, _price_base_specs[p].grf_feature) || dest->price_base_multipliers[p] != INVALID_PRICE_MODIFIER) continue;
9640  Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, source->filename, dest->filename);
9641  dest->price_base_multipliers[p] = source->price_base_multipliers[p];
9642  }
9643  }
9644 
9645  /* The 'master grf' now have the correct multipliers. Assign them to the 'addon grfs' to make everything consistent. */
9646  for (int i = 0; i < num_grfs; i++) {
9647  if (grf_overrides[i] < 0) continue;
9648  GRFFile *source = _grf_files[i];
9649  GRFFile *dest = _grf_files[grf_overrides[i]];
9650 
9651  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9652  source->grf_features |= features;
9653  dest->grf_features |= features;
9654 
9655  for (Price p = PR_BEGIN; p < PR_END; p++) {
9656  if (!HasBit(features, _price_base_specs[p].grf_feature)) continue;
9657  if (source->price_base_multipliers[p] != dest->price_base_multipliers[p]) {
9658  Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, dest->filename, source->filename);
9659  }
9660  source->price_base_multipliers[p] = dest->price_base_multipliers[p];
9661  }
9662  }
9663 
9664  /* Apply fallback prices for grf version < 8 */
9665  for (GRFFile * const file : _grf_files) {
9666  if (file->grf_version >= 8) continue;
9667  PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9668  for (Price p = PR_BEGIN; p < PR_END; p++) {
9669  Price fallback_price = _price_base_specs[p].fallback_price;
9670  if (fallback_price != INVALID_PRICE && price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9671  /* No price multiplier has been set.
9672  * So copy the multiplier from the fallback price, maybe a multiplier was set there. */
9673  price_base_multipliers[p] = price_base_multipliers[fallback_price];
9674  }
9675  }
9676  }
9677 
9678  /* Decide local/global scope of price base multipliers */
9679  for (GRFFile * const file : _grf_files) {
9680  PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9681  for (Price p = PR_BEGIN; p < PR_END; p++) {
9682  if (price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9683  /* No multiplier was set; set it to a neutral value */
9684  price_base_multipliers[p] = 0;
9685  } else {
9686  if (!HasBit(file->grf_features, _price_base_specs[p].grf_feature)) {
9687  /* The grf does not define any objects of the feature,
9688  * so it must be a difficulty setting. Apply it globally */
9689  Debug(grf, 3, "'{}' sets global price base multiplier {}", file->filename, p);
9690  SetPriceBaseMultiplier(p, price_base_multipliers[p]);
9691  price_base_multipliers[p] = 0;
9692  } else {
9693  Debug(grf, 3, "'{}' sets local price base multiplier {}", file->filename, p);
9694  }
9695  }
9696  }
9697  }
9698 }
9699 
9700 extern void InitGRFTownGeneratorNames();
9701 
9703 static void AfterLoadGRFs()
9704 {
9705  for (StringIDMapping &it : _string_to_grf_mapping) {
9706  *it.target = MapGRFStringID(it.grfid, it.source);
9707  }
9708  _string_to_grf_mapping.clear();
9709 
9710  /* Free the action 6 override sprites. */
9711  for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) {
9712  free((*it).second);
9713  }
9714  _grf_line_to_action6_sprite_override.clear();
9715 
9716  /* Polish cargoes */
9718 
9719  /* Pre-calculate all refit masks after loading GRF files. */
9721 
9722  /* Polish engines */
9724 
9725  /* Set the actually used Canal properties */
9726  FinaliseCanals();
9727 
9728  /* Add all new houses to the house array. */
9730 
9731  /* Add all new industries to the industry array. */
9733 
9734  /* Add all new objects to the object array. */
9736 
9738 
9739  /* Sort the list of industry types. */
9741 
9742  /* Create dynamic list of industry legends for smallmap_gui.cpp */
9744 
9745  /* Build the routemap legend, based on the available cargos */
9747 
9748  /* Add all new airports to the airports array. */
9750  BindAirportSpecs();
9751 
9752  /* Update the townname generators list */
9754 
9755  /* Run all queued vehicle list order changes */
9757 
9758  /* Load old shore sprites in new position, if they were replaced by ActionA */
9759  ActivateOldShore();
9760 
9761  /* Load old tram depot sprites in new position, if no new ones are present */
9763 
9764  /* Set up custom rail types */
9765  InitRailTypes();
9766  InitRoadTypes();
9767 
9768  for (Engine *e : Engine::IterateType(VEH_ROAD)) {
9769  if (_gted[e->index].rv_max_speed != 0) {
9770  /* Set RV maximum speed from the mph/0.8 unit value */
9771  e->u.road.max_speed = _gted[e->index].rv_max_speed * 4;
9772  }
9773 
9774  RoadTramType rtt = HasBit(e->info.misc_flags, EF_ROAD_TRAM) ? RTT_TRAM : RTT_ROAD;
9775 
9776  const GRFFile *file = e->GetGRF();
9777  if (file == nullptr || _gted[e->index].roadtramtype == 0) {
9778  e->u.road.roadtype = (rtt == RTT_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD;
9779  continue;
9780  }
9781 
9782  /* Remove +1 offset. */
9783  _gted[e->index].roadtramtype--;
9784 
9785  const std::vector<RoadTypeLabel> *list = (rtt == RTT_TRAM) ? &file->tramtype_list : &file->roadtype_list;
9786  if (_gted[e->index].roadtramtype < list->size())
9787  {
9788  RoadTypeLabel rtl = (*list)[_gted[e->index].roadtramtype];
9789  RoadType rt = GetRoadTypeByLabel(rtl);
9790  if (rt != INVALID_ROADTYPE && GetRoadTramType(rt) == rtt) {
9791  e->u.road.roadtype = rt;
9792  continue;
9793  }
9794  }
9795 
9796  /* Road type is not available, so disable this engine */
9797  e->info.climates = 0;
9798  }
9799 
9800  for (Engine *e : Engine::IterateType(VEH_TRAIN)) {
9801  RailType railtype = GetRailTypeByLabel(_gted[e->index].railtypelabel);
9802  if (railtype == INVALID_RAILTYPE) {
9803  /* Rail type is not available, so disable this engine */
9804  e->info.climates = 0;
9805  } else {
9806  e->u.rail.railtype = railtype;
9807  }
9808  }
9809 
9811 
9813 
9814  /* Deallocate temporary loading data */
9815  free(_gted);
9816  _grm_sprites.clear();
9817 }
9818 
9824 void LoadNewGRF(uint load_index, uint num_baseset)
9825 {
9826  /* In case of networking we need to "sync" the start values
9827  * so all NewGRFs are loaded equally. For this we use the
9828  * start date of the game and we set the counters, etc. to
9829  * 0 so they're the same too. */
9830  Date date = _date;
9831  Year year = _cur_year;
9832  DateFract date_fract = _date_fract;
9833  uint64 tick_counter = _tick_counter;
9834  byte display_opt = _display_opt;
9835 
9836  if (_networking) {
9838  _date = ConvertYMDToDate(_cur_year, 0, 1);
9839  _date_fract = 0;
9840  _tick_counter = 0;
9841  _display_opt = 0;
9842  }
9843 
9845 
9846  ResetNewGRFData();
9847 
9848  /*
9849  * Reset the status of all files, so we can 'retry' to load them.
9850  * This is needed when one for example rearranges the NewGRFs in-game
9851  * and a previously disabled NewGRF becomes usable. If it would not
9852  * be reset, the NewGRF would remain disabled even though it should
9853  * have been enabled.
9854  */
9855  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9856  if (c->status != GCS_NOT_FOUND) c->status = GCS_UNKNOWN;
9857  }
9858 
9859  _cur.spriteid = load_index;
9860 
9861  /* Load newgrf sprites
9862  * in each loading stage, (try to) open each file specified in the config
9863  * and load information from it. */
9864  for (GrfLoadingStage stage = GLS_LABELSCAN; stage <= GLS_ACTIVATION; stage++) {
9865  /* Set activated grfs back to will-be-activated between reservation- and activation-stage.
9866  * This ensures that action7/9 conditions 0x06 - 0x0A work correctly. */
9867  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9868  if (c->status == GCS_ACTIVATED) c->status = GCS_INITIALISED;
9869  }
9870 
9871  if (stage == GLS_RESERVE) {
9872  static const uint32 overrides[][2] = {
9873  { 0x44442202, 0x44440111 }, // UKRS addons modifies UKRS
9874  { 0x6D620402, 0x6D620401 }, // DBSetXL ECS extension modifies DBSetXL
9875  { 0x4D656f20, 0x4D656F17 }, // LV4cut modifies LV4
9876  };
9877  for (size_t i = 0; i < lengthof(overrides); i++) {
9878  SetNewGRFOverride(BSWAP32(overrides[i][0]), BSWAP32(overrides[i][1]));
9879  }
9880  }
9881 
9882  uint num_grfs = 0;
9883  uint num_non_static = 0;
9884 
9885  _cur.stage = stage;
9886  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9887  if (c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND) continue;
9888  if (stage > GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) continue;
9889 
9890  Subdirectory subdir = num_grfs < num_baseset ? BASESET_DIR : NEWGRF_DIR;
9891  if (!FioCheckFileExists(c->filename, subdir)) {
9892  Debug(grf, 0, "NewGRF file is missing '{}'; disabling", c->filename);
9893  c->status = GCS_NOT_FOUND;
9894  continue;
9895  }
9896 
9897  if (stage == GLS_LABELSCAN) InitNewGRFFile(c);
9898 
9899  if (!HasBit(c->flags, GCF_STATIC) && !HasBit(c->flags, GCF_SYSTEM)) {
9900  if (num_non_static == NETWORK_MAX_GRF_COUNT) {
9901  Debug(grf, 0, "'{}' is not loaded as the maximum number of non-static GRFs has been reached", c->filename);
9902  c->status = GCS_DISABLED;
9903  c->error = new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9904  continue;
9905  }
9906  num_non_static++;
9907  }
9908 
9909  num_grfs++;
9910 
9911  LoadNewGRFFile(c, stage, subdir, false);
9912  if (stage == GLS_RESERVE) {
9913  SetBit(c->flags, GCF_RESERVED);
9914  } else if (stage == GLS_ACTIVATION) {
9915  ClrBit(c->flags, GCF_RESERVED);
9916  assert(GetFileByGRFID(c->ident.grfid) == _cur.grffile);
9919  Debug(sprite, 2, "LoadNewGRF: Currently {} sprites are loaded", _cur.spriteid);
9920  } else if (stage == GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) {
9921  /* We're not going to activate this, so free whatever data we allocated */
9923  }
9924  }
9925  }
9926 
9927  /* Pseudo sprite processing is finished; free temporary stuff */
9928  _cur.ClearDataForNextFile();
9929 
9930  /* Call any functions that should be run after GRFs have been loaded. */
9931  AfterLoadGRFs();
9932 
9933  /* Now revert back to the original situation */
9934  _cur_year = year;
9935  _date = date;
9936  _date_fract = date_fract;
9937  _tick_counter = tick_counter;
9938  _display_opt = display_opt;
9939 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
MapLogX
static uint MapLogX()
Logarithm of the map size along the X side.
Definition: map_func.h:51
GRFConfig::version
uint32 version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
Definition: newgrf_config.h:171
ResetCustomHouses
static void ResetCustomHouses()
Reset and clear all NewGRF houses.
Definition: newgrf.cpp:8492
AirportSpec::min_year
Year min_year
first year the airport is available
Definition: newgrf_airport.h:109
RoadTypeInfo::flags
RoadTypeFlags flags
Bit mask of road type flags.
Definition: road.h:125
ChangeGRFName
static bool ChangeGRFName(byte langid, const char *str)
Callback function for 'INFO'->'NAME' to add a translation to the newgrf name.
Definition: newgrf.cpp:7876
AllowedSubtags::call_handler
bool call_handler
True if there is a callback function for this node, false if there is a list of subnodes.
Definition: newgrf.cpp:8156
RoadTypeInfo::new_engine
StringID new_engine
Name of an engine for this type of road in the engine preview GUI.
Definition: road.h:106
StationChangeInfo
static ChangeInfoResult StationChangeInfo(uint stid, int numinfo, int prop, ByteReader *buf)
Define properties for stations.
Definition: newgrf.cpp:1900
ParamSet
static void ParamSet(ByteReader *buf)
Action 0x0D: Set parameter.
Definition: newgrf.cpp:7164
GRFLocation
Definition: newgrf.cpp:360
CalculateRefitMasks
static void CalculateRefitMasks()
Precalculate refit masks from cargo classes for all vehicles.
Definition: newgrf.cpp:8811
GRFP_USE_MASK
@ GRFP_USE_MASK
Bitmask to get only the use palette use states.
Definition: newgrf_config.h:68
RoadTypeInfo::toolbar_caption
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
Definition: road.h:102
HouseSpec::removal_cost
byte removal_cost
cost multiplier for removing it
Definition: house.h:103
CargoType
CargoType
Available types of cargo.
Definition: cargo_type.h:23
AllocateSound
SoundEntry * AllocateSound(uint num)
Allocate sound slots.
Definition: newgrf_sound.cpp:31
GRFTempEngineData::UpdateRefittability
void UpdateRefittability(bool non_empty)
Update the summary refittability on setting a refittability property.
Definition: newgrf.cpp:339
INVALID_ENGINE
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:186
EngineInfo::base_life
Year base_life
Basic duration of engine availability (without random parts). 0xFF means infinite life.
Definition: engine_type.h:145
YearMonthDay::day
Day day
Day (1..31)
Definition: date_type.h:107
Action5Type::sprite_base
SpriteID sprite_base
Load the sprites starting from this sprite.
Definition: newgrf.cpp:6168
OrderSettings::improved_load
bool improved_load
improved loading algorithm
Definition: settings_type.h:475
MAX_NUM_GENDERS
static const uint8 MAX_NUM_GENDERS
Maximum number of supported genders.
Definition: language.h:20
INVALID_AIRPORTTILE
static const uint INVALID_AIRPORTTILE
id for an invalid airport tile
Definition: airport.h:25
RoadTypeInfo
Definition: road.h:76
GRFConfig::num_valid_params
uint8 num_valid_params
NOSAVE: Number of valid parameters (action 0x14)
Definition: newgrf_config.h:178
DuplicateTileTable
static void DuplicateTileTable(AirportSpec *as)
Create a copy of the tile table so it can be freed later without problems.
Definition: newgrf.cpp:3824
IsInsideMM
static constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition: math_func.hpp:204
NUM_STATIONS_PER_GRF
static const uint NUM_STATIONS_PER_GRF
Number of StationSpecs per NewGRF; limited to 255 to allow extending Action3 with an extended byte la...
Definition: newgrf.cpp:314
PROP_TRAIN_SPEED
@ PROP_TRAIN_SPEED
Max. speed: 1 unit = 1/1.6 mph = 1 km-ish/h.
Definition: newgrf_properties.h:21
GRFConfig::info
GRFTextWrapper info
NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
Definition: newgrf_config.h:167
CargoSpec::callback_mask
uint8 callback_mask
Bitmask of cargo callbacks that have to be called.
Definition: cargotype.h:69
AllowedSubtags::AllowedSubtags
AllowedSubtags()
Create empty subtags object used to identify the end of a list.
Definition: newgrf.cpp:8091
GameCreationSettings::generation_seed
uint32 generation_seed
noise seed for world generation
Definition: settings_type.h:310
GRFFileProps::override
uint16 override
id of the entity been replaced by
Definition: newgrf_commons.h:333
NUM_INDUSTRYTYPES
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like INV...
Definition: industry_type.h:26
ROADTYPE_END
@ ROADTYPE_END
Used for iterations.
Definition: road_type.h:26
RAILTYPE_MAGLEV
@ RAILTYPE_MAGLEV
Maglev.
Definition: rail_type.h:32
ResetCustomObjects
static void ResetCustomObjects()
Reset and clear all NewObjects.
Definition: newgrf.cpp:8573
RailVehicleInfo::pow_wag_weight
byte pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition: engine_type.h:56
Engine::IterateType
static Pool::IterateWrapperFiltered< Engine, EngineTypeFilter > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
Definition: engine_base.h:173
IndustrySpec::map_colour
byte map_colour
colour used for the small map
Definition: industrytype.h:126
EngineDisplayFlags::HasVariants
@ HasVariants
Set if engine has variants.
LanguageMetadata
Make sure the size is right.
Definition: language.h:93
VE_DISABLE_EFFECT
@ VE_DISABLE_EFFECT
Flag to disable visual effect.
Definition: vehicle_base.h:92
RailtypeInfo::max_speed
uint16 max_speed
Maximum speed for vehicles travelling on this rail type.
Definition: rail.h:228
newgrf_station.h
newgrf_house.h
GRFFile::language_map
struct LanguageMap * language_map
Mappings related to the languages.
Definition: newgrf.h:141
GRFFile::roadtype_list
std::vector< RoadTypeLabel > roadtype_list
Roadtype translation table (road)
Definition: newgrf.h:133
Pool::PoolItem<&_engine_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
EngineOverrideManager::ResetToDefaultMapping
void ResetToDefaultMapping()
Initializes the EngineOverrideManager with the default engines.
Definition: engine.cpp:479
CargoSpec::label
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:59
StationSpec::flags
byte flags
Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size.
Definition: newgrf_station.h:160
LanguageMap::case_map
std::vector< Mapping > case_map
Mapping of NewGRF and OpenTTD IDs for cases.
Definition: newgrf_text.h:72
PROP_TRAIN_CARGO_CAPACITY
@ PROP_TRAIN_CARGO_CAPACITY
Capacity (if dualheaded: for each single vehicle)
Definition: newgrf_properties.h:24
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
AllowedSubtags::AllowedSubtags
AllowedSubtags(uint32 id, AllowedSubtags *subtags)
Create a branch node with a list of sub-nodes.
Definition: newgrf.cpp:8138
GRFConfig::error
GRFError * error
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
Definition: newgrf_config.h:169
GameSettings::station
StationSettings station
settings related to station management
Definition: settings_type.h:595
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:36
ResetCustomAirports
static void ResetCustomAirports()
Reset and clear all NewGRF airports.
Definition: newgrf.cpp:8507
GRFTextList
std::vector< GRFText > GRFTextList
A GRF text with a list of translations.
Definition: newgrf_text.h:31
PROP_ROADVEH_TRACTIVE_EFFORT
@ PROP_ROADVEH_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
Definition: newgrf_properties.h:39
SNOW_LINE_DAYS
static const uint SNOW_LINE_DAYS
Number of days in each month in the snow line table.
Definition: landscape.h:17
ObjectChangeInfo
static ChangeInfoResult ObjectChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for objects.
Definition: newgrf.cpp:4078
EngineIDMapping::grfid
uint32 grfid
The GRF ID of the file the entity belongs to.
Definition: engine_base.h:180
RoadTypeInfo::menu_text
StringID menu_text
Name of this rail type in the main toolbar dropdown.
Definition: road.h:103
IndustryProductionSpriteGroup::subtract_input
int16 subtract_input[INDUSTRY_NUM_INPUTS]
Take this much of the input cargo (can be negative, is indirect in cb version 1+)
Definition: newgrf_spritegroup.h:273
usererror
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:105
DeterministicSpriteGroupRange
Definition: newgrf_spritegroup.h:160
StationSpec::renderdata
std::vector< NewGRFSpriteLayout > renderdata
Number of tile layouts.
Definition: newgrf_station.h:148
NUM_INDUSTRYTYPES_PER_GRF
static const IndustryType NUM_INDUSTRYTYPES_PER_GRF
maximum number of industry types per NewGRF; limited to 128 because bit 7 has a special meaning in so...
Definition: industry_type.h:23
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
SPR_SHORE_BASE
static const SpriteID SPR_SHORE_BASE
shore tiles - action 05-0D
Definition: sprites.h:224
TLF_DODRAW
@ TLF_DODRAW
Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
Definition: newgrf_commons.h:36
ReusableBuffer
A reusable buffer that can be used for places that temporary allocate a bit of memory and do that ver...
Definition: alloc_type.hpp:24
AircraftVehicleInfo::subtype
byte subtype
Type of aircraft.
Definition: engine_type.h:102
OBJECT_FLAG_2CC_COLOUR
@ OBJECT_FLAG_2CC_COLOUR
Object wants 2CC colour mapping.
Definition: newgrf_object.h:34
ShipVehicleChangeInfo
static ChangeInfoResult ShipVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for ships.
Definition: newgrf.cpp:1558
GetRoadTypeByLabel
RoadType GetRoadTypeByLabel(RoadTypeLabel label, bool allow_alternate_labels)
Get the road type for a given label.
Definition: road.cpp:243
HouseSpec::random_colour
byte random_colour[4]
4 "random" colours
Definition: house.h:116
PROP_ROADVEH_COST_FACTOR
@ PROP_ROADVEH_COST_FACTOR
Purchase cost.
Definition: newgrf_properties.h:35
GCS_ACTIVATED
@ GCS_ACTIVATED
GRF file has been activated.
Definition: newgrf_config.h:39
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:60
CanalProperties::callback_mask
uint8 callback_mask
Bitmask of canal callbacks that have to be called.
Definition: newgrf.h:40
RailtypeInfo::menu_text
StringID menu_text
Name of this rail type in the main toolbar dropdown.
Definition: rail.h:175
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:62
GrfProcessingState::grffile
GRFFile * grffile
Currently processed GRF file.
Definition: newgrf.cpp:104
ObjectFlags
ObjectFlags
Various object behaviours.
Definition: newgrf_object.h:24
DrawTileSeqStruct::IsParentSprite
bool IsParentSprite() const
Check whether this is a parent sprite with a boundingbox.
Definition: sprite.h:47
BridgeSpec::flags
byte flags
bit 0 set: disable drawing of far pillars.
Definition: bridge.h:52
ObjectSpec::build_cost_multiplier
uint8 build_cost_multiplier
Build cost multiplier per tile.
Definition: newgrf_object.h:68
BridgeSpec::avail_year
Year avail_year
the year where it becomes available
Definition: bridge.h:42
ResetCustomIndustries
static void ResetCustomIndustries()
Reset and clear all NewGRF industries.
Definition: newgrf.cpp:8544
PROP_TRAIN_RUNNING_COST_FACTOR
@ PROP_TRAIN_RUNNING_COST_FACTOR
Yearly runningcost (if dualheaded: sum of both vehicles)
Definition: newgrf_properties.h:23
smallmap_gui.h
_grf_files
static std::vector< GRFFile * > _grf_files
List of all loaded GRF files.
Definition: newgrf.cpp:67
SPRITE_WIDTH
@ SPRITE_WIDTH
number of bits for the sprite number
Definition: sprites.h:1523
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:326
StringIDMapping::grfid
uint32 grfid
Source NewGRF.
Definition: newgrf.cpp:468
ShipVehicleInfo::canal_speed_frac
byte canal_speed_frac
Fraction of maximum speed for canal/river tiles.
Definition: engine_type.h:76
TLF_CHILD_X_OFFSET
@ TLF_CHILD_X_OFFSET
Add signed offset to child sprite X positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:44
RoadTypeInfo::introduces_roadtypes
RoadTypes introduces_roadtypes
Bitmask of which other roadtypes are introduced when this roadtype is introduced.
Definition: road.h:175
TE_GOODS
@ TE_GOODS
Cargo behaves goods/candy-like.
Definition: cargotype.h:31
_engine_counts
const uint8 _engine_counts[4]
Number of engines of each vehicle type in original engine data.
Definition: engine.cpp:51
AllowedSubtags::AllowedSubtags
AllowedSubtags(uint32 id, DataHandler handler)
Create a binary leaf node.
Definition: newgrf.cpp:8101
GRFFile::price_base_multipliers
PriceMultipliers price_base_multipliers
Price base multipliers as set by the grf.
Definition: newgrf.h:147
FeatureTownName
static void FeatureTownName(ByteReader *buf)
Action 0x0F - Define Town names.
Definition: newgrf.cpp:7514
grfmsg
void CDECL grfmsg(int severity, const char *str,...)
Debug() function dedicated to newGRF debugging messages Function is essentially the same as Debug(grf...
Definition: newgrf.cpp:391
_cur_year
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:26
IndustriesChangeInfo
static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, ByteReader *buf)
Define properties for industries.
Definition: newgrf.cpp:3444
DeterministicSpriteGroup
Definition: newgrf_spritegroup.h:167
TileLayoutRegisters::sprite
uint8 sprite
Register specifying a signed offset for the sprite.
Definition: newgrf_commons.h:94
PROP_TRAIN_TRACTIVE_EFFORT
@ PROP_TRAIN_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
Definition: newgrf_properties.h:27
AllowedSubtags::branch
BranchHandler branch
Callback function for a branch node, only valid if type == 'C' && call_handler.
Definition: newgrf.cpp:8153
HandleNodes
static bool HandleNodes(ByteReader *buf, AllowedSubtags subtags[])
Handle the contents of a 'C' choice of an Action14.
Definition: newgrf.cpp:8348
EngineDisplayFlags::IsFolded
@ IsFolded
Set if display of variants should be folded (hidden).
HouseSpec::accepts_cargo
CargoID accepts_cargo[HOUSE_NUM_ACCEPTS]
input cargo slots
Definition: house.h:108
RoadTypeInfo::sorting_order
byte sorting_order
The sorting order of this roadtype for the toolbar dropdown.
Definition: road.h:180
CargoSpec::initial_payment
int32 initial_payment
Initial payment rate before inflation is applied.
Definition: cargotype.h:64
AirportSpec::size_y
byte size_y
size of airport in y direction
Definition: newgrf_airport.h:106
CargoSpec::town_effect
TownEffect town_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition: cargotype.h:68
NewGRFSpriteLayout::AllocateRegisters
void AllocateRegisters()
Allocate memory for register modifiers.
Definition: newgrf_commons.cpp:636
Pool::CleanPool
virtual void CleanPool()
Virtual method that deletes all items in the pool.
PALETTE_MODIFIER_COLOUR
@ PALETTE_MODIFIER_COLOUR
this bit is set when a recolouring process is in action
Definition: sprites.h:1538
BASESET_DIR
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
Definition: fileio_type.h:116
currency.h
GRFConfig::num_params
uint8 num_params
Number of used parameters.
Definition: newgrf_config.h:177
GetNewEngine
static Engine * GetNewEngine(const GRFFile *file, VehicleType type, uint16 internal_id, bool static_access=false)
Returns the engine associated to a certain internal_id, resp.
Definition: newgrf.cpp:605
_date_fract
DateFract _date_fract
Fractional part of the day.
Definition: date.cpp:29
TileLayoutRegisters::parent
uint8 parent[3]
Registers for signed offsets for the bounding box position of parent sprites.
Definition: newgrf_commons.h:99
NamePart::prob
byte prob
The relative probability of the following name to appear in the bottom 7 bits.
Definition: newgrf_townname.h:20
Price
Price
Enumeration of all base prices for use with Prices.
Definition: economy_type.h:74
PROP_AIRCRAFT_MAIL_CAPACITY
@ PROP_AIRCRAFT_MAIL_CAPACITY
Mail Capacity.
Definition: newgrf_properties.h:53
AirportSpec::name
StringID name
name of this airport
Definition: newgrf_airport.h:111
CC_EXPRESS
@ CC_EXPRESS
Express cargo (Goods, Food, Candy, but also possible for passengers)
Definition: cargotype.h:43
FinaliseCanals
static void FinaliseCanals()
Set to use the correct action0 properties for each canal feature.
Definition: newgrf.cpp:8983
RailtypeInfo::replace_text
StringID replace_text
Text used in the autoreplace GUI.
Definition: rail.h:177
GRFFile::grf_features
uint32 grf_features
Bitset of GrfSpecFeature the grf uses.
Definition: newgrf.h:146
LanguageMap::plural_form
int plural_form
The plural form used for this language.
Definition: newgrf_text.h:73
ConstructionSettings::map_height_limit
uint8 map_height_limit
the maximum allowed heightlevel
Definition: settings_type.h:339
CurrencySpec::symbol_pos
byte symbol_pos
The currency symbol is represented by two possible values, prefix and suffix Usage of one or the othe...
Definition: currency.h:87
EC_STEAM
@ EC_STEAM
Steam rail engine.
Definition: engine_type.h:34
PriceBaseSpec::grf_feature
uint grf_feature
GRF Feature that decides whether price multipliers apply locally or globally, #GSF_END if none.
Definition: economy_type.h:193
AircraftVehicleInfo::passenger_capacity
uint16 passenger_capacity
Passenger capacity (persons).
Definition: engine_type.h:107
IndustrySpec::removal_cost_multiplier
uint32 removal_cost_multiplier
Base removal cost multiplier.
Definition: industrytype.h:110
RandomizedSpriteGroup::cmp_mode
RandomizedSpriteGroupCompareMode cmp_mode
Check for these triggers:
Definition: newgrf_spritegroup.h:195
DeterministicSpriteGroupAdjust::parameter
byte parameter
Used for variables between 0x60 and 0x7F inclusive.
Definition: newgrf_spritegroup.h:151
VE_DEFAULT
@ VE_DEFAULT
Default value to indicate that visual effect should be based on engine class.
Definition: vehicle_base.h:96
A5BLOCK_INVALID
@ A5BLOCK_INVALID
unknown/not-implemented type
Definition: newgrf.cpp:6163
Action5BlockType
Action5BlockType
The type of action 5 type.
Definition: newgrf.cpp:6160
ChangeGRFParamLimits
static bool ChangeGRFParamLimits(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'LIMI' to set the min/max value of a parameter.
Definition: newgrf.cpp:8023
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
PROP_ROADVEH_SHORTEN_FACTOR
@ PROP_ROADVEH_SHORTEN_FACTOR
Shorter vehicles.
Definition: newgrf_properties.h:41
BridgeSpec::sprite_table
PalSpriteID ** sprite_table
table of sprites for drawing the bridge
Definition: bridge.h:51
IsValidNewGRFImageIndex
static bool IsValidNewGRFImageIndex(uint8 image_index)
Helper to check whether an image index is valid for a particular NewGRF vehicle.
Definition: newgrf.cpp:205
AirportSpec::max_year
Year max_year
last year the airport is available
Definition: newgrf_airport.h:110
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:118
IndustryProductionSpriteGroup::num_input
uint8 num_input
How many subtract_input values are valid.
Definition: newgrf_spritegroup.h:272
ResetPersistentNewGRFData
void ResetPersistentNewGRFData()
Reset NewGRF data which is stored persistently in savegames.
Definition: newgrf.cpp:8706
PROP_SHIP_CARGO_CAPACITY
@ PROP_SHIP_CARGO_CAPACITY
Capacity.
Definition: newgrf_properties.h:45
TileLayoutRegisters::palette_var10
uint8 palette_var10
Value for variable 10 when resolving the palette.
Definition: newgrf_commons.h:103
HouseExtraFlags
HouseExtraFlags
Definition: house.h:88
_bridge
BridgeSpec _bridge[MAX_BRIDGES]
The specification of all bridges.
Definition: tunnelbridge_cmd.cpp:51
PalSpriteID::sprite
SpriteID sprite
The 'real' sprite.
Definition: gfx_type.h:23
GrfProcessingState::ClearDataForNextFile
void ClearDataForNextFile()
Clear temporary data before processing the next file in the current loading stage.
Definition: newgrf.cpp:115
PROP_AIRCRAFT_RUNNING_COST_FACTOR
@ PROP_AIRCRAFT_RUNNING_COST_FACTOR
Yearly runningcost.
Definition: newgrf_properties.h:51
RAILTYPE_MONO
@ RAILTYPE_MONO
Monorail.
Definition: rail_type.h:31
HouseSpec::enabled
bool enabled
the house is available to build (true by default, but can be disabled by newgrf)
Definition: house.h:111
AirportSpec::noise_level
byte noise_level
noise that this airport generates
Definition: newgrf_airport.h:107
ChangeGRFVersion
static bool ChangeGRFVersion(size_t len, ByteReader *buf)
Callback function for 'INFO'->'VRSN' to the version of the NewGRF.
Definition: newgrf.cpp:7957
SortIndustryTypes
void SortIndustryTypes()
Initialize the list of sorted industry types.
Definition: industry_gui.cpp:209
FindFirstBit
uint8 FindFirstBit(uint64 x)
Search the first set bit in a 64 bit variable.
Definition: bitmath_func.cpp:37
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
ResetPriceBaseMultipliers
void ResetPriceBaseMultipliers()
Reset changes to the price base multipliers.
Definition: economy.cpp:882
ChangeGRFParamName
static bool ChangeGRFParamName(byte langid, const char *str)
Callback function for 'INFO'->'PARAM'->param_num->'NAME' to set the name of a parameter.
Definition: newgrf.cpp:7992
ResetRailTypes
void ResetRailTypes()
Reset all rail type information to its default values.
Definition: rail_cmd.cpp:64
GrfProcessingState::spritesets
std::map< uint, SpriteSet > spritesets[GSF_END]
Currently referenceable spritesets.
Definition: newgrf.cpp:95
GrfProcessingState::spriteid
SpriteID spriteid
First available SpriteID for loading realsprites.
Definition: newgrf.cpp:100
RailtypeInfo
This struct contains all the info that is needed to draw and construct tracks.
Definition: rail.h:124
WaterFeature::callback_mask
uint8 callback_mask
Bitmask of canal callbacks that have to be called.
Definition: newgrf_canal.h:25
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
VehicleSettings::wagon_speed_limits
bool wagon_speed_limits
enable wagon speed limits
Definition: settings_type.h:490
CIR_INVALID_ID
@ CIR_INVALID_ID
Attempt to modify an invalid ID.
Definition: newgrf.cpp:996
GRFParameterInfo::param_nr
byte param_nr
GRF parameter to store content in.
Definition: newgrf_config.h:143
TLF_CUSTOM_PALETTE
@ TLF_CUSTOM_PALETTE
Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading).
Definition: newgrf_commons.h:39
RailtypeInfo::grffile
const GRFFile * grffile[RTSG_END]
NewGRF providing the Action3 for the railtype.
Definition: rail.h:273
SetNewGRFOverride
static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)
Set the override for a NewGRF.
Definition: newgrf.cpp:591
_tags_info
AllowedSubtags _tags_info[]
Action14 tags for the INFO node.
Definition: newgrf.cpp:8244
Year
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:18
vehicle_base.h
GRFUnsafe
static void GRFUnsafe(ByteReader *buf)
Set the current NewGRF as unsafe for static use.
Definition: newgrf.cpp:8374
GRFParameterInfo::def_value
uint32 def_value
Default value of this parameter.
Definition: newgrf_config.h:142
fileio_func.h
GCS_NOT_FOUND
@ GCS_NOT_FOUND
GRF file was not found in the local cache.
Definition: newgrf_config.h:37
ConvertTTDBasePrice
static void ConvertTTDBasePrice(uint32 base_pointer, const char *error_location, Price *index)
Converts TTD(P) Base Price pointers into the enum used by OTTD See http://wiki.ttdpatch....
Definition: newgrf.cpp:971
newgrf_airport.h
SetupCargoForClimate
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:40
build_industry.h
GRFTempEngineData::ctt_include_mask
CargoTypes ctt_include_mask
Cargo types always included in the refit mask.
Definition: newgrf.cpp:332
HouseSpec::building_name
StringID building_name
building name
Definition: house.h:104
ObjectSpec::end_of_life_date
Date end_of_life_date
When can't this object be built anymore.
Definition: newgrf_object.h:71
CargoSpec::Iterate
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition: cargotype.h:174
SetupEngines
void SetupEngines()
Initialise the engine pool with the data from the original vehicles.
Definition: engine.cpp:535
OverrideManagerBase::GetID
virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const
Return the ID (if ever available) of a previously inserted entity.
Definition: newgrf_commons.cpp:102
GRFConfig::ident
GRFIdentifier ident
grfid and md5sum to uniquely identify newgrfs
Definition: newgrf_config.h:163
newgrf_townname.h
AircraftVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
Definition: engine_type.h:105
LiveryScheme
LiveryScheme
List of different livery schemes.
Definition: livery.h:20
AirportSpec::ResetAirports
static void ResetAirports()
This function initializes the airportspec array.
Definition: newgrf_airport.cpp:153
GCF_COPY
@ GCF_COPY
The data is copied from a grf in _all_grfs.
Definition: newgrf_config.h:27
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:57
AllowedSubtags::AllowedSubtags
AllowedSubtags(uint32 id, TextHandler handler)
Create a text leaf node.
Definition: newgrf.cpp:8113
ReusableBuffer::Allocate
T * Allocate(size_t count)
Get buffer of at least count times T.
Definition: alloc_type.hpp:42
GRFConfig::status
GRFStatus status
NOSAVE: GRFStatus, enum.
Definition: newgrf_config.h:174
GetNewGRFSoundID
SoundID GetNewGRFSoundID(const GRFFile *file, SoundID sound_id)
Resolve NewGRF sound ID.
Definition: newgrf_sound.cpp:169
VE_TYPE_COUNT
@ VE_TYPE_COUNT
Number of bits used for the effect type.
Definition: vehicle_base.h:86
town.h
ORIGINAL_BASE_YEAR
static const Year ORIGINAL_BASE_YEAR
The minimum starting year/base year of the original TTD.
Definition: date_type.h:50
NUM_OBJECTS_PER_GRF
static const ObjectType NUM_OBJECTS_PER_GRF
Number of supported objects per NewGRF; limited to 255 to allow extending Action3 with an extended by...
Definition: object_type.h:22
RailVehicleInfo::power
uint16 power
Power of engine (hp); For multiheaded engines the sum of both engine powers.
Definition: engine_type.h:48
CC_LIQUID
@ CC_LIQUID
Liquids (Oil, Water, Rubber)
Definition: cargotype.h:47
GRFP_GRF_UNSET
@ GRFP_GRF_UNSET
The NewGRF provided no information.
Definition: newgrf_config.h:70
EngineInfo
Information about a vehicle.
Definition: engine_type.h:142
ChangeGRFParamType
static bool ChangeGRFParamType(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'TYPE' to set the typeof a parameter.
Definition: newgrf.cpp:8006
DSGA_OP_ADD
@ DSGA_OP_ADD
a + b
Definition: newgrf_spritegroup.h:121
GrfProcessingState::file
SpriteFile * file
File of currently processed GRF file.
Definition: newgrf.cpp:103
GMB_TRAIN_WIDTH_32_PIXELS
@ GMB_TRAIN_WIDTH_32_PIXELS
Use 32 pixels per train vehicle in depot gui and vehicle details. Never set in the global variable;.
Definition: newgrf.h:60
IndustrySpec::station_name
StringID station_name
Default name for nearby station.
Definition: industrytype.h:132
CreateGroupFromGroupID
static const SpriteGroup * CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid)
Helper function to either create a callback or a result sprite group.
Definition: newgrf.cpp:5000
DIR_W
@ DIR_W
West.
Definition: direction_type.h:32
_display_opt
byte _display_opt
What do we want to draw/do?
Definition: transparency_gui.cpp:26
OverrideManagerBase::Add
void Add(uint8 local_id, uint32 grfid, uint entity_type)
Since the entity IDs defined by the GRF file does not necessarily correlate to those used by the game...
Definition: newgrf_commons.cpp:72
EngineInfo::base_intro
Date base_intro
Basic date of engine introduction (without random parts).
Definition: engine_type.h:143
CIR_SUCCESS
@ CIR_SUCCESS
Variable was parsed and read.
Definition: newgrf.cpp:992
MAX_SPRITEGROUP
static const uint MAX_SPRITEGROUP
Maximum GRF-local ID for a spritegroup.
Definition: newgrf.cpp:83
GRFLoadedFeatures::used_liveries
uint64 used_liveries
Bitmask of LiveryScheme used by the defined engines.
Definition: newgrf.h:177
HouseSpec::max_year
Year max_year
last year it can be built
Definition: house.h:101
VehicleSettings::road_side
byte road_side
the side of the road vehicles drive on
Definition: settings_type.h:501
RoadTypeInfo::replace_text
StringID replace_text
Text used in the autoreplace GUI.
Definition: road.h:105
AllowedSubtags::text
TextHandler text
Callback function for a text node, only valid if type == 'T'.
Definition: newgrf.cpp:8150
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition: newgrf_spritegroup.h:101
RailtypeInfo::fallback_railtype
byte fallback_railtype
Original railtype number to use when drawing non-newgrf railtypes, or when drawing stations.
Definition: rail.h:198
Engine
Definition: engine_base.h:36
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
CC_PASSENGERS
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:41
EngineIDMapping::internal_id
uint16 internal_id
The internal ID within the GRF file.
Definition: engine_base.h:181
GRFParameterInfo::type
GRFParameterType type
The type of this parameter.
Definition: newgrf_config.h:139
SoundEffectChangeInfo
static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, ByteReader *buf)
Define properties for sound effects.
Definition: newgrf.cpp:3088
_tags_parameters
AllowedSubtags _tags_parameters[]
Action14 parameter tags.
Definition: newgrf.cpp:8200
RoadVehicleInfo::roadtype
RoadType roadtype
Road type.
Definition: engine_type.h:126
SpriteFile::GetContainerVersion
byte GetContainerVersion() const
Get the version number of container type used by the file.
Definition: sprite_file_type.hpp:38
RoadTypeInfo::introduction_date
Date introduction_date
Introduction date.
Definition: road.h:164
SoundEntry::grf_container_ver
byte grf_container_ver
NewGRF container version if the sound is from a NewGRF.
Definition: sound_type.h:22
fios.h
TranslateGRFStrings
static void TranslateGRFStrings(ByteReader *buf)
Action 0x13.
Definition: newgrf.cpp:7823
SmallMap::Insert
bool Insert(const T &key, const U &data)
Adds new item to this map.
Definition: smallmap_type.hpp:127
BridgeSpec::speed
uint16 speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: bridge.h:46
FinalisePriceBaseMultipliers
static void FinalisePriceBaseMultipliers()
Decide whether price base multipliers of grfs shall apply globally or only to the grf specifying them...
Definition: newgrf.cpp:9586
RandomAccessFile::ReadBlock
void ReadBlock(void *ptr, size_t size)
Read a block.
Definition: random_access_file.cpp:138
TranslateTTDPatchCodes
std::string TranslateTTDPatchCodes(uint32 grfid, uint8 language_id, bool allow_newlines, const std::string &str, StringControlCode byte80)
Translate TTDPatch string codes into something OpenTTD can handle (better).
Definition: newgrf_text.cpp:241
MemCpyT
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
Definition: mem_func.hpp:23
TLF_BB_Z_OFFSET
@ TLF_BB_Z_OFFSET
Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:42
GFX_WATERTILE_SPECIALCHECK
@ GFX_WATERTILE_SPECIALCHECK
not really a tile, but rather a very special check
Definition: industry_map.h:54
GRFTempEngineData::rv_max_speed
uint8 rv_max_speed
Temporary storage of RV prop 15, maximum speed in mph/0.8.
Definition: newgrf.cpp:331
ObjectSpec::size
uint8 size
The size of this objects; low nibble for X, high nibble for Y.
Definition: newgrf_object.h:67
GRFFile::GetParam
uint32 GetParam(uint number) const
Get GRF Parameter with range checking.
Definition: newgrf.h:153
AirportSpec
Defines the data structure for an airport.
Definition: newgrf_airport.h:98
EngineOverrideManager::GetID
EngineID GetID(VehicleType type, uint16 grf_local_id, uint32 grfid)
Looks up an EngineID in the EngineOverrideManager.
Definition: engine.cpp:502
ObjectSpec::callback_mask
uint16 callback_mask
Bitmask of requested/allowed callbacks.
Definition: newgrf_object.h:74
NUM_HOUSES_PER_GRF
static const HouseID NUM_HOUSES_PER_GRF
Number of supported houses per NewGRF; limited to 255 to allow extending Action3 with an extended byt...
Definition: house.h:25
INVALID_ROADTYPE
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition: road_type.h:27
genworld.h
RailtypeInfo::sorting_order
byte sorting_order
The sorting order of this railtype for the toolbar dropdown.
Definition: rail.h:268
TileLayoutRegisters
Additional modifiers for items in sprite layouts.
Definition: newgrf_commons.h:91
AnimationInfo::speed
uint8 speed
The speed, i.e. the amount of time between frames.
Definition: newgrf_animation_type.h:21
TileLayoutRegisters::dodraw
uint8 dodraw
Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
Definition: newgrf_commons.h:93
GRFIdentifier::grfid
uint32 grfid
GRF ID (defined by Action 0x08)
Definition: newgrf_config.h:84
GRFP_BLT_UNSET
@ GRFP_BLT_UNSET
The NewGRF provided no information or doesn't care about a 32 bpp blitter.
Definition: newgrf_config.h:76
RandomAccessFile::ReadByte
byte ReadByte()
Read a byte from the file.
Definition: random_access_file.cpp:100
CargoLabel
uint32 CargoLabel
Globally unique label of a cargo type.
Definition: cargotype.h:23
ObjectSpec::animation
AnimationInfo animation
Information about the animation.
Definition: newgrf_object.h:73
CIR_UNHANDLED
@ CIR_UNHANDLED
Variable was parsed but unread.
Definition: newgrf.cpp:994
RoadVehicleInfo::air_drag
uint8 air_drag
Coefficient of air drag.
Definition: engine_type.h:123
AirportSpec::maintenance_cost
uint16 maintenance_cost
maintenance cost multiplier
Definition: newgrf_airport.h:115
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:100
CargoSpec::bitnum
uint8 bitnum
Cargo bit number, is INVALID_CARGO for a non-used spec.
Definition: cargotype.h:58
SPR_AQUEDUCT_BASE
static const SpriteID SPR_AQUEDUCT_BASE
Sprites for the Aqueduct.
Definition: sprites.h:186
RailVehicleInfo::cost_factor
byte cost_factor
Purchase cost factor; For multiheaded engines the sum of both engine prices.
Definition: engine_type.h:45
industry_map.h
DeterministicSpriteGroupAdjustOperation
DeterministicSpriteGroupAdjustOperation
Definition: newgrf_spritegroup.h:120
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:584
GRFParameterInfo::num_bit
byte num_bit
Number of bits to use for this parameter.
Definition: newgrf_config.h:145
RAILTYPE_ELECTRIC
@ RAILTYPE_ELECTRIC
Electric rails.
Definition: rail_type.h:30
RandomizedSpriteGroup::var_scope
VarSpriteGroupScope var_scope
Take this object:
Definition: newgrf_spritegroup.h:193
GCF_INVALID
@ GCF_INVALID
GRF is unusable with this version of OpenTTD.
Definition: newgrf_config.h:30
AllocateRoadType
RoadType AllocateRoadType(RoadTypeLabel label, RoadTramType rtt)
Allocate a new road type label.
Definition: road_cmd.cpp:140
AirportChangeInfo
static ChangeInfoResult AirportChangeInfo(uint airport, int numinfo, int prop, ByteReader *buf)
Define properties for airports.
Definition: newgrf.cpp:3853
IndustryTileLayout
std::vector< IndustryTileLayoutTile > IndustryTileLayout
A complete tile layout for an industry is a list of tiles.
Definition: industrytype.h:102
GCF_INIT_ONLY
@ GCF_INIT_ONLY
GRF file is processed up to GLS_INIT.
Definition: newgrf_config.h:28
EC_ELECTRIC
@ EC_ELECTRIC
Electric rail engine.
Definition: engine_type.h:36
AddGRFString
StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid_to_add, bool new_scheme, bool allow_newlines, const char *text_to_add, StringID def_string)
Add the new read string into our structure.
Definition: newgrf_text.cpp:551
GetFileByGRFID
static GRFFile * GetFileByGRFID(uint32 grfid)
Obtain a NewGRF file by its grfID.
Definition: newgrf.cpp:408
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
ObjectSpec::introduction_date
Date introduction_date
From when can this object be built.
Definition: newgrf_object.h:70
StringIDMapping::target
StringID * target
Destination for mapping result.
Definition: newgrf.cpp:470
RailtypeInfo::introduction_required_railtypes
RailTypes introduction_required_railtypes
Bitmask of railtypes that are required for this railtype to be introduced at a given introduction_dat...
Definition: rail.h:258
RandomAccessFile::SkipBytes
void SkipBytes(int n)
Skip n bytes ahead in the file.
Definition: random_access_file.cpp:148
BridgeSpec
Struct containing information about a single bridge type.
Definition: bridge.h:41
RailtypeInfo::name
StringID name
Name of this rail type.
Definition: rail.h:173
IndustrySpec::closure_text
StringID closure_text
Message appearing when the industry closes.
Definition: industrytype.h:129
EngineInfo::lifelength
Year lifelength
Lifetime of a single vehicle.
Definition: engine_type.h:144
Engine::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:154
GrfProcessingState::SpriteSet::sprite
SpriteID sprite
SpriteID of the first sprite of the set.
Definition: newgrf.cpp:90
GRFFile::traininfo_vehicle_pitch
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
Definition: newgrf.h:143
AirportTileSpec::ResetAirportTiles
static void ResetAirportTiles()
This function initializes the tile array of AirportTileSpec.
Definition: newgrf_airporttiles.cpp:57
TLF_KNOWN_FLAGS
@ TLF_KNOWN_FLAGS
Known flags. Any unknown set flag will disable the GRF.
Definition: newgrf_commons.h:50
ShipVehicleInfo::visual_effect
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:74
RoadVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:118
DrawTileSprites::ground
PalSpriteID ground
Palette and sprite for the ground.
Definition: sprite.h:59
HouseSpec::extra_flags
HouseExtraFlags extra_flags
some more flags
Definition: house.h:118
GetRailTypeInfo
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
AirportTileSpec
Defines the data structure of each individual tile of an airport.
Definition: newgrf_airporttiles.h:66
HouseSpec::probability
byte probability
Relative probability of appearing (16 is the standard value)
Definition: house.h:117
NETWORK_MAX_GRF_COUNT
static const uint NETWORK_MAX_GRF_COUNT
Maximum number of GRFs that can be sent.
Definition: config.h:95
IndustryTileSpec::special_flags
IndustryTileSpecialFlags special_flags
Bitmask of extra flags used by the tile.
Definition: industrytype.h:170
StationSpec::cls_id
StationClassID cls_id
The class to which this spec belongs.
Definition: newgrf_station.h:126
EC_MAGLEV
@ EC_MAGLEV
Maglev engine.
Definition: engine_type.h:38
GRFTempEngineData::Refittability
Refittability
Summary state of refittability properties.
Definition: newgrf.cpp:319
NFO_UTF8_IDENTIFIER
static const WChar NFO_UTF8_IDENTIFIER
This character, the thorn ('þ'), indicates a unicode string to NFO.
Definition: newgrf_text.h:22
IndustryProductionSpriteGroup::num_output
uint8 num_output
How many add_output values are valid.
Definition: newgrf_spritegroup.h:275
newgrf_airporttiles.h
GameSettings::order
OrderSettings order
settings related to orders
Definition: settings_type.h:591
RealSpriteGroup::loading
std::vector< const SpriteGroup * > loading
List of loading groups (can be SpriteIDs or Callback results)
Definition: newgrf_spritegroup.h:90
Pool::PoolItem<&_engine_pool >::GetPoolSize
static size_t GetPoolSize()
Returns first unused index.
Definition: pool_type.hpp:358
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
InitGRFTownGeneratorNames
void InitGRFTownGeneratorNames()
Allocate memory for the NewGRF town names.
Definition: newgrf_townname.cpp:109
GRFP_GRF_DOS
@ GRFP_GRF_DOS
The NewGRF says the DOS palette can be used.
Definition: newgrf_config.h:71
_grm_engines
static uint32 _grm_engines[256]
Contains the GRF ID of the owner of a vehicle if it has been reserved.
Definition: newgrf.cpp:355
MAX_CATCHMENT
@ MAX_CATCHMENT
Maximum catchment for airports with "modified catchment" enabled.
Definition: station_type.h:85
AnimationInfo::frames
uint8 frames
The number of frames.
Definition: newgrf_animation_type.h:19
DrawTileSeqStruct::delta_x
int8 delta_x
0x80 is sequence terminator
Definition: sprite.h:26
GRFLoadedFeatures::has_2CC
bool has_2CC
Set if any vehicle is loaded which uses 2cc (two company colours).
Definition: newgrf.h:176
PROP_ROADVEH_SPEED
@ PROP_ROADVEH_SPEED
Max. speed: 1 unit = 1/0.8 mph = 2 km-ish/h.
Definition: newgrf_properties.h:38
RailVehicleInfo::visual_effect
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:57
TileIndexDiffC::y
int16 y
The y value of the coordinate.
Definition: map_type.h:59
GrfProcessingState::HasValidSpriteSets
bool HasValidSpriteSets(byte feature) const
Check whether there are any valid spritesets for a feature.
Definition: newgrf.cpp:151
DisableStaticNewGRFInfluencingNonStaticNewGRFs
static void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig *c)
Disable a static NewGRF when it is influencing another (non-static) NewGRF as this could cause desync...
Definition: newgrf.cpp:6598
LoadNewGRF
void LoadNewGRF(uint load_index, uint num_baseset)
Load all the NewGRFs.
Definition: newgrf.cpp:9824
AirportSpec::rotation
const Direction * rotation
the rotation of each tiletable
Definition: newgrf_airport.h:101
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
LoadNewGRFFile
void LoadNewGRFFile(GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary)
Load a particular NewGRF.
Definition: newgrf.cpp:9498
SHORE_REPLACE_NONE
@ SHORE_REPLACE_NONE
No shore sprites were replaced.
Definition: newgrf.h:163
RailVehicleInfo::ai_passenger_only
byte ai_passenger_only
Bit value to tell AI that this engine is for passenger use only.
Definition: engine_type.h:54
EconomySettings::station_noise_level
bool station_noise_level
build new airports when the town noise level is still within accepted limits
Definition: settings_type.h:527
RailVehicleInfo
Information about a rail vehicle.
Definition: engine_type.h:42
GRFLoadedFeatures::shore
ShoreReplacement shore
In which way shore sprites were replaced.
Definition: newgrf.h:178
_gted
static GRFTempEngineData * _gted
Temporary engine data used during NewGRF loading.
Definition: newgrf.cpp:349
TE_NONE
@ TE_NONE
Cargo has no effect.
Definition: cargotype.h:28
RoadTypeInfo::powered_roadtypes
RoadTypes powered_roadtypes
bitmask to the OTHER roadtypes on which a vehicle of THIS roadtype generates power
Definition: road.h:120
NUM_AIRPORTTILES_PER_GRF
static const uint NUM_AIRPORTTILES_PER_GRF
Number of airport tiles per NewGRF; limited to 255 to allow extending Action3 with an extended byte l...
Definition: airport.h:21
RailVehicleInfo::engclass
EngineClass engclass
Class of engine for this vehicle.
Definition: engine_type.h:52
IndustryTileSpec::acceptance
int8 acceptance[INDUSTRY_NUM_INPUTS]
Level of acceptance per cargo type (signed, may be negative!)
Definition: industrytype.h:158
BindAirportSpecs
void BindAirportSpecs()
Tie all airportspecs to their class.
Definition: newgrf_airport.cpp:165
LoadNextSprite
bool LoadNextSprite(int load_index, SpriteFile &file, uint file_sprite_id)
Load a real or recolour sprite.
Definition: spritecache.cpp:611
VE_TYPE_START
@ VE_TYPE_START
First bit used for the type of effect.
Definition: vehicle_base.h:85
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
GRFFile::tramtype_list
std::vector< RoadTypeLabel > tramtype_list
Roadtype translation table (tram)
Definition: newgrf.h:136
GetSnowLine
byte GetSnowLine()
Get the current snow line, either variable or static.
Definition: landscape.cpp:656
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:329
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
PROP_AIRCRAFT_CARGO_AGE_PERIOD
@ PROP_AIRCRAFT_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:54
NEW_INDUSTRYOFFSET
static const IndustryType NEW_INDUSTRYOFFSET
original number of industry types
Definition: industry_type.h:25
RailVehicleInfo::air_drag
byte air_drag
Coefficient of air drag.
Definition: engine_type.h:60
LanguageMap::GetLanguageMap
static const LanguageMap * GetLanguageMap(uint32 grfid, uint8 language_id)
Get the language map associated with a given NewGRF and language.
Definition: newgrf.cpp:2596
GCF_UNSAFE
@ GCF_UNSAFE
GRF file is unsafe for static usage.
Definition: newgrf_config.h:24
GCS_INITIALISED
@ GCS_INITIALISED
GRF file has been initialised.
Definition: newgrf_config.h:38
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition: newgrf_config.h:155
NUM_HOUSES
static const HouseID NUM_HOUSES
Total number of houses.
Definition: house.h:29
newgrf_engine.h
PROP_ROADVEH_CARGO_AGE_PERIOD
@ PROP_ROADVEH_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:40
HasExactlyOneBit
static bool HasExactlyOneBit(T value)
Test whether value has exactly 1 bit set.
Definition: bitmath_func.hpp:274
MAX_BRIDGES
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
Definition: bridge.h:34
DrawTileSeqStruct::delta_z
int8 delta_z
0x80 identifies child sprites
Definition: sprite.h:28
StringIDMapping::source
StringID source
Source StringID (GRF local).
Definition: newgrf.cpp:469
AirportSpec::num_table
byte num_table
number of elements in the table
Definition: newgrf_airport.h:102
SetPriceBaseMultiplier
void SetPriceBaseMultiplier(Price price, int factor)
Change a price base by the given factor.
Definition: economy.cpp:894
IndustrySpec::conflicting
IndustryType conflicting[3]
Industries this industry cannot be close to.
Definition: industrytype.h:112
EngineInfo::callback_mask
byte callback_mask
Bitmask of vehicle callbacks that have to be called.
Definition: engine_type.h:153
CurrencySpec::suffix
std::string suffix
Suffix to apply when formatting money in this currency.
Definition: currency.h:77
TLF_BB_XY_OFFSET
@ TLF_BB_XY_OFFSET
Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:41
DIR_E
@ DIR_E
East.
Definition: direction_type.h:28
MIN_YEAR
static const Year MIN_YEAR
The absolute minimum & maximum years in OTTD.
Definition: date_type.h:84
StationSpec::layouts
std::vector< std::vector< std::vector< byte > > > layouts
Custom platform layouts.
Definition: newgrf_station.h:176
OverrideManagerBase::ResetMapping
void ResetMapping()
Resets the mapping, which is used while initializing game.
Definition: newgrf_commons.cpp:82
FinaliseIndustriesArray
static void FinaliseIndustriesArray()
Add all new industries to the industry array.
Definition: newgrf.cpp:9208
TLF_CHILD_Y_OFFSET
@ TLF_CHILD_Y_OFFSET
Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:45
GRFP_GRF_ANY
@ GRFP_GRF_ANY
The NewGRF says any palette can be used.
Definition: newgrf_config.h:73
GCF_SYSTEM
@ GCF_SYSTEM
GRF file is an openttd-internal system grf.
Definition: newgrf_config.h:23
YearMonthDay::month
Month month
Month (0..11)
Definition: date_type.h:106
NEW_HOUSE_OFFSET
static const HouseID NEW_HOUSE_OFFSET
Offset for new houses.
Definition: house.h:28
HandleParameterInfo
static bool HandleParameterInfo(ByteReader *buf)
Callback function for 'INFO'->'PARA' to set extra information about the parameters.
Definition: newgrf.cpp:8217
StationSpec::pylons
byte pylons
Bitmask of base tiles (0 - 7) which should contain elrail pylons.
Definition: newgrf_station.h:162
AirportTileTable::gfx
StationGfx gfx
AirportTile to use for this tile.
Definition: newgrf_airport.h:25
StrMakeValidInPlace
void StrMakeValidInPlace(char *str, const char *last, StringValidationSettings settings)
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
Definition: string.cpp:273
CallbackResultSpriteGroup
Definition: newgrf_spritegroup.h:210
CargoSpec::units_volume
StringID units_volume
Name of a single unit of cargo of this type.
Definition: cargotype.h:73
CargoSpec::IsValid
bool IsValid() const
Tests for validity of this cargospec.
Definition: cargotype.h:99
RailtypeInfo::alternate_labels
RailTypeLabelList alternate_labels
Rail type labels this type provides in addition to the main label.
Definition: rail.h:238
HouseSpec::building_flags
BuildingFlags building_flags
some flags that describe the house (size, stadium etc...)
Definition: house.h:109
RoadVehicleInfo
Information about a road vehicle.
Definition: engine_type.h:112
CC_PIECE_GOODS
@ CC_PIECE_GOODS
Piece goods (Livestock, Wood, Steel, Paper)
Definition: cargotype.h:46
GRFConfig::flags
uint8 flags
NOSAVE: GCF_Flags, bitset.
Definition: newgrf_config.h:173
BranchHandler
bool(* BranchHandler)(ByteReader *)
Type of callback function for branch nodes.
Definition: newgrf.cpp:8080
LanguageMap::Mapping::openttd_id
byte openttd_id
OpenTTD's internal ID for a case/gender.
Definition: newgrf_text.h:62
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
RoadVehicleInfo::visual_effect
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:124
IndustryProductionSpriteGroup
Definition: newgrf_spritegroup.h:268
ConvertYMDToDate
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
IndustrySpec::layouts
std::vector< IndustryTileLayout > layouts
List of possible tile layouts for the industry.
Definition: industrytype.h:108
SPRITE_MODIFIER_OPAQUE
@ SPRITE_MODIFIER_OPAQUE
Set when a sprite must not ever be displayed transparently.
Definition: sprites.h:1536
IndustrySpec::accepts_cargo
CargoID accepts_cargo[INDUSTRY_NUM_INPUTS]
16 accepted cargoes.
Definition: industrytype.h:121
INDUSTRYTILE_NOANIM
static const IndustryGfx INDUSTRYTILE_NOANIM
flag to mark industry tiles as having no animation
Definition: industry_type.h:31
INVALID_INDUSTRYTILE
static const IndustryGfx INVALID_INDUSTRYTILE
one above amount is considered invalid
Definition: industry_type.h:34
GetGRFSpriteOffset
size_t GetGRFSpriteOffset(uint32 id)
Get the file offset for a specific sprite in the sprite section of a GRF.
Definition: spritecache.cpp:546
EF_USES_2CC
@ EF_USES_2CC
Vehicle uses two company colours.
Definition: engine_type.h:167
SHORE_REPLACE_ONLY_NEW
@ SHORE_REPLACE_ONLY_NEW
Only corner-shores were loaded by Action5 (openttd(w/d).grf only).
Definition: newgrf.h:166
IndustrySpec::number_of_sounds
uint8 number_of_sounds
Number of sounds available in the sounds array.
Definition: industrytype.h:135
find_index
int find_index(std::vector< T > const &vec, T const &item)
Helper function to get the index of an item Consider using std::set, std::unordered_set or std::flat_...
Definition: smallvec_type.hpp:44
BridgeSpec::transport_name
StringID transport_name[2]
description of the bridge, when built for road or rail
Definition: bridge.h:50
CC_BULK
@ CC_BULK
Bulk cargo (Coal, Grain etc., Ores, Fruit)
Definition: cargotype.h:45
_cargo_mask
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:29
AircraftVehicleInfo::max_range
uint16 max_range
Maximum range of this aircraft.
Definition: engine_type.h:108
AddGenericCallback
void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group)
Add a generic feature callback sprite group to the appropriate feature list.
Definition: newgrf_generic.cpp:109
SP_CUSTOM
@ SP_CUSTOM
No profile, special "custom" highscore.
Definition: settings_type.h:45
NUM_AIRPORTS_PER_GRF
@ NUM_AIRPORTS_PER_GRF
Maximal number of airports per NewGRF.
Definition: airport.h:40
IndustrySpec::production_up_text
StringID production_up_text
Message appearing when the industry's production is increasing.
Definition: industrytype.h:130
CleanUpStrings
void CleanUpStrings()
House cleaning.
Definition: newgrf_text.cpp:695
Date
int32 Date
The type to store our dates in.
Definition: date_type.h:14
EnsureEarlyHouse
static void EnsureEarlyHouse(HouseZones bitmask)
Make sure there is at least one house available in the year 0 for the given climate / housezone combi...
Definition: newgrf.cpp:9110
GrfProcessingState::SpriteSet
Definition of a single Action1 spriteset.
Definition: newgrf.cpp:89
LoadNewGRFFileFromFile
static void LoadNewGRFFileFromFile(GRFConfig *config, GrfLoadingStage stage, SpriteFile &file)
Load a particular NewGRF from a SpriteFile.
Definition: newgrf.cpp:9409
IndustrySpec::input_cargo_multiplier
uint16 input_cargo_multiplier[INDUSTRY_NUM_INPUTS][INDUSTRY_NUM_OUTPUTS]
Input cargo multipliers (multiply amount of incoming cargo for the produced cargoes)
Definition: industrytype.h:122
CargoSpec::grffile
const struct GRFFile * grffile
NewGRF where #group belongs to.
Definition: cargotype.h:80
StaticGRFInfo
static void StaticGRFInfo(ByteReader *buf)
Handle Action 0x14.
Definition: newgrf.cpp:8363
EC_DIESEL
@ EC_DIESEL
Diesel rail engine.
Definition: engine_type.h:35
HZ_ZONALL
@ HZ_ZONALL
1F This is just to englobe all above types at once
Definition: house.h:78
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:19
StationSettings::never_expire_airports
bool never_expire_airports
never expire airports
Definition: settings_type.h:559
AfterLoadGRFs
static void AfterLoadGRFs()
Finish loading NewGRFs and execute needed post-processing.
Definition: newgrf.cpp:9703
_cur_parameter
static GRFParameterInfo * _cur_parameter
The parameter which info is currently changed by the newgrf.
Definition: newgrf.cpp:7989
IndustrySpec::minimal_cargo
byte minimal_cargo
minimum amount of cargo transported to the stations.
Definition: industrytype.h:120
RoadTypeInfo::group
const SpriteGroup * group[ROTSG_END]
Sprite groups for resolving sprites.
Definition: road.h:190
LanguageMap::gender_map
std::vector< Mapping > gender_map
Mapping of NewGRF and OpenTTD IDs for genders.
Definition: newgrf_text.h:71
SHORE_REPLACE_ACTION_5
@ SHORE_REPLACE_ACTION_5
Shore sprites were replaced by Action5.
Definition: newgrf.h:164
StringIDMapping
Information for mapping static StringIDs.
Definition: newgrf.cpp:467
RailtypeInfo::introduction_date
Date introduction_date
Introduction date.
Definition: rail.h:252
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:54
HouseSpec::animation
AnimationInfo animation
information about the animation.
Definition: house.h:120
NUM_INDUSTRYTILES_PER_GRF
static const IndustryGfx NUM_INDUSTRYTILES_PER_GRF
Maximum number of industry tiles per NewGRF; limited to 255 to allow extending Action3 with an extend...
Definition: industry_type.h:29
ANIM_STATUS_NO_ANIMATION
static const uint8 ANIM_STATUS_NO_ANIMATION
There is no animation.
Definition: newgrf_animation_type.h:15
ValidateIndustryLayout
static bool ValidateIndustryLayout(const IndustryTileLayout &layout)
Validate the industry layout; e.g.
Definition: newgrf.cpp:3411
RoadTypeInfo::alternate_labels
RoadTypeLabelList alternate_labels
Road type labels this type provides in addition to the main label.
Definition: road.h:150
MapNewGRFIndustryType
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)
Map the GRF local type to an industry type.
Definition: newgrf_industries.cpp:39
ChangeGRFURL
static bool ChangeGRFURL(byte langid, const char *str)
Callback function for 'INFO'->'URL_' to set the newgrf url.
Definition: newgrf.cpp:7890
_water_feature
WaterFeature _water_feature[CF_END]
Table of canal 'feature' sprite groups.
Definition: newgrf_canal.cpp:21
PriceBaseSpec::fallback_price
Price fallback_price
Fallback price multiplier for new prices but old grfs.
Definition: economy_type.h:194
GRFParameterInfo
Information about one grf parameter.
Definition: newgrf_config.h:134
CargoSpec::sprite
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain).
Definition: cargotype.h:77
ConvertDateToYMD
void ConvertDateToYMD(Date date, YearMonthDay *ymd)
Converts a Date to a Year, Month & Day.
Definition: date.cpp:94
GameSettings::economy
EconomySettings economy
settings to change the economy
Definition: settings_type.h:593
DrawTileSeqStruct::IsTerminator
bool IsTerminator() const
Check whether this is a sequence terminator.
Definition: sprite.h:41
AirportSpec::ttd_airport_type
TTDPAirportType ttd_airport_type
ttdpatch airport type (Small/Large/Helipad/Oilrig)
Definition: newgrf_airport.h:112
PROP_SHIP_CARGO_AGE_PERIOD
@ PROP_SHIP_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:47
HandleNode
static bool HandleNode(byte type, uint32 id, ByteReader *buf, AllowedSubtags subtags[])
Handle the nodes of an Action14.
Definition: newgrf.cpp:8310
TileLayoutRegisters::child
uint8 child[2]
Registers for signed offsets for the position of child sprites.
Definition: newgrf_commons.h:100
_action5_types
static const Action5Type _action5_types[]
The information about action 5 types.
Definition: newgrf.cpp:6175
NewGRFSpriteLayout
NewGRF supplied spritelayout.
Definition: newgrf_commons.h:113
MAX_LANG
static const uint MAX_LANG
Maximum number of languages supported by the game, and the NewGRF specs.
Definition: strings_type.h:19
safeguards.h
ChangeGRFParamMask
static bool ChangeGRFParamMask(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'MASK' to set the parameter and bits to use.
Definition: newgrf.cpp:8045
StationSpec::name
StringID name
Name of this station.
Definition: newgrf_station.h:127
ObjectOverrideManager::SetEntitySpec
void SetEntitySpec(ObjectSpec *spec)
Method to install the new object data in its proper slot The slot assignment is internal of this meth...
Definition: newgrf_commons.cpp:315
GRFP_BLT_32BPP
@ GRFP_BLT_32BPP
The NewGRF prefers a 32 bpp blitter.
Definition: newgrf_config.h:77
HouseSpec::callback_mask
uint16 callback_mask
Bitmask of house callbacks that have to be called.
Definition: house.h:115
IndustryTileSpec::slopes_refused
Slope slopes_refused
slope pattern on which this tile cannot be built
Definition: industrytype.h:159
ChangeGRFParamValueNames
static bool ChangeGRFParamValueNames(ByteReader *buf)
Callback function for 'INFO'->'PARA'->param_num->'VALU' to set the names of some parameter values (ty...
Definition: newgrf.cpp:8170
ImportGRFSound
static void ImportGRFSound(SoundEntry *sound)
Process a sound import from another GRF file.
Definition: newgrf.cpp:7615
GRFConfig::has_param_defaults
bool has_param_defaults
NOSAVE: did this newgrf specify any defaults for it's parameters.
Definition: newgrf_config.h:181
GRFFile::param_end
uint param_end
one more than the highest set parameter
Definition: newgrf.h:123
TLR_MAX_VAR10
static const uint TLR_MAX_VAR10
Maximum value for var 10.
Definition: newgrf_commons.h:106
GetGRFStringID
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
Definition: newgrf_text.cpp:601
ttd_strnlen
static size_t ttd_strnlen(const char *str, size_t maxlen)
Get the length of a string, within a limited buffer.
Definition: string_func.h:79
GrfProcessingState
Temporary data during loading of GRFs.
Definition: newgrf.cpp:86
SPRITE_MODIFIER_CUSTOM_SPRITE
@ SPRITE_MODIFIER_CUSTOM_SPRITE
Set when a sprite originates from an Action 1.
Definition: sprites.h:1535
IndustryTileSpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:171
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:67
_tags_root
AllowedSubtags _tags_root[]
Action14 root tags.
Definition: newgrf.cpp:8258
CargoSpec::weight
uint8 weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
Definition: cargotype.h:62
FinaliseObjectsArray
static void FinaliseObjectsArray()
Add all new objects to the object array.
Definition: newgrf.cpp:9277
GRFTempEngineData::EMPTY
@ EMPTY
GRF defined vehicle as not-refittable. The vehicle shall only carry the default cargo.
Definition: newgrf.cpp:321
TranslateRefitMask
static CargoTypes TranslateRefitMask(uint32 refit_mask)
Translate the refit mask.
Definition: newgrf.cpp:954
ObjectSpec::height
uint8 height
The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
Definition: newgrf_object.h:75
WaterFeature::flags
uint8 flags
Flags controlling display.
Definition: newgrf_canal.h:26
NamePart::text
char * text
If probability bit 7 is clear.
Definition: newgrf_townname.h:22
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:58
HouseSpec::minimum_life
byte minimum_life
The minimum number of years this house will survive before the town rebuilds it.
Definition: house.h:122
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:58
ROADTYPE_ROAD
@ ROADTYPE_ROAD
Basic road type.
Definition: road_type.h:24
TTDPAirportType
TTDPAirportType
Allow incrementing of AirportClassID variables.
Definition: newgrf_airport.h:81
CanalChangeInfo
static ChangeInfoResult CanalChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for water features.
Definition: newgrf.cpp:2129
LoadTranslationTable
static ChangeInfoResult LoadTranslationTable(uint gvid, int numinfo, ByteReader *buf, T &translation_table, const char *name)
Load a cargo- or railtype-translation table.
Definition: newgrf.cpp:2613
GlobalVarChangeInfo
static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
Define properties for global variables.
Definition: newgrf.cpp:2653
newgrf_text.h
road.h
vseprintf
int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap)
Safer implementation of vsnprintf; same as vsnprintf except:
Definition: string.cpp:62
RoadTypeInfo::name
StringID name
Name of this rail type.
Definition: road.h:101
error.h
GrfProcessingState::GetSprite
SpriteID GetSprite(byte feature, uint set) const
Returns the first sprite of a spriteset.
Definition: newgrf.cpp:176
RailVehicleChangeInfo
static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for rail vehicles.
Definition: newgrf.cpp:1051
CargoSpec::is_freight
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
Definition: cargotype.h:67
HZ_ZON5
@ HZ_ZON5
center of town
Definition: house.h:77
GRFTempEngineData::ctt_exclude_mask
CargoTypes ctt_exclude_mask
Cargo types always excluded from the refit mask.
Definition: newgrf.cpp:333
GRFTempEngineData::defaultcargo_grf
const GRFFile * defaultcargo_grf
GRF defining the cargo translation table to use if the default cargo is the 'first refittable'.
Definition: newgrf.cpp:329
ResetCurrencies
void ResetCurrencies(bool preserve_custom)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
Definition: currency.cpp:157
EngineIDMapping
Definition: engine_base.h:179
AirportTileTable
Tile-offset / AirportTileID pair.
Definition: newgrf_airport.h:23
IndustrySpec::appear_creation
byte appear_creation[NUM_LANDSCAPE]
Probability of appearance during map creation.
Definition: industrytype.h:134
GRFP_GRF_MASK
@ GRFP_GRF_MASK
Bitmask to get only the NewGRF supplied information.
Definition: newgrf_config.h:74
_loaded_newgrf_features
GRFLoadedFeatures _loaded_newgrf_features
Indicates which are the newgrf features currently loaded ingame.
Definition: newgrf.cpp:81
language.h
IndustryTileSpec::anim_production
byte anim_production
Animation frame to start when goods are produced.
Definition: industrytype.h:160
RandomAccessFile::filename
std::string filename
Full name of the file; relative path to subdir plus the extension of the file.
Definition: random_access_file_type.h:27
EngineInfo::retire_early
int8 retire_early
Number of years early to retire vehicle.
Definition: engine_type.h:154
GetNewEngineID
EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
Return the ID of a new engine.
Definition: newgrf.cpp:701
RailVehicleInfo::tractive_effort
byte tractive_effort
Tractive effort coefficient.
Definition: engine_type.h:59
GRFFile::traininfo_vehicle_width
uint traininfo_vehicle_width
Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details.
Definition: newgrf.h:144
EngineIDMapping::substitute_id
uint8 substitute_id
The (original) entity ID to use if this GRF is not available (currently not used)
Definition: engine_base.h:183
CargoChangeInfo
static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, ByteReader *buf)
Define properties for cargoes.
Definition: newgrf.cpp:2949
date_func.h
SoundEntry
Definition: sound_type.h:13
StationSpec::disallowed_platforms
byte disallowed_platforms
Bitmask of number of platforms available for the station.
Definition: newgrf_station.h:133
stdafx.h
GrfProcessingState::grfconfig
GRFConfig * grfconfig
Config of the currently processed GRF file.
Definition: newgrf.cpp:105
TLF_NON_GROUND_FLAGS
@ TLF_NON_GROUND_FLAGS
Flags which do not work for the (first) ground sprite.
Definition: newgrf_commons.h:56
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
IsLeapYear
static bool IsLeapYear(Year yr)
Checks whether the given year is a leap year or not.
Definition: date_func.h:30
landscape.h
ObjectSpec::enabled
bool enabled
Is this spec enabled?
Definition: newgrf_object.h:78
RailVehicleInfo::pow_wag_power
uint16 pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition: engine_type.h:55
RailtypeInfo::toolbar_caption
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
Definition: rail.h:174
OTTDByteReaderSignal
Definition: newgrf.cpp:210
PROP_AIRCRAFT_COST_FACTOR
@ PROP_AIRCRAFT_COST_FACTOR
Purchase cost.
Definition: newgrf_properties.h:49
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:107
RailVehicleInfo::weight
uint16 weight
Weight of vehicle (tons); For multiheaded engines the weight of each single engine.
Definition: engine_type.h:49
PROP_TRAIN_CURVE_SPEED_MOD
@ PROP_TRAIN_CURVE_SPEED_MOD
Modifier to maximum speed in curves.
Definition: newgrf_properties.h:31
IndustryTileSpec::grf_prop
GRFFileProps grf_prop
properties related to the grf file
Definition: industrytype.h:172
BSWAP32
static uint32 BSWAP32(uint32 x)
Perform a 32 bits endianness bitswap on x.
Definition: bitmath_func.hpp:390
SPR_RAILTYPE_TUNNEL_BASE
static const SpriteID SPR_RAILTYPE_TUNNEL_BASE
Tunnel sprites with grass only for custom railtype tunnel.
Definition: sprites.h:299
EngineClass
EngineClass
Type of rail engine.
Definition: engine_type.h:33
PALETTE_MODIFIER_TRANSPARENT
@ PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1537
NEWGRF_DIR
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
Definition: fileio_type.h:117
IgnoreIndustryProperty
static ChangeInfoResult IgnoreIndustryProperty(int prop, ByteReader *buf)
Ignore an industry property.
Definition: newgrf.cpp:3321
GRFTempEngineData::refittability
Refittability refittability
Did the newgrf set any refittability property? If not, default refittability will be applied.
Definition: newgrf.cpp:330
EngineInfo::misc_flags
byte misc_flags
Miscellaneous flags.
Definition: engine_type.h:152
HouseSpec::mail_generation
byte mail_generation
mail generation multiplier (tile based, as the acceptances below)
Definition: house.h:106
A5BLOCK_FIXED
@ A5BLOCK_FIXED
Only allow replacing a whole block of sprites. (TTDP compatible)
Definition: newgrf.cpp:6161
GRFTownName
Definition: newgrf_townname.h:35
RandomAccessFile::ReadWord
uint16 ReadWord()
Read a word (16 bits) from the file (in low endian format).
Definition: random_access_file.cpp:117
A5BLOCK_ALLOW_OFFSET
@ A5BLOCK_ALLOW_OFFSET
Allow replacing any subset by specifiing an offset.
Definition: newgrf.cpp:6162
HouseSpec::population
byte population
population (Zero on other tiles in multi tile house.)
Definition: house.h:102
PROP_SHIP_RUNNING_COST_FACTOR
@ PROP_SHIP_RUNNING_COST_FACTOR
Yearly runningcost.
Definition: newgrf_properties.h:46
RailtypeInfo::powered_railtypes
RailTypes powered_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype generates power
Definition: rail.h:185
RAILVEH_WAGON
@ RAILVEH_WAGON
simple wagon, not motorized
Definition: engine_type.h:29
RealSpriteGroup::loaded
std::vector< const SpriteGroup * > loaded
List of loaded groups (can be SpriteIDs or Callback results)
Definition: newgrf_spritegroup.h:89
LanguageMap::Mapping
Mapping between NewGRF and OpenTTD IDs.
Definition: newgrf_text.h:60
RandomAccessFile::ReadDword
uint32 ReadDword()
Read a double word (32 bits) from the file (in low endian format).
Definition: random_access_file.cpp:127
BuildCargoTranslationMap
static void BuildCargoTranslationMap()
Construct the Cargo Mapping.
Definition: newgrf.cpp:8721
Utf8Decode
size_t Utf8Decode(WChar *c, const char *s)
Decode and consume the next UTF-8 encoded character.
Definition: string.cpp:593
HouseSpec::cargo_acceptance
byte cargo_acceptance[HOUSE_NUM_ACCEPTS]
acceptance level for the cargo slots
Definition: house.h:107
RailtypeInfo::map_colour
byte map_colour
Colour on mini-map.
Definition: rail.h:243
WaterFeature::grffile
const GRFFile * grffile
NewGRF where 'group' belongs to.
Definition: newgrf_canal.h:24
_engine_offsets
const uint8 _engine_offsets[4]
Offset of the first engine of each vehicle type in original engine data.
Definition: engine.cpp:59
ShipVehicleInfo::old_refittable
bool old_refittable
Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
Definition: engine_type.h:73
AllowedSubtags::type
byte type
The type of the node, must be one of 'C', 'B' or 'T'.
Definition: newgrf.cpp:8147
GRFParameterInfo::first_bit
byte first_bit
First bit to use in the GRF parameter.
Definition: newgrf_config.h:144
BuildIndustriesLegend
void BuildIndustriesLegend()
Fills an array for the industries legends.
Definition: smallmap_gui.cpp:169
SetSnowLine
void SetSnowLine(byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS])
Set a variable snow line, as loaded from a newgrf file.
Definition: landscape.cpp:637
newgrf_object.h
BridgeSpec::min_length
byte min_length
the minimum length (not counting start and end tile)
Definition: bridge.h:43
IndustryProductionSpriteGroup::add_output
uint16 add_output[INDUSTRY_NUM_OUTPUTS]
Add this much output cargo when successful (unsigned, is indirect in cb version 1+)
Definition: newgrf_spritegroup.h:276
ObjectSpec::name
StringID name
The name for this object.
Definition: newgrf_object.h:64
ChangeGRFBlitter
static bool ChangeGRFBlitter(size_t len, ByteReader *buf)
Callback function for 'INFO'->'BLTR' to set the blitter info.
Definition: newgrf.cpp:7935
RandomAccessFile::GetPos
size_t GetPos() const
Get position in the file.
Definition: random_access_file.cpp:73
AirportSpec::size_x
byte size_x
size of airport in x direction
Definition: newgrf_airport.h:105
FinaliseEngineArray
static void FinaliseEngineArray()
Check for invalid engines.
Definition: newgrf.cpp:8994
GRFParameterType
GRFParameterType
The possible types of a newgrf parameter.
Definition: newgrf_config.h:127
ChangeGRFNumUsedParams
static bool ChangeGRFNumUsedParams(size_t len, ByteReader *buf)
Callback function for 'INFO'->'NPAR' to set the number of valid parameters.
Definition: newgrf.cpp:7897
GRFTempEngineData::UNSET
@ UNSET
No properties assigned. Default refit masks shall be activated.
Definition: newgrf.cpp:320
ChangeGRFMinVersion
static bool ChangeGRFMinVersion(size_t len, ByteReader *buf)
Callback function for 'INFO'->'MINV' to the minimum compatible version of the NewGRF.
Definition: newgrf.cpp:7970
TileLayoutRegisters::sprite_var10
uint8 sprite_var10
Value for variable 10 when resolving the sprite.
Definition: newgrf_commons.h:102
RAILTYPE_RAIL
@ RAILTYPE_RAIL
Standard non-electric rails.
Definition: rail_type.h:29
_generating_world
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:61
GCS_UNKNOWN
@ GCS_UNKNOWN
The status of this grf file is unknown.
Definition: newgrf_config.h:35
ConstructionSettings::max_bridge_length
uint16 max_bridge_length
maximum length of bridges
Definition: settings_type.h:342
ObjectSpec::clear_cost_multiplier
uint8 clear_cost_multiplier
Clear cost multiplier per tile.
Definition: newgrf_object.h:69
SpriteFile
RandomAccessFile with some extra information specific for sprite files.
Definition: sprite_file_type.hpp:19
LanguagePackHeader::GetGenderIndex
uint8 GetGenderIndex(const char *gender_str) const
Get the index for the given gender.
Definition: language.h:68
DeterministicSpriteGroupAdjust
Definition: newgrf_spritegroup.h:147
PriceBaseSpec
Describes properties of price bases.
Definition: economy_type.h:190
IndustryTileSpec::accepts_cargo
CargoID accepts_cargo[INDUSTRY_NUM_INPUTS]
Cargo accepted by this tile.
Definition: industrytype.h:157
YearMonthDay::year
Year year
Year (0...)
Definition: date_type.h:105
string_func.h
IndustrySpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:140
ObjectSpec::generate_amount
uint8 generate_amount
Number of objects which are attempted to be generated per 256^2 map during world generation.
Definition: newgrf_object.h:77
GRFFile::canal_local_properties
CanalProperties canal_local_properties[CF_END]
Canal properties as set by this NewGRF.
Definition: newgrf.h:139
GRFError
Information about why GRF had problems during initialisation.
Definition: newgrf_config.h:112
RoadTypeInfo::grffile
const GRFFile * grffile[ROTSG_END]
NewGRF providing the Action3 for the roadtype.
Definition: road.h:185
RailtypeInfo::acceleration_type
uint8 acceleration_type
Acceleration type of this rail type.
Definition: rail.h:223
ChangeGRFDescription
static bool ChangeGRFDescription(byte langid, const char *str)
Callback function for 'INFO'->'DESC' to add a translation to the newgrf description.
Definition: newgrf.cpp:7883
GCS_DISABLED
@ GCS_DISABLED
GRF file is disabled.
Definition: newgrf_config.h:36
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SetUnicodeGlyph
static void SetUnicodeGlyph(FontSize size, WChar key, SpriteID sprite)
Map a SpriteID to the font size and key.
Definition: fontcache.h:163
CIR_DISABLED
@ CIR_DISABLED
GRF was disabled due to error.
Definition: newgrf.cpp:993
GRFParameterInfo::max_value
uint32 max_value
The maximal value of this parameter.
Definition: newgrf_config.h:141
AllocateRailType
RailType AllocateRailType(RailTypeLabel label)
Allocate a new rail type label.
Definition: rail_cmd.cpp:159
ORIGINAL_MAX_YEAR
static const Year ORIGINAL_MAX_YEAR
The maximum year of the original TTD.
Definition: date_type.h:54
vehicle_func.h
rev.h
CURRENCY_END
@ CURRENCY_END
always the last item
Definition: currency.h:68
LanguagePackHeader::GetCaseIndex
uint8 GetCaseIndex(const char *case_str) const
Get the index for the given case.
Definition: language.h:81
PROP_TRAIN_WEIGHT
@ PROP_TRAIN_WEIGHT
Weight in t (if dualheaded: for each single vehicle)
Definition: newgrf_properties.h:25
PROP_VEHICLE_LOAD_AMOUNT
@ PROP_VEHICLE_LOAD_AMOUNT
Loading speed.
Definition: newgrf_properties.h:19
GRFFile::GRFFile
GRFFile(const struct GRFConfig *config)
Constructor for GRFFile.
Definition: newgrf.cpp:8761
RailtypeInfo::flags
RailTypeFlags flags
Bit mask of rail type flags.
Definition: rail.h:208
VehicleSettings::dynamic_engines
bool dynamic_engines
enable dynamic allocation of engine data
Definition: settings_type.h:498
newgrf_sound.h
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
RoadVehicleInfo::shorten_factor
byte shorten_factor
length on main map for this type is 8 - shorten_factor
Definition: engine_type.h:125
Pool::PoolItem<&_engine_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
GRFFilePropsBase::spritegroup
const struct SpriteGroup * spritegroup[Tcnt]
pointer to the different sprites of the entity
Definition: newgrf_commons.h:321
GRFP_GRF_WINDOWS
@ GRFP_GRF_WINDOWS
The NewGRF says the Windows palette can be used.
Definition: newgrf_config.h:72
strings_func.h
TLF_VAR10_FLAGS
@ TLF_VAR10_FLAGS
Flags which refer to using multiple action-1-2-3 chains.
Definition: newgrf_commons.h:59
StationSpec
Station specification.
Definition: newgrf_station.h:113
CLEAN_RANDOMSOUNDS
@ CLEAN_RANDOMSOUNDS
Free the dynamically allocated sounds table.
Definition: industrytype.h:24
AirportSpec::enabled
bool enabled
Entity still available (by default true). Newgrf can disable it, though.
Definition: newgrf_airport.h:117
LanguageMap
Mapping of language data between a NewGRF and OpenTTD.
Definition: newgrf_text.h:58
PROP_TRAIN_SHORTEN_FACTOR
@ PROP_TRAIN_SHORTEN_FACTOR
Shorter vehicles.
Definition: newgrf_properties.h:28
IsHouseSpecValid
static bool IsHouseSpecValid(HouseSpec *hs, const HouseSpec *next1, const HouseSpec *next2, const HouseSpec *next3, const char *filename)
Check if a given housespec is valid and disable it if it's not.
Definition: newgrf.cpp:9064
IndustrytilesChangeInfo
static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, ByteReader *buf)
Define properties for industry tiles.
Definition: newgrf.cpp:3183
RailVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: engine_type.h:47
FioCheckFileExists
bool FioCheckFileExists(const std::string &filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:108
GRFParameterInfo::value_names
SmallMap< uint32, GRFTextList > value_names
Names for each value.
Definition: newgrf_config.h:146
bridge.h
NEW_AIRPORT_OFFSET
@ NEW_AIRPORT_OFFSET
Number of the first newgrf airport.
Definition: airport.h:39
TileLayoutRegisters::palette
uint8 palette
Register specifying a signed offset for the palette.
Definition: newgrf_commons.h:95
GRFTempEngineData
Temporary engine data used when loading only.
Definition: newgrf.cpp:317
CC_ARMOURED
@ CC_ARMOURED
Armoured cargo (Valuables, Gold, Diamonds)
Definition: cargotype.h:44
ResetNewGRFErrors
static void ResetNewGRFErrors()
Clear all NewGRF errors.
Definition: newgrf.cpp:8599
GRFConfig::name
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
Definition: newgrf_config.h:166
ResetNewGRF
static void ResetNewGRF()
Reset and clear all NewGRFs.
Definition: newgrf.cpp:8588
GRFLoadedFeatures::tram
TramReplacement tram
In which way tram depots were replaced.
Definition: newgrf.h:179
TileLayoutRegisters::max_palette_offset
uint16 max_palette_offset
Maximum offset to add to the palette. (limited by size of the spriteset)
Definition: newgrf_commons.h:97
BridgeSpec::max_length
uint16 max_length
the maximum length (not counting start and end tile)
Definition: bridge.h:44
GRFParameterInfo::desc
GRFTextList desc
The description of this parameter.
Definition: newgrf_config.h:138
AllowedSubtags
Data structure to store the allowed id/type combinations for action 14.
Definition: newgrf.cpp:8089
FinaliseAirportsArray
static void FinaliseAirportsArray()
Add all new airports to the airport array.
Definition: newgrf.cpp:9296
IndustrySpec::cost_multiplier
uint8 cost_multiplier
Base construction cost multiplier.
Definition: industrytype.h:109
SHORE_REPLACE_ACTION_A
@ SHORE_REPLACE_ACTION_A
Shore sprites were replaced by ActionA (using grass tiles for the corner-shores).
Definition: newgrf.h:165
GCF_RESERVED
@ GCF_RESERVED
GRF file passed GLS_RESERVE stage.
Definition: newgrf_config.h:29
BridgeSpec::price
uint16 price
the price multiplier
Definition: bridge.h:45
SanitizeSpriteOffset
static uint16 SanitizeSpriteOffset(uint16 &num, uint16 offset, int max_sprites, const char *name)
Sanitize incoming sprite offsets for Action 5 graphics replacements.
Definition: newgrf.cpp:6138
GRFConfig::min_loadable_version
uint32 min_loadable_version
NOSAVE: Minimum compatible version a NewGRF can define.
Definition: newgrf_config.h:172
ObjectSpec::views
uint8 views
The number of views.
Definition: newgrf_object.h:76
TRAMWAY_REPLACE_DEPOT_WITH_TRACK
@ TRAMWAY_REPLACE_DEPOT_WITH_TRACK
Electrified depot graphics with tram track were loaded.
Definition: newgrf.h:171
IndustryTileSpec::animation
AnimationInfo animation
Information about the animation (is it looping, how many loops etc)
Definition: industrytype.h:169
AirportTileSpec::callback_mask
uint8 callback_mask
Bitmask telling which grf callback is set.
Definition: newgrf_airporttiles.h:69
MapSpriteMappingRecolour
static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)
Map the colour modifiers of TTDPatch to those that Open is using.
Definition: newgrf.cpp:717
GetGlobalVariable
bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile)
Reads a variable common to VarAction2 and Action7/9/D.
Definition: newgrf.cpp:6316
RAILTYPE_END
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
CC_REFRIGERATED
@ CC_REFRIGERATED
Refrigerated cargo (Food, Fruit)
Definition: cargotype.h:48
CanalProperties::flags
uint8 flags
Flags controlling display.
Definition: newgrf.h:41
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
CommonVehicleChangeInfo
static ChangeInfoResult CommonVehicleChangeInfo(EngineInfo *ei, int prop, ByteReader *buf)
Define properties common to all vehicles.
Definition: newgrf.cpp:1008
ConstructionSettings::build_on_slopes
bool build_on_slopes
allow building on slopes
Definition: settings_type.h:340
RealSpriteGroup
Definition: newgrf_spritegroup.h:79
AllowedSubtags::subtags
AllowedSubtags * subtags
Pointer to a list of subtags, only valid if type == 'C' && !call_handler.
Definition: newgrf.cpp:8154
HZ_SUBARTC_ABOVE
@ HZ_SUBARTC_ABOVE
11 800 can appear in sub-arctic climate above the snow line
Definition: house.h:79
TextHandler
bool(* TextHandler)(byte, const char *str)
Type of callback function for text nodes.
Definition: newgrf.cpp:8079
Action5Type::block_type
Action5BlockType block_type
How is this Action5 type processed?
Definition: newgrf.cpp:6167
AirportSpec::grf_prop
struct GRFFileProps grf_prop
Properties related to the grf file.
Definition: newgrf_airport.h:118
CargoSpec::quantifier
StringID quantifier
Text for multiple units of cargo of this type.
Definition: cargotype.h:74
SPR_AIRPORT_PREVIEW_BASE
static const SpriteID SPR_AIRPORT_PREVIEW_BASE
Airport preview sprites.
Definition: sprites.h:248
Action5Type::min_sprites
uint16 min_sprites
If the Action5 contains less sprites, the whole block will be ignored.
Definition: newgrf.cpp:6169
GRFConfig::next
struct GRFConfig * next
NOSAVE: Next item in the linked list.
Definition: newgrf_config.h:183
industrytype.h
RAILVEH_MULTIHEAD
@ RAILVEH_MULTIHEAD
indicates a combination of two locomotives
Definition: engine_type.h:28
GetEngineLiveryScheme
LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
Determines the LiveryScheme for a vehicle.
Definition: vehicle.cpp:1883
GetDefaultCargoID
CargoID GetDefaultCargoID(LandscapeID l, CargoType ct)
Get the cargo ID of a default cargo, if present.
Definition: cargotype.cpp:87
InitializeSortedCargoSpecs
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
Definition: cargotype.cpp:189
EngineInfo::variant_id
EngineID variant_id
Engine variant ID. If set, will be treated specially in purchase lists.
Definition: engine_type.h:157
GrfProcessingState::AddSpriteSets
void AddSpriteSets(byte feature, SpriteID first_sprite, uint first_set, uint numsets, uint numents)
Records new spritesets.
Definition: newgrf.cpp:135
CurrencySpec::rate
uint16 rate
The conversion rate compared to the base currency.
Definition: currency.h:73
SPR_OPENTTD_BASE
static const SpriteID SPR_OPENTTD_BASE
Extra graphic spritenumbers.
Definition: sprites.h:56
IndustrySpec::production_down_text
StringID production_down_text
Message appearing when the industry's production is decreasing.
Definition: industrytype.h:131
TRAMWAY_REPLACE_DEPOT_NONE
@ TRAMWAY_REPLACE_DEPOT_NONE
No tram depot graphics were loaded.
Definition: newgrf.h:170
RailVehicleInfo::user_def_data
byte user_def_data
Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles.
Definition: engine_type.h:61
AlterVehicleListOrder
void AlterVehicleListOrder(EngineID engine, uint target)
Record a vehicle ListOrderChange.
Definition: newgrf_engine.cpp:1298
CargoSpec::classes
uint16 classes
Classes of this cargo type.
Definition: cargotype.h:79
RoadVehicleChangeInfo
static ChangeInfoResult RoadVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for road vehicles.
Definition: newgrf.cpp:1356
AirportTileSpec::enabled
bool enabled
entity still available (by default true). newgrf can disable it, though
Definition: newgrf_airporttiles.h:71
IndustrySpec::cleanup_flag
uint8 cleanup_flag
flags indicating which data should be freed upon cleaning up
Definition: industrytype.h:139
IndustrySpec::appear_ingame
byte appear_ingame[NUM_LANDSCAPE]
Probability of appearance in game.
Definition: industrytype.h:133
IndustrySpec::grf_prop
GRFFileProps grf_prop
properties related to the grf file
Definition: industrytype.h:141
TRAMWAY_REPLACE_DEPOT_NO_TRACK
@ TRAMWAY_REPLACE_DEPOT_NO_TRACK
Electrified depot graphics without tram track were loaded.
Definition: newgrf.h:172
RoadTypeInfo::map_colour
byte map_colour
Colour on mini-map.
Definition: road.h:155
NewGRFSpriteLayout::consistent_max_offset
uint consistent_max_offset
Number of sprites in all referenced spritesets.
Definition: newgrf_commons.h:120
HouseSpec::watched_cargoes
CargoTypes watched_cargoes
Cargo types watched for acceptance.
Definition: house.h:123
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
IsSnowLineSet
bool IsSnowLineSet()
Has a snow line table already been loaded.
Definition: landscape.cpp:627
RailTypeFlags
RailTypeFlags
Railtype flags.
Definition: rail.h:25
RailtypeInfo::label
RailTypeLabel label
Unique 32 bit rail type identifier.
Definition: rail.h:233
StationClassID
StationClassID
Definition: newgrf_station.h:83
GetCargoTranslation
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
Translate a GRF-local cargo slot/bitnum into a CargoID.
Definition: newgrf_cargo.cpp:79
IndustrySpec::prospecting_chance
uint32 prospecting_chance
Chance prospecting succeeds.
Definition: industrytype.h:111
ConstructionSettings::train_signal_side
byte train_signal_side
show signals on left / driving / right side
Definition: settings_type.h:345
HouseSpec::class_id
HouseClassID class_id
defines the class this house has (not grf file based)
Definition: house.h:119
GRFParameterInfo::name
GRFTextList name
The name of this parameter.
Definition: newgrf_config.h:137
GRFFile::cargo_map
uint8 cargo_map[NUM_CARGO]
Inverse cargo translation table (CargoID -> local ID)
Definition: newgrf.h:128
Pool::PoolItem<&_engine_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
IndustryTileLayoutTile
Definition of one tile in an industry tile layout.
Definition: industrytype.h:96
RailtypeInfo::build_caption
StringID build_caption
Caption of the build vehicle GUI for this rail type.
Definition: rail.h:176
VehicleSettings::disable_elrails
bool disable_elrails
when true, the elrails are disabled
Definition: settings_type.h:491
InitNewGRFFile
static void InitNewGRFFile(const GRFConfig *config)
Prepare loading a NewGRF file with its config.
Definition: newgrf.cpp:8744
CommitVehicleListOrderChanges
void CommitVehicleListOrderChanges()
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder.
Definition: newgrf_engine.cpp:1328
ShipVehicleInfo
Information about a ship vehicle.
Definition: engine_type.h:66
HouseSpec::building_availability
HouseZones building_availability
where can it be built (climates, zones)
Definition: house.h:110
NewGRFClass::name
StringID name
Name of this class.
Definition: newgrf_class.h:39
RoadType
RoadType
The different roadtypes we support.
Definition: road_type.h:22
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
IndustryProductionSpriteGroup::version
uint8 version
Production callback version used, or 0xFF if marked invalid.
Definition: newgrf_spritegroup.h:271
AirportSpec::GetWithoutOverride
static AirportSpec * GetWithoutOverride(byte type)
Retrieve airport spec for the given airport.
Definition: newgrf_airport.cpp:117
TileLayoutFlags
TileLayoutFlags
Flags to enable register usage in sprite layouts.
Definition: newgrf_commons.h:33
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:71
PROP_ROADVEH_CARGO_CAPACITY
@ PROP_ROADVEH_CARGO_CAPACITY
Capacity.
Definition: newgrf_properties.h:34
ResetNewGRFData
void ResetNewGRFData()
Reset all NewGRF loaded data.
Definition: newgrf.cpp:8612
AircraftVehicleChangeInfo
static ChangeInfoResult AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for aircraft.
Definition: newgrf.cpp:1738
GRFFile::cargo_list
std::vector< CargoLabel > cargo_list
Cargo translation table (local ID -> label)
Definition: newgrf.h:127
GameCreationSettings::starting_year
Year starting_year
starting date
Definition: settings_type.h:311
TE_MAIL
@ TE_MAIL
Cargo behaves mail-like.
Definition: cargotype.h:30
PalSpriteID
Combination of a palette sprite and a 'real' sprite.
Definition: gfx_type.h:22
GRFConfig::url
GRFTextWrapper url
NOSAVE: URL belonging to this GRF.
Definition: newgrf_config.h:168
GRFFile::labels
std::vector< GRFLabel > labels
List of labels.
Definition: newgrf.h:125
VSG_SCOPE_RELATIVE
@ VSG_SCOPE_RELATIVE
Relative position (vehicles only)
Definition: newgrf_spritegroup.h:102
ActivateOldTramDepot
static void ActivateOldTramDepot()
Replocate the old tram depot sprites to the new position, if no new ones were loaded.
Definition: newgrf.cpp:9571
HZ_CLIMALL
@ HZ_CLIMALL
Bitmask of all climate bits.
Definition: house.h:84
RoadVehicleInfo::tractive_effort
uint8 tractive_effort
Coefficient of tractive effort.
Definition: engine_type.h:122
GrfProcessingState::stage
GrfLoadingStage stage
Current loading stage.
Definition: newgrf.cpp:99
ExtraEngineFlags
ExtraEngineFlags
Definition: engine_type.h:129
ORIGINAL_SAMPLE_COUNT
static const uint ORIGINAL_SAMPLE_COUNT
The number of sounds in the original sample.cat.
Definition: sound_type.h:116
IndustrySpec::callback_mask
uint16 callback_mask
Bitmask of industry callbacks that have to be called.
Definition: industrytype.h:138
AnimationInfo::triggers
uint16 triggers
The triggers that trigger animation.
Definition: newgrf_animation_type.h:22
IgnoreObjectProperty
static ChangeInfoResult IgnoreObjectProperty(uint prop, ByteReader *buf)
Ignore properties for objects.
Definition: newgrf.cpp:4032
CHECK_NOTHING
@ CHECK_NOTHING
Always succeeds.
Definition: industrytype.h:40
AircraftVehicleInfo::mail_capacity
byte mail_capacity
Mail capacity (bags).
Definition: engine_type.h:106
CargoSpec::name_single
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:72
PTYPE_END
@ PTYPE_END
Invalid parameter type.
Definition: newgrf_config.h:130
IndustrySpec::random_sounds
const uint8 * random_sounds
array of random sounds.
Definition: industrytype.h:136
GrfProcessingState::GetNumEnts
uint GetNumEnts(byte feature, uint set) const
Returns the number of sprites in a spriteset.
Definition: newgrf.cpp:188
CargoSpec::abbrev
StringID abbrev
Two letter abbreviation for this cargo type.
Definition: cargotype.h:75
ReallocT
static T * ReallocT(T *t_ptr, size_t num_elements)
Simplified reallocation function that allocates the specified number of elements of the given type.
Definition: alloc_func.hpp:111
HouseSpec::processing_time
byte processing_time
Periodic refresh multiplier.
Definition: house.h:121
IndustrySpec::life_type
IndustryLifeType life_type
This is also known as Industry production flag, in newgrf specs.
Definition: industrytype.h:123
RoadVehicleInfo::weight
uint8 weight
Weight in 1/4t units.
Definition: engine_type.h:120
Action5Type::name
const char * name
Name for error messages.
Definition: newgrf.cpp:6171
SkipSpriteData
bool SkipSpriteData(SpriteFile &file, byte type, uint16 num)
Skip the given amount of sprite graphics data.
Definition: spritecache.cpp:126
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:138
FinaliseHouseArray
static void FinaliseHouseArray()
Add all new houses to the house array.
Definition: newgrf.cpp:9137
GRFConfig::palette
uint8 palette
GRFPalette, bitset.
Definition: newgrf_config.h:179
CargoSpec::multiplier
uint16 multiplier
Capacity multiplier for vehicles. (8 fractional bits)
Definition: cargotype.h:63
IndustryTileSpec::callback_mask
uint8 callback_mask
Bitmask of industry tile callbacks that have to be called.
Definition: industrytype.h:168
_grm_cargoes
static uint32 _grm_cargoes[NUM_CARGO *2]
Contains the GRF ID of the owner of a cargo if it has been reserved.
Definition: newgrf.cpp:358
NewGRFSpriteLayout::Clone
void Clone(const DrawTileSeqStruct *source)
Clone the building sprites of a spritelayout.
Definition: newgrf_commons.cpp:586
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:134
StationSpec::cargo_threshold
uint16 cargo_threshold
Cargo threshold for choosing between little and lots of cargo.
Definition: newgrf_station.h:154
RandomAccessFile::SeekTo
void SeekTo(size_t pos, int mode)
Seek in the current file.
Definition: random_access_file.cpp:83
RailVehicleInfo::shorten_factor
byte shorten_factor
length on main map for this type is 8 - shorten_factor
Definition: engine_type.h:58
_grfconfig
GRFConfig * _grfconfig
First item in list of current GRF set up.
Definition: newgrf_config.cpp:171
RoadTypeInfo::cost_multiplier
uint16 cost_multiplier
Cost multiplier for building this road type.
Definition: road.h:130
SmallMap::Find
std::vector< Pair >::const_iterator Find(const T &key) const
Finds given key in this map.
Definition: smallmap_type.hpp:41
CurrencySpec::to_euro
Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
Definition: currency.h:75
DrawTileSprites::seq
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
Definition: sprite.h:60
CIR_UNKNOWN
@ CIR_UNKNOWN
Variable is unknown.
Definition: newgrf.cpp:995
GRFTempEngineData::NONEMPTY
@ NONEMPTY
GRF defined the vehicle as refittable. If the refitmask is empty after translation (cargotypes not av...
Definition: newgrf.cpp:322
AllowedSubtags::id
uint32 id
The identifier for this node.
Definition: newgrf.cpp:8146
IndustrySpec::behaviour
IndustryBehaviour behaviour
How this industry will behave, and how others entities can use it.
Definition: industrytype.h:125
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
AnimationInfo::status
uint8 status
Status; 0: no looping, 1: looping, 0xFF: no animation.
Definition: newgrf_animation_type.h:20
ResetObjects
void ResetObjects()
This function initialize the spec arrays of objects.
Definition: newgrf_object.cpp:94
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
TE_WATER
@ TE_WATER
Cargo behaves water-like.
Definition: cargotype.h:32
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
HouseSpec::min_year
Year min_year
introduction year of the house
Definition: house.h:100
CurrencySpec::separator
std::string separator
The thousands separator for this currency.
Definition: currency.h:74
YearMonthDay
Data structure to convert between Date and triplet (year, month, and day).
Definition: date_type.h:104
StationSpec::grf_prop
GRFFilePropsBase< NUM_CARGO+3 > grf_prop
Properties related the the grf file.
Definition: newgrf_station.h:125
NewGRFClass::Get
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
Definition: newgrf_class_func.h:103
RoadTypeInfo::max_speed
uint16 max_speed
Maximum speed for vehicles travelling on this road type.
Definition: road.h:140
InitializeGRFSpecial
static void InitializeGRFSpecial()
Initialize the TTDPatch flags.
Definition: newgrf.cpp:8384
DataHandler
bool(* DataHandler)(size_t, ByteReader *)
Type of callback function for binary nodes.
Definition: newgrf.cpp:8078
RandomizedSpriteGroup::lowest_randbit
byte lowest_randbit
Look for this in the per-object randomized bitmask:
Definition: newgrf_spritegroup.h:199
RailtypeInfo::new_loco
StringID new_loco
Name of an engine for this type of rail in the engine preview GUI.
Definition: rail.h:178
ActivateOldShore
static void ActivateOldShore()
Relocates the old shore sprites at new positions.
Definition: newgrf.cpp:9534
BridgeSpec::material
StringID material
the string that contains the bridge description
Definition: bridge.h:49
RoadVehicleInfo::power
uint8 power
Power in 10hp units.
Definition: engine_type.h:121
TileLayoutRegisters::flags
TileLayoutFlags flags
Flags defining which members are valid and to be used.
Definition: newgrf_commons.h:92
AirportSpec::depot_table
const HangarTileTable * depot_table
gives the position of the depots on the airports
Definition: newgrf_airport.h:103
SkipUnknownInfo
static bool SkipUnknownInfo(ByteReader *buf, byte type)
Try to skip the current node and all subnodes (if it's a branch node).
Definition: newgrf.cpp:8270
RailtypeInfo::compatible_railtypes
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel
Definition: rail.h:188
CT_PURCHASE_OBJECT
static const CargoID CT_PURCHASE_OBJECT
Mapping of purchase for objects.
Definition: newgrf_object.h:161
newgrf_canal.h
TILE_HEIGHT
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:18
IgnoreTownHouseProperty
static ChangeInfoResult IgnoreTownHouseProperty(int prop, ByteReader *buf)
Ignore a house property.
Definition: newgrf.cpp:2277
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
ROADTYPE_TRAM
@ ROADTYPE_TRAM
Trams.
Definition: road_type.h:25
MemSetT
static void MemSetT(T *ptr, byte value, size_t num=1)
Type-safe version of memset().
Definition: mem_func.hpp:49
VehicleSettings::never_expire_vehicles
bool never_expire_vehicles
never expire vehicles
Definition: settings_type.h:499
HouseSpec
Definition: house.h:98
config.h
GetNewgrfCurrencyIdConverted
byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
Will return the ottd's index correspondence to the ttdpatch's id.
Definition: currency.cpp:113
GrfProcessingState::SpriteSet::num_sprites
uint num_sprites
Number of sprites in the set.
Definition: newgrf.cpp:91
NEW_AIRPORTTILE_OFFSET
static const uint NEW_AIRPORTTILE_OFFSET
offset of first newgrf airport tile
Definition: airport.h:24
RoadTypeFlags
RoadTypeFlags
Roadtype flags.
Definition: road.h:38
OverrideManagerBase::AddEntityID
virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id)
Reserves a place in the mapping array for an entity to be installed.
Definition: newgrf_commons.cpp:123
PROP_SHIP_COST_FACTOR
@ PROP_SHIP_COST_FACTOR
Purchase cost.
Definition: newgrf_properties.h:43
ChangeInfoResult
ChangeInfoResult
Possible return values for the FeatureChangeInfo functions.
Definition: newgrf.cpp:991
engine_base.h
IndustryProductionSpriteGroup::cargo_output
CargoID cargo_output[INDUSTRY_NUM_OUTPUTS]
Which output cargoes to add to (only cb version 2)
Definition: newgrf_spritegroup.h:277
BridgeChangeInfo
static ChangeInfoResult BridgeChangeInfo(uint brid, int numinfo, int prop, ByteReader *buf)
Define properties for bridges.
Definition: newgrf.cpp:2167
fontcache.h
_object_mngr
ObjectOverrideManager _object_mngr
The override manager for our objects.
HouseZones
HouseZones
Definition: house.h:71
ReadDWordAsString
static std::string ReadDWordAsString(ByteReader *reader)
Helper to read a DWord worth of bytes from the reader and to return it as a valid string.
Definition: newgrf.cpp:2635
VehicleSettings::plane_speed
uint8 plane_speed
divisor for speed of aircraft
Definition: settings_type.h:496
RailtypeInfo::maintenance_multiplier
uint16 maintenance_multiplier
Cost multiplier for maintenance of this rail type.
Definition: rail.h:218
RailTypeChangeInfo
static ChangeInfoResult RailTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for railtypes.
Definition: newgrf.cpp:4214
Engine::grf_prop
GRFFilePropsBase< NUM_CARGO+2 > grf_prop
Properties related the the grf file.
Definition: engine_base.h:76
RAILVEH_SINGLEHEAD
@ RAILVEH_SINGLEHEAD
indicates a "standalone" locomotive
Definition: engine_type.h:27
IndustryTileSpecialFlags
IndustryTileSpecialFlags
Flags for miscellaneous industry tile specialities.
Definition: industrytype.h:88
IndustrySpec::check_proc
byte check_proc
Index to a procedure to check for conflicting circumstances.
Definition: industrytype.h:113
ReadGRFSpriteOffsets
void ReadGRFSpriteOffsets(SpriteFile &file)
Parse the sprite section of GRFs.
Definition: spritecache.cpp:555
ShipVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:69
RailVehicleInfo::running_cost
byte running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
Definition: engine_type.h:50
EF_ROAD_TRAM
@ EF_ROAD_TRAM
Road vehicle is a tram/light rail vehicle.
Definition: engine_type.h:166
GetRailTypeByLabel
RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels)
Get the rail type for a given label.
Definition: rail.cpp:311
NEW_INDUSTRYTILEOFFSET
static const IndustryGfx NEW_INDUSTRYTILEOFFSET
original number of tiles
Definition: industry_type.h:32
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
newgrf_industries.h
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24
EconomySettings::inflation
bool inflation
disable inflation
Definition: settings_type.h:507
FinaliseCargoArray
static void FinaliseCargoArray()
Check for invalid cargoes.
Definition: newgrf.cpp:9041
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:585
GrfProcessingState::IsValidSpriteSet
bool IsValidSpriteSet(byte feature, uint set) const
Check whether a specific set is defined.
Definition: newgrf.cpp:164
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:592
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:206
TLF_PALETTE_REG_FLAGS
@ TLF_PALETTE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palet...
Definition: newgrf_commons.h:65
TLF_SPRITE
@ TLF_SPRITE
Add signed offset to sprite from register TileLayoutRegisters::sprite.
Definition: newgrf_commons.h:37
ClearTemporaryNewGRFData
static void ClearTemporaryNewGRFData(GRFFile *gf)
Reset all NewGRFData that was used only while processing data.
Definition: newgrf.cpp:430
EngineInfo::climates
byte climates
Climates supported by the engine.
Definition: engine_type.h:148
TLF_PALETTE
@ TLF_PALETTE
Add signed offset to palette from register TileLayoutRegisters::palette.
Definition: newgrf_commons.h:38
PTYPE_UINT_ENUM
@ PTYPE_UINT_ENUM
The parameter allows a range of numbers, each of which can have a special name.
Definition: newgrf_config.h:128
AirportSpec::nof_depots
byte nof_depots
the number of hangar tiles in this airport
Definition: newgrf_airport.h:104
PROP_AIRCRAFT_PASSENGER_CAPACITY
@ PROP_AIRCRAFT_PASSENGER_CAPACITY
Passenger Capacity.
Definition: newgrf_properties.h:52
PROP_SHIP_SPEED
@ PROP_SHIP_SPEED
Max. speed: 1 unit = 1/3.2 mph = 0.5 km-ish/h.
Definition: newgrf_properties.h:44
ClearSnowLine
void ClearSnowLine()
Clear the variable snow line table and free the memory.
Definition: landscape.cpp:689
ResetRoadTypes
void ResetRoadTypes()
Reset all road type information to its default values.
Definition: road_cmd.cpp:64
GRFPalette
GRFPalette
Information that can/has to be stored about a GRF's palette.
Definition: newgrf_config.h:59
StationSpec::callback_mask
byte callback_mask
Bitmask of station callbacks that have to be called.
Definition: newgrf_station.h:158
PROP_ROADVEH_POWER
@ PROP_ROADVEH_POWER
Power in 10 HP.
Definition: newgrf_properties.h:36
TE_FOOD
@ TE_FOOD
Cargo behaves food/fizzy-drinks-like.
Definition: cargotype.h:33
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
RandomizedSpriteGroup
Definition: newgrf_spritegroup.h:190
RailtypeInfo::group
const SpriteGroup * group[RTSG_END]
Sprite groups for resolving sprites.
Definition: rail.h:278
IndustrySpec::name
StringID name
Displayed name of the industry.
Definition: industrytype.h:127
ChangeGRFParamDefault
static bool ChangeGRFParamDefault(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'DFLT' to set the default value.
Definition: newgrf.cpp:8066
IndustryBehaviour
IndustryBehaviour
Various industry behaviours mostly to represent original TTD specialities.
Definition: industrytype.h:61
PROP_TRAIN_COST_FACTOR
@ PROP_TRAIN_COST_FACTOR
Purchase cost (if dualheaded: sum of both vehicles)
Definition: newgrf_properties.h:26
IndustrySpec::new_industry_text
StringID new_industry_text
Message appearing when the industry is built.
Definition: industrytype.h:128
StationSpec::disallowed_lengths
byte disallowed_lengths
Bitmask of platform lengths available for the station.
Definition: newgrf_station.h:138
_misc_grf_features
byte _misc_grf_features
Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E.
Definition: newgrf.cpp:75
RailtypeInfo::strings
struct RailtypeInfo::@39 strings
Strings associated with the rail type.
RailVehicleInfo::capacity
byte capacity
Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
Definition: engine_type.h:53
IndustryProductionSpriteGroup::cargo_input
CargoID cargo_input[INDUSTRY_NUM_INPUTS]
Which input cargoes to take from (only cb version 2)
Definition: newgrf_spritegroup.h:274
DefineGotoLabel
static void DefineGotoLabel(ByteReader *buf)
Action 0x10 - Define goto label.
Definition: newgrf.cpp:7597
ByteReader
Class to read from a NewGRF file.
Definition: newgrf.cpp:213
LoadGRFSound
static void LoadGRFSound(size_t offs, SoundEntry *sound)
Load a sound from a file.
Definition: newgrf.cpp:7646
AllowedSubtags::AllowedSubtags
AllowedSubtags(uint32 id, BranchHandler handler)
Create a branch node with a callback handler.
Definition: newgrf.cpp:8125
TTDPStringIDToOTTDStringIDMapping
static StringID TTDPStringIDToOTTDStringIDMapping(StringID str)
Perform a mapping from TTDPatch's string IDs to OpenTTD's string IDs, but only for the ones we are aw...
Definition: newgrf.cpp:493
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
PROP_AIRCRAFT_SPEED
@ PROP_AIRCRAFT_SPEED
Max. speed: 1 unit = 8 mph = 12.8 km-ish/h.
Definition: newgrf_properties.h:50
AirportTileSpec::name
StringID name
Tile Subname string, land information on this tile will give you "AirportName (TileSubname)".
Definition: newgrf_airporttiles.h:68
CanalProperties
Canal properties local to the NewGRF.
Definition: newgrf.h:39
ResetBridges
void ResetBridges()
Reset the data been eventually changed by the grf loaded.
Definition: tunnelbridge_cmd.cpp:85
RailtypeInfo::cost_multiplier
uint16 cost_multiplier
Cost multiplier for building this rail type.
Definition: rail.h:213
DateFract
uint16 DateFract
The fraction of a date we're in, i.e. the number of ticks since the last date changeover.
Definition: date_type.h:15
AllowedSubtags::data
DataHandler data
Callback function for a binary node, only valid if type == 'B'.
Definition: newgrf.cpp:8149
OBJECT_SIZE_1X1
static const uint8 OBJECT_SIZE_1X1
The value of a NewGRF's size property when the object is 1x1 tiles: low nibble for X,...
Definition: newgrf_object.h:43
AirportTileTable::ti
TileIndexDiffC ti
Tile offset from the top-most airport tile.
Definition: newgrf_airport.h:24
GRFConfig::filename
char * filename
Filename - either with or without full path.
Definition: newgrf_config.h:165
EngineInfo::string_id
StringID string_id
Default name of engine.
Definition: engine_type.h:155
AircraftVehicleInfo
Information about a aircraft vehicle.
Definition: engine_type.h:98
GetLanguage
const LanguageMetadata * GetLanguage(byte newgrflangid)
Get the language with the given NewGRF language ID.
Definition: strings.cpp:1911
ObjectSpec::climate
uint8 climate
In which climates is this object available?
Definition: newgrf_object.h:66
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:470
AirportSpec::table
const AirportTileTable *const * table
list of the tiles composing the airport
Definition: newgrf_airport.h:100
HangarTileTable
A list of all hangar tiles in an airport.
Definition: newgrf_airport.h:89
CT_INVALID
@ CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:69
_tick_counter
uint64 _tick_counter
Ever incrementing tick counter for setting off various events.
Definition: date.cpp:30
MapGRFStringID
StringID MapGRFStringID(uint32 grfid, StringID str)
Used when setting an object's property to map to the GRF's strings while taking in consideration the ...
Definition: newgrf.cpp:557
PROP_TRAIN_POWER
@ PROP_TRAIN_POWER
Power in hp (if dualheaded: sum of both vehicles)
Definition: newgrf_properties.h:22
AirportTileSpec::Get
static const AirportTileSpec * Get(StationGfx gfx)
Retrieve airport tile spec for the given airport tile.
Definition: newgrf_airporttiles.cpp:36
TownHouseChangeInfo
static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, ByteReader *buf)
Define properties for houses.
Definition: newgrf.cpp:2344
IndustryOverrideManager::SetEntitySpec
void SetEntitySpec(IndustrySpec *inds)
Method to install the new industry data in its proper slot The slot assignment is internal of this me...
Definition: newgrf_commons.cpp:260
PROP_TRAIN_CARGO_AGE_PERIOD
@ PROP_TRAIN_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:30
ResetIndustries
void ResetIndustries()
This function initialize the spec arrays of both industry and industry tiles.
Definition: industry_cmd.cpp:75
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
VehicleSettings::freight_trains
uint8 freight_trains
value to multiply the weight of cargo by
Definition: settings_type.h:497
ChangeGRFPalette
static bool ChangeGRFPalette(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PALS' to set the number of valid parameters.
Definition: newgrf.cpp:7909
LoadFontGlyph
static void LoadFontGlyph(ByteReader *buf)
Action 0x12.
Definition: newgrf.cpp:7766
PROP_ROADVEH_RUNNING_COST_FACTOR
@ PROP_ROADVEH_RUNNING_COST_FACTOR
Yearly runningcost.
Definition: newgrf_properties.h:33
SPR_TRACKS_FOR_SLOPES_BASE
static const SpriteID SPR_TRACKS_FOR_SLOPES_BASE
Sprites for 'highlighting' tracks on sloped land.
Definition: sprites.h:198
ResultSpriteGroup
Definition: newgrf_spritegroup.h:236
IndustryTileSpec::anim_next
byte anim_next
Next frame in an animation.
Definition: industrytype.h:161
IndustryTileSpec
Defines the data structure of each individual tile of an industry.
Definition: industrytype.h:156
GRFLoadedFeatures
Definition: newgrf.h:175
TLF_DRAWING_FLAGS
@ TLF_DRAWING_FLAGS
Flags which are still required after loading the GRF.
Definition: newgrf_commons.h:53
TLF_PALETTE_VAR10
@ TLF_PALETTE_VAR10
Resolve palette with a specific value in variable 10.
Definition: newgrf_commons.h:48
InitRailTypes
void InitRailTypes()
Resolve sprites of custom rail types.
Definition: rail_cmd.cpp:139
CurrencySpec::prefix
std::string prefix
Prefix to apply when formatting money in this currency.
Definition: currency.h:76
CC_MAIL
@ CC_MAIL
Mail.
Definition: cargotype.h:42
HouseSpec::remove_rating_decrease
uint16 remove_rating_decrease
rating decrease if removed
Definition: house.h:105
DisableGrf
static GRFError * DisableGrf(StringID message=STR_NULL, GRFConfig *config=nullptr)
Disable a GRF.
Definition: newgrf.cpp:441
AirportTileSpec::grf_prop
GRFFileProps grf_prop
properties related the the grf file
Definition: newgrf_airporttiles.h:72
TLF_SPRITE_REG_FLAGS
@ TLF_SPRITE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite...
Definition: newgrf_commons.h:62
InitRoadTypes
void InitRoadTypes()
Resolve sprites of custom road types.
Definition: road_cmd.cpp:120
RoadTypeInfo::build_caption
StringID build_caption
Caption of the build vehicle GUI for this rail type.
Definition: road.h:104
GetFileByFilename
static GRFFile * GetFileByFilename(const char *filename)
Obtain a NewGRF file by its filename.
Definition: newgrf.cpp:421
GrfProcessingState::skip_sprites
int skip_sprites
Number of pseudo sprites to skip before processing the next one. (-1 to skip to end of file)
Definition: newgrf.cpp:109
OpenCachedSpriteFile
SpriteFile & OpenCachedSpriteFile(const std::string &filename, Subdirectory subdir, bool palette_remap)
Open/get the SpriteFile that is cached for use in the sprite cache.
Definition: spritecache.cpp:96
ResetCustomStations
static void ResetCustomStations()
Reset and clear all NewGRF stations.
Definition: newgrf.cpp:8472
HZ_ZON1
@ HZ_ZON1
0..4 1,2,4,8,10 which town zones the building can be built in, Zone1 been the further suburb
Definition: house.h:73
TLF_SPRITE_VAR10
@ TLF_SPRITE_VAR10
Resolve sprite with a specific value in variable 10.
Definition: newgrf_commons.h:47
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:402
PROP_AIRCRAFT_RANGE
@ PROP_AIRCRAFT_RANGE
Aircraft range.
Definition: newgrf_properties.h:55
EconomySettings::allow_town_roads
bool allow_town_roads
towns are allowed to build roads (always allowed when generating world / in SE)
Definition: settings_type.h:525
MAX_NUM_CASES
static const uint8 MAX_NUM_CASES
Maximum number of supported cases.
Definition: language.h:21
_ttdpatch_flags
static uint32 _ttdpatch_flags[8]
32 * 8 = 256 flags.
Definition: newgrf.cpp:78
BuildLinkStatsLegend
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
Definition: smallmap_gui.cpp:199
ChangeGRFParamDescription
static bool ChangeGRFParamDescription(byte langid, const char *str)
Callback function for 'INFO'->'PARAM'->param_num->'DESC' to set the description of a parameter.
Definition: newgrf.cpp:7999
EngineInfo::cargo_age_period
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:156
GrfProcessingState::nfo_line
uint32 nfo_line
Currently processed pseudo sprite number in the GRF.
Definition: newgrf.cpp:106
RoadTypeInfo::introduction_required_roadtypes
RoadTypes introduction_required_roadtypes
Bitmask of roadtypes that are required for this roadtype to be introduced at a given introduction_dat...
Definition: road.h:170
ReadSpriteLayout
static bool ReadSpriteLayout(ByteReader *buf, uint num_building_sprites, bool use_cur_spritesets, byte feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts)
Read a spritelayout from the GRF.
Definition: newgrf.cpp:859
GetCargoIDByLabel
CargoID GetCargoIDByLabel(CargoLabel cl)
Get the cargo ID by cargo label.
Definition: cargotype.cpp:108
newgrf_cargo.h
SetYearEngineAgingStops
void SetYearEngineAgingStops()
Compute the value for _year_engine_aging_stops.
Definition: engine.cpp:627
RailtypeInfo::curve_speed
byte curve_speed
Multiplier for curve maximum speed advantage.
Definition: rail.h:203
MapLogY
static uint MapLogY()
Logarithm of the map size along the y side.
Definition: map_func.h:62
GRFFile::railtype_list
std::vector< RailTypeLabel > railtype_list
Railtype translation table.
Definition: newgrf.h:130
AirportSpec::catchment
byte catchment
catchment area of this airport
Definition: newgrf_airport.h:108
RandomizedSpriteGroup::groups
std::vector< const SpriteGroup * > groups
Take the group with appropriate index:
Definition: newgrf_spritegroup.h:201
ReadSpriteLayoutSprite
static TileLayoutFlags ReadSpriteLayoutSprite(ByteReader *buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, int feature, PalSpriteID *grf_sprite, uint16 *max_sprite_offset=nullptr, uint16 *max_palette_offset=nullptr)
Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD.
Definition: newgrf.cpp:748
StationSpec::cargo_triggers
CargoTypes cargo_triggers
Bitmask of cargo types which cause trigger re-randomizing.
Definition: newgrf_station.h:156
SpriteGroup
Definition: newgrf_spritegroup.h:57
GRFLabel
Definition: newgrf.h:97
SkipAct12
static void SkipAct12(ByteReader *buf)
Action 0x12 (SKIP)
Definition: newgrf.cpp:7797
SPR_ONEWAY_BASE
static const SpriteID SPR_ONEWAY_BASE
One way road sprites.
Definition: sprites.h:293
HouseSpec::grf_prop
GRFFileProps grf_prop
Properties related the the grf file.
Definition: house.h:114
AddStringForMapping
static void AddStringForMapping(StringID source, StringID *target)
Record a static StringID for getting translated later.
Definition: newgrf.cpp:480
GetGRFConfig
GRFConfig * GetGRFConfig(uint32 grfid, uint32 mask)
Retrieve a NewGRF from the current config by its grfid.
Definition: newgrf_config.cpp:771
ResetGenericCallbacks
void ResetGenericCallbacks()
Reset all generic feature callback sprite groups.
Definition: newgrf_generic.cpp:95
Action5Type
Information about a single action 5 type.
Definition: newgrf.cpp:6166
_currency_specs
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Definition: currency.cpp:74
NamePart::id
byte id
If probability bit 7 is set.
Definition: newgrf_townname.h:23
LanguageMap::Mapping::newgrf_id
byte newgrf_id
NewGRF's internal ID for a case/gender.
Definition: newgrf_text.h:61
RailVehicleInfo::curve_speed_mod
int16 curve_speed_mod
Modifier to maximum speed in curves (fixed-point binary with 8 fractional bits)
Definition: engine_type.h:62
StationSpec::wires
byte wires
Bitmask of base tiles (0 - 7) which should contain elrail wires.
Definition: newgrf_station.h:163
AddGRFTextToList
static void AddGRFTextToList(GRFTextList &list, byte langid, const std::string &text_to_add)
Add a new text to a GRFText list.
Definition: newgrf_text.cpp:493
SetEngineGRF
void SetEngineGRF(EngineID engine, const GRFFile *file)
Tie a GRFFile entry to an engine, to allow us to retrieve GRF parameters etc during a game.
Definition: newgrf_engine.cpp:70
OrderSettings::gradual_loading
bool gradual_loading
load vehicles gradually
Definition: settings_type.h:476
GCF_STATIC
@ GCF_STATIC
GRF file is used statically (can be used in any MP game)
Definition: newgrf_config.h:25
NewGRFSpriteLayout::Allocate
void Allocate(uint num_sprites)
Allocate a spritelayout for num_sprites building sprites.
Definition: newgrf_commons.cpp:624
Action5Type::max_sprites
uint16 max_sprites
If the Action5 contains more sprites, only the first max_sprites sprites will be used.
Definition: newgrf.cpp:6170
GRFConfig::param_info
std::vector< GRFParameterInfo * > param_info
NOSAVE: extra information about the parameters.
Definition: newgrf_config.h:180
IndustryLifeType
IndustryLifeType
Available types of industry lifetimes.
Definition: industrytype.h:28
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:106
ObjectSpec::cls_id
ObjectClassID cls_id
The class to which this spec belongs.
Definition: newgrf_object.h:63
PROP_TRAIN_USER_DATA
@ PROP_TRAIN_USER_DATA
User defined data for vehicle variable 0x42.
Definition: newgrf_properties.h:29
ShipVehicleInfo::ocean_speed_frac
byte ocean_speed_frac
Fraction of maximum speed for ocean tiles.
Definition: engine_type.h:75
Engine::type
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:55
TE_PASSENGERS
@ TE_PASSENGERS
Cargo behaves passenger-like.
Definition: cargotype.h:29
IgnoreIndustryTileProperty
static ChangeInfoResult IgnoreIndustryTileProperty(int prop, ByteReader *buf)
Ignore an industry tile property.
Definition: newgrf.cpp:3143
StationSpec::blocked
byte blocked
Bitmask of base tiles (0 - 7) which are blocked to trains.
Definition: newgrf_station.h:164
debug.h
GRFConfig::param
uint32 param[0x80]
GRF parameters.
Definition: newgrf_config.h:176
DAYS_TILL_ORIGINAL_BASE_YEAR
#define DAYS_TILL_ORIGINAL_BASE_YEAR
The offset in days from the '_date == 0' till 'ConvertYMDToDate(ORIGINAL_BASE_YEAR,...
Definition: date_type.h:81
GRFParameterInfo::min_value
uint32 min_value
The minimal value this parameter can have.
Definition: newgrf_config.h:140
TileLayoutSpriteGroup
Action 2 sprite layout for houses, industry tiles, objects and airport tiles.
Definition: newgrf_spritegroup.h:259
GRFConfig::GetName
const char * GetName() const
Get the name of this grf.
Definition: newgrf_config.cpp:105
RoadTypeInfo::maintenance_multiplier
uint16 maintenance_multiplier
Cost multiplier for maintenance of this road type.
Definition: road.h:135
PROP_ROADVEH_WEIGHT
@ PROP_ROADVEH_WEIGHT
Weight in 1/4 t.
Definition: newgrf_properties.h:37
TileLayoutRegisters::max_sprite_offset
uint16 max_sprite_offset
Maximum offset to add to the sprite. (limited by size of the spriteset)
Definition: newgrf_commons.h:96
SPR_TRAMWAY_BASE
static const SpriteID SPR_TRAMWAY_BASE
Tramway sprites.
Definition: sprites.h:272
engine_func.h
AirportTileSpec::animation
AnimationInfo animation
Information about the animation.
Definition: newgrf_airporttiles.h:67
RoadTypeInfo::strings
struct RoadTypeInfo::@42 strings
Strings associated with the rail type.
EC_MONORAIL
@ EC_MONORAIL
Mono rail engine.
Definition: engine_type.h:37
WaterFeature::group
const SpriteGroup * group
Sprite group to start resolving.
Definition: newgrf_canal.h:23
INVALID_RAILTYPE
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition: rail_type.h:34
DrawTileSeqStruct
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
Definition: sprite.h:25
ObjectSpec::flags
ObjectFlags flags
Flags/settings related to the object.
Definition: newgrf_object.h:72
RoadTypeChangeInfo
static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
Define properties for roadtypes.
Definition: newgrf.cpp:4432
HouseOverrideManager::SetEntitySpec
void SetEntitySpec(const HouseSpec *hs)
Install the specs into the HouseSpecs array It will find itself the proper slot on which it will go.
Definition: newgrf_commons.cpp:176
RailtypeInfo::introduces_railtypes
RailTypes introduces_railtypes
Bitmask of which other railtypes are introduced when this railtype is introduced.
Definition: rail.h:263
MAX_YEAR
static const Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
Definition: date_type.h:95
AllocaM
#define AllocaM(T, num_elements)
alloca() has to be called in the parent function, so define AllocaM() as a macro
Definition: alloc_func.hpp:132
SNOW_LINE_MONTHS
static const uint SNOW_LINE_MONTHS
Number of months in the snow line table.
Definition: landscape.h:16
CanalFeature
CanalFeature
List of different canal 'features'.
Definition: newgrf.h:25
TileIndexDiffC::x
int16 x
The x value of the coordinate.
Definition: map_type.h:58
ReadSpriteLayoutRegisters
static void ReadSpriteLayoutRegisters(ByteReader *buf, TileLayoutFlags flags, bool is_parent, NewGRFSpriteLayout *dts, uint index)
Preprocess the TileLayoutFlags and read register modifiers from the GRF.
Definition: newgrf.cpp:806
GRFP_BLT_MASK
@ GRFP_BLT_MASK
Bitmask to only get the blitter information.
Definition: newgrf_config.h:78