/* $Id$ */ /** @file newgrf.cpp */ #include "stdafx.h" #include #include "openttd.h" #include "debug.h" #include "fileio.h" #include "engine.h" #include "spritecache.h" #include "station.h" #include "sprite.h" #include "newgrf.h" #include "variables.h" #include "table/strings.h" #include "bridge.h" #include "town.h" #include "newgrf_engine.h" #include "newgrf_text.h" #include "table/sprites.h" #include "fontcache.h" #include "currency.h" #include "landscape.h" #include "newgrf_config.h" #include "newgrf_house.h" #include "newgrf_sound.h" #include "newgrf_spritegroup.h" #include "table/town_land.h" #include "cargotype.h" #include "industry.h" #include "newgrf_canal.h" #include "table/build_industry.h" #include "newgrf_commons.h" #include "newgrf_townname.h" #include "newgrf_industries.h" #include "table/landscape_sprite.h" #include "gfxinit.h" #include "fios.h" #include "rail.h" #include "strings_func.h" #include "gfx_func.h" #include "date_func.h" #include "vehicle_func.h" #include "sound_func.h" #include "string_func.h" /* TTDPatch extended GRF format codec * (c) Petr Baudis 2004 (GPL'd) * Changes by Florian octo Forster are (c) by the OpenTTD development team. * * Contains portions of documentation by TTDPatch team. * Thanks especially to Josef Drexler for the documentation as well as a lot * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which * served as subject to the initial testing of this codec. */ static int _skip_sprites; // XXX static uint _file_index; // XXX static GRFFile *_cur_grffile; GRFFile *_first_grffile; static SpriteID _cur_spriteid; static GrfLoadingStage _cur_stage; static uint32 _nfo_line; static GRFConfig *_cur_grfconfig; /* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */ static byte _misc_grf_features = 0; /* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */ static uint32 _ttdpatch_flags[8]; /* Used by Action 0x06 to preload a pseudo sprite and modify its content */ static byte *_preload_sprite = NULL; /* Indicates which are the newgrf features currently loaded ingame */ GRFLoadedFeatures _loaded_newgrf_features; enum GrfDataType { GDT_SOUND, }; static byte _grf_data_blocks; static GrfDataType _grf_data_type; enum grfspec_feature { GSF_TRAIN, GSF_ROAD, GSF_SHIP, GSF_AIRCRAFT, GSF_STATION, GSF_CANAL, GSF_BRIDGE, GSF_TOWNHOUSE, GSF_GLOBALVAR, GSF_INDUSTRYTILES, GSF_INDUSTRIES, GSF_CARGOS, GSF_SOUNDFX, }; typedef void (*SpecialSpriteHandler)(byte *buf, int len); static const uint _vehcounts[4] = { /* GSF_TRAIN */ NUM_TRAIN_ENGINES, /* GSF_ROAD */ NUM_ROAD_ENGINES, /* GSF_SHIP */ NUM_SHIP_ENGINES, /* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES }; static const uint _vehshifts[4] = { /* GSF_TRAIN */ 0, /* GSF_ROAD */ ROAD_ENGINES_INDEX, /* GSF_SHIP */ SHIP_ENGINES_INDEX, /* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX, }; enum { MAX_STATIONS = 256, }; static uint16 cargo_allowed[TOTAL_NUM_ENGINES]; static uint16 cargo_disallowed[TOTAL_NUM_ENGINES]; /* Contains the GRF ID of the owner of a vehicle if it has been reserved */ static uint32 _grm_engines[TOTAL_NUM_ENGINES]; /* Contains the GRF ID of the owner of a cargo if it has been reserved */ static uint32 _grm_cargos[NUM_CARGO]; /** DEBUG() function dedicated to newGRF debugging messages * Function is essentialy the same as DEBUG(grf, severity, ...) with the * addition of file:line information when parsing grf files. * NOTE: for the above reason(s) grfmsg() should ONLY be used for * loading/parsing grf files, not for runtime debug messages as there * is no file information available during that time. * @param severity debugging severity level, see debug.h * @param str message in printf() format */ void CDECL grfmsg(int severity, const char *str, ...) { char buf[1024]; va_list va; va_start(va, str); vsnprintf(buf, sizeof(buf), str, va); va_end(va); DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf); } static inline bool check_length(int real, int wanted, const char *str) { if (real >= wanted) return true; grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted); return false; } static inline byte grf_load_byte(byte **buf) { return *(*buf)++; } static uint16 grf_load_word(byte **buf) { uint16 val = grf_load_byte(buf); return val | (grf_load_byte(buf) << 8); } static uint16 grf_load_extended(byte** buf) { uint16 val; val = grf_load_byte(buf); if (val == 0xFF) val = grf_load_word(buf); return val; } static uint32 grf_load_dword(byte **buf) { uint32 val = grf_load_word(buf); return val | (grf_load_word(buf) << 16); } static uint32 grf_load_var(byte size, byte **buf) { switch (size) { case 1: return grf_load_byte(buf); case 2: return grf_load_word(buf); case 4: return grf_load_dword(buf); default: NOT_REACHED(); return 0; } } static const char *grf_load_string(byte **buf, size_t max_len) { const char *string = *(const char **)buf; size_t string_length = ttd_strnlen(string, max_len); if (string_length == max_len) { /* String was not NUL terminated, so make sure it is now. */ (*buf)[string_length - 1] = '\0'; grfmsg(7, "String was not terminated with a zero byte."); } else { /* Increase the string length to include the NUL byte. */ string_length++; } *buf += string_length; return string; } static GRFFile *GetFileByGRFID(uint32 grfid) { GRFFile *file; for (file = _first_grffile; file != NULL; file = file->next) { if (file->grfid == grfid) break; } return file; } static GRFFile *GetFileByFilename(const char *filename) { GRFFile *file; for (file = _first_grffile; file != NULL; file = file->next) { if (strcmp(file->filename, filename) == 0) break; } return file; } /** Used when setting an object's property to map to the GRF's strings * while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one * @param grfid Id of the grf file * @param str StringID that we want to have the equivalent in OoenTTD * @return the properly adjusted StringID */ StringID MapGRFStringID(uint32 grfid, StringID str) { /* StringID table for TextIDs 0x4E->0x6D */ static StringID units_volume[] = { STR_NOTHING, STR_PASSENGERS, STR_TONS, STR_BAGS, STR_LITERS, STR_ITEMS, STR_CRATES, STR_TONS, STR_TONS, STR_TONS, STR_TONS, STR_BAGS, STR_TONS, STR_TONS, STR_TONS, STR_BAGS, STR_TONS, STR_TONS, STR_BAGS, STR_LITERS, STR_TONS, STR_LITERS, STR_TONS, STR_NOTHING, STR_BAGS, STR_LITERS, STR_TONS, STR_NOTHING, STR_TONS, STR_NOTHING, STR_LITERS, STR_NOTHING }; /* 0xD0 and 0xDC stand for all the TextIDs in the range * of 0xD000 (misc graphics texts) and 0xDC00 (misc persistent texts). * These strings are unique to each grf file, and thus require to be used with the * grfid in which they are declared */ if (GB(str, 8, 8) == 0xD0 || GB(str, 8, 8) == 0xDC) { return GetGRFStringID(grfid, str); } #define TEXID_TO_STRINGID(begin, end, stringid) if (str >= begin && str <= end) return str + (stringid - begin) /* We have some changes in our cargo strings, resulting in some missing. */ TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E); TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E); if (str >= 0x004E && str <= 0x006D) str = units_volume[str - 0x004E]; TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING); TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING); /* Map building names according to our lang file changes. There are several * ranges of house ids, all of which need to be remapped to allow newgrfs * to use original house names. */ TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK); TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES); TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO); /* Same thing for industries, since the introduction of 4 new strings above STR_482A_PRODUCTION_LAST_MONTH */ TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH); #undef TEXTID_TO_STRINGID if (str == STR_NULL) return STR_EMPTY; return str; } static uint8 MapDOSColour(uint8 colour) { if (_use_dos_palette) return colour; if (colour < 10) { static uint8 dos_to_win_colour_map[] = { 0, 215, 216, 136, 88, 106, 32, 33, 40, 245 }; return dos_to_win_colour_map[colour]; } if (colour >= 245 && colour < 254) return colour - 28; return colour; } typedef bool (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len); static void dewagonize(int condition, int engine) { EngineInfo *ei = &_engine_info[engine]; RailVehicleInfo *rvi = &_rail_vehicle_info[engine]; if (condition != 0) { ei->unk2 &= ~0x80; if (rvi->railveh_type == RAILVEH_WAGON) rvi->railveh_type = RAILVEH_SINGLEHEAD; } else { ei->unk2 |= 0x80; rvi->railveh_type = RAILVEH_WAGON; } } static bool RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; for (int i = 0; i < numinfo; i++) { EngineInfo *ei = &_engine_info[engine + i]; RailVehicleInfo *rvi = &_rail_vehicle_info[engine + i]; switch (prop) { case 0x05: { // Track type uint8 tracktype = grf_load_byte(&buf); switch (tracktype) { case 0: rvi->railtype = rvi->engclass >= 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break; case 1: rvi->railtype = RAILTYPE_MONO; break; case 2: rvi->railtype = RAILTYPE_MAGLEV; break; default: grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype); break; } } break; case 0x08: // AI passenger service /** @todo Tells the AI that this engine is designed for * passenger services and shouldn't be used for freight. */ grf_load_byte(&buf); ret = true; break; case 0x09: { // Speed (1 unit is 1 kmh) uint16 speed = grf_load_word(&buf); if (speed == 0xFFFF) speed = 0; rvi->max_speed = speed; } break; case 0x0B: { // Power uint16 power = grf_load_word(&buf); if (rvi->railveh_type == RAILVEH_MULTIHEAD) power /= 2; rvi->power = power; dewagonize(power, engine + i); } break; case 0x0D: { // Running cost factor uint8 runcostfact = grf_load_byte(&buf); if (rvi->railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2; rvi->running_cost_base = runcostfact; } break; case 0x0E: { // Running cost base uint32 base = grf_load_dword(&buf); switch (base) { case 0x4C30: rvi->running_cost_class = 0; break; case 0x4C36: rvi->running_cost_class = 1; break; case 0x4C3C: rvi->running_cost_class = 2; break; case 0: break; // Used by wagons default: grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base); break; } } break; case 0x12: { // Sprite ID uint8 spriteid = grf_load_byte(&buf); /* TTD sprite IDs point to a location in a 16bit array, but we use it * as an array index, so we need it to be half the original value. */ if (spriteid < 0xFD) spriteid >>= 1; rvi->image_index = spriteid; } break; case 0x13: { // Dual-headed uint8 dual = grf_load_byte(&buf); if (dual != 0) { if (rvi->railveh_type != RAILVEH_MULTIHEAD) { // adjust power and running cost if needed rvi->power /= 2; rvi->running_cost_base /= 2; } rvi->railveh_type = RAILVEH_MULTIHEAD; } else { if (rvi->railveh_type == RAILVEH_MULTIHEAD) { // adjust power and running cost if needed rvi->power *= 2; rvi->running_cost_base *= 2; } rvi->railveh_type = rvi->power == 0 ? RAILVEH_WAGON : RAILVEH_SINGLEHEAD; } } break; case 0x14: // Cargo capacity rvi->capacity = grf_load_byte(&buf); break; case 0x15: { // Cargo type uint8 ctype = grf_load_byte(&buf); if (ctype < NUM_CARGO && HasBit(_cargo_mask, ctype)) { rvi->cargo_type = ctype; } else { rvi->cargo_type = CT_INVALID; grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype); } } break; case 0x16: // Weight SB(rvi->weight, 0, 8, grf_load_byte(&buf)); break; case 0x17: // Cost factor rvi->base_cost = grf_load_byte(&buf); break; case 0x18: // AI rank rvi->ai_rank = grf_load_byte(&buf); break; case 0x19: { // Engine traction type /* What do the individual numbers mean? * 0x00 .. 0x07: Steam * 0x08 .. 0x27: Diesel * 0x28 .. 0x31: Electric * 0x32 .. 0x37: Monorail * 0x38 .. 0x41: Maglev */ uint8 traction = grf_load_byte(&buf); EngineClass engclass; if (traction <= 0x07) { engclass = EC_STEAM; } else if (traction <= 0x27) { engclass = EC_DIESEL; } else if (traction <= 0x31) { engclass = EC_ELECTRIC; } else if (traction <= 0x37) { engclass = EC_MONORAIL; } else if (traction <= 0x41) { engclass = EC_MAGLEV; } else { break; } if (rvi->railtype == RAILTYPE_RAIL && engclass >= EC_ELECTRIC) rvi->railtype = RAILTYPE_ELECTRIC; if (rvi->railtype == RAILTYPE_ELECTRIC && engclass < EC_ELECTRIC) rvi->railtype = RAILTYPE_RAIL; rvi->engclass = engclass; } break; case 0x1A: { // Alter purchase list sort order EngineID pos = grf_load_byte(&buf); if (pos < NUM_TRAIN_ENGINES) { AlterRailVehListOrder(engine + i, pos); } else { grfmsg(2, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring", pos); } } break; case 0x1B: // Powered wagons power bonus rvi->pow_wag_power = grf_load_word(&buf); break; case 0x1C: // Refit cost ei->refit_cost = grf_load_byte(&buf); break; case 0x1D: // Refit cargo ei->refit_mask = grf_load_dword(&buf); break; case 0x1E: // Callback ei->callbackmask = grf_load_byte(&buf); break; case 0x1F: // Tractive effort coefficient rvi->tractive_effort = grf_load_byte(&buf); break; case 0x20: // Air drag /** @todo Air drag for trains. */ grf_load_byte(&buf); ret = true; break; case 0x21: // Shorter vehicle rvi->shorten_factor = grf_load_byte(&buf); break; case 0x22: // Visual effect /** @see note in engine.h about rvi->visual_effect */ rvi->visual_effect = grf_load_byte(&buf); break; case 0x23: // Powered wagons weight bonus rvi->pow_wag_weight = grf_load_byte(&buf); break; case 0x24: { // High byte of vehicle weight byte weight = grf_load_byte(&buf); if (weight > 4) { grfmsg(2, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8); } else { SB(rvi->weight, 8, 8, weight); } } break; case 0x25: // User-defined bit mask to set when checking veh. var. 42 rvi->user_def_data = grf_load_byte(&buf); break; case 0x26: // Retire vehicle early ei->retire_early = grf_load_byte(&buf); break; case 0x27: // Miscellaneous flags ei->misc_flags = grf_load_byte(&buf); _loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC); break; case 0x28: // Cargo classes allowed cargo_allowed[engine + i] = grf_load_word(&buf); break; case 0x29: // Cargo classes disallowed cargo_disallowed[engine + i] = grf_load_word(&buf); break; case 0x2A: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool RoadVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; for (int i = 0; i < numinfo; i++) { EngineInfo *ei = &_engine_info[ROAD_ENGINES_INDEX + engine + i]; RoadVehicleInfo *rvi = &_road_vehicle_info[engine + i]; switch (prop) { case 0x08: // Speed (1 unit is 0.5 kmh) rvi->max_speed = grf_load_byte(&buf); break; case 0x09: // Running cost factor rvi->running_cost = grf_load_byte(&buf); break; case 0x0A: // Running cost base /** @todo : I have no idea. --pasky * I THINK it is used for overriding the base cost of all road vehicle (_price.roadveh_base) --belugas */ grf_load_dword(&buf); ret = true; break; case 0x0E: { // Sprite ID uint8 spriteid = grf_load_byte(&buf); /* cars have different custom id in the GRF file */ if (spriteid == 0xFF) spriteid = 0xFD; if (spriteid < 0xFD) spriteid >>= 1; rvi->image_index = spriteid; } break; case 0x0F: // Cargo capacity rvi->capacity = grf_load_byte(&buf); break; case 0x10: { // Cargo type uint8 cargo = grf_load_byte(&buf); if (cargo < NUM_CARGO && HasBit(_cargo_mask, cargo)) { rvi->cargo_type = cargo; } else { rvi->cargo_type = CT_INVALID; grfmsg(2, "RoadVehicleChangeInfo: Invalid cargo type %d, using first refittable", cargo); } } break; case 0x11: // Cost factor rvi->base_cost = grf_load_byte(&buf); // ?? is it base_cost? break; case 0x12: // SFX rvi->sfx = (SoundFx)grf_load_byte(&buf); break; case 0x13: // Power in 10hp case 0x14: // Weight in 1/4 tons case 0x15: // Speed in mph*0.8 /** @todo Support for road vehicles realistic power * computations (called rvpower in TTDPatch) is just * missing in OTTD yet. --pasky */ grf_load_byte(&buf); ret = true; break; case 0x16: // Cargos available for refitting ei->refit_mask = grf_load_dword(&buf); break; case 0x17: // Callback mask ei->callbackmask = grf_load_byte(&buf); break; case 0x18: // Tractive effort case 0x19: // Air drag /** @todo Tractive effort and air drag for road vehicles. */ grf_load_byte(&buf); ret = true; break; case 0x1A: // Refit cost ei->refit_cost = grf_load_byte(&buf); break; case 0x1B: // Retire vehicle early ei->retire_early = grf_load_byte(&buf); break; case 0x1C: // Miscellaneous flags ei->misc_flags = grf_load_byte(&buf); _loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC); break; case 0x1D: // Cargo classes allowed cargo_allowed[ROAD_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x1E: // Cargo classes disallowed cargo_disallowed[ROAD_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x1F: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool ShipVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; for (int i = 0; i < numinfo; i++) { EngineInfo *ei = &_engine_info[SHIP_ENGINES_INDEX + engine + i]; ShipVehicleInfo *svi = &_ship_vehicle_info[engine + i]; switch (prop) { case 0x08: { // Sprite ID uint8 spriteid = grf_load_byte(&buf); /* ships have different custom id in the GRF file */ if (spriteid == 0xFF) spriteid = 0xFD; if (spriteid < 0xFD) spriteid >>= 1; svi->image_index = spriteid; } break; case 0x09: // Refittable svi->refittable = (grf_load_byte(&buf) != 0); break; case 0x0A: // Cost factor svi->base_cost = grf_load_byte(&buf); // ?? is it base_cost? break; case 0x0B: // Speed (1 unit is 0.5 kmh) svi->max_speed = grf_load_byte(&buf); break; case 0x0C: { // Cargo type uint8 cargo = grf_load_byte(&buf); if (cargo < NUM_CARGO && HasBit(_cargo_mask, cargo)) { svi->cargo_type = cargo; } else { svi->cargo_type = CT_INVALID; grfmsg(2, "ShipVehicleChangeInfo: Invalid cargo type %d, using first refittable", cargo); } } break; case 0x0D: // Cargo capacity svi->capacity = grf_load_word(&buf); break; case 0x0F: // Running cost factor svi->running_cost = grf_load_byte(&buf); break; case 0x10: // SFX svi->sfx = (SoundFx)grf_load_byte(&buf); break; case 0x11: // Cargos available for refitting ei->refit_mask = grf_load_dword(&buf); break; case 0x12: // Callback mask ei->callbackmask = grf_load_byte(&buf); break; case 0x13: // Refit cost ei->refit_cost = grf_load_byte(&buf); break; case 0x14: // Ocean speed fraction case 0x15: // Canal speed fraction /** @todo Speed fractions for ships on oceans and canals */ grf_load_byte(&buf); ret = true; break; case 0x16: // Retire vehicle early ei->retire_early = grf_load_byte(&buf); break; case 0x17: // Miscellaneous flags ei->misc_flags = grf_load_byte(&buf); _loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC); break; case 0x18: // Cargo classes allowed cargo_allowed[SHIP_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x19: // Cargo classes disallowed cargo_disallowed[SHIP_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x1A: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; for (int i = 0; i < numinfo; i++) { EngineInfo *ei = &_engine_info[AIRCRAFT_ENGINES_INDEX + engine + i]; AircraftVehicleInfo *avi = &_aircraft_vehicle_info[engine + i]; switch (prop) { case 0x08: { // Sprite ID uint8 spriteid = grf_load_byte(&buf); /* aircraft have different custom id in the GRF file */ if (spriteid == 0xFF) spriteid = 0xFD; if (spriteid < 0xFD) spriteid >>= 1; avi->image_index = spriteid; } break; case 0x09: // Helicopter if (grf_load_byte(&buf) == 0) { avi->subtype = AIR_HELI; } else { SB(avi->subtype, 0, 1, 1); // AIR_CTOL } break; case 0x0A: // Large SB(avi->subtype, 1, 1, (grf_load_byte(&buf) != 0 ? 1 : 0)); // AIR_FAST break; case 0x0B: // Cost factor avi->base_cost = grf_load_byte(&buf); // ?? is it base_cost? break; case 0x0C: // Speed (1 unit is 8 mph, we translate to 1 unit is 1 km/h) avi->max_speed = (grf_load_byte(&buf) * 129) / 10; break; case 0x0D: // Acceleration avi->acceleration = (grf_load_byte(&buf) * 129) / 10; break; case 0x0E: // Running cost factor avi->running_cost = grf_load_byte(&buf); break; case 0x0F: // Passenger capacity avi->passenger_capacity = grf_load_word(&buf); break; case 0x11: // Mail capacity avi->mail_capacity = grf_load_byte(&buf); break; case 0x12: // SFX avi->sfx = (SoundFx)grf_load_byte(&buf); break; case 0x13: // Cargos available for refitting ei->refit_mask = grf_load_dword(&buf); break; case 0x14: // Callback mask ei->callbackmask = grf_load_byte(&buf); break; case 0x15: // Refit cost ei->refit_cost = grf_load_byte(&buf); break; case 0x16: // Retire vehicle early ei->retire_early = grf_load_byte(&buf); break; case 0x17: // Miscellaneous flags ei->misc_flags = grf_load_byte(&buf); _loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC); break; case 0x18: // Cargo classes allowed cargo_allowed[AIRCRAFT_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x19: // Cargo classes disallowed cargo_disallowed[AIRCRAFT_ENGINES_INDEX + engine + i] = grf_load_word(&buf); break; case 0x1A: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool StationChangeInfo(uint stid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (stid + numinfo > MAX_STATIONS) { grfmsg(1, "StationChangeInfo: Station %u is invalid, max %u, ignoring", stid + numinfo, MAX_STATIONS); return false; } /* Allocate station specs if necessary */ if (_cur_grffile->stations == NULL) _cur_grffile->stations = CallocT(MAX_STATIONS); for (int i = 0; i < numinfo; i++) { StationSpec *statspec = _cur_grffile->stations[stid + i]; /* Check that the station we are modifying is defined. */ if (statspec == NULL && prop != 0x08) { grfmsg(2, "StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i); continue; } switch (prop) { case 0x08: { // Class ID StationSpec **spec = &_cur_grffile->stations[stid + i]; /* Property 0x08 is special; it is where the station is allocated */ if (*spec == NULL) *spec = CallocT(1); /* Swap classid because we read it in BE meaning WAYP or DFLT */ uint32 classid = grf_load_dword(&buf); (*spec)->sclass = AllocateStationClass(BSWAP32(classid)); } break; case 0x09: // Define sprite layout statspec->tiles = grf_load_extended(&buf); statspec->renderdata = CallocT(statspec->tiles); statspec->copied_renderdata = false; for (uint t = 0; t < statspec->tiles; t++) { DrawTileSprites *dts = &statspec->renderdata[t]; uint seq_count = 0; dts->seq = NULL; dts->ground_sprite = grf_load_word(&buf); dts->ground_pal = grf_load_word(&buf); if (dts->ground_sprite == 0) continue; if (HasBit(dts->ground_pal, 15)) { ClrBit(dts->ground_pal, 15); SetBit(dts->ground_sprite, SPRITE_MODIFIER_USE_OFFSET); } if (HasBit(dts->ground_pal, 14)) { ClrBit(dts->ground_pal, 14); SetBit(dts->ground_sprite, SPRITE_MODIFIER_OPAQUE); } if (HasBit(dts->ground_sprite, 15)) { ClrBit(dts->ground_sprite, 15); SetBit(dts->ground_sprite, PALETTE_MODIFIER_COLOR); } if (HasBit(dts->ground_sprite, 14)) { ClrBit(dts->ground_sprite, 14); SetBit(dts->ground_sprite, PALETTE_MODIFIER_TRANSPARENT); } while (buf < *bufp + len) { DrawTileSeqStruct *dtss; /* no relative bounding box support */ dts->seq = ReallocT((DrawTileSeqStruct*)dts->seq, ++seq_count); dtss = (DrawTileSeqStruct*) &dts->seq[seq_count - 1]; dtss->delta_x = grf_load_byte(&buf); if ((byte) dtss->delta_x == 0x80) break; dtss->delta_y = grf_load_byte(&buf); dtss->delta_z = grf_load_byte(&buf); dtss->size_x = grf_load_byte(&buf); dtss->size_y = grf_load_byte(&buf); dtss->size_z = grf_load_byte(&buf); dtss->image = grf_load_word(&buf); dtss->pal = grf_load_word(&buf); /* Remap flags as ours collide */ if (HasBit(dtss->pal, 15)) { ClrBit(dtss->pal, 15); SetBit(dtss->image, SPRITE_MODIFIER_USE_OFFSET); } if (HasBit(dtss->pal, 14)) { ClrBit(dtss->pal, 14); SetBit(dtss->image, SPRITE_MODIFIER_OPAQUE); } if (HasBit(dtss->image, 15)) { ClrBit(dtss->image, 15); SetBit(dtss->image, PALETTE_MODIFIER_COLOR); } if (HasBit(dtss->image, 14)) { ClrBit(dtss->image, 14); SetBit(dtss->image, PALETTE_MODIFIER_TRANSPARENT); } } } break; case 0x0A: { // Copy sprite layout byte srcid = grf_load_byte(&buf); const StationSpec *srcstatspec = _cur_grffile->stations[srcid]; statspec->tiles = srcstatspec->tiles; statspec->renderdata = srcstatspec->renderdata; statspec->copied_renderdata = true; } break; case 0x0B: // Callback mask statspec->callbackmask = grf_load_byte(&buf); break; case 0x0C: // Disallowed number of platforms statspec->disallowed_platforms = grf_load_byte(&buf); break; case 0x0D: // Disallowed platform lengths statspec->disallowed_lengths = grf_load_byte(&buf); break; case 0x0E: // Define custom layout statspec->copied_layouts = false; while (buf < *bufp + len) { byte length = grf_load_byte(&buf); byte number = grf_load_byte(&buf); StationLayout layout; uint l, p; if (length == 0 || number == 0) break; //debug("l %d > %d ?", length, stat->lengths); if (length > statspec->lengths) { statspec->platforms = ReallocT(statspec->platforms, length); memset(statspec->platforms + statspec->lengths, 0, length - statspec->lengths); statspec->layouts = ReallocT(statspec->layouts, length); memset(statspec->layouts + statspec->lengths, 0, (length - statspec->lengths) * sizeof(*statspec->layouts)); statspec->lengths = length; } l = length - 1; // index is zero-based //debug("p %d > %d ?", number, stat->platforms[l]); if (number > statspec->platforms[l]) { statspec->layouts[l] = ReallocT(statspec->layouts[l], number); /* We expect NULL being 0 here, but C99 guarantees that. */ memset(statspec->layouts[l] + statspec->platforms[l], 0, (number - statspec->platforms[l]) * sizeof(**statspec->layouts)); statspec->platforms[l] = number; } p = 0; layout = MallocT(length * number); for (l = 0; l < length; l++) { for (p = 0; p < number; p++) { layout[l * number + p] = grf_load_byte(&buf); } } l--; p--; free(statspec->layouts[l][p]); statspec->layouts[l][p] = layout; } break; case 0x0F: { // Copy custom layout byte srcid = grf_load_byte(&buf); const StationSpec *srcstatspec = _cur_grffile->stations[srcid]; statspec->lengths = srcstatspec->lengths; statspec->platforms = srcstatspec->platforms; statspec->layouts = srcstatspec->layouts; statspec->copied_layouts = true; } break; case 0x10: // Little/lots cargo threshold statspec->cargo_threshold = grf_load_word(&buf); break; case 0x11: // Pylon placement statspec->pylons = grf_load_byte(&buf); break; case 0x12: // Cargo types for random triggers statspec->cargo_triggers = grf_load_dword(&buf); break; case 0x13: // General flags statspec->flags = grf_load_byte(&buf); break; case 0x14: // Overhead wire placement statspec->wires = grf_load_byte(&buf); break; case 0x15: // Blocked tiles statspec->blocked = grf_load_byte(&buf); break; case 0x16: // @todo Animation info grf_load_word(&buf); ret = true; break; case 0x17: // @todo Animation speed grf_load_byte(&buf); ret = true; break; case 0x18: // @todo Animation triggers grf_load_word(&buf); ret = true; break; default: ret = true; break; } } *bufp = buf; return ret; } static bool BridgeChangeInfo(uint brid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (brid + numinfo > MAX_BRIDGES) { grfmsg(1, "BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo, MAX_BRIDGES); return false; } for (int i = 0; i < numinfo; i++) { Bridge *bridge = &_bridge[brid + i]; switch (prop) { case 0x08: // Year of availability bridge->avail_year = ORIGINAL_BASE_YEAR + grf_load_byte(&buf); break; case 0x09: // Minimum length bridge->min_length = grf_load_byte(&buf); break; case 0x0A: // Maximum length bridge->max_length = grf_load_byte(&buf); break; case 0x0B: // Cost factor bridge->price = grf_load_byte(&buf); break; case 0x0C: // Maximum speed bridge->speed = grf_load_word(&buf); break; case 0x0D: { // Bridge sprite tables byte tableid = grf_load_byte(&buf); byte numtables = grf_load_byte(&buf); if (bridge->sprite_table == NULL) { /* Allocate memory for sprite table pointers and zero out */ bridge->sprite_table = CallocT(7); } for (; numtables-- != 0; tableid++) { if (tableid >= 7) { // skip invalid data grfmsg(1, "BridgeChangeInfo: Table %d >= 7, skipping", tableid); for (byte sprite = 0; sprite < 32; sprite++) grf_load_dword(&buf); continue; } if (bridge->sprite_table[tableid] == NULL) { bridge->sprite_table[tableid] = MallocT(32); } for (byte sprite = 0; sprite < 32; sprite++) { SpriteID image = grf_load_word(&buf); SpriteID pal = grf_load_word(&buf); if (HasBit(pal, 15)) { SetBit(image, PALETTE_MODIFIER_TRANSPARENT); } /* Clear old color modifer bit */ ClrBit(image, 15); bridge->sprite_table[tableid][sprite].sprite = image; bridge->sprite_table[tableid][sprite].pal = pal; } } } break; case 0x0E: // Flags; bit 0 - disable far pillars bridge->flags = grf_load_byte(&buf); break; case 0x0F: // Long format year of availability (year since year 0) bridge->avail_year = Clamp(grf_load_dword(&buf), MIN_YEAR, MAX_YEAR); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool TownHouseChangeInfo(uint hid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (hid + numinfo > HOUSE_MAX) { grfmsg(1, "TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo, HOUSE_MAX); return false; } /* Allocate house specs if they haven't been allocated already. */ if (_cur_grffile->housespec == NULL) { _cur_grffile->housespec = CallocT(HOUSE_MAX); } for (int i = 0; i < numinfo; i++) { HouseSpec *housespec = _cur_grffile->housespec[hid + i]; if (prop != 0x08 && housespec == NULL) { grfmsg(2, "TownHouseChangeInfo: Attempt to modify undefined house %u. Ignoring.", hid + i); continue; } switch (prop) { case 0x08: { // Substitute building type, and definition of a new house HouseSpec **house = &_cur_grffile->housespec[hid + i]; byte subs_id = grf_load_byte(&buf); if (subs_id == 0xFF) { /* Instead of defining a new house, a substitute house id * of 0xFF disables the old house with the current id. */ _house_specs[hid + i].enabled = false; continue; } else if (subs_id >= NEW_HOUSE_OFFSET) { /* The substitute id must be one of the original houses. */ grfmsg(2, "TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i); return false; } /* Allocate space for this house. */ if (*house == NULL) *house = CallocT(1); housespec = *house; memcpy(housespec, &_house_specs[subs_id], sizeof(_house_specs[subs_id])); housespec->enabled = true; housespec->local_id = hid + i; housespec->substitute_id = subs_id; housespec->grffile = _cur_grffile; housespec->random_colour[0] = 0x04; // those 4 random colours are the base colour housespec->random_colour[1] = 0x08; // for all new houses housespec->random_colour[2] = 0x0C; // they stand for red, blue, orange and green housespec->random_colour[3] = 0x06; /* Make sure that the third cargo type is valid in this * climate. This can cause problems when copying the properties * of a house that accepts food, where the new house is valid * in the temperate climate. */ if (!GetCargo(housespec->accepts_cargo[2])->IsValid()) { housespec->cargo_acceptance[2] = 0; } /** * New houses do not (currently) expect to have a default start * date before 1930, as this breaks the build date stuff. * @see FinaliseHouseArray() for more details. */ if (housespec->min_date < 1930) housespec->min_date = 1930; _loaded_newgrf_features.has_newhouses = true; } break; case 0x09: // Building flags housespec->building_flags = (BuildingFlags)grf_load_byte(&buf); break; case 0x0A: { // Availability years uint16 years = grf_load_word(&buf); housespec->min_date = GB(years, 0, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 0, 8); housespec->max_date = GB(years, 8, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 8, 8); } break; case 0x0B: // Population housespec->population = grf_load_byte(&buf); break; case 0x0C: // Mail generation multiplier housespec->mail_generation = grf_load_byte(&buf); break; case 0x0D: // Passenger acceptance case 0x0E: // Mail acceptance housespec->cargo_acceptance[prop - 0x0D] = grf_load_byte(&buf); break; case 0x0F: { // Goods/candy, food/fizzy drinks acceptance int8 goods = grf_load_byte(&buf); /* If value of goods is negative, it means in fact food or, if in toyland, fizzy_drink acceptance. * Else, we have "standard" 3rd cargo type, goods or candy, for toyland once more */ CargoID cid = (goods >= 0) ? ((_opt.landscape == LT_TOYLAND) ? CT_CANDY : CT_GOODS) : ((_opt.landscape == LT_TOYLAND) ? CT_FIZZY_DRINKS : CT_FOOD); /* Make sure the cargo type is valid in this climate. */ if (!GetCargo(cid)->IsValid()) goods = 0; housespec->accepts_cargo[2] = cid; housespec->cargo_acceptance[2] = abs(goods); // but we do need positive value here } break; case 0x10: // Local authority rating decrease on removal housespec->remove_rating_decrease = grf_load_word(&buf); break; case 0x11: // Removal cost multiplier housespec->removal_cost = grf_load_byte(&buf); break; case 0x12: // Building name ID housespec->building_name = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x13: // Building availability mask housespec->building_availability = (HouseZones)grf_load_word(&buf); break; case 0x14: // House callback flags housespec->callback_mask = grf_load_byte(&buf); break; case 0x15: { // House override byte byte override = grf_load_byte(&buf); /* The house being overridden must be an original house. */ if (override >= NEW_HOUSE_OFFSET) { grfmsg(2, "TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.", override, hid + i); continue; } _house_mngr.Add(hid + i, _cur_grffile->grfid, override); } break; case 0x16: // Periodic refresh multiplier housespec->processing_time = grf_load_byte(&buf); break; case 0x17: // Four random colours to use for (uint j = 0; j < 4; j++) housespec->random_colour[j] = grf_load_byte(&buf); break; case 0x18: // Relative probability of appearing housespec->probability = grf_load_byte(&buf); break; case 0x19: // Extra flags housespec->extra_flags = (HouseExtraFlags)grf_load_byte(&buf); break; case 0x1A: // Animation frames housespec->animation_frames = grf_load_byte(&buf); break; case 0x1B: // Animation speed housespec->animation_speed = Clamp(grf_load_byte(&buf), 2, 16); break; case 0x1C: // Class of the building type housespec->class_id = AllocateHouseClassID(grf_load_byte(&buf), _cur_grffile->grfid); break; case 0x1D: // Callback flags 2 housespec->callback_mask |= (grf_load_byte(&buf) << 8); break; case 0x1E: { // Accepted cargo types uint32 cargotypes = grf_load_dword(&buf); /* Check if the cargo types should not be changed */ if (cargotypes == 0xFFFFFFFF) break; for (uint j = 0; j < 3; j++) { /* Get the cargo number from the 'list' */ uint8 cargo_part = GB(cargotypes, 8 * j, 8); CargoID cargo = GetCargoTranslation(cargo_part, _cur_grffile); if (cargo == CT_INVALID) { /* Disable acceptance of invalid cargo type */ housespec->cargo_acceptance[j] = 0; } else { housespec->accepts_cargo[j] = cargo; } } } break; case 0x1F: // Minimum life span housespec->minimum_life = grf_load_byte(&buf); break; case 0x20: { // @todo Cargo acceptance watch list byte count = grf_load_byte(&buf); for (byte j = 0; j < count; j++) grf_load_byte(&buf); ret = true; } break; default: ret = true; break; } } *bufp = buf; return ret; } static bool GlobalVarChangeInfo(uint gvid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; for (int i = 0; i < numinfo; i++) { switch (prop) { case 0x08: { // Cost base factor byte factor = grf_load_byte(&buf); uint price = gvid + i; if (price < NUM_PRICES) { SetPriceBaseMultiplier(price, factor); } else { grfmsg(1, "GlobalVarChangeInfo: Price %d out of range, ignoring", price); } } break; case 0x09: { // Cargo translation table if (gvid != 0) { if (i == 0) grfmsg(1, "InitChangeInfo: Cargo translation table must start at zero"); /* Skip data */ buf += 4; break; } if (i == 0) { free(_cur_grffile->cargo_list); _cur_grffile->cargo_max = numinfo; _cur_grffile->cargo_list = MallocT(numinfo); } CargoLabel cl = grf_load_dword(&buf); _cur_grffile->cargo_list[i] = BSWAP32(cl); } break; case 0x0A: { // Currency display names uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); if ((newone != STR_UNDEFINED) && (curidx < NUM_CURRENCY)) { _currency_specs[curidx].name = newone; } } break; case 0x0B: { // Currency multipliers uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); uint32 rate = grf_load_dword(&buf); if (curidx < NUM_CURRENCY) { /* TTDPatch uses a multiple of 1000 for its conversion calculations, * which OTTD does not. For this reason, divide grf value by 1000, * to be compatible */ _currency_specs[curidx].rate = rate / 1000; } else { grfmsg(1, "GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx); } } break; case 0x0C: { // Currency options uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); uint16 options = grf_load_word(&buf); if (curidx < NUM_CURRENCY) { _currency_specs[curidx].separator = GB(options, 0, 8); /* By specifying only one bit, we prevent errors, * since newgrf specs said that only 0 and 1 can be set for symbol_pos */ _currency_specs[curidx].symbol_pos = GB(options, 8, 1); } else { grfmsg(1, "GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx); } } break; case 0x0D: { // Currency prefix symbol uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); uint32 tempfix = grf_load_dword(&buf); if (curidx < NUM_CURRENCY) { memcpy(_currency_specs[curidx].prefix, &tempfix, 4); _currency_specs[curidx].prefix[4] = 0; } else { grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx); } } break; case 0x0E: { // Currency suffix symbol uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); uint32 tempfix = grf_load_dword(&buf); if (curidx < NUM_CURRENCY) { memcpy(&_currency_specs[curidx].suffix, &tempfix, 4); _currency_specs[curidx].suffix[4] = 0; } else { grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx); } } break; case 0x0F: { // Euro introduction dates uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); Year year_euro = grf_load_word(&buf); if (curidx < NUM_CURRENCY) { _currency_specs[curidx].to_euro = year_euro; } else { grfmsg(1, "GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx); } } break; case 0x10: // Snow line height table if (numinfo > 1 || IsSnowLineSet()) { grfmsg(1, "GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo); } else if (len < SNOW_LINE_MONTHS * SNOW_LINE_DAYS) { grfmsg(1, "GlobalVarChangeInfo: Not enough entries set in the snowline table (%d)", len); } else { byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS]; for (uint i = 0; i < SNOW_LINE_MONTHS; i++) { for (uint j = 0; j < SNOW_LINE_DAYS; j++) { table[i][j] = grf_load_byte(&buf); } } SetSnowLine(table); } break; default: ret = true; break; } } *bufp = buf; return ret; } static bool CargoChangeInfo(uint cid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (cid + numinfo > NUM_CARGO) { grfmsg(2, "CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo, NUM_CARGO - 1); return false; } for (int i = 0; i < numinfo; i++) { CargoSpec *cs = &_cargo[cid + i]; switch (prop) { case 0x08: /* Bit number of cargo */ cs->bitnum = grf_load_byte(&buf); if (cs->IsValid()) { cs->grfid = _cur_grffile->grfid; SetBit(_cargo_mask, cid + i); } else { ClrBit(_cargo_mask, cid + i); } break; case 0x09: /* String ID for cargo type name */ cs->name = grf_load_word(&buf); break; case 0x0A: /* String for 1 unit of cargo */ cs->name_single = grf_load_word(&buf); break; case 0x0B: /* String for units of cargo. This is different in OpenTTD to TTDPatch * (e.g. 10 tonnes of coal) */ cs->units_volume = grf_load_word(&buf); break; case 0x0C: /* String for quantity of cargo (e.g. 10 tonnes of coal) */ cs->quantifier = grf_load_word(&buf); break; case 0x0D: /* String for two letter cargo abbreviation */ cs->abbrev = grf_load_word(&buf); break; case 0x0E: /* Sprite ID for cargo icon */ cs->sprite = grf_load_word(&buf); break; case 0x0F: /* Weight of one unit of cargo */ cs->weight = grf_load_byte(&buf); break; case 0x10: /* Used for payment calculation */ cs->transit_days[0] = grf_load_byte(&buf); break; case 0x11: /* Used for payment calculation */ cs->transit_days[1] = grf_load_byte(&buf); break; case 0x12: /* Base cargo price */ cs->initial_payment = grf_load_dword(&buf); break; case 0x13: /* Colour for station rating bars */ cs->rating_colour = MapDOSColour(grf_load_byte(&buf)); break; case 0x14: /* Colour for cargo graph */ cs->legend_colour = MapDOSColour(grf_load_byte(&buf)); break; case 0x15: /* Freight status */ cs->is_freight = (grf_load_byte(&buf) != 0); break; case 0x16: /* Cargo classes */ cs->classes = grf_load_word(&buf); break; case 0x17: /* Cargo label */ cs->label = grf_load_dword(&buf); cs->label = BSWAP32(cs->label); break; case 0x18: { /* Town growth substitute type */ uint8 substitute_type = grf_load_byte(&buf); switch (substitute_type) { case 0x00: cs->town_effect = TE_PASSENGERS; break; case 0x02: cs->town_effect = TE_MAIL; break; case 0x05: cs->town_effect = TE_GOODS; break; case 0x09: cs->town_effect = TE_WATER; break; case 0x0B: cs->town_effect = TE_FOOD; break; default: grfmsg(1, "CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type); case 0xFF: cs->town_effect = TE_NONE; break; } } break; case 0x19: /* Town growth coefficient */ cs->multipliertowngrowth = grf_load_word(&buf); break; case 0x1A: /* Bitmask of callbacks to use */ cs->callback_mask = grf_load_byte(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool SoundEffectChangeInfo(uint sid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (_cur_grffile->sound_offset == 0) { grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping"); return false; } for (int i = 0; i < numinfo; i++) { uint sound = sid + i + _cur_grffile->sound_offset - GetNumOriginalSounds(); if (sound >= GetNumSounds()) { grfmsg(1, "SoundEffectChangeInfo: Sound %d not defined (max %d)", sound, GetNumSounds()); continue; } switch (prop) { case 0x08: // Relative volume GetSound(sound)->volume = grf_load_byte(&buf); break; case 0x09: // Priority GetSound(sound)->priority = grf_load_byte(&buf); break; case 0x0A: { // Override old sound uint orig_sound = grf_load_byte(&buf); if (orig_sound >= GetNumSounds()) { grfmsg(1, "SoundEffectChangeInfo: Original sound %d not defined (max %d)", orig_sound, GetNumSounds()); } else { FileEntry *newfe = GetSound(sound); FileEntry *oldfe = GetSound(orig_sound); /* Literally copy the data of the new sound over the original */ *oldfe = *newfe; } } break; default: ret = true; break; } } *bufp = buf; return ret; } static bool IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (indtid + numinfo > NUM_INDUSTRYTILES) { grfmsg(1, "IndustryTilesChangeInfo: Too many industry tiles loaded (%u), max (%u). Ignoring.", indtid + numinfo, NUM_INDUSTRYTILES); return false; } /* Allocate industry tile specs if they haven't been allocated already. */ if (_cur_grffile->indtspec == NULL) { _cur_grffile->indtspec = CallocT(NUM_INDUSTRYTILES); } for (int i = 0; i < numinfo; i++) { IndustryTileSpec *tsp = _cur_grffile->indtspec[indtid + i]; if (prop != 0x08 && tsp == NULL) { grfmsg(2, "IndustryTilesChangeInfo: Attempt to modify undefined industry tile %u. Ignoring.", indtid + i); continue; } switch (prop) { case 0x08: { // Substitute industry tile type IndustryTileSpec **tilespec = &_cur_grffile->indtspec[indtid + i]; byte subs_id = grf_load_byte(&buf); if (subs_id >= NEW_INDUSTRYTILEOFFSET) { /* The substitute id must be one of the original industry tile. */ grfmsg(2, "IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i); return false; } /* Allocate space for this industry. */ if (*tilespec == NULL) { int tempid; *tilespec = CallocT(1); tsp = *tilespec; memcpy(tsp, &_industry_tile_specs[subs_id], sizeof(_industry_tile_specs[subs_id])); tsp->enabled = true; /* A copied tile should not have the animation infos copied too. * The anim_state should be left untouched, though * It is up to the author to animate them himself */ tsp->anim_production = INDUSTRYTILE_NOANIM; tsp->anim_next = INDUSTRYTILE_NOANIM; tsp->grf_prop.local_id = indtid + i; tsp->grf_prop.subst_id = subs_id; tsp->grf_prop.grffile = _cur_grffile; tempid = _industile_mngr.AddEntityID(indtid + i, _cur_grffile->grfid, subs_id); // pre-reserve the tile slot } } break; case 0x09: { // Industry tile override byte ovrid = grf_load_byte(&buf); /* The industry being overridden must be an original industry. */ if (ovrid >= NEW_INDUSTRYTILEOFFSET) { grfmsg(2, "IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i); return false; } _industile_mngr.Add(indtid + i, _cur_grffile->grfid, ovrid); } break; case 0x0A: // Tile acceptance case 0x0B: case 0x0C: { uint16 acctp = grf_load_word(&buf); tsp->accepts_cargo[prop - 0x0A] = GetCargoTranslation(GB(acctp, 0, 8), _cur_grffile); tsp->acceptance[prop - 0x0A] = GB(acctp, 8, 8); } break; case 0x0D: // Land shape flags tsp->slopes_refused = (Slope)grf_load_byte(&buf); break; case 0x0E: // Callback flags tsp->callback_flags = grf_load_byte(&buf); break; case 0x0F: // Animation information tsp->animation_info = grf_load_word(&buf); break; case 0x10: // Animation speed tsp->animation_speed = grf_load_byte(&buf); break; case 0x11: // Triggers for callback 25 tsp->animation_triggers = grf_load_byte(&buf); break; case 0x12: // Special flags tsp->animation_special_flags = grf_load_byte(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } static bool IndustriesChangeInfo(uint indid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; bool ret = false; if (indid + numinfo > NUM_INDUSTRYTYPES) { grfmsg(1, "IndustriesChangeInfo: Too many industries loaded (%u), max (%u). Ignoring.", indid + numinfo, NUM_INDUSTRYTYPES); return false; } grfmsg(1, "IndustriesChangeInfo: newid %u", indid); /* Allocate industry specs if they haven't been allocated already. */ if (_cur_grffile->industryspec == NULL) { _cur_grffile->industryspec = CallocT(NUM_INDUSTRYTYPES); } for (int i = 0; i < numinfo; i++) { IndustrySpec *indsp = _cur_grffile->industryspec[indid + i]; if (prop != 0x08 && indsp == NULL) { grfmsg(2, "IndustriesChangeInfo: Attempt to modify undefined industry %u. Ignoring.", indid + i); continue; } switch (prop) { case 0x08: { // Substitute industry type IndustrySpec **indspec = &_cur_grffile->industryspec[indid + i]; byte subs_id = grf_load_byte(&buf); if (subs_id == 0xFF) { /* Instead of defining a new industry, a substitute industry id * of 0xFF disables the old industry with the current id. */ _industry_specs[indid + i].enabled = false; continue; } else if (subs_id >= NEW_INDUSTRYOFFSET) { /* The substitute id must be one of the original industry. */ grfmsg(2, "_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i); return false; } /* Allocate space for this industry. * Only need to do it once. If ever it is called again, it should not * do anything */ if (*indspec == NULL) { *indspec = CallocT(1); indsp = *indspec; memcpy(indsp, &_origin_industry_specs[subs_id], sizeof(_industry_specs[subs_id])); indsp->enabled = true; indsp->grf_prop.local_id = indid + i; indsp->grf_prop.subst_id = subs_id; indsp->grf_prop.grffile = _cur_grffile; /* If the grf industry needs to check its surounding upon creation, it should * rely on callbacks, not on the original placement functions */ indsp->check_proc = CHECK_NOTHING; } } break; case 0x09: { // Industry type override byte ovrid = grf_load_byte(&buf); /* The industry being overridden must be an original industry. */ if (ovrid >= NEW_INDUSTRYOFFSET) { grfmsg(2, "IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i); return false; } indsp->grf_prop.override = ovrid; _industry_mngr.Add(indid + i, _cur_grffile->grfid, ovrid); } break; case 0x0A: { // Set industry layout(s) indsp->num_table = grf_load_byte(&buf); // Number of layaouts uint32 defsize = grf_load_dword(&buf); // Total size of the definition IndustryTileTable **tile_table = CallocT(indsp->num_table); // Table with tiles to compose an industry IndustryTileTable *itt = CallocT(defsize); // Temporary array to read the tile layouts from the GRF int size; IndustryTileTable *copy_from; for (byte j = 0; j < indsp->num_table; j++) { for (int k = 0;; k++) { itt[k].ti.x = grf_load_byte(&buf); // Offsets from northermost tile if (itt[k].ti.x == 0xFE && k == 0) { /* This means we have to borrow the layout from an old industry */ IndustryType type = grf_load_byte(&buf); //industry holding required layout byte laynbr = grf_load_byte(&buf); //layout number to borrow copy_from = (IndustryTileTable*)_origin_industry_specs[type].table[laynbr]; for (size = 1;; size++) { if (copy_from[size - 1].ti.x == -0x80 && copy_from[size - 1].ti.y == 0) break; } break; } itt[k].ti.y = grf_load_byte(&buf); // Or table definition finalisation if (itt[k].ti.x == 0 && itt[k].ti.y == 0x80) { /* Not the same terminator. The one we are using is rather x= -80, y = x . So, adjust it. */ itt[k].ti.x = -0x80; itt[k].ti.y = 0; itt[k].gfx = 0; size = k + 1; copy_from = itt; break; } itt[k].gfx = grf_load_byte(&buf); if (itt[k].gfx == 0xFE) { /* Use a new tile from this GRF */ int local_tile_id = grf_load_word(&buf); /* Read the ID from the _industile_mngr. */ int tempid = _industile_mngr.GetID(local_tile_id, _cur_grffile->grfid); if (tempid == INVALID_INDUSTRYTILE) { grfmsg(2, "IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid); } else { /* Declared as been valid, can be used */ itt[k].gfx = tempid; size = k + 1; copy_from = itt; } } else if (itt[k].gfx == 0xFF) { itt[k].ti.x = (int8)GB(itt[k].ti.x, 0, 8); itt[k].ti.y = (int8)GB(itt[k].ti.y, 0, 8); } } tile_table[j] = CallocT(size); memcpy(tile_table[j], copy_from, sizeof(*copy_from) * size); } /* Install final layout construction in the industry spec */ indsp->table = tile_table; SetBit(indsp->cleanup_flag, 1); free(itt); } break; case 0x0B: // Industry production flags indsp->life_type = (IndustryLifeType)grf_load_byte(&buf); break; case 0x0C: // Industry closure message indsp->closure_text = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x0D: // Production increase message indsp->production_up_text = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x0E: // Production decrease message indsp->production_down_text = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x0F: // Fund cost multiplier indsp->cost_multiplier = grf_load_byte(&buf); break; case 0x10: // Production cargo types for (byte j = 0; j < 2; j++) { indsp->produced_cargo[j] = GetCargoTranslation(grf_load_byte(&buf), _cur_grffile); } break; case 0x11: // Acceptance cargo types for (byte j = 0; j < 3; j++) { indsp->accepts_cargo[j] = GetCargoTranslation(grf_load_byte(&buf), _cur_grffile); } grf_load_byte(&buf); // Unnused, eat it up break; case 0x12: // Production multipliers case 0x13: indsp->production_rate[prop - 0x12] = grf_load_byte(&buf); break; case 0x14: // Minimal amount of cargo distributed indsp->minimal_cargo = grf_load_byte(&buf); break; case 0x15: { // Random sound effects indsp->number_of_sounds = grf_load_byte(&buf); uint8 *sounds = MallocT(indsp->number_of_sounds); for (uint8 j = 0; j < indsp->number_of_sounds; j++) sounds[j] = grf_load_byte(&buf); indsp->random_sounds = sounds; SetBit(indsp->cleanup_flag, 0); } break; case 0x16: // Conflicting industry types for (byte j = 0; j < 3; j++) indsp->conflicting[j] = grf_load_byte(&buf); break; case 0x17: // Probability in random game indsp->appear_creation[_opt.landscape] = grf_load_byte(&buf); break; case 0x18: // Probability during gameplay indsp->appear_ingame[_opt.landscape] = grf_load_byte(&buf); break; case 0x19: // Map color indsp->map_colour = MapDOSColour(grf_load_byte(&buf)); break; case 0x1A: // Special industry flags to define special behavior indsp->behaviour = (IndustryBehaviour)grf_load_dword(&buf); break; case 0x1B: // New industry text ID indsp->new_industry_text = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x1C: // Input cargo multipliers for the three input cargo types case 0x1D: case 0x1E: { uint32 multiples = grf_load_dword(&buf); indsp->input_cargo_multiplier[prop - 0x1C][0] = GB(multiples, 0,15); indsp->input_cargo_multiplier[prop - 0x1C][1] = GB(multiples, 15,15); } break; case 0x1F: // Industry name indsp->name = MapGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); break; case 0x20: // Prospecting success chance indsp->prospecting_chance = grf_load_dword(&buf); break; case 0x21: // Callback flags case 0x22: { // Callback additional flags byte aflag = grf_load_byte(&buf); SB(indsp->callback_flags, (prop - 0x21) * 8, 8, aflag); } break; case 0x23: // removal cost multiplier indsp->removal_cost_multiplier = grf_load_dword(&buf); break; default: ret = true; break; } } *bufp = buf; return ret; } /* Action 0x00 */ static void FeatureChangeInfo(byte *buf, int len) { byte *bufend = buf + len; /* <00> ()... * * B feature 0, 1, 2 or 3 for trains, road vehicles, ships or planes * 4 for defining new train station sets * B num-props how many properties to change per vehicle/station * B num-info how many vehicles/stations to change * E id ID of first vehicle/station to change, if num-info is * greater than one, this one and the following * vehicles/stations will be changed * B property what property to change, depends on the feature * V new-info new bytes of info (variable size; depends on properties) */ /* TODO: Bridges, town houses. */ static const VCI_Handler handler[] = { /* GSF_TRAIN */ RailVehicleChangeInfo, /* GSF_ROAD */ RoadVehicleChangeInfo, /* GSF_SHIP */ ShipVehicleChangeInfo, /* GSF_AIRCRAFT */ AircraftVehicleChangeInfo, /* GSF_STATION */ StationChangeInfo, /* GSF_CANAL */ NULL, /* GSF_BRIDGE */ BridgeChangeInfo, /* GSF_TOWNHOUSE */ TownHouseChangeInfo, /* GSF_GLOBALVAR */ NULL, /* Global variables are handled during reservation */ /* GSF_INDUSTRYTILES */IndustrytilesChangeInfo, /* GSF_INDUSTRIES */ IndustriesChangeInfo, /* GSF_CARGOS */ NULL, /* Cargo is handled during reservation */ /* GSF_SOUNDFX */ SoundEffectChangeInfo, }; if (!check_length(len, 6, "FeatureChangeInfo")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 numprops = grf_load_byte(&buf); uint numinfo = grf_load_byte(&buf); uint engine = grf_load_extended(&buf); grfmsg(6, "FeatureChangeInfo: feature %d, %d properties, to apply to %d+%d", feature, numprops, engine, numinfo); if (feature >= lengthof(handler) || handler[feature] == NULL) { grfmsg(1, "FeatureChangeInfo: Unsupported feature %d, skipping", feature); return; } if (feature <= GSF_AIRCRAFT) { if (engine + numinfo > _vehcounts[feature]) { grfmsg(0, "FeatureChangeInfo: Last engine ID %d out of bounds (max %d), skipping", engine + numinfo, _vehcounts[feature]); return; } } while (numprops-- && buf < bufend) { uint8 prop = grf_load_byte(&buf); bool ignoring = false; switch (feature) { case GSF_TRAIN: case GSF_ROAD: case GSF_SHIP: case GSF_AIRCRAFT: { bool handled = true; for (uint i = 0; i < numinfo; i++) { EngineInfo *ei = &_engine_info[engine + _vehshifts[feature] + i]; /* Common properties for vehicles */ switch (prop) { case 0x00: // Introduction date ei->base_intro = grf_load_word(&buf) + DAYS_TILL_ORIGINAL_BASE_YEAR; break; case 0x02: // Decay speed SB(ei->unk2, 0, 7, grf_load_byte(&buf) & 0x7F); break; case 0x03: // Vehicle life ei->lifelength = grf_load_byte(&buf); break; case 0x04: // Model life ei->base_life = grf_load_byte(&buf); break; case 0x06: // Climates available ei->climates = grf_load_byte(&buf); break; case 0x07: // Loading speed /* Hyronymus explained me what does * this mean and insists on having a * credit ;-). --pasky */ ei->load_amount = grf_load_byte(&buf); break; default: handled = false; break; } } if (handled) break; } /* FALL THROUGH */ default: if (handler[feature](engine, numinfo, prop, &buf, bufend - buf)) { ignoring = true; } break; } if (ignoring) grfmsg(1, "FeatureChangeInfo: Ignoring property 0x%02X of feature 0x%02X (not implemented)", prop, feature); } } /* Action 0x00 (GLS_SAFETYSCAN) */ static void SafeChangeInfo(byte *buf, int len) { if (!check_length(len, 6, "SafeChangeInfo")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 numprops = grf_load_byte(&buf); grf_load_byte(&buf); // num-info grf_load_extended(&buf); // id if (feature == GSF_BRIDGE && numprops == 1) { uint8 prop = grf_load_byte(&buf); /* Bridge property 0x0D is redefinition of sprite layout tables, which * is considered safe. */ if (prop == 0x0D) return; } SetBit(_cur_grfconfig->flags, GCF_UNSAFE); /* Skip remainder of GRF */ _skip_sprites = -1; } /* Action 0x00 (GLS_RESERVE) */ static void ReserveChangeInfo(byte *buf, int len) { byte *bufend = buf + len; if (!check_length(len, 6, "InitChangeInfo")) return; buf++; uint8 feature = grf_load_byte(&buf); if (feature != GSF_CARGOS && feature != GSF_GLOBALVAR) return; uint8 numprops = grf_load_byte(&buf); uint8 numinfo = grf_load_byte(&buf); uint8 index = grf_load_extended(&buf); while (numprops-- && buf < bufend) { uint8 prop = grf_load_byte(&buf); bool ignoring = false; switch (feature) { default: NOT_REACHED(); case GSF_CARGOS: ignoring = CargoChangeInfo(index, numinfo, prop, &buf, bufend - buf); break; case GSF_GLOBALVAR: ignoring = GlobalVarChangeInfo(index, numinfo, prop, &buf, bufend - buf); break; } if (ignoring) grfmsg(2, "ReserveChangeInfo: Ignoring property 0x%02X (not implemented)", prop); } } /** * Creates a spritegroup representing a callback result * @param value The value that was used to represent this callback result * @return A spritegroup representing that callback result */ static const SpriteGroup* NewCallBackResultSpriteGroup(uint16 value) { SpriteGroup *group = AllocateSpriteGroup(); group->type = SGT_CALLBACK; /* Old style callback results have the highest byte 0xFF so signify it is a callback result * New style ones only have the highest bit set (allows 15-bit results, instead of just 8) */ if ((value >> 8) == 0xFF) { value &= ~0xFF00; } else { value &= ~0x8000; } group->g.callback.result = value; return group; } /** * Creates a spritegroup representing a sprite number result. * @param sprite The sprite number. * @param num_sprites The number of sprites per set. * @return A spritegroup representing the sprite number result. */ static const SpriteGroup* NewResultSpriteGroup(SpriteID sprite, byte num_sprites) { SpriteGroup *group = AllocateSpriteGroup(); group->type = SGT_RESULT; group->g.result.sprite = sprite; group->g.result.num_sprites = num_sprites; return group; } /* Action 0x01 */ static void NewSpriteSet(byte *buf, int len) { /* <01> * * B feature feature to define sprites for * 0, 1, 2, 3: veh-type, 4: train stations * B num-sets number of sprite sets * E num-ent how many entries per sprite set * For vehicles, this is the number of different * vehicle directions in each sprite set * Set num-dirs=8, unless your sprites are symmetric. * In that case, use num-dirs=4. */ if (!check_length(len, 4, "NewSpriteSet")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 num_sets = grf_load_byte(&buf); uint16 num_ents = grf_load_extended(&buf); _cur_grffile->spriteset_start = _cur_spriteid; _cur_grffile->spriteset_feature = feature; _cur_grffile->spriteset_numsets = num_sets; _cur_grffile->spriteset_numents = num_ents; grfmsg(7, "New sprite set at %d of type %d, consisting of %d sets with %d views each (total %d)", _cur_spriteid, feature, num_sets, num_ents, num_sets * num_ents ); for (uint16 i = 0; i < num_sets * num_ents; i++) { _nfo_line++; LoadNextSprite(_cur_spriteid++, _file_index, _nfo_line); } } /* Action 0x01 (SKIP) */ static void SkipAct1(byte *buf, int len) { if (!check_length(len, 4, "SkipAct1")) return; buf++; grf_load_byte(&buf); uint8 num_sets = grf_load_byte(&buf); uint16 num_ents = grf_load_extended(&buf); _skip_sprites = num_sets * num_ents; grfmsg(3, "SkipAct1: Skipping %d sprites", _skip_sprites); } /* Helper function to either create a callback or link to a previously * defined spritegroup. */ static const SpriteGroup* GetGroupFromGroupID(byte setid, byte type, uint16 groupid) { if (HasBit(groupid, 15)) return NewCallBackResultSpriteGroup(groupid); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid); return NULL; } return _cur_grffile->spritegroups[groupid]; } /* Helper function to either create a callback or a result sprite group. */ static const SpriteGroup* CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid, uint16 num_sprites) { if (HasBit(spriteid, 15)) return NewCallBackResultSpriteGroup(spriteid); if (spriteid >= _cur_grffile->spriteset_numsets) { grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid, max %u", setid, type, spriteid, _cur_grffile->spriteset_numsets); return NULL; } /* Check if the sprite is within range. This can fail if the Action 0x01 * is skipped, as TTDPatch mandates that Action 0x02s must be processed. * We don't have that rule, but must live by the Patch... */ if (_cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites > _cur_spriteid) { grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Real Sprite IDs 0x%04X - 0x%04X do not (all) exist (max 0x%04X), leaving empty", setid, type, _cur_grffile->spriteset_start + spriteid * num_sprites, _cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites - 1, _cur_spriteid - 1); return NULL; } if (feature != _cur_grffile->spriteset_feature) { grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set feature 0x%02X does not match action feature 0x%02X, skipping", setid, type, _cur_grffile->spriteset_feature, feature); return NULL; } return NewResultSpriteGroup(_cur_grffile->spriteset_start + spriteid * num_sprites, num_sprites); } /* Action 0x02 */ static void NewSpriteGroup(byte *buf, int len) { /* <02> * * B feature see action 1 * B set-id ID of this particular definition * B type/num-entries * if 80 or greater, this is a randomized or variational * list definition, see below * otherwise it specifies a number of entries, the exact * meaning depends on the feature * V feature-specific-data (huge mess, don't even look it up --pasky) */ SpriteGroup *group = NULL; byte *bufend = buf + len; if (!check_length(len, 5, "NewSpriteGroup")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 setid = grf_load_byte(&buf); uint8 type = grf_load_byte(&buf); if (setid >= _cur_grffile->spritegroups_count) { /* Allocate memory for new sprite group references. */ _cur_grffile->spritegroups = ReallocT(_cur_grffile->spritegroups, setid + 1); /* Initialise new space to NULL */ for (; _cur_grffile->spritegroups_count < (setid + 1); _cur_grffile->spritegroups_count++) _cur_grffile->spritegroups[_cur_grffile->spritegroups_count] = NULL; } switch (type) { /* Deterministic Sprite Group */ case 0x81: // Self scope, byte case 0x82: // Parent scope, byte case 0x85: // Self scope, word case 0x86: // Parent scope, word case 0x89: // Self scope, dword case 0x8A: // Parent scope, dword { byte varadjust; byte varsize; /* Check we can load the var size parameter */ if (!check_length(bufend - buf, 1, "NewSpriteGroup (Deterministic) (1)")) return; group = AllocateSpriteGroup(); group->type = SGT_DETERMINISTIC; group->g.determ.var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF; switch (GB(type, 2, 2)) { default: NOT_REACHED(); case 0: group->g.determ.size = DSG_SIZE_BYTE; varsize = 1; break; case 1: group->g.determ.size = DSG_SIZE_WORD; varsize = 2; break; case 2: group->g.determ.size = DSG_SIZE_DWORD; varsize = 4; break; } if (!check_length(bufend - buf, 5 + varsize, "NewSpriteGroup (Deterministic) (2)")) return; /* Loop through the var adjusts. Unfortunately we don't know how many we have * from the outset, so we shall have to keep reallocing. */ do { DeterministicSpriteGroupAdjust *adjust; if (group->g.determ.num_adjusts > 0) { if (!check_length(bufend - buf, 2 + varsize + 3, "NewSpriteGroup (Deterministic) (3)")) return; } group->g.determ.num_adjusts++; group->g.determ.adjusts = ReallocT(group->g.determ.adjusts, group->g.determ.num_adjusts); adjust = &group->g.determ.adjusts[group->g.determ.num_adjusts - 1]; /* The first var adjust doesn't have an operation specified, so we set it to add. */ adjust->operation = group->g.determ.num_adjusts == 1 ? DSGA_OP_ADD : (DeterministicSpriteGroupAdjustOperation)grf_load_byte(&buf); adjust->variable = grf_load_byte(&buf); if (adjust->variable == 0x7E) { /* Link subroutine group */ adjust->subroutine = GetGroupFromGroupID(setid, type, grf_load_byte(&buf)); } else { adjust->parameter = IsInsideMM(adjust->variable, 0x60, 0x80) ? grf_load_byte(&buf) : 0; } varadjust = grf_load_byte(&buf); adjust->shift_num = GB(varadjust, 0, 5); adjust->type = (DeterministicSpriteGroupAdjustType)GB(varadjust, 6, 2); adjust->and_mask = grf_load_var(varsize, &buf); if (adjust->type != DSGA_TYPE_NONE) { adjust->add_val = grf_load_var(varsize, &buf); adjust->divmod_val = grf_load_var(varsize, &buf); } else { adjust->add_val = 0; adjust->divmod_val = 0; } /* Continue reading var adjusts while bit 5 is set. */ } while (HasBit(varadjust, 5)); group->g.determ.num_ranges = grf_load_byte(&buf); if (group->g.determ.num_ranges > 0) group->g.determ.ranges = CallocT(group->g.determ.num_ranges); if (!check_length(bufend - buf, 2 + (2 + 2 * varsize) * group->g.determ.num_ranges, "NewSpriteGroup (Deterministic)")) return; for (uint i = 0; i < group->g.determ.num_ranges; i++) { group->g.determ.ranges[i].group = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); group->g.determ.ranges[i].low = grf_load_var(varsize, &buf); group->g.determ.ranges[i].high = grf_load_var(varsize, &buf); } group->g.determ.default_group = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); break; } /* Randomized Sprite Group */ case 0x80: // Self scope case 0x83: // Parent scope { if (!check_length(bufend - buf, 7, "NewSpriteGroup (Randomized) (1)")) return; group = AllocateSpriteGroup(); group->type = SGT_RANDOMIZED; group->g.random.var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF; uint8 triggers = grf_load_byte(&buf); group->g.random.triggers = GB(triggers, 0, 7); group->g.random.cmp_mode = HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY; group->g.random.lowest_randbit = grf_load_byte(&buf); group->g.random.num_groups = grf_load_byte(&buf); group->g.random.groups = CallocT(group->g.random.num_groups); if (!check_length(bufend - buf, 2 * group->g.random.num_groups, "NewSpriteGroup (Randomized) (2)")) return; for (uint i = 0; i < group->g.random.num_groups; i++) { group->g.random.groups[i] = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); } break; } /* Neither a variable or randomized sprite group... must be a real group */ default: { switch (feature) { case GSF_TRAIN: case GSF_ROAD: case GSF_SHIP: case GSF_AIRCRAFT: case GSF_STATION: case GSF_CANAL: case GSF_CARGOS: { byte sprites = _cur_grffile->spriteset_numents; byte num_loaded = type; byte num_loading = grf_load_byte(&buf); if (_cur_grffile->spriteset_start == 0) { grfmsg(0, "NewSpriteGroup: No sprite set to work on! Skipping"); return; } if (!check_length(bufend - buf, 2 * num_loaded + 2 * num_loading, "NewSpriteGroup (Real) (1)")) return; group = AllocateSpriteGroup(); group->type = SGT_REAL; group->g.real.num_loaded = num_loaded; group->g.real.num_loading = num_loading; if (num_loaded > 0) group->g.real.loaded = CallocT(num_loaded); if (num_loading > 0) group->g.real.loading = CallocT(num_loading); grfmsg(6, "NewSpriteGroup: New SpriteGroup 0x%02X, %u views, %u loaded, %u loading", setid, sprites, num_loaded, num_loading); for (uint i = 0; i < num_loaded; i++) { uint16 spriteid = grf_load_word(&buf); group->g.real.loaded[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites); grfmsg(8, "NewSpriteGroup: + rg->loaded[%i] = subset %u", i, spriteid); } for (uint i = 0; i < num_loading; i++) { uint16 spriteid = grf_load_word(&buf); group->g.real.loading[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites); grfmsg(8, "NewSpriteGroup: + rg->loading[%i] = subset %u", i, spriteid); } break; } case GSF_TOWNHOUSE: case GSF_INDUSTRYTILES: { byte sprites = _cur_grffile->spriteset_numents; byte num_sprites = max((uint8)1, type); uint i; group = AllocateSpriteGroup(); group->type = SGT_TILELAYOUT; group->g.layout.num_sprites = sprites; group->g.layout.dts = CallocT(1); /* Groundsprite */ group->g.layout.dts->ground_sprite = grf_load_word(&buf); group->g.layout.dts->ground_pal = grf_load_word(&buf); /* Remap transparent/colour modifier bits */ if (HasBit(group->g.layout.dts->ground_sprite, 14)) { ClrBit(group->g.layout.dts->ground_sprite, 14); SetBit(group->g.layout.dts->ground_sprite, PALETTE_MODIFIER_TRANSPARENT); } if (HasBit(group->g.layout.dts->ground_sprite, 15)) { ClrBit(group->g.layout.dts->ground_sprite, 15); SetBit(group->g.layout.dts->ground_sprite, PALETTE_MODIFIER_COLOR); } if (HasBit(group->g.layout.dts->ground_pal, 14)) { ClrBit(group->g.layout.dts->ground_pal, 14); SetBit(group->g.layout.dts->ground_sprite, SPRITE_MODIFIER_OPAQUE); } if (HasBit(group->g.layout.dts->ground_pal, 15)) { /* Bit 31 set means this is a custom sprite, so rewrite it to the * last spriteset defined. */ SpriteID sprite = _cur_grffile->spriteset_start + GB(group->g.layout.dts->ground_sprite, 0, 14) * sprites; SB(group->g.layout.dts->ground_sprite, 0, SPRITE_WIDTH, sprite); ClrBit(group->g.layout.dts->ground_pal, 15); } group->g.layout.dts->seq = CallocT(num_sprites + 1); for (i = 0; i < num_sprites; i++) { DrawTileSeqStruct *seq = (DrawTileSeqStruct*)&group->g.layout.dts->seq[i]; seq->image = grf_load_word(&buf); seq->pal = grf_load_word(&buf); seq->delta_x = grf_load_byte(&buf); seq->delta_y = grf_load_byte(&buf); if (HasBit(seq->image, 14)) { ClrBit(seq->image, 14); SetBit(seq->image, PALETTE_MODIFIER_TRANSPARENT); } if (HasBit(seq->image, 15)) { ClrBit(seq->image, 15); SetBit(seq->image, PALETTE_MODIFIER_COLOR); } if (HasBit(seq->pal, 14)) { ClrBit(seq->pal, 14); SetBit(seq->image, SPRITE_MODIFIER_OPAQUE); } if (HasBit(seq->pal, 15)) { /* Bit 31 set means this is a custom sprite, so rewrite it to the * last spriteset defined. */ SpriteID sprite = _cur_grffile->spriteset_start + GB(seq->image, 0, 14) * sprites; SB(seq->image, 0, SPRITE_WIDTH, sprite); ClrBit(seq->pal, 15); } if (type > 0) { seq->delta_z = grf_load_byte(&buf); if ((byte)seq->delta_z == 0x80) continue; } seq->size_x = grf_load_byte(&buf); seq->size_y = grf_load_byte(&buf); seq->size_z = grf_load_byte(&buf); } /* Set the terminator value. */ ((DrawTileSeqStruct*)group->g.layout.dts->seq)[i].delta_x = (byte)0x80; break; } case GSF_INDUSTRIES: { if (type > 1) { grfmsg(1, "NewSpriteGroup: Unsupported industry production version %d, skipping", type); break; } group = AllocateSpriteGroup(); group->type = SGT_INDUSTRY_PRODUCTION; group->g.indprod.version = type; if (type == 0) { for (uint i = 0; i < 3; i++) { group->g.indprod.substract_input[i] = grf_load_word(&buf); } for (uint i = 0; i < 2; i++) { group->g.indprod.add_output[i] = grf_load_word(&buf); } group->g.indprod.again = grf_load_byte(&buf); } else { for (uint i = 0; i < 3; i++) { group->g.indprod.substract_input[i] = grf_load_byte(&buf); } for (uint i = 0; i < 2; i++) { group->g.indprod.add_output[i] = grf_load_byte(&buf); } group->g.indprod.again = grf_load_byte(&buf); } break; } /* Loading of Tile Layout and Production Callback groups would happen here */ default: grfmsg(1, "NewSpriteGroup: Unsupported feature %d, skipping", feature); } } } _cur_grffile->spritegroups[setid] = group; } static CargoID TranslateCargo(uint8 feature, uint8 ctype) { /* Special cargo types for purchase list and stations */ if (feature == GSF_STATION && ctype == 0xFE) return CT_DEFAULT_NA; if (ctype == 0xFF) return CT_PURCHASE; if (_cur_grffile->cargo_max == 0) { /* No cargo table, so use bitnum values */ if (ctype >= 32) { grfmsg(1, "TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype); return CT_INVALID; } for (CargoID c = 0; c < NUM_CARGO; c++) { const CargoSpec *cs = GetCargo(c); if (!cs->IsValid()) continue; if (cs->bitnum == ctype) { grfmsg(6, "TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, c); return c; } } grfmsg(5, "TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype); return CT_INVALID; } /* Check if the cargo type is out of bounds of the cargo translation table */ if (ctype >= _cur_grffile->cargo_max) { grfmsg(1, "TranslateCargo: Cargo type %d out of range (max %d), skipping.", ctype, _cur_grffile->cargo_max - 1); return CT_INVALID; } /* Look up the cargo label from the translation table */ CargoLabel cl = _cur_grffile->cargo_list[ctype]; if (cl == 0) { grfmsg(5, "TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype); return CT_INVALID; } ctype = GetCargoIDByLabel(cl); if (ctype == CT_INVALID) { 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)); return CT_INVALID; } 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); return ctype; } static void VehicleMapSpriteGroup(byte *buf, byte feature, uint8 idcount, uint8 cidcount, bool wagover) { static EngineID *last_engines; static uint last_engines_count; if (!wagover) { if (last_engines_count != idcount) { last_engines = ReallocT(last_engines, idcount); last_engines_count = idcount; } } else { if (last_engines_count == 0) { grfmsg(0, "VehicleMapSpriteGroup: WagonOverride: No engine to do override with"); return; } grfmsg(6, "VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons", last_engines_count, idcount); } for (uint i = 0; i < idcount; i++) { uint8 engine_id = buf[3 + i]; uint8 engine = engine_id + _vehshifts[feature]; byte *bp = &buf[4 + idcount]; if (engine_id > _vehcounts[feature]) { grfmsg(0, "Id %u for feature 0x%02X is out of bounds", engine_id, feature); return; } grfmsg(7, "VehicleMapSpriteGroup: [%d] Engine %d...", i, engine); for (uint c = 0; c < cidcount; c++) { uint8 ctype = grf_load_byte(&bp); uint16 groupid = grf_load_word(&bp); grfmsg(8, "VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "VehicleMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); continue; } ctype = TranslateCargo(feature, ctype); if (ctype == CT_INVALID) continue; if (wagover) { SetWagonOverrideSprites(engine, ctype, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count); } else { SetCustomEngineSprites(engine, ctype, _cur_grffile->spritegroups[groupid]); last_engines[i] = engine; } } } { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); grfmsg(8, "-- Default group id 0x%04X", groupid); for (uint i = 0; i < idcount; i++) { uint8 engine = buf[3 + i] + _vehshifts[feature]; /* Don't tell me you don't love duplicated code! */ if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "VehicleMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); continue; } if (wagover) { /* If the ID for this action 3 is the same as the vehicle ID, * this indicates we have a helicopter rotor override. */ if (feature == GSF_AIRCRAFT && engine == last_engines[i]) { SetRotorOverrideSprites(engine, _cur_grffile->spritegroups[groupid]); } else { /* TODO: No multiple cargo types per vehicle yet. --pasky */ SetWagonOverrideSprites(engine, CT_DEFAULT, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count); } } else { SetCustomEngineSprites(engine, CT_DEFAULT, _cur_grffile->spritegroups[groupid]); SetEngineGRF(engine, _cur_grffile); last_engines[i] = engine; } } } } static void CanalMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "CanalMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping.", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { CanalFeature cf = (CanalFeature)buf[3 + i]; if (cf >= CF_END) { grfmsg(1, "CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf); continue; } _canal_sg[cf] = _cur_grffile->spritegroups[groupid]; } } static void StationMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { for (uint i = 0; i < idcount; i++) { uint8 stid = buf[3 + i]; StationSpec *statspec = _cur_grffile->stations[stid]; if (statspec == NULL) { grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stid); return; } byte *bp = &buf[4 + idcount]; for (uint c = 0; c < cidcount; c++) { uint8 ctype = grf_load_byte(&bp); uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "StationMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); continue; } ctype = TranslateCargo(GSF_STATION, ctype); if (ctype == CT_INVALID) continue; statspec->spritegroup[ctype] = _cur_grffile->spritegroups[groupid]; } } { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "StationMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { uint8 stid = buf[3 + i]; StationSpec *statspec = _cur_grffile->stations[stid]; if (statspec == NULL) { grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stid); continue; } statspec->spritegroup[CT_DEFAULT] = _cur_grffile->spritegroups[groupid]; statspec->grffile = _cur_grffile; statspec->localidx = stid; SetCustomStationSpec(statspec); } } } static void TownHouseMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "TownHouseMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping.", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { uint8 hid = buf[3 + i]; HouseSpec *hs = _cur_grffile->housespec[hid]; if (hs == NULL) { grfmsg(1, "TownHouseMapSpriteGroup: Too many houses defined, skipping"); return; } hs->spritegroup = _cur_grffile->spritegroups[groupid]; } } static void IndustryMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "IndustryMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping.", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { uint8 id = buf[3 + i]; IndustrySpec *indsp = _cur_grffile->industryspec[id]; if (indsp == NULL) { grfmsg(1, "IndustryMapSpriteGroup: Too many industries defined, skipping"); return; } indsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid]; } } static void IndustrytileMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "IndustrytileMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping.", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { uint8 id = buf[3 + i]; IndustryTileSpec *indtsp = _cur_grffile->indtspec[id]; if (indtsp == NULL) { grfmsg(1, "IndustrytileMapSpriteGroup: Too many industry tiles defined, skipping"); return; } indtsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid]; } } static void CargoMapSpriteGroup(byte *buf, uint8 idcount, uint8 cidcount) { byte *bp = &buf[4 + idcount + cidcount * 3]; uint16 groupid = grf_load_word(&bp); if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "CargoMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping.", groupid, _cur_grffile->spritegroups_count); return; } for (uint i = 0; i < idcount; i++) { CargoID cid = buf[3 + i]; if (cid >= NUM_CARGO) { grfmsg(1, "CargoMapSpriteGroup: Cargo ID %d out of range, skipping"); continue; } CargoSpec *cs = &_cargo[cid]; cs->grfid = _cur_grffile->grfid; cs->group = _cur_grffile->spritegroups[groupid]; } } /* Action 0x03 */ static void FeatureMapSpriteGroup(byte *buf, int len) { /* <03> ... [ ]... * id-list := [] [id-list] * cargo-list := [cargo-list] * * B feature see action 0 * B n-id bits 0-6: how many IDs this definition applies to * bit 7: if set, this is a wagon override definition (see below) * B ids the IDs for which this definition applies * B num-cid number of cargo IDs (sprite group IDs) in this definition * can be zero, in that case the def-cid is used always * B cargo-type type of this cargo type (e.g. mail=2, wood=7, see below) * W cid cargo ID (sprite group ID) for this type of cargo * W def-cid default cargo ID (sprite group ID) */ if (!check_length(len, 6, "FeatureMapSpriteGroup")) return; uint8 feature = buf[1]; uint8 idcount = buf[2] & 0x7F; bool wagover = (buf[2] & 0x80) == 0x80; if (!check_length(len, 3 + idcount, "FeatureMapSpriteGroup")) return; /* If idcount is zero, this is a feature callback */ if (idcount == 0) { grfmsg(2, "FeatureMapSpriteGroup: Feature callbacks not implemented yet"); return; } uint8 cidcount = buf[3 + idcount]; if (!check_length(len, 4 + idcount + cidcount * 3, "FeatureMapSpriteGroup")) return; grfmsg(6, "FeatureMapSpriteGroup: Feature %d, %d ids, %d cids, wagon override %d", feature, idcount, cidcount, wagover); if (_cur_grffile->spritegroups == 0) { grfmsg(1, "FeatureMapSpriteGroup: No sprite groups to work on! Skipping"); return; } switch (feature) { case GSF_TRAIN: case GSF_ROAD: case GSF_SHIP: case GSF_AIRCRAFT: VehicleMapSpriteGroup(buf, feature, idcount, cidcount, wagover); return; case GSF_CANAL: CanalMapSpriteGroup(buf, idcount, cidcount); return; case GSF_STATION: StationMapSpriteGroup(buf, idcount, cidcount); return; case GSF_TOWNHOUSE: TownHouseMapSpriteGroup(buf, idcount, cidcount); return; case GSF_INDUSTRIES: IndustryMapSpriteGroup(buf, idcount, cidcount); return; case GSF_INDUSTRYTILES: IndustrytileMapSpriteGroup(buf, idcount, cidcount); return; case GSF_CARGOS: CargoMapSpriteGroup(buf, idcount, cidcount); return; default: grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature %d, skipping", feature); return; } } /* Action 0x04 */ static void FeatureNewName(byte *buf, int len) { /* <04> * * B veh-type see action 0 (as 00..07, + 0A * But IF veh-type = 48, then generic text * B language-id If bit 6 is set, This is the extended language scheme, with up to 64 language. Otherwise, it is a mapping where set bits have meaning 0 = american, 1 = english, 2 = german, 3 = french, 4 = spanish Bit 7 set means this is a generic text, not a vehicle one (or else) * B num-veh number of vehicles which are getting a new name * B/W offset number of the first vehicle that gets a new name * Byte : ID of vehicle to change * Word : ID of string to change/add * S data new texts, each of them zero-terminated, after * which the next name begins. */ bool new_scheme = _cur_grffile->grf_version >= 7; if (!check_length(len, 6, "FeatureNewName")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 lang = grf_load_byte(&buf); uint8 num = grf_load_byte(&buf); bool generic = HasBit(lang, 7); uint16 id = generic ? grf_load_word(&buf) : grf_load_byte(&buf); ClrBit(lang, 7); if (feature <= GSF_AIRCRAFT && id < _vehcounts[feature]) { id += _vehshifts[feature]; } uint16 endid = id + num; grfmsg(6, "FeatureNewName: About to rename engines %d..%d (feature %d) in language 0x%02X", id, endid, feature, lang); len -= generic ? 6 : 5; for (; id < endid && len > 0; id++) { const char *name = grf_load_string(&buf, len); size_t name_length = strlen(name) + 1; len -= (int)name_length; grfmsg(8, "FeatureNewName: 0x%04X <- %s", id, name); switch (feature) { case GSF_TRAIN: case GSF_ROAD: case GSF_SHIP: case GSF_AIRCRAFT: if (id < TOTAL_NUM_ENGINES) { StringID string = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_8000_KIRBY_PAUL_TANK_STEAM + id); SetCustomEngineName(id, string); } else { AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, id); } break; case GSF_INDUSTRIES: { AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); break; } case GSF_TOWNHOUSE: default: switch (GB(id, 8, 8)) { case 0xC4: // Station class name if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) { grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8)); } else { StationClassID sclass = _cur_grffile->stations[GB(id, 0, 8)]->sclass; SetStationClassName(sclass, AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED)); } break; case 0xC5: // Station name if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) { grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8)); } else { _cur_grffile->stations[GB(id, 0, 8)]->name = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); } break; case 0xC9: // House name if (_cur_grffile->housespec == NULL || _cur_grffile->housespec[GB(id, 0, 8)] == NULL) { grfmsg(1, "FeatureNewName: Attempt to name undefined house 0x%X, ignoring.", GB(id, 0, 8)); } else { _cur_grffile->housespec[GB(id, 0, 8)]->building_name = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); } break; case 0xD0: case 0xDC: AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); break; default: grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id); break; } break; #if 0 case GSF_CANAL : case GSF_BRIDGE : AddGRFString(_cur_spriteid, id, lang, name); switch (GB(id, 8, 8)) { case 0xC9: // House name default: grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id); } break; default : grfmsg(7, "FeatureNewName: Unsupported feature (0x%02X)", feature); break; #endif } } } /** * Sanitize incoming sprite offsets for Action 5 graphics replacements. * @param num the number of sprites to load. * @param offset offset from the base. * @param max_sprites the maximum number of sprites that can be loaded in this action 5. * @param name used for error warnings. * @return the number of sprites that is going to be skipped */ static uint16 SanitizeSpriteOffset(uint16& num, uint16 offset, int max_sprites, const char *name) { if (offset >= max_sprites) { grfmsg(1, "GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites); uint orig_num = num; num = 0; return orig_num; } if (offset + num > max_sprites) { grfmsg(4, "GraphicsNew: %s sprite overflow, truncating...", name); uint orig_num = num; num = max(max_sprites - offset, 0); return orig_num - num; } return 0; } /** Allows to reposition the loaded sprite to its correct placment. * @param load_index SpriteID of the sprite to be relocated */ static inline void TranslateShoreSprites(SpriteID load_index) { /** Contains the displacement required for the corresponding initial sprite*/ static const SpriteID shore_dup[8] = { SPR_SHORE_BASE + 4, ///< 4062 SPR_SHORE_BASE + 1, ///< 4063 SPR_SHORE_BASE + 2, ///< 4064 SPR_SHORE_BASE + 8, ///< 4065 SPR_SHORE_BASE + 6, ///< 4066 SPR_SHORE_BASE + 12, ///< 4067 SPR_SHORE_BASE + 3, ///< 4068 SPR_SHORE_BASE + 9, ///< 4069 }; DupSprite(load_index, shore_dup[load_index - SPR_ORIGINALSHORE_START]); } /* Action 0x05 */ static void GraphicsNew(byte *buf, int len) { /* <05> * * B graphics-type What set of graphics the sprites define. * E num-sprites How many sprites are in this set? * V other data Graphics type specific data. Currently unused. */ /* TODO */ SpriteID replace = 0; if (!check_length(len, 2, "GraphicsNew")) return; buf++; uint8 type = grf_load_byte(&buf); uint16 num = grf_load_extended(&buf); uint16 skip_num = 0; uint16 offset = HasBit(type, 7) ? grf_load_extended(&buf) : 0; ClrBit(type, 7); // Clear the high bit as that only indicates whether there is an offset. switch (type) { case 0x04: // Signal graphics if (num != PRESIGNAL_SPRITE_COUNT && num != PRESIGNAL_AND_SEMAPHORE_SPRITE_COUNT && num != PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Signal graphics sprite count must be 48, 112 or 240, skipping"); return; } replace = SPR_SIGNALS_BASE; break; case 0x05: // Catenary graphics if (num != ELRAIL_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Catenary graphics sprite count must be 48, skipping"); return; } replace = SPR_ELRAIL_BASE; break; case 0x06: // Foundations if (num != NORMAL_FOUNDATION_SPRITE_COUNT && num != NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Foundation graphics sprite count must be 74 or 90, skipping"); return; } replace = SPR_SLOPES_BASE; break; break; /* case 0x07: // TTDP GUI sprites. Not used by OTTD. */ case 0x08: // Canal graphics if (num != CANALS_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Canal graphics sprite count must be 65, skipping"); return; } replace = SPR_CANALS_BASE; break; case 0x09: // One way graphics if (num != ONEWAY_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: One way road graphics sprite count must be 6, skipping"); return; } replace = SPR_ONEWAY_BASE; break; case 0x0A: // 2CC colour maps if (num != TWOCCMAP_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: 2CC colour maps sprite count must be 256, skipping"); return; } replace = SPR_2CCMAP_BASE; break; case 0x0B: // tramways if (num != TRAMWAY_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Tramway graphics sprite count must be 113, skipping"); return; } replace = SPR_TRAMWAY_BASE; break; /* case 0x0C: // Snowy temperate trees. Not yet used by OTTD. */ case 0x0D: // Coast graphics switch (num) { case 10: if (!_cur_grffile->is_ottdfile) { grfmsg(2, "GraphicsNew: feature is reserved only for OpenTTD, skipping"); return; } /* openttd(d/w).grf missing shore sprites and initialisation of SPR_SHORE_BASE */ LoadNextSprite( SPR_SHORE_BASE + 0, _file_index, _nfo_line++); // SLOPE_STEEP_S TranslateShoreSprites(SPR_ORIGINALSHORE_START + 1); // SLOPE_W TranslateShoreSprites(SPR_ORIGINALSHORE_START + 2); // SLOPE_S TranslateShoreSprites(SPR_ORIGINALSHORE_START + 6); // SLOPE_SW TranslateShoreSprites(SPR_ORIGINALSHORE_START); // SLOPE_E LoadNextSprite( SPR_SHORE_BASE + 5, _file_index, _nfo_line++); // SLOPE_STEEP_W TranslateShoreSprites(SPR_ORIGINALSHORE_START + 4); // SLOPE_SE LoadNextSprite( SPR_SHORE_BASE + 7, _file_index, _nfo_line++); // SLOPE_WSE TranslateShoreSprites(SPR_ORIGINALSHORE_START + 3); // SLOPE_N TranslateShoreSprites(SPR_ORIGINALSHORE_START + 7); // SLOPE_NW LoadNextSprite( SPR_SHORE_BASE + 10, _file_index, _nfo_line++); // SLOPE_STEEP_N LoadNextSprite( SPR_SHORE_BASE + 11, _file_index, _nfo_line++); // SLOPE_NWS TranslateShoreSprites(SPR_ORIGINALSHORE_START + 5); // SLOPE_NE LoadNextSprite( SPR_SHORE_BASE + 13, _file_index, _nfo_line++); // SLOPE_ENW LoadNextSprite( SPR_SHORE_BASE + 14, _file_index, _nfo_line++); // SLOPE_SEN LoadNextSprite( SPR_SHORE_BASE + 15, _file_index, _nfo_line++); // SLOPE_STEEP_E LoadNextSprite( SPR_SHORE_BASE + 16, _file_index, _nfo_line++); // SLOPE_EW LoadNextSprite( SPR_SHORE_BASE + 17, _file_index, _nfo_line++); // SLOPE_NS grfmsg(2, "GraphicsNew: Loading all standard shore sprites"); break; case 16: case 18: /* 'normal' newWater newGRF */ replace = SPR_SHORE_BASE; break; default: /* no valid shore sprite count */ grfmsg(1, "GraphicsNew: Shore graphics sprite count must be 10, 16 or 18, skipping"); return; } break; /* case 0x0E: // New Signals. Not yet used by OTTD. */ /* case 0x0F: // Tracks for marking sloped rail. Not yet used by OTTD. */ case 0x10: // New airport sprites if (num != AIRPORTX_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Airport graphics sprite count must be 15, skipping"); return; } replace = SPR_AIRPORTX_BASE; break; case 0x11: // Road stop sprites if (num != ROADSTOP_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Road stop graphics sprite count must be 8, skipping"); return; } replace = SPR_ROADSTOP_BASE; break; /* case 0x12: // Aqueduct sprites. Not yet used by OTTD. */ case 0x13: // Autorail sprites if (num != AUTORAIL_SPRITE_COUNT) { grfmsg(1, "GraphicsNew: Autorail graphics sprite count must be 55, skipping"); return; } replace = SPR_AUTORAIL_BASE; break; case 0x14: // Flag sprites skip_num = SanitizeSpriteOffset(num, offset, FLAGS_SPRITE_COUNT, "Flag graphics"); replace = SPR_FLAGS_BASE + offset; break; case 0x15: // OpenTTD GUI sprites skip_num = SanitizeSpriteOffset(num, offset, OPENTTD_SPRITE_COUNT, "OpenTTD graphics"); replace = SPR_OPENTTD_BASE + offset; break; default: grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num); _skip_sprites = num; return; } if (replace == 0) { grfmsg(2, "GraphicsNew: Loading %u sprites of type 0x%02X at SpriteID 0x%04X", num, type, _cur_spriteid); } else { grfmsg(2, "GraphicsNew: Replacing %u sprites of type 0x%02X at SpriteID 0x%04X", num, type, replace); } for (; num > 0; num--) { _nfo_line++; LoadNextSprite(replace == 0 ? _cur_spriteid++ : replace++, _file_index, _nfo_line); } _skip_sprites = skip_num; } /* Action 0x05 (SKIP) */ static void SkipAct5(byte *buf, int len) { if (!check_length(len, 2, "SkipAct5")) return; buf++; /* Ignore type byte */ grf_load_byte(&buf); /* Skip the sprites of this action */ _skip_sprites = grf_load_extended(&buf); grfmsg(3, "SkipAct5: Skipping %d sprites", _skip_sprites); } static uint32 GetParamVal(byte param, uint32 *cond_val) { switch (param) { case 0x81: // current year return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; case 0x83: // current climate, 0=temp, 1=arctic, 2=trop, 3=toyland return _opt.landscape; case 0x84: { // GRF loading stage uint32 res = 0; if (_cur_stage > GLS_INIT) SetBit(res, 0); if (_cur_stage == GLS_RESERVE) SetBit(res, 8); if (_cur_stage == GLS_ACTIVATION) SetBit(res, 9); return res; } case 0x85: // TTDPatch flags, only for bit tests if (cond_val == NULL) { /* Supported in Action 0x07 and 0x09, not 0x0D */ return 0; } else { uint32 param_val = _ttdpatch_flags[*cond_val / 0x20]; *cond_val %= 0x20; return param_val; } case 0x86: // road traffic side, bit 4 clear=left, set=right return _opt.road_side << 4; case 0x88: // GRF ID check return 0; case 0x8B: { // TTDPatch version uint major = 2; uint minor = 6; uint revision = 1; // special case: 2.0.1 is 2.0.10 uint build = 1382; return (major << 24) | (minor << 20) | (revision << 16) | build; } case 0x8D: // TTD Version, 00=DOS, 01=Windows return !_use_dos_palette; case 0x8E: // Y-offset for train sprites return _traininfo_vehicle_pitch; case 0x92: // Game mode return _game_mode; case 0x9A: // Always -1 return UINT_MAX; case 0x9D: // TTD Platform, 00=TTDPatch, 01=OpenTTD return 1; case 0x9E: // Miscellaneous GRF features return _misc_grf_features; case 0xA1: { // OpenTTD version extern uint32 _openttd_newgrf_version; return _openttd_newgrf_version; } default: /* GRF Parameter */ if (param < 0x80) return _cur_grffile->param[param]; /* In-game variable. */ grfmsg(1, "Unsupported in-game variable 0x%02X", param); return UINT_MAX; } } /* Action 0x06 */ static void CfgApply(byte *buf, int len) { /* <06> ... * * B param-num Number of parameter to substitute (First = "zero") * Ignored if that parameter was not specified in newgrf.cfg * B param-size How many bytes to replace. If larger than 4, the * bytes of the following parameter are used. In that * case, nothing is applied unless *all* parameters * were specified. * B offset Offset into data from beginning of next sprite * to place where parameter is to be stored. */ /* Preload the next sprite */ uint32 pos = FioGetPos(); uint16 num = FioReadWord(); uint8 type = FioReadByte(); /* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */ if (type == 0xFF) { _preload_sprite = MallocT(num); FioReadBlock(_preload_sprite, num); } /* Reset the file position to the start of the next sprite */ FioSeekTo(pos, SEEK_SET); if (type != 0xFF) { grfmsg(2, "CfgApply: Ignoring (next sprite is real, unsupported)"); return; } /* Now perform the Action 0x06 on our data. */ buf++; for (;;) { uint i; uint param_num; uint param_size; uint offset; bool add_value; /* Read the parameter to apply. 0xFF indicates no more data to change. */ param_num = grf_load_byte(&buf); if (param_num == 0xFF) break; /* Get the size of the parameter to use. If the size covers multiple * double words, sequential parameter values are used. */ param_size = grf_load_byte(&buf); /* Bit 7 of param_size indicates we should add to the original value * instead of replacing it. */ add_value = HasBit(param_size, 7); param_size = GB(param_size, 0, 7); /* Where to apply the data to within the pseudo sprite data. */ offset = grf_load_extended(&buf); /* If the parameter is a GRF parameter (not an internal variable) check * if it (and all further sequential parameters) has been defined. */ if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur_grffile->param_end) { grfmsg(2, "CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4)); break; } grfmsg(8, "CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset); bool carry = false; for (i = 0; i < param_size; i++) { uint32 value = GetParamVal(param_num + i / 4, NULL); /* Reset carry flag for each iteration of the variable (only really * matters if param_size is greater than 4) */ if (i == 0) carry = false; if (add_value) { uint new_value = _preload_sprite[offset + i] + GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0); _preload_sprite[offset + i] = GB(new_value, 0, 8); /* Check if the addition overflowed */ carry = new_value >= 256; } else { _preload_sprite[offset + i] = GB(value, (i % 4) * 8, 8); } } } } /* Action 0x07 */ /* Action 0x09 */ static void SkipIf(byte *buf, int len) { /* <07/09> * * B param-num * B param-size * B condition-type * V value * B num-sprites */ /* TODO: More params. More condition types. */ uint32 cond_val = 0; uint32 mask = 0; bool result; if (!check_length(len, 6, "SkipIf")) return; buf++; uint8 param = grf_load_byte(&buf); uint8 paramsize = grf_load_byte(&buf); uint8 condtype = grf_load_byte(&buf); if (condtype < 2) { /* Always 1 for bit tests, the given value should be ignored. */ paramsize = 1; } switch (paramsize) { case 4: cond_val = grf_load_dword(&buf); mask = 0xFFFFFFFF; break; case 2: cond_val = grf_load_word(&buf); mask = 0x0000FFFF; break; case 1: cond_val = grf_load_byte(&buf); mask = 0x000000FF; break; default: break; } if (param < 0x80 && _cur_grffile->param_end <= param) { grfmsg(7, "SkipIf: Param %d undefined, skipping test", param); return; } uint32 param_val = GetParamVal(param, &cond_val); grfmsg(7, "SkipIf: Test condtype %d, param 0x%08X, condval 0x%08X", condtype, param_val, cond_val); /* * Parameter (variable in specs) 0x88 can only have GRF ID checking * conditions, except conditions 0x0B and 0x0C (cargo availability) * as those ignore the parameter. So, when the condition type is * either of those, the specific variable 0x88 code is skipped, so * the "general" code for the cargo availability conditions kicks in. */ if (param == 0x88 && condtype != 0x0B && condtype != 0x0C) { /* GRF ID checks */ const GRFConfig *c = GetGRFConfig(cond_val); if (condtype != 10 && c == NULL) { grfmsg(7, "SkipIf: GRFID 0x%08X unknown, skipping test", BSWAP32(cond_val)); return; } switch (condtype) { /* Tests 0x06 to 0x0A are only for param 0x88, GRFID checks */ case 0x06: // Is GRFID active? result = c->status == GCS_ACTIVATED; break; case 0x07: // Is GRFID non-active? result = c->status != GCS_ACTIVATED; break; case 0x08: // GRFID is not but will be active? result = c->status == GCS_INITIALISED; break; case 0x09: // GRFID is or will be active? result = c->status == GCS_ACTIVATED || c->status == GCS_INITIALISED; break; case 0x0A: // GRFID is not nor will be active /* This is the only condtype that doesn't get ignored if the GRFID is not found */ result = c == NULL || c->flags == GCS_DISABLED || c->status == GCS_NOT_FOUND; break; default: grfmsg(1, "SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype); return; } } else { /* Parameter or variable tests */ switch (condtype) { case 0x00: result = !!(param_val & (1 << cond_val)); break; case 0x01: result = !(param_val & (1 << cond_val)); break; case 0x02: result = (param_val & mask) == cond_val; break; case 0x03: result = (param_val & mask) != cond_val; break; case 0x04: result = (param_val & mask) < cond_val; break; case 0x05: result = (param_val & mask) > cond_val; break; case 0x0B: result = GetCargoIDByLabel(BSWAP32(cond_val)) == CT_INVALID; break; case 0x0C: result = GetCargoIDByLabel(BSWAP32(cond_val)) != CT_INVALID; break; default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return; } } if (!result) { grfmsg(2, "SkipIf: Not skipping sprites, test was false"); return; } uint8 numsprites = grf_load_byte(&buf); /* numsprites can be a GOTO label if it has been defined in the GRF * file. The jump will always be the first matching label that follows * the current nfo_line. If no matching label is found, the first matching * label in the file is used. */ GRFLabel *choice = NULL; for (GRFLabel *label = _cur_grffile->label; label != NULL; label = label->next) { if (label->label != numsprites) continue; /* Remember a goto before the current line */ if (choice == NULL) choice = label; /* If we find a label here, this is definitely good */ if (label->nfo_line > _nfo_line) { choice = label; break; } } if (choice != NULL) { grfmsg(2, "SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line); FioSeekTo(choice->pos, SEEK_SET); _nfo_line = choice->nfo_line; return; } grfmsg(2, "SkipIf: Skipping %d sprites, test was true", numsprites); _skip_sprites = numsprites; if (_skip_sprites == 0) { /* Zero means there are no sprites to skip, so * we use -1 to indicate that all further * sprites should be skipped. */ _skip_sprites = -1; /* If an action 8 hasn't been encountered yet, disable the grf. */ if (_cur_grfconfig->status != GCS_ACTIVATED) { _cur_grfconfig->status = GCS_DISABLED; } } } /* Action 0x08 (GLS_FILESCAN) */ static void ScanInfo(byte *buf, int len) { if (!check_length(len, 8, "Info")) return; buf++; grf_load_byte(&buf); uint32 grfid = grf_load_dword(&buf); _cur_grfconfig->grfid = grfid; /* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */ if (GB(grfid, 24, 8) == 0xFF) SetBit(_cur_grfconfig->flags, GCF_SYSTEM); len -= 6; const char *name = grf_load_string(&buf, len); _cur_grfconfig->name = TranslateTTDPatchCodes(name); len -= strlen(name) + 1; if (len > 0) { const char *info = grf_load_string(&buf, len); _cur_grfconfig->info = TranslateTTDPatchCodes(info); } /* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */ _skip_sprites = -1; } /* Action 0x08 */ static void GRFInfo(byte *buf, int len) { /* <08> * * B version newgrf version, currently 06 * 4*B grf-id globally unique ID of this .grf file * S name name of this .grf set * S info string describing the set, and e.g. author and copyright */ if (!check_length(len, 8, "GRFInfo")) return; buf++; uint8 version = grf_load_byte(&buf); uint32 grfid = grf_load_dword(&buf); const char *name = grf_load_string(&buf, len - 6); _cur_grffile->grfid = grfid; _cur_grffile->grf_version = version; _cur_grfconfig->status = _cur_stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED; /* Do swap the GRFID for displaying purposes since people expect that */ DEBUG(grf, 1, "GRFInfo: Loaded GRFv%d set %08lX - %s", version, BSWAP32(grfid), name); } /* Action 0x0A */ static void SpriteReplace(byte *buf, int len) { /* <0A> [ ...] * : * * B num-sets How many sets of sprites to replace. * Each set: * B num-sprites How many sprites are in this set * W first-sprite First sprite number to replace */ buf++; // skip action byte uint8 num_sets = grf_load_byte(&buf); for (uint i = 0; i < num_sets; i++) { uint8 num_sprites = grf_load_byte(&buf); uint16 first_sprite = grf_load_word(&buf); grfmsg(2, "SpriteReplace: [Set %d] Changing %d sprites, beginning with %d", i, num_sprites, first_sprite ); for (uint j = 0; j < num_sprites; j++) { int load_index = first_sprite + j; _nfo_line++; LoadNextSprite(load_index, _file_index, _nfo_line); // XXX /* Shore sprites now located at different addresses. * So apply the required displacements */ if (IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) TranslateShoreSprites(load_index); } } } /* Action 0x0A (SKIP) */ static void SkipActA(byte *buf, int len) { buf++; uint8 num_sets = grf_load_byte(&buf); for (uint i = 0; i < num_sets; i++) { /* Skip the sprites this replaces */ _skip_sprites += grf_load_byte(&buf); /* But ignore where they go */ grf_load_word(&buf); } grfmsg(3, "SkipActA: Skipping %d sprites", _skip_sprites); } /* Action 0x0B */ static void GRFLoadError(byte *buf, int len) { /* <0B> [ 00] [] 00 [] * * B severity 00: notice, contine loading grf file * 01: warning, continue loading grf file * 02: error, but continue loading grf file, and attempt * loading grf again when loading or starting next game * 03: error, abort loading and prevent loading again in * the future (only when restarting the patch) * B language-id see action 4, use 1F for built-in error messages * B message-id message to show, see below * S message for custom messages (message-id FF), text of the message * not present for built-in messages. * V data additional data for built-in (or custom) messages * B parnum parameter numbers to be shown in the message (maximum of 2) */ static const StringID msgstr[] = { STR_NEWGRF_ERROR_VERSION_NUMBER, STR_NEWGRF_ERROR_DOS_OR_WINDOWS, STR_NEWGRF_ERROR_UNSET_SWITCH, STR_NEWGRF_ERROR_INVALID_PARAMETER, STR_NEWGRF_ERROR_LOAD_BEFORE, STR_NEWGRF_ERROR_LOAD_AFTER, STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER, }; static const StringID sevstr[] = { STR_NEWGRF_ERROR_MSG_INFO, STR_NEWGRF_ERROR_MSG_WARNING, STR_NEWGRF_ERROR_MSG_ERROR, STR_NEWGRF_ERROR_MSG_FATAL }; if (!check_length(len, 6, "GRFLoadError")) return; /* For now we can only show one message per newgrf file. */ if (_cur_grfconfig->error != NULL) return; buf++; // Skip the action byte. byte severity = grf_load_byte(&buf); byte lang = grf_load_byte(&buf); byte message_id = grf_load_byte(&buf); len -= 4; /* Skip the error if it isn't valid for the current language. */ if (!CheckGrfLangID(lang, _cur_grffile->grf_version)) return; /* Skip the error until the activation stage unless bit 7 of the severity * is set. */ if (!HasBit(severity, 7) && _cur_stage == GLS_INIT) { grfmsg(7, "GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur_stage); return; } ClrBit(severity, 7); if (severity >= lengthof(sevstr)) { grfmsg(7, "GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity); severity = 2; } else if (severity == 3) { /* This is a fatal error, so make sure the GRF is deactivated and no * more of it gets loaded. */ _cur_grfconfig->status = GCS_DISABLED; _skip_sprites = -1; } if (message_id >= lengthof(msgstr) && message_id != 0xFF) { grfmsg(7, "GRFLoadError: Invalid message id."); return; } if (len <= 1) { grfmsg(7, "GRFLoadError: No message data supplied."); return; } GRFError *error = CallocT(1); error->severity = sevstr[severity]; if (message_id == 0xFF) { /* This is a custom error message. */ const char *message = grf_load_string(&buf, len); len -= (strlen(message) + 1); error->custom_message = TranslateTTDPatchCodes(message); } else { error->message = msgstr[message_id]; } if (len > 0) { const char *data = grf_load_string(&buf, len); len -= (strlen(data) + 1); error->data = TranslateTTDPatchCodes(data); } /* Only two parameter numbers can be used in the string. */ uint i = 0; for (; i < 2 && len > 0; i++) { error->param_number[i] = grf_load_byte(&buf); len--; } error->num_params = i; _cur_grfconfig->error = error; } /* Action 0x0C */ static void GRFComment(byte *buf, int len) { /* <0C> [] * * V ignored Anything following the 0C is ignored */ if (len == 1) return; int text_len = len - 1; const char *text = (const char*)(buf + 1); grfmsg(2, "GRFComment: %.*s", text_len, text); } /* Action 0x0D (GLS_SAFETYSCAN) */ static void SafeParamSet(byte *buf, int len) { if (!check_length(len, 5, "SafeParamSet")) return; buf++; uint8 target = grf_load_byte(&buf); /* Only writing GRF parameters is considered safe */ if (target < 0x80) return; /* GRM could be unsafe, but as here it can only happen after other GRFs * are loaded, it should be okay. If the GRF tried to use the slots it * reserved, it would be marked unsafe anyway. GRM for (e.g. bridge) * sprites is considered safe. */ SetBit(_cur_grfconfig->flags, GCF_UNSAFE); /* Skip remainder of GRF */ _skip_sprites = -1; } static uint32 GetPatchVariable(uint8 param) { switch (param) { /* start year - 1920 */ case 0x0B: return max(_patches.starting_year, ORIGINAL_BASE_YEAR) - ORIGINAL_BASE_YEAR; /* freight trains weight factor */ case 0x0E: return _patches.freight_trains; /* empty wagon speed increase */ case 0x0F: return 0; /* plane speed factor */ case 0x10: return 4; /* 2CC colormap base sprite */ case 0x11: return SPR_2CCMAP_BASE; default: grfmsg(2, "ParamSet: Unknown Patch variable 0x%02X.", param); return 0; } } static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target, const char *type) { uint start = 0; uint size = 0; if (op == 6) { /* Return GRFID of set that reserved ID */ return grm[_cur_grffile->param[target]]; } /* With an operation of 2 or 3, we want to reserve a specific block of IDs */ if (op == 2 || op == 3) start = _cur_grffile->param[target]; for (uint i = start; i < num_ids; i++) { if (grm[i] == 0) { size++; } else { if (op == 2 || op == 3) break; start = i + 1; size = 0; } if (size == count) break; } if (size == count) { /* Got the slot... */ if (op == 0 || op == 3) { grfmsg(2, "ParamSet: GRM: Reserving %d %s at %d", count, type, start); for (uint i = 0; i < count; i++) grm[start + i] = _cur_grffile->grfid; } return start; } /* Unable to allocate */ if (op != 4 && op != 5) { /* Deactivate GRF */ grfmsg(0, "ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type); _cur_grfconfig->status = GCS_DISABLED; _skip_sprites = -1; return UINT_MAX; } grfmsg(1, "ParamSet: GRM: Unable to allocate %d %s", count, type); return UINT_MAX; } /* Action 0x0D */ static void ParamSet(byte *buf, int len) { /* <0D> [] * * B target parameter number where result is stored * B operation operation to perform, see below * B source1 first source operand * B source2 second source operand * D data data to use in the calculation, not necessary * if both source1 and source2 refer to actual parameters * * Operations * 00 Set parameter equal to source1 * 01 Addition, source1 + source2 * 02 Subtraction, source1 - source2 * 03 Unsigned multiplication, source1 * source2 (both unsigned) * 04 Signed multiplication, source1 * source2 (both signed) * 05 Unsigned bit shift, source1 by source2 (source2 taken to be a * signed quantity; left shift if positive and right shift if * negative, source1 is unsigned) * 06 Signed bit shift, source1 by source2 * (source2 like in 05, and source1 as well) */ if (!check_length(len, 5, "ParamSet")) return; buf++; uint8 target = grf_load_byte(&buf); uint8 oper = grf_load_byte(&buf); uint32 src1 = grf_load_byte(&buf); uint32 src2 = grf_load_byte(&buf); uint32 data = 0; if (len >= 8) data = grf_load_dword(&buf); /* You can add 80 to the operation to make it apply only if the target * is not defined yet. In this respect, a parameter is taken to be * defined if any of the following applies: * - it has been set to any value in the newgrf(w).cfg parameter list * - it OR A PARAMETER WITH HIGHER NUMBER has been set to any value by * an earlier action D */ if (HasBit(oper, 7)) { if (target < 0x80 && target < _cur_grffile->param_end) { grfmsg(7, "ParamSet: Param %u already defined, skipping", target); return; } oper = GB(oper, 0, 7); } if (src2 == 0xFE) { if (GB(data, 0, 8) == 0xFF) { if (data == 0x0000FFFF) { /* Patch variables */ src1 = GetPatchVariable(src1); } else { /* GRF Resource Management */ if (_cur_stage != GLS_ACTIVATION) { /* Ignore GRM during initialization */ src1 = 0; } else { uint8 op = src1; uint8 feature = GB(data, 8, 8); uint16 count = GB(data, 16, 16); switch (feature) { case 0x00: // Trains case 0x01: // Road Vehicles case 0x02: // Ships case 0x03: // Aircraft src1 = PerformGRM(&_grm_engines[_vehshifts[feature]], _vehcounts[feature], count, op, target, "vehicles"); if (_skip_sprites == -1) return; break; case 0x08: // General sprites switch (op) { case 0: /* Check if the allocated sprites will fit below the original sprite limit */ if (_cur_spriteid + count >= 16384) { grfmsg(0, "ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count); _cur_grfconfig->status = GCS_DISABLED; _skip_sprites = -1; return; } /* 'Reserve' space at the current sprite ID */ src1 = _cur_spriteid; _cur_spriteid += count; break; case 1: src1 = _cur_spriteid; break; default: grfmsg(1, "ParamSet: GRM: Unsupported operation %d for general sprites", op); return; } break; case 0x0B: // Cargo /* There are two ranges: one for cargo IDs and one for cargo bitmasks */ src1 = PerformGRM(_grm_cargos, NUM_CARGO * 2, count, op, target, "cargos"); if (_skip_sprites == -1) return; break; default: grfmsg(1, "ParamSet: GRM: Unsupported feature 0x%X", feature); return; } } } } else { /* Read another GRF File's parameter */ const GRFFile *file = GetFileByGRFID(data); if (file == NULL || src1 >= file->param_end) { src1 = 0; } else { src1 = file->param[src1]; } } } else { /* The source1 and source2 operands refer to the grf parameter number * like in action 6 and 7. In addition, they can refer to the special * variables available in action 7, or they can be FF to use the value * of . If referring to parameters that are undefined, a value * of 0 is used instead. */ src1 = (src1 == 0xFF) ? data : GetParamVal(src1, NULL); src2 = (src2 == 0xFF) ? data : GetParamVal(src2, NULL); } /* TODO: You can access the parameters of another GRF file by using * source2=FE, source1=the other GRF's parameter number and data=GRF * ID. This is only valid with operation 00 (set). If the GRF ID * cannot be found, a value of 0 is used for the parameter value * instead. */ uint32 res; switch (oper) { case 0x00: res = src1; break; case 0x01: res = src1 + src2; break; case 0x02: res = src1 - src2; break; case 0x03: res = src1 * src2; break; case 0x04: res = (int32)src1 * (int32)src2; break; case 0x05: if ((int32)src2 < 0) { res = src1 >> -(int32)src2; } else { res = src1 << src2; } break; case 0x06: if ((int32)src2 < 0) { res = (int32)src1 >> -(int32)src2; } else { res = (int32)src1 << src2; } break; case 0x07: // Bitwise AND res = src1 & src2; break; case 0x08: // Bitwise OR res = src1 | src2; break; case 0x09: // Unsigned division if (src2 == 0) { res = src1; } else { res = src1 / src2; } break; case 0x0A: // Signed divison if (src2 == 0) { res = src1; } else { res = (int32)src1 / (int32)src2; } break; case 0x0B: // Unsigned modulo if (src2 == 0) { res = src1; } else { res = src1 % src2; } break; case 0x0C: // Signed modulo if (src2 == 0) { res = src1; } else { res = (int32)src1 % (int32)src2; } break; default: grfmsg(0, "ParamSet: Unknown operation %d, skipping", oper); return; } switch (target) { case 0x8E: // Y-Offset for train sprites _traininfo_vehicle_pitch = res; break; case 0x8F: // Rail track type cost factors _railtype_cost_multiplier[0] = GB(res, 0, 8); if (_patches.disable_elrails) { _railtype_cost_multiplier[1] = GB(res, 0, 8); _railtype_cost_multiplier[2] = GB(res, 8, 8); } else { _railtype_cost_multiplier[1] = GB(res, 8, 8); _railtype_cost_multiplier[2] = GB(res, 16, 8); } _railtype_cost_multiplier[3] = GB(res, 16, 8); break; /* @todo implement */ case 0x93: // Tile refresh offset to left case 0x94: // Tile refresh offset to right case 0x95: // Tile refresh offset upwards case 0x96: // Tile refresh offset downwards case 0x97: // Snow line height case 0x99: // Global ID offset grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target); break; case 0x9E: // Miscellaneous GRF features _misc_grf_features = res; /* Set train list engine width */ _traininfo_vehicle_width = HasGrfMiscBit(GMB_TRAIN_WIDTH_32_PIXELS) ? 32 : 29; break; default: if (target < 0x80) { _cur_grffile->param[target] = res; if (target + 1U > _cur_grffile->param_end) _cur_grffile->param_end = target + 1; } else { grfmsg(7, "ParamSet: Skipping unknown target 0x%02X", target); } break; } } /* Action 0x0E (GLS_SAFETYSCAN) */ static void SafeGRFInhibit(byte *buf, int len) { /* <0E> * * B num Number of GRFIDs that follow * D grfids GRFIDs of the files to deactivate */ if (!check_length(len, 2, "GRFInhibit")) return; buf++; uint8 num = grf_load_byte(&buf); if (!check_length(len, 2 + 4 * num, "GRFInhibit")) return; for (uint i = 0; i < num; i++) { uint32 grfid = grf_load_dword(&buf); /* GRF is unsafe it if tries to deactivate other GRFs */ if (grfid != _cur_grfconfig->grfid) { SetBit(_cur_grfconfig->flags, GCF_UNSAFE); /* Skip remainder of GRF */ _skip_sprites = -1; return; } } } /* Action 0x0E */ static void GRFInhibit(byte *buf, int len) { /* <0E> * * B num Number of GRFIDs that follow * D grfids GRFIDs of the files to deactivate */ if (!check_length(len, 2, "GRFInhibit")) return; buf++; uint8 num = grf_load_byte(&buf); if (!check_length(len, 2 + 4 * num, "GRFInhibit")) return; for (uint i = 0; i < num; i++) { uint32 grfid = grf_load_dword(&buf); GRFConfig *file = GetGRFConfig(grfid); /* Unset activation flag */ if (file != NULL && file != _cur_grfconfig) { grfmsg(2, "GRFInhibit: Deactivating file '%s'", file->filename); file->status = GCS_DISABLED; } } } /* Action 0x0F */ static void FeatureTownName(byte *buf, int len) { /* <0F> * * B id ID of this definition in bottom 7 bits (final definition if bit 7 set) * V style-name Name of the style (only for final definition) * B num-parts Number of parts in this definition * V parts The parts */ if (!check_length(len, 1, "FeatureTownName: definition ID")) return; buf++; len--; uint32 grfid = _cur_grffile->grfid; GRFTownName *townname = AddGRFTownName(grfid); byte id = grf_load_byte(&buf); len--; grfmsg(6, "FeatureTownName: definition 0x%02X", id & 0x7F); if (HasBit(id, 7)) { /* Final definition */ ClrBit(id, 7); bool new_scheme = _cur_grffile->grf_version >= 7; if (!check_length(len, 1, "FeatureTownName: lang_id")) return; byte lang = grf_load_byte(&buf); len--; byte nb_gen = townname->nb_gen; do { ClrBit(lang, 7); if (!check_length(len, 1, "FeatureTownName: style name")) return; const char *name = grf_load_string(&buf, len); len -= strlen(name) + 1; grfmsg(6, "FeatureTownName: lang 0x%X -> '%s'", lang, TranslateTTDPatchCodes(name)); townname->name[nb_gen] = AddGRFString(grfid, id, lang, new_scheme, name, STR_UNDEFINED); if (!check_length(len, 1, "FeatureTownName: lang_id")) return; lang = grf_load_byte(&buf); len--; } while (lang != 0); townname->id[nb_gen] = id; townname->nb_gen++; } if (!check_length(len, 1, "FeatureTownName: number of parts")) return; byte nb = grf_load_byte(&buf); len--; grfmsg(6, "FeatureTownName: %d parts", nb, nb); townname->nbparts[id] = nb; townname->partlist[id] = CallocT(nb); for (int i = 0; i < nb; i++) { if (!check_length(len, 3, "FeatureTownName: parts header")) return; byte nbtext = grf_load_byte(&buf); townname->partlist[id][i].bitstart = grf_load_byte(&buf); townname->partlist[id][i].bitcount = grf_load_byte(&buf); townname->partlist[id][i].maxprob = 0; townname->partlist[id][i].partcount = nbtext; townname->partlist[id][i].parts = CallocT(nbtext); len -= 3; 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); for (int j = 0; j < nbtext; j++) { if (!check_length(len, 2, "FeatureTownName: part")) return; byte prob = grf_load_byte(&buf); len--; if (HasBit(prob, 7)) { byte ref_id = grf_load_byte(&buf); len--; if (townname->nbparts[ref_id] == 0) { grfmsg(0, "FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id); DelGRFTownName(grfid); _cur_grfconfig->status = GCS_DISABLED; _skip_sprites = -1; return; } grfmsg(6, "FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F); townname->partlist[id][i].parts[j].data.id = ref_id; } else { const char *text = grf_load_string(&buf, len); len -= strlen(text) + 1; townname->partlist[id][i].parts[j].data.text = TranslateTTDPatchCodes(text); grfmsg(6, "FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[id][i].parts[j].data.text, prob); } townname->partlist[id][i].parts[j].prob = prob; townname->partlist[id][i].maxprob += GB(prob, 0, 7); } grfmsg(6, "FeatureTownName: part %d, total probability %d", i, townname->partlist[id][i].maxprob); } } /* Action 0x10 */ static void DefineGotoLabel(byte *buf, int len) { /* <10>