54 #include "table/strings.h" 116 this->skip_sprites = 0;
118 for (uint i = 0; i < GSF_END; i++) {
119 this->spritesets[i].clear();
122 memset(this->spritegroups, 0,
sizeof(this->spritegroups));
135 assert(feature < GSF_END);
136 for (uint i = 0; i < numsets; i++) {
137 SpriteSet &
set = this->spritesets[feature][first_set + i];
138 set.
sprite = first_sprite + i * numents;
139 set.num_sprites = numents;
151 assert(feature < GSF_END);
152 return !this->spritesets[feature].empty();
164 assert(feature < GSF_END);
165 return this->spritesets[feature].find(
set) != this->spritesets[feature].end();
177 return this->spritesets[feature].find(
set)->second.sprite;
189 return this->spritesets[feature].find(
set)->second.num_sprites;
202 template <VehicleType T>
205 return image_index == 0xFD || IsValidImageIndex<T>(image_index);
217 ByteReader(byte *data, byte *end) : data(data), end(end) { }
221 if (data < end)
return *(data)++;
231 uint16 ReadExtendedByte()
234 return val == 0xFF ? ReadWord() : val;
239 uint32 val = ReadWord();
240 return val | (ReadWord() << 16);
243 uint32 ReadVarSize(byte size)
247 case 2:
return ReadWord();
248 case 4:
return ReadDWord();
255 const char *ReadString()
257 char *
string =
reinterpret_cast<char *
>(data);
258 size_t string_length =
ttd_strnlen(
string, Remaining());
260 if (string_length == Remaining()) {
262 string[string_length - 1] =
'\0';
263 grfmsg(7,
"String was not terminated with a zero byte.");
273 inline size_t Remaining()
const 278 inline bool HasData(
size_t count = 1)
const 280 return data + count <= end;
288 inline void Skip(
size_t len)
297 typedef void (*SpecialSpriteHandler)(
ByteReader *buf);
310 uint16 cargo_allowed;
311 uint16 cargo_disallowed;
312 RailTypeLabel railtypelabel;
328 this->refittability = NONEMPTY;
329 }
else if (this->refittability == UNSET) {
330 this->refittability = EMPTY;
350 GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { }
354 return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline);
359 return this->grfid == other.grfid && this->nfoline == other.nfoline;
363 static std::map<GRFLocation, SpriteID> _grm_sprites;
364 typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride;
365 static GRFLineToSpriteOverride _grf_line_to_action6_sprite_override;
377 void CDECL
grfmsg(
int severity,
const char *str, ...)
397 if (file->grfid == grfid)
return file;
410 if (strcmp(file->filename, filename) == 0)
return file;
436 if (config !=
nullptr) {
447 if (message != STR_NULL) {
448 delete config->error;
449 config->error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, message);
453 return config->error;
464 typedef std::vector<StringIDMapping> StringIDMappingVector;
465 static StringIDMappingVector _string_to_grf_mapping;
474 *target = STR_UNDEFINED;
475 _string_to_grf_mapping.push_back({_cur.
grffile->grfid, source, target});
488 static const StringID units_volume[] = {
489 STR_ITEMS, STR_PASSENGERS, STR_TONS, STR_BAGS,
490 STR_LITERS, STR_ITEMS, STR_CRATES, STR_TONS,
491 STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
492 STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
493 STR_TONS, STR_TONS, STR_BAGS, STR_LITERS,
494 STR_TONS, STR_LITERS, STR_TONS, STR_ITEMS,
495 STR_BAGS, STR_LITERS, STR_TONS, STR_ITEMS,
496 STR_TONS, STR_ITEMS, STR_LITERS, STR_ITEMS
502 #define TEXTID_TO_STRINGID(begin, end, stringid, stringend) \ 503 assert_compile(stringend - stringid == end - begin); \ 504 if (str >= begin && str <= end) return str + (stringid - begin) 507 TEXTID_TO_STRINGID(0x000E, 0x002D, STR_CARGO_PLURAL_NOTHING, STR_CARGO_PLURAL_FIZZY_DRINKS);
508 TEXTID_TO_STRINGID(0x002E, 0x004D, STR_CARGO_SINGULAR_NOTHING, STR_CARGO_SINGULAR_FIZZY_DRINK);
509 if (str >= 0x004E && str <= 0x006D)
return units_volume[str - 0x004E];
510 TEXTID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING, STR_QUANTITY_FIZZY_DRINKS);
511 TEXTID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING, STR_ABBREV_FIZZY_DRINKS);
512 TEXTID_TO_STRINGID(0x00D1, 0x00E0, STR_COLOUR_DARK_BLUE, STR_COLOUR_WHITE);
517 TEXTID_TO_STRINGID(0x200F, 0x201F, STR_TOWN_BUILDING_NAME_TALL_OFFICE_BLOCK_1, STR_TOWN_BUILDING_NAME_OLD_HOUSES_1);
518 TEXTID_TO_STRINGID(0x2036, 0x2041, STR_TOWN_BUILDING_NAME_COTTAGES_1, STR_TOWN_BUILDING_NAME_SHOPPING_MALL_1);
519 TEXTID_TO_STRINGID(0x2059, 0x205C, STR_TOWN_BUILDING_NAME_IGLOO_1, STR_TOWN_BUILDING_NAME_PIGGY_BANK_1);
522 TEXTID_TO_STRINGID(0x4802, 0x4826, STR_INDUSTRY_NAME_COAL_MINE, STR_INDUSTRY_NAME_SUGAR_MINE);
523 TEXTID_TO_STRINGID(0x482D, 0x482E, STR_NEWS_INDUSTRY_CONSTRUCTION, STR_NEWS_INDUSTRY_PLANTED);
524 TEXTID_TO_STRINGID(0x4832, 0x4834, STR_NEWS_INDUSTRY_CLOSURE_GENERAL, STR_NEWS_INDUSTRY_CLOSURE_LACK_OF_TREES);
525 TEXTID_TO_STRINGID(0x4835, 0x4838, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_FARM);
526 TEXTID_TO_STRINGID(0x4839, 0x483A, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_FARM);
529 case 0x4830:
return STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY;
530 case 0x4831:
return STR_ERROR_FOREST_CAN_ONLY_BE_PLANTED;
531 case 0x483B:
return STR_ERROR_CAN_ONLY_BE_POSITIONED;
533 #undef TEXTID_TO_STRINGID 535 if (str == STR_NULL)
return STR_EMPTY;
537 DEBUG(grf, 0,
"Unknown StringID 0x%04X remapped to STR_EMPTY. Please open a Feature Request if you need it", str);
576 static std::map<uint32, uint32> _grf_id_overrides;
585 _grf_id_overrides[source_grfid] = target_grfid;
586 grfmsg(5,
"SetNewGRFOverride: Added override of 0x%X to 0x%X",
BSWAP32(source_grfid),
BSWAP32(target_grfid));
601 uint32 scope_grfid = INVALID_GRFID;
604 scope_grfid = file->grfid;
605 uint32
override = _grf_id_overrides[file->grfid];
607 scope_grfid =
override;
609 if (grf_match ==
nullptr) {
610 grfmsg(5,
"Tried mapping from GRFID %x to %x but target is not loaded",
BSWAP32(file->grfid),
BSWAP32(
override));
617 EngineID engine = _engine_mngr.
GetID(type, internal_id, scope_grfid);
626 EngineID engine = _engine_mngr.
GetID(type, internal_id, INVALID_GRFID);
632 grfmsg(5,
"Replaced engine at index %d for GRFID %x, type %d, index %d", e->
index,
BSWAP32(file->grfid), type, internal_id);
636 if (!static_access) {
638 eid->
grfid = scope_grfid;
644 if (static_access)
return nullptr;
647 grfmsg(0,
"Can't allocate any more engines");
658 assert(_engine_mngr.size() == e->
index);
659 _engine_mngr.push_back({
672 memset(_gted + engine_pool_size, 0, len);
678 grfmsg(5,
"Created new engine at index %d for GRFID %x, type %d, index %d", e->
index,
BSWAP32(file->grfid), type, internal_id);
695 uint32 scope_grfid = INVALID_GRFID;
697 scope_grfid = file->grfid;
698 uint32
override = _grf_id_overrides[file->grfid];
699 if (
override != 0) scope_grfid =
override;
702 return _engine_mngr.
GetID(type, internal_id, scope_grfid);
742 grf_sprite->
sprite = buf->ReadWord();
743 grf_sprite->
pal = buf->ReadWord();
748 bool custom_sprite =
HasBit(grf_sprite->
pal, 15) != invert_action1_flag;
752 uint index =
GB(grf_sprite->
sprite, 0, 14);
754 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d", index);
755 grf_sprite->
sprite = SPR_IMG_QUERY;
756 grf_sprite->
pal = PAL_NONE;
759 if (max_sprite_offset !=
nullptr) *max_sprite_offset = use_cur_spritesets ? _cur.
GetNumEnts(feature, index) : UINT16_MAX;
764 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout specifies var10 value for non-action-1 sprite");
765 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
771 uint index =
GB(grf_sprite->
pal, 0, 14);
773 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d for 'palette'", index);
774 grf_sprite->
pal = PAL_NONE;
777 if (max_palette_offset !=
nullptr) *max_palette_offset = use_cur_spritesets ? _cur.
GetNumEnts(feature, index) : UINT16_MAX;
782 grfmsg(1,
"ReadSpriteLayoutRegisters: Spritelayout specifies var10 value for non-action-1 palette");
783 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
812 regs.delta.
parent[0] = buf->ReadByte();
813 regs.delta.
parent[1] = buf->ReadByte();
825 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
834 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
853 bool has_flags =
HasBit(num_building_sprites, 6);
854 ClrBit(num_building_sprites, 6);
857 dts->
Allocate(num_building_sprites);
859 uint16 *max_sprite_offset =
AllocaM(uint16, num_building_sprites + 1);
860 uint16 *max_palette_offset =
AllocaM(uint16, num_building_sprites + 1);
861 MemSetT(max_sprite_offset, 0, num_building_sprites + 1);
862 MemSetT(max_palette_offset, 0, num_building_sprites + 1);
869 grfmsg(1,
"ReadSpriteLayout: Spritelayout uses invalid flag 0x%x for ground sprite", flags & ~(valid_flags & ~
TLF_NON_GROUND_FLAGS));
870 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
877 for (uint i = 0; i < num_building_sprites; i++) {
880 flags =
ReadSpriteLayoutSprite(buf, has_flags,
false, use_cur_spritesets, feature, &seq->image, max_sprite_offset + i + 1, max_palette_offset + i + 1);
883 if (flags & ~valid_flags) {
884 grfmsg(1,
"ReadSpriteLayout: Spritelayout uses unknown flag 0x%x", flags & ~valid_flags);
885 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
889 seq->
delta_x = buf->ReadByte();
890 seq->delta_y = buf->ReadByte();
892 if (!no_z_position) seq->
delta_z = buf->ReadByte();
895 seq->size_x = buf->ReadByte();
896 seq->size_y = buf->ReadByte();
897 seq->size_z = buf->ReadByte();
905 bool is_consistent =
true;
907 for (uint i = 0; i < num_building_sprites + 1; i++) {
908 if (max_sprite_offset[i] > 0) {
912 is_consistent =
false;
916 if (max_palette_offset[i] > 0) {
920 is_consistent =
false;
929 if (!is_consistent || dts->registers !=
nullptr) {
933 for (uint i = 0; i < num_building_sprites + 1; i++) {
948 CargoTypes result = 0;
967 if (base_pointer == 0) {
968 *index = INVALID_PRICE;
972 static const uint32 start = 0x4B34;
973 static const uint32 size = 6;
975 if (base_pointer < start || (base_pointer - start) % size != 0 || (base_pointer - start) / size >= PR_END) {
976 grfmsg(1,
"%s: Unsupported running cost base 0x%04X, ignoring", error_location, base_pointer);
980 *index = (
Price)((base_pointer - start) / size);
1009 ei->decay_speed = buf->ReadByte();
1026 ei->load_amount = buf->ReadByte();
1048 for (
int i = 0; i < numinfo; i++) {
1057 uint8 tracktype = buf->ReadByte();
1059 if (tracktype < _cur.grffile->railtype_list.size()) {
1064 switch (tracktype) {
1065 case 0: _gted[e->
index].railtypelabel = rvi->
engclass >= 2 ? RAILTYPE_ELECTRIC_LABEL : RAILTYPE_RAIL_LABEL;
break;
1066 case 1: _gted[e->
index].railtypelabel = RAILTYPE_MONO_LABEL;
break;
1067 case 2: _gted[e->
index].railtypelabel = RAILTYPE_MAGLEV_LABEL;
break;
1069 grfmsg(1,
"RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);
1082 uint16 speed = buf->ReadWord();
1083 if (speed == 0xFFFF) speed = 0;
1090 rvi->
power = buf->ReadWord();
1093 if (rvi->
power != 0) {
1116 if (spriteid < 0xFD) spriteid >>= 1;
1118 if (IsValidNewGRFImageIndex<VEH_TRAIN>(spriteid)) {
1121 grfmsg(1,
"RailVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1122 rvi->image_index = 0;
1128 uint8 dual = buf->ReadByte();
1133 rvi->railveh_type = rvi->
power == 0 ?
1145 uint8 ctype = buf->ReadByte();
1147 if (ctype == 0xFF) {
1150 }
else if (_cur.
grffile->grf_version >= 8) {
1155 ei->cargo_type = ctype;
1158 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1164 SB(rvi->
weight, 0, 8, buf->ReadByte());
1172 grfmsg(2,
"RailVehicleChangeInfo: Property 0x18 'AI rank' not used by NoAI, ignored.");
1184 uint8 traction = buf->ReadByte();
1187 if (traction <= 0x07) {
1189 }
else if (traction <= 0x27) {
1191 }
else if (traction <= 0x31) {
1193 }
else if (traction <= 0x37) {
1195 }
else if (traction <= 0x41) {
1204 if (_gted[e->
index].railtypelabel == RAILTYPE_RAIL_LABEL && engclass >=
EC_ELECTRIC) _gted[e->
index].railtypelabel = RAILTYPE_ELECTRIC_LABEL;
1205 if (_gted[e->
index].railtypelabel == RAILTYPE_ELECTRIC_LABEL && engclass <
EC_ELECTRIC) _gted[e->
index].railtypelabel = RAILTYPE_RAIL_LABEL;
1221 ei->refit_cost = buf->ReadByte();
1225 uint32 mask = buf->ReadDWord();
1263 byte weight = buf->ReadByte();
1266 grfmsg(2,
"RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8);
1288 _gted[e->
index].cargo_allowed = buf->ReadWord();
1294 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1308 uint8 count = buf->ReadByte();
1342 for (
int i = 0; i < numinfo; i++) {
1353 _gted[e->
index].roadtramtype = buf->ReadByte() + 1;
1361 rvi->running_cost = buf->ReadByte();
1373 if (spriteid == 0xFF) spriteid = 0xFD;
1375 if (spriteid < 0xFD) spriteid >>= 1;
1377 if (IsValidNewGRFImageIndex<VEH_ROAD>(spriteid)) {
1380 grfmsg(1,
"RoadVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1381 rvi->image_index = 0;
1387 rvi->capacity = buf->ReadByte();
1392 uint8 ctype = buf->ReadByte();
1394 if (ctype == 0xFF) {
1397 }
else if (_cur.
grffile->grf_version >= 8) {
1402 ei->cargo_type = ctype;
1405 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1411 rvi->cost_factor = buf->ReadByte();
1419 rvi->
power = buf->ReadByte();
1423 rvi->
weight = buf->ReadByte();
1431 uint32 mask = buf->ReadDWord();
1451 ei->refit_cost = buf->ReadByte();
1464 _gted[e->
index].cargo_allowed = buf->ReadWord();
1470 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1502 uint8 count = buf->ReadByte();
1536 for (
int i = 0; i < numinfo; i++) {
1549 if (spriteid == 0xFF) spriteid = 0xFD;
1551 if (spriteid < 0xFD) spriteid >>= 1;
1553 if (IsValidNewGRFImageIndex<VEH_SHIP>(spriteid)) {
1556 grfmsg(1,
"ShipVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1557 svi->image_index = 0;
1567 svi->cost_factor = buf->ReadByte();
1576 uint8 ctype = buf->ReadByte();
1578 if (ctype == 0xFF) {
1581 }
else if (_cur.
grffile->grf_version >= 8) {
1586 ei->cargo_type = ctype;
1589 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1595 svi->capacity = buf->ReadWord();
1599 svi->running_cost = buf->ReadByte();
1607 uint32 mask = buf->ReadDWord();
1619 ei->refit_cost = buf->ReadByte();
1640 _gted[e->
index].cargo_allowed = buf->ReadWord();
1646 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1674 uint8 count = buf->ReadByte();
1708 for (
int i = 0; i < numinfo; i++) {
1721 if (spriteid == 0xFF) spriteid = 0xFD;
1723 if (spriteid < 0xFD) spriteid >>= 1;
1725 if (IsValidNewGRFImageIndex<VEH_AIRCRAFT>(spriteid)) {
1728 grfmsg(1,
"AircraftVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1729 avi->image_index = 0;
1735 if (buf->ReadByte() == 0) {
1743 SB(avi->
subtype, 1, 1, (buf->ReadByte() != 0 ? 1 : 0));
1747 avi->cost_factor = buf->ReadByte();
1751 avi->
max_speed = (buf->ReadByte() * 128) / 10;
1755 avi->acceleration = buf->ReadByte();
1759 avi->running_cost = buf->ReadByte();
1775 uint32 mask = buf->ReadDWord();
1787 ei->refit_cost = buf->ReadByte();
1800 _gted[e->
index].cargo_allowed = buf->ReadWord();
1806 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1824 uint8 count = buf->ReadByte();
1870 for (
int i = 0; i < numinfo; i++) {
1874 if (statspec ==
nullptr && prop != 0x08) {
1875 grfmsg(2,
"StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i);
1884 if (*spec ==
nullptr) *spec = CallocT<StationSpec>(1);
1887 uint32 classid = buf->ReadDWord();
1888 (*spec)->cls_id = StationClass::Allocate(
BSWAP32(classid));
1893 statspec->
tiles = buf->ReadExtendedByte();
1897 for (uint t = 0; t < statspec->
tiles; t++) {
1901 if (buf->HasData(4) && *(uint32*)buf->Data() == 0) {
1904 dts->
Clone(&_station_display_datas_rail[t % 8]);
1912 static std::vector<DrawTileSeqStruct> tmp_layout;
1916 tmp_layout.emplace_back();
1920 dtss.
delta_x = buf->ReadByte();
1922 dtss.delta_y = buf->ReadByte();
1923 dtss.
delta_z = buf->ReadByte();
1924 dtss.size_x = buf->ReadByte();
1925 dtss.size_y = buf->ReadByte();
1926 dtss.size_z = buf->ReadByte();
1932 dts->
Clone(tmp_layout.data());
1937 byte srcid = buf->ReadByte();
1940 if (srcstatspec ==
nullptr) {
1941 grfmsg(1,
"StationChangeInfo: Station %u is not defined, cannot copy sprite layout to %u.", srcid, stid + i);
1949 for (uint t = 0; t < statspec->
tiles; t++) {
1968 statspec->copied_layouts =
false;
1970 while (buf->HasData()) {
1971 byte length = buf->ReadByte();
1972 byte number = buf->ReadByte();
1973 StationLayout layout;
1976 if (length == 0 || number == 0)
break;
1978 if (length > statspec->lengths) {
1979 byte diff_length = length - statspec->lengths;
1980 statspec->platforms =
ReallocT(statspec->platforms, length);
1981 memset(statspec->platforms + statspec->lengths, 0, diff_length);
1983 statspec->layouts =
ReallocT(statspec->layouts, length);
1984 memset(statspec->layouts + statspec->lengths, 0, diff_length *
sizeof(*statspec->layouts));
1986 statspec->lengths = length;
1990 if (number > statspec->platforms[l]) {
1991 statspec->layouts[l] =
ReallocT(statspec->layouts[l], number);
1993 memset(statspec->layouts[l] + statspec->platforms[l], 0,
1994 (number - statspec->platforms[l]) *
sizeof(**statspec->layouts));
1996 statspec->platforms[l] = number;
2000 layout = MallocT<byte>(length * number);
2002 for (l = 0; l < length; l++) {
2003 for (p = 0; p < number; p++) {
2004 layout[l * number + p] = buf->ReadByte();
2014 free(statspec->layouts[l][p]);
2015 statspec->layouts[l][p] = layout;
2020 byte srcid = buf->ReadByte();
2023 if (srcstatspec ==
nullptr) {
2024 grfmsg(1,
"StationChangeInfo: Station %u is not defined, cannot copy tile layout to %u.", srcid, stid + i);
2028 statspec->lengths = srcstatspec->lengths;
2029 statspec->platforms = srcstatspec->platforms;
2030 statspec->layouts = srcstatspec->layouts;
2031 statspec->copied_layouts =
true;
2040 statspec->
pylons = buf->ReadByte();
2044 if (_cur.
grffile->grf_version >= 7) {
2052 statspec->
flags = buf->ReadByte();
2056 statspec->
wires = buf->ReadByte();
2060 statspec->
blocked = buf->ReadByte();
2064 statspec->animation.
frames = buf->ReadByte();
2065 statspec->animation.
status = buf->ReadByte();
2069 statspec->animation.
speed = buf->ReadByte();
2073 statspec->animation.
triggers = buf->ReadWord();
2077 statspec->
tiles = buf->ReadExtendedByte();
2081 for (uint t = 0; t < statspec->
tiles; t++) {
2083 uint num_building_sprites = buf->ReadByte();
2110 if (
id + numinfo > CF_END) {
2111 grfmsg(1,
"CanalChangeInfo: Canal feature 0x%02X is invalid, max %u, ignoring",
id + numinfo, CF_END);
2115 for (
int i = 0; i < numinfo; i++) {
2124 cp->
flags = buf->ReadByte();
2149 grfmsg(1,
"BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo,
MAX_BRIDGES);
2153 for (
int i = 0; i < numinfo; i++) {
2159 byte year = buf->ReadByte();
2174 bridge->
price = buf->ReadByte();
2178 bridge->
speed = buf->ReadWord();
2182 byte tableid = buf->ReadByte();
2183 byte numtables = buf->ReadByte();
2190 for (; numtables-- != 0; tableid++) {
2192 grfmsg(1,
"BridgeChangeInfo: Table %d >= 7, skipping", tableid);
2198 bridge->
sprite_table[tableid] = MallocT<PalSpriteID>(32);
2215 bridge->
flags = buf->ReadByte();
2224 if (newone != STR_UNDEFINED) bridge->
material = newone;
2231 if (newone != STR_UNDEFINED) bridge->
transport_name[prop - 0x11] = newone;
2236 bridge->
price = buf->ReadWord();
2293 for (uint j = 0; j < 4; j++) buf->ReadByte();
2297 byte count = buf->ReadByte();
2298 for (byte j = 0; j < count; j++) buf->ReadByte();
2303 buf->Skip(buf->ReadByte() * 2);
2326 grfmsg(1,
"TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo,
NUM_HOUSES_PER_GRF);
2331 if (_cur.
grffile->housespec ==
nullptr) {
2335 for (
int i = 0; i < numinfo; i++) {
2338 if (prop != 0x08 && housespec ==
nullptr) {
2341 if (cir > ret) ret = cir;
2348 byte subs_id = buf->ReadByte();
2350 if (subs_id == 0xFF) {
2353 HouseSpec::Get(hid + i)->
enabled =
false;
2357 grfmsg(2,
"TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i);
2362 if (*house ==
nullptr) *house = CallocT<HouseSpec>(1);
2366 MemCpyT(housespec, HouseSpec::Get(subs_id));
2368 housespec->enabled =
true;
2369 housespec->grf_prop.local_id = hid + i;
2370 housespec->grf_prop.subst_id = subs_id;
2371 housespec->grf_prop.grffile = _cur.
grffile;
2372 housespec->random_colour[0] = 0x04;
2373 housespec->random_colour[1] = 0x08;
2374 housespec->random_colour[2] = 0x0C;
2375 housespec->random_colour[3] = 0x06;
2382 housespec->cargo_acceptance[2] = 0;
2394 uint16 years = buf->ReadWord();
2414 int8 goods = buf->ReadByte();
2450 byte
override = buf->ReadByte();
2454 grfmsg(2,
"TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.",
override, hid + i);
2458 _house_mngr.
Add(hid + i, _cur.
grffile->grfid,
override);
2467 for (uint j = 0; j < 4; j++) housespec->
random_colour[j] = buf->ReadByte();
2489 housespec->
class_id = AllocateHouseClassID(buf->ReadByte(), _cur.
grffile->grfid);
2497 uint32 cargotypes = buf->ReadDWord();
2500 if (cargotypes == 0xFFFFFFFF)
break;
2502 for (uint j = 0; j < 3; j++) {
2504 uint8 cargo_part =
GB(cargotypes, 8 * j, 8);
2522 byte count = buf->ReadByte();
2523 for (byte j = 0; j < count; j++) {
2531 housespec->
min_year = buf->ReadWord();
2535 housespec->
max_year = buf->ReadWord();
2539 uint count = buf->ReadByte();
2591 template <
typename T>
2595 grfmsg(1,
"LoadTranslationTable: %s translation table must start at zero", name);
2599 translation_table.clear();
2600 for (
int i = 0; i < numinfo; i++) {
2601 uint32 item = buf->ReadDWord();
2602 translation_table.push_back(
BSWAP32(item));
2638 for (
int i = 0; i < numinfo; i++) {
2641 int factor = buf->ReadByte();
2642 uint price = gvid + i;
2644 if (price < PR_END) {
2647 grfmsg(1,
"GlobalVarChangeInfo: Price %d out of range, ignoring", price);
2656 if ((newone != STR_UNDEFINED) && (curidx <
CURRENCY_END)) {
2664 uint32 rate = buf->ReadDWord();
2672 grfmsg(1,
"GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx);
2679 uint16 options = buf->ReadWord();
2688 grfmsg(1,
"GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx);
2695 uint32 tempfix = buf->ReadDWord();
2701 grfmsg(1,
"GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2708 uint32 tempfix = buf->ReadDWord();
2714 grfmsg(1,
"GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2721 Year year_euro = buf->ReadWord();
2726 grfmsg(1,
"GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx);
2733 grfmsg(1,
"GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo);
2735 grfmsg(1,
"GlobalVarChangeInfo: Not enough entries set in the snowline table (" PRINTF_SIZE
")", buf->Remaining());
2741 table[i][j] = buf->ReadByte();
2742 if (_cur.
grffile->grf_version >= 8) {
2745 if (table[i][j] >= 128) {
2767 uint curidx = gvid + i;
2769 if (lang ==
nullptr) {
2770 grfmsg(1,
"GlobalVarChangeInfo: Language %d is not known, ignoring", curidx);
2775 while (buf->ReadByte() != 0) {
2785 uint plural_form = buf->ReadByte();
2786 if (plural_form >= LANGUAGE_MAX_PLURAL) {
2787 grfmsg(1,
"GlobalVarChanceInfo: Plural form %d is out of range, ignoring", plural_form);
2794 byte newgrf_id = buf->ReadByte();
2795 while (newgrf_id != 0) {
2796 const char *name = buf->ReadString();
2811 grfmsg(1,
"GlobalVarChangeInfo: Gender name %s is not known, ignoring", name);
2818 grfmsg(1,
"GlobalVarChangeInfo: Case name %s is not known, ignoring", name);
2823 newgrf_id = buf->ReadByte();
2859 for (
int i = 0; i < numinfo; i++) {
2883 uint32 s = buf->ReadDWord();
2884 uint32 t = buf->ReadDWord();
2891 while (buf->ReadByte() != 0) {
2919 grfmsg(2,
"CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo,
NUM_CARGO - 1);
2923 for (
int i = 0; i < numinfo; i++) {
2928 cs->
bitnum = buf->ReadByte();
2966 cs->
sprite = buf->ReadWord();
2970 cs->
weight = buf->ReadByte();
2974 cs->transit_days[0] = buf->ReadByte();
2978 cs->transit_days[1] = buf->ReadByte();
2982 cs->initial_payment = buf->ReadDWord();
2986 cs->rating_colour = buf->ReadByte();
2990 cs->legend_colour = buf->ReadByte();
2998 cs->
classes = buf->ReadWord();
3002 cs->
label = buf->ReadDWord();
3007 uint8 substitute_type = buf->ReadByte();
3009 switch (substitute_type) {
3016 grfmsg(1,
"CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type);
3032 cs->
multiplier = max<uint16>(1u, buf->ReadWord());
3057 if (_cur.
grffile->sound_offset == 0) {
3058 grfmsg(1,
"SoundEffectChangeInfo: No effects defined, skipping");
3063 grfmsg(1,
"SoundEffectChangeInfo: Attempting to change undefined sound effect (%u), max (%u). Ignoring.", sid + numinfo,
ORIGINAL_SAMPLE_COUNT + _cur.
grffile->num_sounds);
3067 for (
int i = 0; i < numinfo; i++) {
3072 sound->volume = buf->ReadByte();
3076 sound->priority = buf->ReadByte();
3080 SoundID orig_sound = buf->ReadByte();
3085 SoundEntry *old_sound = GetSound(orig_sound);
3088 *old_sound = *sound;
3130 buf->Skip(buf->ReadByte() * 2);
3158 if (_cur.
grffile->indtspec ==
nullptr) {
3162 for (
int i = 0; i < numinfo; i++) {
3165 if (prop != 0x08 && tsp ==
nullptr) {
3167 if (cir > ret) ret = cir;
3174 byte subs_id = buf->ReadByte();
3178 grfmsg(2,
"IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i);
3183 if (*tilespec ==
nullptr) {
3184 *tilespec = CallocT<IndustryTileSpec>(1);
3187 memcpy(tsp, &_industry_tile_specs[subs_id],
sizeof(_industry_tile_specs[subs_id]));
3188 tsp->enabled =
true;
3196 tsp->grf_prop.local_id = indtid + i;
3197 tsp->grf_prop.subst_id = subs_id;
3198 tsp->grf_prop.grffile = _cur.
grffile;
3205 byte ovrid = buf->ReadByte();
3209 grfmsg(2,
"IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i);
3213 _industile_mngr.
Add(indtid + i, _cur.
grffile->grfid, ovrid);
3220 uint16 acctp = buf->ReadWord();
3252 byte num_cargoes = buf->ReadByte();
3259 if (i < num_cargoes) {
3326 byte num_table = buf->ReadByte();
3327 for (byte j = 0; j < num_table; j++) {
3328 for (uint k = 0;; k++) {
3329 byte x = buf->ReadByte();
3330 if (x == 0xFE && k == 0) {
3336 byte y = buf->ReadByte();
3337 if (x == 0 && y == 0x80)
break;
3339 byte gfx = buf->ReadByte();
3340 if (gfx == 0xFE) buf->ReadWord();
3347 for (byte j = 0; j < 3; j++) buf->ReadByte();
3354 buf->Skip(buf->ReadByte());
3358 int num_inputs = buf->ReadByte();
3359 int num_outputs = buf->ReadByte();
3360 buf->Skip(num_inputs * num_outputs * 2);
3378 const size_t size = layout.size();
3379 for (
size_t i = 0; i < size - 1; i++) {
3380 for (
size_t j = i + 1; j < size; j++) {
3381 if (layout[i].ti.x == layout[j].ti.x &&
3382 layout[i].ti.y == layout[j].ti.y) {
3408 if (_cur.
grffile->industryspec ==
nullptr) {
3412 for (
int i = 0; i < numinfo; i++) {
3415 if (prop != 0x08 && indsp ==
nullptr) {
3417 if (cir > ret) ret = cir;
3424 byte subs_id = buf->ReadByte();
3426 if (subs_id == 0xFF) {
3429 _industry_specs[indid + i].
enabled =
false;
3433 grfmsg(2,
"_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i);
3440 if (*indspec ==
nullptr) {
3444 *indsp = _origin_industry_specs[subs_id];
3447 indsp->
grf_prop.subst_id = subs_id;
3457 byte ovrid = buf->ReadByte();
3461 grfmsg(2,
"IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i);
3465 _industry_mngr.
Add(indid + i, _cur.
grffile->grfid, ovrid);
3470 byte new_num_layouts = buf->ReadByte();
3471 uint32 definition_size = buf->ReadDWord();
3472 uint32 bytes_read = 0;
3473 std::vector<IndustryTileLayout> new_layouts;
3476 for (byte j = 0; j < new_num_layouts; j++) {
3479 for (uint k = 0;; k++) {
3480 if (bytes_read >= definition_size) {
3481 grfmsg(3,
"IndustriesChangeInfo: Incorrect size for industry tile layout definition for industry %u.", indid);
3483 definition_size = UINT32_MAX;
3489 it.ti.
x = buf->ReadByte();
3492 if (it.ti.
x == 0xFE && k == 0) {
3494 IndustryType type = buf->ReadByte();
3495 byte laynbr = buf->ReadByte();
3498 if (type >=
lengthof(_origin_industry_specs)) {
3499 grfmsg(1,
"IndustriesChangeInfo: Invalid original industry number for layout import, industry %u", indid);
3503 if (laynbr >= _origin_industry_specs[type].layouts.size()) {
3504 grfmsg(1,
"IndustriesChangeInfo: Invalid original industry layout index for layout import, industry %u", indid);
3508 layout = _origin_industry_specs[type].layouts[laynbr];
3512 it.ti.
y = buf->ReadByte();
3515 if (it.ti.
x == 0 && it.ti.
y == 0x80) {
3521 it.gfx = buf->ReadByte();
3524 if (it.gfx == 0xFE) {
3526 int local_tile_id = buf->ReadWord();
3530 int tempid = _industile_mngr.
GetID(local_tile_id, _cur.
grffile->grfid);
3533 grfmsg(2,
"IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid);
3538 }
else if (it.gfx == 0xFF) {
3539 it.ti.
x = (int8)
GB(it.ti.
x, 0, 8);
3540 it.ti.
y = (int8)
GB(it.ti.
y, 0, 8);
3549 if (_cur.
grffile->grf_version < 8 && it.ti.
x < 0) it.ti.
y += 1;
3555 grfmsg(1,
"IndustriesChangeInfo: Invalid industry layout for industry id %u. Ignoring", indid);
3559 new_layouts.push_back(layout);
3589 for (byte j = 0; j < 2; j++) {
3595 for (byte j = 0; j < 3; j++) {
3603 indsp->production_rate[prop - 0x12] = buf->ReadByte();
3616 sounds[j] = buf->ReadByte();
3632 for (byte j = 0; j < 3; j++) indsp->
conflicting[j] = buf->ReadByte();
3658 uint32 multiples = buf->ReadDWord();
3674 byte aflag = buf->ReadByte();
3684 uint16 str = buf->ReadWord();
3694 byte num_cargoes = buf->ReadByte();
3695 if (num_cargoes >
lengthof(indsp->produced_cargo)) {
3700 for (uint i = 0; i <
lengthof(indsp->produced_cargo); i++) {
3701 if (i < num_cargoes) {
3703 indsp->produced_cargo[i] = cargo;
3712 byte num_cargoes = buf->ReadByte();
3719 if (i < num_cargoes) {
3730 byte num_cargoes = buf->ReadByte();
3731 if (num_cargoes >
lengthof(indsp->production_rate)) {
3736 for (uint i = 0; i <
lengthof(indsp->production_rate); i++) {
3737 if (i < num_cargoes) {
3738 indsp->production_rate[i] = buf->ReadByte();
3740 indsp->production_rate[i] = 0;
3747 byte num_inputs = buf->ReadByte();
3748 byte num_outputs = buf->ReadByte();
3755 for (uint j = 0; j <
lengthof(indsp->produced_cargo); j++) {
3757 if (i < num_inputs && j < num_outputs) mult = buf->ReadWord();
3781 for (
int i = 0; i < as->
num_table; i++) {
3786 }
while ((++it)->ti.x != -0x80);
3787 table_list[i] = MallocT<AirportTileTable>(num_tiles);
3790 as->
table = table_list;
3812 grfmsg(1,
"AirportChangeInfo: Too many airports, trying id (%u), max (%u). Ignoring.", airport + numinfo,
NUM_AIRPORTS_PER_GRF);
3817 if (_cur.
grffile->airportspec ==
nullptr) {
3821 for (
int i = 0; i < numinfo; i++) {
3824 if (as ==
nullptr && prop != 0x08 && prop != 0x09) {
3825 grfmsg(2,
"AirportChangeInfo: Attempt to modify undefined airport %u, ignoring", airport + i);
3831 byte subs_id = buf->ReadByte();
3833 if (subs_id == 0xFF) {
3840 grfmsg(2,
"AirportChangeInfo: Attempt to use new airport %u as substitute airport for %u. Ignoring.", subs_id, airport + i);
3848 if (*spec ==
nullptr) {
3849 *spec = MallocT<AirportSpec>(1);
3854 as->grf_prop.local_id = airport + i;
3855 as->grf_prop.subst_id = subs_id;
3856 as->grf_prop.grffile = _cur.
grffile;
3858 _airport_mngr.
Add(airport + i, _cur.
grffile->grfid, subs_id);
3869 uint32 defsize = buf->ReadDWord();
3875 for (byte j = 0; j < as->
num_table; j++) {
3877 for (
int k = 0;; k++) {
3878 att[k].ti.x = buf->ReadByte();
3879 att[k].ti.y = buf->ReadByte();
3881 if (att[k].ti.x == 0 && att[k].ti.y == 0x80) {
3884 att[k].ti.x = -0x80;
3893 att[k].
gfx = buf->ReadByte();
3895 if (att[k].gfx == 0xFE) {
3897 int local_tile_id = buf->ReadWord();
3900 uint16 tempid = _airporttile_mngr.
GetID(local_tile_id, _cur.
grffile->grfid);
3903 grfmsg(2,
"AirportChangeInfo: Attempt to use airport tile %u with airport id %u, not yet defined. Ignoring.", local_tile_id, airport + i);
3906 att[k].gfx = tempid;
3908 }
else if (att[k].gfx == 0xFF) {
3909 att[k].ti.x = (int8)
GB(att[k].ti.x, 0, 8);
3910 att[k].ti.y = (int8)
GB(att[k].ti.y, 0, 8);
3921 tile_table[j] = CallocT<AirportTileTable>(size);
3922 memcpy(tile_table[j], copy_from,
sizeof(*copy_from) * size);
3925 as->
table = tile_table;
3928 for (
int i = 0; i < as->
num_table; i++) {
3929 free(tile_table[i]);
4035 if (_cur.
grffile->objectspec ==
nullptr) {
4039 for (
int i = 0; i < numinfo; i++) {
4042 if (prop != 0x08 && spec ==
nullptr) {
4045 if (cir > ret) ret = cir;
4054 if (*ospec ==
nullptr) {
4055 *ospec = CallocT<ObjectSpec>(1);
4056 (*ospec)->
views = 1;
4060 uint32 classid = buf->ReadDWord();
4061 (*ospec)->cls_id = ObjectClass::Allocate(
BSWAP32(classid));
4062 (*ospec)->enabled =
true;
4077 spec->
climate = buf->ReadByte();
4081 spec->
size = buf->ReadByte();
4124 spec->
height = buf->ReadByte();
4128 spec->
views = buf->ReadByte();
4130 grfmsg(2,
"ObjectChangeInfo: Invalid number of views (%u) for object id %u. Ignoring.", spec->
views,
id + i);
4163 grfmsg(1,
"RailTypeChangeInfo: Rail type %u is invalid, max %u, ignoring",
id + numinfo,
RAILTYPE_END);
4167 for (
int i = 0; i < numinfo; i++) {
4180 uint16 str = buf->ReadWord();
4182 if (_cur.
grffile->grf_version < 8) {
4212 int n = buf->ReadByte();
4213 for (
int j = 0; j != n; j++) {
4214 RailTypeLabel label = buf->ReadDWord();
4274 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4293 grfmsg(1,
"RailTypeReserveInfo: Rail type %u is invalid, max %u, ignoring",
id + numinfo,
RAILTYPE_END);
4297 for (
int i = 0; i < numinfo; i++) {
4301 RailTypeLabel rtl = buf->ReadDWord();
4310 _cur.
grffile->railtype_map[
id + i] = rt;
4328 int n = buf->ReadByte();
4329 for (
int j = 0; j != n; j++) {
4334 grfmsg(1,
"RailTypeReserveInfo: Ignoring property 1D for rail type %u because no label was set",
id + i);
4341 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4382 grfmsg(1,
"RoadTypeChangeInfo: Road type %u is invalid, max %u, ignoring",
id + numinfo,
ROADTYPE_END);
4386 for (
int i = 0; i < numinfo; i++) {
4399 uint16 str = buf->ReadWord();
4426 int n = buf->ReadByte();
4427 for (
int j = 0; j != n; j++) {
4428 RoadTypeLabel label = buf->ReadDWord();
4475 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4506 grfmsg(1,
"RoadTypeReserveInfo: Road type %u is invalid, max %u, ignoring",
id + numinfo,
ROADTYPE_END);
4510 for (
int i = 0; i < numinfo; i++) {
4513 RoadTypeLabel rtl = buf->ReadDWord();
4520 }
else if (GetRoadTramType(rt) != rtt) {
4521 grfmsg(1,
"RoadTypeReserveInfo: Road type %u is invalid type (road/tram), ignoring",
id + numinfo);
4525 type_map[
id + i] = rt;
4542 int n = buf->ReadByte();
4543 for (
int j = 0; j != n; j++) {
4548 grfmsg(1,
"RoadTypeReserveInfo: Ignoring property 1D for road type %u because no label was set",
id + i);
4554 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4580 return RoadTypeReserveInfo(
id, numinfo, prop, buf, RTT_ROAD);
4585 return RoadTypeReserveInfo(
id, numinfo, prop, buf, RTT_TRAM);
4598 if (_cur.
grffile->airtspec ==
nullptr) {
4602 for (
int i = 0; i < numinfo; i++) {
4605 if (prop != 0x08 && tsp ==
nullptr) {
4606 grfmsg(2,
"AirportTileChangeInfo: Attempt to modify undefined airport tile %u. Ignoring.", airtid + i);
4613 byte subs_id = buf->ReadByte();
4617 grfmsg(2,
"AirportTileChangeInfo: Attempt to use new airport tile %u as substitute airport tile for %u. Ignoring.", subs_id, airtid + i);
4622 if (*tilespec ==
nullptr) {
4623 *tilespec = CallocT<AirportTileSpec>(1);
4627 tsp->enabled =
true;
4631 tsp->grf_prop.local_id = airtid + i;
4632 tsp->grf_prop.subst_id = subs_id;
4633 tsp->grf_prop.grffile = _cur.
grffile;
4640 byte
override = buf->ReadByte();
4644 grfmsg(2,
"AirportTileChangeInfo: Attempt to override new airport tile %u with airport tile id %u. Ignoring.",
override, airtid + i);
4648 _airporttile_mngr.
Add(airtid + i, _cur.
grffile->grfid,
override);
4678 static bool HandleChangeInfoResult(
const char *caller,
ChangeInfoResult cir, uint8 feature, uint8 property)
4681 default: NOT_REACHED();
4691 grfmsg(1,
"%s: Ignoring property 0x%02X of feature 0x%02X (not implemented)", caller, property, feature);
4695 grfmsg(0,
"%s: Unknown property 0x%02X of feature 0x%02X, disabling", caller, property, feature);
4708 static void FeatureChangeInfo(
ByteReader *buf)
4721 static const VCI_Handler handler[] = {
4739 AirportTilesChangeInfo,
4744 uint8 feature = buf->ReadByte();
4745 uint8 numprops = buf->ReadByte();
4746 uint numinfo = buf->ReadByte();
4747 uint engine = buf->ReadExtendedByte();
4749 if (feature >= GSF_END) {
4750 grfmsg(1,
"FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4754 grfmsg(6,
"FeatureChangeInfo: Feature 0x%02X, %d properties, to apply to %d+%d",
4755 feature, numprops, engine, numinfo);
4757 if (feature >=
lengthof(handler) || handler[feature] ==
nullptr) {
4758 if (feature != GSF_CARGOES)
grfmsg(1,
"FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4765 while (numprops-- && buf->HasData()) {
4766 uint8 prop = buf->ReadByte();
4769 if (HandleChangeInfoResult(
"FeatureChangeInfo", cir, feature, prop))
return;
4776 uint8 feature = buf->ReadByte();
4777 uint8 numprops = buf->ReadByte();
4778 uint numinfo = buf->ReadByte();
4779 buf->ReadExtendedByte();
4781 if (feature == GSF_BRIDGES && numprops == 1) {
4782 uint8 prop = buf->ReadByte();
4785 if (prop == 0x0D)
return;
4786 }
else if (feature == GSF_GLOBALVAR && numprops == 1) {
4787 uint8 prop = buf->ReadByte();
4790 bool is_safe =
true;
4791 for (uint i = 0; i < numinfo; i++) {
4792 uint32 s = buf->ReadDWord();
4800 if (is_safe)
return;
4811 static void ReserveChangeInfo(
ByteReader *buf)
4813 uint8 feature = buf->ReadByte();
4815 if (feature != GSF_CARGOES && feature != GSF_GLOBALVAR && feature != GSF_RAILTYPES && feature != GSF_ROADTYPES && feature != GSF_TRAMTYPES)
return;
4817 uint8 numprops = buf->ReadByte();
4818 uint8 numinfo = buf->ReadByte();
4819 uint8 index = buf->ReadExtendedByte();
4821 while (numprops-- && buf->HasData()) {
4822 uint8 prop = buf->ReadByte();
4826 default: NOT_REACHED();
4832 cir = GlobalVarReserveInfo(index, numinfo, prop, buf);
4836 cir = RailTypeReserveInfo(index, numinfo, prop, buf);
4840 cir = RoadTypeReserveInfo(index, numinfo, prop, buf);
4844 cir = TramTypeReserveInfo(index, numinfo, prop, buf);
4848 if (HandleChangeInfoResult(
"ReserveChangeInfo", cir, feature, prop))
return;
4869 uint8 feature = buf->ReadByte();
4870 uint16 num_sets = buf->ReadByte();
4871 uint16 first_set = 0;
4873 if (num_sets == 0 && buf->HasData(3)) {
4876 first_set = buf->ReadExtendedByte();
4877 num_sets = buf->ReadExtendedByte();
4879 uint16 num_ents = buf->ReadExtendedByte();
4881 if (feature >= GSF_END) {
4883 grfmsg(1,
"NewSpriteSet: Unsupported feature 0x%02X, skipping %d sprites", feature, _cur.
skip_sprites);
4889 grfmsg(7,
"New sprite set at %d of feature 0x%02X, consisting of %d sets with %d views each (total %d)",
4890 _cur.
spriteid, feature, num_sets, num_ents, num_sets * num_ents
4893 for (
int i = 0; i < num_sets * num_ents; i++) {
4903 uint16 num_sets = buf->ReadByte();
4905 if (num_sets == 0 && buf->HasData(3)) {
4908 buf->ReadExtendedByte();
4909 num_sets = buf->ReadExtendedByte();
4911 uint16 num_ents = buf->ReadExtendedByte();
4920 static const SpriteGroup *GetGroupFromGroupID(byte setid, byte type, uint16 groupid)
4922 if (
HasBit(groupid, 15)) {
4927 if (groupid >
MAX_SPRITEGROUP || _cur.spritegroups[groupid] ==
nullptr) {
4928 grfmsg(1,
"GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid);
4932 return _cur.spritegroups[groupid];
4945 if (
HasBit(spriteid, 15)) {
4951 grfmsg(1,
"CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid", setid, type, spriteid);
4959 assert(spriteset_start + num_sprites <= _cur.
spriteid);
4980 uint8 feature = buf->ReadByte();
4981 if (feature >= GSF_END) {
4982 grfmsg(1,
"NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
4986 uint8 setid = buf->ReadByte();
4987 uint8 type = buf->ReadByte();
5010 switch (
GB(type, 2, 2)) {
5011 default: NOT_REACHED();
5012 case 0: group->size = DSG_SIZE_BYTE; varsize = 1;
break;
5013 case 1: group->size = DSG_SIZE_WORD; varsize = 2;
break;
5014 case 2: group->size = DSG_SIZE_DWORD; varsize = 4;
break;
5017 static std::vector<DeterministicSpriteGroupAdjust> adjusts;
5023 adjusts.emplace_back();
5028 adjust.variable = buf->ReadByte();
5029 if (adjust.variable == 0x7E) {
5031 adjust.subroutine = GetGroupFromGroupID(setid, type, buf->ReadByte());
5036 varadjust = buf->ReadByte();
5037 adjust.shift_num =
GB(varadjust, 0, 5);
5038 adjust.type = (DeterministicSpriteGroupAdjustType)
GB(varadjust, 6, 2);
5039 adjust.and_mask = buf->ReadVarSize(varsize);
5041 if (adjust.type != DSGA_TYPE_NONE) {
5042 adjust.add_val = buf->ReadVarSize(varsize);
5043 adjust.divmod_val = buf->ReadVarSize(varsize);
5046 adjust.divmod_val = 0;
5050 }
while (
HasBit(varadjust, 5));
5052 group->num_adjusts = (uint)adjusts.size();
5053 group->adjusts = MallocT<DeterministicSpriteGroupAdjust>(group->num_adjusts);
5054 MemCpyT(group->adjusts, adjusts.data(), group->num_adjusts);
5056 std::vector<DeterministicSpriteGroupRange> ranges;
5057 ranges.resize(buf->ReadByte());
5058 for (uint i = 0; i < ranges.size(); i++) {
5059 ranges[i].group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5060 ranges[i].low = buf->ReadVarSize(varsize);
5061 ranges[i].high = buf->ReadVarSize(varsize);
5064 group->default_group = GetGroupFromGroupID(setid, type, buf->ReadWord());
5065 group->error_group = ranges.size() > 0 ? ranges[0].group : group->default_group;
5067 group->calculated_result = ranges.size() == 0;
5070 std::vector<uint32> bounds;
5071 for (uint i = 0; i < ranges.size(); i++) {
5072 bounds.push_back(ranges[i].low);
5073 if (ranges[i].high != UINT32_MAX) bounds.push_back(ranges[i].high + 1);
5075 std::sort(bounds.begin(), bounds.end());
5076 bounds.erase(std::unique(bounds.begin(), bounds.end()), bounds.end());
5078 std::vector<const SpriteGroup *> target;
5079 for (uint j = 0; j < bounds.size(); ++j) {
5080 uint32 v = bounds[j];
5082 for (uint i = 0; i < ranges.size(); i++) {
5083 if (ranges[i].low <= v && v <= ranges[i].high) {
5084 t = ranges[i].group;
5088 target.push_back(t);
5090 assert(target.size() == bounds.size());
5092 std::vector<DeterministicSpriteGroupRange> optimised;
5093 for (uint j = 0; j < bounds.size(); ) {
5094 if (target[j] != group->default_group) {
5096 r.group = target[j];
5098 while (j < bounds.size() && target[j] == r.group) {
5101 r.high = j < bounds.size() ? bounds[j] - 1 : UINT32_MAX;
5102 optimised.push_back(r);
5108 group->num_ranges = (uint)optimised.size();
5109 if (group->num_ranges > 0) {
5110 group->ranges = MallocT<DeterministicSpriteGroupRange>(group->num_ranges);
5111 MemCpyT(group->ranges, &optimised.front(), group->num_ranges);
5128 group->count = buf->ReadByte();
5131 uint8 triggers = buf->ReadByte();
5132 group->triggers =
GB(triggers, 0, 7);
5133 group->
cmp_mode =
HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY;
5138 for (uint i = 0; i < group->
num_groups; i++) {
5139 group->
groups[i] = GetGroupFromGroupID(setid, type, buf->ReadWord());
5150 case GSF_ROADVEHICLES:
5161 byte num_loaded = type;
5162 byte num_loading = buf->ReadByte();
5165 grfmsg(0,
"NewSpriteGroup: No sprite set to work on! Skipping");
5175 if (num_loaded > 0) group->
loaded = CallocT<const SpriteGroup*>(num_loaded);
5176 if (num_loading > 0) group->
loading = CallocT<const SpriteGroup*>(num_loading);
5178 grfmsg(6,
"NewSpriteGroup: New SpriteGroup 0x%02X, %u loaded, %u loading",
5179 setid, num_loaded, num_loading);
5181 for (uint i = 0; i < num_loaded; i++) {
5184 grfmsg(8,
"NewSpriteGroup: + rg->loaded[%i] = subset %u", i, spriteid);
5187 for (uint i = 0; i < num_loading; i++) {
5190 grfmsg(8,
"NewSpriteGroup: + rg->loading[%i] = subset %u", i, spriteid);
5197 case GSF_AIRPORTTILES:
5199 case GSF_INDUSTRYTILES: {
5200 byte num_building_sprites =
max((uint8)1, type);
5207 if (
ReadSpriteLayout(buf, num_building_sprites,
true, feature,
false, type == 0, &group->dts))
return;
5211 case GSF_INDUSTRIES: {
5213 grfmsg(1,
"NewSpriteGroup: Unsupported industry production version %d, skipping", type);
5223 for (uint i = 0; i < 3; i++) {
5227 for (uint i = 0; i < 2; i++) {
5230 group->again = buf->ReadByte();
5231 }
else if (type == 1) {
5233 for (uint i = 0; i < 3; i++) {
5237 for (uint i = 0; i < 2; i++) {
5240 group->again = buf->ReadByte();
5241 }
else if (type == 2) {
5245 error->
data =
stredup(
"too many inputs (max 16)");
5248 for (uint i = 0; i < group->
num_input; i++) {
5249 byte rawcargo = buf->ReadByte();
5267 error->
data =
stredup(
"too many outputs (max 16)");
5270 for (uint i = 0; i < group->
num_output; i++) {
5271 byte rawcargo = buf->ReadByte();
5284 group->again = buf->ReadByte();
5292 default:
grfmsg(1,
"NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5297 _cur.spritegroups[setid] = act_group;
5300 static CargoID TranslateCargo(uint8 feature, uint8 ctype)
5302 if (feature == GSF_OBJECTS) {
5307 grfmsg(1,
"TranslateCargo: Invalid cargo bitnum %d for objects, skipping.", ctype);
5312 if (feature == GSF_STATIONS && ctype == 0xFE)
return CT_DEFAULT_NA;
5313 if (ctype == 0xFF)
return CT_PURCHASE;
5318 grfmsg(1,
"TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype);
5323 FOR_ALL_CARGOSPECS(cs) {
5324 if (cs->
bitnum == ctype) {
5325 grfmsg(6,
"TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, cs->
Index());
5330 grfmsg(5,
"TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype);
5336 grfmsg(1,
"TranslateCargo: Cargo type %d out of range (max %d), skipping.", ctype, (
unsigned int)_cur.
grffile->
cargo_list.size() - 1);
5343 grfmsg(5,
"TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype);
5349 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));
5353 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);
5358 static bool IsValidGroupID(uint16 groupid,
const char *
function)
5360 if (groupid >
MAX_SPRITEGROUP || _cur.spritegroups[groupid] ==
nullptr) {
5361 grfmsg(1,
"%s: Spritegroup 0x%04X out of range or empty, skipping.",
function, groupid);
5368 static void VehicleMapSpriteGroup(
ByteReader *buf, byte feature, uint8 idcount)
5371 static uint last_engines_count;
5372 bool wagover =
false;
5375 if (
HasBit(idcount, 7)) {
5378 idcount =
GB(idcount, 0, 7);
5380 if (last_engines_count == 0) {
5381 grfmsg(0,
"VehicleMapSpriteGroup: WagonOverride: No engine to do override with");
5385 grfmsg(6,
"VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons",
5386 last_engines_count, idcount);
5388 if (last_engines_count != idcount) {
5389 last_engines =
ReallocT(last_engines, idcount);
5390 last_engines_count = idcount;
5395 for (uint i = 0; i < idcount; i++) {
5401 HandleChangeInfoResult(
"VehicleMapSpriteGroup",
CIR_INVALID_ID, 0, 0);
5405 engines[i] = e->
index;
5406 if (!wagover) last_engines[i] = engines[i];
5409 uint8 cidcount = buf->ReadByte();
5410 for (uint c = 0; c < cidcount; c++) {
5411 uint8 ctype = buf->ReadByte();
5412 uint16 groupid = buf->ReadWord();
5413 if (!IsValidGroupID(groupid,
"VehicleMapSpriteGroup"))
continue;
5415 grfmsg(8,
"VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid);
5417 ctype = TranslateCargo(feature, ctype);
5420 for (uint i = 0; i < idcount; i++) {
5423 grfmsg(7,
"VehicleMapSpriteGroup: [%d] Engine %d...", i, engine);
5426 SetWagonOverrideSprites(engine, ctype, _cur.spritegroups[groupid], last_engines, last_engines_count);
5428 SetCustomEngineSprites(engine, ctype, _cur.spritegroups[groupid]);
5433 uint16 groupid = buf->ReadWord();
5434 if (!IsValidGroupID(groupid,
"VehicleMapSpriteGroup"))
return;
5436 grfmsg(8,
"-- Default group id 0x%04X", groupid);
5438 for (uint i = 0; i < idcount; i++) {
5442 SetWagonOverrideSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid], last_engines, last_engines_count);
5444 SetCustomEngineSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid]);
5451 static void CanalMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5454 for (uint i = 0; i < idcount; i++) {
5458 uint8 cidcount = buf->ReadByte();
5459 buf->Skip(cidcount * 3);
5461 uint16 groupid = buf->ReadWord();
5462 if (!IsValidGroupID(groupid,
"CanalMapSpriteGroup"))
return;
5464 for (uint i = 0; i < idcount; i++) {
5468 grfmsg(1,
"CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf);
5478 static void StationMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5480 uint8 *stations =
AllocaM(uint8, idcount);
5481 for (uint i = 0; i < idcount; i++) {
5482 stations[i] = buf->ReadByte();
5485 uint8 cidcount = buf->ReadByte();
5486 for (uint c = 0; c < cidcount; c++) {
5487 uint8 ctype = buf->ReadByte();
5488 uint16 groupid = buf->ReadWord();
5489 if (!IsValidGroupID(groupid,
"StationMapSpriteGroup"))
continue;
5491 ctype = TranslateCargo(GSF_STATIONS, ctype);
5494 for (uint i = 0; i < idcount; i++) {
5497 if (statspec ==
nullptr) {
5498 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5506 uint16 groupid = buf->ReadWord();
5507 if (!IsValidGroupID(groupid,
"StationMapSpriteGroup"))
return;
5509 for (uint i = 0; i < idcount; i++) {
5512 if (statspec ==
nullptr) {
5513 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5518 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X mapped multiple times, skipping", stations[i]);
5525 StationClass::Assign(statspec);
5530 static void TownHouseMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5532 uint8 *houses =
AllocaM(uint8, idcount);
5533 for (uint i = 0; i < idcount; i++) {
5534 houses[i] = buf->ReadByte();
5538 uint8 cidcount = buf->ReadByte();
5539 buf->Skip(cidcount * 3);
5541 uint16 groupid = buf->ReadWord();
5542 if (!IsValidGroupID(groupid,
"TownHouseMapSpriteGroup"))
return;
5544 if (_cur.
grffile->housespec ==
nullptr) {
5545 grfmsg(1,
"TownHouseMapSpriteGroup: No houses defined, skipping");
5549 for (uint i = 0; i < idcount; i++) {
5552 if (hs ==
nullptr) {
5553 grfmsg(1,
"TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]);
5561 static void IndustryMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5563 uint8 *industries =
AllocaM(uint8, idcount);
5564 for (uint i = 0; i < idcount; i++) {
5565 industries[i] = buf->ReadByte();
5569 uint8 cidcount = buf->ReadByte();
5570 buf->Skip(cidcount * 3);
5572 uint16 groupid = buf->ReadWord();
5573 if (!IsValidGroupID(groupid,
"IndustryMapSpriteGroup"))
return;
5575 if (_cur.
grffile->industryspec ==
nullptr) {
5576 grfmsg(1,
"IndustryMapSpriteGroup: No industries defined, skipping");
5580 for (uint i = 0; i < idcount; i++) {
5583 if (indsp ==
nullptr) {
5584 grfmsg(1,
"IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]);
5592 static void IndustrytileMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5594 uint8 *indtiles =
AllocaM(uint8, idcount);
5595 for (uint i = 0; i < idcount; i++) {
5596 indtiles[i] = buf->ReadByte();
5600 uint8 cidcount = buf->ReadByte();
5601 buf->Skip(cidcount * 3);
5603 uint16 groupid = buf->ReadWord();
5604 if (!IsValidGroupID(groupid,
"IndustrytileMapSpriteGroup"))
return;
5606 if (_cur.
grffile->indtspec ==
nullptr) {
5607 grfmsg(1,
"IndustrytileMapSpriteGroup: No industry tiles defined, skipping");
5611 for (uint i = 0; i < idcount; i++) {
5614 if (indtsp ==
nullptr) {
5615 grfmsg(1,
"IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]);
5623 static void CargoMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5626 for (uint i = 0; i < idcount; i++) {
5627 cargoes[i] = buf->ReadByte();
5631 uint8 cidcount = buf->ReadByte();
5632 buf->Skip(cidcount * 3);
5634 uint16 groupid = buf->ReadWord();
5635 if (!IsValidGroupID(groupid,
"CargoMapSpriteGroup"))
return;
5637 for (uint i = 0; i < idcount; i++) {
5641 grfmsg(1,
"CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid);
5647 cs->group = _cur.spritegroups[groupid];
5651 static void ObjectMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5653 if (_cur.
grffile->objectspec ==
nullptr) {
5654 grfmsg(1,
"ObjectMapSpriteGroup: No object tiles defined, skipping");
5658 uint8 *objects =
AllocaM(uint8, idcount);
5659 for (uint i = 0; i < idcount; i++) {
5660 objects[i] = buf->ReadByte();
5663 uint8 cidcount = buf->ReadByte();
5664 for (uint c = 0; c < cidcount; c++) {
5665 uint8 ctype = buf->ReadByte();
5666 uint16 groupid = buf->ReadWord();
5667 if (!IsValidGroupID(groupid,
"ObjectMapSpriteGroup"))
continue;
5669 ctype = TranslateCargo(GSF_OBJECTS, ctype);
5672 for (uint i = 0; i < idcount; i++) {
5675 if (spec ==
nullptr) {
5676 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5684 uint16 groupid = buf->ReadWord();
5685 if (!IsValidGroupID(groupid,
"ObjectMapSpriteGroup"))
return;
5687 for (uint i = 0; i < idcount; i++) {
5690 if (spec ==
nullptr) {
5691 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5696 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X mapped multiple times, skipping", objects[i]);
5706 static void RailTypeMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5708 uint8 *railtypes =
AllocaM(uint8, idcount);
5709 for (uint i = 0; i < idcount; i++) {
5710 uint8
id = buf->ReadByte();
5714 uint8 cidcount = buf->ReadByte();
5715 for (uint c = 0; c < cidcount; c++) {
5716 uint8 ctype = buf->ReadByte();
5717 uint16 groupid = buf->ReadWord();
5718 if (!IsValidGroupID(groupid,
"RailTypeMapSpriteGroup"))
continue;
5720 if (ctype >= RTSG_END)
continue;
5723 for (uint i = 0; i < idcount; i++) {
5728 rti->
group[ctype] = _cur.spritegroups[groupid];
5737 static void RoadTypeMapSpriteGroup(
ByteReader *buf, uint8 idcount, RoadTramType rtt)
5741 uint8 *roadtypes =
AllocaM(uint8, idcount);
5742 for (uint i = 0; i < idcount; i++) {
5743 uint8
id = buf->ReadByte();
5747 uint8 cidcount = buf->ReadByte();
5748 for (uint c = 0; c < cidcount; c++) {
5749 uint8 ctype = buf->ReadByte();
5750 uint16 groupid = buf->ReadWord();
5751 if (!IsValidGroupID(groupid,
"RoadTypeMapSpriteGroup"))
continue;
5753 if (ctype >= ROTSG_END)
continue;
5756 for (uint i = 0; i < idcount; i++) {
5761 rti->
group[ctype] = _cur.spritegroups[groupid];
5770 static void AirportMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5772 uint8 *airports =
AllocaM(uint8, idcount);
5773 for (uint i = 0; i < idcount; i++) {
5774 airports[i] = buf->ReadByte();
5778 uint8 cidcount = buf->ReadByte();
5779 buf->Skip(cidcount * 3);
5781 uint16 groupid = buf->ReadWord();
5782 if (!IsValidGroupID(groupid,
"AirportMapSpriteGroup"))
return;
5784 if (_cur.
grffile->airportspec ==
nullptr) {
5785 grfmsg(1,
"AirportMapSpriteGroup: No airports defined, skipping");
5789 for (uint i = 0; i < idcount; i++) {
5792 if (as ==
nullptr) {
5793 grfmsg(1,
"AirportMapSpriteGroup: Airport %d undefined, skipping", airports[i]);
5801 static void AirportTileMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5803 uint8 *airptiles =
AllocaM(uint8, idcount);
5804 for (uint i = 0; i < idcount; i++) {
5805 airptiles[i] = buf->ReadByte();
5809 uint8 cidcount = buf->ReadByte();
5810 buf->Skip(cidcount * 3);
5812 uint16 groupid = buf->ReadWord();
5813 if (!IsValidGroupID(groupid,
"AirportTileMapSpriteGroup"))
return;
5815 if (_cur.
grffile->airtspec ==
nullptr) {
5816 grfmsg(1,
"AirportTileMapSpriteGroup: No airport tiles defined, skipping");
5820 for (uint i = 0; i < idcount; i++) {
5823 if (airtsp ==
nullptr) {
5824 grfmsg(1,
"AirportTileMapSpriteGroup: Airport tile %d undefined, skipping", airptiles[i]);
5834 static void FeatureMapSpriteGroup(
ByteReader *buf)
5850 uint8 feature = buf->ReadByte();
5851 uint8 idcount = buf->ReadByte();
5853 if (feature >= GSF_END) {
5854 grfmsg(1,
"FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5862 uint16 groupid = buf->ReadWord();
5863 if (!IsValidGroupID(groupid,
"FeatureMapSpriteGroup"))
return;
5865 grfmsg(6,
"FeatureMapSpriteGroup: Adding generic feature callback for feature 0x%02X", feature);
5874 grfmsg(6,
"FeatureMapSpriteGroup: Feature 0x%02X, %d ids", feature, idcount);
5878 case GSF_ROADVEHICLES:
5881 VehicleMapSpriteGroup(buf, feature, idcount);
5885 CanalMapSpriteGroup(buf, idcount);
5889 StationMapSpriteGroup(buf, idcount);
5893 TownHouseMapSpriteGroup(buf, idcount);
5896 case GSF_INDUSTRIES:
5897 IndustryMapSpriteGroup(buf, idcount);
5900 case GSF_INDUSTRYTILES:
5901 IndustrytileMapSpriteGroup(buf, idcount);
5905 CargoMapSpriteGroup(buf, idcount);
5909 AirportMapSpriteGroup(buf, idcount);
5913 ObjectMapSpriteGroup(buf, idcount);
5917 RailTypeMapSpriteGroup(buf, idcount);
5921 RoadTypeMapSpriteGroup(buf, idcount, RTT_ROAD);
5925 RoadTypeMapSpriteGroup(buf, idcount, RTT_TRAM);
5928 case GSF_AIRPORTTILES:
5929 AirportTileMapSpriteGroup(buf, idcount);
5933 grfmsg(1,
"FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5957 bool new_scheme = _cur.
grffile->grf_version >= 7;
5959 uint8 feature = buf->ReadByte();
5960 if (feature >= GSF_END && feature != 0x48) {
5961 grfmsg(1,
"FeatureNewName: Unsupported feature 0x%02X, skipping", feature);
5965 uint8 lang = buf->ReadByte();
5966 uint8 num = buf->ReadByte();
5967 bool generic =
HasBit(lang, 7);
5970 id = buf->ReadWord();
5971 }
else if (feature <= GSF_AIRCRAFT) {
5972 id = buf->ReadExtendedByte();
5974 id = buf->ReadByte();
5979 uint16 endid =
id + num;
5981 grfmsg(6,
"FeatureNewName: About to rename engines %d..%d (feature 0x%02X) in language 0x%02X",
5982 id, endid, feature, lang);
5984 for (;
id < endid && buf->HasData();
id++) {
5985 const char *name = buf->ReadString();
5986 grfmsg(8,
"FeatureNewName: 0x%04X <- %s",
id, name);
5990 case GSF_ROADVEHICLES:
5995 if (e ==
nullptr)
break;
6009 switch (
GB(
id, 8, 8)) {
6011 if (_cur.
grffile->stations ==
nullptr || _cur.
grffile->stations[
GB(
id, 0, 8)] ==
nullptr) {
6012 grfmsg(1,
"FeatureNewName: Attempt to name undefined station 0x%X, ignoring",
GB(
id, 0, 8));
6020 if (_cur.
grffile->stations ==
nullptr || _cur.
grffile->stations[
GB(
id, 0, 8)] ==
nullptr) {
6021 grfmsg(1,
"FeatureNewName: Attempt to name undefined station 0x%X, ignoring",
GB(
id, 0, 8));
6028 if (_cur.
grffile->airtspec ==
nullptr || _cur.
grffile->airtspec[
GB(
id, 0, 8)] ==
nullptr) {
6029 grfmsg(1,
"FeatureNewName: Attempt to name undefined airport tile 0x%X, ignoring",
GB(
id, 0, 8));
6036 if (_cur.
grffile->housespec ==
nullptr || _cur.
grffile->housespec[
GB(
id, 0, 8)] ==
nullptr) {
6037 grfmsg(1,
"FeatureNewName: Attempt to name undefined house 0x%X, ignoring.",
GB(
id, 0, 8));
6044 grfmsg(7,
"FeatureNewName: Unsupported ID (0x%04X)",
id);
6063 if (offset >= max_sprites) {
6064 grfmsg(1,
"GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites);
6065 uint orig_num = num;
6070 if (offset + num > max_sprites) {
6071 grfmsg(4,
"GraphicsNew: %s sprite overflow, truncating...", name);
6072 uint orig_num = num;
6073 num =
max(max_sprites - offset, 0);
6074 return orig_num - num;
6103 {
A5BLOCK_ALLOW_OFFSET, SPR_SIGNALS_BASE, 1, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT,
"Signal graphics" },
6105 {
A5BLOCK_ALLOW_OFFSET, SPR_SLOPES_BASE, 1, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT,
"Foundation graphics" },
6135 uint8 type = buf->ReadByte();
6136 uint16 num = buf->ReadExtendedByte();
6137 uint16 offset =
HasBit(type, 7) ? buf->ReadExtendedByte() : 0;
6143 grfmsg(2,
"GraphicsNew: Loading 10 missing shore sprites from extra grf.");
6160 grfmsg(2,
"GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num);
6165 const Action5Type *action5_type = &_action5_types[type];
6171 grfmsg(1,
"GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->
name, type);
6178 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);
6188 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);
6199 for (; num > 0; num--) {
6270 *value = (major << 24) | (minor << 20) | (revision << 16) | build;
6300 *value = _game_mode;
6334 *value =
Clamp(snowline * (grffile->grf_version >= 8 ? 1 :
TILE_HEIGHT), 0, 0xFE);
6343 *value = _openttd_newgrf_version;
6358 default:
return false;
6362 static uint32 GetParamVal(byte param, uint32 *cond_val)
6380 if (cond_val ==
nullptr) {
6384 uint32 index = *cond_val / 0x20;
6400 grfmsg(1,
"Unsupported in-game variable 0x%02X", param);
6423 byte *preload_sprite =
nullptr;
6427 preload_sprite = MallocT<byte>(num);
6435 grfmsg(2,
"CfgApply: Ignoring (next sprite is real, unsupported)");
6436 free(preload_sprite);
6441 GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
6442 if (it != _grf_line_to_action6_sprite_override.end()) {
6443 free(preload_sprite);
6444 preload_sprite = _grf_line_to_action6_sprite_override[location];
6446 _grf_line_to_action6_sprite_override[location] = preload_sprite;
6459 param_num = buf->ReadByte();
6460 if (param_num == 0xFF)
break;
6464 param_size = buf->ReadByte();
6468 add_value =
HasBit(param_size, 7);
6469 param_size =
GB(param_size, 0, 7);
6472 offset = buf->ReadExtendedByte();
6476 if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur.
grffile->
param_end) {
6477 grfmsg(2,
"CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4));
6481 grfmsg(8,
"CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset);
6484 for (i = 0; i < param_size && offset + i < num; i++) {
6485 uint32 value = GetParamVal(param_num + i / 4,
nullptr);
6488 if (i % 4 == 0) carry =
false;
6491 uint new_value = preload_sprite[offset + i] +
GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0);
6492 preload_sprite[offset + i] =
GB(new_value, 0, 8);
6494 carry = new_value >= 256;
6496 preload_sprite[offset + i] =
GB(value, (i % 4) * 8, 8);
6528 uint32 cond_val = 0;
6532 uint8 param = buf->ReadByte();
6533 uint8 paramsize = buf->ReadByte();
6534 uint8 condtype = buf->ReadByte();
6541 switch (paramsize) {
6542 case 8: cond_val = buf->ReadDWord(); mask = buf->ReadDWord();
break;
6543 case 4: cond_val = buf->ReadDWord(); mask = 0xFFFFFFFF;
break;
6544 case 2: cond_val = buf->ReadWord(); mask = 0x0000FFFF;
break;
6545 case 1: cond_val = buf->ReadByte(); mask = 0x000000FF;
break;
6549 if (param < 0x80 && _cur.grffile->param_end <= param) {
6550 grfmsg(7,
"SkipIf: Param %d undefined, skipping test", param);
6554 uint32 param_val = GetParamVal(param, &cond_val);
6556 grfmsg(7,
"SkipIf: Test condtype %d, param 0x%08X, condval 0x%08X", condtype, param_val, cond_val);
6566 if (param == 0x88 && (condtype < 0x0B || condtype > 0x0E)) {
6576 if (condtype != 10 && c ==
nullptr) {
6577 grfmsg(7,
"SkipIf: GRFID 0x%08X unknown, skipping test",
BSWAP32(cond_val));
6604 default:
grfmsg(1,
"SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype);
return;
6609 case 0x00: result = !!(param_val & (1 << cond_val));
6611 case 0x01: result = !(param_val & (1 << cond_val));
6613 case 0x02: result = (param_val & mask) == cond_val;
6615 case 0x03: result = (param_val & mask) != cond_val;
6617 case 0x04: result = (param_val & mask) < cond_val;
6619 case 0x05: result = (param_val & mask) > cond_val;
6638 default:
grfmsg(1,
"SkipIf: Unsupported condition type %02X. Ignoring", condtype);
return;
6643 grfmsg(2,
"SkipIf: Not skipping sprites, test was false");
6647 uint8 numsprites = buf->ReadByte();
6655 if (label->label != numsprites)
continue;
6658 if (choice ==
nullptr) choice = label;
6660 if (label->nfo_line > _cur.
nfo_line) {
6666 if (choice !=
nullptr) {
6667 grfmsg(2,
"SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line);
6673 grfmsg(2,
"SkipIf: Skipping %d sprites, test was true", numsprites);
6692 uint8 grf_version = buf->ReadByte();
6693 uint32 grfid = buf->ReadDWord();
6694 const char *name = buf->ReadString();
6698 if (grf_version < 2 || grf_version > 8) {
6700 DEBUG(grf, 0,
"%s: NewGRF \"%s\" (GRFID %08X) uses GRF version %d, which is incompatible with this version of OpenTTD.", _cur.
grfconfig->
filename, name,
BSWAP32(grfid), grf_version);
6708 if (buf->HasData()) {
6709 const char *info = buf->ReadString();
6727 uint8 version = buf->ReadByte();
6728 uint32 grfid = buf->ReadDWord();
6729 const char *name = buf->ReadString();
6732 DisableGrf(STR_NEWGRF_ERROR_MULTIPLE_ACTION_8);
6736 if (_cur.
grffile->grfid != grfid) {
6737 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));
6741 _cur.
grffile->grf_version = version;
6759 uint8 num_sets = buf->ReadByte();
6761 for (uint i = 0; i < num_sets; i++) {
6763 uint16 first_sprite = buf->ReadWord();
6765 grfmsg(2,
"SpriteReplace: [Set %d] Changing %d sprites, beginning with %d",
6766 i, num_sprites, first_sprite
6770 int load_index = first_sprite + j;
6776 if (
IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) {
6786 uint8 num_sets = buf->ReadByte();
6788 for (uint i = 0; i < num_sets; i++) {
6817 STR_NEWGRF_ERROR_VERSION_NUMBER,
6818 STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
6819 STR_NEWGRF_ERROR_UNSET_SWITCH,
6820 STR_NEWGRF_ERROR_INVALID_PARAMETER,
6821 STR_NEWGRF_ERROR_LOAD_BEFORE,
6822 STR_NEWGRF_ERROR_LOAD_AFTER,
6823 STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
6827 STR_NEWGRF_ERROR_MSG_INFO,
6828 STR_NEWGRF_ERROR_MSG_WARNING,
6829 STR_NEWGRF_ERROR_MSG_ERROR,
6830 STR_NEWGRF_ERROR_MSG_FATAL
6833 byte severity = buf->ReadByte();
6834 byte lang = buf->ReadByte();
6835 byte message_id = buf->ReadByte();
6838 if (!CheckGrfLangID(lang, _cur.
grffile->grf_version))
return;
6842 if (!
HasBit(severity, 7) && _cur.
stage == GLS_INIT) {
6843 grfmsg(7,
"GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur.
stage);
6848 if (severity >=
lengthof(sevstr)) {
6849 grfmsg(7,
"GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity);
6851 }
else if (severity == 3) {
6861 if (message_id >=
lengthof(msgstr) && message_id != 0xFF) {
6862 grfmsg(7,
"GRFLoadError: Invalid message id.");
6866 if (buf->Remaining() <= 1) {
6867 grfmsg(7,
"GRFLoadError: No message data supplied.");
6876 if (message_id == 0xFF) {
6878 if (buf->HasData()) {
6879 const char *message = buf->ReadString();
6883 grfmsg(7,
"GRFLoadError: No custom message supplied.");
6887 error->
message = msgstr[message_id];
6890 if (buf->HasData()) {
6891 const char *data = buf->ReadString();
6895 grfmsg(7,
"GRFLoadError: No message data supplied.");
6901 uint param_number = buf->ReadByte();
6915 if (!buf->HasData())
return;
6917 const char *text = buf->ReadString();
6918 grfmsg(2,
"GRFComment: %s", text);
6924 uint8 target = buf->ReadByte();
6927 if (target < 0x80 || target == 0x9E)
return;
6941 static uint32 GetPatchVariable(uint8 param)
6951 case 0x0F:
return 0;
6967 case 0x11:
return SPR_2CCMAP_BASE;
6984 byte max_edge =
max(log_X, log_Y);
6986 if (log_X == log_Y) {
6989 if (max_edge == log_Y)
SetBit(map_bits, 1);
6992 return (map_bits << 24) | (
min(log_X, log_Y) << 20) | (max_edge << 16) |
6993 (log_X << 12) | (log_Y << 8) | (log_X + log_Y);
7002 return SPR_SLOPES_BASE;
7009 grfmsg(2,
"ParamSet: Unknown Patch variable 0x%02X.", param);
7015 static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target,
const char *type)
7028 for (uint i = start; i < num_ids; i++) {
7032 if (op == 2 || op == 3)
break;
7037 if (size == count)
break;
7040 if (size == count) {
7042 if (op == 0 || op == 3) {
7043 grfmsg(2,
"ParamSet: GRM: Reserving %d %s at %d", count, type, start);
7044 for (uint i = 0; i < count; i++) grm[start + i] = _cur.
grffile->grfid;
7050 if (op != 4 && op != 5) {
7052 grfmsg(0,
"ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type);
7057 grfmsg(1,
"ParamSet: GRM: Unable to allocate %d %s", count, type);
7087 uint8 target = buf->ReadByte();
7088 uint8 oper = buf->ReadByte();
7089 uint32 src1 = buf->ReadByte();
7090 uint32 src2 = buf->ReadByte();
7093 if (buf->Remaining() >= 4) data = buf->ReadDWord();
7102 if (target < 0x80 && target < _cur.grffile->param_end) {
7103 grfmsg(7,
"ParamSet: Param %u already defined, skipping", target);
7107 oper =
GB(oper, 0, 7);
7111 if (
GB(data, 0, 8) == 0xFF) {
7112 if (data == 0x0000FFFF) {
7114 src1 = GetPatchVariable(src1);
7118 uint8 feature =
GB(data, 8, 8);
7119 uint16 count =
GB(data, 16, 16);
7121 if (_cur.
stage == GLS_RESERVE) {
7122 if (feature == 0x08) {
7126 if (_cur.
spriteid + count >= 16384) {
7127 grfmsg(0,
"ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count);
7133 grfmsg(4,
"ParamSet: GRM: Allocated %d sprites at %d", count, _cur.
spriteid);
7140 }
else if (_cur.
stage == GLS_ACTIVATION) {
7169 grfmsg(4,
"ParamSet: GRM: Using pre-allocated sprites at %d", src1);
7177 grfmsg(1,
"ParamSet: GRM: Unsupported operation %d for general sprites", op);
7188 default:
grfmsg(1,
"ParamSet: GRM: Unsupported feature 0x%X", feature);
return;
7205 }
else if (src1 == 0xFE) {
7217 src1 = (src1 == 0xFF) ? data : GetParamVal(src1,
nullptr);
7218 src2 = (src2 == 0xFF) ? data : GetParamVal(src2,
nullptr);
7240 res = (int32)src1 * (int32)src2;
7244 if ((int32)src2 < 0) {
7245 res = src1 >> -(int32)src2;
7247 res = src1 << (src2 & 0x1F);
7252 if ((int32)src2 < 0) {
7253 res = (int32)src1 >> -(int32)src2;
7255 res = (int32)src1 << (src2 & 0x1F);
7279 res = (int32)src1 / (int32)src2;
7295 res = (int32)src1 % (int32)src2;
7299 default:
grfmsg(0,
"ParamSet: Unknown operation %d, skipping", oper);
return;
7328 grfmsg(7,
"ParamSet: Skipping unimplemented target 0x%02X", target);
7339 uint32 safe_bits = 0;
7340 SetBit(safe_bits, GMB_SECOND_ROCKY_TILE_SET);
7349 grfmsg(7,
"ParamSet: Skipping unimplemented target 0x%02X", target);
7353 if (target < 0x80) {
7354 _cur.
grffile->param[target] = res;
7358 grfmsg(7,
"ParamSet: Skipping unknown target 0x%02X", target);
7372 uint8 num = buf->ReadByte();
7374 for (uint i = 0; i < num; i++) {
7375 uint32 grfid = buf->ReadDWord();
7397 uint8 num = buf->ReadByte();
7399 for (uint i = 0; i < num; i++) {
7400 uint32 grfid = buf->ReadDWord();
7404 if (file !=
nullptr && file != _cur.
grfconfig) {
7422 uint32 grfid = _cur.
grffile->grfid;
7426 byte
id = buf->ReadByte();
7427 grfmsg(6,
"FeatureTownName: definition 0x%02X",
id & 0x7F);
7432 bool new_scheme = _cur.
grffile->grf_version >= 7;
7434 byte lang = buf->ReadByte();
7436 byte nb_gen = townname->nb_gen;
7440 const char *name = buf->ReadString();
7443 grfmsg(6,
"FeatureTownName: lang 0x%X -> '%s'", lang, lang_name);
7446 townname->name[nb_gen] =
AddGRFString(grfid,
id, lang, new_scheme,
false, name, STR_UNDEFINED);
7448 lang = buf->ReadByte();
7449 }
while (lang != 0);
7450 townname->id[nb_gen] = id;
7454 byte nb = buf->ReadByte();
7455 grfmsg(6,
"FeatureTownName: %u parts", nb);
7457 townname->nbparts[id] = nb;
7458 townname->partlist[id] = CallocT<NamePartList>(nb);
7460 for (
int i = 0; i < nb; i++) {
7461 byte nbtext = buf->ReadByte();
7462 townname->partlist[id][i].bitstart = buf->ReadByte();
7463 townname->partlist[id][i].bitcount = buf->ReadByte();
7464 townname->partlist[id][i].maxprob = 0;
7465 townname->partlist[id][i].partcount = nbtext;
7466 townname->partlist[id][i].parts = CallocT<NamePart>(nbtext);
7467 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);
7469 for (
int j = 0; j < nbtext; j++) {
7470 byte prob = buf->ReadByte();
7473 byte ref_id = buf->ReadByte();
7475 if (townname->nbparts[ref_id] == 0) {
7476 grfmsg(0,
"FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id);
7477 DelGRFTownName(grfid);
7482 grfmsg(6,
"FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F);
7483 townname->partlist[id][i].parts[j].data.
id = ref_id;
7485 const char *text = buf->ReadString();
7487 grfmsg(6,
"FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[
id][i].parts[j].data.
text, prob);
7489 townname->partlist[id][i].parts[j].
prob = prob;
7490 townname->partlist[id][i].maxprob +=
GB(prob, 0, 7);
7492 grfmsg(6,
"FeatureTownName: part %d, total probability %d", i, townname->partlist[
id][i].maxprob);
7504 byte nfo_label = buf->ReadByte();
7506 GRFLabel *label = MallocT<GRFLabel>(1);
7507 label->label = nfo_label;
7510 label->next =
nullptr;
7518 for (l = _cur.
grffile->
label; l->next !=
nullptr; l = l->next) {}
7522 grfmsg(2,
"DefineGotoLabel: GOTO target with label 0x%02X", label->label);
7536 if (file ==
nullptr || file->sound_offset == 0) {
7537 grfmsg(1,
"ImportGRFSound: Source file not available");
7541 if (sound_id >= file->num_sounds) {
7542 grfmsg(1,
"ImportGRFSound: Sound effect %d is invalid", sound_id);
7546 grfmsg(2,
"ImportGRFSound: Copying sound %d (%d) from file %X", sound_id, file->sound_offset + sound_id, grfid);
7548 *sound = *GetSound(file->sound_offset + sound_id);
7551 sound->volume = 128;
7552 sound->priority = 0;
7563 sound->volume = 0x80;
7564 sound->priority = 0;
7566 if (offs != SIZE_MAX) {
7569 sound->file_offset = offs;
7581 uint16 num = buf->ReadWord();
7582 if (num == 0)
return;
7585 if (_cur.
grffile->sound_offset == 0) {
7586 _cur.
grffile->sound_offset = GetNumSounds();
7587 _cur.
grffile->num_sounds = num;
7590 sound = GetSound(_cur.
grffile->sound_offset);
7593 for (
int i = 0; i < num; i++) {
7598 bool invalid = i >= _cur.
grffile->num_sounds;
7608 grfmsg(1,
"GRFSound: Sound index out of range (multiple Action 11?)");
7610 }
else if (len != 4) {
7611 grfmsg(1,
"GRFSound: Invalid sprite section import");
7621 grfmsg(1,
"GRFSound: Unexpected RealSprite found, skipping");
7628 grfmsg(1,
"GRFSound: Sound index out of range (multiple Action 11?)");
7636 if (_cur.
stage == GLS_INIT) {
7638 grfmsg(1,
"GRFSound: Inline sounds are not supported for container version >= 2");
7647 if (_cur.
stage == GLS_ACTIVATION) {
7658 grfmsg(1,
"GRFSound: Unexpected Action %x found, skipping", action);
7687 uint8 num_def = buf->ReadByte();
7689 for (uint i = 0; i < num_def; i++) {
7691 uint8 num_char = buf->ReadByte();
7692 uint16 base_char = buf->ReadWord();
7694 if (size >= FS_END) {
7695 grfmsg(1,
"LoadFontGlyph: Size %u is not supported, ignoring", size);
7698 grfmsg(7,
"LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size);
7700 for (uint c = 0; c < num_char; c++) {
7718 uint8 num_def = buf->ReadByte();
7720 for (uint i = 0; i < num_def; i++) {
7744 uint32 grfid = buf->ReadDWord();
7747 grfmsg(7,
"TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13",
BSWAP32(grfid));
7757 GetString(tmp, STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE,
lastof(tmp));
7768 byte language = _cur.
grffile->grf_version >= 8 ? buf->ReadByte() : 0x7F;
7769 byte num_strings = buf->ReadByte();
7770 uint16 first_id = buf->ReadWord();
7772 if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD400) || (first_id >= 0xD800 && first_id + num_strings <= 0xE000))) {
7773 grfmsg(7,
"TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings);
7777 for (uint i = 0; i < num_strings && buf->HasData(); i++) {
7778 const char *
string = buf->ReadString();
7781 grfmsg(7,
"TranslateGRFString: Ignoring empty string.");
7785 AddGRFString(grfid, first_id + i, language,
true,
true,
string, STR_UNDEFINED);
7814 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'NPAR' but got " PRINTF_SIZE
", ignoring this field", len);
7826 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'PALS' but got " PRINTF_SIZE
", ignoring this field", len);
7829 char data = buf->ReadByte();
7837 grfmsg(2,
"StaticGRFInfo: unexpected value '%02x' for 'INFO'->'PALS', ignoring this field", data);
7852 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'BLTR' but got " PRINTF_SIZE
", ignoring this field", len);
7855 char data = buf->ReadByte();
7861 grfmsg(2,
"StaticGRFInfo: unexpected value '%02x' for 'INFO'->'BLTR', ignoring this field", data);
7874 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'VRSN' but got " PRINTF_SIZE
", ignoring this field", len);
7887 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'MINV' but got " PRINTF_SIZE
", ignoring this field", len);
7892 grfmsg(2,
"StaticGRFInfo: 'MINV' defined before 'VRSN' or 'VRSN' set to 0, ignoring this field");
7923 grfmsg(2,
"StaticGRFInfo: expected 1 byte for 'INFO'->'PARA'->'TYPE' but got " PRINTF_SIZE
", ignoring this field", len);
7928 _cur_parameter->
type = type;
7930 grfmsg(3,
"StaticGRFInfo: unknown parameter type %d, ignoring this field", type);
7940 grfmsg(2,
"StaticGRFInfo: 'INFO'->'PARA'->'LIMI' is only valid for parameters with type uint/enum, ignoring this field");
7942 }
else if (len != 8) {
7943 grfmsg(2,
"StaticGRFInfo: expected 8 bytes for 'INFO'->'PARA'->'LIMI' but got " PRINTF_SIZE
", ignoring this field", len);
7946 _cur_parameter->
min_value = buf->ReadDWord();
7947 _cur_parameter->
max_value = buf->ReadDWord();
7955 if (len < 1 || len > 3) {
7956 grfmsg(2,
"StaticGRFInfo: expected 1 to 3 bytes for 'INFO'->'PARA'->'MASK' but got " PRINTF_SIZE
", ignoring this field", len);
7959 byte param_nr = buf->ReadByte();
7961 grfmsg(2,
"StaticGRFInfo: invalid parameter number in 'INFO'->'PARA'->'MASK', param %d, ignoring this field", param_nr);
7964 _cur_parameter->
param_nr = param_nr;
7965 if (len >= 2) _cur_parameter->
first_bit =
min(buf->ReadByte(), 31);
7966 if (len >= 3) _cur_parameter->
num_bit =
min(buf->ReadByte(), 32 - _cur_parameter->
first_bit);
7977 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'PARA'->'DEFA' but got " PRINTF_SIZE
", ignoring this field", len);
7980 _cur_parameter->
def_value = buf->ReadDWord();
8013 this->handler.data = handler;
8025 this->handler.text = handler;
8037 this->handler.call_handler =
true;
8038 this->handler.u.branch = handler;
8050 this->handler.call_handler =
false;
8051 this->handler.u.subtags = subtags;
8080 byte type = buf->ReadByte();
8082 uint32
id = buf->ReadDWord();
8083 if (type !=
'T' ||
id > _cur_parameter->
max_value) {
8084 grfmsg(2,
"StaticGRFInfo: all child nodes of 'INFO'->'PARA'->param_num->'VALU' should have type 't' and the value/bit number as id");
8086 type = buf->ReadByte();
8090 byte langid = buf->ReadByte();
8091 const char *name_string = buf->ReadString();
8094 if (val_name != _cur_parameter->
value_names.End()) {
8102 type = buf->ReadByte();
8127 byte type = buf->ReadByte();
8129 uint32
id = buf->ReadDWord();
8131 grfmsg(2,
"StaticGRFInfo: all child nodes of 'INFO'->'PARA' should have type 'C' and their parameter number as id");
8133 type = buf->ReadByte();
8145 if (!
HandleNodes(buf, _tags_parameters))
return false;
8146 type = buf->ReadByte();
8183 byte new_type = buf->ReadByte();
8184 while (new_type != 0) {
8187 new_type = buf->ReadByte();
8198 uint16 size = buf->ReadWord();
8222 while ((tag = &subtags[i++])->type != 0) {
8225 default: NOT_REACHED();
8228 byte langid = buf->ReadByte();
8229 return tag->handler.
text(langid, buf->ReadString());
8233 size_t len = buf->ReadWord();
8234 if (buf->Remaining() < len)
return false;
8235 return tag->handler.
data(len, buf);
8240 return tag->handler.u.branch(buf);
8246 grfmsg(2,
"StaticGRFInfo: unknown type/id combination found, type=%c, id=%x", type,
id);
8258 byte type = buf->ReadByte();
8260 uint32
id = buf->ReadDWord();
8261 if (!
HandleNode(type,
id, buf, subtags))
return false;
8262 type = buf->ReadByte();
8383 if (stations ==
nullptr)
continue;
8385 if (stations[i] ==
nullptr)
continue;
8391 if (!statspec->copied_layouts) {
8392 for (uint l = 0; l < statspec->lengths; l++) {
8393 for (uint p = 0; p < statspec->platforms[l]; p++) {
8394 free(statspec->layouts[l][p]);
8396 free(statspec->layouts[l]);
8398 free(statspec->layouts);
8399 free(statspec->platforms);
8416 HouseSpec **&housespec = file->housespec;
8417 if (housespec ==
nullptr)
continue;
8423 housespec =
nullptr;
8432 if (aslist !=
nullptr) {
8436 if (as !=
nullptr) {
8438 for (
int j = 0; j < as->
num_table; j++) {
8450 file->airportspec =
nullptr;
8454 if (airporttilespec !=
nullptr) {
8456 free(airporttilespec[i]);
8458 free(airporttilespec);
8459 airporttilespec =
nullptr;
8473 if (industryspec !=
nullptr) {
8480 industryspec =
nullptr;
8483 if (indtspec ==
nullptr)
continue;
8498 if (objectspec ==
nullptr)
continue;
8500 free(objectspec[i]);
8504 objectspec =
nullptr;
8536 CleanUpGRFTownNames();
8581 ObjectClass::Reset();
8586 StationClass::Reset();
8590 AirportClass::Reset();
8613 _loaded_newgrf_features.
has_2CC =
false;
8621 _grf_id_overrides.clear();
8623 InitializeSoundPool();
8671 if (newfile !=
nullptr) {
8677 newfile =
new GRFFile(config);
8691 this->traininfo_vehicle_pitch = 0;
8692 this->traininfo_vehicle_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
8695 for (
Price i = PR_BEGIN; i < PR_END; i++) {
8696 this->price_base_multipliers[i] = INVALID_PRICE_MODIFIER;
8720 if (this->param_end > 0) {
8727 free(this->filename);
8728 delete[] this->language_map;
8737 'PASS',
'COAL',
'MAIL',
'LVST',
'GOOD',
'GRAI',
'WHEA',
'MAIZ',
'WOOD',
8738 'IORE',
'STEL',
'VALU',
'GOLD',
'DIAM',
'PAPR',
'FOOD',
'FRUT',
'CORE',
8739 'WATR',
'SUGR',
'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
8743 static const CargoLabel _default_refitmasks_road[] = {
8746 static const CargoLabel _default_refitmasks_ships[] = {
8747 'COAL',
'MAIL',
'LVST',
'GOOD',
'GRAI',
'WHEA',
'MAIZ',
'WOOD',
'IORE',
8748 'STEL',
'VALU',
'GOLD',
'DIAM',
'PAPR',
'FOOD',
'FRUT',
'CORE',
'WATR',
8749 'RUBR',
'SUGR',
'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
8753 static const CargoLabel _default_refitmasks_aircraft[] = {
8754 'PASS',
'MAIL',
'GOOD',
'VALU',
'GOLD',
'DIAM',
'FOOD',
'FRUT',
'SUGR',
8755 'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
'PLST',
'FZDR',
8758 static const CargoLabel *
const _default_refitmasks[] = {
8760 _default_refitmasks_road,
8761 _default_refitmasks_ships,
8762 _default_refitmasks_aircraft,
8773 FOR_ALL_ENGINES(e) {
8776 bool only_defaultcargo;
8780 CargoTypes mask = 0;
8781 CargoTypes not_mask = 0;
8782 CargoTypes xor_mask = ei->refit_mask;
8788 if (_gted[engine].cargo_allowed != 0) {
8791 FOR_ALL_CARGOSPECS(cs) {
8797 ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) &
_cargo_mask;
8803 CargoTypes xor_mask = 0;
8808 for (uint i = 0;; i++) {
8809 if (cl[i] == 0)
break;
8821 only_defaultcargo = (ei->refit_mask == 0);
8835 if (ei->cargo_type ==
CT_INVALID && ei->refit_mask != 0) {
8837 const uint8 *cargo_map_for_first_refittable =
nullptr;
8840 if (file ==
nullptr) file = e->
GetGRF();
8841 if (file !=
nullptr && file->grf_version >= 8 && file->
cargo_list.size() != 0) {
8842 cargo_map_for_first_refittable = file->
cargo_map;
8846 if (cargo_map_for_first_refittable !=
nullptr) {
8848 byte best_local_slot = 0xFF;
8850 FOR_EACH_SET_CARGO_ID(cargo_type, ei->refit_mask) {
8851 byte local_slot = cargo_map_for_first_refittable[cargo_type];
8852 if (local_slot < best_local_slot) {
8853 best_local_slot = local_slot;
8854 ei->cargo_type = cargo_type;
8876 for (uint i = 0; i < CF_END; i++) {
8889 FOR_ALL_ENGINES(e) {
8890 if (e->
GetGRF() ==
nullptr) {
8893 e->info.
string_id = STR_NEWGRF_INVALID_ENGINE;
8928 default: NOT_REACHED();
8942 cs->
quantifier = STR_NEWGRF_INVALID_CARGO_QUANTITY;
8943 cs->
abbrev = STR_NEWGRF_INVALID_CARGO_ABBREV;
8967 if (filename !=
nullptr)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines house %d as multitile, but no suitable tiles follow. Disabling house.", filename, hs->
grf_prop.
local_id);
8977 if (filename !=
nullptr)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines multitile house %d with non-zero population on additional tiles. Disabling house.", filename, hs->
grf_prop.
local_id);
8985 DEBUG(grf, 1,
"FinaliseHouseArray: %s defines house %d with different house size then it's substitute type. Disabling house.", filename, hs->
grf_prop.
local_id);
8992 if (filename !=
nullptr)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines house %d without a size but marked it as available. Disabling house.", filename, hs->
grf_prop.
local_id);
9011 if (hs ==
nullptr || !hs->
enabled)
continue;
9016 if (min_year == 0)
return;
9020 if (hs ==
nullptr || !hs->
enabled)
continue;
9044 HouseSpec **&housespec = file->housespec;
9045 if (housespec ==
nullptr)
continue;
9050 if (hs ==
nullptr)
continue;
9052 const HouseSpec *next1 = (i + 1 < NUM_HOUSES_PER_GRF ? housespec[i + 1] :
nullptr);
9053 const HouseSpec *next2 = (i + 2 < NUM_HOUSES_PER_GRF ? housespec[i + 2] :
nullptr);
9054 const HouseSpec *next3 = (i + 3 < NUM_HOUSES_PER_GRF ? housespec[i + 3] :
nullptr);
9064 const HouseSpec *next1 = (i + 1 < NUM_HOUSES ? HouseSpec::Get(i + 1) :
nullptr);
9065 const HouseSpec *next2 = (i + 2 < NUM_HOUSES ? HouseSpec::Get(i + 2) :
nullptr);
9066 const HouseSpec *next3 = (i + 3 < NUM_HOUSES ? HouseSpec::Get(i + 3) :
nullptr);
9108 if (industryspec !=
nullptr) {
9112 if (indsp !=
nullptr && indsp->
enabled) {
9118 if (strid != STR_UNDEFINED) indsp->
name = strid;
9121 if (strid != STR_UNDEFINED) indsp->
closure_text = strid;
9136 if (strid != STR_UNDEFINED) indsp->
station_name = strid;
9145 if (indtspec !=
nullptr) {
9148 if (indtsp !=
nullptr) {
9149 _industile_mngr.SetEntitySpec(indtsp);
9158 for (uint i = 0; i < 3; i++) {
9163 indsp->
name = STR_NEWGRF_INVALID_INDUSTRYTYPE;
9177 if (objectspec !=
nullptr) {
9179 if (objectspec[i] !=
nullptr && objectspec[i]->grf_prop.grffile !=
nullptr && objectspec[i]->
enabled) {
9196 if (airportspec !=
nullptr) {
9198 if (airportspec[i] !=
nullptr && airportspec[i]->enabled) {
9199 _airport_mngr.SetEntitySpec(airportspec[i]);
9205 if (airporttilespec !=
nullptr) {
9207 if (airporttilespec[i] !=
nullptr && airporttilespec[i]->enabled) {
9208 _airporttile_mngr.SetEntitySpec(airporttilespec[i]);
9221 static void DecodeSpecialSprite(byte *buf, uint num, GrfLoadingStage
stage)
9235 static const SpecialSpriteHandler handlers[][GLS_END] = {
9236 {
nullptr, SafeChangeInfo,
nullptr,
nullptr, ReserveChangeInfo, FeatureChangeInfo, },
9237 { SkipAct1, SkipAct1, SkipAct1, SkipAct1, SkipAct1, NewSpriteSet, },
9238 {
nullptr,
nullptr,
nullptr,
nullptr,
nullptr, NewSpriteGroup, },
9239 {
nullptr,
GRFUnsafe,
nullptr,
nullptr,
nullptr, FeatureMapSpriteGroup, },
9240 {
nullptr,
nullptr,
nullptr,
nullptr,
nullptr, FeatureNewName, },
9241 { SkipAct5, SkipAct5, SkipAct5, SkipAct5, SkipAct5, GraphicsNew, },
9242 {
nullptr,
nullptr,
nullptr, CfgApply, CfgApply, CfgApply, },
9243 {
nullptr,
nullptr,
nullptr,
nullptr, SkipIf, SkipIf, },
9244 { ScanInfo,
nullptr,
nullptr, GRFInfo, GRFInfo, GRFInfo, },
9245 {
nullptr,
nullptr,
nullptr, SkipIf, SkipIf, SkipIf, },
9246 { SkipActA, SkipActA, SkipActA, SkipActA, SkipActA, SpriteReplace, },
9247 {
nullptr,
nullptr,
nullptr, GRFLoadError, GRFLoadError, GRFLoadError, },
9248 {
nullptr,
nullptr,
nullptr, GRFComment,
nullptr, GRFComment, },
9250 {
nullptr, SafeGRFInhibit,
nullptr, GRFInhibit, GRFInhibit, GRFInhibit, },
9253 { SkipAct11,
GRFUnsafe, SkipAct11, GRFSound, SkipAct11, GRFSound, },
9256 {
StaticGRFInfo,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr, },
9261 GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
9262 if (it == _grf_line_to_action6_sprite_override.end()) {
9268 buf = _grf_line_to_action6_sprite_override[location];
9269 grfmsg(7,
"DecodeSpecialSprite: Using preloaded pseudo sprite data");
9279 byte action = bufp->ReadByte();
9281 if (action == 0xFF) {
9282 grfmsg(2,
"DecodeSpecialSprite: Unexpected data block, skipping");
9283 }
else if (action == 0xFE) {
9284 grfmsg(2,
"DecodeSpecialSprite: Unexpected import block, skipping");
9285 }
else if (action >=
lengthof(handlers)) {
9286 grfmsg(7,
"DecodeSpecialSprite: Skipping unknown action 0x%02X", action);
9287 }
else if (handlers[action][stage] ==
nullptr) {
9288 grfmsg(7,
"DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage);
9290 grfmsg(7,
"DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage);
9291 handlers[action][
stage](bufp);
9294 grfmsg(1,
"DecodeSpecialSprite: Tried to read past end of pseudo-sprite data");
9301 extern const byte
_grf_cont_v2_sig[8] = {
'G',
'R',
'F', 0x82, 0x0D, 0x0A, 0x1A, 0x0A};
9335 const char *filename = config->
filename;
9346 if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) {
9348 if (_cur.
grffile ==
nullptr)
usererror(
"File '%s' lost in cache.\n", filename);
9354 DEBUG(grf, 0,
"'%s' is not loaded as the maximum number of file slots has been reached", filename);
9356 config->
error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9366 DEBUG(grf, 2,
"LoadNewGRFFile: Reading NewGRF-file '%s'", filename);
9370 DEBUG(grf, 7,
"LoadNewGRFFile: Custom .grf has invalid format");
9374 if (stage == GLS_INIT || stage == GLS_ACTIVATION) {
9386 if (compression != 0) {
9387 DEBUG(grf, 7,
"LoadNewGRFFile: Unsupported compression format");
9399 DEBUG(grf, 7,
"LoadNewGRFFile: Custom .grf has invalid format");
9424 grfmsg(0,
"LoadNewGRFFile: Unexpected sprite, disabling");
9425 DisableGrf(STR_NEWGRF_ERROR_UNEXPECTED_SPRITE);
9489 DupSprite(SPR_ROAD_DEPOT + 0, SPR_TRAMWAY_DEPOT_NO_TRACK + 0);
9490 DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 1, SPR_TRAMWAY_DEPOT_NO_TRACK + 1);
9491 DupSprite(SPR_ROAD_DEPOT + 2, SPR_TRAMWAY_DEPOT_NO_TRACK + 2);
9492 DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 3, SPR_TRAMWAY_DEPOT_NO_TRACK + 3);
9493 DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 4, SPR_TRAMWAY_DEPOT_NO_TRACK + 4);
9494 DupSprite(SPR_TRAMWAY_DEPOT_WITH_TRACK + 5, SPR_TRAMWAY_DEPOT_NO_TRACK + 5);
9505 static const uint32 override_features = (1 << GSF_TRAINS) | (1 << GSF_ROADVEHICLES) | (1 << GSF_SHIPS) | (1 << GSF_AIRCRAFT);
9509 int *grf_overrides =
AllocaM(
int, num_grfs);
9510 for (
int i = 0; i < num_grfs; i++) {
9511 grf_overrides[i] = -1;
9514 uint32
override = _grf_id_overrides[source->grfid];
9515 if (
override == 0)
continue;
9518 if (dest ==
nullptr)
continue;
9521 assert(grf_overrides[i] >= 0);
9525 for (
int i = 0; i < num_grfs; i++) {
9526 if (grf_overrides[i] < 0 || grf_overrides[i] >= i)
continue;
9534 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9537 DEBUG(grf, 3,
"'%s' overrides price base multiplier %d of '%s'", source->filename, p, dest->filename);
9543 for (
int i = num_grfs - 1; i >= 0; i--) {
9544 if (grf_overrides[i] < 0 || grf_overrides[i] <= i)
continue;
9552 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9555 DEBUG(grf, 3,
"Price base multiplier %d from '%s' propagated to '%s'", p, source->filename, dest->filename);
9561 for (
int i = 0; i < num_grfs; i++) {
9562 if (grf_overrides[i] < 0)
continue;
9570 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9571 if (!
HasBit(features, _price_base_specs[p].grf_feature))
continue;
9573 DEBUG(grf, 3,
"Price base multiplier %d from '%s' propagated to '%s'", p, dest->filename, source->filename);
9581 if (file->grf_version >= 8)
continue;
9582 PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9583 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9585 if (fallback_price != INVALID_PRICE && price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9588 price_base_multipliers[p] = price_base_multipliers[fallback_price];
9594 for (
GRFFile *
const file : _grf_files) {
9595 PriceMultipliers &price_base_multipliers = file->price_base_multipliers;
9596 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9597 if (price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9599 price_base_multipliers[p] = 0;
9604 DEBUG(grf, 3,
"'%s' sets global price base multiplier %d", file->filename, p);
9606 price_base_multipliers[p] = 0;
9608 DEBUG(grf, 3,
"'%s' sets local price base multiplier %d", file->filename, p);
9623 _string_to_grf_mapping.clear();
9626 for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) {
9629 _grf_line_to_action6_sprite_override.clear();
9684 FOR_ALL_ENGINES_OF_TYPE(e,
VEH_ROAD) {
9693 if (file ==
nullptr || _gted[e->
index].roadtramtype == 0) {
9699 _gted[e->
index].roadtramtype--;
9701 const std::vector<RoadTypeLabel> *list = (rtt == RTT_TRAM) ? &file->tramtype_list : &file->
roadtype_list;
9702 if (_gted[e->
index].roadtramtype < list->size())
9704 RoadTypeLabel rtl = (*list)[_gted[e->
index].roadtramtype];
9722 e->u.rail.railtype = railtype;
9732 _grm_sprites.clear();
9781 for (GrfLoadingStage
stage = GLS_LABELSCAN;
stage <= GLS_ACTIVATION;
stage++) {
9788 if (
stage == GLS_RESERVE) {
9789 static const uint32 overrides[][2] = {
9790 { 0x44442202, 0x44440111 },
9791 { 0x6D620402, 0x6D620401 },
9792 { 0x4D656f20, 0x4D656F17 },
9794 for (
size_t i = 0; i <
lengthof(overrides); i++) {
9800 uint num_non_static = 0;
9809 DEBUG(grf, 0,
"NewGRF file is missing '%s'; disabling", c->filename);
9818 DEBUG(grf, 0,
"'%s' is not loaded as the maximum number of non-static GRFs has been reached", c->filename);
9820 c->error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9826 if (
stage == GLS_RESERVE) {
9828 }
else if (
stage == GLS_ACTIVATION) {
CargoID accepts_cargo[INDUSTRY_NUM_INPUTS]
16 accepted cargoes.
void ResetBridges()
Reset the data been eventually changed by the grf loaded.
bool disable_elrails
when true, the elrails are disabled
bool enabled
the house is available to build (true by default, but can be disabled by newgrf)
const struct GRFFile * grffile
NewGRF where #group belongs to.
Information about a ship vehicle.
Functions related to OTTD's strings.
std::vector< RoadTypeLabel > roadtype_list
Roadtype translation table (road)
RoadType GetRoadTypeByLabel(RoadTypeLabel label, bool allow_alternate_labels)
Get the road type for a given label.
VehicleSettings vehicle
options for vehicles
static void FinaliseEngineArray()
Check for invalid engines.
TTDPAirportType ttd_airport_type
ttdpatch airport type (Small/Large/Helipad/Oilrig)
void ResetRoadTypes()
Reset all road type information to its default values.
uint32 PaletteID
The number of the palette.
void ClearDataForNextFile()
Clear temporary data before processing the next file in the current loading stage.
Class to read from a NewGRF file.
static ChangeInfoResult IgnoreIndustryTileProperty(int prop, ByteReader *buf)
Ignore an industry tile property.
static const SpriteID SPR_SHORE_BASE
shore tiles - action 05-0D
const SpriteGroup * group[RTSG_END]
Sprite groups for resolving sprites.
uint8 max_heightlevel
maximum allowed heightlevel
RailTypeFlags
Railtype flags.
byte probability
Relative probability of appearing (16 is the standard value)
GameSettings _settings_game
Game settings of a running game or the scenario editor.
GRF was disabled due to error.
SmallMap< uint32, struct GRFText * > value_names
Names for each value.
const SpriteGroup ** groups
Take the group with appropriate index:
bool _networking
are we in networking mode?
std::vector< Mapping > case_map
Mapping of NewGRF and OpenTTD IDs for cases.
static const uint NUM_STATIONS_PER_GRF
Number of StationSpecs per NewGRF; limited to 255 to allow extending Action3 with an extended byte la...
void SetEntitySpec(ObjectSpec *spec)
Method to install the new object data in its proper slot The slot assignment is internal of this meth...
CargoID cargo_output[INDUSTRY_NUM_OUTPUTS]
Which output cargoes to add to (only cb version 2)
Functions for NewGRF engines.
bool enabled
entity still available (by default true).newgrf can disable it, though
ObjectFlags
Various object behaviours.
Object wants 2CC colour mapping.
void SortIndustryTypes()
Initialize the list of sorted industry types.
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Year avail_year
the year where it becomes available
static void ResetCustomObjects()
Reset and clear all NewObjects.
const GRFFile * grffile[RTSG_END]
NewGRF providing the Action3 for the railtype.
ObjectFlags flags
Flags/settings related to the object.
static void FinaliseIndustriesArray()
Add all new industries to the industry array.
struct LanguageMap * language_map
Mappings related to the languages.
Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta.child[1].
int16 subtract_input[INDUSTRY_NUM_INPUTS]
Take this much of the input cargo (can be negative, is indirect in cb version 1+) ...
static void AfterLoadGRFs()
Finish loading NewGRFs and execute needed post-processing.
static const SpriteID SPR_TRACKS_FOR_SLOPES_BASE
Sprites for 'highlighting' tracks on sloped land.
uint32 param_value[2]
Values of GRF parameters to show for message and custom_message.
uint8 weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
CargoTypes _cargo_mask
Bitmask of cargo types available.
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.
Electrified depot graphics without tram track were loaded.
void AlterVehicleListOrder(EngineID engine, uint target)
Record a vehicle ListOrderChange.
static void ResetCustomAirports()
Reset and clear all NewGRF airports.
LiveryScheme
List of different livery schemes.
The parameter allows a range of numbers, each of which can have a special name.
GRFConfig * _grfconfig
First item in list of current GRF set up.
byte landscape
the landscape we're currently in
void ResetCurrencies(bool preserve_custom)
Will fill _currency_specs array with default values from origin_currency_specs Called only from newgr...
byte size_y
size of airport in y direction
Subdirectory
The different kinds of subdirectories OpenTTD uses.
RoadType tramtype_map[ROADTYPE_END]
, Roadtype translation table (tram)
byte map_colour
colour used for the small map
static void ResetNewGRF()
Reset and clear all NewGRFs.
int plural_form
The plural form used for this language.
static AirportSpec * GetWithoutOverride(byte type)
Retrieve airport spec for the given airport.
uint16 triggers
The triggers that trigger animation.
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
GRF file is processed up to GLS_INIT.
uint32 grfid
The GRF ID of the file the entity belongs to.
byte newgrf_id
NewGRF's internal ID for a case/gender.
Action5BlockType block_type
How is this Action5 type processed?
byte _display_opt
What do we want to draw/do?
CargoTypes watched_cargoes
Cargo types watched for acceptance.
EconomySettings economy
settings to change the economy
byte map_colour
Colour on mini-map.
uint8 build_cost_multiplier
Build cost multiplier per tile.
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
uint32 nfo_line
Currently processed pseudo sprite number in the GRF.
#define DAYS_TILL_ORIGINAL_BASE_YEAR
The offset in days from the '_date == 0' till 'ConvertYMDToDate(ORIGINAL_BASE_YEAR, 0, 1)'.
void Allocate(uint num_sprites)
Allocate a spritelayout for num_sprites building sprites.
TileLayoutFlags
Flags to enable register usage in sprite layouts.
byte curve_speed
Multiplier for curve maximum speed advantage.
uint16 max_sprites
If the Action5 contains more sprites, only the first max_sprites sprites will be used.
static void FinaliseObjectsArray()
Add all new objects to the object array.
Max. speed: 1 unit = 1/1.6 mph = 1 km-ish/h.
static Titem * Get(size_t index)
Returns Titem with given index.
const GRFFile * grffile
NewGRF where 'group' belongs to.
static const SpriteID SPR_ONEWAY_BASE
One way road sprites.
byte ocean_speed_frac
Fraction of maximum speed for ocean tiles.
Functions related to dates.
Power in hp (if dualheaded: sum of both vehicles)
CargoID GetCargoIDByLabel(CargoLabel cl)
Get the cargo ID by cargo label.
static ChangeInfoResult LoadTranslationTable(uint gvid, int numinfo, ByteReader *buf, T &translation_table, const char *name)
Load a cargo- or railtype-translation table.
static const Year ORIGINAL_MAX_YEAR
The maximum year of the original TTD.
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Functions for NewGRF industries.
Functions to handle different currencies.
const uint8 _engine_offsets[4]
Offset of the first engine of each vehicle type in original engine data.
SpriteID sprite
SpriteID of the first sprite of the set.
GRFParameterType type
The type of this parameter.
void UpdateRefittability(bool non_empty)
Update the summary refittability on setting a refittability property.
RailTypes introduction_required_railtypes
Bitmask of railtypes that are required for this railtype to be introduced at a given introduction_dat...
static uint MapLogX()
Logarithm of the map size along the X side.
uint32 prospecting_chance
Chance prospecting succeeds.
PalSpriteID ** sprite_table
table of sprites for drawing the bridge
static ChangeInfoResult ShipVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for ships.
RailTypeFlags flags
Bit mask of rail type flags.
const byte _grf_cont_v2_sig[8]
Signature of a container version 2 GRF.
static bool ChangeGRFParamMask(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'MASK' to set the parameter and bits to use...
static ChangeInfoResult IgnoreObjectProperty(uint prop, ByteReader *buf)
Ignore properties for objects.
Free the dynamically allocated sounds table.
Functions related to debugging.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
uint32 grfid
Source NewGRF.
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.
GRFConfig * grfconfig
Config of the currently processed GRF file.
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.
char * text
If probability bit 7 is clear.
static const IndustryGfx INVALID_INDUSTRYTILE
one above amount is considered invalid
RoadTypeFlags flags
Bit mask of road type flags.
Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta.parent[0..1].
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
Translate a GRF-local cargo slot/bitnum into a CargoID.
static void ImportGRFSound(SoundEntry *sound)
Process a sound import from another GRF file.
static void FinaliseCanals()
Set to use the correct action0 properties for each canal feature.
GRFPalette
Information that can/has to be stored about a GRF's palette.
byte flags
bit 0 set: disable drawing of far pillars.
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
char * TranslateTTDPatchCodes(uint32 grfid, uint8 language_id, bool allow_newlines, const char *str, int *olen, StringControlCode byte80)
Translate TTDPatch string codes into something OpenTTD can handle (better).
uint16 FioReadWord()
Read a word (16 bits) from the file (in low endian format).
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...
GRFFilePropsBase< NUM_CARGO+2 > grf_prop
Properties related the the grf file.
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Maximal number of cargo types in a game.
Rail vehicle can be flipped in the depot.
The NewGRF prefers a 32 bpp blitter.
static std::vector< GRFFile * > _grf_files
List of all loaded GRF files.
byte cargo_acceptance[HOUSE_NUM_ACCEPTS]
acceptance level for the cargo slots
GRFFile(const struct GRFConfig *config)
Constructor for GRFFile.
static const uint ORIGINAL_SAMPLE_COUNT
The number of sounds in the original sample.cat.
Flag for invalid railtype.
RoadType AllocateRoadType(RoadTypeLabel label, RoadTramType rtt)
Allocate a new road type label.
GRF file has been initialised.
Specification of a cargo type.
std::vector< Pair >::const_iterator Find(const T &key) const
Finds given key in this map.
VehicleType
Available vehicle types.
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...
CanalFeature
List of different canal 'features'.
static void GRFUnsafe(ByteReader *buf)
Set the current NewGRF as unsafe for static use.
void SetSnowLine(byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS])
Set a variable snow line, as loaded from a newgrf file.
uint32 def_value
Default value of this parameter.
Yearly runningcost (if dualheaded: sum of both vehicles)
IndustryLifeType life_type
This is also known as Industry production flag, in newgrf specs.
byte visual_effect
Bitstuffed NewGRF visual effect data.
int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap)
Safer implementation of vsnprintf; same as vsnprintf except:
bool IsSnowLineSet()
Has a snow line table already been loaded.
GRFStatus status
NOSAVE: GRFStatus, enum.
uint16 max_palette_offset
Maximum offset to add to the palette. (limited by size of the spriteset)
Functions related to vehicles.
struct GRFText * text
The actual text.
Resolve sprite with a specific value in variable 10.
static void BuildCargoTranslationMap()
Construct the Cargo Mapping.
const HangarTileTable * depot_table
gives the position of the depots on the airports
CargoID accepts_cargo[HOUSE_NUM_ACCEPTS]
input cargo slots
static const uint INVALID_AIRPORTTILE
id for an invalid airport tile
Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite...
uint16 callback_mask
Bitmask of industry callbacks that have to be called.
Allow replacing any subset by specifiing an offset.
uint32 grf_features
Bitset of GrfSpecFeature the grf uses.
StringID new_engine
Name of an engine for this type of road in the engine preview GUI.
Price
Enumeration of all base prices for use with Prices.
Combination of a palette sprite and a 'real' sprite.
No profile, special "custom" highscore.
byte removal_cost
cost multiplier for removing it
bool HasValidSpriteSets(byte feature) const
Check whether there are any valid spritesets for a feature.
uint32 removal_cost_multiplier
Base removal cost multiplier.
Purchase cost (if dualheaded: sum of both vehicles)
GRF file is used statically (can be used in any MP game)
Header of Action 0F "universal holder" structure and functions.
bool never_expire_airports
never expire airports
uint8 flags
Flags controlling display.
uint GetNumEnts(byte feature, uint set) const
Returns the number of sprites in a spriteset.
AllowedSubtags _tags_info[]
Action14 tags for the INFO node.
uint8 num_valid_params
NOSAVE: Number of valid parameters (action 0x14)
char * custom_message
Custom message (if present)
Add signed offset to palette from register TileLayoutRegisters::palette.
Flags which do not work for the (first) ground sprite.
RailTypeLabelList alternate_labels
Rail type labels this type provides in addition to the main label.
std::vector< Mapping > gender_map
Mapping of NewGRF and OpenTTD IDs for genders.
Tindex index
Index of this pool item.
static void FinaliseCargoArray()
Check for invalid cargoes.
int8 acceptance[INDUSTRY_NUM_INPUTS]
Level of acceptance per cargo type (signed, may be negative!)
flag for invalid roadtype
EngineID GetID(VehicleType type, uint16 grf_local_id, uint32 grfid)
Looks up an EngineID in the EngineOverrideManager.
EngineClass
Type of rail engine.
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.net/tiki-index.php?page=BaseCosts.
void CommitVehicleListOrderChanges()
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder.
void ResetPersistentNewGRFData()
Reset NewGRF data which is stored persistently in savegames.
StringID name_single
Name of a single entity of this type of cargo.
GRFError * error
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
static const uint SNOW_LINE_MONTHS
Number of months in the snow line table.
uint16 speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Add signed offset to sprite from register TileLayoutRegisters::sprite.
RoadTypeFlags
Roadtype flags.
Allow incrementing of ObjectClassID variables.
Functions for Standard In/Out file operations.
Date end_of_life_date
When can't this object be built anymore.
static void ActivateOldShore()
Relocates the old shore sprites at new positions.
A list of all hangar tiles in an airport.
size_t Utf8Decode(WChar *c, const char *s)
Decode and consume the next UTF-8 encoded character.
The NewGRF provided no information.
static const CargoID CT_PURCHASE_OBJECT
Mapping of purchase for objects.
byte param_nr
GRF parameter to store content in.
StringID build_caption
Caption of the build vehicle GUI for this rail type.
Cargo behaves water-like.
StringID abbrev
Two letter abbreviation for this cargo type.
uint16 input_cargo_multiplier[INDUSTRY_NUM_INPUTS][INDUSTRY_NUM_OUTPUTS]
Input cargo multipliers (multiply amount of incoming cargo for the produced cargoes) ...
#define lastof(x)
Get the last element of an fixed size array.
static bool ChangeGRFParamName(byte langid, const char *str)
Callback function for 'INFO'->'PARAM'->param_num->'NAME' to set the name of a parameter.
static const SpriteID SPR_AQUEDUCT_BASE
Sprites for the Aqueduct.
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
ChangeInfoResult
Possible return values for the FeatureChangeInfo functions.
GRF file was not found in the local cache.
Functions related to world/map generation.
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel ...
No properties assigned. Default refit masks shall be activated.
Number of ticks before carried cargo is aged.
Cargo behaves goods/candy-like.
StringID quantifier
Text for multiple units of cargo of this type.
static uint MapLogY()
Logarithm of the map size along the y side.
Relative position (vehicles only)
static ChangeInfoResult RailTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for railtypes.
Date introduction_date
From when can this object be built.
void AllocateRegisters()
Allocate memory for register modifiers.
uint8 flags
Flags controlling display.
byte num_loaded
Number of loaded groups.
LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
Determines the LiveryScheme for a vehicle.
#define FOR_EACH_SET_BIT(bitpos_var, bitset_value)
Do an operation for each set set bit in a value.
#define AllocaM(T, num_elements)
alloca() has to be called in the parent function, so define AllocaM() as a macro
TramReplacement tram
In which way tram depots were replaced.
Tractive effort coefficient in 1/256.
Refittability refittability
Did the newgrf set any refittability property? If not, default refittability will be applied...
GRFIdentifier ident
grfid and md5sum to uniquely identify newgrfs
static ChangeInfoResult AirportChangeInfo(uint airport, int numinfo, int prop, ByteReader *buf)
Define properties for airports.
void LoadNewGRF(uint load_index, uint file_index, uint num_baseset)
Load all the NewGRFs.
byte pow_wag_weight
Extra weight applied to consist if wagon should be powered.
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
uint16 callback_mask
Bitmask of house callbacks that have to be called.
RoadType
The different roadtypes we support.
StringID source
Source StringID (GRF local).
Subdirectory for all base data (base sets, intro game)
static uint16 SanitizeSpriteOffset(uint16 &num, uint16 offset, int max_sprites, const char *name)
Sanitize incoming sprite offsets for Action 5 graphics replacements.
static T max(const T a, const T b)
Returns the maximum of two values.
uint16 classes
Classes of this cargo type.
static bool ChangeGRFPalette(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PALS' to set the number of valid parameters.
bool allow_town_roads
towns are allowed to build roads (always allowed when generating world / in SE)
static bool ChangeGRFDescription(byte langid, const char *str)
Callback function for 'INFO'->'DESC' to add a translation to the newgrf description.
byte FioReadByte()
Read a byte from the file.
std::vector< IndustryTileLayout > layouts
List of possible tile layouts for the industry.
GRFLabel * label
Pointer to the first label. This is a linked list, not an array.
uint8 status
Status; 0: no looping, 1: looping, 0xFF: no animation.
bool never_expire_vehicles
never expire vehicles
Year _cur_year
Current year, starting at 0.
Struct containing information about a single bridge type.
uint32 GetParam(uint number) const
Get GRF Parameter with range checking.
struct RailtypeInfo::@39 strings
Strings associated with the rail type.
uint tiles
Number of tile layouts.
bool improved_load
improved loading algorithm
static void DefineGotoLabel(ByteReader *buf)
Action 0x10 - Define goto label.
const SpriteGroup * group[ROTSG_END]
Sprite groups for resolving sprites.
Year min_year
first year the airport is available
static void LoadGRFSound(size_t offs, SoundEntry *sound)
Load a sound from a file.
Date base_intro
Basic date of engine introduction (without random parts).
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...
GRFParameterType
The possible types of a newgrf parameter.
byte nof_depots
the number of hangar tiles in this airport
Tables with default industry layouts and behaviours.
StringID menu_text
Name of this rail type in the main toolbar dropdown.
StationSettings station
settings related to station management
void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group)
Add a generic feature callback sprite group to the appropriate feature list.
StringID production_down_text
Message appearing when the industry's production is decreasing.
StringID new_loco
Name of an engine for this type of rail in the engine preview GUI.
struct GRFConfig * next
NOSAVE: Next item in the linked list.
static const ObjectType NUM_OBJECTS_PER_GRF
Number of supported objects per NewGRF; limited to 255 to allow extending Action3 with an extended by...
StringID name
Name of this type of cargo.
uint16 maintenance_cost
maintenance cost multiplier
Year lifelength
Lifetime of a single vehicle.
static const HouseID NUM_HOUSES
Total number of houses.
void InitGRFTownGeneratorNames()
Allocate memory for the NewGRF town names.
Definition of a single Action1 spriteset.
byte grf_container_ver
NewGRF container version if the sound is from a NewGRF.
StringID name
Displayed name of the industry.
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.
uint num_sprites
Number of sprites in the set.
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
const AirportTileTable *const * table
list of the tiles composing the airport
uint16 max_speed
Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
No shore sprites were replaced.
byte lowest_randbit
Look for this in the per-object randomized bitmask:
Temporary data during loading of GRFs.
BridgeSpec _bridge[MAX_BRIDGES]
The specification of all bridges.
CargoTypes cargo_triggers
Bitmask of cargo types which cause trigger re-randomizing.
size_t GetGRFSpriteOffset(uint32 id)
Get the file offset for a specific sprite in the sprite section of a GRF.
IndustryTileSpecialFlags special_flags
Bitmask of extra flags used by the tile.
SpriteID sprite_base
Load the sprites starting from this sprite.
StringID build_caption
Caption of the build vehicle GUI for this rail type.
This struct contains all the info that is needed to draw and construct tracks.
const LanguageMetadata * GetLanguage(byte newgrflangid)
Get the language with the given NewGRF language ID.
NewGRF handling of airports.
static void FinaliseAirportsArray()
Add all new airports to the airport array.
HouseZones building_availability
where can it be built (climates, zones)
static const LanguageMap * GetLanguageMap(uint32 grfid, uint8 language_id)
Get the language map associated with a given NewGRF and language.
IndustryLifeType
Available types of industry lifetimes.
GRFFile * grffile
Currently processed GRF file.
RoadType roadtype
Road type.
byte population
population (Zero on other tiles in multi tile house.)
uint8 size
The size of this objects; low nibble for X, high nibble for Y.
Functions related to NewGRF objects.
void ResetIndustries()
This function initialize the spec arrays of both industry and industry tiles.
uint16 multiplier
Capacity multiplier for vehicles. (8 fractional bits)
PriceMultipliers price_base_multipliers
Price base multipliers as set by the grf.
StringID replace_text
Text used in the autoreplace GUI.
int16 y
The y value of the coordinate.
static const HouseID NUM_HOUSES_PER_GRF
Number of supported houses per NewGRF; limited to 255 to allow extending Action3 with an extended byt...
uint8 cleanup_flag
flags indicating which data should be freed upon cleaning up
virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const
Return the ID (if ever available) of a previously inserted entity.
byte grf_container_ver
Container format of the current GRF file.
Slope slopes_refused
slope pattern on which this tile cannot be built
static ChangeInfoResult CommonVehicleChangeInfo(EngineInfo *ei, int prop, ByteReader *buf)
Define properties common to all vehicles.
Functions to read fonts from files and cache them.
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
const uint8 * random_sounds
array of random sounds.
StringID * target
Destination for mapping result.
static ChangeInfoResult AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for aircraft.
Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
void SetPriceBaseMultiplier(Price price, int factor)
Change a price base by the given factor.
byte symbol_pos
The currency symbol is represented by two possible values, prefix and suffix Usage of one or the othe...
uint16 add_output[INDUSTRY_NUM_OUTPUTS]
Add this much output cargo when successful (unsigned, is indirect in cb version 1+) ...
struct GRFText * desc
The description of this parameter.
Mapping between NewGRF and OpenTTD IDs.
byte catchment
catchment area of this airport
Header of Action 04 "universal holder" structure and functions.
uint8 height
The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
GrfLoadingStage stage
Current loading stage.
void ResetObjects()
This function initialize the spec arrays of objects.
void ReadGRFSpriteOffsets(byte container_version)
Parse the sprite section of GRFs.
User defined data for vehicle variable 0x42.
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...
StringID name
Name of this rail type.
byte noise_level
noise that this airport generates
Struct containing information relating to NewGRF classes for stations and airports.
ShoreReplacement shore
In which way shore sprites were replaced.
Functions related to low-level strings.
byte pylons
Bitmask of base tiles (0 - 7) which should contain elrail pylons.
uint8 freight_trains
value to multiply the weight of cargo by
bool prop27_set
Did the NewGRF set property 27 (misc flags)?
static void ReadSpriteLayoutRegisters(ByteReader *buf, TileLayoutFlags flags, bool is_parent, NewGRFSpriteLayout *dts, uint index)
Preprocess the TileLayoutFlags and read register modifiers from the GRF.
uint8 num_output
How many add_output values are valid.
uint8 palette_var10
Value for variable 10 when resolving the palette.
uint param_end
one more than the highest set parameter
void Clone(const DrawTileSeqStruct *source)
Clone the building sprites of a spritelayout.
First bit used for the type of effect.
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
bool enabled
Is this spec enabled?
Information about a vehicle.
static void FinaliseHouseArray()
Add all new houses to the house array.
uint16 internal_id
The internal ID within the GRF file.
uint8 num_params
Number of used parameters.
static void CalculateRefitMasks()
Precalculate refit masks from cargo classes for all vehicles.
byte mail_generation
mail generation multiplier (tile based, as the acceptances below)
bool(* BranchHandler)(ByteReader *)
Type of callback function for branch nodes.
Functions related to errors.
RailType AllocateRailType(RailTypeLabel label)
Allocate a new rail type label.
RoadTypes powered_roadtypes
bitmask to the OTHER roadtypes on which a vehicle of THIS roadtype generates power ...
bool IsTerminator() const
Check whether this is a sequence terminator.
const SpriteGroup ** loaded
List of loaded groups (can be SpriteIDs or Callback results)
byte subtype
Type of aircraft.
uint16 max_sprite_offset
Maximum offset to add to the sprite. (limited by size of the spriteset)
void SetupEngines()
Initialise the engine pool with the data from the original vehicles.
DateFract _date_fract
Fractional part of the day.
static uint32 _grm_engines[256]
Contains the GRF ID of the owner of a vehicle if it has been reserved.
byte train_signal_side
show signals on left / driving / right side
The NewGRF says any palette can be used.
Shore sprites were replaced by Action5.
GRF file is an openttd-internal system grf.
static size_t GetPoolSize()
Returns first unused index.
HouseClassID class_id
defines the class this house has (not grf file based)
Information about GRF, used in the game and (part of it) in savegames.
void SetYearEngineAgingStops()
Compute the value for _year_engine_aging_stops.
int8 retire_early
Number of years early to retire vehicle.
Ground palette sprite of a tile, together with its sprite layout.
byte ReadByte(LoadgameState *ls)
Reads a byte from the buffer and decompress if needed.
Number of the first newgrf airport.
void AddGRFTextToList(GRFText **list, GRFText *text_to_add)
Add a GRFText to a GRFText list.
No tram depot graphics were loaded.
Functions related to engines.
uint16 maintenance_multiplier
Cost multiplier for maintenance of this road type.
byte road_side
the side of the road vehicles drive on
static ChangeInfoResult StationChangeInfo(uint stid, int numinfo, int prop, ByteReader *buf)
Define properties for stations.
static ChangeInfoResult BridgeChangeInfo(uint brid, int numinfo, int prop, ByteReader *buf)
Define properties for bridges.
EngineClass engclass
Class of engine for this vehicle.
uint consistent_max_offset
Number of sprites in all referenced spritesets.
static bool ChangeGRFURL(byte langid, const char *str)
Callback function for 'INFO'->'URL_' to set the newgrf url.
const Direction * rotation
the rotation of each tiletable
static ChangeInfoResult ObjectChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for objects.
uint16 pow_wag_power
Extra power applied to consist if wagon should be powered.
uint16 max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Functions related to NewGRF houses.
Bitmask to get only the use palette use states.
bool has_param_defaults
NOSAVE: did this newgrf specify any defaults for it's parameters.
static void DuplicateTileTable(AirportSpec *as)
Create a copy of the tile table so it can be freed later without problems.
void ClearSnowLine()
Clear the variable snow line table and free the memory.
byte callback_mask
Bitmask of vehicle callbacks that have to be called.
simple wagon, not motorized
GRFFilePropsBase< NUM_CARGO+3 > grf_prop
Properties related the the grf file.
DeterministicSpriteGroupAdjustOperation
Standard non-electric rails.
SoundID GetNewGRFSoundID(const GRFFile *file, SoundID sound_id)
Resolve NewGRF sound ID.
byte num_bit
Number of bits to use for this parameter.
static void ResetAirports()
This function initializes the airportspec array.
AnimationInfo animation
Information about the animation.
Capacity (if dualheaded: for each single vehicle)
static void StaticGRFInfo(ByteReader *buf)
Handle Action 0x14.
Mapping of language data between a NewGRF and OpenTTD.
Definition of base types and functions in a cross-platform compatible way.
static void ResetAirportTiles()
This function initializes the tile array of AirportTileSpec.
static void ResetCustomIndustries()
Reset and clear all NewGRF industries.
The data is copied from a grf in _all_grfs.
Data structure to convert between Date and triplet (year, month, and day).
bool IsValidSpriteSet(byte feature, uint set) const
Check whether a specific set is defined.
byte processing_time
Periodic refresh multiplier.
void SetEntitySpec(const HouseSpec *hs)
Install the specs into the HouseSpecs array It will find itself the proper slot on which it will go...
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
A number of safeguards to prevent using unsafe methods.
int16 x
The x value of the coordinate.
static void FeatureTownName(ByteReader *buf)
Action 0x0F - Define Town names.
static bool ValidateIndustryLayout(const IndustryTileLayout &layout)
Validate the industry layout; e.g.
uint16 callback_mask
Bitmask of requested/allowed callbacks.
uint8 acceleration_type
Acceleration type of this rail type.
void FioSeekTo(size_t pos, int mode)
Seek in the current file.
Information about why GRF had problems during initialisation.
uint32 max_value
The maximal value of this parameter.
Direction
Defines the 8 directions on the map.
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)
Map the GRF local type to an industry type.
RailTypes introduces_railtypes
Bitmask of which other railtypes are introduced when this railtype is introduced. ...
Vehicle uses two company colours.
static const IndustryGfx NEW_INDUSTRYTILEOFFSET
original number of tiles
StringID new_industry_text
Message appearing when the industry is built.
Max. speed: 1 unit = 1/0.8 mph = 2 km-ish/h.
const SpriteGroup * group
Sprite group to start resolving.
void LoadNewGRFFile(GRFConfig *config, uint file_index, GrfLoadingStage stage, Subdirectory subdir)
Load a particular NewGRF.
bool dynamic_engines
enable dynamic allocation of engine data
T * Allocate(size_t count)
Get buffer of at least count times T.
static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for rail vehicles.
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 ...
byte random_colour[4]
4 "random" colours
static const Action5Type _action5_types[]
The information about action 5 types.
uint8 callback_mask
Bitmask of cargo callbacks that have to be called.
byte visual_effect
Bitstuffed NewGRF visual effect data.
int skip_sprites
Number of pseudo sprites to skip before processing the next one. (-1 to skip to end of file) ...
byte sorting_order
The sorting order of this railtype for the toolbar dropdown.
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Refittability
Summary state of refittability properties.
CargoLabel label
Unique label of the cargo type.
byte num_table
number of elements in the table
static bool ChangeGRFParamValueNames(ByteReader *buf)
Callback function for 'INFO'->'PARA'->param_num->'VALU' to set the names of some parameter values (ty...
static void LoadFontGlyph(ByteReader *buf)
Action 0x12.
uint8 views
The number of views.
bool operator==(const MultiMapIterator< Tmap_iter1, Tlist_iter1, Tkey, Tvalue1, Tcompare > &iter1, const MultiMapIterator< Tmap_iter2, Tlist_iter2, Tkey, Tvalue2, Tcompare > &iter2)
Compare two MultiMap iterators.
void CleanUpStrings()
House cleaning.
StringID menu_text
Name of this rail type in the main toolbar dropdown.
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Information about languages and their files.
static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, ByteReader *buf)
Define properties for cargoes.
byte capacity
Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
uint8 flags
NOSAVE: GCF_Flags, bitset.
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
static T * ReallocT(T *t_ptr, size_t num_elements)
Simplified reallocation function that allocates the specified number of elements of the given type...
uint8 tractive_effort
Coefficient of tractive effort.
static bool ChangeGRFParamDefault(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'DFLT' to set the default value.
Number of ticks before carried cargo is aged.
uint8 sprite_var10
Value for variable 10 when resolving the sprite.
uint16 DateFract
The fraction of a date we're in, i.e. the number of ticks since the last date changeover.
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...
GRF is unusable with this version of OpenTTD.
uint traininfo_vehicle_width
Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details.
byte cost_factor
Purchase cost factor; For multiheaded engines the sum of both engine prices.
StringID name
Tile Subname string, land information on this tile will give you "AirportName (TileSubname)".
static ChangeInfoResult CanalChangeInfo(uint id, int numinfo, int prop, ByteReader *buf)
Define properties for water features.
uint16 max_bridge_length
maximum length of bridges
The NewGRF provided no information or doesn't care about a 32 bpp blitter.
uint16 max_speed
Maximum speed for vehicles travelling on this rail type.
static bool IsValidNewGRFImageIndex(uint8 image_index)
Helper to check whether an image index is valid for a particular NewGRF vehicle.
byte min_length
the minimum length (not counting start and end tile)
byte misc_flags
Miscellaneous flags.
Set when a sprite originates from an Action 1.
uint16 max_speed
Maximum speed for vehicles travelling on this road type.
static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, ByteReader *buf)
Define properties for industries.
Defines the data structure for constructing industry.
byte shorten_factor
length on main map for this type is 8 - shorten_factor
uint8 sprite
Register specifying a signed offset for the sprite.
Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta.parent[2].
static bool HandleNode(byte type, uint32 id, ByteReader *buf, AllowedSubtags subtags[])
Handle the nodes of an Action14.
A reusable buffer that can be used for places that temporary allocate a bit of memory and do that ver...
static const uint8 MAX_NUM_GENDERS
Maximum number of supported genders.
byte air_drag
Coefficient of air drag.
GRFFileProps grf_prop
properties related to the grf file
static void AddStringForMapping(StringID source, StringID *target)
Record a static StringID for getting translated later.
static const AirportTileSpec * Get(StationGfx gfx)
Retrieve airport tile spec for the given airport tile.
void FioReadBlock(void *ptr, size_t size)
Read a block.
static bool ChangeGRFVersion(size_t len, ByteReader *buf)
Callback function for 'INFO'->'VRSN' to the version of the NewGRF.
bool _palette_remap_grf[]
Whether the given NewGRFs must get a palette remap from windows to DOS or not.
StationGfx gfx
AirportTile to use for this tile.
EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
Return the ID of a new engine.
uint8 weight
Weight in 1/4t units.
byte wires
Bitmask of base tiles (0 - 7) which should contain elrail wires.
bool IsParentSprite() const
Check whether this is a parent sprite with a boundingbox.
StringID building_name
building name
Basic functions/variables used all over the place.
const SpriteGroup ** loading
List of loading groups (can be SpriteIDs or Callback results)
struct RoadTypeInfo::@42 strings
Strings associated with the rail type.
bool Insert(const T &key, const U &data)
Adds new item to this map.
unknown/not-implemented type
byte openttd_id
OpenTTD's internal ID for a case/gender.
Flags which are still required after loading the GRF.
static const uint8 ANIM_STATUS_NO_ANIMATION
There is no animation.
static bool ChangeGRFMinVersion(size_t len, ByteReader *buf)
Callback function for 'INFO'->'MINV' to the minimum compatible version of the NewGRF.
SpriteID GetSprite(byte feature, uint set) const
Returns the first sprite of a spriteset.
uint8 cargo_map[NUM_CARGO]
Inverse cargo translation table (CargoID -> local ID)
static CargoTypes TranslateRefitMask(uint32 refit_mask)
Translate the refit mask.
static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)
Set the override for a NewGRF.
#define lengthof(x)
Return the length of an fixed size array.
IndustryBehaviour behaviour
How this industry will behave, and how others entities can use it.
static const uint8 MAX_NUM_CASES
Maximum number of supported cases.
static uint32 _ttdpatch_flags[8]
32 * 8 = 256 flags.
byte appear_ingame[NUM_LANDSCAPE]
Probability of appearance in game.
GRFFileProps grf_prop
properties related to the grf file
StringID message
Default message.
static T min(const T a, const T b)
Returns the minimum of two values.
byte GetNewgrfCurrencyIdConverted(byte grfcurr_id)
Will return the ottd's index correspondence to the ttdpatch's id.
number of bits for the sprite number
RailTypeLabel label
Unique 32 bit rail type identifier.
Element of the linked list.
uint8 plane_speed
divisor for speed of aircraft
bool FioCheckFileExists(const char *filename, Subdirectory subdir)
Check whether the given file exists.
Year max_year
last year it can be built
NewGRF supplied spritelayout.
StringID transport_name[2]
description of the bridge, when built for road or rail
static const Year ORIGINAL_BASE_YEAR
The minimum starting year/base year of the original TTD.
static const IndustryGfx NUM_INDUSTRYTILES_PER_GRF
Maximum number of industry tiles per NewGRF; limited to 255 to allow extending Action3 with an extend...
Bitmask of all climate bits.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
const uint8 _engine_counts[4]
Number of engines of each vehicle type in original engine data.
bool build_on_slopes
allow building on slopes
bool SkipSpriteData(byte type, uint16 num)
Skip the given amount of sprite graphics data.
uint16 power
Power of engine (hp); For multiheaded engines the sum of both engine powers.
Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palet...
Known flags. Any unknown set flag will disable the GRF.
const struct SpriteGroup * spritegroup[Tcnt]
pointer to the different sprites of the entity
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
static bool ChangeGRFBlitter(size_t len, ByteReader *buf)
Callback function for 'INFO'->'BLTR' to set the blitter info.
BuildingFlags building_flags
some flags that describe the house (size, stadium etc...)
static const SpriteGroup * CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid)
Helper function to either create a callback or a result sprite group.
static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, ByteReader *buf)
Define properties for industry tiles.
SpriteID spriteid
First available SpriteID for loading realsprites.
byte sorting_order
The sorting order of this roadtype for the toolbar dropdown.
Price fallback_price
Fallback price multiplier for new prices but old grfs.
Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
bool has_newhouses
Set if there are any newhouses loaded.
WaterFeature _water_feature[CF_END]
Table of canal 'feature' sprite groups.
NewGRF handling of airport tiles.
SoundEntry * AllocateSound(uint num)
Allocate sound slots.
Subdirectory for all NewGRFs.
AllowedSubtags _tags_parameters[]
Action14 parameter tags.
uint16 price
the price multiplier
Information about a rail vehicle.
static bool IsLeapYear(Year yr)
Checks whether the given year is a leap year or not.
The status of this grf file is unknown.
Shore sprites were replaced by ActionA (using grass tiles for the corner-shores). ...
static const SpriteID SPR_RAILTYPE_TUNNEL_BASE
Tunnel sprites with grass only for custom railtype tunnel.
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
StringID replace_text
Text used in the autoreplace GUI.
uint32 version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
StringID name
The name for this object.
static void FinalisePriceBaseMultipliers()
Decide whether price base multipliers of grfs shall apply globally or only to the grf specifying them...
#define DEBUG(name, level,...)
Output a line of debugging information.
uint8 FindFirstBit(uint32 x)
Search the first set bit in a 32 bit variable.
static const uint MAX_LANG
Maximum number of languages supported by the game, and the NewGRF specs.
uint8 callback_mask
Bitmask of industry tile callbacks that have to be called.
uint16 override
id of the entity been replaced by
void FioOpenFile(int slot, const char *filename, Subdirectory subdir)
Open a slotted file.
uint8 callback_mask
Bitmask of canal callbacks that have to be called.
byte flags
Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size...
GRFTextWrapper * url
NOSAVE: URL belonging to this GRF.
void BindAirportSpecs()
Tie all airportspecs to their class.
uint16 _tick_counter
Ever incrementing (and sometimes wrapping) tick counter for setting off various events.
GRF file passed GLS_RESERVE stage.
static void ResetCustomHouses()
Reset and clear all NewGRF houses.
static void ParamSet(ByteReader *buf)
Action 0x0D: Set parameter.
Resolve palette with a specific value in variable 10.
byte num_loading
Number of loading groups.
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.
Cargo behaves passenger-like.
Additional modifiers for items in sprite layouts.
static bool ChangeGRFNumUsedParams(size_t len, ByteReader *buf)
Callback function for 'INFO'->'NPAR' to set the number of valid parameters.
The NewGRF says the Windows palette can be used.
Handling of NewGRF canals.
Describes properties of price bases.
uint32 FioReadDword()
Read a double word (32 bits) from the file (in low endian format).
Flag to disable visual effect.
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
void InitRoadTypes()
Resolve sprites of custom road types.
byte first_bit
First bit to use in the GRF parameter.
StringID material
the string that contains the bridge description
uint grf_feature
GRF Feature that decides whether price multipliers apply locally or globally, #GSF_END if none...
CargoID accepts_cargo[INDUSTRY_NUM_INPUTS]
Cargo accepted by this tile.
uint8 clear_cost_multiplier
Clear cost multiplier per tile.
bool old_refittable
Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
std::vector< IndustryTileLayoutTile > IndustryTileLayout
A complete tile layout for an industry is a list of tiles.
IndustryTileSpecialFlags
Flags for miscellaneous industry tile specialities.
Date introduction_date
Introduction date.
uint16 cost_multiplier
Cost multiplier for building this rail type.
static GRFFile * GetFileByGRFID(uint32 grfid)
Obtain a NewGRF file by its grfID.
PalSpriteID ground
Palette and sprite for the ground.
GRFConfig * GetGRFConfig(uint32 grfid, uint32 mask)
Retrieve a NewGRF from the current config by its grfid.
uint8 child[2]
Registers for signed offsets for the position of child sprites.
TownEffect town_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies...
this bit is set when a recolouring process is in action
bool _generating_world
Whether we are generating the map or not.
1F This is just to englobe all above types at once
Information about a road vehicle.
Header file for NewGRF stations.
uint8 callback_mask
Bitmask of canal callbacks that have to be called.
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
RailType
Enumeration for all possible railtypes.
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Variable was parsed but unread.
static const WChar NFO_UTF8_IDENTIFIER
This character, the thorn ('þ'), indicates a unicode string to NFO.
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
HouseExtraFlags extra_flags
some more flags
bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile)
Reads a variable common to VarAction2 and Action7/9/D.
byte minimal_cargo
minimum amount of cargo transported to the stations.
byte prob
The relative probability of the following name to appear in the bottom 7 bits.
uint8 cost_multiplier
Base construction cost multiplier.
Information about one grf parameter.
bool station_noise_level
build new airports when the town noise level is still within accepted limits
Base class for all vehicles.
indicates a "standalone" locomotive
byte appear_creation[NUM_LANDSCAPE]
Probability of appearance during map creation.
bool(* TextHandler)(byte, const char *str)
Type of callback function for text nodes.
void ResetMapping()
Resets the mapping, which is used while initializing game.
uint16 max_length
the maximum length (not counting start and end tile)
Maximal number of airports per NewGRF.
static size_t ttd_strnlen(const char *str, size_t maxlen)
Get the length of a string, within a limited buffer.
Temporary engine data used when loading only.
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
void ResetNewGRFData()
Reset all NewGRF loaded data.
Declarations for savegames operations.
uint16 EngineID
Unique identification number of an engine.
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
bool gradual_loading
load vehicles gradually
Number of bits used for the effect type.
static void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig *c)
Disable a static NewGRF when it is influencing another (non-static) NewGRF as this could cause desync...
static void ResetNewGRFErrors()
Clear all NewGRF errors.
RandomizedSpriteGroupCompareMode cmp_mode
Check for these triggers:
uint16 cost_multiplier
Cost multiplier for building this road type.
AnimationInfo animation
Information about the animation (is it looping, how many loops etc)
Max. speed: 1 unit = 1/3.2 mph = 0.5 km-ish/h.
byte tractive_effort
Tractive effort coefficient.
Cargo support for NewGRFs.
uint8 palette
GRFPalette, bitset.
static ChangeInfoResult RoadVehicleChangeInfo(uint engine, int numinfo, int prop, ByteReader *buf)
Define properties for road vehicles.
Number of ticks before carried cargo is aged.
byte minimum_life
The minimum number of years this house will survive before the town rebuilds it.
StringID name
name of this airport
Canal properties local to the NewGRF.
Information about a aircraft vehicle.
uint16 remove_rating_decrease
rating decrease if removed
bool has_newindustries
Set if there are any newindustries loaded.
GRF file is unsafe for static usage.
byte fallback_railtype
Original railtype number to use when drawing non-newgrf railtypes, or when drawing stations...
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like INV...
OrderSettings order
settings related to orders
AnimationInfo animation
Information about the animation.
bool wagon_speed_limits
enable wagon speed limits
static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)
Map the colour modifiers of TTDPatch to those that Open is using.
static void InitNewGRFFile(const GRFConfig *config)
Prepare loading a NewGRF file with its config.
Add signed offset to child sprite X positions from register TileLayoutRegisters::delta.child[0].
StringID closure_text
Message appearing when the industry closes.
Related object of the resolved one.
GRF defined the vehicle as refittable. If the refitmask is empty after translation (cargotypes not av...
void FioSkipBytes(int n)
Skip n bytes ahead in the file.
Date introduction_date
Introduction date.
Year min_year
introduction year of the house
byte map_colour
Colour on mini-map.
when a sprite is to be displayed transparently, this bit needs to be set.
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Action5BlockType
The type of action 5 type.
int8 delta_z
0x80 identifies child sprites
void CDECL grfmsg(int severity, const char *str,...)
DEBUG() function dedicated to newGRF debugging messages Function is essentially the same as DEBUG(grf...
static T abs(const T a)
Returns the absolute value of (scalar) variable.
byte size_x
size of airport in x direction
indicates a combination of two locomotives
uint8 power
Power in 10hp units.
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
0..4 1,2,4,8,10 which town zones the building can be built in, Zone1 been the further suburb ...
uint8 rv_max_speed
Temporary storage of RV prop 15, maximum speed in mph/0.8.
void InitRailTypes()
Resolve sprites of custom rail types.
static void ActivateOldTramDepot()
Replocate the old tram depot sprites to the new position, if no new ones were loaded.
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
uint16 max_range
Maximum range of this aircraft.
Tile-offset / AirportTileID pair.
static bool HandleNodes(ByteReader *buf, AllowedSubtags subtags[])
Handle the contents of a 'C' choice of an Action14.
StringID string_id
Default name of engine.
CanalProperties canal_local_properties[CF_END]
Canal properties as set by this NewGRF.
bool(* DataHandler)(size_t, ByteReader *)
Type of callback function for binary nodes.
FontSize
Available font sizes.
static const SpriteID SPR_AIRPORT_PREVIEW_BASE
Airport preview sprites.
Slope
Enumeration for the slope-type.
static GRFTempEngineData * _gted
Temporary engine data used during NewGRF loading.
void ResetPriceBaseMultipliers()
Reset changes to the price base multipliers.
char * filename
Filename - either with or without full path.
static const CargoLabel _default_refitmasks_rail[]
List of what cargo labels are refittable for the given the vehicle-type.
uint32 CargoLabel
Globally unique label of a cargo type.
uint8 version
Production callback version used, or 0xFF if marked invalid.
static const HouseID NEW_HOUSE_OFFSET
Offset for new houses.
Only corner-shores were loaded by Action5 (openttd(w/d).grf only).
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...
Bitmask to only get the blitter information.
bool LoadNextSprite(int load_index, byte file_slot, uint file_sprite_id, byte container_version)
Load a real or recolour sprite.
static const IndustryType NEW_INDUSTRYOFFSET
original number of industry types
static const SpriteID SPR_OPENTTD_BASE
Extra graphic spritenumbers.
uint16 weight
Weight of vehicle (tons); For multiheaded engines the weight of each single engine.
uint16 cargo_threshold
Cargo threshold for choosing between little and lots of cargo.
bool has_2CC
Set if any vehicle is loaded which uses 2cc (two company colours).
uint8 generate_amount
Number of objects which are attempted to be generated per 256^2 map during world generation.
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() ...
Number of ticks before carried cargo is aged.
RailTypes powered_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype generates power ...
Functions related to OTTD's landscape.
Default value to indicate that visual effect should be based on engine class.
void ResetRailTypes()
Reset all rail type information to its default values.
GRFTextWrapper * name
NOSAVE: GRF name (Action 0x08)
void ResetGenericCallbacks()
Reset all generic feature callback sprite groups.
std::vector< RailTypeLabel > railtype_list
Railtype translation table.
uint8 substitute_id
The (original) entity ID to use if this GRF is not available (currently not used) ...
Attempt to modify an invalid ID.
Defines the data structure of each individual tile of an airport.
const GRFFile * defaultcargo_grf
GRF defining the cargo translation table to use if the default cargo is the 'first refittable'...
IndustryBehaviour
Various industry behaviours mostly to represent original TTD specialities.
static void InitializeGRFSpecial()
Initialize the TTDPatch flags.
The NewGRF says the DOS palette can be used.
AnimationInfo animation
information about the animation.
static void ClearTemporaryNewGRFData(GRFFile *gf)
Reset all NewGRFData that was used only while processing data.
CargoID Index() const
Determines index of this cargospec.
static void EnsureEarlyHouse(HouseZones bitmask)
Make sure there is at least one house available in the year 0 for the given climate / housezone combi...
byte GetGRFContainerVersion()
Get the container version of the currently opened GRF file.
uint8 callback_mask
Bitmask telling which grf callback is set.
IndustryType conflicting[3]
Industries this industry cannot be close to.
byte GetSnowLine()
Get the current snow line, either variable or static.
uint16 local_id
id defined by the grf file for this entity
uint32 min_loadable_version
NOSAVE: Minimum compatible version a NewGRF can define.
static ChangeInfoResult IgnoreTownHouseProperty(int prop, ByteReader *buf)
Ignore a house property.
static bool SkipUnknownInfo(ByteReader *buf, byte type)
Try to skip the current node and all subnodes (if it's a branch node).
uint64 used_liveries
Bitmask of LiveryScheme used by the defined engines.
byte shorten_factor
length on main map for this type is 8 - shorten_factor
std::vector< GRFParameterInfo * > param_info
NOSAVE: extra information about the parameters.
static const SpriteID SPR_TRAMWAY_BASE
Tramway sprites.
Cargo behaves food/fizzy-drinks-like.
static const uint TLR_MAX_VAR10
Maximum value for var 10.
Max. speed: 1 unit = 8 mph = 12.8 km-ish/h.
ConstructionSettings construction
construction of things in-game
static const uint SNOW_LINE_DAYS
Number of days in each month in the snow line table.
Variable was parsed and read.
static const Year MIN_YEAR
The absolute minimum & maximum years in OTTD.
static uint32 _grm_cargoes[NUM_CARGO *2]
Contains the GRF ID of the owner of a cargo if it has been reserved.
static const uint MAX_SPRITEGROUP
Maximum GRF-local ID for a spritegroup.
uint8 air_drag
Coefficient of air drag.
uint32 min_value
The minimal value this parameter can have.
const char * GetName() const
Get the name of this grf.
int32 Date
The type to store our dates in.
uint32 grfid
GRF ID (defined by Action 0x08)
char * data
Additional data for message and custom_message.
Tractive effort coefficient in 1/256.
struct GRFText * name
The name of this parameter.
VarSpriteGroupScope var_scope
Take this object:
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
GRF defined vehicle as not-refittable. The vehicle shall only carry the default cargo.
GRFFileProps grf_prop
Properties related the the grf file.
StringID name
Name of this rail type.
uint file_index
File index of currently processed GRF file.
declaration of OTTD revision dependent variables
const struct GRFFile * grffile
grf file that introduced this entity
uint8 number_of_sounds
Number of sounds available in the sounds array.
uint8 bitnum
Cargo bit number, is INVALID_CARGO for a non-used spec.
bool enabled
Entity still available (by default true). Newgrf can disable it, though.
StringID station_name
Default name for nearby station.
std::vector< CargoLabel > cargo_list
Cargo translation table (local ID -> label)
RoadTypes introduction_required_roadtypes
Bitmask of roadtypes that are required for this roadtype to be introduced at a given introduction_dat...
uint32 param[0x80]
GRF parameters.
GRF file has been activated.
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
StringID units_volume
Name of a single unit of cargo of this type.
bool IsValid() const
Tests for validity of this cargospec.
StringID production_up_text
Message appearing when the industry's production is increasing.
Functions related to NewGRF provided sounds.
byte callback_mask
Bitmask of station callbacks that have to be called.
byte num_groups
must be power of 2
AllowedSubtags _tags_root[]
Action14 root tags.
byte disallowed_lengths
Bitmask of platform lengths available for the station.
byte _misc_grf_features
Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E.
byte check_proc
Index to a procedure to check for conflicting circumstances.
Definition of one tile in an industry tile layout.
static GRFFile * GetFileByFilename(const char *filename)
Obtain a NewGRF file by its filename.
byte id
If probability bit 7 is set.
static GRFParameterInfo * _cur_parameter
The parameter which info is currently changed by the newgrf.
static void ResetCustomStations()
Reset and clear all NewGRF stations.
GameCreationSettings game_creation
settings used during the creation of a game (map)
static const uint NEW_AIRPORTTILE_OFFSET
offset of first newgrf airport tile
static bool ChangeGRFParamType(size_t len, ByteReader *buf)
Callback function for 'INFO'->'PARAM'->param_num->'TYPE' to set the typeof a parameter.
byte CargoID
Cargo slots to indicate a cargo type within a game.
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
Defines the data structure of each individual tile of an industry.
static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, ByteReader *buf)
Define properties for global variables.
Bitmask to get only the NewGRF supplied information.
Weight in t (if dualheaded: for each single vehicle)
Year base_life
Basic duration of engine availability (without random parts). 0xFF means infinite life...
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Road vehicle is a tram/light rail vehicle.
NewGRFSpriteLayout * renderdata
Array of tile layouts.
size_t FioGetPos()
Get position in the current file.
int8 delta_x
0x80 is sequence terminator
static uint32 BSWAP32(uint32 x)
Perform a 32 bits endianness bitswap on x.
static void SkipAct12(ByteReader *buf)
Action 0x12 (SKIP)
static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, ByteReader *buf)
Define properties for sound effects.
RoadTypes introduces_roadtypes
Bitmask of which other roadtypes are introduced when this roadtype is introduced. ...
StringID name
Name of this station.
Maximum catchment for airports with "modified catchment" enabled.
Defines the data structure for an airport.
GRFLoadedFeatures _loaded_newgrf_features
Indicates which are the newgrf features currently loaded ingame.
Use 32 pixels per train vehicle in depot gui and vehicle details. Never set in the global variable;...
static void TranslateGRFStrings(ByteReader *buf)
Action 0x13.
static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, ByteReader *buf)
Define properties for houses.
RoadTypeLabelList alternate_labels
Road type labels this type provides in addition to the main label.
uint16 multipliertowngrowth
Size of the effect.
const GRFFile * grffile[ROTSG_END]
NewGRF providing the Action3 for the roadtype.
byte parameter
Used for variables between 0x60 and 0x7F inclusive.
CargoTypes ctt_include_mask
Cargo types always included in the refit mask.
byte ai_passenger_only
Bit value to tell AI that this engine is for passenger use only.
uint8 num_input
How many subtract_input values are valid.
RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels)
Get the rail type for a given label.
SpriteID sprite
The 'real' sprite.
uint8 parent[3]
Registers for signed offsets for the bounding box position of parent sprites.
byte disallowed_platforms
Bitmask of number of platforms available for the station.
uint8 speed
The speed, i.e. the amount of time between frames.
byte running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
static GRFError * DisableGrf(StringID message=STR_NULL, GRFConfig *config=nullptr)
Disable a GRF.
ObjectClassID cls_id
The class to which this spec belongs.
StationClassID cls_id
The class to which this spec belongs.
uint8 dodraw
Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
Action 2 sprite layout for houses, industry tiles, objects and airport tiles.
static bool ChangeGRFParamDescription(byte langid, const char *str)
Callback function for 'INFO'->'PARAM'->param_num->'DESC' to set the description of a parameter...
byte climates
Climates supported by the engine.
static void SetUnicodeGlyph(FontSize size, WChar key, SpriteID sprite)
Map a SpriteID to the font size and key.
Date _date
Current date in days (day counter)
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
static ChangeInfoResult IgnoreIndustryProperty(int prop, ByteReader *buf)
Ignore an industry property.
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain)...
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.
uint32 WChar
Type for wide characters, i.e.
TTDPAirportType
Allow incrementing of AirportClassID variables.
Year max_year
last year the airport is available
void ConvertDateToYMD(Date date, YearMonthDay *ymd)
Converts a Date to a Year, Month & Day.
Set when a sprite must not ever be displayed transparently.
Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading)...
uint8 climate
In which climates is this object available?
GRFFileProps grf_prop
properties related the the grf file
CargoID cargo_input[INDUSTRY_NUM_INPUTS]
Which input cargoes to take from (only cb version 2)
byte canal_speed_frac
Fraction of maximum speed for canal/river tiles.
static const IndustryGfx INDUSTRYTILE_NOANIM
flag to mark industry tiles as having no animation
void AddSpriteSets(byte feature, SpriteID first_sprite, uint first_set, uint numsets, uint numents)
Records new spritesets.
byte user_def_data
Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles.
uint8 frames
The number of frames.
const char * name
Name for error messages.
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...
void SetEntitySpec(IndustrySpec *inds)
Method to install the new industry data in its proper slot The slot assignment is internal of this me...
std::map< uint, SpriteSet > spritesets[GSF_END]
Currently referenceable spritesets.
Year starting_year
starting date
static bool ChangeGRFName(byte langid, const char *str)
Callback function for 'INFO'->'NAME' to add a translation to the newgrf name.
struct GRFFileProps grf_prop
Properties related to the grf file.
ObjectOverrideManager _object_mngr
The override manager for our objects.
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_...
Only allow replacing a whole block of sprites. (TTDP compatible)
CargoTypes ctt_exclude_mask
Cargo types always excluded from the refit mask.
byte blocked
Bitmask of base tiles (0 - 7) which are blocked to trains.
uint8 palette
Register specifying a signed offset for the palette.
static const uint NETWORK_MAX_GRF_COUNT
Maximum number of GRFs that can be sent.
TileLayoutFlags flags
Flags defining which members are valid and to be used.
static const SpriteID SPR_FLAGS_BASE
Flags sprites (in same order as enum NetworkLanguage)
uint16 passenger_capacity
Passenger capacity (persons).
byte mail_capacity
Mail capacity (bags).
uint16 min_sprites
If the Action5 contains less sprites, the whole block will be ignored.
virtual void CleanPool()
Virtual method that deletes all items in the pool.
static void MemSetT(T *ptr, byte value, size_t num=1)
Type-safe version of memset().
void ResetToDefaultMapping()
Initializes the EngineOverrideManager with the default engines.
byte visual_effect
Bitstuffed NewGRF visual effect data.
Electrified depot graphics with tram track were loaded.
Dynamic data of a loaded NewGRF.
11 800 can appear in sub-arctic climate above the snow line
uint16 maintenance_multiplier
Cost multiplier for maintenance of this rail type.
Information about a single action 5 type.
Information for mapping static StringIDs.
static bool HandleParameterInfo(ByteReader *buf)
Callback function for 'INFO'->'PARA' to set extra information about the parameters.
GRFTextWrapper * info
NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
static ChangeInfoResult RoadTypeChangeInfo(uint id, int numinfo, int prop, ByteReader *buf, RoadTramType rtt)
Define properties for roadtypes.
Flags which refer to using multiple action-1-2-3 chains.
PaletteID pal
The palette (use PAL_NONE) if not needed)
StringID name
Name of this class.
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...
void BuildIndustriesLegend()
Fills an array for the industries legends.