53 #include "table/strings.h" 115 this->skip_sprites = 0;
117 for (uint i = 0; i < GSF_END; i++) {
118 this->spritesets[i].clear();
121 memset(this->spritegroups, 0,
sizeof(this->spritegroups));
134 assert(feature < GSF_END);
135 for (uint i = 0; i < numsets; i++) {
136 SpriteSet &
set = this->spritesets[feature][first_set + i];
137 set.
sprite = first_sprite + i * numents;
138 set.num_sprites = numents;
150 assert(feature < GSF_END);
151 return !this->spritesets[feature].empty();
163 assert(feature < GSF_END);
164 return this->spritesets[feature].find(
set) != this->spritesets[feature].end();
176 return this->spritesets[feature].find(
set)->second.sprite;
188 return this->spritesets[feature].find(
set)->second.num_sprites;
201 template <VehicleType T>
204 return image_index == 0xFD || IsValidImageIndex<T>(image_index);
216 ByteReader(byte *data, byte *end) : data(data), end(end) { }
220 if (data < end)
return *(data)++;
230 uint16 ReadExtendedByte()
233 return val == 0xFF ? ReadWord() : val;
238 uint32 val = ReadWord();
239 return val | (ReadWord() << 16);
242 uint32 ReadVarSize(byte size)
246 case 2:
return ReadWord();
247 case 4:
return ReadDWord();
254 const char *ReadString()
256 char *
string =
reinterpret_cast<char *
>(data);
257 size_t string_length =
ttd_strnlen(
string, Remaining());
259 if (string_length == Remaining()) {
261 string[string_length - 1] =
'\0';
262 grfmsg(7,
"String was not terminated with a zero byte.");
272 inline size_t Remaining()
const 277 inline bool HasData(
size_t count = 1)
const 279 return data + count <= end;
287 inline void Skip(
size_t len)
296 typedef void (*SpecialSpriteHandler)(
ByteReader *buf);
309 uint16 cargo_allowed;
310 uint16 cargo_disallowed;
311 RailTypeLabel railtypelabel;
326 this->refittability = NONEMPTY;
327 }
else if (this->refittability == UNSET) {
328 this->refittability = EMPTY;
348 GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { }
352 return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline);
357 return this->grfid == other.grfid && this->nfoline == other.nfoline;
361 static std::map<GRFLocation, SpriteID> _grm_sprites;
362 typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride;
363 static GRFLineToSpriteOverride _grf_line_to_action6_sprite_override;
375 void CDECL
grfmsg(
int severity,
const char *str, ...)
394 const GRFFile *
const *end = _grf_files.
End();
395 for (
GRFFile *
const *file = _grf_files.
Begin(); file != end; file++) {
396 if ((*file)->grfid == grfid)
return *file;
408 const GRFFile *
const *end = _grf_files.
End();
409 for (
GRFFile *
const *file = _grf_files.
Begin(); file != end; file++) {
410 if (strcmp((*file)->filename, filename) == 0)
return *file;
436 if (config != NULL) {
447 if (message != STR_NULL) {
448 delete config->error;
449 config->error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, message);
453 return config->error;
474 *target = STR_UNDEFINED;
491 static const StringID units_volume[] = {
492 STR_ITEMS, STR_PASSENGERS, STR_TONS, STR_BAGS,
493 STR_LITERS, STR_ITEMS, STR_CRATES, STR_TONS,
494 STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
495 STR_TONS, STR_TONS, STR_TONS, STR_BAGS,
496 STR_TONS, STR_TONS, STR_BAGS, STR_LITERS,
497 STR_TONS, STR_LITERS, STR_TONS, STR_ITEMS,
498 STR_BAGS, STR_LITERS, STR_TONS, STR_ITEMS,
499 STR_TONS, STR_ITEMS, STR_LITERS, STR_ITEMS
505 #define TEXTID_TO_STRINGID(begin, end, stringid, stringend) \ 506 assert_compile(stringend - stringid == end - begin); \ 507 if (str >= begin && str <= end) return str + (stringid - begin) 510 TEXTID_TO_STRINGID(0x000E, 0x002D, STR_CARGO_PLURAL_NOTHING, STR_CARGO_PLURAL_FIZZY_DRINKS);
511 TEXTID_TO_STRINGID(0x002E, 0x004D, STR_CARGO_SINGULAR_NOTHING, STR_CARGO_SINGULAR_FIZZY_DRINK);
512 if (str >= 0x004E && str <= 0x006D)
return units_volume[str - 0x004E];
513 TEXTID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING, STR_QUANTITY_FIZZY_DRINKS);
514 TEXTID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING, STR_ABBREV_FIZZY_DRINKS);
515 TEXTID_TO_STRINGID(0x00D1, 0x00E0, STR_COLOUR_DARK_BLUE, STR_COLOUR_WHITE);
520 TEXTID_TO_STRINGID(0x200F, 0x201F, STR_TOWN_BUILDING_NAME_TALL_OFFICE_BLOCK_1, STR_TOWN_BUILDING_NAME_OLD_HOUSES_1);
521 TEXTID_TO_STRINGID(0x2036, 0x2041, STR_TOWN_BUILDING_NAME_COTTAGES_1, STR_TOWN_BUILDING_NAME_SHOPPING_MALL_1);
522 TEXTID_TO_STRINGID(0x2059, 0x205C, STR_TOWN_BUILDING_NAME_IGLOO_1, STR_TOWN_BUILDING_NAME_PIGGY_BANK_1);
525 TEXTID_TO_STRINGID(0x4802, 0x4826, STR_INDUSTRY_NAME_COAL_MINE, STR_INDUSTRY_NAME_SUGAR_MINE);
526 TEXTID_TO_STRINGID(0x482D, 0x482E, STR_NEWS_INDUSTRY_CONSTRUCTION, STR_NEWS_INDUSTRY_PLANTED);
527 TEXTID_TO_STRINGID(0x4832, 0x4834, STR_NEWS_INDUSTRY_CLOSURE_GENERAL, STR_NEWS_INDUSTRY_CLOSURE_LACK_OF_TREES);
528 TEXTID_TO_STRINGID(0x4835, 0x4838, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_INCREASE_FARM);
529 TEXTID_TO_STRINGID(0x4839, 0x483A, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_GENERAL, STR_NEWS_INDUSTRY_PRODUCTION_DECREASE_FARM);
532 case 0x4830:
return STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY;
533 case 0x4831:
return STR_ERROR_FOREST_CAN_ONLY_BE_PLANTED;
534 case 0x483B:
return STR_ERROR_CAN_ONLY_BE_POSITIONED;
536 #undef TEXTID_TO_STRINGID 538 if (str == STR_NULL)
return STR_EMPTY;
540 DEBUG(grf, 0,
"Unknown StringID 0x%04X remapped to STR_EMPTY. Please open a Feature Request if you need it", str);
579 static std::map<uint32, uint32> _grf_id_overrides;
588 _grf_id_overrides[source_grfid] = target_grfid;
589 grfmsg(5,
"SetNewGRFOverride: Added override of 0x%X to 0x%X",
BSWAP32(source_grfid),
BSWAP32(target_grfid));
604 uint32 scope_grfid = INVALID_GRFID;
607 scope_grfid = file->grfid;
608 uint32
override = _grf_id_overrides[file->grfid];
610 scope_grfid =
override;
612 if (grf_match == NULL) {
613 grfmsg(5,
"Tried mapping from GRFID %x to %x but target is not loaded",
BSWAP32(file->grfid),
BSWAP32(
override));
620 EngineID engine = _engine_mngr.
GetID(type, internal_id, scope_grfid);
629 EngineID engine = _engine_mngr.
GetID(type, internal_id, INVALID_GRFID);
635 grfmsg(5,
"Replaced engine at index %d for GRFID %x, type %d, index %d", e->
index,
BSWAP32(file->grfid), type, internal_id);
639 if (!static_access) {
641 eid->
grfid = scope_grfid;
647 if (static_access)
return NULL;
650 grfmsg(0,
"Can't allocate any more engines");
664 eid->grfid = scope_grfid;
665 eid->internal_id = internal_id;
674 memset(_gted + engine_pool_size, 0, len);
680 grfmsg(5,
"Created new engine at index %d for GRFID %x, type %d, index %d", e->
index,
BSWAP32(file->grfid), type, internal_id);
697 uint32 scope_grfid = INVALID_GRFID;
699 scope_grfid = file->grfid;
700 uint32
override = _grf_id_overrides[file->grfid];
701 if (
override != 0) scope_grfid =
override;
704 return _engine_mngr.
GetID(type, internal_id, scope_grfid);
744 grf_sprite->
sprite = buf->ReadWord();
745 grf_sprite->
pal = buf->ReadWord();
750 bool custom_sprite =
HasBit(grf_sprite->
pal, 15) != invert_action1_flag;
754 uint index =
GB(grf_sprite->
sprite, 0, 14);
756 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d", index);
757 grf_sprite->
sprite = SPR_IMG_QUERY;
758 grf_sprite->
pal = PAL_NONE;
761 if (max_sprite_offset != NULL) *max_sprite_offset = use_cur_spritesets ? _cur.
GetNumEnts(feature, index) : UINT16_MAX;
766 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout specifies var10 value for non-action-1 sprite");
767 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
773 uint index =
GB(grf_sprite->
pal, 0, 14);
775 grfmsg(1,
"ReadSpriteLayoutSprite: Spritelayout uses undefined custom spriteset %d for 'palette'", index);
776 grf_sprite->
pal = PAL_NONE;
779 if (max_palette_offset != NULL) *max_palette_offset = use_cur_spritesets ? _cur.
GetNumEnts(feature, index) : UINT16_MAX;
784 grfmsg(1,
"ReadSpriteLayoutRegisters: Spritelayout specifies var10 value for non-action-1 palette");
785 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
814 regs.delta.
parent[0] = buf->ReadByte();
815 regs.delta.
parent[1] = buf->ReadByte();
827 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
836 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
855 bool has_flags =
HasBit(num_building_sprites, 6);
856 ClrBit(num_building_sprites, 6);
859 dts->
Allocate(num_building_sprites);
861 uint16 *max_sprite_offset =
AllocaM(uint16, num_building_sprites + 1);
862 uint16 *max_palette_offset =
AllocaM(uint16, num_building_sprites + 1);
863 MemSetT(max_sprite_offset, 0, num_building_sprites + 1);
864 MemSetT(max_palette_offset, 0, num_building_sprites + 1);
871 grfmsg(1,
"ReadSpriteLayout: Spritelayout uses invalid flag 0x%x for ground sprite", flags & ~(valid_flags & ~
TLF_NON_GROUND_FLAGS));
872 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
879 for (uint i = 0; i < num_building_sprites; i++) {
882 flags =
ReadSpriteLayoutSprite(buf, has_flags,
false, use_cur_spritesets, feature, &seq->image, max_sprite_offset + i + 1, max_palette_offset + i + 1);
885 if (flags & ~valid_flags) {
886 grfmsg(1,
"ReadSpriteLayout: Spritelayout uses unknown flag 0x%x", flags & ~valid_flags);
887 DisableGrf(STR_NEWGRF_ERROR_INVALID_SPRITE_LAYOUT);
891 seq->
delta_x = buf->ReadByte();
892 seq->delta_y = buf->ReadByte();
894 if (!no_z_position) seq->
delta_z = buf->ReadByte();
897 seq->size_x = buf->ReadByte();
898 seq->size_y = buf->ReadByte();
899 seq->size_z = buf->ReadByte();
907 bool is_consistent =
true;
909 for (uint i = 0; i < num_building_sprites + 1; i++) {
910 if (max_sprite_offset[i] > 0) {
914 is_consistent =
false;
918 if (max_palette_offset[i] > 0) {
922 is_consistent =
false;
931 if (!is_consistent || dts->registers != NULL) {
935 for (uint i = 0; i < num_building_sprites + 1; i++) {
950 CargoTypes result = 0;
969 if (base_pointer == 0) {
970 *index = INVALID_PRICE;
974 static const uint32 start = 0x4B34;
975 static const uint32 size = 6;
977 if (base_pointer < start || (base_pointer - start) % size != 0 || (base_pointer - start) / size >= PR_END) {
978 grfmsg(1,
"%s: Unsupported running cost base 0x%04X, ignoring", error_location, base_pointer);
982 *index = (
Price)((base_pointer - start) / size);
1011 ei->decay_speed = buf->ReadByte();
1028 ei->load_amount = buf->ReadByte();
1050 for (
int i = 0; i < numinfo; i++) {
1059 uint8 tracktype = buf->ReadByte();
1061 if (tracktype < _cur.grffile->railtype_list.Length()) {
1066 switch (tracktype) {
1067 case 0: _gted[e->
index].railtypelabel = rvi->
engclass >= 2 ? RAILTYPE_ELECTRIC_LABEL : RAILTYPE_RAIL_LABEL;
break;
1068 case 1: _gted[e->
index].railtypelabel = RAILTYPE_MONO_LABEL;
break;
1069 case 2: _gted[e->
index].railtypelabel = RAILTYPE_MAGLEV_LABEL;
break;
1071 grfmsg(1,
"RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);
1084 uint16 speed = buf->ReadWord();
1085 if (speed == 0xFFFF) speed = 0;
1092 rvi->
power = buf->ReadWord();
1095 if (rvi->
power != 0) {
1118 if (spriteid < 0xFD) spriteid >>= 1;
1120 if (IsValidNewGRFImageIndex<VEH_TRAIN>(spriteid)) {
1123 grfmsg(1,
"RailVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1124 rvi->image_index = 0;
1130 uint8 dual = buf->ReadByte();
1135 rvi->railveh_type = rvi->
power == 0 ?
1147 uint8 ctype = buf->ReadByte();
1149 if (ctype == 0xFF) {
1152 }
else if (_cur.
grffile->grf_version >= 8) {
1157 ei->cargo_type = ctype;
1160 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1166 SB(rvi->
weight, 0, 8, buf->ReadByte());
1174 grfmsg(2,
"RailVehicleChangeInfo: Property 0x18 'AI rank' not used by NoAI, ignored.");
1186 uint8 traction = buf->ReadByte();
1189 if (traction <= 0x07) {
1191 }
else if (traction <= 0x27) {
1193 }
else if (traction <= 0x31) {
1195 }
else if (traction <= 0x37) {
1197 }
else if (traction <= 0x41) {
1206 if (_gted[e->
index].railtypelabel == RAILTYPE_RAIL_LABEL && engclass >=
EC_ELECTRIC) _gted[e->
index].railtypelabel = RAILTYPE_ELECTRIC_LABEL;
1207 if (_gted[e->
index].railtypelabel == RAILTYPE_ELECTRIC_LABEL && engclass <
EC_ELECTRIC) _gted[e->
index].railtypelabel = RAILTYPE_RAIL_LABEL;
1223 ei->refit_cost = buf->ReadByte();
1227 uint32 mask = buf->ReadDWord();
1265 byte weight = buf->ReadByte();
1268 grfmsg(2,
"RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8);
1290 _gted[e->
index].cargo_allowed = buf->ReadWord();
1296 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1310 uint8 count = buf->ReadByte();
1344 for (
int i = 0; i < numinfo; i++) {
1357 rvi->running_cost = buf->ReadByte();
1369 if (spriteid == 0xFF) spriteid = 0xFD;
1371 if (spriteid < 0xFD) spriteid >>= 1;
1373 if (IsValidNewGRFImageIndex<VEH_ROAD>(spriteid)) {
1376 grfmsg(1,
"RoadVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1377 rvi->image_index = 0;
1383 rvi->capacity = buf->ReadByte();
1388 uint8 ctype = buf->ReadByte();
1390 if (ctype == 0xFF) {
1393 }
else if (_cur.
grffile->grf_version >= 8) {
1398 ei->cargo_type = ctype;
1401 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1407 rvi->cost_factor = buf->ReadByte();
1415 rvi->
power = buf->ReadByte();
1419 rvi->
weight = buf->ReadByte();
1427 uint32 mask = buf->ReadDWord();
1447 ei->refit_cost = buf->ReadByte();
1460 _gted[e->
index].cargo_allowed = buf->ReadWord();
1466 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1498 uint8 count = buf->ReadByte();
1532 for (
int i = 0; i < numinfo; i++) {
1545 if (spriteid == 0xFF) spriteid = 0xFD;
1547 if (spriteid < 0xFD) spriteid >>= 1;
1549 if (IsValidNewGRFImageIndex<VEH_SHIP>(spriteid)) {
1552 grfmsg(1,
"ShipVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1553 svi->image_index = 0;
1563 svi->cost_factor = buf->ReadByte();
1572 uint8 ctype = buf->ReadByte();
1574 if (ctype == 0xFF) {
1577 }
else if (_cur.
grffile->grf_version >= 8) {
1582 ei->cargo_type = ctype;
1585 grfmsg(2,
"RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
1591 svi->capacity = buf->ReadWord();
1595 svi->running_cost = buf->ReadByte();
1603 uint32 mask = buf->ReadDWord();
1615 ei->refit_cost = buf->ReadByte();
1636 _gted[e->
index].cargo_allowed = buf->ReadWord();
1642 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1670 uint8 count = buf->ReadByte();
1704 for (
int i = 0; i < numinfo; i++) {
1717 if (spriteid == 0xFF) spriteid = 0xFD;
1719 if (spriteid < 0xFD) spriteid >>= 1;
1721 if (IsValidNewGRFImageIndex<VEH_AIRCRAFT>(spriteid)) {
1724 grfmsg(1,
"AircraftVehicleChangeInfo: Invalid Sprite %d specified, ignoring", orig_spriteid);
1725 avi->image_index = 0;
1731 if (buf->ReadByte() == 0) {
1739 SB(avi->
subtype, 1, 1, (buf->ReadByte() != 0 ? 1 : 0));
1743 avi->cost_factor = buf->ReadByte();
1747 avi->
max_speed = (buf->ReadByte() * 128) / 10;
1751 avi->acceleration = buf->ReadByte();
1755 avi->running_cost = buf->ReadByte();
1771 uint32 mask = buf->ReadDWord();
1783 ei->refit_cost = buf->ReadByte();
1796 _gted[e->
index].cargo_allowed = buf->ReadWord();
1802 _gted[e->
index].cargo_disallowed = buf->ReadWord();
1820 uint8 count = buf->ReadByte();
1866 for (
int i = 0; i < numinfo; i++) {
1870 if (statspec == NULL && prop != 0x08) {
1871 grfmsg(2,
"StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i);
1880 if (*spec == NULL) *spec = CallocT<StationSpec>(1);
1883 uint32 classid = buf->ReadDWord();
1884 (*spec)->cls_id = StationClass::Allocate(
BSWAP32(classid));
1889 statspec->
tiles = buf->ReadExtendedByte();
1893 for (uint t = 0; t < statspec->
tiles; t++) {
1897 if (buf->HasData(4) && *(uint32*)buf->Data() == 0) {
1900 dts->
Clone(&_station_display_datas_rail[t % 8]);
1915 dtss->
delta_x = buf->ReadByte();
1917 dtss->delta_y = buf->ReadByte();
1918 dtss->
delta_z = buf->ReadByte();
1919 dtss->size_x = buf->ReadByte();
1920 dtss->size_y = buf->ReadByte();
1921 dtss->size_z = buf->ReadByte();
1932 byte srcid = buf->ReadByte();
1935 if (srcstatspec == NULL) {
1936 grfmsg(1,
"StationChangeInfo: Station %u is not defined, cannot copy sprite layout to %u.", srcid, stid + i);
1944 for (uint t = 0; t < statspec->
tiles; t++) {
1963 statspec->copied_layouts =
false;
1965 while (buf->HasData()) {
1966 byte length = buf->ReadByte();
1967 byte number = buf->ReadByte();
1968 StationLayout layout;
1971 if (length == 0 || number == 0)
break;
1973 if (length > statspec->lengths) {
1974 byte diff_length = length - statspec->lengths;
1975 statspec->platforms =
ReallocT(statspec->platforms, length);
1976 memset(statspec->platforms + statspec->lengths, 0, diff_length);
1978 statspec->layouts =
ReallocT(statspec->layouts, length);
1979 memset(statspec->layouts + statspec->lengths, 0, diff_length *
sizeof(*statspec->layouts));
1981 statspec->lengths = length;
1985 if (number > statspec->platforms[l]) {
1986 statspec->layouts[l] =
ReallocT(statspec->layouts[l], number);
1988 memset(statspec->layouts[l] + statspec->platforms[l], 0,
1989 (number - statspec->platforms[l]) *
sizeof(**statspec->layouts));
1991 statspec->platforms[l] = number;
1995 layout = MallocT<byte>(length * number);
1997 for (l = 0; l < length; l++) {
1998 for (p = 0; p < number; p++) {
1999 layout[l * number + p] = buf->ReadByte();
2009 free(statspec->layouts[l][p]);
2010 statspec->layouts[l][p] = layout;
2015 byte srcid = buf->ReadByte();
2018 if (srcstatspec == NULL) {
2019 grfmsg(1,
"StationChangeInfo: Station %u is not defined, cannot copy tile layout to %u.", srcid, stid + i);
2023 statspec->lengths = srcstatspec->lengths;
2024 statspec->platforms = srcstatspec->platforms;
2025 statspec->layouts = srcstatspec->layouts;
2026 statspec->copied_layouts =
true;
2035 statspec->
pylons = buf->ReadByte();
2039 if (_cur.
grffile->grf_version >= 7) {
2047 statspec->
flags = buf->ReadByte();
2051 statspec->
wires = buf->ReadByte();
2055 statspec->
blocked = buf->ReadByte();
2059 statspec->animation.
frames = buf->ReadByte();
2060 statspec->animation.
status = buf->ReadByte();
2064 statspec->animation.
speed = buf->ReadByte();
2068 statspec->animation.
triggers = buf->ReadWord();
2072 statspec->
tiles = buf->ReadExtendedByte();
2076 for (uint t = 0; t < statspec->
tiles; t++) {
2078 uint num_building_sprites = buf->ReadByte();
2105 if (
id + numinfo > CF_END) {
2106 grfmsg(1,
"CanalChangeInfo: Canal feature 0x%02X is invalid, max %u, ignoring",
id + numinfo, CF_END);
2110 for (
int i = 0; i < numinfo; i++) {
2119 cp->
flags = buf->ReadByte();
2144 grfmsg(1,
"BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo,
MAX_BRIDGES);
2148 for (
int i = 0; i < numinfo; i++) {
2154 byte year = buf->ReadByte();
2169 bridge->
price = buf->ReadByte();
2173 bridge->
speed = buf->ReadWord();
2177 byte tableid = buf->ReadByte();
2178 byte numtables = buf->ReadByte();
2185 for (; numtables-- != 0; tableid++) {
2187 grfmsg(1,
"BridgeChangeInfo: Table %d >= 7, skipping", tableid);
2193 bridge->
sprite_table[tableid] = MallocT<PalSpriteID>(32);
2210 bridge->
flags = buf->ReadByte();
2219 if (newone != STR_UNDEFINED) bridge->
material = newone;
2226 if (newone != STR_UNDEFINED) bridge->
transport_name[prop - 0x11] = newone;
2231 bridge->
price = buf->ReadWord();
2288 for (uint j = 0; j < 4; j++) buf->ReadByte();
2292 byte count = buf->ReadByte();
2293 for (byte j = 0; j < count; j++) buf->ReadByte();
2298 buf->Skip(buf->ReadByte() * 2);
2321 grfmsg(1,
"TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo,
NUM_HOUSES_PER_GRF);
2326 if (_cur.
grffile->housespec == NULL) {
2330 for (
int i = 0; i < numinfo; i++) {
2333 if (prop != 0x08 && housespec == NULL) {
2336 if (cir > ret) ret = cir;
2343 byte subs_id = buf->ReadByte();
2345 if (subs_id == 0xFF) {
2348 HouseSpec::Get(hid + i)->
enabled =
false;
2352 grfmsg(2,
"TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i);
2357 if (*house == NULL) *house = CallocT<HouseSpec>(1);
2361 MemCpyT(housespec, HouseSpec::Get(subs_id));
2363 housespec->enabled =
true;
2364 housespec->grf_prop.local_id = hid + i;
2365 housespec->grf_prop.subst_id = subs_id;
2366 housespec->grf_prop.grffile = _cur.
grffile;
2367 housespec->random_colour[0] = 0x04;
2368 housespec->random_colour[1] = 0x08;
2369 housespec->random_colour[2] = 0x0C;
2370 housespec->random_colour[3] = 0x06;
2377 housespec->cargo_acceptance[2] = 0;
2389 uint16 years = buf->ReadWord();
2409 int8 goods = buf->ReadByte();
2445 byte
override = buf->ReadByte();
2449 grfmsg(2,
"TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.",
override, hid + i);
2453 _house_mngr.
Add(hid + i, _cur.
grffile->grfid,
override);
2462 for (uint j = 0; j < 4; j++) housespec->
random_colour[j] = buf->ReadByte();
2484 housespec->
class_id = AllocateHouseClassID(buf->ReadByte(), _cur.
grffile->grfid);
2492 uint32 cargotypes = buf->ReadDWord();
2495 if (cargotypes == 0xFFFFFFFF)
break;
2497 for (uint j = 0; j < 3; j++) {
2499 uint8 cargo_part =
GB(cargotypes, 8 * j, 8);
2517 byte count = buf->ReadByte();
2518 for (byte j = 0; j < count; j++) {
2526 housespec->
min_year = buf->ReadWord();
2530 housespec->
max_year = buf->ReadWord();
2534 uint count = buf->ReadByte();
2586 template <
typename T>
2590 grfmsg(1,
"LoadTranslationTable: %s translation table must start at zero", name);
2594 translation_table.Clear();
2595 for (
int i = 0; i < numinfo; i++) {
2596 uint32 item = buf->ReadDWord();
2597 *translation_table.Append() =
BSWAP32(item);
2627 for (
int i = 0; i < numinfo; i++) {
2630 int factor = buf->ReadByte();
2631 uint price = gvid + i;
2633 if (price < PR_END) {
2636 grfmsg(1,
"GlobalVarChangeInfo: Price %d out of range, ignoring", price);
2645 if ((newone != STR_UNDEFINED) && (curidx <
CURRENCY_END)) {
2653 uint32 rate = buf->ReadDWord();
2661 grfmsg(1,
"GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx);
2668 uint16 options = buf->ReadWord();
2677 grfmsg(1,
"GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx);
2684 uint32 tempfix = buf->ReadDWord();
2690 grfmsg(1,
"GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2697 uint32 tempfix = buf->ReadDWord();
2703 grfmsg(1,
"GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
2710 Year year_euro = buf->ReadWord();
2715 grfmsg(1,
"GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx);
2722 grfmsg(1,
"GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo);
2724 grfmsg(1,
"GlobalVarChangeInfo: Not enough entries set in the snowline table (" PRINTF_SIZE
")", buf->Remaining());
2730 table[i][j] = buf->ReadByte();
2731 if (_cur.
grffile->grf_version >= 8) {
2734 if (table[i][j] >= 128) {
2756 uint curidx = gvid + i;
2759 grfmsg(1,
"GlobalVarChangeInfo: Language %d is not known, ignoring", curidx);
2764 while (buf->ReadByte() != 0) {
2774 uint plural_form = buf->ReadByte();
2775 if (plural_form >= LANGUAGE_MAX_PLURAL) {
2776 grfmsg(1,
"GlobalVarChanceInfo: Plural form %d is out of range, ignoring", plural_form);
2783 byte newgrf_id = buf->ReadByte();
2784 while (newgrf_id != 0) {
2785 const char *name = buf->ReadString();
2800 grfmsg(1,
"GlobalVarChangeInfo: Gender name %s is not known, ignoring", name);
2807 grfmsg(1,
"GlobalVarChangeInfo: Case name %s is not known, ignoring", name);
2812 newgrf_id = buf->ReadByte();
2842 for (
int i = 0; i < numinfo; i++) {
2866 uint32 s = buf->ReadDWord();
2867 uint32 t = buf->ReadDWord();
2874 while (buf->ReadByte() != 0) {
2902 grfmsg(2,
"CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo,
NUM_CARGO - 1);
2906 for (
int i = 0; i < numinfo; i++) {
2911 cs->
bitnum = buf->ReadByte();
2949 cs->
sprite = buf->ReadWord();
2953 cs->
weight = buf->ReadByte();
2957 cs->transit_days[0] = buf->ReadByte();
2961 cs->transit_days[1] = buf->ReadByte();
2965 cs->initial_payment = buf->ReadDWord();
2969 cs->rating_colour = buf->ReadByte();
2973 cs->legend_colour = buf->ReadByte();
2981 cs->
classes = buf->ReadWord();
2985 cs->
label = buf->ReadDWord();
2990 uint8 substitute_type = buf->ReadByte();
2992 switch (substitute_type) {
2999 grfmsg(1,
"CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type);
3015 cs->
multiplier = max<uint16>(1u, buf->ReadWord());
3040 if (_cur.
grffile->sound_offset == 0) {
3041 grfmsg(1,
"SoundEffectChangeInfo: No effects defined, skipping");
3046 grfmsg(1,
"SoundEffectChangeInfo: Attempting to change undefined sound effect (%u), max (%u). Ignoring.", sid + numinfo,
ORIGINAL_SAMPLE_COUNT + _cur.
grffile->num_sounds);
3050 for (
int i = 0; i < numinfo; i++) {
3055 sound->volume = buf->ReadByte();
3059 sound->priority = buf->ReadByte();
3063 SoundID orig_sound = buf->ReadByte();
3068 SoundEntry *old_sound = GetSound(orig_sound);
3071 *old_sound = *sound;
3113 buf->Skip(buf->ReadByte() * 2);
3141 if (_cur.
grffile->indtspec == NULL) {
3145 for (
int i = 0; i < numinfo; i++) {
3148 if (prop != 0x08 && tsp == NULL) {
3150 if (cir > ret) ret = cir;
3157 byte subs_id = buf->ReadByte();
3161 grfmsg(2,
"IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i);
3166 if (*tilespec == NULL) {
3167 *tilespec = CallocT<IndustryTileSpec>(1);
3170 memcpy(tsp, &_industry_tile_specs[subs_id],
sizeof(_industry_tile_specs[subs_id]));
3171 tsp->enabled =
true;
3179 tsp->grf_prop.local_id = indtid + i;
3180 tsp->grf_prop.subst_id = subs_id;
3181 tsp->grf_prop.grffile = _cur.
grffile;
3188 byte ovrid = buf->ReadByte();
3192 grfmsg(2,
"IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i);
3196 _industile_mngr.
Add(indtid + i, _cur.
grffile->grfid, ovrid);
3203 uint16 acctp = buf->ReadWord();
3235 byte num_cargoes = buf->ReadByte();
3242 if (i < num_cargoes) {
3309 byte num_table = buf->ReadByte();
3310 for (byte j = 0; j < num_table; j++) {
3311 for (uint k = 0;; k++) {
3312 byte x = buf->ReadByte();
3313 if (x == 0xFE && k == 0) {
3319 byte y = buf->ReadByte();
3320 if (x == 0 && y == 0x80)
break;
3322 byte gfx = buf->ReadByte();
3323 if (gfx == 0xFE) buf->ReadWord();
3330 for (byte j = 0; j < 3; j++) buf->ReadByte();
3337 buf->Skip(buf->ReadByte());
3341 int num_inputs = buf->ReadByte();
3342 int num_outputs = buf->ReadByte();
3343 buf->Skip(num_inputs * num_outputs * 2);
3362 for (
int i = 0; i < size - 1; i++) {
3363 for (
int j = i + 1; j < size; j++) {
3364 if (layout[i].ti.x == layout[j].ti.
x &&
3365 layout[i].ti.
y == layout[j].ti.
y) {
3377 for (
int j = 0; j < ind->
num_table; j++) {
3405 if (_cur.
grffile->industryspec == NULL) {
3409 for (
int i = 0; i < numinfo; i++) {
3412 if (prop != 0x08 && indsp == NULL) {
3414 if (cir > ret) ret = cir;
3421 byte subs_id = buf->ReadByte();
3423 if (subs_id == 0xFF) {
3426 _industry_specs[indid + i].
enabled =
false;
3430 grfmsg(2,
"_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i);
3437 if (*indspec == NULL) {
3438 *indspec = CallocT<IndustrySpec>(1);
3441 memcpy(indsp, &_origin_industry_specs[subs_id],
sizeof(_industry_specs[subs_id]));
3442 indsp->enabled =
true;
3443 indsp->grf_prop.local_id = indid + i;
3444 indsp->grf_prop.subst_id = subs_id;
3445 indsp->grf_prop.grffile = _cur.
grffile;
3454 byte ovrid = buf->ReadByte();
3458 grfmsg(2,
"IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i);
3462 _industry_mngr.
Add(indid + i, _cur.
grffile->grfid, ovrid);
3467 byte new_num_layouts = buf->ReadByte();
3473 uint32 def_num_tiles = buf->ReadDWord() / 3 + 1;
3480 for (byte j = 0; j < new_num_layouts; j++) {
3481 for (uint k = 0;; k++) {
3482 if (k >= def_num_tiles) {
3483 grfmsg(3,
"IndustriesChangeInfo: Incorrect size for industry tile layout definition for industry %u.", indid);
3486 itt = ReallocT<IndustryTileTable>(itt, def_num_tiles);
3489 itt[k].ti.x = buf->ReadByte();
3491 if (itt[k].ti.x == 0xFE && k == 0) {
3493 IndustryType type = buf->ReadByte();
3494 byte laynbr = buf->ReadByte();
3496 copy_from = _origin_industry_specs[type].table[laynbr];
3497 for (size = 1;; size++) {
3498 if (copy_from[size - 1].ti.x == -0x80 && copy_from[size - 1].ti.
y == 0)
break;
3503 itt[k].ti.
y = buf->ReadByte();
3505 if (itt[k].ti.x == 0 && itt[k].ti.y == 0x80) {
3508 itt[k].ti.x = -0x80;
3517 itt[k].gfx = buf->ReadByte();
3519 if (itt[k].gfx == 0xFE) {
3521 int local_tile_id = buf->ReadWord();
3524 int tempid = _industile_mngr.
GetID(local_tile_id, _cur.
grffile->grfid);
3527 grfmsg(2,
"IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid);
3530 itt[k].gfx = tempid;
3532 }
else if (itt[k].gfx == 0xFF) {
3533 itt[k].ti.x = (int8)
GB(itt[k].ti.x, 0, 8);
3534 itt[k].ti.y = (int8)
GB(itt[k].ti.y, 0, 8);
3543 if (_cur.
grffile->grf_version < 8 && itt[k].ti.x < 0) itt[k].ti.y += 1;
3549 grfmsg(1,
"IndustriesChangeInfo: Invalid industry layout for industry id %u. Ignoring", indid);
3553 tile_table[j] = CallocT<IndustryTileTable>(size);
3554 memcpy(tile_table[j], copy_from,
sizeof(*copy_from) * size);
3558 for (
int i = 0; i < new_num_layouts; i++) {
3559 free(tile_table[i]);
3570 indsp->
table = tile_table;
3597 for (byte j = 0; j < 2; j++) {
3603 for (byte j = 0; j < 3; j++) {
3611 indsp->production_rate[prop - 0x12] = buf->ReadByte();
3624 sounds[j] = buf->ReadByte();
3640 for (byte j = 0; j < 3; j++) indsp->
conflicting[j] = buf->ReadByte();
3666 uint32 multiples = buf->ReadDWord();
3682 byte aflag = buf->ReadByte();
3692 uint16 str = buf->ReadWord();
3702 byte num_cargoes = buf->ReadByte();
3703 if (num_cargoes >
lengthof(indsp->produced_cargo)) {
3708 for (uint i = 0; i <
lengthof(indsp->produced_cargo); i++) {
3709 if (i < num_cargoes) {
3711 indsp->produced_cargo[i] = cargo;
3720 byte num_cargoes = buf->ReadByte();
3727 if (i < num_cargoes) {
3738 byte num_cargoes = buf->ReadByte();
3739 if (num_cargoes >
lengthof(indsp->production_rate)) {
3744 for (uint i = 0; i <
lengthof(indsp->production_rate); i++) {
3745 if (i < num_cargoes) {
3746 indsp->production_rate[i] = buf->ReadByte();
3748 indsp->production_rate[i] = 0;
3755 byte num_inputs = buf->ReadByte();
3756 byte num_outputs = buf->ReadByte();
3763 for (uint j = 0; j <
lengthof(indsp->produced_cargo); j++) {
3765 if (i < num_inputs && j < num_outputs) mult = buf->ReadWord();
3789 for (
int i = 0; i < as->
num_table; i++) {
3794 }
while ((++it)->ti.x != -0x80);
3795 table_list[i] = MallocT<AirportTileTable>(num_tiles);
3798 as->
table = table_list;
3820 grfmsg(1,
"AirportChangeInfo: Too many airports, trying id (%u), max (%u). Ignoring.", airport + numinfo,
NUM_AIRPORTS_PER_GRF);
3825 if (_cur.
grffile->airportspec == NULL) {
3829 for (
int i = 0; i < numinfo; i++) {
3832 if (as == NULL && prop != 0x08 && prop != 0x09) {
3833 grfmsg(2,
"AirportChangeInfo: Attempt to modify undefined airport %u, ignoring", airport + i);
3839 byte subs_id = buf->ReadByte();
3841 if (subs_id == 0xFF) {
3848 grfmsg(2,
"AirportChangeInfo: Attempt to use new airport %u as substitute airport for %u. Ignoring.", subs_id, airport + i);
3856 if (*spec == NULL) {
3857 *spec = MallocT<AirportSpec>(1);
3862 as->grf_prop.local_id = airport + i;
3863 as->grf_prop.subst_id = subs_id;
3864 as->grf_prop.grffile = _cur.
grffile;
3866 _airport_mngr.
Add(airport + i, _cur.
grffile->grfid, subs_id);
3877 uint32 defsize = buf->ReadDWord();
3883 for (byte j = 0; j < as->
num_table; j++) {
3885 for (
int k = 0;; k++) {
3886 att[k].ti.x = buf->ReadByte();
3887 att[k].ti.y = buf->ReadByte();
3889 if (att[k].ti.x == 0 && att[k].ti.y == 0x80) {
3892 att[k].ti.x = -0x80;
3901 att[k].
gfx = buf->ReadByte();
3903 if (att[k].gfx == 0xFE) {
3905 int local_tile_id = buf->ReadWord();
3908 uint16 tempid = _airporttile_mngr.
GetID(local_tile_id, _cur.
grffile->grfid);
3911 grfmsg(2,
"AirportChangeInfo: Attempt to use airport tile %u with airport id %u, not yet defined. Ignoring.", local_tile_id, airport + i);
3914 att[k].gfx = tempid;
3916 }
else if (att[k].gfx == 0xFF) {
3917 att[k].ti.x = (int8)
GB(att[k].ti.x, 0, 8);
3918 att[k].ti.y = (int8)
GB(att[k].ti.y, 0, 8);
3929 tile_table[j] = CallocT<AirportTileTable>(size);
3930 memcpy(tile_table[j], copy_from,
sizeof(*copy_from) * size);
3933 as->
table = tile_table;
3936 for (
int i = 0; i < as->
num_table; i++) {
3937 free(tile_table[i]);
4043 if (_cur.
grffile->objectspec == NULL) {
4047 for (
int i = 0; i < numinfo; i++) {
4050 if (prop != 0x08 && spec == NULL) {
4053 if (cir > ret) ret = cir;
4062 if (*ospec == NULL) {
4063 *ospec = CallocT<ObjectSpec>(1);
4064 (*ospec)->
views = 1;
4068 uint32 classid = buf->ReadDWord();
4069 (*ospec)->cls_id = ObjectClass::Allocate(
BSWAP32(classid));
4070 (*ospec)->enabled =
true;
4085 spec->
climate = buf->ReadByte();
4089 spec->
size = buf->ReadByte();
4132 spec->
height = buf->ReadByte();
4136 spec->
views = buf->ReadByte();
4138 grfmsg(2,
"ObjectChangeInfo: Invalid number of views (%u) for object id %u. Ignoring.", spec->
views,
id + i);
4171 grfmsg(1,
"RailTypeChangeInfo: Rail type %u is invalid, max %u, ignoring",
id + numinfo,
RAILTYPE_END);
4175 for (
int i = 0; i < numinfo; i++) {
4188 uint16 str = buf->ReadWord();
4190 if (_cur.
grffile->grf_version < 8) {
4220 int n = buf->ReadByte();
4221 for (
int j = 0; j != n; j++) {
4222 RailTypeLabel label = buf->ReadDWord();
4282 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4301 grfmsg(1,
"RailTypeReserveInfo: Rail type %u is invalid, max %u, ignoring",
id + numinfo,
RAILTYPE_END);
4305 for (
int i = 0; i < numinfo; i++) {
4309 RailTypeLabel rtl = buf->ReadDWord();
4318 _cur.
grffile->railtype_map[
id + i] = rt;
4336 int n = buf->ReadByte();
4337 for (
int j = 0; j != n; j++) {
4342 grfmsg(1,
"RailTypeReserveInfo: Ignoring property 1D for rail type %u because no label was set",
id + i);
4349 for (
int j = buf->ReadByte(); j != 0; j--) buf->ReadDWord();
4384 if (_cur.
grffile->airtspec == NULL) {
4388 for (
int i = 0; i < numinfo; i++) {
4391 if (prop != 0x08 && tsp == NULL) {
4392 grfmsg(2,
"AirportTileChangeInfo: Attempt to modify undefined airport tile %u. Ignoring.", airtid + i);
4399 byte subs_id = buf->ReadByte();
4403 grfmsg(2,
"AirportTileChangeInfo: Attempt to use new airport tile %u as substitute airport tile for %u. Ignoring.", subs_id, airtid + i);
4408 if (*tilespec == NULL) {
4409 *tilespec = CallocT<AirportTileSpec>(1);
4413 tsp->enabled =
true;
4417 tsp->grf_prop.local_id = airtid + i;
4418 tsp->grf_prop.subst_id = subs_id;
4419 tsp->grf_prop.grffile = _cur.
grffile;
4426 byte
override = buf->ReadByte();
4430 grfmsg(2,
"AirportTileChangeInfo: Attempt to override new airport tile %u with airport tile id %u. Ignoring.",
override, airtid + i);
4434 _airporttile_mngr.
Add(airtid + i, _cur.
grffile->grfid,
override);
4464 static bool HandleChangeInfoResult(
const char *caller,
ChangeInfoResult cir, uint8 feature, uint8 property)
4467 default: NOT_REACHED();
4477 grfmsg(1,
"%s: Ignoring property 0x%02X of feature 0x%02X (not implemented)", caller, property, feature);
4481 grfmsg(0,
"%s: Unknown property 0x%02X of feature 0x%02X, disabling", caller, property, feature);
4494 static void FeatureChangeInfo(
ByteReader *buf)
4507 static const VCI_Handler handler[] = {
4525 AirportTilesChangeInfo,
4528 uint8 feature = buf->ReadByte();
4529 uint8 numprops = buf->ReadByte();
4530 uint numinfo = buf->ReadByte();
4531 uint engine = buf->ReadExtendedByte();
4533 if (feature >= GSF_END) {
4534 grfmsg(1,
"FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4538 grfmsg(6,
"FeatureChangeInfo: Feature 0x%02X, %d properties, to apply to %d+%d",
4539 feature, numprops, engine, numinfo);
4541 if (feature >=
lengthof(handler) || handler[feature] == NULL) {
4542 if (feature != GSF_CARGOES)
grfmsg(1,
"FeatureChangeInfo: Unsupported feature 0x%02X, skipping", feature);
4549 while (numprops-- && buf->HasData()) {
4550 uint8 prop = buf->ReadByte();
4553 if (HandleChangeInfoResult(
"FeatureChangeInfo", cir, feature, prop))
return;
4560 uint8 feature = buf->ReadByte();
4561 uint8 numprops = buf->ReadByte();
4562 uint numinfo = buf->ReadByte();
4563 buf->ReadExtendedByte();
4565 if (feature == GSF_BRIDGES && numprops == 1) {
4566 uint8 prop = buf->ReadByte();
4569 if (prop == 0x0D)
return;
4570 }
else if (feature == GSF_GLOBALVAR && numprops == 1) {
4571 uint8 prop = buf->ReadByte();
4574 bool is_safe =
true;
4575 for (uint i = 0; i < numinfo; i++) {
4576 uint32 s = buf->ReadDWord();
4584 if (is_safe)
return;
4595 static void ReserveChangeInfo(
ByteReader *buf)
4597 uint8 feature = buf->ReadByte();
4599 if (feature != GSF_CARGOES && feature != GSF_GLOBALVAR && feature != GSF_RAILTYPES)
return;
4601 uint8 numprops = buf->ReadByte();
4602 uint8 numinfo = buf->ReadByte();
4603 uint8 index = buf->ReadExtendedByte();
4605 while (numprops-- && buf->HasData()) {
4606 uint8 prop = buf->ReadByte();
4610 default: NOT_REACHED();
4616 cir = GlobalVarReserveInfo(index, numinfo, prop, buf);
4620 cir = RailTypeReserveInfo(index, numinfo, prop, buf);
4624 if (HandleChangeInfoResult(
"ReserveChangeInfo", cir, feature, prop))
return;
4645 uint8 feature = buf->ReadByte();
4646 uint16 num_sets = buf->ReadByte();
4647 uint16 first_set = 0;
4649 if (num_sets == 0 && buf->HasData(3)) {
4652 first_set = buf->ReadExtendedByte();
4653 num_sets = buf->ReadExtendedByte();
4655 uint16 num_ents = buf->ReadExtendedByte();
4657 if (feature >= GSF_END) {
4659 grfmsg(1,
"NewSpriteSet: Unsupported feature 0x%02X, skipping %d sprites", feature, _cur.
skip_sprites);
4665 grfmsg(7,
"New sprite set at %d of feature 0x%02X, consisting of %d sets with %d views each (total %d)",
4666 _cur.
spriteid, feature, num_sets, num_ents, num_sets * num_ents
4669 for (
int i = 0; i < num_sets * num_ents; i++) {
4679 uint16 num_sets = buf->ReadByte();
4681 if (num_sets == 0 && buf->HasData(3)) {
4684 buf->ReadExtendedByte();
4685 num_sets = buf->ReadExtendedByte();
4687 uint16 num_ents = buf->ReadExtendedByte();
4696 static const SpriteGroup *GetGroupFromGroupID(byte setid, byte type, uint16 groupid)
4698 if (
HasBit(groupid, 15)) {
4703 if (groupid >
MAX_SPRITEGROUP || _cur.spritegroups[groupid] == NULL) {
4704 grfmsg(1,
"GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid);
4708 return _cur.spritegroups[groupid];
4721 if (
HasBit(spriteid, 15)) {
4727 grfmsg(1,
"CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid", setid, type, spriteid);
4735 assert(spriteset_start + num_sprites <= _cur.
spriteid);
4756 uint8 feature = buf->ReadByte();
4757 if (feature >= GSF_END) {
4758 grfmsg(1,
"NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
4762 uint8 setid = buf->ReadByte();
4763 uint8 type = buf->ReadByte();
4786 switch (
GB(type, 2, 2)) {
4787 default: NOT_REACHED();
4788 case 0: group->size = DSG_SIZE_BYTE; varsize = 1;
break;
4789 case 1: group->size = DSG_SIZE_WORD; varsize = 2;
break;
4790 case 2: group->size = DSG_SIZE_DWORD; varsize = 4;
break;
4803 adjust->variable = buf->ReadByte();
4804 if (adjust->variable == 0x7E) {
4806 adjust->subroutine = GetGroupFromGroupID(setid, type, buf->ReadByte());
4811 varadjust = buf->ReadByte();
4812 adjust->shift_num =
GB(varadjust, 0, 5);
4813 adjust->type = (DeterministicSpriteGroupAdjustType)
GB(varadjust, 6, 2);
4814 adjust->and_mask = buf->ReadVarSize(varsize);
4816 if (adjust->type != DSGA_TYPE_NONE) {
4817 adjust->add_val = buf->ReadVarSize(varsize);
4818 adjust->divmod_val = buf->ReadVarSize(varsize);
4820 adjust->add_val = 0;
4821 adjust->divmod_val = 0;
4825 }
while (
HasBit(varadjust, 5));
4827 group->num_adjusts = adjusts.
Length();
4828 group->adjusts = MallocT<DeterministicSpriteGroupAdjust>(group->num_adjusts);
4829 MemCpyT(group->adjusts, adjusts.
Begin(), group->num_adjusts);
4831 std::vector<DeterministicSpriteGroupRange> ranges;
4832 ranges.resize(buf->ReadByte());
4833 for (uint i = 0; i < ranges.size(); i++) {
4834 ranges[i].group = GetGroupFromGroupID(setid, type, buf->ReadWord());
4835 ranges[i].low = buf->ReadVarSize(varsize);
4836 ranges[i].high = buf->ReadVarSize(varsize);
4839 group->default_group = GetGroupFromGroupID(setid, type, buf->ReadWord());
4840 group->error_group = ranges.size() > 0 ? ranges[0].group : group->default_group;
4842 group->calculated_result = ranges.size() == 0;
4845 std::vector<uint32> bounds;
4846 for (uint i = 0; i < ranges.size(); i++) {
4847 bounds.push_back(ranges[i].low);
4848 if (ranges[i].high != UINT32_MAX) bounds.push_back(ranges[i].high + 1);
4850 std::sort(bounds.begin(), bounds.end());
4851 bounds.erase(std::unique(bounds.begin(), bounds.end()), bounds.end());
4853 std::vector<const SpriteGroup *> target;
4854 for (uint j = 0; j < bounds.size(); ++j) {
4855 uint32 v = bounds[j];
4857 for (uint i = 0; i < ranges.size(); i++) {
4858 if (ranges[i].low <= v && v <= ranges[i].high) {
4859 t = ranges[i].group;
4863 target.push_back(t);
4865 assert(target.size() == bounds.size());
4867 std::vector<DeterministicSpriteGroupRange> optimised;
4868 for (uint j = 0; j < bounds.size(); ) {
4869 if (target[j] != group->default_group) {
4871 r.group = target[j];
4873 while (j < bounds.size() && target[j] == r.group) {
4876 r.high = j < bounds.size() ? bounds[j] - 1 : UINT32_MAX;
4877 optimised.push_back(r);
4883 group->num_ranges = (uint)optimised.size();
4884 if (group->num_ranges > 0) {
4885 group->ranges = MallocT<DeterministicSpriteGroupRange>(group->num_ranges);
4886 MemCpyT(group->ranges, &optimised.front(), group->num_ranges);
4903 group->count = buf->ReadByte();
4906 uint8 triggers = buf->ReadByte();
4907 group->triggers =
GB(triggers, 0, 7);
4908 group->
cmp_mode =
HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY;
4913 for (uint i = 0; i < group->
num_groups; i++) {
4914 group->
groups[i] = GetGroupFromGroupID(setid, type, buf->ReadWord());
4925 case GSF_ROADVEHICLES:
4934 byte num_loaded = type;
4935 byte num_loading = buf->ReadByte();
4938 grfmsg(0,
"NewSpriteGroup: No sprite set to work on! Skipping");
4948 if (num_loaded > 0) group->
loaded = CallocT<const SpriteGroup*>(num_loaded);
4949 if (num_loading > 0) group->
loading = CallocT<const SpriteGroup*>(num_loading);
4951 grfmsg(6,
"NewSpriteGroup: New SpriteGroup 0x%02X, %u loaded, %u loading",
4952 setid, num_loaded, num_loading);
4954 for (uint i = 0; i < num_loaded; i++) {
4957 grfmsg(8,
"NewSpriteGroup: + rg->loaded[%i] = subset %u", i, spriteid);
4960 for (uint i = 0; i < num_loading; i++) {
4963 grfmsg(8,
"NewSpriteGroup: + rg->loading[%i] = subset %u", i, spriteid);
4970 case GSF_AIRPORTTILES:
4972 case GSF_INDUSTRYTILES: {
4973 byte num_building_sprites =
max((uint8)1, type);
4980 if (
ReadSpriteLayout(buf, num_building_sprites,
true, feature,
false, type == 0, &group->dts))
return;
4984 case GSF_INDUSTRIES: {
4986 grfmsg(1,
"NewSpriteGroup: Unsupported industry production version %d, skipping", type);
4996 for (uint i = 0; i < 3; i++) {
5000 for (uint i = 0; i < 2; i++) {
5003 group->again = buf->ReadByte();
5004 }
else if (type == 1) {
5006 for (uint i = 0; i < 3; i++) {
5010 for (uint i = 0; i < 2; i++) {
5013 group->again = buf->ReadByte();
5014 }
else if (type == 2) {
5018 error->
data =
stredup(
"too many inputs (max 16)");
5021 for (uint i = 0; i < group->
num_input; i++) {
5022 byte rawcargo = buf->ReadByte();
5040 error->
data =
stredup(
"too many outputs (max 16)");
5043 for (uint i = 0; i < group->
num_output; i++) {
5044 byte rawcargo = buf->ReadByte();
5057 group->again = buf->ReadByte();
5065 default:
grfmsg(1,
"NewSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5070 _cur.spritegroups[setid] = act_group;
5073 static CargoID TranslateCargo(uint8 feature, uint8 ctype)
5075 if (feature == GSF_OBJECTS) {
5080 grfmsg(1,
"TranslateCargo: Invalid cargo bitnum %d for objects, skipping.", ctype);
5085 if (feature == GSF_STATIONS && ctype == 0xFE)
return CT_DEFAULT_NA;
5086 if (ctype == 0xFF)
return CT_PURCHASE;
5091 grfmsg(1,
"TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype);
5096 FOR_ALL_CARGOSPECS(cs) {
5097 if (cs->
bitnum == ctype) {
5098 grfmsg(6,
"TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, cs->
Index());
5103 grfmsg(5,
"TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype);
5116 grfmsg(5,
"TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype);
5122 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));
5126 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);
5131 static bool IsValidGroupID(uint16 groupid,
const char *
function)
5133 if (groupid >
MAX_SPRITEGROUP || _cur.spritegroups[groupid] == NULL) {
5134 grfmsg(1,
"%s: Spritegroup 0x%04X out of range or empty, skipping.",
function, groupid);
5141 static void VehicleMapSpriteGroup(
ByteReader *buf, byte feature, uint8 idcount)
5144 static uint last_engines_count;
5145 bool wagover =
false;
5148 if (
HasBit(idcount, 7)) {
5151 idcount =
GB(idcount, 0, 7);
5153 if (last_engines_count == 0) {
5154 grfmsg(0,
"VehicleMapSpriteGroup: WagonOverride: No engine to do override with");
5158 grfmsg(6,
"VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons",
5159 last_engines_count, idcount);
5161 if (last_engines_count != idcount) {
5162 last_engines =
ReallocT(last_engines, idcount);
5163 last_engines_count = idcount;
5168 for (uint i = 0; i < idcount; i++) {
5174 HandleChangeInfoResult(
"VehicleMapSpriteGroup",
CIR_INVALID_ID, 0, 0);
5178 engines[i] = e->
index;
5179 if (!wagover) last_engines[i] = engines[i];
5182 uint8 cidcount = buf->ReadByte();
5183 for (uint c = 0; c < cidcount; c++) {
5184 uint8 ctype = buf->ReadByte();
5185 uint16 groupid = buf->ReadWord();
5186 if (!IsValidGroupID(groupid,
"VehicleMapSpriteGroup"))
continue;
5188 grfmsg(8,
"VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid);
5190 ctype = TranslateCargo(feature, ctype);
5193 for (uint i = 0; i < idcount; i++) {
5196 grfmsg(7,
"VehicleMapSpriteGroup: [%d] Engine %d...", i, engine);
5199 SetWagonOverrideSprites(engine, ctype, _cur.spritegroups[groupid], last_engines, last_engines_count);
5201 SetCustomEngineSprites(engine, ctype, _cur.spritegroups[groupid]);
5206 uint16 groupid = buf->ReadWord();
5207 if (!IsValidGroupID(groupid,
"VehicleMapSpriteGroup"))
return;
5209 grfmsg(8,
"-- Default group id 0x%04X", groupid);
5211 for (uint i = 0; i < idcount; i++) {
5215 SetWagonOverrideSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid], last_engines, last_engines_count);
5217 SetCustomEngineSprites(engine, CT_DEFAULT, _cur.spritegroups[groupid]);
5224 static void CanalMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5227 for (uint i = 0; i < idcount; i++) {
5231 uint8 cidcount = buf->ReadByte();
5232 buf->Skip(cidcount * 3);
5234 uint16 groupid = buf->ReadWord();
5235 if (!IsValidGroupID(groupid,
"CanalMapSpriteGroup"))
return;
5237 for (uint i = 0; i < idcount; i++) {
5241 grfmsg(1,
"CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf);
5251 static void StationMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5253 uint8 *stations =
AllocaM(uint8, idcount);
5254 for (uint i = 0; i < idcount; i++) {
5255 stations[i] = buf->ReadByte();
5258 uint8 cidcount = buf->ReadByte();
5259 for (uint c = 0; c < cidcount; c++) {
5260 uint8 ctype = buf->ReadByte();
5261 uint16 groupid = buf->ReadWord();
5262 if (!IsValidGroupID(groupid,
"StationMapSpriteGroup"))
continue;
5264 ctype = TranslateCargo(GSF_STATIONS, ctype);
5267 for (uint i = 0; i < idcount; i++) {
5270 if (statspec == NULL) {
5271 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5279 uint16 groupid = buf->ReadWord();
5280 if (!IsValidGroupID(groupid,
"StationMapSpriteGroup"))
return;
5282 for (uint i = 0; i < idcount; i++) {
5285 if (statspec == NULL) {
5286 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
5291 grfmsg(1,
"StationMapSpriteGroup: Station with ID 0x%02X mapped multiple times, skipping", stations[i]);
5298 StationClass::Assign(statspec);
5303 static void TownHouseMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5305 uint8 *houses =
AllocaM(uint8, idcount);
5306 for (uint i = 0; i < idcount; i++) {
5307 houses[i] = buf->ReadByte();
5311 uint8 cidcount = buf->ReadByte();
5312 buf->Skip(cidcount * 3);
5314 uint16 groupid = buf->ReadWord();
5315 if (!IsValidGroupID(groupid,
"TownHouseMapSpriteGroup"))
return;
5317 if (_cur.
grffile->housespec == NULL) {
5318 grfmsg(1,
"TownHouseMapSpriteGroup: No houses defined, skipping");
5322 for (uint i = 0; i < idcount; i++) {
5326 grfmsg(1,
"TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]);
5334 static void IndustryMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5336 uint8 *industries =
AllocaM(uint8, idcount);
5337 for (uint i = 0; i < idcount; i++) {
5338 industries[i] = buf->ReadByte();
5342 uint8 cidcount = buf->ReadByte();
5343 buf->Skip(cidcount * 3);
5345 uint16 groupid = buf->ReadWord();
5346 if (!IsValidGroupID(groupid,
"IndustryMapSpriteGroup"))
return;
5348 if (_cur.
grffile->industryspec == NULL) {
5349 grfmsg(1,
"IndustryMapSpriteGroup: No industries defined, skipping");
5353 for (uint i = 0; i < idcount; i++) {
5356 if (indsp == NULL) {
5357 grfmsg(1,
"IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]);
5365 static void IndustrytileMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5367 uint8 *indtiles =
AllocaM(uint8, idcount);
5368 for (uint i = 0; i < idcount; i++) {
5369 indtiles[i] = buf->ReadByte();
5373 uint8 cidcount = buf->ReadByte();
5374 buf->Skip(cidcount * 3);
5376 uint16 groupid = buf->ReadWord();
5377 if (!IsValidGroupID(groupid,
"IndustrytileMapSpriteGroup"))
return;
5379 if (_cur.
grffile->indtspec == NULL) {
5380 grfmsg(1,
"IndustrytileMapSpriteGroup: No industry tiles defined, skipping");
5384 for (uint i = 0; i < idcount; i++) {
5387 if (indtsp == NULL) {
5388 grfmsg(1,
"IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]);
5396 static void CargoMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5399 for (uint i = 0; i < idcount; i++) {
5400 cargoes[i] = buf->ReadByte();
5404 uint8 cidcount = buf->ReadByte();
5405 buf->Skip(cidcount * 3);
5407 uint16 groupid = buf->ReadWord();
5408 if (!IsValidGroupID(groupid,
"CargoMapSpriteGroup"))
return;
5410 for (uint i = 0; i < idcount; i++) {
5414 grfmsg(1,
"CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid);
5420 cs->group = _cur.spritegroups[groupid];
5424 static void ObjectMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5426 if (_cur.
grffile->objectspec == NULL) {
5427 grfmsg(1,
"ObjectMapSpriteGroup: No object tiles defined, skipping");
5431 uint8 *objects =
AllocaM(uint8, idcount);
5432 for (uint i = 0; i < idcount; i++) {
5433 objects[i] = buf->ReadByte();
5436 uint8 cidcount = buf->ReadByte();
5437 for (uint c = 0; c < cidcount; c++) {
5438 uint8 ctype = buf->ReadByte();
5439 uint16 groupid = buf->ReadWord();
5440 if (!IsValidGroupID(groupid,
"ObjectMapSpriteGroup"))
continue;
5442 ctype = TranslateCargo(GSF_OBJECTS, ctype);
5445 for (uint i = 0; i < idcount; i++) {
5449 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5457 uint16 groupid = buf->ReadWord();
5458 if (!IsValidGroupID(groupid,
"ObjectMapSpriteGroup"))
return;
5460 for (uint i = 0; i < idcount; i++) {
5464 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X undefined, skipping", objects[i]);
5469 grfmsg(1,
"ObjectMapSpriteGroup: Object with ID 0x%02X mapped multiple times, skipping", objects[i]);
5479 static void RailTypeMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5481 uint8 *railtypes =
AllocaM(uint8, idcount);
5482 for (uint i = 0; i < idcount; i++) {
5483 uint8
id = buf->ReadByte();
5487 uint8 cidcount = buf->ReadByte();
5488 for (uint c = 0; c < cidcount; c++) {
5489 uint8 ctype = buf->ReadByte();
5490 uint16 groupid = buf->ReadWord();
5491 if (!IsValidGroupID(groupid,
"RailTypeMapSpriteGroup"))
continue;
5493 if (ctype >= RTSG_END)
continue;
5496 for (uint i = 0; i < idcount; i++) {
5501 rti->
group[ctype] = _cur.spritegroups[groupid];
5510 static void AirportMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5512 uint8 *airports =
AllocaM(uint8, idcount);
5513 for (uint i = 0; i < idcount; i++) {
5514 airports[i] = buf->ReadByte();
5518 uint8 cidcount = buf->ReadByte();
5519 buf->Skip(cidcount * 3);
5521 uint16 groupid = buf->ReadWord();
5522 if (!IsValidGroupID(groupid,
"AirportMapSpriteGroup"))
return;
5524 if (_cur.
grffile->airportspec == NULL) {
5525 grfmsg(1,
"AirportMapSpriteGroup: No airports defined, skipping");
5529 for (uint i = 0; i < idcount; i++) {
5533 grfmsg(1,
"AirportMapSpriteGroup: Airport %d undefined, skipping", airports[i]);
5541 static void AirportTileMapSpriteGroup(
ByteReader *buf, uint8 idcount)
5543 uint8 *airptiles =
AllocaM(uint8, idcount);
5544 for (uint i = 0; i < idcount; i++) {
5545 airptiles[i] = buf->ReadByte();
5549 uint8 cidcount = buf->ReadByte();
5550 buf->Skip(cidcount * 3);
5552 uint16 groupid = buf->ReadWord();
5553 if (!IsValidGroupID(groupid,
"AirportTileMapSpriteGroup"))
return;
5555 if (_cur.
grffile->airtspec == NULL) {
5556 grfmsg(1,
"AirportTileMapSpriteGroup: No airport tiles defined, skipping");
5560 for (uint i = 0; i < idcount; i++) {
5563 if (airtsp == NULL) {
5564 grfmsg(1,
"AirportTileMapSpriteGroup: Airport tile %d undefined, skipping", airptiles[i]);
5574 static void FeatureMapSpriteGroup(
ByteReader *buf)
5590 uint8 feature = buf->ReadByte();
5591 uint8 idcount = buf->ReadByte();
5593 if (feature >= GSF_END) {
5594 grfmsg(1,
"FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5602 uint16 groupid = buf->ReadWord();
5603 if (!IsValidGroupID(groupid,
"FeatureMapSpriteGroup"))
return;
5605 grfmsg(6,
"FeatureMapSpriteGroup: Adding generic feature callback for feature 0x%02X", feature);
5614 grfmsg(6,
"FeatureMapSpriteGroup: Feature 0x%02X, %d ids", feature, idcount);
5618 case GSF_ROADVEHICLES:
5621 VehicleMapSpriteGroup(buf, feature, idcount);
5625 CanalMapSpriteGroup(buf, idcount);
5629 StationMapSpriteGroup(buf, idcount);
5633 TownHouseMapSpriteGroup(buf, idcount);
5636 case GSF_INDUSTRIES:
5637 IndustryMapSpriteGroup(buf, idcount);
5640 case GSF_INDUSTRYTILES:
5641 IndustrytileMapSpriteGroup(buf, idcount);
5645 CargoMapSpriteGroup(buf, idcount);
5649 AirportMapSpriteGroup(buf, idcount);
5653 ObjectMapSpriteGroup(buf, idcount);
5657 RailTypeMapSpriteGroup(buf, idcount);
5660 case GSF_AIRPORTTILES:
5661 AirportTileMapSpriteGroup(buf, idcount);
5665 grfmsg(1,
"FeatureMapSpriteGroup: Unsupported feature 0x%02X, skipping", feature);
5689 bool new_scheme = _cur.
grffile->grf_version >= 7;
5691 uint8 feature = buf->ReadByte();
5692 if (feature >= GSF_END && feature != 0x48) {
5693 grfmsg(1,
"FeatureNewName: Unsupported feature 0x%02X, skipping", feature);
5697 uint8 lang = buf->ReadByte();
5698 uint8 num = buf->ReadByte();
5699 bool generic =
HasBit(lang, 7);
5702 id = buf->ReadWord();
5703 }
else if (feature <= GSF_AIRCRAFT) {
5704 id = buf->ReadExtendedByte();
5706 id = buf->ReadByte();
5711 uint16 endid =
id + num;
5713 grfmsg(6,
"FeatureNewName: About to rename engines %d..%d (feature 0x%02X) in language 0x%02X",
5714 id, endid, feature, lang);
5716 for (;
id < endid && buf->HasData();
id++) {
5717 const char *name = buf->ReadString();
5718 grfmsg(8,
"FeatureNewName: 0x%04X <- %s",
id, name);
5722 case GSF_ROADVEHICLES:
5727 if (e == NULL)
break;
5741 switch (
GB(
id, 8, 8)) {
5743 if (_cur.
grffile->stations == NULL || _cur.
grffile->stations[
GB(
id, 0, 8)] == NULL) {
5744 grfmsg(1,
"FeatureNewName: Attempt to name undefined station 0x%X, ignoring",
GB(
id, 0, 8));
5752 if (_cur.
grffile->stations == NULL || _cur.
grffile->stations[
GB(
id, 0, 8)] == NULL) {
5753 grfmsg(1,
"FeatureNewName: Attempt to name undefined station 0x%X, ignoring",
GB(
id, 0, 8));
5760 if (_cur.
grffile->airtspec == NULL || _cur.
grffile->airtspec[
GB(
id, 0, 8)] == NULL) {
5761 grfmsg(1,
"FeatureNewName: Attempt to name undefined airport tile 0x%X, ignoring",
GB(
id, 0, 8));
5768 if (_cur.
grffile->housespec == NULL || _cur.
grffile->housespec[
GB(
id, 0, 8)] == NULL) {
5769 grfmsg(1,
"FeatureNewName: Attempt to name undefined house 0x%X, ignoring.",
GB(
id, 0, 8));
5776 grfmsg(7,
"FeatureNewName: Unsupported ID (0x%04X)",
id);
5795 if (offset >= max_sprites) {
5796 grfmsg(1,
"GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites);
5797 uint orig_num = num;
5802 if (offset + num > max_sprites) {
5803 grfmsg(4,
"GraphicsNew: %s sprite overflow, truncating...", name);
5804 uint orig_num = num;
5805 num =
max(max_sprites - offset, 0);
5806 return orig_num - num;
5835 {
A5BLOCK_ALLOW_OFFSET, SPR_SIGNALS_BASE, 1, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT,
"Signal graphics" },
5837 {
A5BLOCK_ALLOW_OFFSET, SPR_SLOPES_BASE, 1, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT,
"Foundation graphics" },
5867 uint8 type = buf->ReadByte();
5868 uint16 num = buf->ReadExtendedByte();
5869 uint16 offset =
HasBit(type, 7) ? buf->ReadExtendedByte() : 0;
5875 grfmsg(2,
"GraphicsNew: Loading 10 missing shore sprites from extra grf.");
5892 grfmsg(2,
"GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num);
5897 const Action5Type *action5_type = &_action5_types[type];
5903 grfmsg(1,
"GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->
name, type);
5910 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);
5920 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);
5922 for (; num > 0; num--) {
5995 *value = (major << 24) | (minor << 20) | (revision << 16) | build;
6025 *value = _game_mode;
6059 *value =
Clamp(snowline * (grffile->grf_version >= 8 ? 1 :
TILE_HEIGHT), 0, 0xFE);
6068 *value = _openttd_newgrf_version;
6083 default:
return false;
6087 static uint32 GetParamVal(byte param, uint32 *cond_val)
6105 if (cond_val == NULL) {
6109 uint32 index = *cond_val / 0x20;
6125 grfmsg(1,
"Unsupported in-game variable 0x%02X", param);
6148 byte *preload_sprite = NULL;
6152 preload_sprite = MallocT<byte>(num);
6160 grfmsg(2,
"CfgApply: Ignoring (next sprite is real, unsupported)");
6161 free(preload_sprite);
6166 GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
6167 if (it != _grf_line_to_action6_sprite_override.end()) {
6168 free(preload_sprite);
6169 preload_sprite = _grf_line_to_action6_sprite_override[location];
6171 _grf_line_to_action6_sprite_override[location] = preload_sprite;
6184 param_num = buf->ReadByte();
6185 if (param_num == 0xFF)
break;
6189 param_size = buf->ReadByte();
6193 add_value =
HasBit(param_size, 7);
6194 param_size =
GB(param_size, 0, 7);
6197 offset = buf->ReadExtendedByte();
6201 if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur.
grffile->
param_end) {
6202 grfmsg(2,
"CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4));
6206 grfmsg(8,
"CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset);
6209 for (i = 0; i < param_size && offset + i < num; i++) {
6210 uint32 value = GetParamVal(param_num + i / 4, NULL);
6213 if (i % 4 == 0) carry =
false;
6216 uint new_value = preload_sprite[offset + i] +
GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0);
6217 preload_sprite[offset + i] =
GB(new_value, 0, 8);
6219 carry = new_value >= 256;
6221 preload_sprite[offset + i] =
GB(value, (i % 4) * 8, 8);
6253 uint32 cond_val = 0;
6257 uint8 param = buf->ReadByte();
6258 uint8 paramsize = buf->ReadByte();
6259 uint8 condtype = buf->ReadByte();
6266 switch (paramsize) {
6267 case 8: cond_val = buf->ReadDWord(); mask = buf->ReadDWord();
break;
6268 case 4: cond_val = buf->ReadDWord(); mask = 0xFFFFFFFF;
break;
6269 case 2: cond_val = buf->ReadWord(); mask = 0x0000FFFF;
break;
6270 case 1: cond_val = buf->ReadByte(); mask = 0x000000FF;
break;
6274 if (param < 0x80 && _cur.grffile->param_end <= param) {
6275 grfmsg(7,
"SkipIf: Param %d undefined, skipping test", param);
6279 uint32 param_val = GetParamVal(param, &cond_val);
6281 grfmsg(7,
"SkipIf: Test condtype %d, param 0x%08X, condval 0x%08X", condtype, param_val, cond_val);
6291 if (param == 0x88 && (condtype < 0x0B || condtype > 0x0E)) {
6301 if (condtype != 10 && c == NULL) {
6302 grfmsg(7,
"SkipIf: GRFID 0x%08X unknown, skipping test",
BSWAP32(cond_val));
6329 default:
grfmsg(1,
"SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype);
return;
6334 case 0x00: result = !!(param_val & (1 << cond_val));
6336 case 0x01: result = !(param_val & (1 << cond_val));
6338 case 0x02: result = (param_val & mask) == cond_val;
6340 case 0x03: result = (param_val & mask) != cond_val;
6342 case 0x04: result = (param_val & mask) < cond_val;
6344 case 0x05: result = (param_val & mask) > cond_val;
6355 default:
grfmsg(1,
"SkipIf: Unsupported condition type %02X. Ignoring", condtype);
return;
6360 grfmsg(2,
"SkipIf: Not skipping sprites, test was false");
6364 uint8 numsprites = buf->ReadByte();
6372 if (label->label != numsprites)
continue;
6375 if (choice == NULL) choice = label;
6377 if (label->nfo_line > _cur.
nfo_line) {
6383 if (choice != NULL) {
6384 grfmsg(2,
"SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line);
6390 grfmsg(2,
"SkipIf: Skipping %d sprites, test was true", numsprites);
6409 uint8 grf_version = buf->ReadByte();
6410 uint32 grfid = buf->ReadDWord();
6411 const char *name = buf->ReadString();
6415 if (grf_version < 2 || grf_version > 8) {
6417 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);
6425 if (buf->HasData()) {
6426 const char *info = buf->ReadString();
6444 uint8 version = buf->ReadByte();
6445 uint32 grfid = buf->ReadDWord();
6446 const char *name = buf->ReadString();
6449 DisableGrf(STR_NEWGRF_ERROR_MULTIPLE_ACTION_8);
6453 if (_cur.
grffile->grfid != grfid) {
6454 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));
6458 _cur.
grffile->grf_version = version;
6476 uint8 num_sets = buf->ReadByte();
6478 for (uint i = 0; i < num_sets; i++) {
6480 uint16 first_sprite = buf->ReadWord();
6482 grfmsg(2,
"SpriteReplace: [Set %d] Changing %d sprites, beginning with %d",
6483 i, num_sprites, first_sprite
6487 int load_index = first_sprite + j;
6493 if (
IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) {
6503 uint8 num_sets = buf->ReadByte();
6505 for (uint i = 0; i < num_sets; i++) {
6534 STR_NEWGRF_ERROR_VERSION_NUMBER,
6535 STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
6536 STR_NEWGRF_ERROR_UNSET_SWITCH,
6537 STR_NEWGRF_ERROR_INVALID_PARAMETER,
6538 STR_NEWGRF_ERROR_LOAD_BEFORE,
6539 STR_NEWGRF_ERROR_LOAD_AFTER,
6540 STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
6544 STR_NEWGRF_ERROR_MSG_INFO,
6545 STR_NEWGRF_ERROR_MSG_WARNING,
6546 STR_NEWGRF_ERROR_MSG_ERROR,
6547 STR_NEWGRF_ERROR_MSG_FATAL
6550 byte severity = buf->ReadByte();
6551 byte lang = buf->ReadByte();
6552 byte message_id = buf->ReadByte();
6555 if (!CheckGrfLangID(lang, _cur.
grffile->grf_version))
return;
6559 if (!
HasBit(severity, 7) && _cur.
stage == GLS_INIT) {
6560 grfmsg(7,
"GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur.
stage);
6565 if (severity >=
lengthof(sevstr)) {
6566 grfmsg(7,
"GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity);
6568 }
else if (severity == 3) {
6578 if (message_id >=
lengthof(msgstr) && message_id != 0xFF) {
6579 grfmsg(7,
"GRFLoadError: Invalid message id.");
6583 if (buf->Remaining() <= 1) {
6584 grfmsg(7,
"GRFLoadError: No message data supplied.");
6593 if (message_id == 0xFF) {
6595 if (buf->HasData()) {
6596 const char *message = buf->ReadString();
6600 grfmsg(7,
"GRFLoadError: No custom message supplied.");
6604 error->
message = msgstr[message_id];
6607 if (buf->HasData()) {
6608 const char *data = buf->ReadString();
6612 grfmsg(7,
"GRFLoadError: No message data supplied.");
6618 uint param_number = buf->ReadByte();
6632 if (!buf->HasData())
return;
6634 const char *text = buf->ReadString();
6635 grfmsg(2,
"GRFComment: %s", text);
6641 uint8 target = buf->ReadByte();
6644 if (target < 0x80 || target == 0x9E)
return;
6658 static uint32 GetPatchVariable(uint8 param)
6668 case 0x0F:
return 0;
6684 case 0x11:
return SPR_2CCMAP_BASE;
6701 byte max_edge =
max(log_X, log_Y);
6703 if (log_X == log_Y) {
6706 if (max_edge == log_Y)
SetBit(map_bits, 1);
6709 return (map_bits << 24) | (
min(log_X, log_Y) << 20) | (max_edge << 16) |
6710 (log_X << 12) | (log_Y << 8) | (log_X + log_Y);
6719 return SPR_SLOPES_BASE;
6726 grfmsg(2,
"ParamSet: Unknown Patch variable 0x%02X.", param);
6732 static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target,
const char *type)
6745 for (uint i = start; i < num_ids; i++) {
6749 if (op == 2 || op == 3)
break;
6754 if (size == count)
break;
6757 if (size == count) {
6759 if (op == 0 || op == 3) {
6760 grfmsg(2,
"ParamSet: GRM: Reserving %d %s at %d", count, type, start);
6761 for (uint i = 0; i < count; i++) grm[start + i] = _cur.
grffile->grfid;
6767 if (op != 4 && op != 5) {
6769 grfmsg(0,
"ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type);
6774 grfmsg(1,
"ParamSet: GRM: Unable to allocate %d %s", count, type);
6804 uint8 target = buf->ReadByte();
6805 uint8 oper = buf->ReadByte();
6806 uint32 src1 = buf->ReadByte();
6807 uint32 src2 = buf->ReadByte();
6810 if (buf->Remaining() >= 4) data = buf->ReadDWord();
6819 if (target < 0x80 && target < _cur.grffile->param_end) {
6820 grfmsg(7,
"ParamSet: Param %u already defined, skipping", target);
6824 oper =
GB(oper, 0, 7);
6828 if (
GB(data, 0, 8) == 0xFF) {
6829 if (data == 0x0000FFFF) {
6831 src1 = GetPatchVariable(src1);
6835 uint8 feature =
GB(data, 8, 8);
6836 uint16 count =
GB(data, 16, 16);
6838 if (_cur.
stage == GLS_RESERVE) {
6839 if (feature == 0x08) {
6843 if (_cur.
spriteid + count >= 16384) {
6844 grfmsg(0,
"ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count);
6850 grfmsg(4,
"ParamSet: GRM: Allocated %d sprites at %d", count, _cur.
spriteid);
6857 }
else if (_cur.
stage == GLS_ACTIVATION) {
6886 grfmsg(4,
"ParamSet: GRM: Using pre-allocated sprites at %d", src1);
6894 grfmsg(1,
"ParamSet: GRM: Unsupported operation %d for general sprites", op);
6905 default:
grfmsg(1,
"ParamSet: GRM: Unsupported feature 0x%X", feature);
return;
6922 }
else if (src1 == 0xFE) {
6934 src1 = (src1 == 0xFF) ? data : GetParamVal(src1, NULL);
6935 src2 = (src2 == 0xFF) ? data : GetParamVal(src2, NULL);
6957 res = (int32)src1 * (int32)src2;
6961 if ((int32)src2 < 0) {
6962 res = src1 >> -(int32)src2;
6964 res = src1 << (src2 & 0x1F);
6969 if ((int32)src2 < 0) {
6970 res = (int32)src1 >> -(int32)src2;
6972 res = (int32)src1 << (src2 & 0x1F);
6996 res = (int32)src1 / (int32)src2;
7012 res = (int32)src1 % (int32)src2;
7016 default:
grfmsg(0,
"ParamSet: Unknown operation %d, skipping", oper);
return;
7045 grfmsg(7,
"ParamSet: Skipping unimplemented target 0x%02X", target);
7056 uint32 safe_bits = 0;
7057 SetBit(safe_bits, GMB_SECOND_ROCKY_TILE_SET);
7066 grfmsg(7,
"ParamSet: Skipping unimplemented target 0x%02X", target);
7070 if (target < 0x80) {
7071 _cur.
grffile->param[target] = res;
7075 grfmsg(7,
"ParamSet: Skipping unknown target 0x%02X", target);
7089 uint8 num = buf->ReadByte();
7091 for (uint i = 0; i < num; i++) {
7092 uint32 grfid = buf->ReadDWord();
7114 uint8 num = buf->ReadByte();
7116 for (uint i = 0; i < num; i++) {
7117 uint32 grfid = buf->ReadDWord();
7121 if (file != NULL && file != _cur.
grfconfig) {
7139 uint32 grfid = _cur.
grffile->grfid;
7143 byte
id = buf->ReadByte();
7144 grfmsg(6,
"FeatureTownName: definition 0x%02X",
id & 0x7F);
7149 bool new_scheme = _cur.
grffile->grf_version >= 7;
7151 byte lang = buf->ReadByte();
7153 byte nb_gen = townname->nb_gen;
7157 const char *name = buf->ReadString();
7160 grfmsg(6,
"FeatureTownName: lang 0x%X -> '%s'", lang, lang_name);
7163 townname->name[nb_gen] =
AddGRFString(grfid,
id, lang, new_scheme,
false, name, STR_UNDEFINED);
7165 lang = buf->ReadByte();
7166 }
while (lang != 0);
7167 townname->id[nb_gen] = id;
7171 byte nb = buf->ReadByte();
7172 grfmsg(6,
"FeatureTownName: %u parts", nb);
7174 townname->nbparts[id] = nb;
7175 townname->partlist[id] = CallocT<NamePartList>(nb);
7177 for (
int i = 0; i < nb; i++) {
7178 byte nbtext = buf->ReadByte();
7179 townname->partlist[id][i].bitstart = buf->ReadByte();
7180 townname->partlist[id][i].bitcount = buf->ReadByte();
7181 townname->partlist[id][i].maxprob = 0;
7182 townname->partlist[id][i].partcount = nbtext;
7183 townname->partlist[id][i].parts = CallocT<NamePart>(nbtext);
7184 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);
7186 for (
int j = 0; j < nbtext; j++) {
7187 byte prob = buf->ReadByte();
7190 byte ref_id = buf->ReadByte();
7192 if (townname->nbparts[ref_id] == 0) {
7193 grfmsg(0,
"FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id);
7194 DelGRFTownName(grfid);
7199 grfmsg(6,
"FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F);
7200 townname->partlist[id][i].parts[j].data.
id = ref_id;
7202 const char *text = buf->ReadString();
7204 grfmsg(6,
"FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[
id][i].parts[j].data.
text, prob);
7206 townname->partlist[id][i].parts[j].
prob = prob;
7207 townname->partlist[id][i].maxprob +=
GB(prob, 0, 7);
7209 grfmsg(6,
"FeatureTownName: part %d, total probability %d", i, townname->partlist[
id][i].maxprob);
7221 byte nfo_label = buf->ReadByte();
7223 GRFLabel *label = MallocT<GRFLabel>(1);
7224 label->label = nfo_label;
7235 for (l = _cur.
grffile->
label; l->next != NULL; l = l->next) {}
7239 grfmsg(2,
"DefineGotoLabel: GOTO target with label 0x%02X", label->label);
7253 if (file == NULL || file->sound_offset == 0) {
7254 grfmsg(1,
"ImportGRFSound: Source file not available");
7258 if (sound_id >= file->num_sounds) {
7259 grfmsg(1,
"ImportGRFSound: Sound effect %d is invalid", sound_id);
7263 grfmsg(2,
"ImportGRFSound: Copying sound %d (%d) from file %X", sound_id, file->sound_offset + sound_id, grfid);
7265 *sound = *GetSound(file->sound_offset + sound_id);
7268 sound->volume = 128;
7269 sound->priority = 0;
7280 sound->volume = 0x80;
7281 sound->priority = 0;
7283 if (offs != SIZE_MAX) {
7286 sound->file_offset = offs;
7298 uint16 num = buf->ReadWord();
7299 if (num == 0)
return;
7302 if (_cur.
grffile->sound_offset == 0) {
7303 _cur.
grffile->sound_offset = GetNumSounds();
7304 _cur.
grffile->num_sounds = num;
7307 sound = GetSound(_cur.
grffile->sound_offset);
7310 for (
int i = 0; i < num; i++) {
7315 bool invalid = i >= _cur.
grffile->num_sounds;
7325 grfmsg(1,
"GRFSound: Sound index out of range (multiple Action 11?)");
7327 }
else if (len != 4) {
7328 grfmsg(1,
"GRFSound: Invalid sprite section import");
7338 grfmsg(1,
"GRFSound: Unexpected RealSprite found, skipping");
7345 grfmsg(1,
"GRFSound: Sound index out of range (multiple Action 11?)");
7353 if (_cur.
stage == GLS_INIT) {
7355 grfmsg(1,
"GRFSound: Inline sounds are not supported for container version >= 2");
7364 if (_cur.
stage == GLS_ACTIVATION) {
7375 grfmsg(1,
"GRFSound: Unexpected Action %x found, skipping", action);
7404 uint8 num_def = buf->ReadByte();
7406 for (uint i = 0; i < num_def; i++) {
7408 uint8 num_char = buf->ReadByte();
7409 uint16 base_char = buf->ReadWord();
7411 if (size >= FS_END) {
7412 grfmsg(1,
"LoadFontGlyph: Size %u is not supported, ignoring", size);
7415 grfmsg(7,
"LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size);
7417 for (uint c = 0; c < num_char; c++) {
7435 uint8 num_def = buf->ReadByte();
7437 for (uint i = 0; i < num_def; i++) {
7461 uint32 grfid = buf->ReadDWord();
7464 grfmsg(7,
"TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13",
BSWAP32(grfid));
7474 GetString(tmp, STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE,
lastof(tmp));
7485 byte language = _cur.
grffile->grf_version >= 8 ? buf->ReadByte() : 0x7F;
7486 byte num_strings = buf->ReadByte();
7487 uint16 first_id = buf->ReadWord();
7489 if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD400) || (first_id >= 0xD800 && first_id + num_strings <= 0xE000))) {
7490 grfmsg(7,
"TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings);
7494 for (uint i = 0; i < num_strings && buf->HasData(); i++) {
7495 const char *
string = buf->ReadString();
7498 grfmsg(7,
"TranslateGRFString: Ignoring empty string.");
7502 AddGRFString(grfid, first_id + i, language,
true,
true,
string, STR_UNDEFINED);
7531 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'NPAR' but got " PRINTF_SIZE
", ignoring this field", len);
7543 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'PALS' but got " PRINTF_SIZE
", ignoring this field", len);
7546 char data = buf->ReadByte();
7554 grfmsg(2,
"StaticGRFInfo: unexpected value '%02x' for 'INFO'->'PALS', ignoring this field", data);
7569 grfmsg(2,
"StaticGRFInfo: expected only 1 byte for 'INFO'->'BLTR' but got " PRINTF_SIZE
", ignoring this field", len);
7572 char data = buf->ReadByte();
7578 grfmsg(2,
"StaticGRFInfo: unexpected value '%02x' for 'INFO'->'BLTR', ignoring this field", data);
7591 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'VRSN' but got " PRINTF_SIZE
", ignoring this field", len);
7604 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'MINV' but got " PRINTF_SIZE
", ignoring this field", len);
7609 grfmsg(2,
"StaticGRFInfo: 'MINV' defined before 'VRSN' or 'VRSN' set to 0, ignoring this field");
7640 grfmsg(2,
"StaticGRFInfo: expected 1 byte for 'INFO'->'PARA'->'TYPE' but got " PRINTF_SIZE
", ignoring this field", len);
7645 _cur_parameter->
type = type;
7647 grfmsg(3,
"StaticGRFInfo: unknown parameter type %d, ignoring this field", type);
7657 grfmsg(2,
"StaticGRFInfo: 'INFO'->'PARA'->'LIMI' is only valid for parameters with type uint/enum, ignoring this field");
7659 }
else if (len != 8) {
7660 grfmsg(2,
"StaticGRFInfo: expected 8 bytes for 'INFO'->'PARA'->'LIMI' but got " PRINTF_SIZE
", ignoring this field", len);
7663 _cur_parameter->
min_value = buf->ReadDWord();
7664 _cur_parameter->
max_value = buf->ReadDWord();
7672 if (len < 1 || len > 3) {
7673 grfmsg(2,
"StaticGRFInfo: expected 1 to 3 bytes for 'INFO'->'PARA'->'MASK' but got " PRINTF_SIZE
", ignoring this field", len);
7676 byte param_nr = buf->ReadByte();
7678 grfmsg(2,
"StaticGRFInfo: invalid parameter number in 'INFO'->'PARA'->'MASK', param %d, ignoring this field", param_nr);
7681 _cur_parameter->
param_nr = param_nr;
7682 if (len >= 2) _cur_parameter->
first_bit =
min(buf->ReadByte(), 31);
7683 if (len >= 3) _cur_parameter->
num_bit =
min(buf->ReadByte(), 32 - _cur_parameter->
first_bit);
7694 grfmsg(2,
"StaticGRFInfo: expected 4 bytes for 'INFO'->'PARA'->'DEFA' but got " PRINTF_SIZE
", ignoring this field", len);
7697 _cur_parameter->
def_value = buf->ReadDWord();
7730 this->handler.data = handler;
7742 this->handler.text = handler;
7754 this->handler.call_handler =
true;
7755 this->handler.u.branch = handler;
7767 this->handler.call_handler =
false;
7768 this->handler.u.subtags = subtags;
7797 byte type = buf->ReadByte();
7799 uint32
id = buf->ReadDWord();
7800 if (type !=
'T' ||
id > _cur_parameter->
max_value) {
7801 grfmsg(2,
"StaticGRFInfo: all child nodes of 'INFO'->'PARA'->param_num->'VALU' should have type 't' and the value/bit number as id");
7803 type = buf->ReadByte();
7807 byte langid = buf->ReadByte();
7808 const char *name_string = buf->ReadString();
7819 type = buf->ReadByte();
7844 byte type = buf->ReadByte();
7846 uint32
id = buf->ReadDWord();
7848 grfmsg(2,
"StaticGRFInfo: all child nodes of 'INFO'->'PARA' should have type 'C' and their parameter number as id");
7850 type = buf->ReadByte();
7857 MemSetT<GRFParameterInfo *>(newdata, 0, num_to_add);
7864 if (!
HandleNodes(buf, _tags_parameters))
return false;
7865 type = buf->ReadByte();
7902 byte new_type = buf->ReadByte();
7903 while (new_type != 0) {
7906 new_type = buf->ReadByte();
7917 uint16 size = buf->ReadWord();
7941 while ((tag = &subtags[i++])->type != 0) {
7944 default: NOT_REACHED();
7947 byte langid = buf->ReadByte();
7948 return tag->handler.
text(langid, buf->ReadString());
7952 size_t len = buf->ReadWord();
7953 if (buf->Remaining() < len)
return false;
7954 return tag->handler.
data(len, buf);
7959 return tag->handler.u.branch(buf);
7965 grfmsg(2,
"StaticGRFInfo: unknown type/id combination found, type=%c, id=%x", type,
id);
7977 byte type = buf->ReadByte();
7979 uint32
id = buf->ReadDWord();
7980 if (!
HandleNode(type,
id, buf, subtags))
return false;
7981 type = buf->ReadByte();
8100 const GRFFile *
const *end = _grf_files.
End();
8101 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8103 if (stations == NULL)
continue;
8105 if (stations[i] == NULL)
continue;
8111 if (!statspec->copied_layouts) {
8112 for (uint l = 0; l < statspec->lengths; l++) {
8113 for (uint p = 0; p < statspec->platforms[l]; p++) {
8114 free(statspec->layouts[l][p]);
8116 free(statspec->layouts[l]);
8118 free(statspec->layouts);
8119 free(statspec->platforms);
8135 const GRFFile *
const *end = _grf_files.
End();
8136 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8137 HouseSpec **&housespec = (*file)->housespec;
8138 if (housespec == NULL)
continue;
8151 const GRFFile *
const *end = _grf_files.
End();
8152 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8154 if (aslist != NULL) {
8160 for (
int j = 0; j < as->
num_table; j++) {
8172 (*file)->airportspec = NULL;
8176 if (airporttilespec != NULL) {
8178 free(airporttilespec[i]);
8180 free(airporttilespec);
8181 airporttilespec = NULL;
8189 const GRFFile *
const *end = _grf_files.
End();
8190 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8196 if (industryspec != NULL) {
8199 if (ind == NULL)
continue;
8213 industryspec = NULL;
8216 if (indtspec == NULL)
continue;
8229 const GRFFile *
const *end = _grf_files.
End();
8230 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8231 ObjectSpec **&objectspec = (*file)->objectspec;
8232 if (objectspec == NULL)
continue;
8234 free(objectspec[i]);
8245 const GRFFile *
const *end = _grf_files.
End();
8246 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8271 CleanUpGRFTownNames();
8313 ObjectClass::Reset();
8318 StationClass::Reset();
8322 AirportClass::Reset();
8345 _loaded_newgrf_features.
has_2CC =
false;
8352 _grf_id_overrides.clear();
8354 InitializeSoundPool();
8402 if (newfile != NULL) {
8408 newfile =
new GRFFile(config);
8422 this->traininfo_vehicle_pitch = 0;
8423 this->traininfo_vehicle_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
8426 for (
Price i = PR_BEGIN; i < PR_END; i++) {
8427 this->price_base_multipliers[i] = INVALID_PRICE_MODIFIER;
8443 if (this->param_end > 0) {
8450 free(this->filename);
8451 delete[] this->language_map;
8460 'PASS',
'COAL',
'MAIL',
'LVST',
'GOOD',
'GRAI',
'WHEA',
'MAIZ',
'WOOD',
8461 'IORE',
'STEL',
'VALU',
'GOLD',
'DIAM',
'PAPR',
'FOOD',
'FRUT',
'CORE',
8462 'WATR',
'SUGR',
'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
8466 static const CargoLabel _default_refitmasks_road[] = {
8469 static const CargoLabel _default_refitmasks_ships[] = {
8470 'COAL',
'MAIL',
'LVST',
'GOOD',
'GRAI',
'WHEA',
'MAIZ',
'WOOD',
'IORE',
8471 'STEL',
'VALU',
'GOLD',
'DIAM',
'PAPR',
'FOOD',
'FRUT',
'CORE',
'WATR',
8472 'RUBR',
'SUGR',
'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
8476 static const CargoLabel _default_refitmasks_aircraft[] = {
8477 'PASS',
'MAIL',
'GOOD',
'VALU',
'GOLD',
'DIAM',
'FOOD',
'FRUT',
'SUGR',
8478 'TOYS',
'BATT',
'SWET',
'TOFF',
'COLA',
'CTCD',
'BUBL',
'PLST',
'FZDR',
8481 static const CargoLabel *
const _default_refitmasks[] = {
8483 _default_refitmasks_road,
8484 _default_refitmasks_ships,
8485 _default_refitmasks_aircraft,
8496 FOR_ALL_ENGINES(e) {
8499 bool only_defaultcargo;
8503 CargoTypes mask = 0;
8504 CargoTypes not_mask = 0;
8505 CargoTypes xor_mask = ei->refit_mask;
8511 if (_gted[engine].cargo_allowed != 0) {
8514 FOR_ALL_CARGOSPECS(cs) {
8520 ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) &
_cargo_mask;
8526 CargoTypes xor_mask = 0;
8531 for (uint i = 0;; i++) {
8532 if (cl[i] == 0)
break;
8544 only_defaultcargo = (ei->refit_mask == 0);
8558 if (ei->cargo_type ==
CT_INVALID && ei->refit_mask != 0) {
8560 const uint8 *cargo_map_for_first_refittable = NULL;
8563 if (file == NULL) file = e->
GetGRF();
8564 if (file != NULL && file->grf_version >= 8 && file->
cargo_list.
Length() != 0) {
8565 cargo_map_for_first_refittable = file->
cargo_map;
8569 if (cargo_map_for_first_refittable != NULL) {
8571 byte best_local_slot = 0xFF;
8573 FOR_EACH_SET_CARGO_ID(cargo_type, ei->refit_mask) {
8574 byte local_slot = cargo_map_for_first_refittable[cargo_type];
8575 if (local_slot < best_local_slot) {
8576 best_local_slot = local_slot;
8577 ei->cargo_type = cargo_type;
8599 for (uint i = 0; i < CF_END; i++) {
8612 FOR_ALL_ENGINES(e) {
8613 if (e->
GetGRF() == NULL) {
8616 e->info.
string_id = STR_NEWGRF_INVALID_ENGINE;
8651 default: NOT_REACHED();
8665 cs->
quantifier = STR_NEWGRF_INVALID_CARGO_QUANTITY;
8666 cs->
abbrev = STR_NEWGRF_INVALID_CARGO_ABBREV;
8690 if (filename != NULL)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines house %d as multitile, but no suitable tiles follow. Disabling house.", filename, hs->
grf_prop.
local_id);
8700 if (filename != NULL)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines multitile house %d with non-zero population on additional tiles. Disabling house.", filename, hs->
grf_prop.
local_id);
8708 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);
8715 if (filename != NULL)
DEBUG(grf, 1,
"FinaliseHouseArray: %s defines house %d without a size but marked it as available. Disabling house.", filename, hs->
grf_prop.
local_id);
8734 if (hs == NULL || !hs->
enabled)
continue;
8739 if (min_year == 0)
return;
8743 if (hs == NULL || !hs->
enabled)
continue;
8766 const GRFFile *
const *end = _grf_files.
End();
8767 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8768 HouseSpec **&housespec = (*file)->housespec;
8769 if (housespec == NULL)
continue;
8774 if (hs == NULL)
continue;
8776 const HouseSpec *next1 = (i + 1 < NUM_HOUSES_PER_GRF ? housespec[i + 1] : NULL);
8777 const HouseSpec *next2 = (i + 2 < NUM_HOUSES_PER_GRF ? housespec[i + 2] : NULL);
8778 const HouseSpec *next3 = (i + 3 < NUM_HOUSES_PER_GRF ? housespec[i + 3] : NULL);
8780 if (!
IsHouseSpecValid(hs, next1, next2, next3, (*file)->filename))
continue;
8788 const HouseSpec *next1 = (i + 1 < NUM_HOUSES ? HouseSpec::Get(i + 1) : NULL);
8789 const HouseSpec *next2 = (i + 2 < NUM_HOUSES ? HouseSpec::Get(i + 2) : NULL);
8790 const HouseSpec *next3 = (i + 3 < NUM_HOUSES ? HouseSpec::Get(i + 3) : NULL);
8829 const GRFFile *
const *end = _grf_files.
End();
8830 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8833 if (industryspec != NULL) {
8837 if (indsp != NULL && indsp->
enabled) {
8843 if (strid != STR_UNDEFINED) indsp->
name = strid;
8846 if (strid != STR_UNDEFINED) indsp->
closure_text = strid;
8861 if (strid != STR_UNDEFINED) indsp->
station_name = strid;
8870 if (indtspec != NULL) {
8873 if (indtsp != NULL) {
8874 _industile_mngr.SetEntitySpec(indtsp);
8883 for (uint i = 0; i < 3; i++) {
8888 indsp->
name = STR_NEWGRF_INVALID_INDUSTRYTYPE;
8900 const GRFFile *
const *end = _grf_files.
End();
8901 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8902 ObjectSpec **&objectspec = (*file)->objectspec;
8903 if (objectspec != NULL) {
8905 if (objectspec[i] != NULL && objectspec[i]->grf_prop.grffile != NULL && objectspec[i]->
enabled) {
8920 const GRFFile *
const *end = _grf_files.
End();
8921 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
8922 AirportSpec **&airportspec = (*file)->airportspec;
8923 if (airportspec != NULL) {
8925 if (airportspec[i] != NULL && airportspec[i]->enabled) {
8926 _airport_mngr.SetEntitySpec(airportspec[i]);
8932 if (airporttilespec != NULL) {
8934 if (airporttilespec[i] != NULL && airporttilespec[i]->enabled) {
8935 _airporttile_mngr.SetEntitySpec(airporttilespec[i]);
8948 static void DecodeSpecialSprite(byte *buf, uint num, GrfLoadingStage
stage)
8962 static const SpecialSpriteHandler handlers[][GLS_END] = {
8963 { NULL, SafeChangeInfo, NULL, NULL, ReserveChangeInfo, FeatureChangeInfo, },
8964 { SkipAct1, SkipAct1, SkipAct1, SkipAct1, SkipAct1, NewSpriteSet, },
8965 { NULL, NULL, NULL, NULL, NULL, NewSpriteGroup, },
8966 { NULL,
GRFUnsafe, NULL, NULL, NULL, FeatureMapSpriteGroup, },
8967 { NULL, NULL, NULL, NULL, NULL, FeatureNewName, },
8968 { SkipAct5, SkipAct5, SkipAct5, SkipAct5, SkipAct5, GraphicsNew, },
8969 { NULL, NULL, NULL, CfgApply, CfgApply, CfgApply, },
8970 { NULL, NULL, NULL, NULL, SkipIf, SkipIf, },
8971 { ScanInfo, NULL, NULL, GRFInfo, GRFInfo, GRFInfo, },
8972 { NULL, NULL, NULL, SkipIf, SkipIf, SkipIf, },
8973 { SkipActA, SkipActA, SkipActA, SkipActA, SkipActA, SpriteReplace, },
8974 { NULL, NULL, NULL, GRFLoadError, GRFLoadError, GRFLoadError, },
8975 { NULL, NULL, NULL, GRFComment, NULL, GRFComment, },
8977 { NULL, SafeGRFInhibit, NULL, GRFInhibit, GRFInhibit, GRFInhibit, },
8980 { SkipAct11,
GRFUnsafe, SkipAct11, GRFSound, SkipAct11, GRFSound, },
8988 GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
8989 if (it == _grf_line_to_action6_sprite_override.end()) {
8995 buf = _grf_line_to_action6_sprite_override[location];
8996 grfmsg(7,
"DecodeSpecialSprite: Using preloaded pseudo sprite data");
9006 byte action = bufp->ReadByte();
9008 if (action == 0xFF) {
9009 grfmsg(2,
"DecodeSpecialSprite: Unexpected data block, skipping");
9010 }
else if (action == 0xFE) {
9011 grfmsg(2,
"DecodeSpecialSprite: Unexpected import block, skipping");
9012 }
else if (action >=
lengthof(handlers)) {
9013 grfmsg(7,
"DecodeSpecialSprite: Skipping unknown action 0x%02X", action);
9014 }
else if (handlers[action][stage] == NULL) {
9015 grfmsg(7,
"DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage);
9017 grfmsg(7,
"DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage);
9018 handlers[action][
stage](bufp);
9021 grfmsg(1,
"DecodeSpecialSprite: Tried to read past end of pseudo-sprite data");
9028 extern const byte
_grf_cont_v2_sig[8] = {
'G',
'R',
'F', 0x82, 0x0D, 0x0A, 0x1A, 0x0A};
9062 const char *filename = config->
filename;
9073 if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) {
9075 if (_cur.
grffile == NULL)
usererror(
"File '%s' lost in cache.\n", filename);
9081 DEBUG(grf, 0,
"'%s' is not loaded as the maximum number of file slots has been reached", filename);
9083 config->
error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9093 DEBUG(grf, 2,
"LoadNewGRFFile: Reading NewGRF-file '%s'", filename);
9097 DEBUG(grf, 7,
"LoadNewGRFFile: Custom .grf has invalid format");
9101 if (stage == GLS_INIT || stage == GLS_ACTIVATION) {
9113 if (compression != 0) {
9114 DEBUG(grf, 7,
"LoadNewGRFFile: Unsupported compression format");
9126 DEBUG(grf, 7,
"LoadNewGRFFile: Custom .grf has invalid format");
9151 grfmsg(0,
"LoadNewGRFFile: Unexpected sprite, disabling");
9152 DisableGrf(STR_NEWGRF_ERROR_UNEXPECTED_SPRITE);
9217 static const uint32 override_features = (1 << GSF_TRAINS) | (1 << GSF_ROADVEHICLES) | (1 << GSF_SHIPS) | (1 << GSF_AIRCRAFT);
9220 int num_grfs = _grf_files.
Length();
9221 int *grf_overrides =
AllocaM(
int, num_grfs);
9222 for (
int i = 0; i < num_grfs; i++) {
9223 grf_overrides[i] = -1;
9225 GRFFile *source = _grf_files[i];
9226 uint32
override = _grf_id_overrides[source->grfid];
9227 if (
override == 0)
continue;
9230 if (dest == NULL)
continue;
9232 grf_overrides[i] = _grf_files.
FindIndex(dest);
9233 assert(grf_overrides[i] >= 0);
9237 for (
int i = 0; i < num_grfs; i++) {
9238 if (grf_overrides[i] < 0 || grf_overrides[i] >= i)
continue;
9239 GRFFile *source = _grf_files[i];
9240 GRFFile *dest = _grf_files[grf_overrides[i]];
9246 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9249 DEBUG(grf, 3,
"'%s' overrides price base multiplier %d of '%s'", source->filename, p, dest->filename);
9255 for (
int i = num_grfs - 1; i >= 0; i--) {
9256 if (grf_overrides[i] < 0 || grf_overrides[i] <= i)
continue;
9257 GRFFile *source = _grf_files[i];
9258 GRFFile *dest = _grf_files[grf_overrides[i]];
9264 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9267 DEBUG(grf, 3,
"Price base multiplier %d from '%s' propagated to '%s'", p, source->filename, dest->filename);
9273 for (
int i = 0; i < num_grfs; i++) {
9274 if (grf_overrides[i] < 0)
continue;
9275 GRFFile *source = _grf_files[i];
9276 GRFFile *dest = _grf_files[grf_overrides[i]];
9282 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9283 if (!
HasBit(features, _price_base_specs[p].grf_feature))
continue;
9285 DEBUG(grf, 3,
"Price base multiplier %d from '%s' propagated to '%s'", p, dest->filename, source->filename);
9292 const GRFFile *
const *end = _grf_files.
End();
9293 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
9294 if ((*file)->grf_version >= 8)
continue;
9295 PriceMultipliers &price_base_multipliers = (*file)->price_base_multipliers;
9296 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9298 if (fallback_price != INVALID_PRICE && price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9301 price_base_multipliers[p] = price_base_multipliers[fallback_price];
9307 for (
GRFFile **file = _grf_files.
Begin(); file != end; file++) {
9308 PriceMultipliers &price_base_multipliers = (*file)->price_base_multipliers;
9309 for (
Price p = PR_BEGIN; p < PR_END; p++) {
9310 if (price_base_multipliers[p] == INVALID_PRICE_MODIFIER) {
9312 price_base_multipliers[p] = 0;
9317 DEBUG(grf, 3,
"'%s' sets global price base multiplier %d", (*file)->filename, p);
9319 price_base_multipliers[p] = 0;
9321 DEBUG(grf, 3,
"'%s' sets local price base multiplier %d", (*file)->filename, p);
9336 _string_to_grf_mapping.
Clear();
9339 for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) {
9342 _grf_line_to_action6_sprite_override.clear();
9393 FOR_ALL_ENGINES_OF_TYPE(e,
VEH_ROAD) {
9406 e->u.rail.railtype = railtype;
9416 _grm_sprites.clear();
9465 for (GrfLoadingStage
stage = GLS_LABELSCAN;
stage <= GLS_ACTIVATION;
stage++) {
9472 if (
stage == GLS_RESERVE) {
9473 static const uint32 overrides[][2] = {
9474 { 0x44442202, 0x44440111 },
9475 { 0x6D620402, 0x6D620401 },
9476 { 0x4D656f20, 0x4D656F17 },
9478 for (
size_t i = 0; i <
lengthof(overrides); i++) {
9484 uint num_non_static = 0;
9493 DEBUG(grf, 0,
"NewGRF file is missing '%s'; disabling", c->filename);
9502 DEBUG(grf, 0,
"'%s' is not loaded as the maximum number of non-static GRFs has been reached", c->filename);
9504 c->error =
new GRFError(STR_NEWGRF_ERROR_MSG_FATAL, STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED);
9510 if (
stage == GLS_RESERVE) {
9512 }
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.
VehicleSettings vehicle
options for vehicles
static void FinaliseEngineArray()
Check for invalid engines.
TTDPAirportType ttd_airport_type
ttdpatch airport type (Small/Large/Helipad/Oilrig)
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.
SmallVector< Mapping, 1 > case_map
Mapping of NewGRF and OpenTTD IDs for cases.
GRF was disabled due to error.
const SpriteGroup ** groups
Take the group with appropriate index:
bool _networking
are we in networking mode?
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.
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
RailType
Enumeration for all possible railtypes.
Subdirectory
The different kinds of subdirectories OpenTTD uses.
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?
const Pair * Find(const T &key) const
Finds given key in this map.
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
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)
static bool IsInsideMM(const T x, const uint min, const uint max)
Checks if a value is in an interval.
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
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.
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.
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.
GRF file has been initialised.
Specification of a cargo type.
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.
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.
void Clear()
Remove all items from the list.
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)
const T * Begin() const
Get the pointer to the first item (const)
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.
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!)
EngineID GetID(VehicleType type, uint16 grf_local_id, uint32 grfid)
Looks up an EngineID in the EngineOverrideManager.
bool Insert(const T &key, const U &data)
Adds new item to this map.
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.
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.
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.
Simple vector template class.
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
ChangeInfoResult
Possible return values for the FeatureChangeInfo functions.
static void CleanIndustryTileTable(IndustrySpec *ind)
Clean the tile table of the IndustrySpec if it's needed.
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.
const IndustryTileTable *const * table
List of the tiles composing the industry.
Standard non-electric rails.
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
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.
static GRFError * DisableGrf(StringID message=STR_NULL, GRFConfig *config=NULL)
Disable a GRF.
uint16 callback_mask
Bitmask of house callbacks that have to be called.
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.
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.
uint tiles
Number of tile layouts.
bool improved_load
improved loading algorithm
static void DefineGotoLabel(ByteReader *buf)
Action 0x10 - Define goto label.
Year min_year
first year the airport is available
const T * End() const
Get the pointer behind the last valid item (const)
SmallVector< GRFParameterInfo *, 4 > param_info
NOSAVE: extra information about the parameters.
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.
Direction
Defines the 8 directions on the map.
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.
T * Append(uint to_add=1)
Append an item and return it.
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.
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.
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.
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.
byte noise_level
noise that this airport generates
Struct containing information relating to NewGRF classes for stations and airports.
struct RailtypeInfo::@40 strings
Strings associated with the rail type.
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
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=NULL, uint16 *max_palette_offset=NULL)
Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD...
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 draing 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.
bool IsTerminator() const
Check whether this is a sequence terminator.
static SmallVector< GRFFile *, 16 > _grf_files
List of all loaded GRF files.
const SpriteGroup ** loaded
List of loaded groups (can be SpriteIDs or Callback results)
uint Length() const
Get the number of items in the list.
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.
Functions related to engines.
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.
VehicleType
Available vehicle types.
SmallVector< RailTypeLabel, 4 > railtype_list
Railtype translation table.
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
SoundID GetNewGRFSoundID(const GRFFile *file, SoundID sound_id)
Resolve NewGRF sound ID.
byte num_bit
Number of bits to use for this parameter.
SmallMap< uint32, struct GRFText *, 8 > value_names
Names for each value.
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.
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.
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 psuedo 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.
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.
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)
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.
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).
byte num_table
Number of elements in the table.
Flag to disable visual effect.
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
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.
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
int FindIndex(const T &item) const
Search for the first occurrence of an item.
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)
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:
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.
SmallVector< CargoLabel, 4 > cargo_list
Cargo translation table (local ID -> label)
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.
VehicleTypeByte type
The engine type.
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 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.
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
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.
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.
static GRFFile * GetFileByFilename(const char *filename)
Obtain a NewGRF file by its filename.
const T * Get(uint index) const
Get the pointer to item "number" (const)
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.
Free the dynamically allocated tile layout structure.
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
static bool ValidateIndustryLayout(const IndustryTileTable *layout, int size)
Validate the industry layout; e.g.
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.
Flag for invalid railtype.
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.
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.
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.
uint16 multipliertowngrowth
Size of the effect.
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.
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.
SmallVector< Mapping, 1 > gender_map
Mapping of NewGRF and OpenTTD IDs for genders.
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.
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.
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.
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.