OpenTTD Source  13.0-RC2
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 = 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 = 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 = 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 = 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 = UINT16_MAX;
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  if (bridge->speed == 0) bridge->speed = UINT16_MAX;
2203  break;
2204 
2205  case 0x0D: { // Bridge sprite tables
2206  byte tableid = buf->ReadByte();
2207  byte numtables = buf->ReadByte();
2208 
2209  if (bridge->sprite_table == nullptr) {
2210  /* Allocate memory for sprite table pointers and zero out */
2211  bridge->sprite_table = CallocT<PalSpriteID*>(7);
2212  }
2213 
2214  for (; numtables-- != 0; tableid++) {
2215  if (tableid >= 7) { // skip invalid data
2216  grfmsg(1, "BridgeChangeInfo: Table %d >= 7, skipping", tableid);
2217  for (byte sprite = 0; sprite < 32; sprite++) buf->ReadDWord();
2218  continue;
2219  }
2220 
2221  if (bridge->sprite_table[tableid] == nullptr) {
2222  bridge->sprite_table[tableid] = MallocT<PalSpriteID>(32);
2223  }
2224 
2225  for (byte sprite = 0; sprite < 32; sprite++) {
2226  SpriteID image = buf->ReadWord();
2227  PaletteID pal = buf->ReadWord();
2228 
2229  bridge->sprite_table[tableid][sprite].sprite = image;
2230  bridge->sprite_table[tableid][sprite].pal = pal;
2231 
2232  MapSpriteMappingRecolour(&bridge->sprite_table[tableid][sprite]);
2233  }
2234  }
2235  break;
2236  }
2237 
2238  case 0x0E: // Flags; bit 0 - disable far pillars
2239  bridge->flags = buf->ReadByte();
2240  break;
2241 
2242  case 0x0F: // Long format year of availability (year since year 0)
2243  bridge->avail_year = Clamp(buf->ReadDWord(), MIN_YEAR, MAX_YEAR);
2244  break;
2245 
2246  case 0x10: { // purchase string
2247  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2248  if (newone != STR_UNDEFINED) bridge->material = newone;
2249  break;
2250  }
2251 
2252  case 0x11: // description of bridge with rails or roads
2253  case 0x12: {
2254  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2255  if (newone != STR_UNDEFINED) bridge->transport_name[prop - 0x11] = newone;
2256  break;
2257  }
2258 
2259  case 0x13: // 16 bits cost multiplier
2260  bridge->price = buf->ReadWord();
2261  break;
2262 
2263  default:
2264  ret = CIR_UNKNOWN;
2265  break;
2266  }
2267  }
2268 
2269  return ret;
2270 }
2271 
2279 {
2281 
2282  switch (prop) {
2283  case 0x09:
2284  case 0x0B:
2285  case 0x0C:
2286  case 0x0D:
2287  case 0x0E:
2288  case 0x0F:
2289  case 0x11:
2290  case 0x14:
2291  case 0x15:
2292  case 0x16:
2293  case 0x18:
2294  case 0x19:
2295  case 0x1A:
2296  case 0x1B:
2297  case 0x1C:
2298  case 0x1D:
2299  case 0x1F:
2300  buf->ReadByte();
2301  break;
2302 
2303  case 0x0A:
2304  case 0x10:
2305  case 0x12:
2306  case 0x13:
2307  case 0x21:
2308  case 0x22:
2309  buf->ReadWord();
2310  break;
2311 
2312  case 0x1E:
2313  buf->ReadDWord();
2314  break;
2315 
2316  case 0x17:
2317  for (uint j = 0; j < 4; j++) buf->ReadByte();
2318  break;
2319 
2320  case 0x20: {
2321  byte count = buf->ReadByte();
2322  for (byte j = 0; j < count; j++) buf->ReadByte();
2323  break;
2324  }
2325 
2326  case 0x23:
2327  buf->Skip(buf->ReadByte() * 2);
2328  break;
2329 
2330  default:
2331  ret = CIR_UNKNOWN;
2332  break;
2333  }
2334  return ret;
2335 }
2336 
2345 static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, ByteReader *buf)
2346 {
2348 
2349  if (hid + numinfo > NUM_HOUSES_PER_GRF) {
2350  grfmsg(1, "TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo, NUM_HOUSES_PER_GRF);
2351  return CIR_INVALID_ID;
2352  }
2353 
2354  /* Allocate house specs if they haven't been allocated already. */
2355  if (_cur.grffile->housespec == nullptr) {
2356  _cur.grffile->housespec = CallocT<HouseSpec*>(NUM_HOUSES_PER_GRF);
2357  }
2358 
2359  for (int i = 0; i < numinfo; i++) {
2360  HouseSpec *housespec = _cur.grffile->housespec[hid + i];
2361 
2362  if (prop != 0x08 && housespec == nullptr) {
2363  /* If the house property 08 is not yet set, ignore this property */
2364  ChangeInfoResult cir = IgnoreTownHouseProperty(prop, buf);
2365  if (cir > ret) ret = cir;
2366  continue;
2367  }
2368 
2369  switch (prop) {
2370  case 0x08: { // Substitute building type, and definition of a new house
2371  HouseSpec **house = &_cur.grffile->housespec[hid + i];
2372  byte subs_id = buf->ReadByte();
2373 
2374  if (subs_id == 0xFF) {
2375  /* Instead of defining a new house, a substitute house id
2376  * of 0xFF disables the old house with the current id. */
2377  HouseSpec::Get(hid + i)->enabled = false;
2378  continue;
2379  } else if (subs_id >= NEW_HOUSE_OFFSET) {
2380  /* The substitute id must be one of the original houses. */
2381  grfmsg(2, "TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i);
2382  continue;
2383  }
2384 
2385  /* Allocate space for this house. */
2386  if (*house == nullptr) *house = CallocT<HouseSpec>(1);
2387 
2388  housespec = *house;
2389 
2390  MemCpyT(housespec, HouseSpec::Get(subs_id));
2391 
2392  housespec->enabled = true;
2393  housespec->grf_prop.local_id = hid + i;
2394  housespec->grf_prop.subst_id = subs_id;
2395  housespec->grf_prop.grffile = _cur.grffile;
2396  housespec->random_colour[0] = 0x04; // those 4 random colours are the base colour
2397  housespec->random_colour[1] = 0x08; // for all new houses
2398  housespec->random_colour[2] = 0x0C; // they stand for red, blue, orange and green
2399  housespec->random_colour[3] = 0x06;
2400 
2401  /* Make sure that the third cargo type is valid in this
2402  * climate. This can cause problems when copying the properties
2403  * of a house that accepts food, where the new house is valid
2404  * in the temperate climate. */
2405  if (!CargoSpec::Get(housespec->accepts_cargo[2])->IsValid()) {
2406  housespec->cargo_acceptance[2] = 0;
2407  }
2408  break;
2409  }
2410 
2411  case 0x09: // Building flags
2412  housespec->building_flags = (BuildingFlags)buf->ReadByte();
2413  break;
2414 
2415  case 0x0A: { // Availability years
2416  uint16 years = buf->ReadWord();
2417  housespec->min_year = GB(years, 0, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 0, 8);
2418  housespec->max_year = GB(years, 8, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 8, 8);
2419  break;
2420  }
2421 
2422  case 0x0B: // Population
2423  housespec->population = buf->ReadByte();
2424  break;
2425 
2426  case 0x0C: // Mail generation multiplier
2427  housespec->mail_generation = buf->ReadByte();
2428  break;
2429 
2430  case 0x0D: // Passenger acceptance
2431  case 0x0E: // Mail acceptance
2432  housespec->cargo_acceptance[prop - 0x0D] = buf->ReadByte();
2433  break;
2434 
2435  case 0x0F: { // Goods/candy, food/fizzy drinks acceptance
2436  int8 goods = buf->ReadByte();
2437 
2438  /* If value of goods is negative, it means in fact food or, if in toyland, fizzy_drink acceptance.
2439  * Else, we have "standard" 3rd cargo type, goods or candy, for toyland once more */
2440  CargoID cid = (goods >= 0) ? ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_CANDY : CT_GOODS) :
2441  ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_FIZZY_DRINKS : CT_FOOD);
2442 
2443  /* Make sure the cargo type is valid in this climate. */
2444  if (!CargoSpec::Get(cid)->IsValid()) goods = 0;
2445 
2446  housespec->accepts_cargo[2] = cid;
2447  housespec->cargo_acceptance[2] = abs(goods); // but we do need positive value here
2448  break;
2449  }
2450 
2451  case 0x10: // Local authority rating decrease on removal
2452  housespec->remove_rating_decrease = buf->ReadWord();
2453  break;
2454 
2455  case 0x11: // Removal cost multiplier
2456  housespec->removal_cost = buf->ReadByte();
2457  break;
2458 
2459  case 0x12: // Building name ID
2460  AddStringForMapping(buf->ReadWord(), &housespec->building_name);
2461  break;
2462 
2463  case 0x13: // Building availability mask
2464  housespec->building_availability = (HouseZones)buf->ReadWord();
2465  break;
2466 
2467  case 0x14: // House callback mask
2468  housespec->callback_mask |= buf->ReadByte();
2469  break;
2470 
2471  case 0x15: { // House override byte
2472  byte override = buf->ReadByte();
2473 
2474  /* The house being overridden must be an original house. */
2475  if (override >= NEW_HOUSE_OFFSET) {
2476  grfmsg(2, "TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.", override, hid + i);
2477  continue;
2478  }
2479 
2480  _house_mngr.Add(hid + i, _cur.grffile->grfid, override);
2481  break;
2482  }
2483 
2484  case 0x16: // Periodic refresh multiplier
2485  housespec->processing_time = std::min<byte>(buf->ReadByte(), 63u);
2486  break;
2487 
2488  case 0x17: // Four random colours to use
2489  for (uint j = 0; j < 4; j++) housespec->random_colour[j] = buf->ReadByte();
2490  break;
2491 
2492  case 0x18: // Relative probability of appearing
2493  housespec->probability = buf->ReadByte();
2494  break;
2495 
2496  case 0x19: // Extra flags
2497  housespec->extra_flags = (HouseExtraFlags)buf->ReadByte();
2498  break;
2499 
2500  case 0x1A: // Animation frames
2501  housespec->animation.frames = buf->ReadByte();
2502  housespec->animation.status = GB(housespec->animation.frames, 7, 1);
2503  SB(housespec->animation.frames, 7, 1, 0);
2504  break;
2505 
2506  case 0x1B: // Animation speed
2507  housespec->animation.speed = Clamp(buf->ReadByte(), 2, 16);
2508  break;
2509 
2510  case 0x1C: // Class of the building type
2511  housespec->class_id = AllocateHouseClassID(buf->ReadByte(), _cur.grffile->grfid);
2512  break;
2513 
2514  case 0x1D: // Callback mask part 2
2515  housespec->callback_mask |= (buf->ReadByte() << 8);
2516  break;
2517 
2518  case 0x1E: { // Accepted cargo types
2519  uint32 cargotypes = buf->ReadDWord();
2520 
2521  /* Check if the cargo types should not be changed */
2522  if (cargotypes == 0xFFFFFFFF) break;
2523 
2524  for (uint j = 0; j < 3; j++) {
2525  /* Get the cargo number from the 'list' */
2526  uint8 cargo_part = GB(cargotypes, 8 * j, 8);
2527  CargoID cargo = GetCargoTranslation(cargo_part, _cur.grffile);
2528 
2529  if (cargo == CT_INVALID) {
2530  /* Disable acceptance of invalid cargo type */
2531  housespec->cargo_acceptance[j] = 0;
2532  } else {
2533  housespec->accepts_cargo[j] = cargo;
2534  }
2535  }
2536  break;
2537  }
2538 
2539  case 0x1F: // Minimum life span
2540  housespec->minimum_life = buf->ReadByte();
2541  break;
2542 
2543  case 0x20: { // Cargo acceptance watch list
2544  byte count = buf->ReadByte();
2545  for (byte j = 0; j < count; j++) {
2546  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
2547  if (cargo != CT_INVALID) SetBit(housespec->watched_cargoes, cargo);
2548  }
2549  break;
2550  }
2551 
2552  case 0x21: // long introduction year
2553  housespec->min_year = buf->ReadWord();
2554  break;
2555 
2556  case 0x22: // long maximum year
2557  housespec->max_year = buf->ReadWord();
2558  break;
2559 
2560  case 0x23: { // variable length cargo types accepted
2561  uint count = buf->ReadByte();
2562  if (count > lengthof(housespec->accepts_cargo)) {
2563  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
2564  error->param_value[1] = prop;
2565  return CIR_DISABLED;
2566  }
2567  /* Always write the full accepts_cargo array, and check each index for being inside the
2568  * provided data. This ensures all values are properly initialized, and also avoids
2569  * any risks of array overrun. */
2570  for (uint i = 0; i < lengthof(housespec->accepts_cargo); i++) {
2571  if (i < count) {
2572  housespec->accepts_cargo[i] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
2573  housespec->cargo_acceptance[i] = buf->ReadByte();
2574  } else {
2575  housespec->accepts_cargo[i] = CT_INVALID;
2576  housespec->cargo_acceptance[i] = 0;
2577  }
2578  }
2579  break;
2580  }
2581 
2582  default:
2583  ret = CIR_UNKNOWN;
2584  break;
2585  }
2586  }
2587 
2588  return ret;
2589 }
2590 
2597 /* static */ const LanguageMap *LanguageMap::GetLanguageMap(uint32 grfid, uint8 language_id)
2598 {
2599  /* LanguageID "MAX_LANG", i.e. 7F is any. This language can't have a gender/case mapping, but has to be handled gracefully. */
2600  const GRFFile *grffile = GetFileByGRFID(grfid);
2601  return (grffile != nullptr && grffile->language_map != nullptr && language_id < MAX_LANG) ? &grffile->language_map[language_id] : nullptr;
2602 }
2603 
2613 template <typename T>
2614 static ChangeInfoResult LoadTranslationTable(uint gvid, int numinfo, ByteReader *buf, T &translation_table, const char *name)
2615 {
2616  if (gvid != 0) {
2617  grfmsg(1, "LoadTranslationTable: %s translation table must start at zero", name);
2618  return CIR_INVALID_ID;
2619  }
2620 
2621  translation_table.clear();
2622  for (int i = 0; i < numinfo; i++) {
2623  uint32 item = buf->ReadDWord();
2624  translation_table.push_back(BSWAP32(item));
2625  }
2626 
2627  return CIR_SUCCESS;
2628 }
2629 
2636 static std::string ReadDWordAsString(ByteReader *reader)
2637 {
2638  char output[5];
2639  for (int i = 0; i < 4; i++) output[i] = reader->ReadByte();
2640  output[4] = '\0';
2641  StrMakeValidInPlace(output, lastof(output));
2642 
2643  return std::string(output);
2644 }
2645 
2654 static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
2655 {
2656  /* Properties which are handled as a whole */
2657  switch (prop) {
2658  case 0x09: // Cargo Translation Table; loading during both reservation and activation stage (in case it is selected depending on defined cargos)
2659  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->cargo_list, "Cargo");
2660 
2661  case 0x12: // Rail type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2662  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->railtype_list, "Rail type");
2663 
2664  case 0x16: // Road type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2665  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->roadtype_list, "Road type");
2666 
2667  case 0x17: // Tram type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2668  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->tramtype_list, "Tram type");
2669 
2670  default:
2671  break;
2672  }
2673 
2674  /* Properties which are handled per item */
2676  for (int i = 0; i < numinfo; i++) {
2677  switch (prop) {
2678  case 0x08: { // Cost base factor
2679  int factor = buf->ReadByte();
2680  uint price = gvid + i;
2681 
2682  if (price < PR_END) {
2683  _cur.grffile->price_base_multipliers[price] = std::min<int>(factor - 8, MAX_PRICE_MODIFIER);
2684  } else {
2685  grfmsg(1, "GlobalVarChangeInfo: Price %d out of range, ignoring", price);
2686  }
2687  break;
2688  }
2689 
2690  case 0x0A: { // Currency display names
2691  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2692  StringID newone = GetGRFStringID(_cur.grffile->grfid, buf->ReadWord());
2693 
2694  if ((newone != STR_UNDEFINED) && (curidx < CURRENCY_END)) {
2695  _currency_specs[curidx].name = newone;
2696  }
2697  break;
2698  }
2699 
2700  case 0x0B: { // Currency multipliers
2701  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2702  uint32 rate = buf->ReadDWord();
2703 
2704  if (curidx < CURRENCY_END) {
2705  /* TTDPatch uses a multiple of 1000 for its conversion calculations,
2706  * which OTTD does not. For this reason, divide grf value by 1000,
2707  * to be compatible */
2708  _currency_specs[curidx].rate = rate / 1000;
2709  } else {
2710  grfmsg(1, "GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx);
2711  }
2712  break;
2713  }
2714 
2715  case 0x0C: { // Currency options
2716  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2717  uint16 options = buf->ReadWord();
2718 
2719  if (curidx < CURRENCY_END) {
2720  _currency_specs[curidx].separator.clear();
2721  _currency_specs[curidx].separator.push_back(GB(options, 0, 8));
2722  /* By specifying only one bit, we prevent errors,
2723  * since newgrf specs said that only 0 and 1 can be set for symbol_pos */
2724  _currency_specs[curidx].symbol_pos = GB(options, 8, 1);
2725  } else {
2726  grfmsg(1, "GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx);
2727  }
2728  break;
2729  }
2730 
2731  case 0x0D: { // Currency prefix symbol
2732  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2733  std::string prefix = ReadDWordAsString(buf);
2734 
2735  if (curidx < CURRENCY_END) {
2736  _currency_specs[curidx].prefix = prefix;
2737  } else {
2738  grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2739  }
2740  break;
2741  }
2742 
2743  case 0x0E: { // Currency suffix symbol
2744  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2745  std::string suffix = ReadDWordAsString(buf);
2746 
2747  if (curidx < CURRENCY_END) {
2748  _currency_specs[curidx].suffix = suffix;
2749  } else {
2750  grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2751  }
2752  break;
2753  }
2754 
2755  case 0x0F: { // Euro introduction dates
2756  uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
2757  Year year_euro = buf->ReadWord();
2758 
2759  if (curidx < CURRENCY_END) {
2760  _currency_specs[curidx].to_euro = year_euro;
2761  } else {
2762  grfmsg(1, "GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx);
2763  }
2764  break;
2765  }
2766 
2767  case 0x10: // Snow line height table
2768  if (numinfo > 1 || IsSnowLineSet()) {
2769  grfmsg(1, "GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo);
2770  } else if (buf->Remaining() < SNOW_LINE_MONTHS * SNOW_LINE_DAYS) {
2771  grfmsg(1, "GlobalVarChangeInfo: Not enough entries set in the snowline table (" PRINTF_SIZE ")", buf->Remaining());
2772  } else {
2773  byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS];
2774 
2775  for (uint i = 0; i < SNOW_LINE_MONTHS; i++) {
2776  for (uint j = 0; j < SNOW_LINE_DAYS; j++) {
2777  table[i][j] = buf->ReadByte();
2778  if (_cur.grffile->grf_version >= 8) {
2779  if (table[i][j] != 0xFF) table[i][j] = table[i][j] * (1 + _settings_game.construction.map_height_limit) / 256;
2780  } else {
2781  if (table[i][j] >= 128) {
2782  /* no snow */
2783  table[i][j] = 0xFF;
2784  } else {
2785  table[i][j] = table[i][j] * (1 + _settings_game.construction.map_height_limit) / 128;
2786  }
2787  }
2788  }
2789  }
2790  SetSnowLine(table);
2791  }
2792  break;
2793 
2794  case 0x11: // GRF match for engine allocation
2795  /* This is loaded during the reservation stage, so just skip it here. */
2796  /* Each entry is 8 bytes. */
2797  buf->Skip(8);
2798  break;
2799 
2800  case 0x13: // Gender translation table
2801  case 0x14: // Case translation table
2802  case 0x15: { // Plural form translation
2803  uint curidx = gvid + i; // The current index, i.e. language.
2804  const LanguageMetadata *lang = curidx < MAX_LANG ? GetLanguage(curidx) : nullptr;
2805  if (lang == nullptr) {
2806  grfmsg(1, "GlobalVarChangeInfo: Language %d is not known, ignoring", curidx);
2807  /* Skip over the data. */
2808  if (prop == 0x15) {
2809  buf->ReadByte();
2810  } else {
2811  while (buf->ReadByte() != 0) {
2812  buf->ReadString();
2813  }
2814  }
2815  break;
2816  }
2817 
2818  if (_cur.grffile->language_map == nullptr) _cur.grffile->language_map = new LanguageMap[MAX_LANG];
2819 
2820  if (prop == 0x15) {
2821  uint plural_form = buf->ReadByte();
2822  if (plural_form >= LANGUAGE_MAX_PLURAL) {
2823  grfmsg(1, "GlobalVarChanceInfo: Plural form %d is out of range, ignoring", plural_form);
2824  } else {
2825  _cur.grffile->language_map[curidx].plural_form = plural_form;
2826  }
2827  break;
2828  }
2829 
2830  byte newgrf_id = buf->ReadByte(); // The NewGRF (custom) identifier.
2831  while (newgrf_id != 0) {
2832  const char *name = buf->ReadString(); // The name for the OpenTTD identifier.
2833 
2834  /* We'll just ignore the UTF8 identifier character. This is (fairly)
2835  * safe as OpenTTD's strings gender/cases are usually in ASCII which
2836  * is just a subset of UTF8, or they need the bigger UTF8 characters
2837  * such as Cyrillic. Thus we will simply assume they're all UTF8. */
2838  WChar c;
2839  size_t len = Utf8Decode(&c, name);
2840  if (c == NFO_UTF8_IDENTIFIER) name += len;
2841 
2843  map.newgrf_id = newgrf_id;
2844  if (prop == 0x13) {
2845  map.openttd_id = lang->GetGenderIndex(name);
2846  if (map.openttd_id >= MAX_NUM_GENDERS) {
2847  grfmsg(1, "GlobalVarChangeInfo: Gender name %s is not known, ignoring", name);
2848  } else {
2849  _cur.grffile->language_map[curidx].gender_map.push_back(map);
2850  }
2851  } else {
2852  map.openttd_id = lang->GetCaseIndex(name);
2853  if (map.openttd_id >= MAX_NUM_CASES) {
2854  grfmsg(1, "GlobalVarChangeInfo: Case name %s is not known, ignoring", name);
2855  } else {
2856  _cur.grffile->language_map[curidx].case_map.push_back(map);
2857  }
2858  }
2859  newgrf_id = buf->ReadByte();
2860  }
2861  break;
2862  }
2863 
2864  default:
2865  ret = CIR_UNKNOWN;
2866  break;
2867  }
2868  }
2869 
2870  return ret;
2871 }
2872 
2873 static ChangeInfoResult GlobalVarReserveInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
2874 {
2875  /* Properties which are handled as a whole */
2876  switch (prop) {
2877  case 0x09: // Cargo Translation Table; loading during both reservation and activation stage (in case it is selected depending on defined cargos)
2878  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->cargo_list, "Cargo");
2879 
2880  case 0x12: // Rail type translation table; loading during both reservation and activation stage (in case it is selected depending on defined railtypes)
2881  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->railtype_list, "Rail type");
2882 
2883  case 0x16: // Road type translation table; loading during both reservation and activation stage (in case it is selected depending on defined roadtypes)
2884  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->roadtype_list, "Road type");
2885 
2886  case 0x17: // Tram type translation table; loading during both reservation and activation stage (in case it is selected depending on defined tramtypes)
2887  return LoadTranslationTable(gvid, numinfo, buf, _cur.grffile->tramtype_list, "Tram type");
2888 
2889  default:
2890  break;
2891  }
2892 
2893  /* Properties which are handled per item */
2895  for (int i = 0; i < numinfo; i++) {
2896  switch (prop) {
2897  case 0x08: // Cost base factor
2898  case 0x15: // Plural form translation
2899  buf->ReadByte();
2900  break;
2901 
2902  case 0x0A: // Currency display names
2903  case 0x0C: // Currency options
2904  case 0x0F: // Euro introduction dates
2905  buf->ReadWord();
2906  break;
2907 
2908  case 0x0B: // Currency multipliers
2909  case 0x0D: // Currency prefix symbol
2910  case 0x0E: // Currency suffix symbol
2911  buf->ReadDWord();
2912  break;
2913 
2914  case 0x10: // Snow line height table
2915  buf->Skip(SNOW_LINE_MONTHS * SNOW_LINE_DAYS);
2916  break;
2917 
2918  case 0x11: { // GRF match for engine allocation
2919  uint32 s = buf->ReadDWord();
2920  uint32 t = buf->ReadDWord();
2921  SetNewGRFOverride(s, t);
2922  break;
2923  }
2924 
2925  case 0x13: // Gender translation table
2926  case 0x14: // Case translation table
2927  while (buf->ReadByte() != 0) {
2928  buf->ReadString();
2929  }
2930  break;
2931 
2932  default:
2933  ret = CIR_UNKNOWN;
2934  break;
2935  }
2936  }
2937 
2938  return ret;
2939 }
2940 
2941 
2950 static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, ByteReader *buf)
2951 {
2953 
2954  if (cid + numinfo > NUM_CARGO) {
2955  grfmsg(2, "CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo, NUM_CARGO - 1);
2956  return CIR_INVALID_ID;
2957  }
2958 
2959  for (int i = 0; i < numinfo; i++) {
2960  CargoSpec *cs = CargoSpec::Get(cid + i);
2961 
2962  switch (prop) {
2963  case 0x08: // Bit number of cargo
2964  cs->bitnum = buf->ReadByte();
2965  if (cs->IsValid()) {
2966  cs->grffile = _cur.grffile;
2967  SetBit(_cargo_mask, cid + i);
2968  } else {
2969  ClrBit(_cargo_mask, cid + i);
2970  }
2971  break;
2972 
2973  case 0x09: // String ID for cargo type name
2974  AddStringForMapping(buf->ReadWord(), &cs->name);
2975  break;
2976 
2977  case 0x0A: // String for 1 unit of cargo
2978  AddStringForMapping(buf->ReadWord(), &cs->name_single);
2979  break;
2980 
2981  case 0x0B: // String for singular quantity of cargo (e.g. 1 tonne of coal)
2982  case 0x1B: // String for cargo units
2983  /* String for units of cargo. This is different in OpenTTD
2984  * (e.g. tonnes) to TTDPatch (e.g. {COMMA} tonne of coal).
2985  * Property 1B is used to set OpenTTD's behaviour. */
2986  AddStringForMapping(buf->ReadWord(), &cs->units_volume);
2987  break;
2988 
2989  case 0x0C: // String for plural quantity of cargo (e.g. 10 tonnes of coal)
2990  case 0x1C: // String for any amount of cargo
2991  /* Strings for an amount of cargo. This is different in OpenTTD
2992  * (e.g. {WEIGHT} of coal) to TTDPatch (e.g. {COMMA} tonnes of coal).
2993  * Property 1C is used to set OpenTTD's behaviour. */
2994  AddStringForMapping(buf->ReadWord(), &cs->quantifier);
2995  break;
2996 
2997  case 0x0D: // String for two letter cargo abbreviation
2998  AddStringForMapping(buf->ReadWord(), &cs->abbrev);
2999  break;
3000 
3001  case 0x0E: // Sprite ID for cargo icon
3002  cs->sprite = buf->ReadWord();
3003  break;
3004 
3005  case 0x0F: // Weight of one unit of cargo
3006  cs->weight = buf->ReadByte();
3007  break;
3008 
3009  case 0x10: // Used for payment calculation
3010  cs->transit_days[0] = buf->ReadByte();
3011  break;
3012 
3013  case 0x11: // Used for payment calculation
3014  cs->transit_days[1] = buf->ReadByte();
3015  break;
3016 
3017  case 0x12: // Base cargo price
3018  cs->initial_payment = buf->ReadDWord();
3019  break;
3020 
3021  case 0x13: // Colour for station rating bars
3022  cs->rating_colour = buf->ReadByte();
3023  break;
3024 
3025  case 0x14: // Colour for cargo graph
3026  cs->legend_colour = buf->ReadByte();
3027  break;
3028 
3029  case 0x15: // Freight status
3030  cs->is_freight = (buf->ReadByte() != 0);
3031  break;
3032 
3033  case 0x16: // Cargo classes
3034  cs->classes = buf->ReadWord();
3035  break;
3036 
3037  case 0x17: // Cargo label
3038  cs->label = buf->ReadDWord();
3039  cs->label = BSWAP32(cs->label);
3040  break;
3041 
3042  case 0x18: { // Town growth substitute type
3043  uint8 substitute_type = buf->ReadByte();
3044 
3045  switch (substitute_type) {
3046  case 0x00: cs->town_effect = TE_PASSENGERS; break;
3047  case 0x02: cs->town_effect = TE_MAIL; break;
3048  case 0x05: cs->town_effect = TE_GOODS; break;
3049  case 0x09: cs->town_effect = TE_WATER; break;
3050  case 0x0B: cs->town_effect = TE_FOOD; break;
3051  default:
3052  grfmsg(1, "CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type);
3053  FALLTHROUGH;
3054  case 0xFF: cs->town_effect = TE_NONE; break;
3055  }
3056  break;
3057  }
3058 
3059  case 0x19: // Town growth coefficient
3060  buf->ReadWord();
3061  break;
3062 
3063  case 0x1A: // Bitmask of callbacks to use
3064  cs->callback_mask = buf->ReadByte();
3065  break;
3066 
3067  case 0x1D: // Vehicle capacity muliplier
3068  cs->multiplier = std::max<uint16>(1u, buf->ReadWord());
3069  break;
3070 
3071  default:
3072  ret = CIR_UNKNOWN;
3073  break;
3074  }
3075  }
3076 
3077  return ret;
3078 }
3079 
3080 
3089 static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, ByteReader *buf)
3090 {
3092 
3093  if (_cur.grffile->sound_offset == 0) {
3094  grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping");
3095  return CIR_INVALID_ID;
3096  }
3097 
3098  if (sid + numinfo - ORIGINAL_SAMPLE_COUNT > _cur.grffile->num_sounds) {
3099  grfmsg(1, "SoundEffectChangeInfo: Attempting to change undefined sound effect (%u), max (%u). Ignoring.", sid + numinfo, ORIGINAL_SAMPLE_COUNT + _cur.grffile->num_sounds);
3100  return CIR_INVALID_ID;
3101  }
3102 
3103  for (int i = 0; i < numinfo; i++) {
3104  SoundEntry *sound = GetSound(sid + i + _cur.grffile->sound_offset - ORIGINAL_SAMPLE_COUNT);
3105 
3106  switch (prop) {
3107  case 0x08: // Relative volume
3108  sound->volume = buf->ReadByte();
3109  break;
3110 
3111  case 0x09: // Priority
3112  sound->priority = buf->ReadByte();
3113  break;
3114 
3115  case 0x0A: { // Override old sound
3116  SoundID orig_sound = buf->ReadByte();
3117 
3118  if (orig_sound >= ORIGINAL_SAMPLE_COUNT) {
3119  grfmsg(1, "SoundEffectChangeInfo: Original sound %d not defined (max %d)", orig_sound, ORIGINAL_SAMPLE_COUNT);
3120  } else {
3121  SoundEntry *old_sound = GetSound(orig_sound);
3122 
3123  /* Literally copy the data of the new sound over the original */
3124  *old_sound = *sound;
3125  }
3126  break;
3127  }
3128 
3129  default:
3130  ret = CIR_UNKNOWN;
3131  break;
3132  }
3133  }
3134 
3135  return ret;
3136 }
3137 
3145 {
3147 
3148  switch (prop) {
3149  case 0x09:
3150  case 0x0D:
3151  case 0x0E:
3152  case 0x10:
3153  case 0x11:
3154  case 0x12:
3155  buf->ReadByte();
3156  break;
3157 
3158  case 0x0A:
3159  case 0x0B:
3160  case 0x0C:
3161  case 0x0F:
3162  buf->ReadWord();
3163  break;
3164 
3165  case 0x13:
3166  buf->Skip(buf->ReadByte() * 2);
3167  break;
3168 
3169  default:
3170  ret = CIR_UNKNOWN;
3171  break;
3172  }
3173  return ret;
3174 }
3175 
3184 static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, ByteReader *buf)
3185 {
3187 
3188  if (indtid + numinfo > NUM_INDUSTRYTILES_PER_GRF) {
3189  grfmsg(1, "IndustryTilesChangeInfo: Too many industry tiles loaded (%u), max (%u). Ignoring.", indtid + numinfo, NUM_INDUSTRYTILES_PER_GRF);
3190  return CIR_INVALID_ID;
3191  }
3192 
3193  /* Allocate industry tile specs if they haven't been allocated already. */
3194  if (_cur.grffile->indtspec == nullptr) {
3195  _cur.grffile->indtspec = CallocT<IndustryTileSpec*>(NUM_INDUSTRYTILES_PER_GRF);
3196  }
3197 
3198  for (int i = 0; i < numinfo; i++) {
3199  IndustryTileSpec *tsp = _cur.grffile->indtspec[indtid + i];
3200 
3201  if (prop != 0x08 && tsp == nullptr) {
3203  if (cir > ret) ret = cir;
3204  continue;
3205  }
3206 
3207  switch (prop) {
3208  case 0x08: { // Substitute industry tile type
3209  IndustryTileSpec **tilespec = &_cur.grffile->indtspec[indtid + i];
3210  byte subs_id = buf->ReadByte();
3211 
3212  if (subs_id >= NEW_INDUSTRYTILEOFFSET) {
3213  /* The substitute id must be one of the original industry tile. */
3214  grfmsg(2, "IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i);
3215  continue;
3216  }
3217 
3218  /* Allocate space for this industry. */
3219  if (*tilespec == nullptr) {
3220  *tilespec = CallocT<IndustryTileSpec>(1);
3221  tsp = *tilespec;
3222 
3223  memcpy(tsp, &_industry_tile_specs[subs_id], sizeof(_industry_tile_specs[subs_id]));
3224  tsp->enabled = true;
3225 
3226  /* A copied tile should not have the animation infos copied too.
3227  * The anim_state should be left untouched, though
3228  * It is up to the author to animate them */
3231 
3232  tsp->grf_prop.local_id = indtid + i;
3233  tsp->grf_prop.subst_id = subs_id;
3234  tsp->grf_prop.grffile = _cur.grffile;
3235  _industile_mngr.AddEntityID(indtid + i, _cur.grffile->grfid, subs_id); // pre-reserve the tile slot
3236  }
3237  break;
3238  }
3239 
3240  case 0x09: { // Industry tile override
3241  byte ovrid = buf->ReadByte();
3242 
3243  /* The industry being overridden must be an original industry. */
3244  if (ovrid >= NEW_INDUSTRYTILEOFFSET) {
3245  grfmsg(2, "IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i);
3246  continue;
3247  }
3248 
3249  _industile_mngr.Add(indtid + i, _cur.grffile->grfid, ovrid);
3250  break;
3251  }
3252 
3253  case 0x0A: // Tile acceptance
3254  case 0x0B:
3255  case 0x0C: {
3256  uint16 acctp = buf->ReadWord();
3257  tsp->accepts_cargo[prop - 0x0A] = GetCargoTranslation(GB(acctp, 0, 8), _cur.grffile);
3258  tsp->acceptance[prop - 0x0A] = Clamp(GB(acctp, 8, 8), 0, 16);
3259  break;
3260  }
3261 
3262  case 0x0D: // Land shape flags
3263  tsp->slopes_refused = (Slope)buf->ReadByte();
3264  break;
3265 
3266  case 0x0E: // Callback mask
3267  tsp->callback_mask = buf->ReadByte();
3268  break;
3269 
3270  case 0x0F: // Animation information
3271  tsp->animation.frames = buf->ReadByte();
3272  tsp->animation.status = buf->ReadByte();
3273  break;
3274 
3275  case 0x10: // Animation speed
3276  tsp->animation.speed = buf->ReadByte();
3277  break;
3278 
3279  case 0x11: // Triggers for callback 25
3280  tsp->animation.triggers = buf->ReadByte();
3281  break;
3282 
3283  case 0x12: // Special flags
3284  tsp->special_flags = (IndustryTileSpecialFlags)buf->ReadByte();
3285  break;
3286 
3287  case 0x13: { // variable length cargo acceptance
3288  byte num_cargoes = buf->ReadByte();
3289  if (num_cargoes > lengthof(tsp->acceptance)) {
3290  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3291  error->param_value[1] = prop;
3292  return CIR_DISABLED;
3293  }
3294  for (uint i = 0; i < lengthof(tsp->acceptance); i++) {
3295  if (i < num_cargoes) {
3296  tsp->accepts_cargo[i] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3297  /* Tile acceptance can be negative to counteract the INDTILE_SPECIAL_ACCEPTS_ALL_CARGO flag */
3298  tsp->acceptance[i] = (int8)buf->ReadByte();
3299  } else {
3300  tsp->accepts_cargo[i] = CT_INVALID;
3301  tsp->acceptance[i] = 0;
3302  }
3303  }
3304  break;
3305  }
3306 
3307  default:
3308  ret = CIR_UNKNOWN;
3309  break;
3310  }
3311  }
3312 
3313  return ret;
3314 }
3315 
3323 {
3325 
3326  switch (prop) {
3327  case 0x09:
3328  case 0x0B:
3329  case 0x0F:
3330  case 0x12:
3331  case 0x13:
3332  case 0x14:
3333  case 0x17:
3334  case 0x18:
3335  case 0x19:
3336  case 0x21:
3337  case 0x22:
3338  buf->ReadByte();
3339  break;
3340 
3341  case 0x0C:
3342  case 0x0D:
3343  case 0x0E:
3344  case 0x10:
3345  case 0x1B:
3346  case 0x1F:
3347  case 0x24:
3348  buf->ReadWord();
3349  break;
3350 
3351  case 0x11:
3352  case 0x1A:
3353  case 0x1C:
3354  case 0x1D:
3355  case 0x1E:
3356  case 0x20:
3357  case 0x23:
3358  buf->ReadDWord();
3359  break;
3360 
3361  case 0x0A: {
3362  byte num_table = buf->ReadByte();
3363  for (byte j = 0; j < num_table; j++) {
3364  for (uint k = 0;; k++) {
3365  byte x = buf->ReadByte();
3366  if (x == 0xFE && k == 0) {
3367  buf->ReadByte();
3368  buf->ReadByte();
3369  break;
3370  }
3371 
3372  byte y = buf->ReadByte();
3373  if (x == 0 && y == 0x80) break;
3374 
3375  byte gfx = buf->ReadByte();
3376  if (gfx == 0xFE) buf->ReadWord();
3377  }
3378  }
3379  break;
3380  }
3381 
3382  case 0x16:
3383  for (byte j = 0; j < 3; j++) buf->ReadByte();
3384  break;
3385 
3386  case 0x15:
3387  case 0x25:
3388  case 0x26:
3389  case 0x27:
3390  buf->Skip(buf->ReadByte());
3391  break;
3392 
3393  case 0x28: {
3394  int num_inputs = buf->ReadByte();
3395  int num_outputs = buf->ReadByte();
3396  buf->Skip(num_inputs * num_outputs * 2);
3397  break;
3398  }
3399 
3400  default:
3401  ret = CIR_UNKNOWN;
3402  break;
3403  }
3404  return ret;
3405 }
3406 
3412 static bool ValidateIndustryLayout(const IndustryTileLayout &layout)
3413 {
3414  const size_t size = layout.size();
3415  if (size == 0) return false;
3416 
3417  for (size_t i = 0; i < size - 1; i++) {
3418  for (size_t j = i + 1; j < size; j++) {
3419  if (layout[i].ti.x == layout[j].ti.x &&
3420  layout[i].ti.y == layout[j].ti.y) {
3421  return false;
3422  }
3423  }
3424  }
3425 
3426  bool have_regular_tile = false;
3427  for (size_t i = 0; i < size; i++) {
3428  if (layout[i].gfx != GFX_WATERTILE_SPECIALCHECK) {
3429  have_regular_tile = true;
3430  break;
3431  }
3432  }
3433 
3434  return have_regular_tile;
3435 }
3436 
3445 static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, ByteReader *buf)
3446 {
3448 
3449  if (indid + numinfo > NUM_INDUSTRYTYPES_PER_GRF) {
3450  grfmsg(1, "IndustriesChangeInfo: Too many industries loaded (%u), max (%u). Ignoring.", indid + numinfo, NUM_INDUSTRYTYPES_PER_GRF);
3451  return CIR_INVALID_ID;
3452  }
3453 
3454  /* Allocate industry specs if they haven't been allocated already. */
3455  if (_cur.grffile->industryspec == nullptr) {
3456  _cur.grffile->industryspec = CallocT<IndustrySpec*>(NUM_INDUSTRYTYPES_PER_GRF);
3457  }
3458 
3459  for (int i = 0; i < numinfo; i++) {
3460  IndustrySpec *indsp = _cur.grffile->industryspec[indid + i];
3461 
3462  if (prop != 0x08 && indsp == nullptr) {
3463  ChangeInfoResult cir = IgnoreIndustryProperty(prop, buf);
3464  if (cir > ret) ret = cir;
3465  continue;
3466  }
3467 
3468  switch (prop) {
3469  case 0x08: { // Substitute industry type
3470  IndustrySpec **indspec = &_cur.grffile->industryspec[indid + i];
3471  byte subs_id = buf->ReadByte();
3472 
3473  if (subs_id == 0xFF) {
3474  /* Instead of defining a new industry, a substitute industry id
3475  * of 0xFF disables the old industry with the current id. */
3476  _industry_specs[indid + i].enabled = false;
3477  continue;
3478  } else if (subs_id >= NEW_INDUSTRYOFFSET) {
3479  /* The substitute id must be one of the original industry. */
3480  grfmsg(2, "_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i);
3481  continue;
3482  }
3483 
3484  /* Allocate space for this industry.
3485  * Only need to do it once. If ever it is called again, it should not
3486  * do anything */
3487  if (*indspec == nullptr) {
3488  *indspec = new IndustrySpec;
3489  indsp = *indspec;
3490 
3491  *indsp = _origin_industry_specs[subs_id];
3492  indsp->enabled = true;
3493  indsp->grf_prop.local_id = indid + i;
3494  indsp->grf_prop.subst_id = subs_id;
3495  indsp->grf_prop.grffile = _cur.grffile;
3496  /* If the grf industry needs to check its surrounding upon creation, it should
3497  * rely on callbacks, not on the original placement functions */
3498  indsp->check_proc = CHECK_NOTHING;
3499  }
3500  break;
3501  }
3502 
3503  case 0x09: { // Industry type override
3504  byte ovrid = buf->ReadByte();
3505 
3506  /* The industry being overridden must be an original industry. */
3507  if (ovrid >= NEW_INDUSTRYOFFSET) {
3508  grfmsg(2, "IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i);
3509  continue;
3510  }
3511  indsp->grf_prop.override = ovrid;
3512  _industry_mngr.Add(indid + i, _cur.grffile->grfid, ovrid);
3513  break;
3514  }
3515 
3516  case 0x0A: { // Set industry layout(s)
3517  byte new_num_layouts = buf->ReadByte();
3518  uint32 definition_size = buf->ReadDWord();
3519  uint32 bytes_read = 0;
3520  std::vector<IndustryTileLayout> new_layouts;
3521  IndustryTileLayout layout;
3522 
3523  for (byte j = 0; j < new_num_layouts; j++) {
3524  layout.clear();
3525 
3526  for (uint k = 0;; k++) {
3527  if (bytes_read >= definition_size) {
3528  grfmsg(3, "IndustriesChangeInfo: Incorrect size for industry tile layout definition for industry %u.", indid);
3529  /* Avoid warning twice */
3530  definition_size = UINT32_MAX;
3531  }
3532 
3533  layout.push_back(IndustryTileLayoutTile{});
3534  IndustryTileLayoutTile &it = layout.back();
3535 
3536  it.ti.x = buf->ReadByte(); // Offsets from northermost tile
3537  ++bytes_read;
3538 
3539  if (it.ti.x == 0xFE && k == 0) {
3540  /* This means we have to borrow the layout from an old industry */
3541  IndustryType type = buf->ReadByte();
3542  byte laynbr = buf->ReadByte();
3543  bytes_read += 2;
3544 
3545  if (type >= lengthof(_origin_industry_specs)) {
3546  grfmsg(1, "IndustriesChangeInfo: Invalid original industry number for layout import, industry %u", indid);
3547  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
3548  return CIR_DISABLED;
3549  }
3550  if (laynbr >= _origin_industry_specs[type].layouts.size()) {
3551  grfmsg(1, "IndustriesChangeInfo: Invalid original industry layout index for layout import, industry %u", indid);
3552  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
3553  return CIR_DISABLED;
3554  }
3555  layout = _origin_industry_specs[type].layouts[laynbr];
3556  break;
3557  }
3558 
3559  it.ti.y = buf->ReadByte(); // Or table definition finalisation
3560  ++bytes_read;
3561 
3562  if (it.ti.x == 0 && it.ti.y == 0x80) {
3563  /* Terminator, remove and finish up */
3564  layout.pop_back();
3565  break;
3566  }
3567 
3568  it.gfx = buf->ReadByte();
3569  ++bytes_read;
3570 
3571  if (it.gfx == 0xFE) {
3572  /* Use a new tile from this GRF */
3573  int local_tile_id = buf->ReadWord();
3574  bytes_read += 2;
3575 
3576  /* Read the ID from the _industile_mngr. */
3577  int tempid = _industile_mngr.GetID(local_tile_id, _cur.grffile->grfid);
3578 
3579  if (tempid == INVALID_INDUSTRYTILE) {
3580  grfmsg(2, "IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid);
3581  } else {
3582  /* Declared as been valid, can be used */
3583  it.gfx = tempid;
3584  }
3585  } else if (it.gfx == GFX_WATERTILE_SPECIALCHECK) {
3586  it.ti.x = (int8)GB(it.ti.x, 0, 8);
3587  it.ti.y = (int8)GB(it.ti.y, 0, 8);
3588 
3589  /* When there were only 256x256 maps, TileIndex was a uint16 and
3590  * it.ti was just a TileIndexDiff that was added to it.
3591  * As such negative "x" values were shifted into the "y" position.
3592  * x = -1, y = 1 -> x = 255, y = 0
3593  * Since GRF version 8 the position is interpreted as pair of independent int8.
3594  * For GRF version < 8 we need to emulate the old shifting behaviour.
3595  */
3596  if (_cur.grffile->grf_version < 8 && it.ti.x < 0) it.ti.y += 1;
3597  }
3598  }
3599 
3600  if (!ValidateIndustryLayout(layout)) {
3601  /* The industry layout was not valid, so skip this one. */
3602  grfmsg(1, "IndustriesChangeInfo: Invalid industry layout for industry id %u. Ignoring", indid);
3603  new_num_layouts--;
3604  j--;
3605  } else {
3606  new_layouts.push_back(layout);
3607  }
3608  }
3609 
3610  /* Install final layout construction in the industry spec */
3611  indsp->layouts = new_layouts;
3612  break;
3613  }
3614 
3615  case 0x0B: // Industry production flags
3616  indsp->life_type = (IndustryLifeType)buf->ReadByte();
3617  break;
3618 
3619  case 0x0C: // Industry closure message
3620  AddStringForMapping(buf->ReadWord(), &indsp->closure_text);
3621  break;
3622 
3623  case 0x0D: // Production increase message
3624  AddStringForMapping(buf->ReadWord(), &indsp->production_up_text);
3625  break;
3626 
3627  case 0x0E: // Production decrease message
3628  AddStringForMapping(buf->ReadWord(), &indsp->production_down_text);
3629  break;
3630 
3631  case 0x0F: // Fund cost multiplier
3632  indsp->cost_multiplier = buf->ReadByte();
3633  break;
3634 
3635  case 0x10: // Production cargo types
3636  for (byte j = 0; j < 2; j++) {
3637  indsp->produced_cargo[j] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3638  }
3639  break;
3640 
3641  case 0x11: // Acceptance cargo types
3642  for (byte j = 0; j < 3; j++) {
3643  indsp->accepts_cargo[j] = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3644  }
3645  buf->ReadByte(); // Unnused, eat it up
3646  break;
3647 
3648  case 0x12: // Production multipliers
3649  case 0x13:
3650  indsp->production_rate[prop - 0x12] = buf->ReadByte();
3651  break;
3652 
3653  case 0x14: // Minimal amount of cargo distributed
3654  indsp->minimal_cargo = buf->ReadByte();
3655  break;
3656 
3657  case 0x15: { // Random sound effects
3658  indsp->number_of_sounds = buf->ReadByte();
3659  uint8 *sounds = MallocT<uint8>(indsp->number_of_sounds);
3660 
3661  try {
3662  for (uint8 j = 0; j < indsp->number_of_sounds; j++) {
3663  sounds[j] = buf->ReadByte();
3664  }
3665  } catch (...) {
3666  free(sounds);
3667  throw;
3668  }
3669 
3670  if (HasBit(indsp->cleanup_flag, CLEAN_RANDOMSOUNDS)) {
3671  free(indsp->random_sounds);
3672  }
3673  indsp->random_sounds = sounds;
3675  break;
3676  }
3677 
3678  case 0x16: // Conflicting industry types
3679  for (byte j = 0; j < 3; j++) indsp->conflicting[j] = buf->ReadByte();
3680  break;
3681 
3682  case 0x17: // Probability in random game
3683  indsp->appear_creation[_settings_game.game_creation.landscape] = buf->ReadByte();
3684  break;
3685 
3686  case 0x18: // Probability during gameplay
3687  indsp->appear_ingame[_settings_game.game_creation.landscape] = buf->ReadByte();
3688  break;
3689 
3690  case 0x19: // Map colour
3691  indsp->map_colour = buf->ReadByte();
3692  break;
3693 
3694  case 0x1A: // Special industry flags to define special behavior
3695  indsp->behaviour = (IndustryBehaviour)buf->ReadDWord();
3696  break;
3697 
3698  case 0x1B: // New industry text ID
3699  AddStringForMapping(buf->ReadWord(), &indsp->new_industry_text);
3700  break;
3701 
3702  case 0x1C: // Input cargo multipliers for the three input cargo types
3703  case 0x1D:
3704  case 0x1E: {
3705  uint32 multiples = buf->ReadDWord();
3706  indsp->input_cargo_multiplier[prop - 0x1C][0] = GB(multiples, 0, 16);
3707  indsp->input_cargo_multiplier[prop - 0x1C][1] = GB(multiples, 16, 16);
3708  break;
3709  }
3710 
3711  case 0x1F: // Industry name
3712  AddStringForMapping(buf->ReadWord(), &indsp->name);
3713  break;
3714 
3715  case 0x20: // Prospecting success chance
3716  indsp->prospecting_chance = buf->ReadDWord();
3717  break;
3718 
3719  case 0x21: // Callback mask
3720  case 0x22: { // Callback additional mask
3721  byte aflag = buf->ReadByte();
3722  SB(indsp->callback_mask, (prop - 0x21) * 8, 8, aflag);
3723  break;
3724  }
3725 
3726  case 0x23: // removal cost multiplier
3727  indsp->removal_cost_multiplier = buf->ReadDWord();
3728  break;
3729 
3730  case 0x24: { // name for nearby station
3731  uint16 str = buf->ReadWord();
3732  if (str == 0) {
3733  indsp->station_name = STR_NULL;
3734  } else {
3735  AddStringForMapping(str, &indsp->station_name);
3736  }
3737  break;
3738  }
3739 
3740  case 0x25: { // variable length produced cargoes
3741  byte num_cargoes = buf->ReadByte();
3742  if (num_cargoes > lengthof(indsp->produced_cargo)) {
3743  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3744  error->param_value[1] = prop;
3745  return CIR_DISABLED;
3746  }
3747  for (uint i = 0; i < lengthof(indsp->produced_cargo); i++) {
3748  if (i < num_cargoes) {
3749  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3750  indsp->produced_cargo[i] = cargo;
3751  } else {
3752  indsp->produced_cargo[i] = CT_INVALID;
3753  }
3754  }
3755  break;
3756  }
3757 
3758  case 0x26: { // variable length accepted cargoes
3759  byte num_cargoes = buf->ReadByte();
3760  if (num_cargoes > lengthof(indsp->accepts_cargo)) {
3761  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3762  error->param_value[1] = prop;
3763  return CIR_DISABLED;
3764  }
3765  for (uint i = 0; i < lengthof(indsp->accepts_cargo); i++) {
3766  if (i < num_cargoes) {
3767  CargoID cargo = GetCargoTranslation(buf->ReadByte(), _cur.grffile);
3768  indsp->accepts_cargo[i] = cargo;
3769  } else {
3770  indsp->accepts_cargo[i] = CT_INVALID;
3771  }
3772  }
3773  break;
3774  }
3775 
3776  case 0x27: { // variable length production rates
3777  byte num_cargoes = buf->ReadByte();
3778  if (num_cargoes > lengthof(indsp->production_rate)) {
3779  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3780  error->param_value[1] = prop;
3781  return CIR_DISABLED;
3782  }
3783  for (uint i = 0; i < lengthof(indsp->production_rate); i++) {
3784  if (i < num_cargoes) {
3785  indsp->production_rate[i] = buf->ReadByte();
3786  } else {
3787  indsp->production_rate[i] = 0;
3788  }
3789  }
3790  break;
3791  }
3792 
3793  case 0x28: { // variable size input/output production multiplier table
3794  byte num_inputs = buf->ReadByte();
3795  byte num_outputs = buf->ReadByte();
3796  if (num_inputs > lengthof(indsp->accepts_cargo) || num_outputs > lengthof(indsp->produced_cargo)) {
3797  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LIST_PROPERTY_TOO_LONG);
3798  error->param_value[1] = prop;
3799  return CIR_DISABLED;
3800  }
3801  for (uint i = 0; i < lengthof(indsp->accepts_cargo); i++) {
3802  for (uint j = 0; j < lengthof(indsp->produced_cargo); j++) {
3803  uint16 mult = 0;
3804  if (i < num_inputs && j < num_outputs) mult = buf->ReadWord();
3805  indsp->input_cargo_multiplier[i][j] = mult;
3806  }
3807  }
3808  break;
3809  }
3810 
3811  default:
3812  ret = CIR_UNKNOWN;
3813  break;
3814  }
3815  }
3816 
3817  return ret;
3818 }
3819 
3826 {
3827  AirportTileTable **table_list = MallocT<AirportTileTable*>(as->num_table);
3828  for (int i = 0; i < as->num_table; i++) {
3829  uint num_tiles = 1;
3830  const AirportTileTable *it = as->table[0];
3831  do {
3832  num_tiles++;
3833  } while ((++it)->ti.x != -0x80);
3834  table_list[i] = MallocT<AirportTileTable>(num_tiles);
3835  MemCpyT(table_list[i], as->table[i], num_tiles);
3836  }
3837  as->table = table_list;
3838  HangarTileTable *depot_table = MallocT<HangarTileTable>(as->nof_depots);
3839  MemCpyT(depot_table, as->depot_table, as->nof_depots);
3840  as->depot_table = depot_table;
3841  Direction *rotation = MallocT<Direction>(as->num_table);
3842  MemCpyT(rotation, as->rotation, as->num_table);
3843  as->rotation = rotation;
3844 }
3845 
3854 static ChangeInfoResult AirportChangeInfo(uint airport, int numinfo, int prop, ByteReader *buf)
3855 {
3857 
3858  if (airport + numinfo > NUM_AIRPORTS_PER_GRF) {
3859  grfmsg(1, "AirportChangeInfo: Too many airports, trying id (%u), max (%u). Ignoring.", airport + numinfo, NUM_AIRPORTS_PER_GRF);
3860  return CIR_INVALID_ID;
3861  }
3862 
3863  /* Allocate industry specs if they haven't been allocated already. */
3864  if (_cur.grffile->airportspec == nullptr) {
3865  _cur.grffile->airportspec = CallocT<AirportSpec*>(NUM_AIRPORTS_PER_GRF);
3866  }
3867 
3868  for (int i = 0; i < numinfo; i++) {
3869  AirportSpec *as = _cur.grffile->airportspec[airport + i];
3870 
3871  if (as == nullptr && prop != 0x08 && prop != 0x09) {
3872  grfmsg(2, "AirportChangeInfo: Attempt to modify undefined airport %u, ignoring", airport + i);
3873  return CIR_INVALID_ID;
3874  }
3875 
3876  switch (prop) {
3877  case 0x08: { // Modify original airport
3878  byte subs_id = buf->ReadByte();
3879 
3880  if (subs_id == 0xFF) {
3881  /* Instead of defining a new airport, an airport id
3882  * of 0xFF disables the old airport with the current id. */
3883  AirportSpec::GetWithoutOverride(airport + i)->enabled = false;
3884  continue;
3885  } else if (subs_id >= NEW_AIRPORT_OFFSET) {
3886  /* The substitute id must be one of the original airports. */
3887  grfmsg(2, "AirportChangeInfo: Attempt to use new airport %u as substitute airport for %u. Ignoring.", subs_id, airport + i);
3888  continue;
3889  }
3890 
3891  AirportSpec **spec = &_cur.grffile->airportspec[airport + i];
3892  /* Allocate space for this airport.
3893  * Only need to do it once. If ever it is called again, it should not
3894  * do anything */
3895  if (*spec == nullptr) {
3896  *spec = MallocT<AirportSpec>(1);
3897  as = *spec;
3898 
3899  memcpy(as, AirportSpec::GetWithoutOverride(subs_id), sizeof(*as));
3900  as->enabled = true;
3901  as->grf_prop.local_id = airport + i;
3902  as->grf_prop.subst_id = subs_id;
3903  as->grf_prop.grffile = _cur.grffile;
3904  /* override the default airport */
3905  _airport_mngr.Add(airport + i, _cur.grffile->grfid, subs_id);
3906  /* Create a copy of the original tiletable so it can be freed later. */
3907  DuplicateTileTable(as);
3908  }
3909  break;
3910  }
3911 
3912  case 0x0A: { // Set airport layout
3913  byte old_num_table = as->num_table;
3914  free(as->rotation);
3915  as->num_table = buf->ReadByte(); // Number of layaouts
3916  as->rotation = MallocT<Direction>(as->num_table);
3917  uint32 defsize = buf->ReadDWord(); // Total size of the definition
3918  AirportTileTable **tile_table = CallocT<AirportTileTable*>(as->num_table); // Table with tiles to compose the airport
3919  AirportTileTable *att = CallocT<AirportTileTable>(defsize); // Temporary array to read the tile layouts from the GRF
3920  int size;
3921  const AirportTileTable *copy_from;
3922  try {
3923  for (byte j = 0; j < as->num_table; j++) {
3924  const_cast<Direction&>(as->rotation[j]) = (Direction)buf->ReadByte();
3925  for (int k = 0;; k++) {
3926  att[k].ti.x = buf->ReadByte(); // Offsets from northermost tile
3927  att[k].ti.y = buf->ReadByte();
3928 
3929  if (att[k].ti.x == 0 && att[k].ti.y == 0x80) {
3930  /* Not the same terminator. The one we are using is rather
3931  * x = -80, y = 0 . So, adjust it. */
3932  att[k].ti.x = -0x80;
3933  att[k].ti.y = 0;
3934  att[k].gfx = 0;
3935 
3936  size = k + 1;
3937  copy_from = att;
3938  break;
3939  }
3940 
3941  att[k].gfx = buf->ReadByte();
3942 
3943  if (att[k].gfx == 0xFE) {
3944  /* Use a new tile from this GRF */
3945  int local_tile_id = buf->ReadWord();
3946 
3947  /* Read the ID from the _airporttile_mngr. */
3948  uint16 tempid = _airporttile_mngr.GetID(local_tile_id, _cur.grffile->grfid);
3949 
3950  if (tempid == INVALID_AIRPORTTILE) {
3951  grfmsg(2, "AirportChangeInfo: Attempt to use airport tile %u with airport id %u, not yet defined. Ignoring.", local_tile_id, airport + i);
3952  } else {
3953  /* Declared as been valid, can be used */
3954  att[k].gfx = tempid;
3955  }
3956  } else if (att[k].gfx == 0xFF) {
3957  att[k].ti.x = (int8)GB(att[k].ti.x, 0, 8);
3958  att[k].ti.y = (int8)GB(att[k].ti.y, 0, 8);
3959  }
3960 
3961  if (as->rotation[j] == DIR_E || as->rotation[j] == DIR_W) {
3962  as->size_x = std::max<byte>(as->size_x, att[k].ti.y + 1);
3963  as->size_y = std::max<byte>(as->size_y, att[k].ti.x + 1);
3964  } else {
3965  as->size_x = std::max<byte>(as->size_x, att[k].ti.x + 1);
3966  as->size_y = std::max<byte>(as->size_y, att[k].ti.y + 1);
3967  }
3968  }
3969  tile_table[j] = CallocT<AirportTileTable>(size);
3970  memcpy(tile_table[j], copy_from, sizeof(*copy_from) * size);
3971  }
3972  /* Free old layouts in the airport spec */
3973  for (int j = 0; j < old_num_table; j++) {
3974  /* remove the individual layouts */
3975  free(as->table[j]);
3976  }
3977  free(as->table);
3978  /* Install final layout construction in the airport spec */
3979  as->table = tile_table;
3980  free(att);
3981  } catch (...) {
3982  for (int i = 0; i < as->num_table; i++) {
3983  free(tile_table[i]);
3984  }
3985  free(tile_table);
3986  free(att);
3987  throw;
3988  }
3989  break;
3990  }
3991 
3992  case 0x0C:
3993  as->min_year = buf->ReadWord();
3994  as->max_year = buf->ReadWord();
3995  if (as->max_year == 0xFFFF) as->max_year = MAX_YEAR;
3996  break;
3997 
3998  case 0x0D:
3999  as->ttd_airport_type = (TTDPAirportType)buf->ReadByte();
4000  break;
4001 
4002  case 0x0E:
4003  as->catchment = Clamp(buf->ReadByte(), 1, MAX_CATCHMENT);
4004  break;
4005 
4006  case 0x0F:
4007  as->noise_level = buf->ReadByte();
4008  break;
4009 
4010  case 0x10:
4011  AddStringForMapping(buf->ReadWord(), &as->name);
4012  break;
4013 
4014  case 0x11: // Maintenance cost factor
4015  as->maintenance_cost = buf->ReadWord();
4016  break;
4017 
4018  default:
4019  ret = CIR_UNKNOWN;
4020  break;
4021  }
4022  }
4023 
4024  return ret;
4025 }
4026 
4034 {
4036 
4037  switch (prop) {
4038  case 0x0B:
4039  case 0x0C:
4040  case 0x0D:
4041  case 0x12:
4042  case 0x14:
4043  case 0x16:
4044  case 0x17:
4045  buf->ReadByte();
4046  break;
4047 
4048  case 0x09:
4049  case 0x0A:
4050  case 0x10:
4051  case 0x11:
4052  case 0x13:
4053  case 0x15:
4054  buf->ReadWord();
4055  break;
4056 
4057  case 0x08:
4058  case 0x0E:
4059  case 0x0F:
4060  buf->ReadDWord();
4061  break;
4062 
4063  default:
4064  ret = CIR_UNKNOWN;
4065  break;
4066  }
4067 
4068  return ret;
4069 }
4070 
4079 static ChangeInfoResult ObjectChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4080 {
4082 
4083  if (id + numinfo > NUM_OBJECTS_PER_GRF) {
4084  grfmsg(1, "ObjectChangeInfo: Too many objects loaded (%u), max (%u). Ignoring.", id + numinfo, NUM_OBJECTS_PER_GRF);
4085  return CIR_INVALID_ID;
4086  }
4087 
4088  /* Allocate object specs if they haven't been allocated already. */
4089  if (_cur.grffile->objectspec == nullptr) {
4090  _cur.grffile->objectspec = CallocT<ObjectSpec*>(NUM_OBJECTS_PER_GRF);
4091  }
4092 
4093  for (int i = 0; i < numinfo; i++) {
4094  ObjectSpec *spec = _cur.grffile->objectspec[id + i];
4095 
4096  if (prop != 0x08 && spec == nullptr) {
4097  /* If the object property 08 is not yet set, ignore this property */
4098  ChangeInfoResult cir = IgnoreObjectProperty(prop, buf);
4099  if (cir > ret) ret = cir;
4100  continue;
4101  }
4102 
4103  switch (prop) {
4104  case 0x08: { // Class ID
4105  ObjectSpec **ospec = &_cur.grffile->objectspec[id + i];
4106 
4107  /* Allocate space for this object. */
4108  if (*ospec == nullptr) {
4109  *ospec = CallocT<ObjectSpec>(1);
4110  (*ospec)->views = 1; // Default for NewGRFs that don't set it.
4111  (*ospec)->size = OBJECT_SIZE_1X1; // Default for NewGRFs that manage to not set it (1x1)
4112  }
4113 
4114  /* Swap classid because we read it in BE. */
4115  uint32 classid = buf->ReadDWord();
4116  (*ospec)->cls_id = ObjectClass::Allocate(BSWAP32(classid));
4117  (*ospec)->enabled = true;
4118  break;
4119  }
4120 
4121  case 0x09: { // Class name
4122  ObjectClass *objclass = ObjectClass::Get(spec->cls_id);
4123  AddStringForMapping(buf->ReadWord(), &objclass->name);
4124  break;
4125  }
4126 
4127  case 0x0A: // Object name
4128  AddStringForMapping(buf->ReadWord(), &spec->name);
4129  break;
4130 
4131  case 0x0B: // Climate mask
4132  spec->climate = buf->ReadByte();
4133  break;
4134 
4135  case 0x0C: // Size
4136  spec->size = buf->ReadByte();
4137  if (GB(spec->size, 0, 4) == 0 || GB(spec->size, 4, 4) == 0) {
4138  grfmsg(0, "ObjectChangeInfo: Invalid object size requested (0x%x) for object id %u. Ignoring.", spec->size, id + i);
4139  spec->size = OBJECT_SIZE_1X1;
4140  }
4141  break;
4142 
4143  case 0x0D: // Build cost multipler
4144  spec->build_cost_multiplier = buf->ReadByte();
4146  break;
4147 
4148  case 0x0E: // Introduction date
4149  spec->introduction_date = buf->ReadDWord();
4150  break;
4151 
4152  case 0x0F: // End of life
4153  spec->end_of_life_date = buf->ReadDWord();
4154  break;
4155 
4156  case 0x10: // Flags
4157  spec->flags = (ObjectFlags)buf->ReadWord();
4159  break;
4160 
4161  case 0x11: // Animation info
4162  spec->animation.frames = buf->ReadByte();
4163  spec->animation.status = buf->ReadByte();
4164  break;
4165 
4166  case 0x12: // Animation speed
4167  spec->animation.speed = buf->ReadByte();
4168  break;
4169 
4170  case 0x13: // Animation triggers
4171  spec->animation.triggers = buf->ReadWord();
4172  break;
4173 
4174  case 0x14: // Removal cost multiplier
4175  spec->clear_cost_multiplier = buf->ReadByte();
4176  break;
4177 
4178  case 0x15: // Callback mask
4179  spec->callback_mask = buf->ReadWord();
4180  break;
4181 
4182  case 0x16: // Building height
4183  spec->height = buf->ReadByte();
4184  break;
4185 
4186  case 0x17: // Views
4187  spec->views = buf->ReadByte();
4188  if (spec->views != 1 && spec->views != 2 && spec->views != 4) {
4189  grfmsg(2, "ObjectChangeInfo: Invalid number of views (%u) for object id %u. Ignoring.", spec->views, id + i);
4190  spec->views = 1;
4191  }
4192  break;
4193 
4194  case 0x18: // Amount placed on 256^2 map on map creation
4195  spec->generate_amount = buf->ReadByte();
4196  break;
4197 
4198  default:
4199  ret = CIR_UNKNOWN;
4200  break;
4201  }
4202  }
4203 
4204  return ret;
4205 }
4206 
4215 static ChangeInfoResult RailTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4216 {
4218 
4219  extern RailtypeInfo _railtypes[RAILTYPE_END];
4220 
4221  if (id + numinfo > RAILTYPE_END) {
4222  grfmsg(1, "RailTypeChangeInfo: Rail type %u is invalid, max %u, ignoring", id + numinfo, RAILTYPE_END);
4223  return CIR_INVALID_ID;
4224  }
4225 
4226  for (int i = 0; i < numinfo; i++) {
4227  RailType rt = _cur.grffile->railtype_map[id + i];
4228  if (rt == INVALID_RAILTYPE) return CIR_INVALID_ID;
4229 
4230  RailtypeInfo *rti = &_railtypes[rt];
4231 
4232  switch (prop) {
4233  case 0x08: // Label of rail type
4234  /* Skipped here as this is loaded during reservation stage. */
4235  buf->ReadDWord();
4236  break;
4237 
4238  case 0x09: { // Toolbar caption of railtype (sets name as well for backwards compatibility for grf ver < 8)
4239  uint16 str = buf->ReadWord();
4241  if (_cur.grffile->grf_version < 8) {
4242  AddStringForMapping(str, &rti->strings.name);
4243  }
4244  break;
4245  }
4246 
4247  case 0x0A: // Menu text of railtype
4248  AddStringForMapping(buf->ReadWord(), &rti->strings.menu_text);
4249  break;
4250 
4251  case 0x0B: // Build window caption
4252  AddStringForMapping(buf->ReadWord(), &rti->strings.build_caption);
4253  break;
4254 
4255  case 0x0C: // Autoreplace text
4256  AddStringForMapping(buf->ReadWord(), &rti->strings.replace_text);
4257  break;
4258 
4259  case 0x0D: // New locomotive text
4260  AddStringForMapping(buf->ReadWord(), &rti->strings.new_loco);
4261  break;
4262 
4263  case 0x0E: // Compatible railtype list
4264  case 0x0F: // Powered railtype list
4265  case 0x18: // Railtype list required for date introduction
4266  case 0x19: // Introduced railtype list
4267  {
4268  /* Rail type compatibility bits are added to the existing bits
4269  * to allow multiple GRFs to modify compatibility with the
4270  * default rail types. */
4271  int n = buf->ReadByte();
4272  for (int j = 0; j != n; j++) {
4273  RailTypeLabel label = buf->ReadDWord();
4274  RailType rt = GetRailTypeByLabel(BSWAP32(label), false);
4275  if (rt != INVALID_RAILTYPE) {
4276  switch (prop) {
4277  case 0x0F: SetBit(rti->powered_railtypes, rt); FALLTHROUGH; // Powered implies compatible.
4278  case 0x0E: SetBit(rti->compatible_railtypes, rt); break;
4279  case 0x18: SetBit(rti->introduction_required_railtypes, rt); break;
4280  case 0x19: SetBit(rti->introduces_railtypes, rt); break;
4281  }
4282  }
4283  }
4284  break;
4285  }
4286 
4287  case 0x10: // Rail Type flags
4288  rti->flags = (RailTypeFlags)buf->ReadByte();
4289  break;
4290 
4291  case 0x11: // Curve speed advantage
4292  rti->curve_speed = buf->ReadByte();
4293  break;
4294 
4295  case 0x12: // Station graphic
4296  rti->fallback_railtype = Clamp(buf->ReadByte(), 0, 2);
4297  break;
4298 
4299  case 0x13: // Construction cost factor
4300  rti->cost_multiplier = buf->ReadWord();
4301  break;
4302 
4303  case 0x14: // Speed limit
4304  rti->max_speed = buf->ReadWord();
4305  break;
4306 
4307  case 0x15: // Acceleration model
4308  rti->acceleration_type = Clamp(buf->ReadByte(), 0, 2);
4309  break;
4310 
4311  case 0x16: // Map colour
4312  rti->map_colour = buf->ReadByte();
4313  break;
4314 
4315  case 0x17: // Introduction date
4316  rti->introduction_date = buf->ReadDWord();
4317  break;
4318 
4319  case 0x1A: // Sort order
4320  rti->sorting_order = buf->ReadByte();
4321  break;
4322 
4323  case 0x1B: // Name of railtype (overridden by prop 09 for grf ver < 8)
4324  AddStringForMapping(buf->ReadWord(), &rti->strings.name);
4325  break;
4326 
4327  case 0x1C: // Maintenance cost factor
4328  rti->maintenance_multiplier = buf->ReadWord();
4329  break;
4330 
4331  case 0x1D: // Alternate rail type label list
4332  /* Skipped here as this is loaded during reservation stage. */
4333  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4334  break;
4335 
4336  default:
4337  ret = CIR_UNKNOWN;
4338  break;
4339  }
4340  }
4341 
4342  return ret;
4343 }
4344 
4345 static ChangeInfoResult RailTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4346 {
4348 
4349  extern RailtypeInfo _railtypes[RAILTYPE_END];
4350 
4351  if (id + numinfo > RAILTYPE_END) {
4352  grfmsg(1, "RailTypeReserveInfo: Rail type %u is invalid, max %u, ignoring", id + numinfo, RAILTYPE_END);
4353  return CIR_INVALID_ID;
4354  }
4355 
4356  for (int i = 0; i < numinfo; i++) {
4357  switch (prop) {
4358  case 0x08: // Label of rail type
4359  {
4360  RailTypeLabel rtl = buf->ReadDWord();
4361  rtl = BSWAP32(rtl);
4362 
4363  RailType rt = GetRailTypeByLabel(rtl, false);
4364  if (rt == INVALID_RAILTYPE) {
4365  /* Set up new rail type */
4366  rt = AllocateRailType(rtl);
4367  }
4368 
4369  _cur.grffile->railtype_map[id + i] = rt;
4370  break;
4371  }
4372 
4373  case 0x09: // Toolbar caption of railtype
4374  case 0x0A: // Menu text
4375  case 0x0B: // Build window caption
4376  case 0x0C: // Autoreplace text
4377  case 0x0D: // New loco
4378  case 0x13: // Construction cost
4379  case 0x14: // Speed limit
4380  case 0x1B: // Name of railtype
4381  case 0x1C: // Maintenance cost factor
4382  buf->ReadWord();
4383  break;
4384 
4385  case 0x1D: // Alternate rail type label list
4386  if (_cur.grffile->railtype_map[id + i] != INVALID_RAILTYPE) {
4387  int n = buf->ReadByte();
4388  for (int j = 0; j != n; j++) {
4389  _railtypes[_cur.grffile->railtype_map[id + i]].alternate_labels.push_back(BSWAP32(buf->ReadDWord()));
4390  }
4391  break;
4392  }
4393  grfmsg(1, "RailTypeReserveInfo: Ignoring property 1D for rail type %u because no label was set", id + i);
4394  FALLTHROUGH;
4395 
4396  case 0x0E: // Compatible railtype list
4397  case 0x0F: // Powered railtype list
4398  case 0x18: // Railtype list required for date introduction
4399  case 0x19: // Introduced railtype list
4400  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4401  break;
4402 
4403  case 0x10: // Rail Type flags
4404  case 0x11: // Curve speed advantage
4405  case 0x12: // Station graphic
4406  case 0x15: // Acceleration model
4407  case 0x16: // Map colour
4408  case 0x1A: // Sort order
4409  buf->ReadByte();
4410  break;
4411 
4412  case 0x17: // Introduction date
4413  buf->ReadDWord();
4414  break;
4415 
4416  default:
4417  ret = CIR_UNKNOWN;
4418  break;
4419  }
4420  }
4421 
4422  return ret;
4423 }
4424 
4433 static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
4434 {
4436 
4437  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
4438  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
4439 
4440  if (id + numinfo > ROADTYPE_END) {
4441  grfmsg(1, "RoadTypeChangeInfo: Road type %u is invalid, max %u, ignoring", id + numinfo, ROADTYPE_END);
4442  return CIR_INVALID_ID;
4443  }
4444 
4445  for (int i = 0; i < numinfo; i++) {
4446  RoadType rt = type_map[id + i];
4447  if (rt == INVALID_ROADTYPE) return CIR_INVALID_ID;
4448 
4449  RoadTypeInfo *rti = &_roadtypes[rt];
4450 
4451  switch (prop) {
4452  case 0x08: // Label of road type
4453  /* Skipped here as this is loaded during reservation stage. */
4454  buf->ReadDWord();
4455  break;
4456 
4457  case 0x09: { // Toolbar caption of roadtype (sets name as well for backwards compatibility for grf ver < 8)
4458  uint16 str = buf->ReadWord();
4460  break;
4461  }
4462 
4463  case 0x0A: // Menu text of roadtype
4464  AddStringForMapping(buf->ReadWord(), &rti->strings.menu_text);
4465  break;
4466 
4467  case 0x0B: // Build window caption
4468  AddStringForMapping(buf->ReadWord(), &rti->strings.build_caption);
4469  break;
4470 
4471  case 0x0C: // Autoreplace text
4472  AddStringForMapping(buf->ReadWord(), &rti->strings.replace_text);
4473  break;
4474 
4475  case 0x0D: // New engine text
4476  AddStringForMapping(buf->ReadWord(), &rti->strings.new_engine);
4477  break;
4478 
4479  case 0x0F: // Powered roadtype list
4480  case 0x18: // Roadtype list required for date introduction
4481  case 0x19: { // Introduced roadtype list
4482  /* Road type compatibility bits are added to the existing bits
4483  * to allow multiple GRFs to modify compatibility with the
4484  * default road types. */
4485  int n = buf->ReadByte();
4486  for (int j = 0; j != n; j++) {
4487  RoadTypeLabel label = buf->ReadDWord();
4488  RoadType rt = GetRoadTypeByLabel(BSWAP32(label), false);
4489  if (rt != INVALID_ROADTYPE) {
4490  switch (prop) {
4491  case 0x0F: SetBit(rti->powered_roadtypes, rt); break;
4492  case 0x18: SetBit(rti->introduction_required_roadtypes, rt); break;
4493  case 0x19: SetBit(rti->introduces_roadtypes, rt); break;
4494  }
4495  }
4496  }
4497  break;
4498  }
4499 
4500  case 0x10: // Road Type flags
4501  rti->flags = (RoadTypeFlags)buf->ReadByte();
4502  break;
4503 
4504  case 0x13: // Construction cost factor
4505  rti->cost_multiplier = buf->ReadWord();
4506  break;
4507 
4508  case 0x14: // Speed limit
4509  rti->max_speed = buf->ReadWord();
4510  break;
4511 
4512  case 0x16: // Map colour
4513  rti->map_colour = buf->ReadByte();
4514  break;
4515 
4516  case 0x17: // Introduction date
4517  rti->introduction_date = buf->ReadDWord();
4518  break;
4519 
4520  case 0x1A: // Sort order
4521  rti->sorting_order = buf->ReadByte();
4522  break;
4523 
4524  case 0x1B: // Name of roadtype
4525  AddStringForMapping(buf->ReadWord(), &rti->strings.name);
4526  break;
4527 
4528  case 0x1C: // Maintenance cost factor
4529  rti->maintenance_multiplier = buf->ReadWord();
4530  break;
4531 
4532  case 0x1D: // Alternate road type label list
4533  /* Skipped here as this is loaded during reservation stage. */
4534  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4535  break;
4536 
4537  default:
4538  ret = CIR_UNKNOWN;
4539  break;
4540  }
4541  }
4542 
4543  return ret;
4544 }
4545 
4546 static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4547 {
4548  return RoadTypeChangeInfo(id, numinfo, prop, buf, RTT_ROAD);
4549 }
4550 
4551 static ChangeInfoResult TramTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
4552 {
4553  return RoadTypeChangeInfo(id, numinfo, prop, buf, RTT_TRAM);
4554 }
4555 
4556 
4557 static ChangeInfoResult RoadTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
4558 {
4560 
4561  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
4562  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
4563 
4564  if (id + numinfo > ROADTYPE_END) {
4565  grfmsg(1, "RoadTypeReserveInfo: Road type %u is invalid, max %u, ignoring", id + numinfo, ROADTYPE_END);
4566  return CIR_INVALID_ID;
4567  }
4568 
4569  for (int i = 0; i < numinfo; i++) {
4570  switch (prop) {
4571  case 0x08: { // Label of road type
4572  RoadTypeLabel rtl = buf->ReadDWord();
4573  rtl = BSWAP32(rtl);
4574 
4575  RoadType rt = GetRoadTypeByLabel(rtl, false);
4576  if (rt == INVALID_ROADTYPE) {
4577  /* Set up new road type */
4578  rt = AllocateRoadType(rtl, rtt);
4579  } else if (GetRoadTramType(rt) != rtt) {
4580  grfmsg(1, "RoadTypeReserveInfo: Road type %u is invalid type (road/tram), ignoring", id + numinfo);
4581  return CIR_INVALID_ID;
4582  }
4583 
4584  type_map[id + i] = rt;
4585  break;
4586  }
4587  case 0x09: // Toolbar caption of roadtype
4588  case 0x0A: // Menu text
4589  case 0x0B: // Build window caption
4590  case 0x0C: // Autoreplace text
4591  case 0x0D: // New loco
4592  case 0x13: // Construction cost
4593  case 0x14: // Speed limit
4594  case 0x1B: // Name of roadtype
4595  case 0x1C: // Maintenance cost factor
4596  buf->ReadWord();
4597  break;
4598 
4599  case 0x1D: // Alternate road type label list
4600  if (type_map[id + i] != INVALID_ROADTYPE) {
4601  int n = buf->ReadByte();
4602  for (int j = 0; j != n; j++) {
4603  _roadtypes[type_map[id + i]].alternate_labels.push_back(BSWAP32(buf->ReadDWord()));
4604  }
4605  break;
4606  }
4607  grfmsg(1, "RoadTypeReserveInfo: Ignoring property 1D for road type %u because no label was set", id + i);
4608  /* FALL THROUGH */
4609 
4610  case 0x0F: // Powered roadtype list
4611  case 0x18: // Roadtype list required for date introduction
4612  case 0x19: // Introduced roadtype list
4613  for (int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4614  break;
4615 
4616  case 0x10: // Road Type flags
4617  case 0x16: // Map colour
4618  case 0x1A: // Sort order
4619  buf->ReadByte();
4620  break;
4621 
4622  case 0x17: // Introduction date
4623  buf->ReadDWord();
4624  break;
4625 
4626  default:
4627  ret = CIR_UNKNOWN;
4628  break;
4629  }
4630  }
4631 
4632  return ret;
4633 }
4634 
4635 static ChangeInfoResult RoadTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4636 {
4637  return RoadTypeReserveInfo(id, numinfo, prop, buf, RTT_ROAD);
4638 }
4639 
4640 static ChangeInfoResult TramTypeReserveInfo(uint id, int numinfo, int prop, ByteReader *buf)
4641 {
4642  return RoadTypeReserveInfo(id, numinfo, prop, buf, RTT_TRAM);
4643 }
4644 
4645 static ChangeInfoResult AirportTilesChangeInfo(uint airtid, int numinfo, int prop, ByteReader *buf)
4646 {
4648 
4649  if (airtid + numinfo > NUM_AIRPORTTILES_PER_GRF) {
4650  grfmsg(1, "AirportTileChangeInfo: Too many airport tiles loaded (%u), max (%u). Ignoring.", airtid + numinfo, NUM_AIRPORTTILES_PER_GRF);
4651  return CIR_INVALID_ID;
4652  }
4653 
4654  /* Allocate airport tile specs if they haven't been allocated already. */
4655  if (_cur.grffile->airtspec == nullptr) {
4656  _cur.grffile->airtspec = CallocT<AirportTileSpec*>(NUM_AIRPORTTILES_PER_GRF);
4657  }
4658 
4659  for (int i = 0; i < numinfo; i++) {
4660  AirportTileSpec *tsp = _cur.grffile->airtspec[airtid + i];
4661 
4662  if (prop != 0x08 && tsp == nullptr) {
4663  grfmsg(2, "AirportTileChangeInfo: Attempt to modify undefined airport tile %u. Ignoring.", airtid + i);
4664  return CIR_INVALID_ID;
4665  }
4666 
4667  switch (prop) {
4668  case 0x08: { // Substitute airport tile type
4669  AirportTileSpec **tilespec = &_cur.grffile->airtspec[airtid + i];
4670  byte subs_id = buf->ReadByte();
4671 
4672  if (subs_id >= NEW_AIRPORTTILE_OFFSET) {
4673  /* The substitute id must be one of the original airport tiles. */
4674  grfmsg(2, "AirportTileChangeInfo: Attempt to use new airport tile %u as substitute airport tile for %u. Ignoring.", subs_id, airtid + i);
4675  continue;
4676  }
4677 
4678  /* Allocate space for this airport tile. */
4679  if (*tilespec == nullptr) {
4680  *tilespec = CallocT<AirportTileSpec>(1);
4681  tsp = *tilespec;
4682 
4683  memcpy(tsp, AirportTileSpec::Get(subs_id), sizeof(AirportTileSpec));
4684  tsp->enabled = true;
4685 
4687 
4688  tsp->grf_prop.local_id = airtid + i;
4689  tsp->grf_prop.subst_id = subs_id;
4690  tsp->grf_prop.grffile = _cur.grffile;
4691  _airporttile_mngr.AddEntityID(airtid + i, _cur.grffile->grfid, subs_id); // pre-reserve the tile slot
4692  }
4693  break;
4694  }
4695 
4696  case 0x09: { // Airport tile override
4697  byte override = buf->ReadByte();
4698 
4699  /* The airport tile being overridden must be an original airport tile. */
4700  if (override >= NEW_AIRPORTTILE_OFFSET) {
4701  grfmsg(2, "AirportTileChangeInfo: Attempt to override new airport tile %u with airport tile id %u. Ignoring.", override, airtid + i);
4702  continue;
4703  }
4704 
4705  _airporttile_mngr.Add(airtid + i, _cur.grffile->grfid, override);
4706  break;
4707  }
4708 
4709  case 0x0E: // Callback mask
4710  tsp->callback_mask = buf->ReadByte();
4711  break;
4712 
4713  case 0x0F: // Animation information
4714  tsp->animation.frames = buf->ReadByte();
4715  tsp->animation.status = buf->ReadByte();
4716  break;
4717 
4718  case 0x10: // Animation speed
4719  tsp->animation.speed = buf->ReadByte();
4720  break;
4721 
4722  case 0x11: // Animation triggers
4723  tsp->animation.triggers = buf->ReadByte();
4724  break;
4725 
4726  default:
4727  ret = CIR_UNKNOWN;
4728  break;
4729  }
4730  }
4731 
4732  return ret;
4733 }
4734 
4735 static bool HandleChangeInfoResult(const char *caller, ChangeInfoResult cir, uint8 feature, uint8 property)
4736 {
4737  switch (cir) {
4738  default: NOT_REACHED();
4739 
4740  case CIR_DISABLED:
4741  /* Error has already been printed; just stop parsing */
4742  return true;
4743 
4744  case CIR_SUCCESS:
4745  return false;
4746 
4747  case CIR_UNHANDLED:
4748  grfmsg(1, "%s: Ignoring property 0x%02X of feature 0x%02X (not implemented)", caller, property, feature);
4749  return false;
4750 
4751  case CIR_UNKNOWN:
4752  grfmsg(0, "%s: Unknown property 0x%02X of feature 0x%02X, disabling", caller, property, feature);
4753  FALLTHROUGH;
4754 
4755  case CIR_INVALID_ID: {
4756  /* No debug message for an invalid ID, as it has already been output */
4757  GRFError *error = DisableGrf(cir == CIR_INVALID_ID ? STR_NEWGRF_ERROR_INVALID_ID : STR_NEWGRF_ERROR_UNKNOWN_PROPERTY);
4758  if (cir != CIR_INVALID_ID) error->param_value[1] = property;
4759  return true;
4760  }
4761  }
4762 }
4763 
4764 /* Action 0x00 */
4765 static void FeatureChangeInfo(ByteReader *buf)
4766 {
4767  /* <00> <feature> <num-props> <num-info> <id> (<property <new-info>)...
4768  *
4769  * B feature
4770  * B num-props how many properties to change per vehicle/station
4771  * B num-info how many vehicles/stations to change
4772  * E id ID of first vehicle/station to change, if num-info is
4773  * greater than one, this one and the following
4774  * vehicles/stations will be changed
4775  * B property what property to change, depends on the feature
4776  * V new-info new bytes of info (variable size; depends on properties) */
4777 
4778  static const VCI_Handler handler[] = {
4779  /* GSF_TRAINS */ RailVehicleChangeInfo,
4780  /* GSF_ROADVEHICLES */ RoadVehicleChangeInfo,
4781  /* GSF_SHIPS */ ShipVehicleChangeInfo,
4782  /* GSF_AIRCRAFT */ AircraftVehicleChangeInfo,
4783  /* GSF_STATIONS */ StationChangeInfo,
4784  /* GSF_CANALS */ CanalChangeInfo,
4785  /* GSF_BRIDGES */ BridgeChangeInfo,
4786  /* GSF_HOUSES */ TownHouseChangeInfo,
4787  /* GSF_GLOBALVAR */ GlobalVarChangeInfo,
4788  /* GSF_INDUSTRYTILES */ IndustrytilesChangeInfo,
4789  /* GSF_INDUSTRIES */ IndustriesChangeInfo,
4790  /* GSF_CARGOES */ nullptr, // Cargo is handled during reservation
4791  /* GSF_SOUNDFX */ SoundEffectChangeInfo,
4792  /* GSF_AIRPORTS */ AirportChangeInfo,
4793  /* GSF_SIGNALS */ nullptr,
4794  /* GSF_OBJECTS */ ObjectChangeInfo,
4795  /* GSF_RAILTYPES */ RailTypeChangeInfo,
4796  /* GSF_AIRPORTTILES */ AirportTilesChangeInfo,
4797  /* GSF_ROADTYPES */ RoadTypeChangeInfo,
4798  /* GSF_TRAMTYPES */ TramTypeChangeInfo,
4799  };
4800  static_assert(GSF_END == lengthof(handler));
4801 
4802  uint8 feature = buf->ReadByte();
4803  uint8 numprops = buf->ReadByte();
4804  uint numinfo = buf->ReadByte();
4805  uint engine = buf->ReadExtendedByte();
4806 
4807  if (feature >= GSF_END) {
4808  grfmsg(1, "FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4809  return;
4810  }
4811 
4812  grfmsg(6, "FeatureChangeInfo: Feature 0x%02X, %d properties, to apply to %d+%d",
4813  feature, numprops, engine, numinfo);
4814 
4815  if (handler[feature] == nullptr) {
4816  if (feature != GSF_CARGOES) grfmsg(1, "FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4817  return;
4818  }
4819 
4820  /* Mark the feature as used by the grf */
4821  SetBit(_cur.grffile->grf_features, feature);
4822 
4823  while (numprops-- && buf->HasData()) {
4824  uint8 prop = buf->ReadByte();
4825 
4826  ChangeInfoResult cir = handler[feature](engine, numinfo, prop, buf);
4827  if (HandleChangeInfoResult("FeatureChangeInfo", cir, feature, prop)) return;
4828  }
4829 }
4830 
4831 /* Action 0x00 (GLS_SAFETYSCAN) */
4832 static void SafeChangeInfo(ByteReader *buf)
4833 {
4834  uint8 feature = buf->ReadByte();
4835  uint8 numprops = buf->ReadByte();
4836  uint numinfo = buf->ReadByte();
4837  buf->ReadExtendedByte(); // id
4838 
4839  if (feature == GSF_BRIDGES && numprops == 1) {
4840  uint8 prop = buf->ReadByte();
4841  /* Bridge property 0x0D is redefinition of sprite layout tables, which
4842  * is considered safe. */
4843  if (prop == 0x0D) return;
4844  } else if (feature == GSF_GLOBALVAR && numprops == 1) {
4845  uint8 prop = buf->ReadByte();
4846  /* Engine ID Mappings are safe, if the source is static */
4847  if (prop == 0x11) {
4848  bool is_safe = true;
4849  for (uint i = 0; i < numinfo; i++) {
4850  uint32 s = buf->ReadDWord();
4851  buf->ReadDWord(); // dest
4852  const GRFConfig *grfconfig = GetGRFConfig(s);
4853  if (grfconfig != nullptr && !HasBit(grfconfig->flags, GCF_STATIC)) {
4854  is_safe = false;
4855  break;
4856  }
4857  }
4858  if (is_safe) return;
4859  }
4860  }
4861 
4862  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
4863 
4864  /* Skip remainder of GRF */
4865  _cur.skip_sprites = -1;
4866 }
4867 
4868 /* Action 0x00 (GLS_RESERVE) */
4869 static void ReserveChangeInfo(ByteReader *buf)
4870 {
4871  uint8 feature = buf->ReadByte();
4872 
4873  if (feature != GSF_CARGOES && feature != GSF_GLOBALVAR && feature != GSF_RAILTYPES && feature != GSF_ROADTYPES && feature != GSF_TRAMTYPES) return;
4874 
4875  uint8 numprops = buf->ReadByte();
4876  uint8 numinfo = buf->ReadByte();
4877  uint8 index = buf->ReadExtendedByte();
4878 
4879  while (numprops-- && buf->HasData()) {
4880  uint8 prop = buf->ReadByte();
4882 
4883  switch (feature) {
4884  default: NOT_REACHED();
4885  case GSF_CARGOES:
4886  cir = CargoChangeInfo(index, numinfo, prop, buf);
4887  break;
4888 
4889  case GSF_GLOBALVAR:
4890  cir = GlobalVarReserveInfo(index, numinfo, prop, buf);
4891  break;
4892 
4893  case GSF_RAILTYPES:
4894  cir = RailTypeReserveInfo(index, numinfo, prop, buf);
4895  break;
4896 
4897  case GSF_ROADTYPES:
4898  cir = RoadTypeReserveInfo(index, numinfo, prop, buf);
4899  break;
4900 
4901  case GSF_TRAMTYPES:
4902  cir = TramTypeReserveInfo(index, numinfo, prop, buf);
4903  break;
4904  }
4905 
4906  if (HandleChangeInfoResult("ReserveChangeInfo", cir, feature, prop)) return;
4907  }
4908 }
4909 
4910 /* Action 0x01 */
4911 static void NewSpriteSet(ByteReader *buf)
4912 {
4913  /* Basic format: <01> <feature> <num-sets> <num-ent>
4914  * Extended format: <01> <feature> 00 <first-set> <num-sets> <num-ent>
4915  *
4916  * B feature feature to define sprites for
4917  * 0, 1, 2, 3: veh-type, 4: train stations
4918  * E first-set first sprite set to define
4919  * B num-sets number of sprite sets (extended byte in extended format)
4920  * E num-ent how many entries per sprite set
4921  * For vehicles, this is the number of different
4922  * vehicle directions in each sprite set
4923  * Set num-dirs=8, unless your sprites are symmetric.
4924  * In that case, use num-dirs=4.
4925  */
4926 
4927  uint8 feature = buf->ReadByte();
4928  uint16 num_sets = buf->ReadByte();
4929  uint16 first_set = 0;
4930 
4931  if (num_sets == 0 && buf->HasData(3)) {
4932  /* Extended Action1 format.
4933  * Some GRFs define zero sets of zero sprites, though there is actually no use in that. Ignore them. */
4934  first_set = buf->ReadExtendedByte();
4935  num_sets = buf->ReadExtendedByte();
4936  }
4937  uint16 num_ents = buf->ReadExtendedByte();
4938 
4939  if (feature >= GSF_END) {
4940  _cur.skip_sprites = num_sets * num_ents;
4941  grfmsg(1, "NewSpriteSet: Unsupported feature 0x%02X, skipping %d sprites", feature, _cur.skip_sprites);
4942  return;
4943  }
4944 
4945  _cur.AddSpriteSets(feature, _cur.spriteid, first_set, num_sets, num_ents);
4946 
4947  grfmsg(7, "New sprite set at %d of feature 0x%02X, consisting of %d sets with %d views each (total %d)",
4948  _cur.spriteid, feature, num_sets, num_ents, num_sets * num_ents
4949  );
4950 
4951  for (int i = 0; i < num_sets * num_ents; i++) {
4952  _cur.nfo_line++;
4953  LoadNextSprite(_cur.spriteid++, *_cur.file, _cur.nfo_line);
4954  }
4955 }
4956 
4957 /* Action 0x01 (SKIP) */
4958 static void SkipAct1(ByteReader *buf)
4959 {
4960  buf->ReadByte();
4961  uint16 num_sets = buf->ReadByte();
4962 
4963  if (num_sets == 0 && buf->HasData(3)) {
4964  /* Extended Action1 format.
4965  * Some GRFs define zero sets of zero sprites, though there is actually no use in that. Ignore them. */
4966  buf->ReadExtendedByte(); // first_set
4967  num_sets = buf->ReadExtendedByte();
4968  }
4969  uint16 num_ents = buf->ReadExtendedByte();
4970 
4971  _cur.skip_sprites = num_sets * num_ents;
4972 
4973  grfmsg(3, "SkipAct1: Skipping %d sprites", _cur.skip_sprites);
4974 }
4975 
4976 /* Helper function to either create a callback or link to a previously
4977  * defined spritegroup. */
4978 static const SpriteGroup *GetGroupFromGroupID(byte setid, byte type, uint16 groupid)
4979 {
4980  if (HasBit(groupid, 15)) {
4982  return new CallbackResultSpriteGroup(groupid, _cur.grffile->grf_version >= 8);
4983  }
4984 
4985  if (groupid > MAX_SPRITEGROUP || _cur.spritegroups[groupid] == nullptr) {
4986  grfmsg(1, "GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid);
4987  return nullptr;
4988  }
4989 
4990  return _cur.spritegroups[groupid];
4991 }
4992 
5001 static const SpriteGroup *CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid)
5002 {
5003  if (HasBit(spriteid, 15)) {
5005  return new CallbackResultSpriteGroup(spriteid, _cur.grffile->grf_version >= 8);
5006  }
5007 
5008  if (!_cur.IsValidSpriteSet(feature, spriteid)) {
5009  grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid", setid, type, spriteid);
5010  return nullptr;
5011  }
5012 
5013  SpriteID spriteset_start = _cur.GetSprite(feature, spriteid);
5014  uint num_sprites = _cur.GetNumEnts(feature, spriteid);
5015 
5016  /* Ensure that the sprites are loeded */
5017  assert(spriteset_start + num_sprites <= _cur.spriteid);
5018 
5020  return new ResultSpriteGroup(spriteset_start, num_sprites);
5021 }
5022 
5023 /* Action 0x02 */
5024 static void NewSpriteGroup(ByteReader *buf)
5025 {
5026  /* <02> <feature> <set-id> <type/num-entries> <feature-specific-data...>
5027  *
5028  * B feature see action 1
5029  * B set-id ID of this particular definition
5030  * B type/num-entries
5031  * if 80 or greater, this is a randomized or variational
5032  * list definition, see below
5033  * otherwise it specifies a number of entries, the exact
5034  * meaning depends on the feature
5035  * V feature-specific-data (huge mess, don't even look it up --pasky) */
5036  const SpriteGroup *act_group = nullptr;
5037 
5038  uint8 feature = buf->ReadByte();
5039  if (feature >= GSF_END) {
5040  grfmsg(1, "NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5041  return;
5042  }
5043 
5044  uint8 setid = buf->ReadByte();
5045  uint8 type = buf->ReadByte();
5046 
5047  /* Sprite Groups are created here but they are allocated from a pool, so
5048  * we do not need to delete anything if there is an exception from the
5049  * ByteReader. */
5050 
5051  switch (type) {
5052  /* Deterministic Sprite Group */
5053  case 0x81: // Self scope, byte
5054  case 0x82: // Parent scope, byte
5055  case 0x85: // Self scope, word
5056  case 0x86: // Parent scope, word
5057  case 0x89: // Self scope, dword
5058  case 0x8A: // Parent scope, dword
5059  {
5060  byte varadjust;
5061  byte varsize;
5062 
5065  group->nfo_line = _cur.nfo_line;
5066  act_group = group;
5067  group->var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
5068 
5069  switch (GB(type, 2, 2)) {
5070  default: NOT_REACHED();
5071  case 0: group->size = DSG_SIZE_BYTE; varsize = 1; break;
5072  case 1: group->size = DSG_SIZE_WORD; varsize = 2; break;
5073  case 2: group->size = DSG_SIZE_DWORD; varsize = 4; break;
5074  }
5075 
5076  /* Loop through the var adjusts. Unfortunately we don't know how many we have
5077  * from the outset, so we shall have to keep reallocing. */
5078  do {
5079  DeterministicSpriteGroupAdjust &adjust = group->adjusts.emplace_back();
5080 
5081  /* The first var adjust doesn't have an operation specified, so we set it to add. */
5082  adjust.operation = group->adjusts.size() == 1 ? DSGA_OP_ADD : (DeterministicSpriteGroupAdjustOperation)buf->ReadByte();
5083  adjust.variable = buf->ReadByte();
5084  if (adjust.variable == 0x7E) {
5085  /* Link subroutine group */
5086  adjust.subroutine = GetGroupFromGroupID(setid, type, buf->ReadByte());
5087  } else {
5088  adjust.parameter = IsInsideMM(adjust.variable, 0x60, 0x80) ? buf->ReadByte() : 0;
5089  }
5090 
5091  varadjust = buf->ReadByte();
5092  adjust.shift_num = GB(varadjust, 0, 5);
5093  adjust.type = (DeterministicSpriteGroupAdjustType)GB(varadjust, 6, 2);
5094  adjust.and_mask = buf->ReadVarSize(varsize);
5095 
5096  if (adjust.type != DSGA_TYPE_NONE) {
5097  adjust.add_val = buf->ReadVarSize(varsize);
5098  adjust.divmod_val = buf->ReadVarSize(varsize);
5099  } else {
5100  adjust.add_val = 0;
5101  adjust.divmod_val = 0;
5102  }
5103 
5104  /* Continue reading var adjusts while bit 5 is set. */
5105  } while (HasBit(varadjust, 5));
5106 
5107  std::vector<DeterministicSpriteGroupRange> ranges;
5108  ranges.resize(buf->ReadByte());
5109  for (uint i = 0; i < ranges.size(); i++) {
5110  ranges[i].group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5111  ranges[i].low = buf->ReadVarSize(varsize);
5112  ranges[i].high = buf->ReadVarSize(varsize);
5113  }
5114 
5115  group->default_group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5116  group->error_group = ranges.size() > 0 ? ranges[0].group : group->default_group;
5117  /* nvar == 0 is a special case -- we turn our value into a callback result */
5118  group->calculated_result = ranges.size() == 0;
5119 
5120  /* Sort ranges ascending. When ranges overlap, this may required clamping or splitting them */
5121  std::vector<uint32> bounds;
5122  for (uint i = 0; i < ranges.size(); i++) {
5123  bounds.push_back(ranges[i].low);
5124  if (ranges[i].high != UINT32_MAX) bounds.push_back(ranges[i].high + 1);
5125  }
5126  std::sort(bounds.begin(), bounds.end());
5127  bounds.erase(std::unique(bounds.begin(), bounds.end()), bounds.end());
5128 
5129  std::vector<const SpriteGroup *> target;
5130  for (uint j = 0; j < bounds.size(); ++j) {
5131  uint32 v = bounds[j];
5132  const SpriteGroup *t = group->default_group;
5133  for (uint i = 0; i < ranges.size(); i++) {
5134  if (ranges[i].low <= v && v <= ranges[i].high) {
5135  t = ranges[i].group;
5136  break;
5137  }
5138  }
5139  target.push_back(t);
5140  }
5141  assert(target.size() == bounds.size());
5142 
5143  for (uint j = 0; j < bounds.size(); ) {
5144  if (target[j] != group->default_group) {
5145  DeterministicSpriteGroupRange &r = group->ranges.emplace_back();
5146  r.group = target[j];
5147  r.low = bounds[j];
5148  while (j < bounds.size() && target[j] == r.group) {
5149  j++;
5150  }
5151  r.high = j < bounds.size() ? bounds[j] - 1 : UINT32_MAX;
5152  } else {
5153  j++;
5154  }
5155  }
5156 
5157  break;
5158  }
5159 
5160  /* Randomized Sprite Group */
5161  case 0x80: // Self scope
5162  case 0x83: // Parent scope
5163  case 0x84: // Relative scope
5164  {
5167  group->nfo_line = _cur.nfo_line;
5168  act_group = group;
5169  group->var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
5170 
5171  if (HasBit(type, 2)) {
5172  if (feature <= GSF_AIRCRAFT) group->var_scope = VSG_SCOPE_RELATIVE;
5173  group->count = buf->ReadByte();
5174  }
5175 
5176  uint8 triggers = buf->ReadByte();
5177  group->triggers = GB(triggers, 0, 7);
5178  group->cmp_mode = HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY;
5179  group->lowest_randbit = buf->ReadByte();
5180 
5181  byte num_groups = buf->ReadByte();
5182  if (!HasExactlyOneBit(num_groups)) {
5183  grfmsg(1, "NewSpriteGroup: Random Action 2 nrand should be power of 2");
5184  }
5185 
5186  for (uint i = 0; i < num_groups; i++) {
5187  group->groups.push_back(GetGroupFromGroupID(setid, type, buf->ReadWord()));
5188  }
5189 
5190  break;
5191  }
5192 
5193  /* Neither a variable or randomized sprite group... must be a real group */
5194  default:
5195  {
5196  switch (feature) {
5197  case GSF_TRAINS:
5198  case GSF_ROADVEHICLES:
5199  case GSF_SHIPS:
5200  case GSF_AIRCRAFT:
5201  case GSF_STATIONS:
5202  case GSF_CANALS:
5203  case GSF_CARGOES:
5204  case GSF_AIRPORTS:
5205  case GSF_RAILTYPES:
5206  case GSF_ROADTYPES:
5207  case GSF_TRAMTYPES:
5208  {
5209  byte num_loaded = type;
5210  byte num_loading = buf->ReadByte();
5211 
5212  if (!_cur.HasValidSpriteSets(feature)) {
5213  grfmsg(0, "NewSpriteGroup: No sprite set to work on! Skipping");
5214  return;
5215  }
5216 
5217  grfmsg(6, "NewSpriteGroup: New SpriteGroup 0x%02X, %u loaded, %u loading",
5218  setid, num_loaded, num_loading);
5219 
5220  if (num_loaded + num_loading == 0) {
5221  grfmsg(1, "NewSpriteGroup: no result, skipping invalid RealSpriteGroup");
5222  break;
5223  }
5224 
5225  if (num_loaded + num_loading == 1) {
5226  /* Avoid creating 'Real' sprite group if only one option. */
5227  uint16 spriteid = buf->ReadWord();
5228  act_group = CreateGroupFromGroupID(feature, setid, type, spriteid);
5229  grfmsg(8, "NewSpriteGroup: one result, skipping RealSpriteGroup = subset %u", spriteid);
5230  break;
5231  }
5232 
5233  std::vector<uint16> loaded;
5234  std::vector<uint16> loading;
5235 
5236  for (uint i = 0; i < num_loaded; i++) {
5237  loaded.push_back(buf->ReadWord());
5238  grfmsg(8, "NewSpriteGroup: + rg->loaded[%i] = subset %u", i, loaded[i]);
5239  }
5240 
5241  for (uint i = 0; i < num_loading; i++) {
5242  loading.push_back(buf->ReadWord());
5243  grfmsg(8, "NewSpriteGroup: + rg->loading[%i] = subset %u", i, loading[i]);
5244  }
5245 
5246  if (std::adjacent_find(loaded.begin(), loaded.end(), std::not_equal_to<>()) == loaded.end() &&
5247  std::adjacent_find(loading.begin(), loading.end(), std::not_equal_to<>()) == loading.end() &&
5248  loaded[0] == loading[0])
5249  {
5250  /* Both lists only contain the same value, so don't create 'Real' sprite group */
5251  act_group = CreateGroupFromGroupID(feature, setid, type, loaded[0]);
5252  grfmsg(8, "NewSpriteGroup: same result, skipping RealSpriteGroup = subset %u", loaded[0]);
5253  break;
5254  }
5255 
5257  RealSpriteGroup *group = new RealSpriteGroup();
5258  group->nfo_line = _cur.nfo_line;
5259  act_group = group;
5260 
5261  for (uint16 spriteid : loaded) {
5262  const SpriteGroup *t = CreateGroupFromGroupID(feature, setid, type, spriteid);
5263  group->loaded.push_back(t);
5264  }
5265 
5266  for (uint16 spriteid : loading) {
5267  const SpriteGroup *t = CreateGroupFromGroupID(feature, setid, type, spriteid);
5268  group->loading.push_back(t);
5269  }
5270 
5271  break;
5272  }
5273 
5274  case GSF_HOUSES:
5275  case GSF_AIRPORTTILES:
5276  case GSF_OBJECTS:
5277  case GSF_INDUSTRYTILES: {
5278  byte num_building_sprites = std::max((uint8)1, type);
5279 
5282  group->nfo_line = _cur.nfo_line;
5283  act_group = group;
5284 
5285  /* On error, bail out immediately. Temporary GRF data was already freed */
5286  if (ReadSpriteLayout(buf, num_building_sprites, true, feature, false, type == 0, &group->dts)) return;
5287  break;
5288  }
5289 
5290  case GSF_INDUSTRIES: {
5291  if (type > 2) {
5292  grfmsg(1, "NewSpriteGroup: Unsupported industry production version %d, skipping", type);
5293  break;
5294  }
5295 
5298  group->nfo_line = _cur.nfo_line;
5299  act_group = group;
5300  group->version = type;
5301  if (type == 0) {
5302  group->num_input = 3;
5303  for (uint i = 0; i < 3; i++) {
5304  group->subtract_input[i] = (int16)buf->ReadWord(); // signed
5305  }
5306  group->num_output = 2;
5307  for (uint i = 0; i < 2; i++) {
5308  group->add_output[i] = buf->ReadWord(); // unsigned
5309  }
5310  group->again = buf->ReadByte();
5311  } else if (type == 1) {
5312  group->num_input = 3;
5313  for (uint i = 0; i < 3; i++) {
5314  group->subtract_input[i] = buf->ReadByte();
5315  }
5316  group->num_output = 2;
5317  for (uint i = 0; i < 2; i++) {
5318  group->add_output[i] = buf->ReadByte();
5319  }
5320  group->again = buf->ReadByte();
5321  } else if (type == 2) {
5322  group->num_input = buf->ReadByte();
5323  if (group->num_input > lengthof(group->subtract_input)) {
5324  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5325  error->data = "too many inputs (max 16)";
5326  return;
5327  }
5328  for (uint i = 0; i < group->num_input; i++) {
5329  byte rawcargo = buf->ReadByte();
5330  CargoID cargo = GetCargoTranslation(rawcargo, _cur.grffile);
5331  if (cargo == CT_INVALID) {
5332  /* The mapped cargo is invalid. This is permitted at this point,
5333  * as long as the result is not used. Mark it invalid so this
5334  * can be tested later. */
5335  group->version = 0xFF;
5336  } else if (std::find(group->cargo_input, group->cargo_input + i, cargo) != group->cargo_input + i) {
5337  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5338  error->data = "duplicate input cargo";
5339  return;
5340  }
5341  group->cargo_input[i] = cargo;
5342  group->subtract_input[i] = buf->ReadByte();
5343  }
5344  group->num_output = buf->ReadByte();
5345  if (group->num_output > lengthof(group->add_output)) {
5346  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5347  error->data = "too many outputs (max 16)";
5348  return;
5349  }
5350  for (uint i = 0; i < group->num_output; i++) {
5351  byte rawcargo = buf->ReadByte();
5352  CargoID cargo = GetCargoTranslation(rawcargo, _cur.grffile);
5353  if (cargo == CT_INVALID) {
5354  /* Mark this result as invalid to use */
5355  group->version = 0xFF;
5356  } else if (std::find(group->cargo_output, group->cargo_output + i, cargo) != group->cargo_output + i) {
5357  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_INDPROD_CALLBACK);
5358  error->data = "duplicate output cargo";
5359  return;
5360  }
5361  group->cargo_output[i] = cargo;
5362  group->add_output[i] = buf->ReadByte();
5363  }
5364  group->again = buf->ReadByte();
5365  } else {
5366  NOT_REACHED();
5367  }
5368  break;
5369  }
5370 
5371  /* Loading of Tile Layout and Production Callback groups would happen here */
5372  default: grfmsg(1, "NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5373  }
5374  }
5375  }
5376 
5377  _cur.spritegroups[setid] = act_group;
5378 }
5379 
5380 static CargoID TranslateCargo(uint8 feature, uint8 ctype)
5381 {
5382  if (feature == GSF_OBJECTS) {
5383  switch (ctype) {
5384  case 0: return 0;
5385  case 0xFF: return CT_PURCHASE_OBJECT;
5386  default:
5387  grfmsg(1, "TranslateCargo: Invalid cargo bitnum %d for objects, skipping.", ctype);
5388  return CT_INVALID;
5389  }
5390  }
5391  /* Special cargo types for purchase list and stations */
5392  if (feature == GSF_STATIONS && ctype == 0xFE) return CT_DEFAULT_NA;
5393  if (ctype == 0xFF) return CT_PURCHASE;
5394 
5395  if (_cur.grffile->cargo_list.size() == 0) {
5396  /* No cargo table, so use bitnum values */
5397  if (ctype >= 32) {
5398  grfmsg(1, "TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype);
5399  return CT_INVALID;
5400  }
5401 
5402  for (const CargoSpec *cs : CargoSpec::Iterate()) {
5403  if (cs->bitnum == ctype) {
5404  grfmsg(6, "TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, cs->Index());
5405  return cs->Index();
5406  }
5407  }
5408 
5409  grfmsg(5, "TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype);
5410  return CT_INVALID;
5411  }
5412 
5413  /* Check if the cargo type is out of bounds of the cargo translation table */
5414  if (ctype >= _cur.grffile->cargo_list.size()) {
5415  grfmsg(1, "TranslateCargo: Cargo type %d out of range (max %d), skipping.", ctype, (unsigned int)_cur.grffile->cargo_list.size() - 1);
5416  return CT_INVALID;
5417  }
5418 
5419  /* Look up the cargo label from the translation table */
5420  CargoLabel cl = _cur.grffile->cargo_list[ctype];
5421  if (cl == 0) {
5422  grfmsg(5, "TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype);
5423  return CT_INVALID;
5424  }
5425 
5426  ctype = GetCargoIDByLabel(cl);
5427  if (ctype == CT_INVALID) {
5428  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));
5429  return CT_INVALID;
5430  }
5431 
5432  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);
5433  return ctype;
5434 }
5435 
5436 
5437 static bool IsValidGroupID(uint16 groupid, const char *function)
5438 {
5439  if (groupid > MAX_SPRITEGROUP || _cur.spritegroups[groupid] == nullptr) {
5440  grfmsg(1, "%s: Spritegroup 0x%04X out of range or empty, skipping.", function, groupid);
5441  return false;
5442  }
5443 
5444  return true;
5445 }
5446 
5447 static void VehicleMapSpriteGroup(ByteReader *buf, byte feature, uint8 idcount)
5448 {
5449  static EngineID *last_engines;
5450  static uint last_engines_count;
5451  bool wagover = false;
5452 
5453  /* Test for 'wagon override' flag */
5454  if (HasBit(idcount, 7)) {
5455  wagover = true;
5456  /* Strip off the flag */
5457  idcount = GB(idcount, 0, 7);
5458 
5459  if (last_engines_count == 0) {
5460  grfmsg(0, "VehicleMapSpriteGroup: WagonOverride: No engine to do override with");
5461  return;
5462  }
5463 
5464  grfmsg(6, "VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons",
5465  last_engines_count, idcount);
5466  } else {
5467  if (last_engines_count != idcount) {
5468  last_engines = ReallocT(last_engines, idcount);
5469  last_engines_count = idcount;
5470  }
5471  }
5472 
5473  EngineID *engines = AllocaM(EngineID, idcount);
5474  for (uint i = 0; i < idcount; i++) {
5475  Engine *e = GetNewEngine(_cur.grffile, (VehicleType)feature, buf->ReadExtendedByte());
5476  if (e == nullptr) {
5477  /* No engine could be allocated?!? Deal with it. Okay,
5478  * this might look bad. Also make sure this NewGRF
5479  * gets disabled, as a half loaded one is bad. */
5480  HandleChangeInfoResult("VehicleMapSpriteGroup", CIR_INVALID_ID, 0, 0);
5481  return;
5482  }
5483 
5484  engines[i] = e->index;
5485  if (!wagover) last_engines[i] = engines[i];
5486  }
5487 
5488  uint8 cidcount = buf->ReadByte();
5489  for (uint c = 0; c < cidcount; c++) {
5490  uint8 ctype = buf->ReadByte();
5491  uint16 groupid = buf->ReadWord();
5492  if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) continue;
5493 
5494  grfmsg(8, "VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid);
5495 
5496  ctype = TranslateCargo(feature, ctype);
5497  if (ctype == CT_INVALID) continue;
5498 
5499  for (uint i = 0; i < idcount; i++) {
5500  EngineID engine = engines[i];
5501 
5502  grfmsg(7, "VehicleMapSpriteGroup: [%d] Engine %d...", i, engine);
5503 
5504  if (wagover) {
5505  SetWagonOverrideSprites(engine, ctype, _cur.spritegroups[groupid], last_engines, last_engines_count);
5506  } else {
5507  SetCustomEngineSprites(engine, ctype, _cur.spritegroups[groupid]);
5508  }
5509  }
5510  }
5511 
5512  uint16 groupid = buf->ReadWord();
5513  if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) return;
5514 
5515  grfmsg(8, "-- Default group id 0x%04X", groupid);
5516 
5517  for (uint i = 0; i < idcount; i++) {
5518  EngineID engine = engines[i];
5519 
5520  if (wagover) {
5521  SetWagonOverrideSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid], last_engines, last_engines_count);
5522  } else {
5523  SetCustomEngineSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid]);
5524  SetEngineGRF(engine, _cur.grffile);
5525  }
5526  }
5527 }
5528 
5529 
5530 static void CanalMapSpriteGroup(ByteReader *buf, uint8 idcount)
5531 {
5532  CanalFeature *cfs = AllocaM(CanalFeature, idcount);
5533  for (uint i = 0; i < idcount; i++) {
5534  cfs[i] = (CanalFeature)buf->ReadByte();
5535  }
5536 
5537  uint8 cidcount = buf->ReadByte();
5538  buf->Skip(cidcount * 3);
5539 
5540  uint16 groupid = buf->ReadWord();
5541  if (!IsValidGroupID(groupid, "CanalMapSpriteGroup")) return;
5542 
5543  for (uint i = 0; i < idcount; i++) {
5544  CanalFeature cf = cfs[i];
5545 
5546  if (cf >= CF_END) {
5547  grfmsg(1, "CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf);
5548  continue;
5549  }
5550 
5551  _water_feature[cf].grffile = _cur.grffile;
5552  _water_feature[cf].group = _cur.spritegroups[groupid];
5553  }
5554 }
5555 
5556 
5557 static void StationMapSpriteGroup(ByteReader *buf, uint8 idcount)
5558 {
5559  uint8 *stations = AllocaM(uint8, idcount);
5560  for (uint i = 0; i < idcount; i++) {
5561  stations[i] = buf->ReadByte();
5562  }
5563 
5564  uint8 cidcount = buf->ReadByte();
5565  for (uint c = 0; c < cidcount; c++) {
5566  uint8 ctype = buf->ReadByte();
5567  uint16 groupid = buf->ReadWord();
5568  if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) continue;
5569 
5570  ctype = TranslateCargo(GSF_STATIONS, ctype);
5571  if (ctype == CT_INVALID) continue;
5572 
5573  for (uint i = 0; i < idcount; i++) {
5574  StationSpec *statspec = _cur.grffile->stations == nullptr ? nullptr : _cur.grffile->stations[stations[i]];
5575 
5576  if (statspec == nullptr) {
5577  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5578  continue;
5579  }
5580 
5581  statspec->grf_prop.spritegroup[ctype] = _cur.spritegroups[groupid];
5582  }
5583  }
5584 
5585  uint16 groupid = buf->ReadWord();
5586  if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) return;
5587 
5588  for (uint i = 0; i < idcount; i++) {
5589  StationSpec *statspec = _cur.grffile->stations == nullptr ? nullptr : _cur.grffile->stations[stations[i]];
5590 
5591  if (statspec == nullptr) {
5592  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5593  continue;
5594  }
5595 
5596  if (statspec->grf_prop.grffile != nullptr) {
5597  grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X mapped multiple times, skipping", stations[i]);
5598  continue;
5599  }
5600 
5601  statspec->grf_prop.spritegroup[CT_DEFAULT] = _cur.spritegroups[groupid];
5602  statspec->grf_prop.grffile = _cur.grffile;
5603  statspec->grf_prop.local_id = stations[i];
5604  StationClass::Assign(statspec);
5605  }
5606 }
5607 
5608 
5609 static void TownHouseMapSpriteGroup(ByteReader *buf, uint8 idcount)
5610 {
5611  uint8 *houses = AllocaM(uint8, idcount);
5612  for (uint i = 0; i < idcount; i++) {
5613  houses[i] = buf->ReadByte();
5614  }
5615 
5616  /* Skip the cargo type section, we only care about the default group */
5617  uint8 cidcount = buf->ReadByte();
5618  buf->Skip(cidcount * 3);
5619 
5620  uint16 groupid = buf->ReadWord();
5621  if (!IsValidGroupID(groupid, "TownHouseMapSpriteGroup")) return;
5622 
5623  if (_cur.grffile->housespec == nullptr) {
5624  grfmsg(1, "TownHouseMapSpriteGroup: No houses defined, skipping");
5625  return;
5626  }
5627 
5628  for (uint i = 0; i < idcount; i++) {
5629  HouseSpec *hs = _cur.grffile->housespec[houses[i]];
5630 
5631  if (hs == nullptr) {
5632  grfmsg(1, "TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]);
5633  continue;
5634  }
5635 
5636  hs->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5637  }
5638 }
5639 
5640 static void IndustryMapSpriteGroup(ByteReader *buf, uint8 idcount)
5641 {
5642  uint8 *industries = AllocaM(uint8, idcount);
5643  for (uint i = 0; i < idcount; i++) {
5644  industries[i] = buf->ReadByte();
5645  }
5646 
5647  /* Skip the cargo type section, we only care about the default group */
5648  uint8 cidcount = buf->ReadByte();
5649  buf->Skip(cidcount * 3);
5650 
5651  uint16 groupid = buf->ReadWord();
5652  if (!IsValidGroupID(groupid, "IndustryMapSpriteGroup")) return;
5653 
5654  if (_cur.grffile->industryspec == nullptr) {
5655  grfmsg(1, "IndustryMapSpriteGroup: No industries defined, skipping");
5656  return;
5657  }
5658 
5659  for (uint i = 0; i < idcount; i++) {
5660  IndustrySpec *indsp = _cur.grffile->industryspec[industries[i]];
5661 
5662  if (indsp == nullptr) {
5663  grfmsg(1, "IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]);
5664  continue;
5665  }
5666 
5667  indsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5668  }
5669 }
5670 
5671 static void IndustrytileMapSpriteGroup(ByteReader *buf, uint8 idcount)
5672 {
5673  uint8 *indtiles = AllocaM(uint8, idcount);
5674  for (uint i = 0; i < idcount; i++) {
5675  indtiles[i] = buf->ReadByte();
5676  }
5677 
5678  /* Skip the cargo type section, we only care about the default group */
5679  uint8 cidcount = buf->ReadByte();
5680  buf->Skip(cidcount * 3);
5681 
5682  uint16 groupid = buf->ReadWord();
5683  if (!IsValidGroupID(groupid, "IndustrytileMapSpriteGroup")) return;
5684 
5685  if (_cur.grffile->indtspec == nullptr) {
5686  grfmsg(1, "IndustrytileMapSpriteGroup: No industry tiles defined, skipping");
5687  return;
5688  }
5689 
5690  for (uint i = 0; i < idcount; i++) {
5691  IndustryTileSpec *indtsp = _cur.grffile->indtspec[indtiles[i]];
5692 
5693  if (indtsp == nullptr) {
5694  grfmsg(1, "IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]);
5695  continue;
5696  }
5697 
5698  indtsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5699  }
5700 }
5701 
5702 static void CargoMapSpriteGroup(ByteReader *buf, uint8 idcount)
5703 {
5704  CargoID *cargoes = AllocaM(CargoID, idcount);
5705  for (uint i = 0; i < idcount; i++) {
5706  cargoes[i] = buf->ReadByte();
5707  }
5708 
5709  /* Skip the cargo type section, we only care about the default group */
5710  uint8 cidcount = buf->ReadByte();
5711  buf->Skip(cidcount * 3);
5712 
5713  uint16 groupid = buf->ReadWord();
5714  if (!IsValidGroupID(groupid, "CargoMapSpriteGroup")) return;
5715 
5716  for (uint i = 0; i < idcount; i++) {
5717  CargoID cid = cargoes[i];
5718 
5719  if (cid >= NUM_CARGO) {
5720  grfmsg(1, "CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid);
5721  continue;
5722  }
5723 
5724  CargoSpec *cs = CargoSpec::Get(cid);
5725  cs->grffile = _cur.grffile;
5726  cs->group = _cur.spritegroups[groupid];
5727  }
5728 }
5729 
5730 static void ObjectMapSpriteGroup(ByteReader *buf, uint8 idcount)
5731 {
5732  if (_cur.grffile->objectspec == nullptr) {
5733  grfmsg(1, "ObjectMapSpriteGroup: No object tiles defined, skipping");
5734  return;
5735  }
5736 
5737  uint8 *objects = AllocaM(uint8, idcount);
5738  for (uint i = 0; i < idcount; i++) {
5739  objects[i] = buf->ReadByte();
5740  }
5741 
5742  uint8 cidcount = buf->ReadByte();
5743  for (uint c = 0; c < cidcount; c++) {
5744  uint8 ctype = buf->ReadByte();
5745  uint16 groupid = buf->ReadWord();
5746  if (!IsValidGroupID(groupid, "ObjectMapSpriteGroup")) continue;
5747 
5748  ctype = TranslateCargo(GSF_OBJECTS, ctype);
5749  if (ctype == CT_INVALID) continue;
5750 
5751  for (uint i = 0; i < idcount; i++) {
5752  ObjectSpec *spec = _cur.grffile->objectspec[objects[i]];
5753 
5754  if (spec == nullptr) {
5755  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5756  continue;
5757  }
5758 
5759  spec->grf_prop.spritegroup[ctype] = _cur.spritegroups[groupid];
5760  }
5761  }
5762 
5763  uint16 groupid = buf->ReadWord();
5764  if (!IsValidGroupID(groupid, "ObjectMapSpriteGroup")) return;
5765 
5766  for (uint i = 0; i < idcount; i++) {
5767  ObjectSpec *spec = _cur.grffile->objectspec[objects[i]];
5768 
5769  if (spec == nullptr) {
5770  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5771  continue;
5772  }
5773 
5774  if (spec->grf_prop.grffile != nullptr) {
5775  grfmsg(1, "ObjectMapSpriteGroup: Object with ID 0x%02X mapped multiple times, skipping", objects[i]);
5776  continue;
5777  }
5778 
5779  spec->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5780  spec->grf_prop.grffile = _cur.grffile;
5781  spec->grf_prop.local_id = objects[i];
5782  }
5783 }
5784 
5785 static void RailTypeMapSpriteGroup(ByteReader *buf, uint8 idcount)
5786 {
5787  uint8 *railtypes = AllocaM(uint8, idcount);
5788  for (uint i = 0; i < idcount; i++) {
5789  uint8 id = buf->ReadByte();
5790  railtypes[i] = id < RAILTYPE_END ? _cur.grffile->railtype_map[id] : INVALID_RAILTYPE;
5791  }
5792 
5793  uint8 cidcount = buf->ReadByte();
5794  for (uint c = 0; c < cidcount; c++) {
5795  uint8 ctype = buf->ReadByte();
5796  uint16 groupid = buf->ReadWord();
5797  if (!IsValidGroupID(groupid, "RailTypeMapSpriteGroup")) continue;
5798 
5799  if (ctype >= RTSG_END) continue;
5800 
5801  extern RailtypeInfo _railtypes[RAILTYPE_END];
5802  for (uint i = 0; i < idcount; i++) {
5803  if (railtypes[i] != INVALID_RAILTYPE) {
5804  RailtypeInfo *rti = &_railtypes[railtypes[i]];
5805 
5806  rti->grffile[ctype] = _cur.grffile;
5807  rti->group[ctype] = _cur.spritegroups[groupid];
5808  }
5809  }
5810  }
5811 
5812  /* Railtypes do not use the default group. */
5813  buf->ReadWord();
5814 }
5815 
5816 static void RoadTypeMapSpriteGroup(ByteReader *buf, uint8 idcount, RoadTramType rtt)
5817 {
5818  RoadType *type_map = (rtt == RTT_TRAM) ? _cur.grffile->tramtype_map : _cur.grffile->roadtype_map;
5819 
5820  uint8 *roadtypes = AllocaM(uint8, idcount);
5821  for (uint i = 0; i < idcount; i++) {
5822  uint8 id = buf->ReadByte();
5823  roadtypes[i] = id < ROADTYPE_END ? type_map[id] : INVALID_ROADTYPE;
5824  }
5825 
5826  uint8 cidcount = buf->ReadByte();
5827  for (uint c = 0; c < cidcount; c++) {
5828  uint8 ctype = buf->ReadByte();
5829  uint16 groupid = buf->ReadWord();
5830  if (!IsValidGroupID(groupid, "RoadTypeMapSpriteGroup")) continue;
5831 
5832  if (ctype >= ROTSG_END) continue;
5833 
5834  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
5835  for (uint i = 0; i < idcount; i++) {
5836  if (roadtypes[i] != INVALID_ROADTYPE) {
5837  RoadTypeInfo *rti = &_roadtypes[roadtypes[i]];
5838 
5839  rti->grffile[ctype] = _cur.grffile;
5840  rti->group[ctype] = _cur.spritegroups[groupid];
5841  }
5842  }
5843  }
5844 
5845  /* Roadtypes do not use the default group. */
5846  buf->ReadWord();
5847 }
5848 
5849 static void AirportMapSpriteGroup(ByteReader *buf, uint8 idcount)
5850 {
5851  uint8 *airports = AllocaM(uint8, idcount);
5852  for (uint i = 0; i < idcount; i++) {
5853  airports[i] = buf->ReadByte();
5854  }
5855 
5856  /* Skip the cargo type section, we only care about the default group */
5857  uint8 cidcount = buf->ReadByte();
5858  buf->Skip(cidcount * 3);
5859 
5860  uint16 groupid = buf->ReadWord();
5861  if (!IsValidGroupID(groupid, "AirportMapSpriteGroup")) return;
5862 
5863  if (_cur.grffile->airportspec == nullptr) {
5864  grfmsg(1, "AirportMapSpriteGroup: No airports defined, skipping");
5865  return;
5866  }
5867 
5868  for (uint i = 0; i < idcount; i++) {
5869  AirportSpec *as = _cur.grffile->airportspec[airports[i]];
5870 
5871  if (as == nullptr) {
5872  grfmsg(1, "AirportMapSpriteGroup: Airport %d undefined, skipping", airports[i]);
5873  continue;
5874  }
5875 
5876  as->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5877  }
5878 }
5879 
5880 static void AirportTileMapSpriteGroup(ByteReader *buf, uint8 idcount)
5881 {
5882  uint8 *airptiles = AllocaM(uint8, idcount);
5883  for (uint i = 0; i < idcount; i++) {
5884  airptiles[i] = buf->ReadByte();
5885  }
5886 
5887  /* Skip the cargo type section, we only care about the default group */
5888  uint8 cidcount = buf->ReadByte();
5889  buf->Skip(cidcount * 3);
5890 
5891  uint16 groupid = buf->ReadWord();
5892  if (!IsValidGroupID(groupid, "AirportTileMapSpriteGroup")) return;
5893 
5894  if (_cur.grffile->airtspec == nullptr) {
5895  grfmsg(1, "AirportTileMapSpriteGroup: No airport tiles defined, skipping");
5896  return;
5897  }
5898 
5899  for (uint i = 0; i < idcount; i++) {
5900  AirportTileSpec *airtsp = _cur.grffile->airtspec[airptiles[i]];
5901 
5902  if (airtsp == nullptr) {
5903  grfmsg(1, "AirportTileMapSpriteGroup: Airport tile %d undefined, skipping", airptiles[i]);
5904  continue;
5905  }
5906 
5907  airtsp->grf_prop.spritegroup[0] = _cur.spritegroups[groupid];
5908  }
5909 }
5910 
5911 
5912 /* Action 0x03 */
5913 static void FeatureMapSpriteGroup(ByteReader *buf)
5914 {
5915  /* <03> <feature> <n-id> <ids>... <num-cid> [<cargo-type> <cid>]... <def-cid>
5916  * id-list := [<id>] [id-list]
5917  * cargo-list := <cargo-type> <cid> [cargo-list]
5918  *
5919  * B feature see action 0
5920  * B n-id bits 0-6: how many IDs this definition applies to
5921  * bit 7: if set, this is a wagon override definition (see below)
5922  * B ids the IDs for which this definition applies
5923  * B num-cid number of cargo IDs (sprite group IDs) in this definition
5924  * can be zero, in that case the def-cid is used always
5925  * B cargo-type type of this cargo type (e.g. mail=2, wood=7, see below)
5926  * W cid cargo ID (sprite group ID) for this type of cargo
5927  * W def-cid default cargo ID (sprite group ID) */
5928 
5929  uint8 feature = buf->ReadByte();
5930  uint8 idcount = buf->ReadByte();
5931 
5932  if (feature >= GSF_END) {
5933  grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5934  return;
5935  }
5936 
5937  /* If idcount is zero, this is a feature callback */
5938  if (idcount == 0) {
5939  /* Skip number of cargo ids? */
5940  buf->ReadByte();
5941  uint16 groupid = buf->ReadWord();
5942  if (!IsValidGroupID(groupid, "FeatureMapSpriteGroup")) return;
5943 
5944  grfmsg(6, "FeatureMapSpriteGroup: Adding generic feature callback for feature 0x%02X", feature);
5945 
5946  AddGenericCallback(feature, _cur.grffile, _cur.spritegroups[groupid]);
5947  return;
5948  }
5949 
5950  /* Mark the feature as used by the grf (generic callbacks do not count) */
5951  SetBit(_cur.grffile->grf_features, feature);
5952 
5953  grfmsg(6, "FeatureMapSpriteGroup: Feature 0x%02X, %d ids", feature, idcount);
5954 
5955  switch (feature) {
5956  case GSF_TRAINS:
5957  case GSF_ROADVEHICLES:
5958  case GSF_SHIPS:
5959  case GSF_AIRCRAFT:
5960  VehicleMapSpriteGroup(buf, feature, idcount);
5961  return;
5962 
5963  case GSF_CANALS:
5964  CanalMapSpriteGroup(buf, idcount);
5965  return;
5966 
5967  case GSF_STATIONS:
5968  StationMapSpriteGroup(buf, idcount);
5969  return;
5970 
5971  case GSF_HOUSES:
5972  TownHouseMapSpriteGroup(buf, idcount);
5973  return;
5974 
5975  case GSF_INDUSTRIES:
5976  IndustryMapSpriteGroup(buf, idcount);
5977  return;
5978 
5979  case GSF_INDUSTRYTILES:
5980  IndustrytileMapSpriteGroup(buf, idcount);
5981  return;
5982 
5983  case GSF_CARGOES:
5984  CargoMapSpriteGroup(buf, idcount);
5985  return;
5986 
5987  case GSF_AIRPORTS:
5988  AirportMapSpriteGroup(buf, idcount);
5989  return;
5990 
5991  case GSF_OBJECTS:
5992  ObjectMapSpriteGroup(buf, idcount);
5993  break;
5994 
5995  case GSF_RAILTYPES:
5996  RailTypeMapSpriteGroup(buf, idcount);
5997  break;
5998 
5999  case GSF_ROADTYPES:
6000  RoadTypeMapSpriteGroup(buf, idcount, RTT_ROAD);
6001  break;
6002 
6003  case GSF_TRAMTYPES:
6004  RoadTypeMapSpriteGroup(buf, idcount, RTT_TRAM);
6005  break;
6006 
6007  case GSF_AIRPORTTILES:
6008  AirportTileMapSpriteGroup(buf, idcount);
6009  return;
6010 
6011  default:
6012  grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
6013  return;
6014  }
6015 }
6016 
6017 /* Action 0x04 */
6018 static void FeatureNewName(ByteReader *buf)
6019 {
6020  /* <04> <veh-type> <language-id> <num-veh> <offset> <data...>
6021  *
6022  * B veh-type see action 0 (as 00..07, + 0A
6023  * But IF veh-type = 48, then generic text
6024  * B language-id If bit 6 is set, This is the extended language scheme,
6025  * with up to 64 language.
6026  * Otherwise, it is a mapping where set bits have meaning
6027  * 0 = american, 1 = english, 2 = german, 3 = french, 4 = spanish
6028  * Bit 7 set means this is a generic text, not a vehicle one (or else)
6029  * B num-veh number of vehicles which are getting a new name
6030  * B/W offset number of the first vehicle that gets a new name
6031  * Byte : ID of vehicle to change
6032  * Word : ID of string to change/add
6033  * S data new texts, each of them zero-terminated, after
6034  * which the next name begins. */
6035 
6036  bool new_scheme = _cur.grffile->grf_version >= 7;
6037 
6038  uint8 feature = buf->ReadByte();
6039  if (feature >= GSF_END && feature != 0x48) {
6040  grfmsg(1, "FeatureNewName: Unsupported feature 0x%02X, skipping", feature);
6041  return;
6042  }
6043 
6044  uint8 lang = buf->ReadByte();
6045  uint8 num = buf->ReadByte();
6046  bool generic = HasBit(lang, 7);
6047  uint16 id;
6048  if (generic) {
6049  id = buf->ReadWord();
6050  } else if (feature <= GSF_AIRCRAFT) {
6051  id = buf->ReadExtendedByte();
6052  } else {
6053  id = buf->ReadByte();
6054  }
6055 
6056  ClrBit(lang, 7);
6057 
6058  uint16 endid = id + num;
6059 
6060  grfmsg(6, "FeatureNewName: About to rename engines %d..%d (feature 0x%02X) in language 0x%02X",
6061  id, endid, feature, lang);
6062 
6063  for (; id < endid && buf->HasData(); id++) {
6064  const char *name = buf->ReadString();
6065  grfmsg(8, "FeatureNewName: 0x%04X <- %s", id, name);
6066 
6067  switch (feature) {
6068  case GSF_TRAINS:
6069  case GSF_ROADVEHICLES:
6070  case GSF_SHIPS:
6071  case GSF_AIRCRAFT:
6072  if (!generic) {
6073  Engine *e = GetNewEngine(_cur.grffile, (VehicleType)feature, id, HasBit(_cur.grfconfig->flags, GCF_STATIC));
6074  if (e == nullptr) break;
6075  StringID string = AddGRFString(_cur.grffile->grfid, e->index, lang, new_scheme, false, name, e->info.string_id);
6076  e->info.string_id = string;
6077  } else {
6078  AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, true, name, STR_UNDEFINED);
6079  }
6080  break;
6081 
6082  default:
6083  if (IsInsideMM(id, 0xD000, 0xD400) || IsInsideMM(id, 0xD800, 0xE000)) {
6084  AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, true, name, STR_UNDEFINED);
6085  break;
6086  }
6087 
6088  switch (GB(id, 8, 8)) {
6089  case 0xC4: // Station class name
6090  if (_cur.grffile->stations == nullptr || _cur.grffile->stations[GB(id, 0, 8)] == nullptr) {
6091  grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
6092  } else {
6093  StationClassID cls_id = _cur.grffile->stations[GB(id, 0, 8)]->cls_id;
6094  StationClass::Get(cls_id)->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6095  }
6096  break;
6097 
6098  case 0xC5: // Station name
6099  if (_cur.grffile->stations == nullptr || _cur.grffile->stations[GB(id, 0, 8)] == nullptr) {
6100  grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
6101  } else {
6102  _cur.grffile->stations[GB(id, 0, 8)]->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6103  }
6104  break;
6105 
6106  case 0xC7: // Airporttile name
6107  if (_cur.grffile->airtspec == nullptr || _cur.grffile->airtspec[GB(id, 0, 8)] == nullptr) {
6108  grfmsg(1, "FeatureNewName: Attempt to name undefined airport tile 0x%X, ignoring", GB(id, 0, 8));
6109  } else {
6110  _cur.grffile->airtspec[GB(id, 0, 8)]->name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6111  }
6112  break;
6113 
6114  case 0xC9: // House name
6115  if (_cur.grffile->housespec == nullptr || _cur.grffile->housespec[GB(id, 0, 8)] == nullptr) {
6116  grfmsg(1, "FeatureNewName: Attempt to name undefined house 0x%X, ignoring.", GB(id, 0, 8));
6117  } else {
6118  _cur.grffile->housespec[GB(id, 0, 8)]->building_name = AddGRFString(_cur.grffile->grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
6119  }
6120  break;
6121 
6122  default:
6123  grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id);
6124  break;
6125  }
6126  break;
6127  }
6128  }
6129 }
6130 
6139 static uint16 SanitizeSpriteOffset(uint16& num, uint16 offset, int max_sprites, const char *name)
6140 {
6141 
6142  if (offset >= max_sprites) {
6143  grfmsg(1, "GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites);
6144  uint orig_num = num;
6145  num = 0;
6146  return orig_num;
6147  }
6148 
6149  if (offset + num > max_sprites) {
6150  grfmsg(4, "GraphicsNew: %s sprite overflow, truncating...", name);
6151  uint orig_num = num;
6152  num = std::max(max_sprites - offset, 0);
6153  return orig_num - num;
6154  }
6155 
6156  return 0;
6157 }
6158 
6159 
6165 };
6167 struct Action5Type {
6170  uint16 min_sprites;
6171  uint16 max_sprites;
6172  const char *name;
6173 };
6174 
6176 static const Action5Type _action5_types[] = {
6177  /* Note: min_sprites should not be changed. Therefore these constants are directly here and not in sprites.h */
6178  /* 0x00 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x00" },
6179  /* 0x01 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x01" },
6180  /* 0x02 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x02" },
6181  /* 0x03 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x03" },
6182  /* 0x04 */ { A5BLOCK_ALLOW_OFFSET, SPR_SIGNALS_BASE, 1, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT, "Signal graphics" },
6183  /* 0x05 */ { A5BLOCK_ALLOW_OFFSET, SPR_ELRAIL_BASE, 1, ELRAIL_SPRITE_COUNT, "Rail catenary graphics" },
6184  /* 0x06 */ { A5BLOCK_ALLOW_OFFSET, SPR_SLOPES_BASE, 1, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT, "Foundation graphics" },
6185  /* 0x07 */ { A5BLOCK_INVALID, 0, 75, 0, "TTDP GUI graphics" }, // Not used by OTTD.
6186  /* 0x08 */ { A5BLOCK_ALLOW_OFFSET, SPR_CANALS_BASE, 1, CANALS_SPRITE_COUNT, "Canal graphics" },
6187  /* 0x09 */ { A5BLOCK_ALLOW_OFFSET, SPR_ONEWAY_BASE, 1, ONEWAY_SPRITE_COUNT, "One way road graphics" },
6188  /* 0x0A */ { A5BLOCK_ALLOW_OFFSET, SPR_2CCMAP_BASE, 1, TWOCCMAP_SPRITE_COUNT, "2CC colour maps" },
6189  /* 0x0B */ { A5BLOCK_ALLOW_OFFSET, SPR_TRAMWAY_BASE, 1, TRAMWAY_SPRITE_COUNT, "Tramway graphics" },
6190  /* 0x0C */ { A5BLOCK_INVALID, 0, 133, 0, "Snowy temperate tree" }, // Not yet used by OTTD.
6191  /* 0x0D */ { A5BLOCK_FIXED, SPR_SHORE_BASE, 16, SPR_SHORE_SPRITE_COUNT, "Shore graphics" },
6192  /* 0x0E */ { A5BLOCK_INVALID, 0, 0, 0, "New Signals graphics" }, // Not yet used by OTTD.
6193  /* 0x0F */ { A5BLOCK_ALLOW_OFFSET, SPR_TRACKS_FOR_SLOPES_BASE, 1, TRACKS_FOR_SLOPES_SPRITE_COUNT, "Sloped rail track" },
6194  /* 0x10 */ { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORTX_BASE, 1, AIRPORTX_SPRITE_COUNT, "Airport graphics" },
6195  /* 0x11 */ { A5BLOCK_ALLOW_OFFSET, SPR_ROADSTOP_BASE, 1, ROADSTOP_SPRITE_COUNT, "Road stop graphics" },
6196  /* 0x12 */ { A5BLOCK_ALLOW_OFFSET, SPR_AQUEDUCT_BASE, 1, AQUEDUCT_SPRITE_COUNT, "Aqueduct graphics" },
6197  /* 0x13 */ { A5BLOCK_ALLOW_OFFSET, SPR_AUTORAIL_BASE, 1, AUTORAIL_SPRITE_COUNT, "Autorail graphics" },
6198  /* 0x14 */ { A5BLOCK_INVALID, 0, 1, 0, "Flag graphics" }, // deprecated, no longer used.
6199  /* 0x15 */ { A5BLOCK_ALLOW_OFFSET, SPR_OPENTTD_BASE, 1, OPENTTD_SPRITE_COUNT, "OpenTTD GUI graphics" },
6200  /* 0x16 */ { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORT_PREVIEW_BASE, 1, SPR_AIRPORT_PREVIEW_COUNT, "Airport preview graphics" },
6201  /* 0x17 */ { A5BLOCK_ALLOW_OFFSET, SPR_RAILTYPE_TUNNEL_BASE, 1, RAILTYPE_TUNNEL_BASE_COUNT, "Railtype tunnel base" },
6202  /* 0x18 */ { A5BLOCK_ALLOW_OFFSET, SPR_PALETTE_BASE, 1, PALETTE_SPRITE_COUNT, "Palette" },
6203 };
6204 
6205 /* Action 0x05 */
6206 static void GraphicsNew(ByteReader *buf)
6207 {
6208  /* <05> <graphics-type> <num-sprites> <other data...>
6209  *
6210  * B graphics-type What set of graphics the sprites define.
6211  * E num-sprites How many sprites are in this set?
6212  * V other data Graphics type specific data. Currently unused. */
6213 
6214  uint8 type = buf->ReadByte();
6215  uint16 num = buf->ReadExtendedByte();
6216  uint16 offset = HasBit(type, 7) ? buf->ReadExtendedByte() : 0;
6217  ClrBit(type, 7); // Clear the high bit as that only indicates whether there is an offset.
6218 
6219  if ((type == 0x0D) && (num == 10) && HasBit(_cur.grfconfig->flags, GCF_SYSTEM)) {
6220  /* Special not-TTDP-compatible case used in openttd.grf
6221  * Missing shore sprites and initialisation of SPR_SHORE_BASE */
6222  grfmsg(2, "GraphicsNew: Loading 10 missing shore sprites from extra grf.");
6223  LoadNextSprite(SPR_SHORE_BASE + 0, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_S
6224  LoadNextSprite(SPR_SHORE_BASE + 5, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_W
6225  LoadNextSprite(SPR_SHORE_BASE + 7, *_cur.file, _cur.nfo_line++); // SLOPE_WSE
6226  LoadNextSprite(SPR_SHORE_BASE + 10, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_N
6227  LoadNextSprite(SPR_SHORE_BASE + 11, *_cur.file, _cur.nfo_line++); // SLOPE_NWS
6228  LoadNextSprite(SPR_SHORE_BASE + 13, *_cur.file, _cur.nfo_line++); // SLOPE_ENW
6229  LoadNextSprite(SPR_SHORE_BASE + 14, *_cur.file, _cur.nfo_line++); // SLOPE_SEN
6230  LoadNextSprite(SPR_SHORE_BASE + 15, *_cur.file, _cur.nfo_line++); // SLOPE_STEEP_E
6231  LoadNextSprite(SPR_SHORE_BASE + 16, *_cur.file, _cur.nfo_line++); // SLOPE_EW
6232  LoadNextSprite(SPR_SHORE_BASE + 17, *_cur.file, _cur.nfo_line++); // SLOPE_NS
6234  return;
6235  }
6236 
6237  /* Supported type? */
6238  if ((type >= lengthof(_action5_types)) || (_action5_types[type].block_type == A5BLOCK_INVALID)) {
6239  grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num);
6240  _cur.skip_sprites = num;
6241  return;
6242  }
6243 
6244  const Action5Type *action5_type = &_action5_types[type];
6245 
6246  /* Contrary to TTDP we allow always to specify too few sprites as we allow always an offset,
6247  * except for the long version of the shore type:
6248  * Ignore offset if not allowed */
6249  if ((action5_type->block_type != A5BLOCK_ALLOW_OFFSET) && (offset != 0)) {
6250  grfmsg(1, "GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->name, type);
6251  offset = 0;
6252  }
6253 
6254  /* Ignore action5 if too few sprites are specified. (for TTDP compatibility)
6255  * This does not make sense, if <offset> is allowed */
6256  if ((action5_type->block_type == A5BLOCK_FIXED) && (num < action5_type->min_sprites)) {
6257  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);
6258  _cur.skip_sprites = num;
6259  return;
6260  }
6261 
6262  /* Load at most max_sprites sprites. Skip remaining sprites. (for compatibility with TTDP and future extensions) */
6263  uint16 skip_num = SanitizeSpriteOffset(num, offset, action5_type->max_sprites, action5_type->name);
6264  SpriteID replace = action5_type->sprite_base + offset;
6265 
6266  /* Load <num> sprites starting from <replace>, then skip <skip_num> sprites. */
6267  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);
6268 
6270 
6271  if (type == 0x0B) {
6272  static const SpriteID depot_with_track_offset = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_TRAMWAY_BASE;
6273  static const SpriteID depot_no_track_offset = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_TRAMWAY_BASE;
6274  if (offset <= depot_with_track_offset && offset + num > depot_with_track_offset) _loaded_newgrf_features.tram = TRAMWAY_REPLACE_DEPOT_WITH_TRACK;
6275  if (offset <= depot_no_track_offset && offset + num > depot_no_track_offset) _loaded_newgrf_features.tram = TRAMWAY_REPLACE_DEPOT_NO_TRACK;
6276  }
6277 
6278  /* If the baseset or grf only provides sprites for flat tiles (pre #10282), duplicate those for use on slopes. */
6279  bool dup_oneway_sprites = ((type == 0x09) && (offset + num <= SPR_ONEWAY_SLOPE_N_OFFSET));
6280 
6281  for (; num > 0; num--) {
6282  _cur.nfo_line++;
6283  int load_index = (replace == 0 ? _cur.spriteid++ : replace++);
6284  LoadNextSprite(load_index, *_cur.file, _cur.nfo_line);
6285  if (dup_oneway_sprites) {
6286  DupSprite(load_index, load_index + SPR_ONEWAY_SLOPE_N_OFFSET);
6287  DupSprite(load_index, load_index + SPR_ONEWAY_SLOPE_S_OFFSET);
6288  }
6289  }
6290 
6291  _cur.skip_sprites = skip_num;
6292 }
6293 
6294 /* Action 0x05 (SKIP) */
6295 static void SkipAct5(ByteReader *buf)
6296 {
6297  /* Ignore type byte */
6298  buf->ReadByte();
6299 
6300  /* Skip the sprites of this action */
6301  _cur.skip_sprites = buf->ReadExtendedByte();
6302 
6303  grfmsg(3, "SkipAct5: Skipping %d sprites", _cur.skip_sprites);
6304 }
6305 
6317 bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile)
6318 {
6319  switch (param) {
6320  case 0x00: // current date
6321  *value = std::max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);
6322  return true;
6323 
6324  case 0x01: // current year
6326  return true;
6327 
6328  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)
6329  YearMonthDay ymd;
6330  ConvertDateToYMD(_date, &ymd);
6331  Date start_of_year = ConvertYMDToDate(ymd.year, 0, 1);
6332  *value = ymd.month | (ymd.day - 1) << 8 | (IsLeapYear(ymd.year) ? 1 << 15 : 0) | (_date - start_of_year) << 16;
6333  return true;
6334  }
6335 
6336  case 0x03: // current climate, 0=temp, 1=arctic, 2=trop, 3=toyland
6338  return true;
6339 
6340  case 0x06: // road traffic side, bit 4 clear=left, set=right
6341  *value = _settings_game.vehicle.road_side << 4;
6342  return true;
6343 
6344  case 0x09: // date fraction
6345  *value = _date_fract * 885;
6346  return true;
6347 
6348  case 0x0A: // animation counter
6349  *value = GB(_tick_counter, 0, 16);
6350  return true;
6351 
6352  case 0x0B: { // TTDPatch version
6353  uint major = 2;
6354  uint minor = 6;
6355  uint revision = 1; // special case: 2.0.1 is 2.0.10
6356  uint build = 1382;
6357  *value = (major << 24) | (minor << 20) | (revision << 16) | build;
6358  return true;
6359  }
6360 
6361  case 0x0D: // TTD Version, 00=DOS, 01=Windows
6362  *value = _cur.grfconfig->palette & GRFP_USE_MASK;
6363  return true;
6364 
6365  case 0x0E: // Y-offset for train sprites
6366  *value = _cur.grffile->traininfo_vehicle_pitch;
6367  return true;
6368 
6369  case 0x0F: // Rail track type cost factors
6370  *value = 0;
6371  SB(*value, 0, 8, GetRailTypeInfo(RAILTYPE_RAIL)->cost_multiplier); // normal rail
6373  /* skip elrail multiplier - disabled */
6374  SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_MONO)->cost_multiplier); // monorail
6375  } else {
6376  SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_ELECTRIC)->cost_multiplier); // electified railway
6377  /* Skip monorail multiplier - no space in result */
6378  }
6379  SB(*value, 16, 8, GetRailTypeInfo(RAILTYPE_MAGLEV)->cost_multiplier); // maglev
6380  return true;
6381 
6382  case 0x11: // current rail tool type
6383  *value = 0; // constant fake value to avoid desync
6384  return true;
6385 
6386  case 0x12: // Game mode
6387  *value = _game_mode;
6388  return true;
6389 
6390  /* case 0x13: // Tile refresh offset to left not implemented */
6391  /* case 0x14: // Tile refresh offset to right not implemented */
6392  /* case 0x15: // Tile refresh offset upwards not implemented */
6393  /* case 0x16: // Tile refresh offset downwards not implemented */
6394  /* case 0x17: // temperate snow line not implemented */
6395 
6396  case 0x1A: // Always -1
6397  *value = UINT_MAX;
6398  return true;
6399 
6400  case 0x1B: // Display options
6401  *value = 0x3F; // constant fake value to avoid desync
6402  return true;
6403 
6404  case 0x1D: // TTD Platform, 00=TTDPatch, 01=OpenTTD
6405  *value = 1;
6406  return true;
6407 
6408  case 0x1E: // Miscellaneous GRF features
6409  *value = _misc_grf_features;
6410 
6411  /* Add the local flags */
6412  assert(!HasBit(*value, GMB_TRAIN_WIDTH_32_PIXELS));
6413  if (_cur.grffile->traininfo_vehicle_width == VEHICLEINFO_FULL_VEHICLE_WIDTH) SetBit(*value, GMB_TRAIN_WIDTH_32_PIXELS);
6414  return true;
6415 
6416  /* case 0x1F: // locale dependent settings not implemented to avoid desync */
6417 
6418  case 0x20: { // snow line height
6419  byte snowline = GetSnowLine();
6421  *value = Clamp(snowline * (grffile->grf_version >= 8 ? 1 : TILE_HEIGHT), 0, 0xFE);
6422  } else {
6423  /* No snow */
6424  *value = 0xFF;
6425  }
6426  return true;
6427  }
6428 
6429  case 0x21: // OpenTTD version
6430  *value = _openttd_newgrf_version;
6431  return true;
6432 
6433  case 0x22: // difficulty level
6434  *value = SP_CUSTOM;
6435  return true;
6436 
6437  case 0x23: // long format date
6438  *value = _date;
6439  return true;
6440 
6441  case 0x24: // long format year
6442  *value = _cur_year;
6443  return true;
6444 
6445  default: return false;
6446  }
6447 }
6448 
6449 static uint32 GetParamVal(byte param, uint32 *cond_val)
6450 {
6451  /* First handle variable common with VarAction2 */
6452  uint32 value;
6453  if (GetGlobalVariable(param - 0x80, &value, _cur.grffile)) return value;
6454 
6455  /* Non-common variable */
6456  switch (param) {
6457  case 0x84: { // GRF loading stage
6458  uint32 res = 0;
6459 
6460  if (_cur.stage > GLS_INIT) SetBit(res, 0);
6461  if (_cur.stage == GLS_RESERVE) SetBit(res, 8);
6462  if (_cur.stage == GLS_ACTIVATION) SetBit(res, 9);
6463  return res;
6464  }
6465 
6466  case 0x85: // TTDPatch flags, only for bit tests
6467  if (cond_val == nullptr) {
6468  /* Supported in Action 0x07 and 0x09, not 0x0D */
6469  return 0;
6470  } else {
6471  uint32 index = *cond_val / 0x20;
6472  uint32 param_val = index < lengthof(_ttdpatch_flags) ? _ttdpatch_flags[index] : 0;
6473  *cond_val %= 0x20;
6474  return param_val;
6475  }
6476 
6477  case 0x88: // GRF ID check
6478  return 0;
6479 
6480  /* case 0x99: Global ID offset not implemented */
6481 
6482  default:
6483  /* GRF Parameter */
6484  if (param < 0x80) return _cur.grffile->GetParam(param);
6485 
6486  /* In-game variable. */
6487  grfmsg(1, "Unsupported in-game variable 0x%02X", param);
6488  return UINT_MAX;
6489  }
6490 }
6491 
6492 /* Action 0x06 */
6493 static void CfgApply(ByteReader *buf)
6494 {
6495  /* <06> <param-num> <param-size> <offset> ... <FF>
6496  *
6497  * B param-num Number of parameter to substitute (First = "zero")
6498  * Ignored if that parameter was not specified in newgrf.cfg
6499  * B param-size How many bytes to replace. If larger than 4, the
6500  * bytes of the following parameter are used. In that
6501  * case, nothing is applied unless *all* parameters
6502  * were specified.
6503  * B offset Offset into data from beginning of next sprite
6504  * to place where parameter is to be stored. */
6505 
6506  /* Preload the next sprite */
6507  SpriteFile &file = *_cur.file;
6508  size_t pos = file.GetPos();
6509  uint32 num = file.GetContainerVersion() >= 2 ? file.ReadDword() : file.ReadWord();
6510  uint8 type = file.ReadByte();
6511  byte *preload_sprite = nullptr;
6512 
6513  /* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */
6514  if (type == 0xFF) {
6515  preload_sprite = MallocT<byte>(num);
6516  file.ReadBlock(preload_sprite, num);
6517  }
6518 
6519  /* Reset the file position to the start of the next sprite */
6520  file.SeekTo(pos, SEEK_SET);
6521 
6522  if (type != 0xFF) {
6523  grfmsg(2, "CfgApply: Ignoring (next sprite is real, unsupported)");
6524  free(preload_sprite);
6525  return;
6526  }
6527 
6528  GRFLocation location(_cur.grfconfig->ident.grfid, _cur.nfo_line + 1);
6529  GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
6530  if (it != _grf_line_to_action6_sprite_override.end()) {
6531  free(preload_sprite);
6532  preload_sprite = _grf_line_to_action6_sprite_override[location];
6533  } else {
6534  _grf_line_to_action6_sprite_override[location] = preload_sprite;
6535  }
6536 
6537  /* Now perform the Action 0x06 on our data. */
6538 
6539  for (;;) {
6540  uint i;
6541  uint param_num;
6542  uint param_size;
6543  uint offset;
6544  bool add_value;
6545 
6546  /* Read the parameter to apply. 0xFF indicates no more data to change. */
6547  param_num = buf->ReadByte();
6548  if (param_num == 0xFF) break;
6549 
6550  /* Get the size of the parameter to use. If the size covers multiple
6551  * double words, sequential parameter values are used. */
6552  param_size = buf->ReadByte();
6553 
6554  /* Bit 7 of param_size indicates we should add to the original value
6555  * instead of replacing it. */
6556  add_value = HasBit(param_size, 7);
6557  param_size = GB(param_size, 0, 7);
6558 
6559  /* Where to apply the data to within the pseudo sprite data. */
6560  offset = buf->ReadExtendedByte();
6561 
6562  /* If the parameter is a GRF parameter (not an internal variable) check
6563  * if it (and all further sequential parameters) has been defined. */
6564  if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur.grffile->param_end) {
6565  grfmsg(2, "CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4));
6566  break;
6567  }
6568 
6569  grfmsg(8, "CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset);
6570 
6571  bool carry = false;
6572  for (i = 0; i < param_size && offset + i < num; i++) {
6573  uint32 value = GetParamVal(param_num + i / 4, nullptr);
6574  /* Reset carry flag for each iteration of the variable (only really
6575  * matters if param_size is greater than 4) */
6576  if (i % 4 == 0) carry = false;
6577 
6578  if (add_value) {
6579  uint new_value = preload_sprite[offset + i] + GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0);
6580  preload_sprite[offset + i] = GB(new_value, 0, 8);
6581  /* Check if the addition overflowed */
6582  carry = new_value >= 256;
6583  } else {
6584  preload_sprite[offset + i] = GB(value, (i % 4) * 8, 8);
6585  }
6586  }
6587  }
6588 }
6589 
6600 {
6601  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_STATIC_GRF_CAUSES_DESYNC, c);
6602  error->data = _cur.grfconfig->GetName();
6603 }
6604 
6605 /* Action 0x07
6606  * Action 0x09 */
6607 static void SkipIf(ByteReader *buf)
6608 {
6609  /* <07/09> <param-num> <param-size> <condition-type> <value> <num-sprites>
6610  *
6611  * B param-num
6612  * B param-size
6613  * B condition-type
6614  * V value
6615  * B num-sprites */
6616  uint32 cond_val = 0;
6617  uint32 mask = 0;
6618  bool result;
6619 
6620  uint8 param = buf->ReadByte();
6621  uint8 paramsize = buf->ReadByte();
6622  uint8 condtype = buf->ReadByte();
6623 
6624  if (condtype < 2) {
6625  /* Always 1 for bit tests, the given value should be ignored. */
6626  paramsize = 1;
6627  }
6628 
6629  switch (paramsize) {
6630  case 8: cond_val = buf->ReadDWord(); mask = buf->ReadDWord(); break;
6631  case 4: cond_val = buf->ReadDWord(); mask = 0xFFFFFFFF; break;
6632  case 2: cond_val = buf->ReadWord(); mask = 0x0000FFFF; break;
6633  case 1: cond_val = buf->ReadByte(); mask = 0x000000FF; break;
6634  default: break;
6635  }
6636 
6637  if (param < 0x80 && _cur.grffile->param_end <= param) {
6638  grfmsg(7, "SkipIf: Param %d undefined, skipping test", param);
6639  return;
6640  }
6641 
6642  grfmsg(7, "SkipIf: Test condtype %d, param 0x%02X, condval 0x%08X", condtype, param, cond_val);
6643 
6644  /* condtypes that do not use 'param' are always valid.
6645  * condtypes that use 'param' are either not valid for param 0x88, or they are only valid for param 0x88.
6646  */
6647  if (condtype >= 0x0B) {
6648  /* Tests that ignore 'param' */
6649  switch (condtype) {
6650  case 0x0B: result = GetCargoIDByLabel(BSWAP32(cond_val)) == CT_INVALID;
6651  break;
6652  case 0x0C: result = GetCargoIDByLabel(BSWAP32(cond_val)) != CT_INVALID;
6653  break;
6654  case 0x0D: result = GetRailTypeByLabel(BSWAP32(cond_val)) == INVALID_RAILTYPE;
6655  break;
6656  case 0x0E: result = GetRailTypeByLabel(BSWAP32(cond_val)) != INVALID_RAILTYPE;
6657  break;
6658  case 0x0F: {
6659  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6660  result = rt == INVALID_ROADTYPE || !RoadTypeIsRoad(rt);
6661  break;
6662  }
6663  case 0x10: {
6664  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6665  result = rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt);
6666  break;
6667  }
6668  case 0x11: {
6669  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6670  result = rt == INVALID_ROADTYPE || !RoadTypeIsTram(rt);
6671  break;
6672  }
6673  case 0x12: {
6674  RoadType rt = GetRoadTypeByLabel(BSWAP32(cond_val));
6675  result = rt != INVALID_ROADTYPE && RoadTypeIsTram(rt);
6676  break;
6677  }
6678  default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return;
6679  }
6680  } else if (param == 0x88) {
6681  /* GRF ID checks */
6682 
6683  GRFConfig *c = GetGRFConfig(cond_val, mask);
6684 
6685  if (c != nullptr && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur.grfconfig->flags, GCF_STATIC) && _networking) {
6687  c = nullptr;
6688  }
6689 
6690  if (condtype != 10 && c == nullptr) {
6691  grfmsg(7, "SkipIf: GRFID 0x%08X unknown, skipping test", BSWAP32(cond_val));
6692  return;
6693  }
6694 
6695  switch (condtype) {
6696  /* Tests 0x06 to 0x0A are only for param 0x88, GRFID checks */
6697  case 0x06: // Is GRFID active?
6698  result = c->status == GCS_ACTIVATED;
6699  break;
6700 
6701  case 0x07: // Is GRFID non-active?
6702  result = c->status != GCS_ACTIVATED;
6703  break;
6704 
6705  case 0x08: // GRFID is not but will be active?
6706  result = c->status == GCS_INITIALISED;
6707  break;
6708 
6709  case 0x09: // GRFID is or will be active?
6710  result = c->status == GCS_ACTIVATED || c->status == GCS_INITIALISED;
6711  break;
6712 
6713  case 0x0A: // GRFID is not nor will be active
6714  /* This is the only condtype that doesn't get ignored if the GRFID is not found */
6715  result = c == nullptr || c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND;
6716  break;
6717 
6718  default: grfmsg(1, "SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype); return;
6719  }
6720  } else {
6721  /* Tests that use 'param' and are not GRF ID checks. */
6722  uint32 param_val = GetParamVal(param, &cond_val); // cond_val is modified for param == 0x85
6723  switch (condtype) {
6724  case 0x00: result = !!(param_val & (1 << cond_val));
6725  break;
6726  case 0x01: result = !(param_val & (1 << cond_val));
6727  break;
6728  case 0x02: result = (param_val & mask) == cond_val;
6729  break;
6730  case 0x03: result = (param_val & mask) != cond_val;
6731  break;
6732  case 0x04: result = (param_val & mask) < cond_val;
6733  break;
6734  case 0x05: result = (param_val & mask) > cond_val;
6735  break;
6736  default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return;
6737  }
6738  }
6739 
6740  if (!result) {
6741  grfmsg(2, "SkipIf: Not skipping sprites, test was false");
6742  return;
6743  }
6744 
6745  uint8 numsprites = buf->ReadByte();
6746 
6747  /* numsprites can be a GOTO label if it has been defined in the GRF
6748  * file. The jump will always be the first matching label that follows
6749  * the current nfo_line. If no matching label is found, the first matching
6750  * label in the file is used. */
6751  const GRFLabel *choice = nullptr;
6752  for (const auto &label : _cur.grffile->labels) {
6753  if (label.label != numsprites) continue;
6754 
6755  /* Remember a goto before the current line */
6756  if (choice == nullptr) choice = &label;
6757  /* If we find a label here, this is definitely good */
6758  if (label.nfo_line > _cur.nfo_line) {
6759  choice = &label;
6760  break;
6761  }
6762  }
6763 
6764  if (choice != nullptr) {
6765  grfmsg(2, "SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line);
6766  _cur.file->SeekTo(choice->pos, SEEK_SET);
6767  _cur.nfo_line = choice->nfo_line;
6768  return;
6769  }
6770 
6771  grfmsg(2, "SkipIf: Skipping %d sprites, test was true", numsprites);
6772  _cur.skip_sprites = numsprites;
6773  if (_cur.skip_sprites == 0) {
6774  /* Zero means there are no sprites to skip, so
6775  * we use -1 to indicate that all further
6776  * sprites should be skipped. */
6777  _cur.skip_sprites = -1;
6778 
6779  /* If an action 8 hasn't been encountered yet, disable the grf. */
6780  if (_cur.grfconfig->status != (_cur.stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED)) {
6781  DisableGrf();
6782  }
6783  }
6784 }
6785 
6786 
6787 /* Action 0x08 (GLS_FILESCAN) */
6788 static void ScanInfo(ByteReader *buf)
6789 {
6790  uint8 grf_version = buf->ReadByte();
6791  uint32 grfid = buf->ReadDWord();
6792  const char *name = buf->ReadString();
6793 
6794  _cur.grfconfig->ident.grfid = grfid;
6795 
6796  if (grf_version < 2 || grf_version > 8) {
6798  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);
6799  }
6800 
6801  /* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */
6802  if (GB(grfid, 0, 8) == 0xFF) SetBit(_cur.grfconfig->flags, GCF_SYSTEM);
6803 
6804  AddGRFTextToList(_cur.grfconfig->name, 0x7F, grfid, false, name);
6805 
6806  if (buf->HasData()) {
6807  const char *info = buf->ReadString();
6808  AddGRFTextToList(_cur.grfconfig->info, 0x7F, grfid, true, info);
6809  }
6810 
6811  /* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */
6812  _cur.skip_sprites = -1;
6813 }
6814 
6815 /* Action 0x08 */
6816 static void GRFInfo(ByteReader *buf)
6817 {
6818  /* <08> <version> <grf-id> <name> <info>
6819  *
6820  * B version newgrf version, currently 06
6821  * 4*B grf-id globally unique ID of this .grf file
6822  * S name name of this .grf set
6823  * S info string describing the set, and e.g. author and copyright */
6824 
6825  uint8 version = buf->ReadByte();
6826  uint32 grfid = buf->ReadDWord();
6827  const char *name = buf->ReadString();
6828 
6829  if (_cur.stage < GLS_RESERVE && _cur.grfconfig->status != GCS_UNKNOWN) {
6830  DisableGrf(STR_NEWGRF_ERROR_MULTIPLE_ACTION_8);
6831  return;
6832  }
6833 
6834  if (_cur.grffile->grfid != grfid) {
6835  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));
6836  _cur.grffile->grfid = grfid;
6837  }
6838 
6839  _cur.grffile->grf_version = version;
6840  _cur.grfconfig->status = _cur.stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED;
6841 
6842  /* Do swap the GRFID for displaying purposes since people expect that */
6843  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);
6844 }
6845 
6846 /* Action 0x0A */
6847 static void SpriteReplace(ByteReader *buf)
6848 {
6849  /* <0A> <num-sets> <set1> [<set2> ...]
6850  * <set>: <num-sprites> <first-sprite>
6851  *
6852  * B num-sets How many sets of sprites to replace.
6853  * Each set:
6854  * B num-sprites How many sprites are in this set
6855  * W first-sprite First sprite number to replace */
6856 
6857  uint8 num_sets = buf->ReadByte();
6858 
6859  for (uint i = 0; i < num_sets; i++) {
6860  uint8 num_sprites = buf->ReadByte();
6861  uint16 first_sprite = buf->ReadWord();
6862 
6863  grfmsg(2, "SpriteReplace: [Set %d] Changing %d sprites, beginning with %d",
6864  i, num_sprites, first_sprite
6865  );
6866 
6867  for (uint j = 0; j < num_sprites; j++) {
6868  int load_index = first_sprite + j;
6869  _cur.nfo_line++;
6870  LoadNextSprite(load_index, *_cur.file, _cur.nfo_line); // XXX
6871 
6872  /* Shore sprites now located at different addresses.
6873  * So detect when the old ones get replaced. */
6874  if (IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) {
6876  }
6877  }
6878  }
6879 }
6880 
6881 /* Action 0x0A (SKIP) */
6882 static void SkipActA(ByteReader *buf)
6883 {
6884  uint8 num_sets = buf->ReadByte();
6885 
6886  for (uint i = 0; i < num_sets; i++) {
6887  /* Skip the sprites this replaces */
6888  _cur.skip_sprites += buf->ReadByte();
6889  /* But ignore where they go */
6890  buf->ReadWord();
6891  }
6892 
6893  grfmsg(3, "SkipActA: Skipping %d sprites", _cur.skip_sprites);
6894 }
6895 
6896 /* Action 0x0B */
6897 static void GRFLoadError(ByteReader *buf)
6898 {
6899  /* <0B> <severity> <language-id> <message-id> [<message...> 00] [<data...>] 00 [<parnum>]
6900  *
6901  * B severity 00: notice, continue loading grf file
6902  * 01: warning, continue loading grf file
6903  * 02: error, but continue loading grf file, and attempt
6904  * loading grf again when loading or starting next game
6905  * 03: error, abort loading and prevent loading again in
6906  * the future (only when restarting the patch)
6907  * B language-id see action 4, use 1F for built-in error messages
6908  * B message-id message to show, see below
6909  * S message for custom messages (message-id FF), text of the message
6910  * not present for built-in messages.
6911  * V data additional data for built-in (or custom) messages
6912  * B parnum parameter numbers to be shown in the message (maximum of 2) */
6913 
6914  static const StringID msgstr[] = {
6915  STR_NEWGRF_ERROR_VERSION_NUMBER,
6916  STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
6917  STR_NEWGRF_ERROR_UNSET_SWITCH,
6918  STR_NEWGRF_ERROR_INVALID_PARAMETER,
6919  STR_NEWGRF_ERROR_LOAD_BEFORE,
6920  STR_NEWGRF_ERROR_LOAD_AFTER,
6921  STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
6922  };
6923 
6924  static const StringID sevstr[] = {
6925  STR_NEWGRF_ERROR_MSG_INFO,
6926  STR_NEWGRF_ERROR_MSG_WARNING,
6927  STR_NEWGRF_ERROR_MSG_ERROR,
6928  STR_NEWGRF_ERROR_MSG_FATAL
6929  };
6930 
6931  byte severity = buf->ReadByte();
6932  byte lang = buf->ReadByte();
6933  byte message_id = buf->ReadByte();
6934 
6935  /* Skip the error if it isn't valid for the current language. */
6936  if (!CheckGrfLangID(lang, _cur.grffile->grf_version)) return;
6937 
6938  /* Skip the error until the activation stage unless bit 7 of the severity
6939  * is set. */
6940  if (!HasBit(severity, 7) && _cur.stage == GLS_INIT) {
6941  grfmsg(7, "GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur.stage);
6942  return;
6943  }
6944  ClrBit(severity, 7);
6945 
6946  if (severity >= lengthof(sevstr)) {
6947  grfmsg(7, "GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity);
6948  severity = 2;
6949  } else if (severity == 3) {
6950  /* This is a fatal error, so make sure the GRF is deactivated and no
6951  * more of it gets loaded. */
6952  DisableGrf();
6953 
6954  /* Make sure we show fatal errors, instead of silly infos from before */
6955  delete _cur.grfconfig->error;
6956  _cur.grfconfig->error = nullptr;
6957  }
6958 
6959  if (message_id >= lengthof(msgstr) && message_id != 0xFF) {
6960  grfmsg(7, "GRFLoadError: Invalid message id.");
6961  return;
6962  }
6963 
6964  if (buf->Remaining() <= 1) {
6965  grfmsg(7, "GRFLoadError: No message data supplied.");
6966  return;
6967  }
6968 
6969  /* For now we can only show one message per newgrf file. */
6970  if (_cur.grfconfig->error != nullptr) return;
6971 
6972  GRFError *error = new GRFError(sevstr[severity]);
6973 
6974  if (message_id == 0xFF) {
6975  /* This is a custom error message. */
6976  if (buf->HasData()) {
6977  const char *message = buf->ReadString();
6978 
6979  error->custom_message = TranslateTTDPatchCodes(_cur.grffile->grfid, lang, true, message, SCC_RAW_STRING_POINTER);
6980  } else {
6981  grfmsg(7, "GRFLoadError: No custom message supplied.");
6982  error->custom_message.clear();
6983  }
6984  } else {
6985  error->message = msgstr[message_id];
6986  }
6987 
6988  if (buf->HasData()) {
6989  const char *data = buf->ReadString();
6990 
6991  error->data = TranslateTTDPatchCodes(_cur.grffile->grfid, lang, true, data);
6992  } else {
6993  grfmsg(7, "GRFLoadError: No message data supplied.");
6994  error->data.clear();
6995  }
6996 
6997  /* Only two parameter numbers can be used in the string. */
6998  for (uint i = 0; i < lengthof(error->param_value) && buf->HasData(); i++) {
6999  uint param_number = buf->ReadByte();
7000  error->param_value[i] = _cur.grffile->GetParam(param_number);
7001  }
7002 
7003  _cur.grfconfig->error = error;
7004 }
7005 
7006 /* Action 0x0C */
7007 static void GRFComment(ByteReader *buf)
7008 {
7009  /* <0C> [<ignored...>]
7010  *
7011  * V ignored Anything following the 0C is ignored */
7012 
7013  if (!buf->HasData()) return;
7014 
7015  const char *text = buf->ReadString();
7016  grfmsg(2, "GRFComment: %s", text);
7017 }
7018 
7019 /* Action 0x0D (GLS_SAFETYSCAN) */
7020 static void SafeParamSet(ByteReader *buf)
7021 {
7022  uint8 target = buf->ReadByte();
7023 
7024  /* Writing GRF parameters and some bits of 'misc GRF features' are safe. */
7025  if (target < 0x80 || target == 0x9E) return;
7026 
7027  /* GRM could be unsafe, but as here it can only happen after other GRFs
7028  * are loaded, it should be okay. If the GRF tried to use the slots it
7029  * reserved, it would be marked unsafe anyway. GRM for (e.g. bridge)
7030  * sprites is considered safe. */
7031 
7032  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
7033 
7034  /* Skip remainder of GRF */
7035  _cur.skip_sprites = -1;
7036 }
7037 
7038 
7039 static uint32 GetPatchVariable(uint8 param)
7040 {
7041  switch (param) {
7042  /* start year - 1920 */
7044 
7045  /* freight trains weight factor */
7046  case 0x0E: return _settings_game.vehicle.freight_trains;
7047 
7048  /* empty wagon speed increase */
7049  case 0x0F: return 0;
7050 
7051  /* plane speed factor; our patch option is reversed from TTDPatch's,
7052  * the following is good for 1x, 2x and 4x (most common?) and...
7053  * well not really for 3x. */
7054  case 0x10:
7056  default:
7057  case 4: return 1;
7058  case 3: return 2;
7059  case 2: return 2;
7060  case 1: return 4;
7061  }
7062 
7063 
7064  /* 2CC colourmap base sprite */
7065  case 0x11: return SPR_2CCMAP_BASE;
7066 
7067  /* map size: format = -MABXYSS
7068  * M : the type of map
7069  * bit 0 : set : squared map. Bit 1 is now not relevant
7070  * clear : rectangle map. Bit 1 will indicate the bigger edge of the map
7071  * bit 1 : set : Y is the bigger edge. Bit 0 is clear
7072  * clear : X is the bigger edge.
7073  * A : minimum edge(log2) of the map
7074  * B : maximum edge(log2) of the map
7075  * XY : edges(log2) of each side of the map.
7076  * SS : combination of both X and Y, thus giving the size(log2) of the map
7077  */
7078  case 0x13: {
7079  byte map_bits = 0;
7080  byte log_X = MapLogX() - 6; // subtraction is required to make the minimal size (64) zero based
7081  byte log_Y = MapLogY() - 6;
7082  byte max_edge = std::max(log_X, log_Y);
7083 
7084  if (log_X == log_Y) { // we have a squared map, since both edges are identical
7085  SetBit(map_bits, 0);
7086  } else {
7087  if (max_edge == log_Y) SetBit(map_bits, 1); // edge Y been the biggest, mark it
7088  }
7089 
7090  return (map_bits << 24) | (std::min(log_X, log_Y) << 20) | (max_edge << 16) |
7091  (log_X << 12) | (log_Y << 8) | (log_X + log_Y);
7092  }
7093 
7094  /* The maximum height of the map. */
7095  case 0x14:
7097 
7098  /* Extra foundations base sprite */
7099  case 0x15:
7100  return SPR_SLOPES_BASE;
7101 
7102  /* Shore base sprite */
7103  case 0x16:
7104  return SPR_SHORE_BASE;
7105 
7106  /* Game map seed */
7107  case 0x17:
7109 
7110  default:
7111  grfmsg(2, "ParamSet: Unknown Patch variable 0x%02X.", param);
7112  return 0;
7113  }
7114 }
7115 
7116 
7117 static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target, const char *type)
7118 {
7119  uint start = 0;
7120  uint size = 0;
7121 
7122  if (op == 6) {
7123  /* Return GRFID of set that reserved ID */
7124  return grm[_cur.grffile->GetParam(target)];
7125  }
7126 
7127  /* With an operation of 2 or 3, we want to reserve a specific block of IDs */
7128  if (op == 2 || op == 3) start = _cur.grffile->GetParam(target);
7129 
7130  for (uint i = start; i < num_ids; i++) {
7131  if (grm[i] == 0) {
7132  size++;
7133  } else {
7134  if (op == 2 || op == 3) break;
7135  start = i + 1;
7136  size = 0;
7137  }
7138 
7139  if (size == count) break;
7140  }
7141 
7142  if (size == count) {
7143  /* Got the slot... */
7144  if (op == 0 || op == 3) {
7145  grfmsg(2, "ParamSet: GRM: Reserving %d %s at %d", count, type, start);
7146  for (uint i = 0; i < count; i++) grm[start + i] = _cur.grffile->grfid;
7147  }
7148  return start;
7149  }
7150 
7151  /* Unable to allocate */
7152  if (op != 4 && op != 5) {
7153  /* Deactivate GRF */
7154  grfmsg(0, "ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type);
7155  DisableGrf(STR_NEWGRF_ERROR_GRM_FAILED);
7156  return UINT_MAX;
7157  }
7158 
7159  grfmsg(1, "ParamSet: GRM: Unable to allocate %d %s", count, type);
7160  return UINT_MAX;
7161 }
7162 
7163 
7165 static void ParamSet(ByteReader *buf)
7166 {
7167  /* <0D> <target> <operation> <source1> <source2> [<data>]
7168  *
7169  * B target parameter number where result is stored
7170  * B operation operation to perform, see below
7171  * B source1 first source operand
7172  * B source2 second source operand
7173  * D data data to use in the calculation, not necessary
7174  * if both source1 and source2 refer to actual parameters
7175  *
7176  * Operations
7177  * 00 Set parameter equal to source1
7178  * 01 Addition, source1 + source2
7179  * 02 Subtraction, source1 - source2
7180  * 03 Unsigned multiplication, source1 * source2 (both unsigned)
7181  * 04 Signed multiplication, source1 * source2 (both signed)
7182  * 05 Unsigned bit shift, source1 by source2 (source2 taken to be a
7183  * signed quantity; left shift if positive and right shift if
7184  * negative, source1 is unsigned)
7185  * 06 Signed bit shift, source1 by source2
7186  * (source2 like in 05, and source1 as well)
7187  */
7188 
7189  uint8 target = buf->ReadByte();
7190  uint8 oper = buf->ReadByte();
7191  uint32 src1 = buf->ReadByte();
7192  uint32 src2 = buf->ReadByte();
7193 
7194  uint32 data = 0;
7195  if (buf->Remaining() >= 4) data = buf->ReadDWord();
7196 
7197  /* You can add 80 to the operation to make it apply only if the target
7198  * is not defined yet. In this respect, a parameter is taken to be
7199  * defined if any of the following applies:
7200  * - it has been set to any value in the newgrf(w).cfg parameter list
7201  * - it OR A PARAMETER WITH HIGHER NUMBER has been set to any value by
7202  * an earlier action D */
7203  if (HasBit(oper, 7)) {
7204  if (target < 0x80 && target < _cur.grffile->param_end) {
7205  grfmsg(7, "ParamSet: Param %u already defined, skipping", target);
7206  return;
7207  }
7208 
7209  oper = GB(oper, 0, 7);
7210  }
7211 
7212  if (src2 == 0xFE) {
7213  if (GB(data, 0, 8) == 0xFF) {
7214  if (data == 0x0000FFFF) {
7215  /* Patch variables */
7216  src1 = GetPatchVariable(src1);
7217  } else {
7218  /* GRF Resource Management */
7219  uint8 op = src1;
7220  uint8 feature = GB(data, 8, 8);
7221  uint16 count = GB(data, 16, 16);
7222 
7223  if (_cur.stage == GLS_RESERVE) {
7224  if (feature == 0x08) {
7225  /* General sprites */
7226  if (op == 0) {
7227  /* Check if the allocated sprites will fit below the original sprite limit */
7228  if (_cur.spriteid + count >= 16384) {
7229  grfmsg(0, "ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count);
7230  DisableGrf(STR_NEWGRF_ERROR_GRM_FAILED);
7231  return;
7232  }
7233 
7234  /* Reserve space at the current sprite ID */
7235  grfmsg(4, "ParamSet: GRM: Allocated %d sprites at %d", count, _cur.spriteid);
7236  _grm_sprites[GRFLocation(_cur.grffile->grfid, _cur.nfo_line)] = _cur.spriteid;
7237  _cur.spriteid += count;
7238  }
7239  }
7240  /* Ignore GRM result during reservation */
7241  src1 = 0;
7242  } else if (_cur.stage == GLS_ACTIVATION) {
7243  switch (feature) {
7244  case 0x00: // Trains
7245  case 0x01: // Road Vehicles
7246  case 0x02: // Ships
7247  case 0x03: // Aircraft
7249  src1 = PerformGRM(&_grm_engines[_engine_offsets[feature]], _engine_counts[feature], count, op, target, "vehicles");
7250  if (_cur.skip_sprites == -1) return;
7251  } else {
7252  /* GRM does not apply for dynamic engine allocation. */
7253  switch (op) {
7254  case 2:
7255  case 3:
7256  src1 = _cur.grffile->GetParam(target);
7257  break;
7258 
7259  default:
7260  src1 = 0;
7261  break;
7262  }
7263  }
7264  break;
7265 
7266  case 0x08: // General sprites
7267  switch (op) {
7268  case 0:
7269  /* Return space reserved during reservation stage */
7270  src1 = _grm_sprites[GRFLocation(_cur.grffile->grfid, _cur.nfo_line)];
7271  grfmsg(4, "ParamSet: GRM: Using pre-allocated sprites at %d", src1);
7272  break;
7273 
7274  case 1:
7275  src1 = _cur.spriteid;
7276  break;
7277 
7278  default:
7279  grfmsg(1, "ParamSet: GRM: Unsupported operation %d for general sprites", op);
7280  return;
7281  }
7282  break;
7283 
7284  case 0x0B: // Cargo
7285  /* There are two ranges: one for cargo IDs and one for cargo bitmasks */
7286  src1 = PerformGRM(_grm_cargoes, NUM_CARGO * 2, count, op, target, "cargoes");
7287  if (_cur.skip_sprites == -1) return;
7288  break;
7289 
7290  default: grfmsg(1, "ParamSet: GRM: Unsupported feature 0x%X", feature); return;
7291  }
7292  } else {
7293  /* Ignore GRM during initialization */
7294  src1 = 0;
7295  }
7296  }
7297  } else {
7298  /* Read another GRF File's parameter */
7299  const GRFFile *file = GetFileByGRFID(data);
7300  GRFConfig *c = GetGRFConfig(data);
7301  if (c != nullptr && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur.grfconfig->flags, GCF_STATIC) && _networking) {
7302  /* Disable the read GRF if it is a static NewGRF. */
7304  src1 = 0;
7305  } else if (file == nullptr || c == nullptr || c->status == GCS_DISABLED) {
7306  src1 = 0;
7307  } else if (src1 == 0xFE) {
7308  src1 = c->version;
7309  } else {
7310  src1 = file->GetParam(src1);
7311  }
7312  }
7313  } else {
7314  /* The source1 and source2 operands refer to the grf parameter number
7315  * like in action 6 and 7. In addition, they can refer to the special
7316  * variables available in action 7, or they can be FF to use the value
7317  * of <data>. If referring to parameters that are undefined, a value
7318  * of 0 is used instead. */
7319  src1 = (src1 == 0xFF) ? data : GetParamVal(src1, nullptr);
7320  src2 = (src2 == 0xFF) ? data : GetParamVal(src2, nullptr);
7321  }
7322 
7323  uint32 res;
7324  switch (oper) {
7325  case 0x00:
7326  res = src1;
7327  break;
7328 
7329  case 0x01:
7330  res = src1 + src2;
7331  break;
7332 
7333  case 0x02:
7334  res = src1 - src2;
7335  break;
7336 
7337  case 0x03:
7338  res = src1 * src2;
7339  break;
7340 
7341  case 0x04:
7342  res = (int32)src1 * (int32)src2;
7343  break;
7344 
7345  case 0x05:
7346  if ((int32)src2 < 0) {
7347  res = src1 >> -(int32)src2;
7348  } else {
7349  res = src1 << (src2 & 0x1F); // Same behaviour as in EvalAdjustT, mask 'value' to 5 bits, which should behave the same on all architectures.
7350  }
7351  break;
7352 
7353  case 0x06:
7354  if ((int32)src2 < 0) {
7355  res = (int32)src1 >> -(int32)src2;
7356  } else {
7357  res = (int32)src1 << (src2 & 0x1F); // Same behaviour as in EvalAdjustT, mask 'value' to 5 bits, which should behave the same on all architectures.
7358  }
7359  break;
7360 
7361  case 0x07: // Bitwise AND
7362  res = src1 & src2;
7363  break;
7364 
7365  case 0x08: // Bitwise OR
7366  res = src1 | src2;
7367  break;
7368 
7369  case 0x09: // Unsigned division
7370  if (src2 == 0) {
7371  res = src1;
7372  } else {
7373  res = src1 / src2;
7374  }
7375  break;
7376 
7377  case 0x0A: // Signed division
7378  if (src2 == 0) {
7379  res = src1;
7380  } else {
7381  res = (int32)src1 / (int32)src2;
7382  }
7383  break;
7384 
7385  case 0x0B: // Unsigned modulo
7386  if (src2 == 0) {
7387  res = src1;
7388  } else {
7389  res = src1 % src2;
7390  }
7391  break;
7392 
7393  case 0x0C: // Signed modulo
7394  if (src2 == 0) {
7395  res = src1;
7396  } else {
7397  res = (int32)src1 % (int32)src2;
7398  }
7399  break;
7400 
7401  default: grfmsg(0, "ParamSet: Unknown operation %d, skipping", oper); return;
7402  }
7403 
7404  switch (target) {
7405  case 0x8E: // Y-Offset for train sprites
7406  _cur.grffile->traininfo_vehicle_pitch = res;
7407  break;
7408 
7409  case 0x8F: { // Rail track type cost factors
7410  extern RailtypeInfo _railtypes[RAILTYPE_END];
7411  _railtypes[RAILTYPE_RAIL].cost_multiplier = GB(res, 0, 8);
7413  _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 0, 8);
7414  _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 8, 8);
7415  } else {
7416  _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 8, 8);
7417  _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 16, 8);
7418  }
7419  _railtypes[RAILTYPE_MAGLEV].cost_multiplier = GB(res, 16, 8);
7420  break;
7421  }
7422 
7423  /* not implemented */
7424  case 0x93: // Tile refresh offset to left -- Intended to allow support for larger sprites, not necessary for OTTD
7425  case 0x94: // Tile refresh offset to right
7426  case 0x95: // Tile refresh offset upwards
7427  case 0x96: // Tile refresh offset downwards
7428  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
7429  case 0x99: // Global ID offset -- Not necessary since IDs are remapped automatically
7430  grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
7431  break;
7432 
7433  case 0x9E: // Miscellaneous GRF features
7434  /* Set train list engine width */
7435  _cur.grffile->traininfo_vehicle_width = HasBit(res, GMB_TRAIN_WIDTH_32_PIXELS) ? VEHICLEINFO_FULL_VEHICLE_WIDTH : TRAININFO_DEFAULT_VEHICLE_WIDTH;
7436  /* Remove the local flags from the global flags */
7438 
7439  /* Only copy safe bits for static grfs */
7440  if (HasBit(_cur.grfconfig->flags, GCF_STATIC)) {
7441  uint32 safe_bits = 0;
7442  SetBit(safe_bits, GMB_SECOND_ROCKY_TILE_SET);
7443 
7444  _misc_grf_features = (_misc_grf_features & ~safe_bits) | (res & safe_bits);
7445  } else {
7446  _misc_grf_features = res;
7447  }
7448  break;
7449 
7450  case 0x9F: // locale-dependent settings
7451  grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
7452  break;
7453 
7454  default:
7455  if (target < 0x80) {
7456  _cur.grffile->param[target] = res;
7457  /* param is zeroed by default */
7458  if (target + 1U > _cur.grffile->param_end) _cur.grffile->param_end = target + 1;
7459  } else {
7460  grfmsg(7, "ParamSet: Skipping unknown target 0x%02X", target);
7461  }
7462  break;
7463  }
7464 }
7465 
7466 /* Action 0x0E (GLS_SAFETYSCAN) */
7467 static void SafeGRFInhibit(ByteReader *buf)
7468 {
7469  /* <0E> <num> <grfids...>
7470  *
7471  * B num Number of GRFIDs that follow
7472  * D grfids GRFIDs of the files to deactivate */
7473 
7474  uint8 num = buf->ReadByte();
7475 
7476  for (uint i = 0; i < num; i++) {
7477  uint32 grfid = buf->ReadDWord();
7478 
7479  /* GRF is unsafe it if tries to deactivate other GRFs */
7480  if (grfid != _cur.grfconfig->ident.grfid) {
7481  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
7482 
7483  /* Skip remainder of GRF */
7484  _cur.skip_sprites = -1;
7485 
7486  return;
7487  }
7488  }
7489 }
7490 
7491 /* Action 0x0E */
7492 static void GRFInhibit(ByteReader *buf)
7493 {
7494  /* <0E> <num> <grfids...>
7495  *
7496  * B num Number of GRFIDs that follow
7497  * D grfids GRFIDs of the files to deactivate */
7498 
7499  uint8 num = buf->ReadByte();
7500 
7501  for (uint i = 0; i < num; i++) {
7502  uint32 grfid = buf->ReadDWord();
7503  GRFConfig *file = GetGRFConfig(grfid);
7504 
7505  /* Unset activation flag */
7506  if (file != nullptr && file != _cur.grfconfig) {
7507  grfmsg(2, "GRFInhibit: Deactivating file '%s'", file->filename);
7508  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_FORCEFULLY_DISABLED, file);
7509  error->data = _cur.grfconfig->GetName();
7510  }
7511  }
7512 }
7513 
7515 static void FeatureTownName(ByteReader *buf)
7516 {
7517  /* <0F> <id> <style-name> <num-parts> <parts>
7518  *
7519  * B id ID of this definition in bottom 7 bits (final definition if bit 7 set)
7520  * V style-name Name of the style (only for final definition)
7521  * B num-parts Number of parts in this definition
7522  * V parts The parts */
7523 
7524  uint32 grfid = _cur.grffile->grfid;
7525 
7526  GRFTownName *townname = AddGRFTownName(grfid);
7527 
7528  byte id = buf->ReadByte();
7529  grfmsg(6, "FeatureTownName: definition 0x%02X", id & 0x7F);
7530 
7531  if (HasBit(id, 7)) {
7532  /* Final definition */
7533  ClrBit(id, 7);
7534  bool new_scheme = _cur.grffile->grf_version >= 7;
7535 
7536  byte lang = buf->ReadByte();
7537 
7538  byte nb_gen = townname->nb_gen;
7539  do {
7540  ClrBit(lang, 7);
7541 
7542  const char *name = buf->ReadString();
7543 
7544  std::string lang_name = TranslateTTDPatchCodes(grfid, lang, false, name);
7545  grfmsg(6, "FeatureTownName: lang 0x%X -> '%s'", lang, lang_name.c_str());
7546 
7547  townname->name[nb_gen] = AddGRFString(grfid, id, lang, new_scheme, false, name, STR_UNDEFINED);
7548 
7549  lang = buf->ReadByte();
7550  } while (lang != 0);
7551  townname->id[nb_gen] = id;
7552  townname->nb_gen++;
7553  }
7554 
7555  byte nb = buf->ReadByte();
7556  grfmsg(6, "FeatureTownName: %u parts", nb);
7557 
7558  townname->nbparts[id] = nb;
7559  townname->partlist[id] = CallocT<NamePartList>(nb);
7560 
7561  for (int i = 0; i < nb; i++) {
7562  byte nbtext = buf->ReadByte();
7563  townname->partlist[id][i].bitstart = buf->ReadByte();
7564  townname->partlist[id][i].bitcount = buf->ReadByte();
7565  townname->partlist[id][i].maxprob = 0;
7566  townname->partlist[id][i].partcount = nbtext;
7567  townname->partlist[id][i].parts = CallocT<NamePart>(nbtext);
7568  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);
7569 
7570  for (int j = 0; j < nbtext; j++) {
7571  byte prob = buf->ReadByte();
7572 
7573  if (HasBit(prob, 7)) {
7574  byte ref_id = buf->ReadByte();
7575 
7576  if (townname->nbparts[ref_id] == 0) {
7577  grfmsg(0, "FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id);
7578  DelGRFTownName(grfid);
7579  DisableGrf(STR_NEWGRF_ERROR_INVALID_ID);
7580  return;
7581  }
7582 
7583  grfmsg(6, "FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F);
7584  townname->partlist[id][i].parts[j].data.id = ref_id;
7585  } else {
7586  const char *text = buf->ReadString();
7587  townname->partlist[id][i].parts[j].data.text = stredup(TranslateTTDPatchCodes(grfid, 0, false, text).c_str());
7588  grfmsg(6, "FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[id][i].parts[j].data.text, prob);
7589  }
7590  townname->partlist[id][i].parts[j].prob = prob;
7591  townname->partlist[id][i].maxprob += GB(prob, 0, 7);
7592  }
7593  grfmsg(6, "FeatureTownName: part %d, total probability %d", i, townname->partlist[id][i].maxprob);
7594  }
7595 }
7596 
7598 static void DefineGotoLabel(ByteReader *buf)
7599 {
7600  /* <10> <label> [<comment>]
7601  *
7602  * B label The label to define
7603  * V comment Optional comment - ignored */
7604 
7605  byte nfo_label = buf->ReadByte();
7606 
7607  _cur.grffile->labels.emplace_back(nfo_label, _cur.nfo_line, _cur.file->GetPos());
7608 
7609  grfmsg(2, "DefineGotoLabel: GOTO target with label 0x%02X", nfo_label);
7610 }
7611 
7616 static void ImportGRFSound(SoundEntry *sound)
7617 {
7618  const GRFFile *file;
7619  uint32 grfid = _cur.file->ReadDword();
7620  SoundID sound_id = _cur.file->ReadWord();
7621 
7622  file = GetFileByGRFID(grfid);
7623  if (file == nullptr || file->sound_offset == 0) {
7624  grfmsg(1, "ImportGRFSound: Source file not available");
7625  return;
7626  }
7627 
7628  if (sound_id >= file->num_sounds) {
7629  grfmsg(1, "ImportGRFSound: Sound effect %d is invalid", sound_id);
7630  return;
7631  }
7632 
7633  grfmsg(2, "ImportGRFSound: Copying sound %d (%d) from file %X", sound_id, file->sound_offset + sound_id, grfid);
7634 
7635  *sound = *GetSound(file->sound_offset + sound_id);
7636 
7637  /* Reset volume and priority, which TTDPatch doesn't copy */
7638  sound->volume = 128;
7639  sound->priority = 0;
7640 }
7641 
7647 static void LoadGRFSound(size_t offs, SoundEntry *sound)
7648 {
7649  /* Set default volume and priority */
7650  sound->volume = 0x80;
7651  sound->priority = 0;
7652 
7653  if (offs != SIZE_MAX) {
7654  /* Sound is present in the NewGRF. */
7655  sound->file = _cur.file;
7656  sound->file_offset = offs;
7657  sound->grf_container_ver = _cur.file->GetContainerVersion();
7658  }
7659 }
7660 
7661 /* Action 0x11 */
7662 static void GRFSound(ByteReader *buf)
7663 {
7664  /* <11> <num>
7665  *
7666  * W num Number of sound files that follow */
7667 
7668  uint16 num = buf->ReadWord();
7669  if (num == 0) return;
7670 
7671  SoundEntry *sound;
7672  if (_cur.grffile->sound_offset == 0) {
7673  _cur.grffile->sound_offset = GetNumSounds();
7674  _cur.grffile->num_sounds = num;
7675  sound = AllocateSound(num);
7676  } else {
7677  sound = GetSound(_cur.grffile->sound_offset);
7678  }
7679 
7680  SpriteFile &file = *_cur.file;
7681  byte grf_container_version = file.GetContainerVersion();
7682  for (int i = 0; i < num; i++) {
7683  _cur.nfo_line++;
7684 
7685  /* Check whether the index is in range. This might happen if multiple action 11 are present.
7686  * While this is invalid, we do not check for this. But we should prevent it from causing bigger trouble */
7687  bool invalid = i >= _cur.grffile->num_sounds;
7688 
7689  size_t offs = file.GetPos();
7690 
7691  uint32 len = grf_container_version >= 2 ? file.ReadDword() : file.ReadWord();
7692  byte type = file.ReadByte();
7693 
7694  if (grf_container_version >= 2 && type == 0xFD) {
7695  /* Reference to sprite section. */
7696  if (invalid) {
7697  grfmsg(1, "GRFSound: Sound index out of range (multiple Action 11?)");
7698  file.SkipBytes(len);
7699  } else if (len != 4) {
7700  grfmsg(1, "GRFSound: Invalid sprite section import");
7701  file.SkipBytes(len);
7702  } else {
7703  uint32 id = file.ReadDword();
7704  if (_cur.stage == GLS_INIT) LoadGRFSound(GetGRFSpriteOffset(id), sound + i);
7705  }
7706  continue;
7707  }
7708 
7709  if (type != 0xFF) {
7710  grfmsg(1, "GRFSound: Unexpected RealSprite found, skipping");
7711  file.SkipBytes(7);
7712  SkipSpriteData(*_cur.file, type, len - 8);
7713  continue;
7714  }
7715 
7716  if (invalid) {
7717  grfmsg(1, "GRFSound: Sound index out of range (multiple Action 11?)");
7718  file.SkipBytes(len);
7719  }
7720 
7721  byte action = file.ReadByte();
7722  switch (action) {
7723  case 0xFF:
7724  /* Allocate sound only in init stage. */
7725  if (_cur.stage == GLS_INIT) {
7726  if (grf_container_version >= 2) {
7727  grfmsg(1, "GRFSound: Inline sounds are not supported for container version >= 2");
7728  } else {
7729  LoadGRFSound(offs, sound + i);
7730  }
7731  }
7732  file.SkipBytes(len - 1); // already read <action>
7733  break;
7734 
7735  case 0xFE:
7736  if (_cur.stage == GLS_ACTIVATION) {
7737  /* XXX 'Action 0xFE' isn't really specified. It is only mentioned for
7738  * importing sounds, so this is probably all wrong... */
7739  if (file.ReadByte() != 0) grfmsg(1, "GRFSound: Import type mismatch");
7740  ImportGRFSound(sound + i);
7741  } else {
7742  file.SkipBytes(len - 1); // already read <action>
7743  }
7744  break;
7745 
7746  default:
7747  grfmsg(1, "GRFSound: Unexpected Action %x found, skipping", action);
7748  file.SkipBytes(len - 1); // already read <action>
7749  break;
7750  }
7751  }
7752 }
7753 
7754 /* Action 0x11 (SKIP) */
7755 static void SkipAct11(ByteReader *buf)
7756 {
7757  /* <11> <num>
7758  *
7759  * W num Number of sound files that follow */
7760 
7761  _cur.skip_sprites = buf->ReadWord();
7762 
7763  grfmsg(3, "SkipAct11: Skipping %d sprites", _cur.skip_sprites);
7764 }
7765 
7767 static void LoadFontGlyph(ByteReader *buf)
7768 {
7769  /* <12> <num_def> <font_size> <num_char> <base_char>
7770  *
7771  * B num_def Number of definitions
7772  * B font_size Size of font (0 = normal, 1 = small, 2 = large, 3 = mono)
7773  * B num_char Number of consecutive glyphs
7774  * W base_char First character index */
7775 
7776  uint8 num_def = buf->ReadByte();
7777 
7778  for (uint i = 0; i < num_def; i++) {
7779  FontSize size = (FontSize)buf->ReadByte();
7780  uint8 num_char = buf->ReadByte();
7781  uint16 base_char = buf->ReadWord();
7782 
7783  if (size >= FS_END) {
7784  grfmsg(1, "LoadFontGlyph: Size %u is not supported, ignoring", size);
7785  }
7786 
7787  grfmsg(7, "LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size);
7788 
7789  for (uint c = 0; c < num_char; c++) {
7790  if (size < FS_END) SetUnicodeGlyph(size, base_char + c, _cur.spriteid);
7791  _cur.nfo_line++;
7792  LoadNextSprite(_cur.spriteid++, *_cur.file, _cur.nfo_line);
7793  }
7794  }
7795 }
7796 
7798 static void SkipAct12(ByteReader *buf)
7799 {
7800  /* <12> <num_def> <font_size> <num_char> <base_char>
7801  *
7802  * B num_def Number of definitions
7803  * B font_size Size of font (0 = normal, 1 = small, 2 = large)
7804  * B num_char Number of consecutive glyphs
7805  * W base_char First character index */
7806 
7807  uint8 num_def = buf->ReadByte();
7808 
7809  for (uint i = 0; i < num_def; i++) {
7810  /* Ignore 'size' byte */
7811  buf->ReadByte();
7812 
7813  /* Sum up number of characters */
7814  _cur.skip_sprites += buf->ReadByte();
7815 
7816  /* Ignore 'base_char' word */
7817  buf->ReadWord();
7818  }
7819 
7820  grfmsg(3, "SkipAct12: Skipping %d sprites", _cur.skip_sprites);
7821 }
7822 
7825 {
7826  /* <13> <grfid> <num-ent> <offset> <text...>
7827  *
7828  * 4*B grfid The GRFID of the file whose texts are to be translated
7829  * B num-ent Number of strings
7830  * W offset First text ID
7831  * S text... Zero-terminated strings */
7832 
7833  uint32 grfid = buf->ReadDWord();
7834  const GRFConfig *c = GetGRFConfig(grfid);
7835  if (c == nullptr || (c->status != GCS_INITIALISED && c->status != GCS_ACTIVATED)) {
7836  grfmsg(7, "TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13", BSWAP32(grfid));
7837  return;
7838  }
7839 
7840  if (c->status == GCS_INITIALISED) {
7841  /* If the file is not active but will be activated later, give an error
7842  * and disable this file. */
7843  GRFError *error = DisableGrf(STR_NEWGRF_ERROR_LOAD_AFTER);
7844 
7845  error->data = GetString(STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE);
7846 
7847  return;
7848  }
7849 
7850  /* Since no language id is supplied for with version 7 and lower NewGRFs, this string has
7851  * to be added as a generic string, thus the language id of 0x7F. For this to work
7852  * new_scheme has to be true as well, which will also be implicitly the case for version 8
7853  * and higher. A language id of 0x7F will be overridden by a non-generic id, so this will
7854  * not change anything if a string has been provided specifically for this language. */
7855  byte language = _cur.grffile->grf_version >= 8 ? buf->ReadByte() : 0x7F;
7856  byte num_strings = buf->ReadByte();
7857  uint16 first_id = buf->ReadWord();
7858 
7859  if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD400) || (first_id >= 0xD800 && first_id + num_strings <= 0xE000))) {
7860  grfmsg(7, "TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings);
7861  return;
7862  }
7863 
7864  for (uint i = 0; i < num_strings && buf->HasData(); i++) {
7865  const char *string = buf->ReadString();
7866 
7867  if (StrEmpty(string)) {
7868  grfmsg(7, "TranslateGRFString: Ignoring empty string.");
7869  continue;
7870  }
7871 
7872  AddGRFString(grfid, first_id + i, language, true, true, string, STR_UNDEFINED);
7873  }
7874 }
7875 
7877 static bool ChangeGRFName(byte langid, const char *str)
7878 {
7879  AddGRFTextToList(_cur.grfconfig->name, langid, _cur.grfconfig->ident.grfid, false, str);
7880  return true;
7881 }
7882 
7884 static bool ChangeGRFDescription(byte langid, const char *str)
7885 {
7886  AddGRFTextToList(_cur.grfconfig->info, langid, _cur.grfconfig->ident.grfid, true, str);
7887  return true;
7888 }
7889 
7891 static bool ChangeGRFURL(byte langid, const char *str)
7892 {
7893  AddGRFTextToList(_cur.grfconfig->url, langid, _cur.grfconfig->ident.grfid, false, str);
7894  return true;
7895 }
7896 
7898 static bool ChangeGRFNumUsedParams(size_t len, ByteReader *buf)
7899 {
7900  if (len != 1) {
7901  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'NPAR' but got " PRINTF_SIZE ", ignoring this field", len);
7902  buf->Skip(len);
7903  } else {
7904  _cur.grfconfig->num_valid_params = std::min<byte>(buf->ReadByte(), lengthof(_cur.grfconfig->param));
7905  }
7906  return true;
7907 }
7908 
7910 static bool ChangeGRFPalette(size_t len, ByteReader *buf)
7911 {
7912  if (len != 1) {
7913  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'PALS' but got " PRINTF_SIZE ", ignoring this field", len);
7914  buf->Skip(len);
7915  } else {
7916  char data = buf->ReadByte();
7917  GRFPalette pal = GRFP_GRF_UNSET;
7918  switch (data) {
7919  case '*':
7920  case 'A': pal = GRFP_GRF_ANY; break;
7921  case 'W': pal = GRFP_GRF_WINDOWS; break;
7922  case 'D': pal = GRFP_GRF_DOS; break;
7923  default:
7924  grfmsg(2, "StaticGRFInfo: unexpected value '%02x' for 'INFO'->'PALS', ignoring this field", data);
7925  break;
7926  }
7927  if (pal != GRFP_GRF_UNSET) {
7928  _cur.grfconfig->palette &= ~GRFP_GRF_MASK;
7929  _cur.grfconfig->palette |= pal;
7930  }
7931  }
7932  return true;
7933 }
7934 
7936 static bool ChangeGRFBlitter(size_t len, ByteReader *buf)
7937 {
7938  if (len != 1) {
7939  grfmsg(2, "StaticGRFInfo: expected only 1 byte for 'INFO'->'BLTR' but got " PRINTF_SIZE ", ignoring this field", len);
7940  buf->Skip(len);
7941  } else {
7942  char data = buf->ReadByte();
7943  GRFPalette pal = GRFP_BLT_UNSET;
7944  switch (data) {
7945  case '8': pal = GRFP_BLT_UNSET; break;
7946  case '3': pal = GRFP_BLT_32BPP; break;
7947  default:
7948  grfmsg(2, "StaticGRFInfo: unexpected value '%02x' for 'INFO'->'BLTR', ignoring this field", data);
7949  return true;
7950  }
7951  _cur.grfconfig->palette &= ~GRFP_BLT_MASK;
7952  _cur.grfconfig->palette |= pal;
7953  }
7954  return true;
7955 }
7956 
7958 static bool ChangeGRFVersion(size_t len, ByteReader *buf)
7959 {
7960  if (len != 4) {
7961  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'VRSN' but got " PRINTF_SIZE ", ignoring this field", len);
7962  buf->Skip(len);
7963  } else {
7964  /* Set min_loadable_version as well (default to minimal compatibility) */
7965  _cur.grfconfig->version = _cur.grfconfig->min_loadable_version = buf->ReadDWord();
7966  }
7967  return true;
7968 }
7969 
7971 static bool ChangeGRFMinVersion(size_t len, ByteReader *buf)
7972 {
7973  if (len != 4) {
7974  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'MINV' but got " PRINTF_SIZE ", ignoring this field", len);
7975  buf->Skip(len);
7976  } else {
7977  _cur.grfconfig->min_loadable_version = buf->ReadDWord();
7978  if (_cur.grfconfig->version == 0) {
7979  grfmsg(2, "StaticGRFInfo: 'MINV' defined before 'VRSN' or 'VRSN' set to 0, ignoring this field");
7980  _cur.grfconfig->min_loadable_version = 0;
7981  }
7982  if (_cur.grfconfig->version < _cur.grfconfig->min_loadable_version) {
7983  grfmsg(2, "StaticGRFInfo: 'MINV' defined as %d, limiting it to 'VRSN'", _cur.grfconfig->min_loadable_version);
7985  }
7986  }
7987  return true;
7988 }
7989 
7991 
7993 static bool ChangeGRFParamName(byte langid, const char *str)
7994 {
7995  AddGRFTextToList(_cur_parameter->name, langid, _cur.grfconfig->ident.grfid, false, str);
7996  return true;
7997 }
7998 
8000 static bool ChangeGRFParamDescription(byte langid, const char *str)
8001 {
8002  AddGRFTextToList(_cur_parameter->desc, langid, _cur.grfconfig->ident.grfid, true, str);
8003  return true;
8004 }
8005 
8007 static bool ChangeGRFParamType(size_t len, ByteReader *buf)
8008 {
8009  if (len != 1) {
8010  grfmsg(2, "StaticGRFInfo: expected 1 byte for 'INFO'->'PARA'->'TYPE' but got " PRINTF_SIZE ", ignoring this field", len);
8011  buf->Skip(len);
8012  } else {
8013  GRFParameterType type = (GRFParameterType)buf->ReadByte();
8014  if (type < PTYPE_END) {
8015  _cur_parameter->type = type;
8016  } else {
8017  grfmsg(3, "StaticGRFInfo: unknown parameter type %d, ignoring this field", type);
8018  }
8019  }
8020  return true;
8021 }
8022 
8024 static bool ChangeGRFParamLimits(size_t len, ByteReader *buf)
8025 {
8027  grfmsg(2, "StaticGRFInfo: 'INFO'->'PARA'->'LIMI' is only valid for parameters with type uint/enum, ignoring this field");
8028  buf->Skip(len);
8029  } else if (len != 8) {
8030  grfmsg(2, "StaticGRFInfo: expected 8 bytes for 'INFO'->'PARA'->'LIMI' but got " PRINTF_SIZE ", ignoring this field", len);
8031  buf->Skip(len);
8032  } else {
8033  uint32 min_value = buf->ReadDWord();
8034  uint32 max_value = buf->ReadDWord();
8035  if (min_value <= max_value) {
8036  _cur_parameter->min_value = min_value;
8037  _cur_parameter->max_value = max_value;
8038  } else {
8039  grfmsg(2, "StaticGRFInfo: 'INFO'->'PARA'->'LIMI' values are incoherent, ignoring this field");
8040  }
8041  }
8042  return true;
8043 }
8044 
8046 static bool ChangeGRFParamMask(size_t len, ByteReader *buf)
8047 {
8048  if (len < 1 || len > 3) {
8049  grfmsg(2, "StaticGRFInfo: expected 1 to 3 bytes for 'INFO'->'PARA'->'MASK' but got " PRINTF_SIZE ", ignoring this field", len);
8050  buf->Skip(len);
8051  } else {
8052  byte param_nr = buf->ReadByte();
8053  if (param_nr >= lengthof(_cur.grfconfig->param)) {
8054  grfmsg(2, "StaticGRFInfo: invalid parameter number in 'INFO'->'PARA'->'MASK', param %d, ignoring this field", param_nr);
8055  buf->Skip(len - 1);
8056  } else {
8057  _cur_parameter->param_nr = param_nr;
8058  if (len >= 2) _cur_parameter->first_bit = std::min<byte>(buf->ReadByte(), 31);
8059  if (len >= 3) _cur_parameter->num_bit = std::min<byte>(buf->ReadByte(), 32 - _cur_parameter->first_bit);
8060  }
8061  }
8062 
8063  return true;
8064 }
8065 
8067 static bool ChangeGRFParamDefault(size_t len, ByteReader *buf)
8068 {
8069  if (len != 4) {
8070  grfmsg(2, "StaticGRFInfo: expected 4 bytes for 'INFO'->'PARA'->'DEFA' but got " PRINTF_SIZE ", ignoring this field", len);
8071  buf->Skip(len);
8072  } else {
8073  _cur_parameter->def_value = buf->ReadDWord();
8074  }
8075  _cur.grfconfig->has_param_defaults = true;
8076  return true;
8077 }
8078 
8079 typedef bool (*DataHandler)(size_t, ByteReader *);
8080 typedef bool (*TextHandler)(byte, const char *str);
8081 typedef bool (*BranchHandler)(ByteReader *);
8082 
8093  id(0),
8094  type(0)
8095  {}
8096 
8102  AllowedSubtags(uint32 id, DataHandler handler) :
8103  id(id),
8104  type('B')
8105  {
8106  this->handler.data = handler;
8107  }
8108 
8114  AllowedSubtags(uint32 id, TextHandler handler) :
8115  id(id),
8116  type('T')
8117  {
8118  this->handler.text = handler;
8119  }
8120 
8126  AllowedSubtags(uint32 id, BranchHandler handler) :
8127  id(id),
8128  type('C')
8129  {
8130  this->handler.call_handler = true;
8131  this->handler.u.branch = handler;
8132  }
8133 
8140  id(id),
8141  type('C')
8142  {
8143  this->handler.call_handler = false;
8144  this->handler.u.subtags = subtags;
8145  }
8146 
8147  uint32 id;
8148  byte type;
8149  union {
8152  struct {
8153  union {
8156  } u;
8158  };
8159  } handler;
8160 };
8161 
8162 static bool SkipUnknownInfo(ByteReader *buf, byte type);
8163 static bool HandleNodes(ByteReader *buf, AllowedSubtags *tags);
8164 
8172 {
8173  byte type = buf->ReadByte();
8174  while (type != 0) {
8175  uint32 id = buf->ReadDWord();
8176  if (type != 'T' || id > _cur_parameter->max_value) {
8177  grfmsg(2, "StaticGRFInfo: all child nodes of 'INFO'->'PARA'->param_num->'VALU' should have type 't' and the value/bit number as id");
8178  if (!SkipUnknownInfo(buf, type)) return false;
8179  type = buf->ReadByte();
8180  continue;
8181  }
8182 
8183  byte langid = buf->ReadByte();
8184  const char *name_string = buf->ReadString();
8185 
8186  std::pair<uint32, GRFTextList> *val_name = _cur_parameter->value_names.Find(id);
8187  if (val_name != _cur_parameter->value_names.End()) {
8188  AddGRFTextToList(val_name->second, langid, _cur.grfconfig->ident.grfid, false, name_string);
8189  } else {
8190  GRFTextList list;
8191  AddGRFTextToList(list, langid, _cur.grfconfig->ident.grfid, false, name_string);
8192  _cur_parameter->value_names.Insert(id, list);
8193  }
8194 
8195  type = buf->ReadByte();
8196  }
8197  return true;
8198 }
8199 
8209  AllowedSubtags()
8210 };
8211 
8219 {
8220  byte type = buf->ReadByte();
8221  while (type != 0) {
8222  uint32 id = buf->ReadDWord();
8223  if (type != 'C' || id >= _cur.grfconfig->num_valid_params) {
8224  grfmsg(2, "StaticGRFInfo: all child nodes of 'INFO'->'PARA' should have type 'C' and their parameter number as id");
8225  if (!SkipUnknownInfo(buf, type)) return false;
8226  type = buf->ReadByte();
8227  continue;
8228  }
8229 
8230  if (id >= _cur.grfconfig->param_info.size()) {
8231  _cur.grfconfig->param_info.resize(id + 1);
8232  }
8233  if (_cur.grfconfig->param_info[id] == nullptr) {
8234  _cur.grfconfig->param_info[id] = new GRFParameterInfo(id);
8235  }
8236  _cur_parameter = _cur.grfconfig->param_info[id];
8237  /* Read all parameter-data and process each node. */
8238  if (!HandleNodes(buf, _tags_parameters)) return false;
8239  type = buf->ReadByte();
8240  }
8241  return true;
8242 }
8243 
8246  AllowedSubtags('NAME', ChangeGRFName),
8248  AllowedSubtags('URL_', ChangeGRFURL),
8255  AllowedSubtags()
8256 };
8257 
8260  AllowedSubtags('INFO', _tags_info),
8261  AllowedSubtags()
8262 };
8263 
8264 
8271 static bool SkipUnknownInfo(ByteReader *buf, byte type)
8272 {
8273  /* type and id are already read */
8274  switch (type) {
8275  case 'C': {
8276  byte new_type = buf->ReadByte();
8277  while (new_type != 0) {
8278  buf->ReadDWord(); // skip the id
8279  if (!SkipUnknownInfo(buf, new_type)) return false;
8280  new_type = buf->ReadByte();
8281  }
8282  break;
8283  }
8284 
8285  case 'T':
8286  buf->ReadByte(); // lang
8287  buf->ReadString(); // actual text
8288  break;
8289 
8290  case 'B': {
8291  uint16 size = buf->ReadWord();
8292  buf->Skip(size);
8293  break;
8294  }
8295 
8296  default:
8297  return false;
8298  }
8299 
8300  return true;
8301 }
8302 
8311 static bool HandleNode(byte type, uint32 id, ByteReader *buf, AllowedSubtags subtags[])
8312 {
8313  uint i = 0;
8314  AllowedSubtags *tag;
8315  while ((tag = &subtags[i++])->type != 0) {
8316  if (tag->id != BSWAP32(id) || tag->type != type) continue;
8317  switch (type) {
8318  default: NOT_REACHED();
8319 
8320  case 'T': {
8321  byte langid = buf->ReadByte();
8322  return tag->handler.text(langid, buf->ReadString());
8323  }
8324 
8325  case 'B': {
8326  size_t len = buf->ReadWord();
8327  if (buf->Remaining() < len) return false;
8328  return tag->handler.data(len, buf);
8329  }
8330 
8331  case 'C': {
8332  if (tag->handler.call_handler) {
8333  return tag->handler.u.branch(buf);
8334  }
8335  return HandleNodes(buf, tag->handler.u.subtags);
8336  }
8337  }
8338  }
8339  grfmsg(2, "StaticGRFInfo: unknown type/id combination found, type=%c, id=%x", type, id);
8340  return SkipUnknownInfo(buf, type);
8341 }
8342 
8349 static bool HandleNodes(ByteReader *buf, AllowedSubtags subtags[])
8350 {
8351  byte type = buf->ReadByte();
8352  while (type != 0) {
8353  uint32 id = buf->ReadDWord();
8354  if (!HandleNode(type, id, buf, subtags)) return false;
8355  type = buf->ReadByte();
8356  }
8357  return true;
8358 }
8359 
8364 static void StaticGRFInfo(ByteReader *buf)
8365 {
8366  /* <14> <type> <id> <text/data...> */
8367  HandleNodes(buf, _tags_root);
8368 }
8369 
8375 static void GRFUnsafe(ByteReader *buf)
8376 {
8377  SetBit(_cur.grfconfig->flags, GCF_UNSAFE);
8378 
8379  /* Skip remainder of GRF */
8380  _cur.skip_sprites = -1;
8381 }
8382 
8383 
8386 {
8387  _ttdpatch_flags[0] = ((_settings_game.station.never_expire_airports ? 1U : 0U) << 0x0C) // keepsmallairport
8388  | (1U << 0x0D) // newairports
8389  | (1U << 0x0E) // largestations
8390  | ((_settings_game.construction.max_bridge_length > 16 ? 1U : 0U) << 0x0F) // longbridges
8391  | (0U << 0x10) // loadtime
8392  | (1U << 0x12) // presignals
8393  | (1U << 0x13) // extpresignals
8394  | ((_settings_game.vehicle.never_expire_vehicles ? 1U : 0U) << 0x16) // enginespersist
8395  | (1U << 0x1B) // multihead
8396  | (1U << 0x1D) // lowmemory
8397  | (1U << 0x1E); // generalfixes
8398 
8399  _ttdpatch_flags[1] = ((_settings_game.economy.station_noise_level ? 1U : 0U) << 0x07) // moreairports - based on units of noise
8400  | (1U << 0x08) // mammothtrains
8401  | (1U << 0x09) // trainrefit
8402  | (0U << 0x0B) // subsidiaries
8403  | ((_settings_game.order.gradual_loading ? 1U : 0U) << 0x0C) // gradualloading
8404  | (1U << 0x12) // unifiedmaglevmode - set bit 0 mode. Not revelant to OTTD
8405  | (1U << 0x13) // unifiedmaglevmode - set bit 1 mode
8406  | (1U << 0x14) // bridgespeedlimits
8407  | (1U << 0x16) // eternalgame
8408  | (1U << 0x17) // newtrains
8409  | (1U << 0x18) // newrvs
8410  | (1U << 0x19) // newships
8411  | (1U << 0x1A) // newplanes
8412  | ((_settings_game.construction.train_signal_side == 1 ? 1U : 0U) << 0x1B) // signalsontrafficside
8413  | ((_settings_game.vehicle.disable_elrails ? 0U : 1U) << 0x1C); // electrifiedrailway
8414 
8415  _ttdpatch_flags[2] = (1U << 0x01) // loadallgraphics - obsolote
8416  | (1U << 0x03) // semaphores
8417  | (1U << 0x0A) // newobjects
8418  | (0U << 0x0B) // enhancedgui
8419  | (0U << 0x0C) // newagerating
8420  | ((_settings_game.construction.build_on_slopes ? 1U : 0U) << 0x0D) // buildonslopes
8421  | (1U << 0x0E) // fullloadany
8422  | (1U << 0x0F) // planespeed
8423  | (0U << 0x10) // moreindustriesperclimate - obsolete
8424  | (0U << 0x11) // moretoylandfeatures
8425  | (1U << 0x12) // newstations
8426  | (1U << 0x13) // tracktypecostdiff
8427  | (1U << 0x14) // manualconvert
8428  | ((_settings_game.construction.build_on_slopes ? 1U : 0U) << 0x15) // buildoncoasts
8429  | (1U << 0x16) // canals
8430  | (1U << 0x17) // newstartyear
8431  | ((_settings_game.vehicle.freight_trains > 1 ? 1U : 0U) << 0x18) // freighttrains
8432  | (1U << 0x19) // newhouses
8433  | (1U << 0x1A) // newbridges
8434  | (1U << 0x1B) // newtownnames
8435  | (1U << 0x1C) // moreanimation
8436  | ((_settings_game.vehicle.wagon_speed_limits ? 1U : 0U) << 0x1D) // wagonspeedlimits
8437  | (1U << 0x1E) // newshistory
8438  | (0U << 0x1F); // custombridgeheads
8439 
8440  _ttdpatch_flags[3] = (0U << 0x00) // newcargodistribution
8441  | (1U << 0x01) // windowsnap
8442  | ((_settings_game.economy.allow_town_roads || _generating_world ? 0U : 1U) << 0x02) // townbuildnoroad
8443  | (1U << 0x03) // pathbasedsignalling
8444  | (0U << 0x04) // aichoosechance
8445  | (1U << 0x05) // resolutionwidth
8446  | (1U << 0x06) // resolutionheight
8447  | (1U << 0x07) // newindustries
8448  | ((_settings_game.order.improved_load ? 1U : 0U) << 0x08) // fifoloading
8449  | (0U << 0x09) // townroadbranchprob
8450  | (0U << 0x0A) // tempsnowline
8451  | (1U << 0x0B) // newcargo
8452  | (1U << 0x0C) // enhancemultiplayer
8453  | (1U << 0x0D) // onewayroads
8454  | (1U << 0x0E) // irregularstations
8455  | (1U << 0x0F) // statistics
8456  | (1U << 0x10) // newsounds
8457  | (1U << 0x11) // autoreplace
8458  | (1U << 0x12) // autoslope
8459  | (0U << 0x13) // followvehicle
8460  | (1U << 0x14) // trams
8461  | (0U << 0x15) // enhancetunnels
8462  | (1U << 0x16) // shortrvs
8463  | (1U << 0x17) // articulatedrvs
8464  | ((_settings_game.vehicle.dynamic_engines ? 1U : 0U) << 0x18) // dynamic engines
8465  | (1U << 0x1E) // variablerunningcosts
8466  | (1U << 0x1F); // any switch is on
8467 
8468  _ttdpatch_flags[4] = (1U << 0x00) // larger persistent storage
8469  | ((_settings_game.economy.inflation ? 1U : 0U) << 0x01); // inflation is on
8470 }
8471 
8473 static void ResetCustomStations()
8474 {
8475  for (GRFFile * const file : _grf_files) {
8476  StationSpec **&stations = file->stations;
8477  if (stations == nullptr) continue;
8478  for (uint i = 0; i < NUM_STATIONS_PER_GRF; i++) {
8479  if (stations[i] == nullptr) continue;
8480  StationSpec *statspec = stations[i];
8481 
8482  /* Release this station */
8483  delete statspec;
8484  }
8485 
8486  /* Free and reset the station data */
8487  free(stations);
8488  stations = nullptr;
8489  }
8490 }
8491 
8493 static void ResetCustomHouses()
8494 {
8495  for (GRFFile * const file : _grf_files) {
8496  HouseSpec **&housespec = file->housespec;
8497  if (housespec == nullptr) continue;
8498  for (uint i = 0; i < NUM_HOUSES_PER_GRF; i++) {
8499  free(housespec[i]);
8500  }
8501 
8502  free(housespec);
8503  housespec = nullptr;
8504  }
8505 }
8506 
8508 static void ResetCustomAirports()
8509 {
8510  for (GRFFile * const file : _grf_files) {
8511  AirportSpec **aslist = file->airportspec;
8512  if (aslist != nullptr) {
8513  for (uint i = 0; i < NUM_AIRPORTS_PER_GRF; i++) {
8514  AirportSpec *as = aslist[i];
8515 
8516  if (as != nullptr) {
8517  /* We need to remove the tiles layouts */
8518  for (int j = 0; j < as->num_table; j++) {
8519  /* remove the individual layouts */
8520  free(as->table[j]);
8521  }
8522  free(as->table);
8523  free(as->depot_table);
8524  free(as->rotation);
8525 
8526  free(as);
8527  }
8528  }
8529  free(aslist);
8530  file->airportspec = nullptr;
8531  }
8532 
8533  AirportTileSpec **&airporttilespec = file->airtspec;
8534  if (airporttilespec != nullptr) {
8535  for (uint i = 0; i < NUM_AIRPORTTILES_PER_GRF; i++) {
8536  free(airporttilespec[i]);
8537  }
8538  free(airporttilespec);
8539  airporttilespec = nullptr;
8540  }
8541  }
8542 }
8543 
8546 {
8547  for (GRFFile * const file : _grf_files) {
8548  IndustrySpec **&industryspec = file->industryspec;
8549  IndustryTileSpec **&indtspec = file->indtspec;
8550 
8551  /* We are verifiying both tiles and industries specs loaded from the grf file
8552  * First, let's deal with industryspec */
8553  if (industryspec != nullptr) {
8554  for (uint i = 0; i < NUM_INDUSTRYTYPES_PER_GRF; i++) {
8555  IndustrySpec *ind = industryspec[i];
8556  delete ind;
8557  }
8558 
8559  free(industryspec);
8560  industryspec = nullptr;
8561  }
8562 
8563  if (indtspec == nullptr) continue;
8564  for (uint i = 0; i < NUM_INDUSTRYTILES_PER_GRF; i++) {
8565  free(indtspec[i]);
8566  }
8567 
8568  free(indtspec);
8569  indtspec = nullptr;
8570  }
8571 }
8572 
8574 static void ResetCustomObjects()
8575 {
8576  for (GRFFile * const file : _grf_files) {
8577  ObjectSpec **&objectspec = file->objectspec;
8578  if (objectspec == nullptr) continue;
8579  for (uint i = 0; i < NUM_OBJECTS_PER_GRF; i++) {
8580  free(objectspec[i]);
8581  }
8582 
8583  free(objectspec);
8584  objectspec = nullptr;
8585  }
8586 }
8587 
8589 static void ResetNewGRF()
8590 {
8591  for (GRFFile * const file : _grf_files) {
8592  delete file;
8593  }
8594 
8595  _grf_files.clear();
8596  _cur.grffile = nullptr;
8597 }
8598 
8600 static void ResetNewGRFErrors()
8601 {
8602  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
8603  if (!HasBit(c->flags, GCF_COPY) && c->error != nullptr) {
8604  delete c->error;
8605  c->error = nullptr;
8606  }
8607  }
8608 }
8609 
8614 {
8615  CleanUpStrings();
8616  CleanUpGRFTownNames();
8617 
8618  /* Copy/reset original engine info data */
8619  SetupEngines();
8620 
8621  /* Copy/reset original bridge info data */
8622  ResetBridges();
8623 
8624  /* Reset rail type information */
8625  ResetRailTypes();
8626 
8627  /* Copy/reset original road type info data */
8628  ResetRoadTypes();
8629 
8630  /* Allocate temporary refit/cargo class data */
8631  _gted = CallocT<GRFTempEngineData>(Engine::GetPoolSize());
8632 
8633  /* Fill rail type label temporary data for default trains */
8634  for (const Engine *e : Engine::IterateType(VEH_TRAIN)) {
8635  _gted[e->index].railtypelabel = GetRailTypeInfo(e->u.rail.railtype)->label;
8636  }
8637 
8638  /* Reset GRM reservations */
8639  memset(&_grm_engines, 0, sizeof(_grm_engines));
8640  memset(&_grm_cargoes, 0, sizeof(_grm_cargoes));
8641 
8642  /* Reset generic feature callback lists */
8644 
8645  /* Reset price base data */
8647 
8648  /* Reset the curencies array */
8649  ResetCurrencies();
8650 
8651  /* Reset the house array */
8653  ResetHouses();
8654 
8655  /* Reset the industries structures*/
8657  ResetIndustries();
8658 
8659  /* Reset the objects. */
8660  ObjectClass::Reset();
8662  ResetObjects();
8663 
8664  /* Reset station classes */
8665  StationClass::Reset();
8667 
8668  /* Reset airport-related structures */
8669  AirportClass::Reset();
8673 
8674  /* Reset canal sprite groups and flags */
8675  memset(_water_feature, 0, sizeof(_water_feature));
8676 
8677  /* Reset the snowline table. */
8678  ClearSnowLine();
8679 
8680  /* Reset NewGRF files */
8681  ResetNewGRF();
8682 
8683  /* Reset NewGRF errors. */
8685 
8686  /* Set up the default cargo types */
8688 
8689  /* Reset misc GRF features and train list display variables */
8690  _misc_grf_features = 0;
8691 
8693  _loaded_newgrf_features.used_liveries = 1 << LS_DEFAULT;
8696 
8697  /* Clear all GRF overrides */
8698  _grf_id_overrides.clear();
8699 
8700  InitializeSoundPool();
8701  _spritegroup_pool.CleanPool();
8702 }
8703 
8708 {
8709  /* Reset override managers */
8710  _engine_mngr.ResetToDefaultMapping();
8711  _house_mngr.ResetMapping();
8712  _industry_mngr.ResetMapping();
8713  _industile_mngr.ResetMapping();
8714  _airport_mngr.ResetMapping();
8715  _airporttile_mngr.ResetMapping();
8716 }
8717 
8723 {
8724  memset(_cur.grffile->cargo_map, 0xFF, sizeof(_cur.grffile->cargo_map));
8725 
8726  for (CargoID c = 0; c < NUM_CARGO; c++) {
8727  const CargoSpec *cs = CargoSpec::Get(c);
8728  if (!cs->IsValid()) continue;
8729 
8730  if (_cur.grffile->cargo_list.size() == 0) {
8731  /* Default translation table, so just a straight mapping to bitnum */
8732  _cur.grffile->cargo_map[c] = cs->bitnum;
8733  } else {
8734  /* Check the translation table for this cargo's label */
8735  int idx = find_index(_cur.grffile->cargo_list, {cs->label});
8736  if (idx >= 0) _cur.grffile->cargo_map[c] = idx;
8737  }
8738  }
8739 }
8740 
8745 static void InitNewGRFFile(const GRFConfig *config)
8746 {
8747  GRFFile *newfile = GetFileByFilename(config->filename);
8748  if (newfile != nullptr) {
8749  /* We already loaded it once. */
8750  _cur.grffile = newfile;
8751  return;
8752  }
8753 
8754  newfile = new GRFFile(config);
8755  _grf_files.push_back(_cur.grffile = newfile);
8756 }
8757 
8763 {
8764  this->filename = stredup(config->filename);
8765  this->grfid = config->ident.grfid;
8766 
8767  /* Initialise local settings to defaults */
8768  this->traininfo_vehicle_pitch = 0;
8769  this->traininfo_vehicle_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
8770 
8771  /* Mark price_base_multipliers as 'not set' */
8772  for (Price i = PR_BEGIN; i < PR_END; i++) {
8773  this->price_base_multipliers[i] = INVALID_PRICE_MODIFIER;
8774  }
8775 
8776  /* Initialise rail type map with default rail types */
8777  std::fill(std::begin(this->railtype_map), std::end(this->railtype_map), INVALID_RAILTYPE);
8778  this->railtype_map[0] = RAILTYPE_RAIL;
8779  this->railtype_map[1] = RAILTYPE_ELECTRIC;
8780  this->railtype_map[2] = RAILTYPE_MONO;
8781  this->railtype_map[3] = RAILTYPE_MAGLEV;
8782 
8783  /* Initialise road type map with default road types */
8784  std::fill(std::begin(this->roadtype_map), std::end(this->roadtype_map), INVALID_ROADTYPE);
8785  this->roadtype_map[0] = ROADTYPE_ROAD;
8786 
8787  /* Initialise tram type map with default tram types */
8788  std::fill(std::begin(this->tramtype_map), std::end(this->tramtype_map), INVALID_ROADTYPE);
8789  this->tramtype_map[0] = ROADTYPE_TRAM;
8790 
8791  /* Copy the initial parameter list
8792  * 'Uninitialised' parameters are zeroed as that is their default value when dynamically creating them. */
8793  static_assert(lengthof(this->param) == lengthof(config->param) && lengthof(this->param) == 0x80);
8794 
8795  assert(config->num_params <= lengthof(config->param));
8796  this->param_end = config->num_params;
8797  if (this->param_end > 0) {
8798  MemCpyT(this->param, config->param, this->param_end);
8799  }
8800 }
8801 
8802 GRFFile::~GRFFile()
8803 {
8804  free(this->filename);
8805  delete[] this->language_map;
8806 }
8807 
8808 
8812 static void CalculateRefitMasks()
8813 {
8814  CargoTypes original_known_cargoes = 0;
8815  for (int ct = 0; ct != NUM_ORIGINAL_CARGO; ++ct) {
8817  if (cid != CT_INVALID) SetBit(original_known_cargoes, cid);
8818  }
8819 
8820  for (Engine *e : Engine::Iterate()) {
8821  EngineID engine = e->index;
8822  EngineInfo *ei = &e->info;
8823  bool only_defaultcargo;
8824 
8825  /* If the NewGRF did not set any cargo properties, we apply default values. */
8826  if (_gted[engine].defaultcargo_grf == nullptr) {
8827  /* If the vehicle has any capacity, apply the default refit masks */
8828  if (e->type != VEH_TRAIN || e->u.rail.capacity != 0) {
8829  static constexpr byte T = 1 << LT_TEMPERATE;
8830  static constexpr byte A = 1 << LT_ARCTIC;
8831  static constexpr byte S = 1 << LT_TROPIC;
8832  static constexpr byte Y = 1 << LT_TOYLAND;
8833  static const struct DefaultRefitMasks {
8834  byte climate;
8835  CargoType cargo_type;
8836  CargoTypes cargo_allowed;
8837  CargoTypes cargo_disallowed;
8838  } _default_refit_masks[] = {
8839  {T | A | S | Y, CT_PASSENGERS, CC_PASSENGERS, 0},
8840  {T | A | S , CT_MAIL, CC_MAIL, 0},
8841  {T | A | S , CT_VALUABLES, CC_ARMOURED, CC_LIQUID},
8842  { Y, CT_MAIL, CC_MAIL | CC_ARMOURED, CC_LIQUID},
8843  {T | A , CT_COAL, CC_BULK, 0},
8844  { S , CT_COPPER_ORE, CC_BULK, 0},
8845  { Y, CT_SUGAR, CC_BULK, 0},
8846  {T | A | S , CT_OIL, CC_LIQUID, 0},
8847  { Y, CT_COLA, CC_LIQUID, 0},
8848  {T , CT_GOODS, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS},
8849  { A | S , CT_GOODS, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS | CC_REFRIGERATED},
8850  { A | S , CT_FOOD, CC_REFRIGERATED, 0},
8851  { Y, CT_CANDY, CC_PIECE_GOODS | CC_EXPRESS, CC_LIQUID | CC_PASSENGERS},
8852  };
8853 
8854  if (e->type == VEH_AIRCRAFT) {
8855  /* Aircraft default to "light" cargoes */
8856  _gted[engine].cargo_allowed = CC_PASSENGERS | CC_MAIL | CC_ARMOURED | CC_EXPRESS;
8857  _gted[engine].cargo_disallowed = CC_LIQUID;
8858  } else if (e->type == VEH_SHIP) {
8859  switch (ei->cargo_type) {
8860  case CT_PASSENGERS:
8861  /* Ferries */
8862  _gted[engine].cargo_allowed = CC_PASSENGERS;
8863  _gted[engine].cargo_disallowed = 0;
8864  break;
8865  case CT_OIL:
8866  /* Tankers */
8867  _gted[engine].cargo_allowed = CC_LIQUID;
8868  _gted[engine].cargo_disallowed = 0;
8869  break;
8870  default:
8871  /* Cargo ships */
8872  if (_settings_game.game_creation.landscape == LT_TOYLAND) {
8873  /* No tanker in toyland :( */
8874  _gted[engine].cargo_allowed = CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS | CC_LIQUID;
8875  _gted[engine].cargo_disallowed = CC_PASSENGERS;
8876  } else {
8877  _gted[engine].cargo_allowed = CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS;
8878  _gted[engine].cargo_disallowed = CC_LIQUID | CC_PASSENGERS;
8879  }
8880  break;
8881  }
8882  e->u.ship.old_refittable = true;
8883  } else if (e->type == VEH_TRAIN && e->u.rail.railveh_type != RAILVEH_WAGON) {
8884  /* Train engines default to all cargoes, so you can build single-cargo consists with fast engines.
8885  * Trains loading multiple cargoes may start stations accepting unwanted cargoes. */
8886  _gted[engine].cargo_allowed = CC_PASSENGERS | CC_MAIL | CC_ARMOURED | CC_EXPRESS | CC_BULK | CC_PIECE_GOODS | CC_LIQUID;
8887  _gted[engine].cargo_disallowed = 0;
8888  } else {
8889  /* Train wagons and road vehicles are classified by their default cargo type */
8890  for (const auto &drm : _default_refit_masks) {
8891  if (!HasBit(drm.climate, _settings_game.game_creation.landscape)) continue;
8892  if (drm.cargo_type != ei->cargo_type) continue;
8893 
8894  _gted[engine].cargo_allowed = drm.cargo_allowed;
8895  _gted[engine].cargo_disallowed = drm.cargo_disallowed;
8896  break;
8897  }
8898 
8899  /* All original cargoes have specialised vehicles, so exclude them */
8900  _gted[engine].ctt_exclude_mask = original_known_cargoes;
8901  }
8902  }
8903  _gted[engine].UpdateRefittability(_gted[engine].cargo_allowed != 0);
8904 
8905  /* Translate cargo_type using the original climate-specific cargo table. */
8906  ei->cargo_type = GetDefaultCargoID(_settings_game.game_creation.landscape, static_cast<CargoType>(ei->cargo_type));
8907  if (ei->cargo_type != CT_INVALID) ClrBit(_gted[engine].ctt_exclude_mask, ei->cargo_type);
8908  }
8909 
8910  /* Compute refittability */
8911  {
8912  CargoTypes mask = 0;
8913  CargoTypes not_mask = 0;
8914  CargoTypes xor_mask = ei->refit_mask;
8915 
8916  /* If the original masks set by the grf are zero, the vehicle shall only carry the default cargo.
8917  * Note: After applying the translations, the vehicle may end up carrying no defined cargo. It becomes unavailable in that case. */
8918  only_defaultcargo = _gted[engine].refittability != GRFTempEngineData::NONEMPTY;
8919 
8920  if (_gted[engine].cargo_allowed != 0) {
8921  /* Build up the list of cargo types from the set cargo classes. */
8922  for (const CargoSpec *cs : CargoSpec::Iterate()) {
8923  if (_gted[engine].cargo_allowed & cs->classes) SetBit(mask, cs->Index());
8924  if (_gted[engine].cargo_disallowed & cs->classes) SetBit(not_mask, cs->Index());
8925  }
8926  }
8927 
8928  ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) & _cargo_mask;
8929 
8930  /* Apply explicit refit includes/excludes. */
8931  ei->refit_mask |= _gted[engine].ctt_include_mask;
8932  ei->refit_mask &= ~_gted[engine].ctt_exclude_mask;
8933  }
8934 
8935  /* Clear invalid cargoslots (from default vehicles or pre-NewCargo GRFs) */
8936  if (ei->cargo_type != CT_INVALID && !HasBit(_cargo_mask, ei->cargo_type)) ei->cargo_type = CT_INVALID;
8937 
8938  /* Ensure that the vehicle is either not refittable, or that the default cargo is one of the refittable cargoes.
8939  * Note: Vehicles refittable to no cargo are handle differently to vehicle refittable to a single cargo. The latter might have subtypes. */
8940  if (!only_defaultcargo && (e->type != VEH_SHIP || e->u.ship.old_refittable) && ei->cargo_type != CT_INVALID && !HasBit(ei->refit_mask, ei->cargo_type)) {
8941  ei->cargo_type = CT_INVALID;
8942  }
8943 
8944  /* Check if this engine's cargo type is valid. If not, set to the first refittable
8945  * cargo type. Finally disable the vehicle, if there is still no cargo. */
8946  if (ei->cargo_type == CT_INVALID && ei->refit_mask != 0) {
8947  /* Figure out which CTT to use for the default cargo, if it is 'first refittable'. */
8948  const uint8 *cargo_map_for_first_refittable = nullptr;
8949  {
8950  const GRFFile *file = _gted[engine].defaultcargo_grf;
8951  if (file == nullptr) file = e->GetGRF();
8952  if (file != nullptr && file->grf_version >= 8 && file->cargo_list.size() != 0) {
8953  cargo_map_for_first_refittable = file->cargo_map;
8954  }
8955  }
8956 
8957  if (cargo_map_for_first_refittable != nullptr) {
8958  /* Use first refittable cargo from cargo translation table */
8959  byte best_local_slot = 0xFF;
8960  for (CargoID cargo_type : SetCargoBitIterator(ei->refit_mask)) {
8961  byte local_slot = cargo_map_for_first_refittable[cargo_type];
8962  if (local_slot < best_local_slot) {
8963  best_local_slot = local_slot;
8964  ei->cargo_type = cargo_type;
8965  }
8966  }
8967  }
8968 
8969  if (ei->cargo_type == CT_INVALID) {
8970  /* Use first refittable cargo slot */
8971  ei->cargo_type = (CargoID)FindFirstBit(ei->refit_mask);
8972  }
8973  }
8974  if (ei->cargo_type == CT_INVALID) ei->climates = 0;
8975 
8976  /* Clear refit_mask for not refittable ships */
8977  if (e->type == VEH_SHIP && !e->u.ship.old_refittable) {
8978  ei->refit_mask = 0;
8979  }
8980  }
8981 }
8982 
8984 static void FinaliseCanals()
8985 {
8986  for (uint i = 0; i < CF_END; i++) {
8987  if (_water_feature[i].grffile != nullptr) {
8990  }
8991  }
8992 }
8993 
8995 static void FinaliseEngineArray()
8996 {
8997  for (Engine *e : Engine::Iterate()) {
8998  if (e->GetGRF() == nullptr) {
8999  const EngineIDMapping &eid = _engine_mngr[e->index];
9000  if (eid.grfid != INVALID_GRFID || eid.internal_id != eid.substitute_id) {
9001  e->info.string_id = STR_NEWGRF_INVALID_ENGINE;
9002  }
9003  }
9004 
9005  /* Do final mapping on variant engine ID and set appropriate flags on variant engine */
9006  if (e->info.variant_id != INVALID_ENGINE) {
9007  e->info.variant_id = GetNewEngineID(e->grf_prop.grffile, e->type, e->info.variant_id);
9008  if (e->info.variant_id != INVALID_ENGINE) {
9010  }
9011  }
9012 
9013  if (!HasBit(e->info.climates, _settings_game.game_creation.landscape)) continue;
9014 
9015  /* Skip wagons, there livery is defined via the engine */
9016  if (e->type != VEH_TRAIN || e->u.rail.railveh_type != RAILVEH_WAGON) {
9019  /* Note: For ships and roadvehicles we assume that they cannot be refitted between passenger and freight */
9020 
9021  if (e->type == VEH_TRAIN) {
9022  SetBit(_loaded_newgrf_features.used_liveries, LS_FREIGHT_WAGON);
9023  switch (ls) {
9024  case LS_STEAM:
9025  case LS_DIESEL:
9026  case LS_ELECTRIC:
9027  case LS_MONORAIL:
9028  case LS_MAGLEV:
9029  SetBit(_loaded_newgrf_features.used_liveries, LS_PASSENGER_WAGON_STEAM + ls - LS_STEAM);
9030  break;
9031 
9032  case LS_DMU:
9033  case LS_EMU:
9034  SetBit(_loaded_newgrf_features.used_liveries, LS_PASSENGER_WAGON_DIESEL + ls - LS_DMU);
9035  break;
9036 
9037  default: NOT_REACHED();
9038  }
9039  }
9040  }
9041  }
9042 }
9043 
9045 static void FinaliseCargoArray()
9046 {
9047  for (CargoID c = 0; c < NUM_CARGO; c++) {
9048  CargoSpec *cs = CargoSpec::Get(c);
9049  if (!cs->IsValid()) {
9050  cs->name = cs->name_single = cs->units_volume = STR_NEWGRF_INVALID_CARGO;
9051  cs->quantifier = STR_NEWGRF_INVALID_CARGO_QUANTITY;
9052  cs->abbrev = STR_NEWGRF_INVALID_CARGO_ABBREV;
9053  }
9054  }
9055 }
9056 
9068 static bool IsHouseSpecValid(HouseSpec *hs, const HouseSpec *next1, const HouseSpec *next2, const HouseSpec *next3, const char *filename)
9069 {
9070  if (((hs->building_flags & BUILDING_HAS_2_TILES) != 0 &&
9071  (next1 == nullptr || !next1->enabled || (next1->building_flags & BUILDING_HAS_1_TILE) != 0)) ||
9072  ((hs->building_flags & BUILDING_HAS_4_TILES) != 0 &&
9073  (next2 == nullptr || !next2->enabled || (next2->building_flags & BUILDING_HAS_1_TILE) != 0 ||
9074  next3 == nullptr || !next3->enabled || (next3->building_flags & BUILDING_HAS_1_TILE) != 0))) {
9075  hs->enabled = false;
9076  if (filename != nullptr) Debug(grf, 1, "FinaliseHouseArray: {} defines house {} as multitile, but no suitable tiles follow. Disabling house.", filename, hs->grf_prop.local_id);
9077  return false;
9078  }
9079 
9080  /* Some places sum population by only counting north tiles. Other places use all tiles causing desyncs.
9081  * As the newgrf specs define population to be zero for non-north tiles, we just disable the offending house.
9082  * If you want to allow non-zero populations somewhen, make sure to sum the population of all tiles in all places. */
9083  if (((hs->building_flags & BUILDING_HAS_2_TILES) != 0 && next1->population != 0) ||
9084  ((hs->building_flags & BUILDING_HAS_4_TILES) != 0 && (next2->population != 0 || next3->population != 0))) {
9085  hs->enabled = false;
9086  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);
9087  return false;
9088  }
9089 
9090  /* Substitute type is also used for override, and having an override with a different size causes crashes.
9091  * This check should only be done for NewGRF houses because grf_prop.subst_id is not set for original houses.*/
9092  if (filename != nullptr && (hs->building_flags & BUILDING_HAS_1_TILE) != (HouseSpec::Get(hs->grf_prop.subst_id)->building_flags & BUILDING_HAS_1_TILE)) {
9093  hs->enabled = false;
9094  Debug(grf, 1, "FinaliseHouseArray: {} defines house {} with different house size then it's substitute type. Disabling house.", filename, hs->grf_prop.local_id);
9095  return false;
9096  }
9097 
9098  /* Make sure that additional parts of multitile houses are not available. */
9099  if ((hs->building_flags & BUILDING_HAS_1_TILE) == 0 && (hs->building_availability & HZ_ZONALL) != 0 && (hs->building_availability & HZ_CLIMALL) != 0) {
9100  hs->enabled = false;
9101  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);
9102  return false;
9103  }
9104 
9105  return true;
9106 }
9107 
9114 static void EnsureEarlyHouse(HouseZones bitmask)
9115 {
9116  Year min_year = MAX_YEAR;
9117 
9118  for (int i = 0; i < NUM_HOUSES; i++) {
9119  HouseSpec *hs = HouseSpec::Get(i);
9120  if (hs == nullptr || !hs->enabled) continue;
9121  if ((hs->building_availability & bitmask) != bitmask) continue;
9122  if (hs->min_year < min_year) min_year = hs->min_year;
9123  }
9124 
9125  if (min_year == 0) return;
9126 
9127  for (int i = 0; i < NUM_HOUSES; i++) {
9128  HouseSpec *hs = HouseSpec::Get(i);
9129  if (hs == nullptr || !hs->enabled) continue;
9130  if ((hs->building_availability & bitmask) != bitmask) continue;
9131  if (hs->min_year == min_year) hs->min_year = 0;
9132  }
9133 }
9134 
9141 static void FinaliseHouseArray()
9142 {
9143  /* If there are no houses with start dates before 1930, then all houses
9144  * with start dates of 1930 have them reset to 0. This is in order to be
9145  * compatible with TTDPatch, where if no houses have start dates before
9146  * 1930 and the date is before 1930, the game pretends that this is 1930.
9147  * If there have been any houses defined with start dates before 1930 then
9148  * the dates are left alone.
9149  * On the other hand, why 1930? Just 'fix' the houses with the lowest
9150  * minimum introduction date to 0.
9151  */
9152  for (GRFFile * const file : _grf_files) {
9153  HouseSpec **&housespec = file->housespec;
9154  if (housespec == nullptr) continue;
9155 
9156  for (int i = 0; i < NUM_HOUSES_PER_GRF; i++) {
9157  HouseSpec *hs = housespec[i];
9158 
9159  if (hs == nullptr) continue;
9160 
9161  const HouseSpec *next1 = (i + 1 < NUM_HOUSES_PER_GRF ? housespec[i + 1] : nullptr);
9162  const HouseSpec *next2 = (i + 2 < NUM_HOUSES_PER_GRF ? housespec[i + 2] : nullptr);
9163  const HouseSpec *next3 = (i + 3 < NUM_HOUSES_PER_GRF ? housespec[i + 3] : nullptr);
9164 
9165  if (!IsHouseSpecValid(hs, next1, next2, next3, file->filename)) continue;
9166 
9167  _house_mngr.SetEntitySpec(hs);
9168  }
9169  }
9170 
9171  for (int i = 0; i < NUM_HOUSES; i++) {
9172  HouseSpec *hs = HouseSpec::Get(i);
9173  const HouseSpec *next1 = (i + 1 < NUM_HOUSES ? HouseSpec::Get(i + 1) : nullptr);
9174  const HouseSpec *next2 = (i + 2 < NUM_HOUSES ? HouseSpec::Get(i + 2) : nullptr);
9175  const HouseSpec *next3 = (i + 3 < NUM_HOUSES ? HouseSpec::Get(i + 3) : nullptr);
9176 
9177  /* We need to check all houses again to we are sure that multitile houses
9178  * did get consecutive IDs and none of the parts are missing. */
9179  if (!IsHouseSpecValid(hs, next1, next2, next3, nullptr)) {
9180  /* GetHouseNorthPart checks 3 houses that are directly before
9181  * it in the house pool. If any of those houses have multi-tile
9182  * flags set it assumes it's part of a multitile house. Since
9183  * we can have invalid houses in the pool marked as disabled, we
9184  * don't want to have them influencing valid tiles. As such set
9185  * building_flags to zero here to make sure any house following
9186  * this one in the pool is properly handled as 1x1 house. */
9187  hs->building_flags = TILE_NO_FLAG;
9188  }
9189  }
9190 
9191  HouseZones climate_mask = (HouseZones)(1 << (_settings_game.game_creation.landscape + 12));
9192  EnsureEarlyHouse(HZ_ZON1 | climate_mask);
9193  EnsureEarlyHouse(HZ_ZON2 | climate_mask);
9194  EnsureEarlyHouse(HZ_ZON3 | climate_mask);
9195  EnsureEarlyHouse(HZ_ZON4 | climate_mask);
9196  EnsureEarlyHouse(HZ_ZON5 | climate_mask);
9197 
9198  if (_settings_game.game_creation.landscape == LT_ARCTIC) {
9204  }
9205 }
9206 
9213 {
9214  for (GRFFile * const file : _grf_files) {
9215  IndustrySpec **&industryspec = file->industryspec;
9216  IndustryTileSpec **&indtspec = file->indtspec;
9217  if (industryspec != nullptr) {
9218  for (int i = 0; i < NUM_INDUSTRYTYPES_PER_GRF; i++) {
9219  IndustrySpec *indsp = industryspec[i];
9220 
9221  if (indsp != nullptr && indsp->enabled) {
9222  StringID strid;
9223  /* process the conversion of text at the end, so to be sure everything will be fine
9224  * and available. Check if it does not return undefind marker, which is a very good sign of a
9225  * substitute industry who has not changed the string been examined, thus using it as such */
9226  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->name);
9227  if (strid != STR_UNDEFINED) indsp->name = strid;
9228 
9229  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->closure_text);
9230  if (strid != STR_UNDEFINED) indsp->closure_text = strid;
9231 
9232  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_up_text);
9233  if (strid != STR_UNDEFINED) indsp->production_up_text = strid;
9234 
9235  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_down_text);
9236  if (strid != STR_UNDEFINED) indsp->production_down_text = strid;
9237 
9238  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->new_industry_text);
9239  if (strid != STR_UNDEFINED) indsp->new_industry_text = strid;
9240 
9241  if (indsp->station_name != STR_NULL) {
9242  /* STR_NULL (0) can be set by grf. It has a meaning regarding assignation of the
9243  * station's name. Don't want to lose the value, therefore, do not process. */
9244  strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->station_name);
9245  if (strid != STR_UNDEFINED) indsp->station_name = strid;
9246  }
9247 
9248  _industry_mngr.SetEntitySpec(indsp);
9249  }
9250  }
9251  }
9252 
9253  if (indtspec != nullptr) {
9254  for (int i = 0; i < NUM_INDUSTRYTILES_PER_GRF; i++) {
9255  IndustryTileSpec *indtsp = indtspec[i];
9256  if (indtsp != nullptr) {
9257  _industile_mngr.SetEntitySpec(indtsp);
9258  }
9259  }
9260  }
9261  }
9262 
9263  for (uint j = 0; j < NUM_INDUSTRYTYPES; j++) {
9264  IndustrySpec *indsp = &_industry_specs[j];
9265  if (indsp->enabled && indsp->grf_prop.grffile != nullptr) {
9266  for (uint i = 0; i < 3; i++) {
9267  indsp->conflicting[i] = MapNewGRFIndustryType(indsp->conflicting[i], indsp->grf_prop.grffile->grfid);
9268  }
9269  }
9270  if (!indsp->enabled) {
9271  indsp->name = STR_NEWGRF_INVALID_INDUSTRYTYPE;
9272  }
9273  }
9274 }
9275 
9282 {
9283  for (GRFFile * const file : _grf_files) {
9284  ObjectSpec **&objectspec = file->objectspec;
9285  if (objectspec != nullptr) {
9286  for (int i = 0; i < NUM_OBJECTS_PER_GRF; i++) {
9287  if (objectspec[i] != nullptr && objectspec[i]->grf_prop.grffile != nullptr && objectspec[i]->enabled) {
9288  _object_mngr.SetEntitySpec(objectspec[i]);
9289  }
9290  }
9291  }
9292  }
9293 }
9294 
9301 {
9302  for (GRFFile * const file : _grf_files) {
9303  AirportSpec **&airportspec = file->airportspec;
9304  if (airportspec != nullptr) {
9305  for (int i = 0; i < NUM_AIRPORTS_PER_GRF; i++) {
9306  if (airportspec[i] != nullptr && airportspec[i]->enabled) {
9307  _airport_mngr.SetEntitySpec(airportspec[i]);
9308  }
9309  }
9310  }
9311 
9312  AirportTileSpec **&airporttilespec = file->airtspec;
9313  if (airporttilespec != nullptr) {
9314  for (uint i = 0; i < NUM_AIRPORTTILES_PER_GRF; i++) {
9315  if (airporttilespec[i] != nullptr && airporttilespec[i]->enabled) {
9316  _airporttile_mngr.SetEntitySpec(airporttilespec[i]);
9317  }
9318  }
9319  }
9320  }
9321 }
9322 
9323 /* Here we perform initial decoding of some special sprites (as are they
9324  * described at http://www.ttdpatch.net/src/newgrf.txt, but this is only a very
9325  * partial implementation yet).
9326  * XXX: We consider GRF files trusted. It would be trivial to exploit OTTD by
9327  * a crafted invalid GRF file. We should tell that to the user somehow, or
9328  * better make this more robust in the future. */
9329 static void DecodeSpecialSprite(byte *buf, uint num, GrfLoadingStage stage)
9330 {
9331  /* XXX: There is a difference between staged loading in TTDPatch and
9332  * here. In TTDPatch, for some reason actions 1 and 2 are carried out
9333  * during stage 1, whilst action 3 is carried out during stage 2 (to
9334  * "resolve" cargo IDs... wtf). This is a little problem, because cargo
9335  * IDs are valid only within a given set (action 1) block, and may be
9336  * overwritten after action 3 associates them. But overwriting happens
9337  * in an earlier stage than associating, so... We just process actions
9338  * 1 and 2 in stage 2 now, let's hope that won't get us into problems.
9339  * --pasky
9340  * We need a pre-stage to set up GOTO labels of Action 0x10 because the grf
9341  * is not in memory and scanning the file every time would be too expensive.
9342  * In other stages we skip action 0x10 since it's already dealt with. */
9343  static const SpecialSpriteHandler handlers[][GLS_END] = {
9344  /* 0x00 */ { nullptr, SafeChangeInfo, nullptr, nullptr, ReserveChangeInfo, FeatureChangeInfo, },
9345  /* 0x01 */ { SkipAct1, SkipAct1, SkipAct1, SkipAct1, SkipAct1, NewSpriteSet, },
9346  /* 0x02 */ { nullptr, nullptr, nullptr, nullptr, nullptr, NewSpriteGroup, },
9347  /* 0x03 */ { nullptr, GRFUnsafe, nullptr, nullptr, nullptr, FeatureMapSpriteGroup, },
9348  /* 0x04 */ { nullptr, nullptr, nullptr, nullptr, nullptr, FeatureNewName, },
9349  /* 0x05 */ { SkipAct5, SkipAct5, SkipAct5, SkipAct5, SkipAct5, GraphicsNew, },
9350  /* 0x06 */ { nullptr, nullptr, nullptr, CfgApply, CfgApply, CfgApply, },
9351  /* 0x07 */ { nullptr, nullptr, nullptr, nullptr, SkipIf, SkipIf, },
9352  /* 0x08 */ { ScanInfo, nullptr, nullptr, GRFInfo, GRFInfo, GRFInfo, },
9353  /* 0x09 */ { nullptr, nullptr, nullptr, SkipIf, SkipIf, SkipIf, },
9354  /* 0x0A */ { SkipActA, SkipActA, SkipActA, SkipActA, SkipActA, SpriteReplace, },
9355  /* 0x0B */ { nullptr, nullptr, nullptr, GRFLoadError, GRFLoadError, GRFLoadError, },
9356  /* 0x0C */ { nullptr, nullptr, nullptr, GRFComment, nullptr, GRFComment, },
9357  /* 0x0D */ { nullptr, SafeParamSet, nullptr, ParamSet, ParamSet, ParamSet, },
9358  /* 0x0E */ { nullptr, SafeGRFInhibit, nullptr, GRFInhibit, GRFInhibit, GRFInhibit, },
9359  /* 0x0F */ { nullptr, GRFUnsafe, nullptr, FeatureTownName, nullptr, nullptr, },
9360  /* 0x10 */ { nullptr, nullptr, DefineGotoLabel, nullptr, nullptr, nullptr, },
9361  /* 0x11 */ { SkipAct11, GRFUnsafe, SkipAct11, GRFSound, SkipAct11, GRFSound, },
9363  /* 0x13 */ { nullptr, nullptr, nullptr, nullptr, nullptr, TranslateGRFStrings, },
9364  /* 0x14 */ { StaticGRFInfo, nullptr, nullptr, nullptr, nullptr, nullptr, },
9365  };
9366 
9367  GRFLocation location(_cur.grfconfig->ident.grfid, _cur.nfo_line);
9368 
9369  GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
9370  if (it == _grf_line_to_action6_sprite_override.end()) {
9371  /* No preloaded sprite to work with; read the
9372  * pseudo sprite content. */
9373  _cur.file->ReadBlock(buf, num);
9374  } else {
9375  /* Use the preloaded sprite data. */
9376  buf = _grf_line_to_action6_sprite_override[location];
9377  grfmsg(7, "DecodeSpecialSprite: Using preloaded pseudo sprite data");
9378 
9379  /* Skip the real (original) content of this action. */
9380  _cur.file->SeekTo(num, SEEK_CUR);
9381  }
9382 
9383  ByteReader br(buf, buf + num);
9384  ByteReader *bufp = &br;
9385 
9386  try {
9387  byte action = bufp->ReadByte();
9388 
9389  if (action == 0xFF) {
9390  grfmsg(2, "DecodeSpecialSprite: Unexpected data block, skipping");
9391  } else if (action == 0xFE) {
9392  grfmsg(2, "DecodeSpecialSprite: Unexpected import block, skipping");
9393  } else if (action >= lengthof(handlers)) {
9394  grfmsg(7, "DecodeSpecialSprite: Skipping unknown action 0x%02X", action);
9395  } else if (handlers[action][stage] == nullptr) {
9396  grfmsg(7, "DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage);
9397  } else {
9398  grfmsg(7, "DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage);
9399  handlers[action][stage](bufp);
9400  }
9401  } catch (...) {
9402  grfmsg(1, "DecodeSpecialSprite: Tried to read past end of pseudo-sprite data");
9403  DisableGrf(STR_NEWGRF_ERROR_READ_BOUNDS);
9404  }
9405 }
9406 
9413 static void LoadNewGRFFileFromFile(GRFConfig *config, GrfLoadingStage stage, SpriteFile &file)
9414 {
9415  _cur.file = &file;
9416  _cur.grfconfig = config;
9417 
9418  Debug(grf, 2, "LoadNewGRFFile: Reading NewGRF-file '{}'", config->filename);
9419 
9420  byte grf_container_version = file.GetContainerVersion();
9421  if (grf_container_version == 0) {
9422  Debug(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format");
9423  return;
9424  }
9425 
9426  if (stage == GLS_INIT || stage == GLS_ACTIVATION) {
9427  /* We need the sprite offsets in the init stage for NewGRF sounds
9428  * and in the activation stage for real sprites. */
9429  ReadGRFSpriteOffsets(file);
9430  } else {
9431  /* Skip sprite section offset if present. */
9432  if (grf_container_version >= 2) file.ReadDword();
9433  }
9434 
9435  if (grf_container_version >= 2) {
9436  /* Read compression value. */
9437  byte compression = file.ReadByte();
9438  if (compression != 0) {
9439  Debug(grf, 7, "LoadNewGRFFile: Unsupported compression format");
9440  return;
9441  }
9442  }
9443 
9444  /* Skip the first sprite; we don't care about how many sprites this
9445  * does contain; newest TTDPatches and George's longvehicles don't
9446  * neither, apparently. */
9447  uint32 num = grf_container_version >= 2 ? file.ReadDword() : file.ReadWord();
9448  if (num == 4 && file.ReadByte() == 0xFF) {
9449  file.ReadDword();
9450  } else {
9451  Debug(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format");
9452  return;
9453  }
9454 
9455  _cur.ClearDataForNextFile();
9456 
9458 
9459  while ((num = (grf_container_version >= 2 ? file.ReadDword() : file.ReadWord())) != 0) {
9460  byte type = file.ReadByte();
9461  _cur.nfo_line++;
9462 
9463  if (type == 0xFF) {
9464  if (_cur.skip_sprites == 0) {
9465  DecodeSpecialSprite(buf.Allocate(num), num, stage);
9466 
9467  /* Stop all processing if we are to skip the remaining sprites */
9468  if (_cur.skip_sprites == -1) break;
9469 
9470  continue;
9471  } else {
9472  file.SkipBytes(num);
9473  }
9474  } else {
9475  if (_cur.skip_sprites == 0) {
9476  grfmsg(0, "LoadNewGRFFile: Unexpected sprite, disabling");
9477  DisableGrf(STR_NEWGRF_ERROR_UNEXPECTED_SPRITE);
9478  break;
9479  }
9480 
9481  if (grf_container_version >= 2 && type == 0xFD) {
9482  /* Reference to data section. Container version >= 2 only. */
9483  file.SkipBytes(num);
9484  } else {
9485  file.SkipBytes(7);
9486  SkipSpriteData(file, type, num - 8);
9487  }
9488  }
9489 
9490  if (_cur.skip_sprites > 0) _cur.skip_sprites--;
9491  }
9492 }
9493 
9502 void LoadNewGRFFile(GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary)
9503 {
9504  const char *filename = config->filename;
9505 
9506  /* A .grf file is activated only if it was active when the game was
9507  * started. If a game is loaded, only its active .grfs will be
9508  * reactivated, unless "loadallgraphics on" is used. A .grf file is
9509  * considered active if its action 8 has been processed, i.e. its
9510  * action 8 hasn't been skipped using an action 7.
9511  *
9512  * During activation, only actions 0, 1, 2, 3, 4, 5, 7, 8, 9, 0A and 0B are
9513  * carried out. All others are ignored, because they only need to be
9514  * processed once at initialization. */
9515  if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) {
9516  _cur.grffile = GetFileByFilename(filename);
9517  if (_cur.grffile == nullptr) usererror("File '%s' lost in cache.\n", filename);
9518  if (stage == GLS_RESERVE && config->status != GCS_INITIALISED) return;
9519  if (stage == GLS_ACTIVATION && !HasBit(config->flags, GCF_RESERVED)) return;
9520  }
9521 
9522  bool needs_palette_remap = config->palette & GRFP_USE_MASK;
9523  if (temporary) {
9524  SpriteFile temporarySpriteFile(filename, subdir, needs_palette_remap);
9525  LoadNewGRFFileFromFile(config, stage, temporarySpriteFile);
9526  } else {
9527  LoadNewGRFFileFromFile(config, stage, OpenCachedSpriteFile(filename, subdir, needs_palette_remap));
9528  }
9529 }
9530 
9538 static void ActivateOldShore()
9539 {
9540  /* Use default graphics, if no shore sprites were loaded.
9541  * Should not happen, as the base set's extra grf should include some. */
9543 
9545  DupSprite(SPR_ORIGINALSHORE_START + 1, SPR_SHORE_BASE + 1); // SLOPE_W
9546  DupSprite(SPR_ORIGINALSHORE_START + 2, SPR_SHORE_BASE + 2); // SLOPE_S
9547  DupSprite(SPR_ORIGINALSHORE_START + 6, SPR_SHORE_BASE + 3); // SLOPE_SW
9548  DupSprite(SPR_ORIGINALSHORE_START + 0, SPR_SHORE_BASE + 4); // SLOPE_E
9549  DupSprite(SPR_ORIGINALSHORE_START + 4, SPR_SHORE_BASE + 6); // SLOPE_SE
9550  DupSprite(SPR_ORIGINALSHORE_START + 3, SPR_SHORE_BASE + 8); // SLOPE_N
9551  DupSprite(SPR_ORIGINALSHORE_START + 7, SPR_SHORE_BASE + 9); // SLOPE_NW
9552  DupSprite(SPR_ORIGINALSHORE_START + 5, SPR_SHORE_BASE + 12); // SLOPE_NE
9553  }
9554 
9556  DupSprite(SPR_FLAT_GRASS_TILE + 16, SPR_SHORE_BASE + 0); // SLOPE_STEEP_S
9557  DupSprite(SPR_FLAT_GRASS_TILE + 17, SPR_SHORE_BASE + 5); // SLOPE_STEEP_W
9558  DupSprite(SPR_FLAT_GRASS_TILE + 7, SPR_SHORE_BASE + 7); // SLOPE_WSE
9559  DupSprite(SPR_FLAT_GRASS_TILE + 15, SPR_SHORE_BASE + 10); // SLOPE_STEEP_N
9560  DupSprite(SPR_FLAT_GRASS_TILE + 11, SPR_SHORE_BASE + 11); // SLOPE_NWS
9561  DupSprite(SPR_FLAT_GRASS_TILE + 13, SPR_SHORE_BASE + 13); // SLOPE_ENW
9562  DupSprite(SPR_FLAT_GRASS_TILE + 14, SPR_SHORE_BASE + 14); // SLOPE_SEN
9563  DupSprite(SPR_FLAT_GRASS_TILE + 18, SPR_SHORE_BASE + 15); // SLOPE_STEEP_E
9564 
9565  /* XXX - SLOPE_EW, SLOPE_NS are currently not used.
9566  * If they would be used somewhen, then these grass tiles will most like not look as needed */
9567  DupSprite(SPR_FLAT_GRASS_TILE + 5, SPR_SHORE_BASE + 16); // SLOPE_EW
9568  DupSprite(SPR_FLAT_GRASS_TILE + 10, SPR_SHORE_BASE + 17); // SLOPE_NS
9569  }
9570 }
9571 
9576 {
9578  DupSprite(SPR_ROAD_DEPOT + 0, SPR_TRAMWAY_DEPOT_NO_TRACK + 0); // use road depot graphics for "no tracks"
9579  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 1, SPR_TRAMWAY_DEPOT_NO_TRACK + 1);
9580  DupSprite(SPR_ROAD_DEPOT + 2, SPR_TRAMWAY_DEPOT_NO_TRACK + 2); // use road depot graphics for "no tracks"
9581  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 3, SPR_TRAMWAY_DEPOT_NO_TRACK + 3);
9582  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 4, SPR_TRAMWAY_DEPOT_NO_TRACK + 4);
9583  DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 5, SPR_TRAMWAY_DEPOT_NO_TRACK + 5);
9584  }
9585 }
9586 
9591 {
9592  extern const PriceBaseSpec _price_base_specs[];
9594  static const uint32 override_features = (1 << GSF_TRAINS) | (1 << GSF_ROADVEHICLES) | (1 << GSF_SHIPS) | (1 << GSF_AIRCRAFT);
9595 
9596  /* Evaluate grf overrides */
9597  int num_grfs = (uint)_grf_files.size();
9598  int *grf_overrides = AllocaM(int, num_grfs);
9599  for (int i = 0; i < num_grfs; i++) {
9600  grf_overrides[i] = -1;
9601 
9602  GRFFile *source = _grf_files[i];
9603  uint32 override = _grf_id_overrides[source->grfid];
9604  if (override == 0) continue;
9605 
9606  GRFFile *dest = GetFileByGRFID(override);
9607  if (dest == nullptr) continue;
9608 
9609  grf_overrides[i] = find_index(_grf_files, dest);
9610  assert(grf_overrides[i] >= 0);
9611  }
9612 
9613  /* Override features and price base multipliers of earlier loaded grfs */
9614  for (int i = 0; i < num_grfs; i++) {
9615  if (grf_overrides[i] < 0 || grf_overrides[i] >= i) continue;
9616  GRFFile *source = _grf_files[i];
9617  GRFFile *dest = _grf_files[grf_overrides[i]];
9618 
9619  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9620  source->grf_features |= features;
9621  dest->grf_features |= features;
9622 
9623  for (Price p = PR_BEGIN; p < PR_END; p++) {
9624  /* No price defined -> nothing to do */
9625  if (!HasBit(features, _price_base_specs[p].grf_feature) || source->price_base_multipliers[p] == INVALID_PRICE_MODIFIER) continue;
9626  Debug(grf, 3, "'{}' overrides price base multiplier {} of '{}'", source->filename, p, dest->filename);
9627  dest->price_base_multipliers[p] = source->price_base_multipliers[p];
9628  }
9629  }
9630 
9631  /* Propagate features and price base multipliers of afterwards loaded grfs, if none is present yet */
9632  for (int i = num_grfs - 1; i >= 0; i--) {
9633  if (grf_overrides[i] < 0 || grf_overrides[i] <= i) continue;
9634  GRFFile *source = _grf_files[i];
9635  GRFFile *dest = _grf_files[grf_overrides[i]];
9636 
9637  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9638  source->grf_features |= features;
9639  dest->grf_features |= features;
9640 
9641  for (Price p = PR_BEGIN; p < PR_END; p++) {
9642  /* Already a price defined -> nothing to do */
9643  if (!HasBit(features, _price_base_specs[p].grf_feature) || dest->price_base_multipliers[p] != INVALID_PRICE_MODIFIER) continue;
9644  Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, source->filename, dest->filename);
9645  dest->price_base_multipliers[p] = source->price_base_multipliers[p];
9646  }
9647  }
9648 
9649  /* The 'master grf' now have the correct multipliers. Assign them to the 'addon grfs' to make everything consistent. */
9650  for (int i = 0; i < num_grfs; i++) {
9651  if (grf_overrides[i] < 0) continue;
9652  GRFFile *source = _grf_files[i];
9653  GRFFile *dest = _grf_files[grf_overrides[i]];
9654 
9655  uint32 features = (source->grf_features | dest->grf_features) & override_features;
9656  source->grf_features |= features;
9657  dest->grf_features |= features;
9658 
9659  for (Price p = PR_BEGIN; p < PR_END; p++) {
9660  if (!HasBit(features, _price_base_specs[p].grf_feature)) continue;
9661  if (source->price_base_multipliers[p] != dest->price_base_multipliers[p]) {
9662  Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, dest->filename, source->filename);
9663  }
9664  source->price_base_multipliers[p] = dest->price_base_multipliers[p];
9665  }
9666  }
9667 
9668  /* Apply fallback prices for grf version < 8 */
9669  for (GRFFile * const file : _grf_files) {
9670  if (file->grf_version >= 8) continue;
9671  PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9672  for (Price p = PR_BEGIN; p < PR_END; p++) {
9673  Price fallback_price = _price_base_specs[p].fallback_price;
9674  if (fallback_price != INVALID_PRICE && price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9675  /* No price multiplier has been set.
9676  * So copy the multiplier from the fallback price, maybe a multiplier was set there. */
9677  price_base_multipliers[p] = price_base_multipliers[fallback_price];
9678  }
9679  }
9680  }
9681 
9682  /* Decide local/global scope of price base multipliers */
9683  for (GRFFile * const file : _grf_files) {
9684  PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9685  for (Price p = PR_BEGIN; p < PR_END; p++) {
9686  if (price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9687  /* No multiplier was set; set it to a neutral value */
9688  price_base_multipliers[p] = 0;
9689  } else {
9690  if (!HasBit(file->grf_features, _price_base_specs[p].grf_feature)) {
9691  /* The grf does not define any objects of the feature,
9692  * so it must be a difficulty setting. Apply it globally */
9693  Debug(grf, 3, "'{}' sets global price base multiplier {}", file->filename, p);
9694  SetPriceBaseMultiplier(p, price_base_multipliers[p]);
9695  price_base_multipliers[p] = 0;
9696  } else {
9697  Debug(grf, 3, "'{}' sets local price base multiplier {}", file->filename, p);
9698  }
9699  }
9700  }
9701  }
9702 }
9703 
9704 extern void InitGRFTownGeneratorNames();
9705 
9707 static void AfterLoadGRFs()
9708 {
9709  for (StringIDMapping &it : _string_to_grf_mapping) {
9710  *it.target = MapGRFStringID(it.grfid, it.source);
9711  }
9712  _string_to_grf_mapping.clear();
9713 
9714  /* Free the action 6 override sprites. */
9715  for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) {
9716  free((*it).second);
9717  }
9718  _grf_line_to_action6_sprite_override.clear();
9719 
9720  /* Polish cargoes */
9722 
9723  /* Pre-calculate all refit masks after loading GRF files. */
9725 
9726  /* Polish engines */
9728 
9729  /* Set the actually used Canal properties */
9730  FinaliseCanals();
9731 
9732  /* Add all new houses to the house array. */
9734 
9735  /* Add all new industries to the industry array. */
9737 
9738  /* Add all new objects to the object array. */
9740 
9742 
9743  /* Sort the list of industry types. */
9745 
9746  /* Create dynamic list of industry legends for smallmap_gui.cpp */
9748 
9749  /* Build the routemap legend, based on the available cargos */
9751 
9752  /* Add all new airports to the airports array. */
9754  BindAirportSpecs();
9755 
9756  /* Update the townname generators list */
9758 
9759  /* Run all queued vehicle list order changes */
9761 
9762  /* Load old shore sprites in new position, if they were replaced by ActionA */
9763  ActivateOldShore();
9764 
9765  /* Load old tram depot sprites in new position, if no new ones are present */
9767 
9768  /* Set up custom rail types */
9769  InitRailTypes();
9770  InitRoadTypes();
9771 
9772  for (Engine *e : Engine::IterateType(VEH_ROAD)) {
9773  if (_gted[e->index].rv_max_speed != 0) {
9774  /* Set RV maximum speed from the mph/0.8 unit value */
9775  e->u.road.max_speed = _gted[e->index].rv_max_speed * 4;
9776  }
9777 
9778  RoadTramType rtt = HasBit(e->info.misc_flags, EF_ROAD_TRAM) ? RTT_TRAM : RTT_ROAD;
9779 
9780  const GRFFile *file = e->GetGRF();
9781  if (file == nullptr || _gted[e->index].roadtramtype == 0) {
9782  e->u.road.roadtype = (rtt == RTT_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD;
9783  continue;
9784  }
9785 
9786  /* Remove +1 offset. */
9787  _gted[e->index].roadtramtype--;
9788 
9789  const std::vector<RoadTypeLabel> *list = (rtt == RTT_TRAM) ? &file->tramtype_list : &file->roadtype_list;
9790  if (_gted[e->index].roadtramtype < list->size())
9791  {
9792  RoadTypeLabel rtl = (*list)[_gted[e->index].roadtramtype];
9793  RoadType rt = GetRoadTypeByLabel(rtl);
9794  if (rt != INVALID_ROADTYPE && GetRoadTramType(rt) == rtt) {
9795  e->u.road.roadtype = rt;
9796  continue;
9797  }
9798  }
9799 
9800  /* Road type is not available, so disable this engine */
9801  e->info.climates = 0;
9802  }
9803 
9804  for (Engine *e : Engine::IterateType(VEH_TRAIN)) {
9805  RailType railtype = GetRailTypeByLabel(_gted[e->index].railtypelabel);
9806  if (railtype == INVALID_RAILTYPE) {
9807  /* Rail type is not available, so disable this engine */
9808  e->info.climates = 0;
9809  } else {
9810  e->u.rail.railtype = railtype;
9811  e->u.rail.intended_railtype = railtype;
9812  }
9813  }
9814 
9816 
9818 
9819  /* Deallocate temporary loading data */
9820  free(_gted);
9821  _grm_sprites.clear();
9822 }
9823 
9829 void LoadNewGRF(uint load_index, uint num_baseset)
9830 {
9831  /* In case of networking we need to "sync" the start values
9832  * so all NewGRFs are loaded equally. For this we use the
9833  * start date of the game and we set the counters, etc. to
9834  * 0 so they're the same too. */
9835  Date date = _date;
9836  Year year = _cur_year;
9837  DateFract date_fract = _date_fract;
9838  uint64 tick_counter = _tick_counter;
9839  byte display_opt = _display_opt;
9840 
9841  if (_networking) {
9843  _date = ConvertYMDToDate(_cur_year, 0, 1);
9844  _date_fract = 0;
9845  _tick_counter = 0;
9846  _display_opt = 0;
9847  }
9848 
9850 
9851  ResetNewGRFData();
9852 
9853  /*
9854  * Reset the status of all files, so we can 'retry' to load them.
9855  * This is needed when one for example rearranges the NewGRFs in-game
9856  * and a previously disabled NewGRF becomes usable. If it would not
9857  * be reset, the NewGRF would remain disabled even though it should
9858  * have been enabled.
9859  */
9860  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9861  if (c->status != GCS_NOT_FOUND) c->status = GCS_UNKNOWN;
9862  }
9863 
9864  _cur.spriteid = load_index;
9865 
9866  /* Load newgrf sprites
9867  * in each loading stage, (try to) open each file specified in the config
9868  * and load information from it. */
9869  for (GrfLoadingStage stage = GLS_LABELSCAN; stage <= GLS_ACTIVATION; stage++) {
9870  /* Set activated grfs back to will-be-activated between reservation- and activation-stage.
9871  * This ensures that action7/9 conditions 0x06 - 0x0A work correctly. */
9872  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9873  if (c->status == GCS_ACTIVATED) c->status = GCS_INITIALISED;
9874  }
9875 
9876  if (stage == GLS_RESERVE) {
9877  static const uint32 overrides[][2] = {
9878  { 0x44442202, 0x44440111 }, // UKRS addons modifies UKRS
9879  { 0x6D620402, 0x6D620401 }, // DBSetXL ECS extension modifies DBSetXL
9880  { 0x4D656f20, 0x4D656F17 }, // LV4cut modifies LV4
9881  };
9882  for (size_t i = 0; i < lengthof(overrides); i++) {
9883  SetNewGRFOverride(BSWAP32(overrides[i][0]), BSWAP32(overrides[i][1]));
9884  }
9885  }
9886 
9887  uint num_grfs = 0;
9888  uint num_non_static = 0;
9889 
9890  _cur.stage = stage;
9891  for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
9892  if (c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND) continue;
9893  if (stage > GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) continue;
9894 
9895  Subdirectory subdir = num_grfs < num_baseset ? BASESET_DIR : NEWGRF_DIR;
9896  if (!FioCheckFileExists(c->filename, subdir)) {
9897  Debug(grf, 0, "NewGRF file is missing '{}'; disabling", c->filename);
9898  c->status = GCS_NOT_FOUND;
9899  continue;
9900  }
9901 
9902  if (stage == GLS_LABELSCAN) InitNewGRFFile(c);
9903 
9904  if (!HasBit(c->flags, GCF_STATIC) && !HasBit(c->flags, GCF_SYSTEM)) {
9905  if (num_non_static == NETWORK_MAX_GRF_COUNT) {
9906  Debug(grf, 0, "'{}' is not loaded as the maximum number of non-static GRFs has been reached", c->filename);
9907  c->status = GCS_DISABLED;
9908  c->error = new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9909  continue;
9910  }
9911  num_non_static++;
9912  }
9913 
9914  num_grfs++;
9915 
9916  LoadNewGRFFile(c, stage, subdir, false);
9917  if (stage == GLS_RESERVE) {
9918  SetBit(c->flags, GCF_RESERVED);
9919  } else if (stage == GLS_ACTIVATION) {
9920  ClrBit(c->flags, GCF_RESERVED);
9921  assert(GetFileByGRFID(c->ident.grfid) == _cur.grffile);
9924  Debug(sprite, 2, "LoadNewGRF: Currently {} sprites are loaded", _cur.spriteid);
9925  } else if (stage == GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) {
9926  /* We're not going to activate this, so free whatever data we allocated */
9928  }
9929  }
9930  }
9931 
9932  /* Pseudo sprite processing is finished; free temporary stuff */
9933  _cur.ClearDataForNextFile();
9934 
9935  /* Call any functions that should be run after GRFs have been loaded. */
9936  AfterLoadGRFs();
9937 
9938  /* Now revert back to the original situation */
9939  _cur_year = year;
9940  _date = date;
9941  _date_fract = date_fract;
9942  _tick_counter = tick_counter;
9943  _display_opt = display_opt;
9944 }
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:8493
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:7877
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:8157
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:7165
GRFLocation
Definition: newgrf.cpp:360
CalculateRefitMasks
static void CalculateRefitMasks()
Precalculate refit masks from cargo classes for all vehicles.
Definition: newgrf.cpp:8812
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:187
EngineInfo::base_life
Year base_life
Basic duration of engine availability (without random parts). 0xFF means infinite life.
Definition: engine_type.h:146
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:6169
OrderSettings::improved_load
bool improved_load
improved loading algorithm
Definition: settings_type.h:478
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:3825
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:8092
GameCreationSettings::generation_seed
uint32 generation_seed
noise seed for world generation
Definition: settings_type.h:312
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:8574
RailVehicleInfo::pow_wag_weight
byte pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition: engine_type.h:57
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:8139
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:598
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:8508
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:4079
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:103
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:8545
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:328
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:77
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:8102
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:7515
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:3445
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:8154
HandleNodes
static bool HandleNodes(ByteReader *buf, AllowedSubtags subtags[])
Handle the contents of a 'C' choice of an Action14.
Definition: newgrf.cpp:8349
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:8984
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:342
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:108
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:6164
Action5BlockType
Action5BlockType
The type of action 5 type.
Definition: newgrf.cpp:6161
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:8024
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:8707
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:7958
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:7993
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:493
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:8245
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:8375
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:106
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:8114
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:49
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:143
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:8007
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:5001
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:144
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:504
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:8151
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:3089
_tags_parameters
AllowedSubtags _tags_parameters[]
Action14 parameter tags.
Definition: newgrf.cpp:8201
RoadVehicleInfo::roadtype
RoadType roadtype
Road type.
Definition: engine_type.h:127
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:7824
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:9590
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:124
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:587
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:3854
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:145
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:75
RoadVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:119
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:594
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:58
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:6599
LoadNewGRF
void LoadNewGRF(uint load_index, uint num_baseset)
Load all the NewGRFs.
Definition: newgrf.cpp:9829
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:9502
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:55
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:530
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:53
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:61
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:2597
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:154
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:9212
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:8218
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:113
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:8081
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:125
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:168
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:109
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:9114
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:9413
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:8364
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:562
AfterLoadGRFs
static void AfterLoadGRFs()
Finish loading NewGRFs and execute needed post-processing.
Definition: newgrf.cpp:9707
_cur_parameter
static GRFParameterInfo * _cur_parameter
The parameter which info is currently changed by the newgrf.
Definition: newgrf.cpp:7990
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:3412
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:7891
_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:596
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:8311
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:6176
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:8046
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:8171
ImportGRFSound
static void ImportGRFSound(SoundEntry *sound)
Process a sound import from another GRF file.
Definition: newgrf.cpp:7616
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:8259
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:9281
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:2614
GlobalVarChangeInfo
static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
Define properties for global variables.
Definition: newgrf.cpp:2654
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:155
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:60
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:2950
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:56
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:50
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:3322
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:153
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:6162
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:6163
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:8722
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:74
AllowedSubtags::type
byte type
The type of the node, must be one of 'C', 'B' or 'T'.
Definition: newgrf.cpp:8148
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:7936
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:8995
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:7898
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:7971
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:345
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:7884
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:8762
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:501
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:126
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:9068
IndustrytilesChangeInfo
static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, ByteReader *buf)
Define properties for industry tiles.
Definition: newgrf.cpp:3184
RailVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: engine_type.h:48
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:8600
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:8589
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:8090
FinaliseAirportsArray
static void FinaliseAirportsArray()
Add all new airports to the airport array.
Definition: newgrf.cpp:9300
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:6139
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:6317
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:343
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:8155
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:8080
Action5Type::block_type
Action5BlockType block_type
How is this Action5 type processed?
Definition: newgrf.cpp:6168
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:6170
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:158
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:62
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:348
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:494
InitNewGRFFile
static void InitNewGRFFile(const GRFConfig *config)
Prepare loading a NewGRF file with its config.
Definition: newgrf.cpp:8745
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:67
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
RailVehicleInfo::railtype
RailType railtype
Railtype, mangled if elrail is disabled.
Definition: engine_type.h:46
ResetNewGRFData
void ResetNewGRFData()
Reset all NewGRF loaded data.
Definition: newgrf.cpp:8613
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:313
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:9575
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:123
GrfProcessingState::stage
GrfLoadingStage stage
Current loading stage.
Definition: newgrf.cpp:99
ExtraEngineFlags
ExtraEngineFlags
Definition: engine_type.h:130
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:4033
CHECK_NOTHING
@ CHECK_NOTHING
Always succeeds.
Definition: industrytype.h:40
AircraftVehicleInfo::mail_capacity
byte mail_capacity
Mail capacity (bags).
Definition: engine_type.h:107
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:121
Action5Type::name
const char * name
Name for error messages.
Definition: newgrf.cpp:6172
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:9141
GRFConfig::palette
uint8 palette
GRFPalette, bitset.
Definition: newgrf_config.h:179
RailVehicleInfo::intended_railtype
RailType intended_railtype
Intended railtype, regardless of elrail being enabled or disabled.
Definition: engine_type.h:47
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:59
_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:8147
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:8385
DataHandler
bool(* DataHandler)(size_t, ByteReader *)
Type of callback function for binary nodes.
Definition: newgrf.cpp:8079
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:9538
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:122
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:8271
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:2278
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:502
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:2636
VehicleSettings::plane_speed
uint8 plane_speed
divisor for speed of aircraft
Definition: settings_type.h:499
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:4215
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:70
RailVehicleInfo::running_cost
byte running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
Definition: engine_type.h:51
EF_ROAD_TRAM
@ EF_ROAD_TRAM
Road vehicle is a tram/light rail vehicle.
Definition: engine_type.h:167
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:510
FinaliseCargoArray
static void FinaliseCargoArray()
Check for invalid cargoes.
Definition: newgrf.cpp:9045
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:588
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:595
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:149
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:8067
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:54
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:7598
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:7647
AllowedSubtags::AllowedSubtags
AllowedSubtags(uint32 id, BranchHandler handler)
Create a branch node with a callback handler.
Definition: newgrf.cpp:8126
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:8150
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:156
AircraftVehicleInfo
Information about a aircraft vehicle.
Definition: engine_type.h:99
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:2345
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:500
ChangeGRFPalette
static bool ChangeGRFPalette(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PALS' to set the number of valid parameters.
Definition: newgrf.cpp:7910
LoadFontGlyph
static void LoadFontGlyph(ByteReader *buf)
Action 0x12.
Definition: newgrf.cpp:7767
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:8473
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:528
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:8000
EngineInfo::cargo_age_period
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:157
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:7798
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:6167
_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:63
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:479
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:6171
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:76
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:3144
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:4433
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