/* $Id$ */ /** @file newgrf.cpp Base of all NewGRF support. */ #include "stdafx.h" #include <stdarg.h> #include "openttd.h" #include "debug.h" #include "fileio_func.h" #include "engine_func.h" #include "engine_base.h" #include "spritecache.h" #include "variables.h" #include "bridge.h" #include "town.h" #include "newgrf_engine.h" #include "newgrf_text.h" #include "fontcache.h" #include "currency.h" #include "landscape.h" #include "newgrf_house.h" #include "newgrf_sound.h" #include "newgrf_station.h" #include "industry.h" #include "newgrf_canal.h" #include "newgrf_commons.h" #include "newgrf_townname.h" #include "newgrf_industries.h" #include "rev.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" #include "network/network.h" #include "map_func.h" #include <map> #include "core/alloc_type.hpp" #include "table/strings.h" #include "table/build_industry.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]; /* 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; typedef void (*SpecialSpriteHandler)(byte *buf, size_t len); enum { MAX_STATIONS = 256, }; /* Temporary data used when loading only */ struct GRFTempEngineData { uint16 cargo_allowed; uint16 cargo_disallowed; uint8 rv_max_speed; ///< Temporary storage of RV prop 15, maximum speed in mph/0.8 }; static GRFTempEngineData *_gted; /* Contains the GRF ID of the owner of a vehicle if it has been reserved. * GRM for vehicles is only used if dynamic engine allocation is disabled, * so 256 is the number of original engines. */ static uint32 _grm_engines[256]; /* Contains the GRF ID of the owner of a cargo if it has been reserved */ static uint32 _grm_cargos[NUM_CARGO * 2]; struct GRFLocation { uint32 grfid; uint32 nfoline; GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { } bool operator<(const GRFLocation &other) const { return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline); } bool operator==(const GRFLocation &other) const { return this->grfid == other.grfid && this->nfoline == other.nfoline; } }; static std::map<GRFLocation, SpriteID> _grm_sprites; typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride; GRFLineToSpriteOverride _grf_line_to_action6_sprite_override; /** 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(size_t real, size_t 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; } /** Reset all NewGRFData that was used only while processing data */ static void ClearTemporaryNewGRFData(GRFFile *gf) { /* Clear the GOTO labels used for GRF processing */ for (GRFLabel *l = gf->label; l != NULL;) { GRFLabel *l2 = l->next; free(l); l = l2; } gf->label = NULL; /* Clear the list of spritegroups */ free(gf->spritegroups); gf->spritegroups = NULL; gf->spritegroups_count = 0; } typedef std::map<StringID *, uint32> StringIDToGRFIDMapping; StringIDToGRFIDMapping _string_to_grf_mapping; /** 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 */ switch (GB(str, 8, 8)) { case 0xD0: case 0xD1: case 0xD2: case 0xD3: case 0xDC: return GetGRFStringID(grfid, str); case 0xD4: case 0xD5: case 0xD6: case 0xD7: /* Strings embedded via 0x81 have 0x400 added to them (no real * explanation why...) */ return GetGRFStringID(grfid, str - 0x400); default: break; } #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 inline uint8 MapDOSColour(uint8 colour) { extern const byte _palmap_d2w[]; return (_use_palette == PAL_DOS ? colour : _palmap_d2w[colour]); } static std::map<uint32, uint32> _grf_id_overrides; static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid) { _grf_id_overrides[source_grfid] = target_grfid; grfmsg(5, "SetNewGRFOverride: Added override of 0x%X to 0x%X", BSWAP32(source_grfid), BSWAP32(target_grfid)); } /** * Returns the engine associated to a certain internal_id, resp. allocates it. * @param file NewGRF that wants to change the engine * @param type Vehicle type * @param internal_id Engine ID inside the NewGRF * @param static_access If the engine is not present, return NULL instead of allocating a new engine. (Used for static Action 0x04) * @return The requested engine */ static Engine *GetNewEngine(const GRFFile *file, VehicleType type, uint16 internal_id, bool static_access = false) { /* Hack for add-on GRFs that need to modify another GRF's engines. This lets * them use the same engine slots. */ uint32 scope_grfid = INVALID_GRFID; // If not using dynamic_engines, all newgrfs share their ID range if (_settings_game.vehicle.dynamic_engines) { /* If dynamic_engies is enabled, there can be multiple independent ID ranges. */ scope_grfid = file->grfid; uint32 override = _grf_id_overrides[file->grfid]; if (override != 0) { scope_grfid = override; const GRFFile *grf_match = GetFileByGRFID(override); if (grf_match == NULL) { grfmsg(5, "Tried mapping from GRFID %x to %x but target is not loaded", BSWAP32(file->grfid), BSWAP32(override)); } else { grfmsg(5, "Mapping from GRFID %x to %x", BSWAP32(file->grfid), BSWAP32(override)); } } /* Check if the engine is registered in the override manager */ EngineID engine = _engine_mngr.GetID(type, internal_id, scope_grfid); if (engine != INVALID_ENGINE) return GetEngine(engine); } /* Check if there is an unreserved slot */ EngineID engine = _engine_mngr.GetID(type, internal_id, INVALID_GRFID); if (engine != INVALID_ENGINE) { Engine *e = GetEngine(engine); if (e->grffile == NULL) { e->grffile = file; grfmsg(5, "Replaced engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id); } /* Reserve the engine slot */ if (!static_access) { EngineIDMapping *eid = _engine_mngr.Get(engine); eid->grfid = scope_grfid; // Note: this is INVALID_GRFID if dynamic_engines is disabled, so no reservation } return e; } if (static_access) return NULL; uint engine_pool_size = GetEnginePoolSize(); /* ... it's not, so create a new one based off an existing engine */ Engine *e = new Engine(type, internal_id); e->grffile = file; /* Reserve the engine slot */ assert(_engine_mngr.Length() == e->index); EngineIDMapping *eid = _engine_mngr.Append(); eid->type = type; eid->grfid = scope_grfid; // Note: this is INVALID_GRFID if dynamic_engines is disabled, so no reservation eid->internal_id = internal_id; eid->substitute_id = min(internal_id, _engine_counts[type]); // substitute_id == _engine_counts[subtype] means "no substitute" if (engine_pool_size != GetEnginePoolSize()) { /* Resize temporary engine data ... */ _gted = ReallocT(_gted, GetEnginePoolSize()); /* and blank the new block. */ size_t len = (GetEnginePoolSize() - engine_pool_size) * sizeof(*_gted); memset(_gted + engine_pool_size, 0, len); } grfmsg(5, "Created new engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id); return e; } EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id) { uint32 scope_grfid = INVALID_GRFID; // If not using dynamic_engines, all newgrfs share their ID range if (_settings_game.vehicle.dynamic_engines) { scope_grfid = file->grfid; uint32 override = _grf_id_overrides[file->grfid]; if (override != 0) scope_grfid = override; } return _engine_mngr.GetID(type, internal_id, scope_grfid); } /** Map the colour modifiers of TTDPatch to those that Open is using. * @param grf_sprite pointer to the structure been modified */ static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite) { if (HasBit(grf_sprite->pal, 14)) { ClrBit(grf_sprite->pal, 14); SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE); } if (HasBit(grf_sprite->sprite, 14)) { ClrBit(grf_sprite->sprite, 14); SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT); } if (HasBit(grf_sprite->sprite, 15)) { ClrBit(grf_sprite->sprite, 15); SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOUR); } } enum ChangeInfoResult { CIR_SUCCESS, ///< Variable was parsed and read CIR_UNHANDLED, ///< Variable was parsed but unread CIR_UNKNOWN, ///< Variable is unknown CIR_INVALID_ID, ///< Attempt to modify an invalid ID }; typedef ChangeInfoResult (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len); static ChangeInfoResult CommonVehicleChangeInfo(EngineInfo *ei, int prop, byte **buf) { switch (prop) { case 0x00: // Introduction date ei->base_intro = grf_load_word(buf) + DAYS_TILL_ORIGINAL_BASE_YEAR; break; case 0x02: // Decay speed ei->decay_speed = grf_load_byte(buf); 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); /* Sometimes a GRF wants hidden vehicles. Setting climates to * zero may cause the ID to be reallocated. */ if (ei->climates == 0) ei->climates = 0x80; break; case 0x07: // Loading speed /* Amount of cargo loaded during a vehicle's "loading tick" */ ei->load_amount = grf_load_byte(buf); break; default: return CIR_UNKNOWN; } return CIR_SUCCESS; } static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; for (int i = 0; i < numinfo; i++) { Engine *e = GetNewEngine(_cur_grffile, VEH_TRAIN, engine + i); EngineInfo *ei = &e->info; RailVehicleInfo *rvi = &e->u.rail; switch (prop) { case 0x05: { // Track type uint8 tracktype = grf_load_byte(&buf); if (tracktype < _cur_grffile->railtype_max) { RailType railtype = GetRailTypeByLabel(_cur_grffile->railtype_list[tracktype]); if (railtype == INVALID_RAILTYPE) { /* Rail type is not available, so disable this engine */ ei[i].climates = 0x80; } else { rvi[i].railtype = railtype; } break; } 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 /* Tells the AI that this engine is designed for * passenger services and shouldn't be used for freight. */ rvi->ai_passenger_only = grf_load_byte(&buf); 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 rvi->power = grf_load_word(&buf); /* Set engine / wagon state based on power */ if (rvi->power != 0) { if (rvi->railveh_type == RAILVEH_WAGON) { rvi->railveh_type = RAILVEH_SINGLEHEAD; } } else { rvi->railveh_type = RAILVEH_WAGON; } break; case 0x0D: // Running cost factor rvi->running_cost = grf_load_byte(&buf); break; case 0x0E: { // Running cost base uint32 base = grf_load_dword(&buf); /* These magic numbers are used in GRFs to specify the base cost: * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts */ if (base == 0) { rvi->running_cost_class = 0xFF; } else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) { grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base); } else { /* Convert the magic number to an index into the price data */ rvi->running_cost_class = (base - 0x4B34) / 6; } } 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) { rvi->railveh_type = RAILVEH_MULTIHEAD; } else { 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 if (ctype == 0xFF) { /* 0xFF is specified as 'use first refittable' */ rvi->cargo_type = CT_INVALID; } 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->cost_factor = 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 (_cur_grffile->railtype_max == 0) { /* Use traction type to select between normal and electrified * rail only when no translation list is in place. */ 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 AlterVehicleListOrder(e->index, grf_load_extended(&buf)); 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 = CIR_UNHANDLED; 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 _gted[e->index].cargo_allowed = grf_load_word(&buf); break; case 0x29: // Cargo classes disallowed _gted[e->index].cargo_disallowed = 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 = CommonVehicleChangeInfo(ei, prop, &buf); break; } } *bufp = buf; return ret; } static ChangeInfoResult RoadVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; for (int i = 0; i < numinfo; i++) { Engine *e = GetNewEngine(_cur_grffile, VEH_ROAD, engine + i); EngineInfo *ei = &e->info; RoadVehicleInfo *rvi = &e->u.road; 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 uint32 base = grf_load_dword(&buf); /* These magic numbers are used in GRFs to specify the base cost: * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts */ if (base == 0) { rvi->running_cost_class = 0xFF; } else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) { grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base); } else { /* Convert the magic number to an index into the price data */ rvi->running_cost_class = (base - 0x4B34) / 6; } 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 if (cargo == 0xFF) { rvi->cargo_type = CT_INVALID; } else { rvi->cargo_type = CT_INVALID; grfmsg(2, "RoadVehicleChangeInfo: Invalid cargo type %d, using first refittable", cargo); } } break; case 0x11: // Cost factor rvi->cost_factor = grf_load_byte(&buf); break; case 0x12: // SFX rvi->sfx = (SoundFx)grf_load_byte(&buf); break; case 0x13: // Power in 10hp rvi->power = grf_load_byte(&buf); break; case 0x14: // Weight in 1/4 tons rvi->weight = grf_load_byte(&buf); break; case 0x15: // Speed in mph/0.8 _gted[e->index].rv_max_speed = grf_load_byte(&buf); 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 rvi->tractive_effort = grf_load_byte(&buf); break; case 0x19: // Air drag rvi->air_drag = grf_load_byte(&buf); 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 _gted[e->index].cargo_allowed = grf_load_word(&buf); break; case 0x1E: // Cargo classes disallowed _gted[e->index].cargo_disallowed = grf_load_word(&buf); break; case 0x1F: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; case 0x20: // Alter purchase list sort order AlterVehicleListOrder(e->index, grf_load_extended(&buf)); break; default: ret = CommonVehicleChangeInfo(ei, prop, &buf); break; } } *bufp = buf; return ret; } static ChangeInfoResult ShipVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; for (int i = 0; i < numinfo; i++) { Engine *e = GetNewEngine(_cur_grffile, VEH_SHIP, engine + i); EngineInfo *ei = &e->info; ShipVehicleInfo *svi = &e->u.ship; 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->cost_factor = grf_load_byte(&buf); 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 if (cargo == 0xFF) { svi->cargo_type = CT_INVALID; } 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 = CIR_UNHANDLED; 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 _gted[e->index].cargo_allowed = grf_load_word(&buf); break; case 0x19: // Cargo classes disallowed _gted[e->index].cargo_disallowed = grf_load_word(&buf); break; case 0x1A: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; case 0x1B: // Alter purchase list sort order AlterVehicleListOrder(e->index, grf_load_extended(&buf)); break; default: ret = CommonVehicleChangeInfo(ei, prop, &buf); break; } } *bufp = buf; return ret; } static ChangeInfoResult AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; for (int i = 0; i < numinfo; i++) { Engine *e = GetNewEngine(_cur_grffile, VEH_AIRCRAFT, engine + i); EngineInfo *ei = &e->info; AircraftVehicleInfo *avi = &e->u.air; 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->cost_factor = grf_load_byte(&buf); 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 _gted[e->index].cargo_allowed = grf_load_word(&buf); break; case 0x19: // Cargo classes disallowed _gted[e->index].cargo_disallowed = grf_load_word(&buf); break; case 0x1A: // Long format introduction date (days since year 0) ei->base_intro = grf_load_dword(&buf); break; case 0x1B: // Alter purchase list sort order AlterVehicleListOrder(e->index, grf_load_extended(&buf)); break; default: ret = CommonVehicleChangeInfo(ei, prop, &buf); break; } } *bufp = buf; return ret; } static ChangeInfoResult StationChangeInfo(uint stid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (stid + numinfo > MAX_STATIONS) { grfmsg(1, "StationChangeInfo: Station %u is invalid, max %u, ignoring", stid + numinfo, MAX_STATIONS); return CIR_INVALID_ID; } /* Allocate station specs if necessary */ if (_cur_grffile->stations == NULL) _cur_grffile->stations = CallocT<StationSpec*>(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); return CIR_INVALID_ID; } 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<StationSpec>(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<DrawTileSprites>(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); } MapSpriteMappingRecolour(&dts->ground); 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.sprite = grf_load_word(&buf); dtss->image.pal = grf_load_word(&buf); /* Remap flags as ours collide */ if (HasBit(dtss->image.pal, 15)) { ClrBit(dtss->image.pal, 15); SetBit(dtss->image.sprite, SPRITE_MODIFIER_USE_OFFSET); } MapSpriteMappingRecolour(&dtss->image); } } 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; 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 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<byte>(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: // Animation info statspec->anim_frames = grf_load_byte(&buf); statspec->anim_status = grf_load_byte(&buf); break; case 0x17: // Animation speed statspec->anim_speed = grf_load_byte(&buf); break; case 0x18: // Animation triggers statspec->anim_triggers = grf_load_word(&buf); break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult CanalChangeInfo(uint id, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (id + numinfo > CF_END) { grfmsg(1, "CanalChangeInfo: Canal feature %u is invalid, max %u, ignoreing", id + numinfo, CF_END); return CIR_INVALID_ID; } for (int i = 0; i < numinfo; i++) { WaterFeature *wf = &_water_feature[id + i]; switch (prop) { case 0x08: wf->callbackmask = grf_load_byte(&buf); break; case 0x09: wf->flags = grf_load_byte(&buf); break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult BridgeChangeInfo(uint brid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (brid + numinfo > MAX_BRIDGES) { grfmsg(1, "BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo, MAX_BRIDGES); return CIR_INVALID_ID; } for (int i = 0; i < numinfo; i++) { BridgeSpec *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<PalSpriteID*>(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<PalSpriteID>(32); } for (byte sprite = 0; sprite < 32; sprite++) { SpriteID image = grf_load_word(&buf); SpriteID pal = grf_load_word(&buf); bridge->sprite_table[tableid][sprite].sprite = image; bridge->sprite_table[tableid][sprite].pal = pal; MapSpriteMappingRecolour(&bridge->sprite_table[tableid][sprite]); } } } 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; case 0x10: { // purchase string StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); if (newone != STR_UNDEFINED) bridge->material = newone; } break; case 0x11: // description of bridge with rails or roads case 0x12: { StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); if (newone != STR_UNDEFINED) bridge->transport_name[prop - 0x11] = newone; } break; case 0x13: // 16 bits cost multiplier bridge->price = grf_load_word(&buf); break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (hid + numinfo > HOUSE_MAX) { grfmsg(1, "TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo, HOUSE_MAX); return CIR_INVALID_ID; } /* Allocate house specs if they haven't been allocated already. */ if (_cur_grffile->housespec == NULL) { _cur_grffile->housespec = CallocT<HouseSpec*>(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); return CIR_INVALID_ID; } 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); continue; } /* Allocate space for this house. */ if (*house == NULL) *house = CallocT<HouseSpec>(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_year < 1930) housespec->min_year = 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_year = GB(years, 0, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 0, 8); housespec->max_year = 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) ? ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_CANDY : CT_GOODS) : ((_settings_game.game_creation.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 = grf_load_word(&buf); _string_to_grf_mapping[&housespec->building_name] = _cur_grffile->grfid; 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 = CIR_UNHANDLED; } break; case 0x21: // long introduction year housespec->min_year = grf_load_word(&buf); break; case 0x22: // long maximum year housespec->max_year = grf_load_word(&buf); break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; 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 /* This is loaded during the reservation stage, so just skip it here. */ /* Each entry is 4 bytes. */ buf += 4; 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; case 0x11: // GRF match for engine allocation /* This is loaded during the reservation stage, so just skip it here. */ /* Each entry is 8 bytes. */ buf += 8; break; case 0x12: // Rail type translation table /* This is loaded during the reservation stage, so just skip it here. */ /* Each entry is 4 bytes. */ buf += 4; break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult GlobalVarReserveInfo(uint gvid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; for (int i = 0; i < numinfo; i++) { switch (prop) { case 0x08: // Cost base factor grf_load_byte(&buf); break; case 0x09: { // Cargo Translation Table if (i == 0) { if (gvid != 0) { grfmsg(1, "ReserveChangeInfo: Cargo translation table must start at zero"); return CIR_INVALID_ID; } free(_cur_grffile->cargo_list); _cur_grffile->cargo_max = numinfo; _cur_grffile->cargo_list = MallocT<CargoLabel>(numinfo); } CargoLabel cl = grf_load_dword(&buf); _cur_grffile->cargo_list[i] = BSWAP32(cl); break; } case 0x0A: // Currency display names case 0x0C: // Currency options case 0x0F: // Euro introduction dates grf_load_word(&buf); break; case 0x0B: // Currency multipliers case 0x0D: // Currency prefix symbol case 0x0E: // Currency suffix symbol grf_load_dword(&buf); break; case 0x10: // Snow line height table buf += SNOW_LINE_MONTHS * SNOW_LINE_DAYS; break; case 0x11: { // GRF match for engine allocation uint32 s = grf_load_dword(&buf); uint32 t = grf_load_dword(&buf); SetNewGRFOverride(s, t); break; } case 0x12: { // Rail type translation table if (i == 0) { if (gvid != 0) { grfmsg(1, "ReserveChangeInfo: Rail type translation table must start at zero"); return CIR_INVALID_ID; } free(_cur_grffile->railtype_list); _cur_grffile->railtype_max = numinfo; _cur_grffile->railtype_list = MallocT<RailTypeLabel>(numinfo); } RailTypeLabel rtl = grf_load_dword(&buf); _cur_grffile->railtype_list[i] = BSWAP32(rtl); break; } default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (cid + numinfo > NUM_CARGO) { grfmsg(2, "CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo, NUM_CARGO - 1); return CIR_INVALID_ID; } 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->grffile = _cur_grffile; 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); _string_to_grf_mapping[&cs->name] = _cur_grffile->grfid; break; case 0x0A: // String for 1 unit of cargo cs->name_single = grf_load_word(&buf); _string_to_grf_mapping[&cs->name_single] = _cur_grffile->grfid; 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); _string_to_grf_mapping[&cs->units_volume] = _cur_grffile->grfid; break; case 0x0C: // String for quantity of cargo (e.g. 10 tonnes of coal) cs->quantifier = grf_load_word(&buf); _string_to_grf_mapping[&cs->quantifier] = _cur_grffile->grfid; break; case 0x0D: // String for two letter cargo abbreviation cs->abbrev = grf_load_word(&buf); _string_to_grf_mapping[&cs->abbrev] = _cur_grffile->grfid; 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 = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (_cur_grffile->sound_offset == 0) { grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping"); return CIR_INVALID_ID; } 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()); return CIR_INVALID_ID; } 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 = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (indtid + numinfo > NUM_INDUSTRYTILES) { grfmsg(1, "IndustryTilesChangeInfo: Too many industry tiles loaded (%u), max (%u). Ignoring.", indtid + numinfo, NUM_INDUSTRYTILES); return CIR_INVALID_ID; } /* Allocate industry tile specs if they haven't been allocated already. */ if (_cur_grffile->indtspec == NULL) { _cur_grffile->indtspec = CallocT<IndustryTileSpec*>(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); return CIR_INVALID_ID; } 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); continue; } /* Allocate space for this industry. */ if (*tilespec == NULL) { int tempid; *tilespec = CallocT<IndustryTileSpec>(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); continue; } _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 = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, byte **bufp, int len) { byte *buf = *bufp; ChangeInfoResult ret = CIR_SUCCESS; if (indid + numinfo > NUM_INDUSTRYTYPES) { grfmsg(1, "IndustriesChangeInfo: Too many industries loaded (%u), max (%u). Ignoring.", indid + numinfo, NUM_INDUSTRYTYPES); return CIR_INVALID_ID; } 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<IndustrySpec*>(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); return CIR_INVALID_ID; } 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); continue; } /* 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<IndustrySpec>(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); continue; } 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<IndustryTileTable*>(indsp->num_table); // Table with tiles to compose an industry IndustryTileTable *itt = CallocT<IndustryTileTable>(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<IndustryTileTable>(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 = grf_load_word(&buf); _string_to_grf_mapping[&indsp->closure_text] = _cur_grffile->grfid; break; case 0x0D: // Production increase message indsp->production_up_text = grf_load_word(&buf); _string_to_grf_mapping[&indsp->production_up_text] = _cur_grffile->grfid; break; case 0x0E: // Production decrease message indsp->production_down_text = grf_load_word(&buf); _string_to_grf_mapping[&indsp->production_down_text] = _cur_grffile->grfid; 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<uint8>(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[_settings_game.game_creation.landscape] = grf_load_byte(&buf); break; case 0x18: // Probability during gameplay indsp->appear_ingame[_settings_game.game_creation.landscape] = grf_load_byte(&buf); break; case 0x19: // Map colour 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 = grf_load_word(&buf); _string_to_grf_mapping[&indsp->new_industry_text] = _cur_grffile->grfid; 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, 16); indsp->input_cargo_multiplier[prop - 0x1C][1] = GB(multiples, 16, 16); } break; case 0x1F: // Industry name indsp->name = grf_load_word(&buf); _string_to_grf_mapping[&indsp->name] = _cur_grffile->grfid; 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; case 0x24: // name for nearby station indsp->station_name = grf_load_word(&buf); _string_to_grf_mapping[&indsp->station_name] = _cur_grffile->grfid; break; default: ret = CIR_UNKNOWN; break; } } *bufp = buf; return ret; } static bool HandleChangeInfoResult(const char *caller, ChangeInfoResult cir, uint8 feature, uint8 property) { switch (cir) { default: NOT_REACHED(); case CIR_SUCCESS: return false; case CIR_UNHANDLED: grfmsg(1, "%s: Ignoring property 0x%02X of feature 0x%02X (not implemented)", caller, property, feature); return false; case CIR_UNKNOWN: grfmsg(0, "%s: Unknown property 0x%02X of feature 0x%02X, disabling", caller, property, feature); /* Fall through */ case CIR_INVALID_ID: /* No debug message for an invalid ID, as it has already been output */ _skip_sprites = -1; _cur_grfconfig->status = GCS_DISABLED; _cur_grfconfig->error = CallocT<GRFError>(1); _cur_grfconfig->error->severity = STR_NEWGRF_ERROR_MSG_FATAL; _cur_grfconfig->error->message = (cir == CIR_INVALID_ID) ? STR_NEWGRF_ERROR_INVALID_ID : STR_NEWGRF_ERROR_UNKNOWN_PROPERTY; return true; } } /* Action 0x00 */ static void FeatureChangeInfo(byte *buf, size_t len) { byte *bufend = buf + len; /* <00> <feature> <num-props> <num-info> <id> (<property <new-info>)... * * 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 */ CanalChangeInfo, /* GSF_BRIDGE */ BridgeChangeInfo, /* GSF_TOWNHOUSE */ TownHouseChangeInfo, /* GSF_GLOBALVAR */ GlobalVarChangeInfo, /* 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; } while (numprops-- && buf < bufend) { uint8 prop = grf_load_byte(&buf); ChangeInfoResult cir = handler[feature](engine, numinfo, prop, &buf, bufend - buf); if (HandleChangeInfoResult("FeatureChangeInfo", cir, feature, prop)) return; } } /* Action 0x00 (GLS_SAFETYSCAN) */ static void SafeChangeInfo(byte *buf, size_t len) { if (!check_length(len, 6, "SafeChangeInfo")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 numprops = grf_load_byte(&buf); uint numinfo = grf_load_byte(&buf); 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; } else if (feature == GSF_GLOBALVAR && numprops == 1) { uint8 prop = grf_load_byte(&buf); /* Engine ID Mappings are safe, if the source is static */ if (prop == 0x11) { bool is_safe = true; for (uint i = 0; i < numinfo; i++) { uint32 s = grf_load_dword(&buf); grf_load_dword(&buf); // dest const GRFConfig *grfconfig = GetGRFConfig(s); if (grfconfig != NULL && !HasBit(grfconfig->flags, GCF_STATIC)) { is_safe = false; break; } } if (is_safe) return; } } SetBit(_cur_grfconfig->flags, GCF_UNSAFE); /* Skip remainder of GRF */ _skip_sprites = -1; } /* Action 0x00 (GLS_RESERVE) */ static void ReserveChangeInfo(byte *buf, size_t len) { byte *bufend = buf + len; if (!check_length(len, 6, "ReserveChangeInfo")) 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); ChangeInfoResult cir = CIR_SUCCESS; switch (feature) { default: NOT_REACHED(); case GSF_CARGOS: cir = CargoChangeInfo(index, numinfo, prop, &buf, bufend - buf); break; case GSF_GLOBALVAR: cir = GlobalVarReserveInfo(index, numinfo, prop, &buf, bufend - buf); break; } if (HandleChangeInfoResult("ReserveChangeInfo", cir, feature, prop)) return; } } /** * 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, size_t len) { /* <01> <feature> <num-sets> <num-ent> * * 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 (int 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, size_t 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, size_t len) { /* <02> <feature> <set-id> <type/num-entries> <feature-specific-data...> * * 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<DeterministicSpriteGroupRange>(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 case 0x84: // Relative scope { if (!check_length(bufend - buf, HasBit(type, 2) ? 8 : 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; if (HasBit(type, 2)) { if (feature <= GSF_AIRCRAFT) group->g.random.var_scope = VSG_SCOPE_RELATIVE; group->g.random.count = grf_load_byte(&buf); } 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<const SpriteGroup*>(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<const SpriteGroup*>(num_loaded); if (num_loading > 0) group->g.real.loading = CallocT<const SpriteGroup*>(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<DrawTileSprites>(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 */ MapSpriteMappingRecolour(&group->g.layout.dts->ground); 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<DrawTileSeqStruct>(num_sprites + 1); for (i = 0; i < num_sprites; i++) { DrawTileSeqStruct *seq = (DrawTileSeqStruct*)&group->g.layout.dts->seq[i]; seq->image.sprite = grf_load_word(&buf); seq->image.pal = grf_load_word(&buf); seq->delta_x = grf_load_byte(&buf); seq->delta_y = grf_load_byte(&buf); MapSpriteMappingRecolour(&seq->image); if (HasBit(seq->image.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.sprite, 0, 14) * sprites; SB(seq->image.sprite, 0, SPRITE_WIDTH, sprite); ClrBit(seq->image.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 bool IsValidGroupID(uint16 groupid, const char *function) { if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { grfmsg(1, "%s: Spriteset 0x%04X out of range (maximum 0x%02X) or empty, skipping.", function, groupid, _cur_grffile->spritegroups_count - 1); return false; } return true; } static void VehicleMapSpriteGroup(byte *buf, byte feature, uint8 idcount) { static EngineID *last_engines; static uint last_engines_count; bool wagover = false; /* Test for 'wagon override' flag */ if (HasBit(idcount, 7)) { wagover = true; /* Strip off the flag */ idcount = GB(idcount, 0, 7); 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); } else { if (last_engines_count != idcount) { last_engines = ReallocT(last_engines, idcount); last_engines_count = idcount; } } EngineID *engines = AllocaM(EngineID, idcount); for (uint i = 0; i < idcount; i++) { engines[i] = GetNewEngine(_cur_grffile, (VehicleType)feature, grf_load_extended(&buf))->index; if (!wagover) last_engines[i] = engines[i]; } uint8 cidcount = grf_load_byte(&buf); for (uint c = 0; c < cidcount; c++) { uint8 ctype = grf_load_byte(&buf); uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) continue; grfmsg(8, "VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid); ctype = TranslateCargo(feature, ctype); if (ctype == CT_INVALID) continue; for (uint i = 0; i < idcount; i++) { EngineID engine = engines[i]; grfmsg(7, "VehicleMapSpriteGroup: [%d] Engine %d...", i, engine); if (wagover) { SetWagonOverrideSprites(engine, ctype, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count); } else { SetCustomEngineSprites(engine, ctype, _cur_grffile->spritegroups[groupid]); } } } uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) return; grfmsg(8, "-- Default group id 0x%04X", groupid); for (uint i = 0; i < idcount; i++) { EngineID engine = engines[i]; if (wagover) { 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); } } } static void CanalMapSpriteGroup(byte *buf, uint8 idcount) { CanalFeature *cfs = AllocaM(CanalFeature, idcount); for (uint i = 0; i < idcount; i++) { cfs[i] = (CanalFeature)grf_load_byte(&buf); } uint8 cidcount = grf_load_byte(&buf); buf += cidcount * 3; uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "CanalMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { CanalFeature cf = cfs[i]; if (cf >= CF_END) { grfmsg(1, "CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf); continue; } _water_feature[cf].grffile = _cur_grffile; _water_feature[cf].group = _cur_grffile->spritegroups[groupid]; } } static void StationMapSpriteGroup(byte *buf, uint8 idcount) { uint8 *stations = AllocaM(uint8, idcount); for (uint i = 0; i < idcount; i++) { stations[i] = grf_load_byte(&buf); } uint8 cidcount = grf_load_byte(&buf); for (uint c = 0; c < cidcount; c++) { uint8 ctype = grf_load_byte(&buf); uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) continue; ctype = TranslateCargo(GSF_STATION, ctype); if (ctype == CT_INVALID) continue; for (uint i = 0; i < idcount; i++) { StationSpec *statspec = _cur_grffile->stations[stations[i]]; if (statspec == NULL) { grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]); continue; } statspec->spritegroup[ctype] = _cur_grffile->spritegroups[groupid]; } } uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { StationSpec *statspec = _cur_grffile->stations[stations[i]]; if (statspec == NULL) { grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]); continue; } statspec->spritegroup[CT_DEFAULT] = _cur_grffile->spritegroups[groupid]; statspec->grffile = _cur_grffile; statspec->localidx = stations[i]; SetCustomStationSpec(statspec); } } static void TownHouseMapSpriteGroup(byte *buf, uint8 idcount) { uint8 *houses = AllocaM(uint8, idcount); for (uint i = 0; i < idcount; i++) { houses[i] = grf_load_byte(&buf); } /* Skip the cargo type section, we only care about the default group */ uint8 cidcount = grf_load_byte(&buf); buf += cidcount * 3; uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "TownHouseMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { HouseSpec *hs = _cur_grffile->housespec[houses[i]]; if (hs == NULL) { grfmsg(1, "TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]); continue; } hs->spritegroup = _cur_grffile->spritegroups[groupid]; } } static void IndustryMapSpriteGroup(byte *buf, uint8 idcount) { uint8 *industries = AllocaM(uint8, idcount); for (uint i = 0; i < idcount; i++) { industries[i] = grf_load_byte(&buf); } /* Skip the cargo type section, we only care about the default group */ uint8 cidcount = grf_load_byte(&buf); buf += cidcount * 3; uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "IndustryMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { IndustrySpec *indsp = _cur_grffile->industryspec[industries[i]]; if (indsp == NULL) { grfmsg(1, "IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]); continue; } indsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid]; } } static void IndustrytileMapSpriteGroup(byte *buf, uint8 idcount) { uint8 *indtiles = AllocaM(uint8, idcount); for (uint i = 0; i < idcount; i++) { indtiles[i] = grf_load_byte(&buf); } /* Skip the cargo type section, we only care about the default group */ uint8 cidcount = grf_load_byte(&buf); buf += cidcount * 3; uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "IndustrytileMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { IndustryTileSpec *indtsp = _cur_grffile->indtspec[indtiles[i]]; if (indtsp == NULL) { grfmsg(1, "IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]); continue; } indtsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid]; } } static void CargoMapSpriteGroup(byte *buf, uint8 idcount) { CargoID *cargos = AllocaM(CargoID, idcount); for (uint i = 0; i < idcount; i++) { cargos[i] = grf_load_byte(&buf); } /* Skip the cargo type section, we only care about the default group */ uint8 cidcount = grf_load_byte(&buf); buf += cidcount * 3; uint16 groupid = grf_load_word(&buf); if (!IsValidGroupID(groupid, "CargoMapSpriteGroup")) return; for (uint i = 0; i < idcount; i++) { CargoID cid = cargos[i]; if (cid >= NUM_CARGO) { grfmsg(1, "CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid); continue; } CargoSpec *cs = &_cargo[cid]; cs->grffile = _cur_grffile; cs->group = _cur_grffile->spritegroups[groupid]; } } /* Action 0x03 */ static void FeatureMapSpriteGroup(byte *buf, size_t len) { /* <03> <feature> <n-id> <ids>... <num-cid> [<cargo-type> <cid>]... <def-cid> * id-list := [<id>] [id-list] * cargo-list := <cargo-type> <cid> [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 (_cur_grffile->spritegroups == 0) { grfmsg(1, "FeatureMapSpriteGroup: No sprite groups to work on! Skipping"); return; } if (!check_length(len, 6, "FeatureMapSpriteGroup")) return; buf++; uint8 feature = grf_load_byte(&buf); uint8 idcount = grf_load_byte(&buf); /* If idcount is zero, this is a feature callback */ if (idcount == 0) { /* Skip number of cargo ids? */ grf_load_byte(&buf); uint16 groupid = grf_load_word(&buf); grfmsg(6, "FeatureMapSpriteGroup: Adding generic feature callback for feature %d", feature); AddGenericCallback(feature, _cur_grffile, _cur_grffile->spritegroups[groupid]); return; } grfmsg(6, "FeatureMapSpriteGroup: Feature %d, %d ids", feature, idcount); switch (feature) { case GSF_TRAIN: case GSF_ROAD: case GSF_SHIP: case GSF_AIRCRAFT: VehicleMapSpriteGroup(buf, feature, idcount); return; case GSF_CANAL: CanalMapSpriteGroup(buf, idcount); return; case GSF_STATION: StationMapSpriteGroup(buf, idcount); return; case GSF_TOWNHOUSE: TownHouseMapSpriteGroup(buf, idcount); return; case GSF_INDUSTRIES: IndustryMapSpriteGroup(buf, idcount); return; case GSF_INDUSTRYTILES: IndustrytileMapSpriteGroup(buf, idcount); return; case GSF_CARGOS: CargoMapSpriteGroup(buf, idcount); return; default: grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature %d, skipping", feature); return; } } /* Action 0x04 */ static void FeatureNewName(byte *buf, size_t len) { /* <04> <veh-type> <language-id> <num-veh> <offset> <data...> * * 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; if (generic) { id = grf_load_word(&buf); } else if (feature <= GSF_AIRCRAFT) { id = grf_load_extended(&buf); } else { id = grf_load_byte(&buf); } ClrBit(lang, 7); 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 (!generic) { Engine *e = GetNewEngine(_cur_grffile, (VehicleType)feature, id, HasBit(_cur_grfconfig->flags, GCF_STATIC)); if (e == NULL) break; StringID string = AddGRFString(_cur_grffile->grfid, e->index, lang, new_scheme, name, e->info.string_id); e->info.string_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 0xD1: case 0xD2: case 0xD3: 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; } /* Action 0x05 */ static void GraphicsNew(byte *buf, size_t len) { /* <05> <graphics-type> <num-sprites> <other data...> * * 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 */ enum Action5BlockType { A5BLOCK_FIXED, ///< Only allow replacing a whole block of sprites. (TTDP compatible) A5BLOCK_ALLOW_OFFSET, ///< Allow replacing any subset by specifiing an offset. A5BLOCK_INVALID, ///< unknown/not-implemented type }; struct Action5Type { Action5BlockType block_type; ///< How is this Action5 type processed? SpriteID sprite_base; ///< Load the sprites starting from this sprite. uint16 min_sprites; ///< If the Action5 contains less sprites, the whole block will be ignored. uint16 max_sprites; ///< If the Action5 contains more sprites, only the first max_sprites sprites will be used. const char *name; ///< Name for error messages. }; static const Action5Type action5_types[] = { /* Note: min_sprites should not be changed. Therefore these constants are directly here and not in sprites.h */ /* 0x00 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x00" }, /* 0x01 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x01" }, /* 0x02 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x02" }, /* 0x03 */ { A5BLOCK_INVALID, 0, 0, 0, "Type 0x03" }, /* 0x04 */ { A5BLOCK_FIXED, SPR_SIGNALS_BASE, 48, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT, "Signal graphics" }, /* 0x05 */ { A5BLOCK_FIXED, SPR_ELRAIL_BASE, 48, ELRAIL_SPRITE_COUNT, "Catenary graphics" }, /* 0x06 */ { A5BLOCK_FIXED, SPR_SLOPES_BASE, 74, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT, "Foundation graphics" }, /* 0x07 */ { A5BLOCK_INVALID, 0, 75, 0, "TTDP GUI graphics" }, // Not used by OTTD. /* 0x08 */ { A5BLOCK_FIXED, SPR_CANALS_BASE, 65, CANALS_SPRITE_COUNT, "Canal graphics" }, /* 0x09 */ { A5BLOCK_FIXED, SPR_ONEWAY_BASE, 6, ONEWAY_SPRITE_COUNT, "One way road graphics" }, /* 0x0A */ { A5BLOCK_FIXED, SPR_2CCMAP_BASE, 256, TWOCCMAP_SPRITE_COUNT, "2CC colour maps" }, /* 0x0B */ { A5BLOCK_FIXED, SPR_TRAMWAY_BASE, 113, TRAMWAY_SPRITE_COUNT, "Tramway graphics" }, /* 0x0C */ { A5BLOCK_INVALID, 0, 133, 0, "Snowy temperate tree" }, // Not yet used by OTTD. /* 0x0D */ { A5BLOCK_FIXED, SPR_SHORE_BASE, 16, SPR_SHORE_SPRITE_COUNT, "Shore graphics" }, /* 0x0E */ { A5BLOCK_INVALID, 0, 0, 0, "New Signals graphics" }, // Not yet used by OTTD. /* 0x0F */ { A5BLOCK_FIXED, SPR_TRACKS_FOR_SLOPES_BASE, 12, TRACKS_FOR_SLOPES_SPRITE_COUNT, "Sloped rail track" }, /* 0x10 */ { A5BLOCK_FIXED, SPR_AIRPORTX_BASE, 15, AIRPORTX_SPRITE_COUNT, "Airport graphics" }, /* 0x11 */ { A5BLOCK_FIXED, SPR_ROADSTOP_BASE, 8, ROADSTOP_SPRITE_COUNT, "Road stop graphics" }, /* 0x12 */ { A5BLOCK_FIXED, SPR_AQUEDUCT_BASE, 8, AQUEDUCT_SPRITE_COUNT, "Aqueduct graphics" }, /* 0x13 */ { A5BLOCK_FIXED, SPR_AUTORAIL_BASE, 55, AUTORAIL_SPRITE_COUNT, "Autorail graphics" }, /* 0x14 */ { A5BLOCK_ALLOW_OFFSET, SPR_FLAGS_BASE, 1, FLAGS_SPRITE_COUNT, "Flag graphics" }, /* 0x15 */ { A5BLOCK_ALLOW_OFFSET, SPR_OPENTTD_BASE, 1, OPENTTD_SPRITE_COUNT, "OpenTTD GUI graphics" }, }; if (!check_length(len, 2, "GraphicsNew")) return; buf++; uint8 type = grf_load_byte(&buf); uint16 num = grf_load_extended(&buf); 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. if ((type == 0x0D) && (num == 10) && _cur_grffile->is_ottdfile) { /* Special not-TTDP-compatible case used in openttd(d/w).grf * Missing shore sprites and initialisation of SPR_SHORE_BASE */ grfmsg(2, "GraphicsNew: Loading 10 missing shore sprites from openttd(d/w).grf."); LoadNextSprite(SPR_SHORE_BASE + 0, _file_index, _nfo_line++); // SLOPE_STEEP_S LoadNextSprite(SPR_SHORE_BASE + 5, _file_index, _nfo_line++); // SLOPE_STEEP_W LoadNextSprite(SPR_SHORE_BASE + 7, _file_index, _nfo_line++); // SLOPE_WSE LoadNextSprite(SPR_SHORE_BASE + 10, _file_index, _nfo_line++); // SLOPE_STEEP_N LoadNextSprite(SPR_SHORE_BASE + 11, _file_index, _nfo_line++); // SLOPE_NWS 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 if (_loaded_newgrf_features.shore == SHORE_REPLACE_NONE) _loaded_newgrf_features.shore = SHORE_REPLACE_ONLY_NEW; return; } /* Supported type? */ if ((type >= lengthof(action5_types)) || (action5_types[type].block_type == A5BLOCK_INVALID)) { grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num); _skip_sprites = num; return; } const Action5Type *action5_type = &action5_types[type]; /* Ignore offset if not allowed */ if ((action5_type->block_type != A5BLOCK_ALLOW_OFFSET) && (offset != 0)) { grfmsg(1, "GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->name, type); offset = 0; } /* Ignore action5 if too few sprites are specified. (for TTDP compatibility) * This does not make sense, if <offset> is allowed */ if ((action5_type->block_type == A5BLOCK_FIXED) && (num < action5_type->min_sprites)) { grfmsg(1, "GraphicsNew: %s (type 0x%02X) count must be at least %d. Only %d were specified. Skipping.", action5_type->name, type, action5_type->min_sprites, num); _skip_sprites = num; return; } /* Load at most max_sprites sprites. Skip remaining sprites. (for compatibility with TTDP and future extentions) */ uint16 skip_num = SanitizeSpriteOffset(num, offset, action5_type->max_sprites, action5_type->name); SpriteID replace = action5_type->sprite_base + offset; /* Load <num> sprites starting from <replace>, then skip <skip_num> sprites. */ grfmsg(2, "GraphicsNew: Replacing sprites %d to %d of %s (type 0x%02X) at SpriteID 0x%04X", offset, offset + num - 1, action5_type->name, type, replace); for (; num > 0; num--) { _nfo_line++; LoadNextSprite(replace == 0 ? _cur_spriteid++ : replace++, _file_index, _nfo_line); } if (type == 0x0D) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_5; _skip_sprites = skip_num; } /* Action 0x05 (SKIP) */ static void SkipAct5(byte *buf, size_t 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); } /** * Reads a variable common to VarAction2 and Action7/9/D. * * Returns VarAction2 variable 'param' resp. Action7/9/D variable '0x80 + param'. * If a variable is not accessible from all four actions, it is handled in the action specific functions. * * @param param variable number (as for VarAction2, for Action7/9/D you have to subtract 0x80 first). * @param value returns the value of the variable. * @return true iff the variable is known and the value is returned in 'value'. */ bool GetGlobalVariable(byte param, uint32 *value) { switch (param) { case 0x00: // current date *value = max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0); return true; case 0x01: // current year *value = Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; return true; case 0x02: { // detailed date information: month of year (bit 0-7), day of month (bit 8-12), leap year (bit 15), day of year (bit 16-24) YearMonthDay ymd; ConvertDateToYMD(_date, &ymd); Date start_of_year = ConvertYMDToDate(ymd.year, 0, 1); *value = ymd.month | (ymd.day - 1) << 8 | (IsLeapYear(ymd.year) ? 1 << 15 : 0) | (_date - start_of_year) << 16; return true; } case 0x03: // current climate, 0=temp, 1=arctic, 2=trop, 3=toyland *value = _settings_game.game_creation.landscape; return true; case 0x06: // road traffic side, bit 4 clear=left, set=right *value = _settings_game.vehicle.road_side << 4; return true; case 0x09: // date fraction *value = _date_fract; return true; case 0x0A: // animation counter *value = _tick_counter; return true; case 0x0B: { // TTDPatch version uint major = 2; uint minor = 6; uint revision = 1; // special case: 2.0.1 is 2.0.10 uint build = 1382; *value = (major << 24) | (minor << 20) | (revision << 16) | build; return true; } case 0x0D: // TTD Version, 00=DOS, 01=Windows *value = _cur_grfconfig->windows_paletted; return true; case 0x0E: // Y-offset for train sprites *value = _traininfo_vehicle_pitch; return true; case 0x0F: // Rail track type cost factors *value = 0; SB(*value, 0, 8, GetRailTypeInfo(RAILTYPE_RAIL)->cost_multiplier); // normal rail if (_settings_game.vehicle.disable_elrails) { /* skip elrail multiplier - disabled */ SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_MONO)->cost_multiplier); // monorail } else { SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_ELECTRIC)->cost_multiplier); // electified railway /* Skip monorail multiplier - no space in result */ } SB(*value, 16, 8, GetRailTypeInfo(RAILTYPE_MAGLEV)->cost_multiplier); // maglev return true; case 0x11: // current rail tool type *value = 0; return true; case 0x12: // Game mode *value = _game_mode; return true; /* case 0x13: // Tile refresh offset to left not implemented */ /* case 0x14: // Tile refresh offset to right not implemented */ /* case 0x15: // Tile refresh offset upwards not implemented */ /* case 0x16: // Tile refresh offset downwards not implemented */ /* case 0x17: // temperate snow line not implemented */ case 0x1A: // Always -1 *value = UINT_MAX; return true; case 0x1B: // Display options *value = GB(_display_opt, 0, 6); return true; case 0x1D: // TTD Platform, 00=TTDPatch, 01=OpenTTD *value = 1; return true; case 0x1E: // Miscellaneous GRF features *value = _misc_grf_features; return true; /* case 0x1F: // locale dependent settings not implemented */ case 0x20: // snow line height *value = _settings_game.game_creation.landscape == LT_ARCTIC ? GetSnowLine() : 0xFF; return true; case 0x21: // OpenTTD version *value = _openttd_newgrf_version; return true; case 0x22: // difficulty level *value = _settings_game.difficulty.diff_level; return true; case 0x23: // long format date *value = _date; return true; case 0x24: // long format year *value = _cur_year; return true; default: return false; } } static uint32 GetParamVal(byte param, uint32 *cond_val) { /* First handle variable common with VarAction2 */ uint32 value; if (GetGlobalVariable(param - 0x80, &value)) return value; /* Non-common variable */ switch (param) { 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 0x88: // GRF ID check return 0; /* case 0x99: Global ID offest not implemented */ 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, size_t len) { /* <06> <param-num> <param-size> <offset> ... <FF> * * 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 */ size_t pos = FioGetPos(); uint16 num = FioReadWord(); uint8 type = FioReadByte(); byte *preload_sprite = NULL; /* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */ if (type == 0xFF) { preload_sprite = MallocT<byte>(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)"); free(preload_sprite); return; } GRFLocation location(_cur_grfconfig->grfid, _nfo_line + 1); GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location); if (it != _grf_line_to_action6_sprite_override.end()) { free(preload_sprite); preload_sprite = _grf_line_to_action6_sprite_override[location]; } else { _grf_line_to_action6_sprite_override[location] = preload_sprite; } /* 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 && offset + i < num; 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); } } } } /** * Disable a static NewGRF when it is influencing another (non-static) * NewGRF as this could cause desyncs. * * We could just tell the NewGRF querying that the file doesn't exist, * but that might give unwanted results. Disabling the NewGRF gives the * best result as no NewGRF author can complain about that. * @param c the NewGRF to disable. */ static void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig *c) { if (c->error != NULL) { free(c->error->custom_message); free(c->error->data); free(c->error); } c->status = GCS_DISABLED; c->error = CallocT<GRFError>(1); c->error->data = strdup(_cur_grfconfig->name); c->error->severity = STR_NEWGRF_ERROR_MSG_FATAL; c->error->message = STR_NEWGRF_ERROR_STATIC_GRF_CAUSES_DESYNC; ClearTemporaryNewGRFData(GetFileByGRFID(c->grfid)); } /* Action 0x07 * Action 0x09 */ static void SkipIf(byte *buf, size_t len) { /* <07/09> <param-num> <param-size> <condition-type> <value> <num-sprites> * * 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 8: cond_val = grf_load_dword(&buf); mask = grf_load_dword(&buf); break; 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 */ GRFConfig *c = GetGRFConfig(cond_val, mask); if (c != NULL && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur_grfconfig->flags, GCF_STATIC) && c->status != GCS_DISABLED && _networking) { DisableStaticNewGRFInfluencingNonStaticNewGRFs(c); c = NULL; } 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; case 0x0D: result = GetRailTypeByLabel(BSWAP32(cond_val)) == INVALID_RAILTYPE; break; case 0x0E: result = GetRailTypeByLabel(BSWAP32(cond_val)) != INVALID_RAILTYPE; 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; ClearTemporaryNewGRFData(_cur_grffile); } } } /* Action 0x08 (GLS_FILESCAN) */ static void ScanInfo(byte *buf, size_t 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(grfid, name); len -= strlen(name) + 1; if (len > 0) { const char *info = grf_load_string(&buf, len); _cur_grfconfig->info = TranslateTTDPatchCodes(grfid, 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, size_t len) { /* <08> <version> <grf-id> <name> <info> * * 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); if (_cur_stage < GLS_RESERVE && _cur_grfconfig->status != GCS_UNKNOWN) { _cur_grfconfig->status = GCS_DISABLED; _cur_grfconfig->error = CallocT<GRFError>(1); _cur_grfconfig->error->severity = STR_NEWGRF_ERROR_MSG_FATAL; _cur_grfconfig->error->message = STR_NEWGRF_ERROR_MULTIPLE_ACTION_8; _skip_sprites = -1; return; } _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 (palette: %s)", version, BSWAP32(grfid), name, _cur_grfconfig->windows_paletted ? "Windows" : "DOS"); } /* Action 0x0A */ static void SpriteReplace(byte *buf, size_t len) { /* <0A> <num-sets> <set1> [<set2> ...] * <set>: <num-sprites> <first-sprite> * * 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 detect when the old ones get replaced. */ if (IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) { if (_loaded_newgrf_features.shore != SHORE_REPLACE_ACTION_5) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_A; } } } } /* Action 0x0A (SKIP) */ static void SkipActA(byte *buf, size_t 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, size_t len) { /* <0B> <severity> <language-id> <message-id> [<message...> 00] [<data...>] 00 [<parnum>] * * 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; ClearTemporaryNewGRFData(_cur_grffile); _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<GRFError>(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(_cur_grffile->grfid, 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(_cur_grffile->grfid, 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, size_t len) { /* <0C> [<ignored...>] * * V ignored Anything following the 0C is ignored */ if (len == 1) return; size_t 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, size_t 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(_settings_game.game_creation.starting_year, ORIGINAL_BASE_YEAR) - ORIGINAL_BASE_YEAR; /* freight trains weight factor */ case 0x0E: return _settings_game.vehicle.freight_trains; /* empty wagon speed increase */ case 0x0F: return 0; /* plane speed factor; our patch option is reversed from TTDPatch's, * the following is good for 1x, 2x and 4x (most common?) and... * well not really for 3x. */ case 0x10: switch (_settings_game.vehicle.plane_speed) { default: case 4: return 1; case 3: return 2; case 2: return 2; case 1: return 4; } /* 2CC colourmap base sprite */ case 0x11: return SPR_2CCMAP_BASE; /* map size: format = -MABXYSS * M : the type of map * bit 0 : set : squared map. Bit 1 is now not relevant * clear : rectangle map. Bit 1 will indicate the bigger edge of the map * bit 1 : set : Y is the bigger edge. Bit 0 is clear * clear : X is the bigger edge. * A : minimum edge(log2) of the map * B : maximum edge(log2) of the map * XY : edges(log2) of each side of the map. * SS : combination of both X and Y, thus giving the size(log2) of the map */ case 0x13: { byte map_bits = 0; byte log_X = MapLogX() - 6; // substraction is required to make the minimal size (64) zero based byte log_Y = MapLogY() - 6; byte max_edge = max(log_X, log_Y); if (log_X == log_Y) { // we have a squared map, since both edges are identical SetBit(map_bits ,0); } else { if (max_edge == log_Y) SetBit(map_bits, 1); // edge Y been the biggest, mark it } return (map_bits << 24) | (min(log_X, log_Y) << 20) | (max_edge << 16) | (log_X << 12) | (log_Y << 8) | (log_X + log_Y); } 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; ClearTemporaryNewGRFData(_cur_grffile); _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, size_t len) { /* <0D> <target> <operation> <source1> <source2> [<data>] * * 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 */ uint8 op = src1; uint8 feature = GB(data, 8, 8); uint16 count = GB(data, 16, 16); if (_cur_stage == GLS_RESERVE) { if (feature == 0x08) { /* General sprites */ if (op == 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; ClearTemporaryNewGRFData(_cur_grffile); _skip_sprites = -1; return; } /* Reserve space at the current sprite ID */ grfmsg(4, "ParamSet: GRM: Allocated %d sprites at %d", count, _cur_spriteid); _grm_sprites[GRFLocation(_cur_grffile->grfid, _nfo_line)] = _cur_spriteid; _cur_spriteid += count; } } /* Ignore GRM result during reservation */ src1 = 0; } else if (_cur_stage == GLS_ACTIVATION) { switch (feature) { case 0x00: // Trains case 0x01: // Road Vehicles case 0x02: // Ships case 0x03: // Aircraft if (!_settings_game.vehicle.dynamic_engines) { src1 = PerformGRM(&_grm_engines[_engine_offsets[feature]], _engine_counts[feature], count, op, target, "vehicles"); if (_skip_sprites == -1) return; } else { /* GRM does not apply for dynamic engine allocation. */ switch (op) { case 2: case 3: src1 = _cur_grffile->param[target]; break; default: src1 = 0; break; } } break; case 0x08: // General sprites switch (op) { case 0: /* Return space reserved during reservation stage */ src1 = _grm_sprites[GRFLocation(_cur_grffile->grfid, _nfo_line)]; grfmsg(4, "ParamSet: GRM: Using pre-allocated sprites at %d", src1); 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 { /* Ignore GRM during initialization */ src1 = 0; } } } else { /* Read another GRF File's parameter */ const GRFFile *file = GetFileByGRFID(data); GRFConfig *c = GetGRFConfig(data); if (c != NULL && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur_grfconfig->flags, GCF_STATIC) && _networking) { /* Disable the read GRF if it is a static NewGRF. */ DisableStaticNewGRFInfluencingNonStaticNewGRFs(c); src1 = 0; } else if (file == NULL || src1 >= file->param_end || (c != NULL && c->status == GCS_DISABLED)) { 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 <data>. 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 extern RailtypeInfo _railtypes[RAILTYPE_END]; _railtypes[RAILTYPE_RAIL].cost_multiplier = GB(res, 0, 8); if (_settings_game.vehicle.disable_elrails) { _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 0, 8); _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 8, 8); } else { _railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 8, 8); _railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 16, 8); } _railtypes[RAILTYPE_MAGLEV].cost_multiplier = 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; case 0x9F: // locale-dependent settings grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target); 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, size_t len) { /* <0E> <num> <grfids...> * * 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, size_t len) { /* <0E> <num> <grfids...> * * 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, size_t len) { /* <0F> <id> <style-name> <num-parts> <parts> * * 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; char *lang_name = TranslateTTDPatchCodes(grfid, name); grfmsg(6, "FeatureTownName: lang 0x%X -> '%s'", lang, lang_name); free(lang_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<NamePartList>(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<NamePart>(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; ClearTemporaryNewGRFData(_cur_grffile); _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(grfid, 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, size_t len) { /* <10> <label> [<comment>] * * B label The label to define * V comment Optional comment - ignored */ if (!check_length(len, 1, "DefineGotoLabel")) return; buf++; len--; GRFLabel *label = MallocT<GRFLabel>(1); label->label = grf_load_byte(&buf); label->nfo_line = _nfo_line; label->pos = FioGetPos(); label->next = NULL; /* Set up a linked list of goto targets which we will search in an Action 0x7/0x9 */ if (_cur_grffile->label == NULL) { _cur_grffile->label = label; } else { /* Attach the label to the end of the list */ GRFLabel *l; for (l = _cur_grffile->label; l->next != NULL; l = l->next) {} l->next = label; } grfmsg(2, "DefineGotoLabel: GOTO target with label 0x%02X", label->label); } /* Action 0x11 */ static void GRFSound(byte *buf, size_t len) { /* <11> <num> * * W num Number of sound files that follow */ if (!check_length(len, 1, "GRFSound")) return; buf++; uint16 num = grf_load_word(&buf); _grf_data_blocks = num; _grf_data_type = GDT_SOUND; if (_cur_grffile->sound_offset == 0) _cur_grffile->sound_offset = GetNumSounds(); } /* Action 0x11 (SKIP) */ static void SkipAct11(byte *buf, size_t len) { /* <11> <num> * * W num Number of sound files that follow */ if (!check_length(len, 1, "SkipAct11")) return; buf++; _skip_sprites = grf_load_word(&buf); grfmsg(3, "SkipAct11: Skipping %d sprites", _skip_sprites); } static void ImportGRFSound(byte *buf, int len) { const GRFFile *file; FileEntry *se = AllocateFileEntry(); uint32 grfid = grf_load_dword(&buf); uint16 sound = grf_load_word(&buf); file = GetFileByGRFID(grfid); if (file == NULL || file->sound_offset == 0) { grfmsg(1, "ImportGRFSound: Source file not available"); return; } if (file->sound_offset + sound >= GetNumSounds()) { grfmsg(1, "ImportGRFSound: Sound effect %d is invalid", sound); return; } grfmsg(2, "ImportGRFSound: Copying sound %d (%d) from file %X", sound, file->sound_offset + sound, grfid); *se = *GetSound(file->sound_offset + sound); /* Reset volume and priority, which TTDPatch doesn't copy */ se->volume = 128; se->priority = 0; } /* 'Action 0xFE' */ static void GRFImportBlock(byte *buf, int len) { if (_grf_data_blocks == 0) { grfmsg(2, "GRFImportBlock: Unexpected import block, skipping"); return; } buf++; _grf_data_blocks--; /* XXX 'Action 0xFE' isn't really specified. It is only mentioned for * importing sounds, so this is probably all wrong... */ if (grf_load_byte(&buf) != _grf_data_type) { grfmsg(1, "GRFImportBlock: Import type mismatch"); } switch (_grf_data_type) { case GDT_SOUND: ImportGRFSound(buf, len - 1); break; default: NOT_REACHED(); break; } } static void LoadGRFSound(byte *buf, int len) { byte *buf_start = buf; /* Allocate a sound entry. This is done even if the data is not loaded * so that the indices used elsewhere are still correct. */ FileEntry *se = AllocateFileEntry(); if (grf_load_dword(&buf) != BSWAP32('RIFF')) { grfmsg(1, "LoadGRFSound: Missing RIFF header"); return; } /* Size of file -- we ignore this */ grf_load_dword(&buf); if (grf_load_dword(&buf) != BSWAP32('WAVE')) { grfmsg(1, "LoadGRFSound: Invalid RIFF type"); return; } for (;;) { uint32 tag = grf_load_dword(&buf); uint32 size = grf_load_dword(&buf); switch (tag) { case ' tmf': // 'fmt ' /* Audio format, must be 1 (PCM) */ if (grf_load_word(&buf) != 1) { grfmsg(1, "LoadGRFSound: Invalid audio format"); return; } se->channels = grf_load_word(&buf); se->rate = grf_load_dword(&buf); grf_load_dword(&buf); grf_load_word(&buf); se->bits_per_sample = grf_load_word(&buf); /* Consume any extra bytes */ for (; size > 16; size--) grf_load_byte(&buf); break; case 'atad': // 'data' se->file_size = size; se->file_offset = FioGetPos() - (len - (buf - buf_start)) + 1; se->file_slot = _file_index; /* Set default volume and priority */ se->volume = 0x80; se->priority = 0; grfmsg(2, "LoadGRFSound: channels %u, sample rate %u, bits per sample %u, length %u", se->channels, se->rate, se->bits_per_sample, size); return; default: se->file_size = 0; return; } } } /* Action 0x12 */ static void LoadFontGlyph(byte *buf, size_t len) { /* <12> <num_def> <font_size> <num_char> <base_char> * * B num_def Number of definitions * B font_size Size of font (0 = normal, 1 = small, 2 = large) * B num_char Number of consecutive glyphs * W base_char First character index */ buf++; len--; if (!check_length(len, 1, "LoadFontGlyph")) return; uint8 num_def = grf_load_byte(&buf); if (!check_length(len, 1 + num_def * 4, "LoadFontGlyph")) return; for (uint i = 0; i < num_def; i++) { FontSize size = (FontSize)grf_load_byte(&buf); uint8 num_char = grf_load_byte(&buf); uint16 base_char = grf_load_word(&buf); grfmsg(7, "LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size); for (uint c = 0; c < num_char; c++) { SetUnicodeGlyph(size, base_char + c, _cur_spriteid); _nfo_line++; LoadNextSprite(_cur_spriteid++, _file_index, _nfo_line); } } } /* Action 0x12 (SKIP) */ static void SkipAct12(byte *buf, size_t len) { /* <12> <num_def> <font_size> <num_char> <base_char> * * B num_def Number of definitions * B font_size Size of font (0 = normal, 1 = small, 2 = large) * B num_char Number of consecutive glyphs * W base_char First character index */ buf++; len--; if (!check_length(len, 1, "SkipAct12")) return; uint8 num_def = grf_load_byte(&buf); if (!check_length(len, 1 + num_def * 4, "SkipAct12")) return; for (uint i = 0; i < num_def; i++) { /* Ignore 'size' byte */ grf_load_byte(&buf); /* Sum up number of characters */ _skip_sprites += grf_load_byte(&buf); /* Ignore 'base_char' word */ grf_load_word(&buf); } grfmsg(3, "SkipAct12: Skipping %d sprites", _skip_sprites); } /* Action 0x13 */ static void TranslateGRFStrings(byte *buf, size_t len) { /* <13> <grfid> <num-ent> <offset> <text...> * * 4*B grfid The GRFID of the file whose texts are to be translated * B num-ent Number of strings * W offset First text ID * S text... Zero-terminated strings */ buf++; len--; if (!check_length(len, 7, "TranslateGRFString")) return; uint32 grfid = grf_load_dword(&buf); const GRFConfig *c = GetGRFConfig(grfid); if (c == NULL || (c->status != GCS_INITIALISED && c->status != GCS_ACTIVATED)) { grfmsg(7, "TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13", BSWAP32(grfid)); return; } if (c->status == GCS_INITIALISED) { /* If the file is not active but will be activated later, give an error * and disable this file. */ GRFError *error = CallocT<GRFError>(1); char tmp[256]; GetString(tmp, STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE, lastof(tmp)); error->data = strdup(tmp); error->message = STR_NEWGRF_ERROR_LOAD_AFTER; error->severity = STR_NEWGRF_ERROR_MSG_FATAL; if (_cur_grfconfig->error != NULL) free(_cur_grfconfig->error); _cur_grfconfig->error = error; _cur_grfconfig->status = GCS_DISABLED; ClearTemporaryNewGRFData(_cur_grffile); _skip_sprites = -1; return; } byte num_strings = grf_load_byte(&buf); uint16 first_id = grf_load_word(&buf); if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD3FF) || (first_id >= 0xDC00 && first_id + num_strings <= 0xDCFF))) { grfmsg(7, "TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings); return; } len -= 7; for (uint i = 0; i < num_strings && len > 0; i++) { const char *string = grf_load_string(&buf, len); size_t string_length = strlen(string) + 1; len -= (int)string_length; if (string_length == 1) { grfmsg(7, "TranslateGRFString: Ignoring empty string."); continue; } /* Since no language id is supplied this string has to be added as a * generic string, thus the language id of 0x7F. For this to work * new_scheme has to be true as well. A language id of 0x7F will be * overridden by a non-generic id, so this will not change anything if * a string has been provided specifically for this language. */ AddGRFString(grfid, first_id + i, 0x7F, true, string, STR_UNDEFINED); } } /* 'Action 0xFF' */ static void GRFDataBlock(byte *buf, int len) { if (_grf_data_blocks == 0) { grfmsg(2, "GRFDataBlock: unexpected data block, skipping"); return; } buf++; uint8 name_len = grf_load_byte(&buf); const char *name = (const char *)buf; buf += name_len + 1; grfmsg(2, "GRFDataBlock: block name '%s'...", name); _grf_data_blocks--; switch (_grf_data_type) { case GDT_SOUND: LoadGRFSound(buf, len - name_len - 2); break; default: NOT_REACHED(); break; } } /* Used during safety scan on unsafe actions */ static void GRFUnsafe(byte *buf, size_t len) { SetBit(_cur_grfconfig->flags, GCF_UNSAFE); /* Skip remainder of GRF */ _skip_sprites = -1; } static void InitializeGRFSpecial() { _ttdpatch_flags[0] = ((_settings_game.station.always_small_airport ? 1 : 0) << 0x0C) // keepsmallairport | (1 << 0x0D) // newairports | (1 << 0x0E) // largestations | ((_settings_game.construction.longbridges ? 1 : 0) << 0x0F) // longbridges | (0 << 0x10) // loadtime | (1 << 0x12) // presignals | (1 << 0x13) // extpresignals | ((_settings_game.vehicle.never_expire_vehicles ? 1 : 0) << 0x16) // enginespersist | (1 << 0x1B) // multihead | (1 << 0x1D) // lowmemory | (1 << 0x1E); // generalfixes _ttdpatch_flags[1] = ((_settings_game.economy.station_noise_level ? 1 : 0) << 0x07) // moreairports - based on units of noise | ((_settings_game.vehicle.mammoth_trains ? 1 : 0) << 0x08) // mammothtrains | (1 << 0x09) // trainrefit | (0 << 0x0B) // subsidiaries | ((_settings_game.order.gradual_loading ? 1 : 0) << 0x0C) // gradualloading | (1 << 0x12) // unifiedmaglevmode - set bit 0 mode. Not revelant to OTTD | (1 << 0x13) // unifiedmaglevmode - set bit 1 mode | (1 << 0x14) // bridgespeedlimits | (1 << 0x16) // eternalgame | (1 << 0x17) // newtrains | (1 << 0x18) // newrvs | (1 << 0x19) // newships | (1 << 0x1A) // newplanes | ((_settings_game.construction.signal_side ? 1 : 0) << 0x1B) // signalsontrafficside | ((_settings_game.vehicle.disable_elrails ? 0 : 1) << 0x1C); // electrifiedrailway _ttdpatch_flags[2] = (1 << 0x01) // loadallgraphics - obsolote | (1 << 0x03) // semaphores | (0 << 0x0B) // enhancedgui | (0 << 0x0C) // newagerating | ((_settings_game.construction.build_on_slopes ? 1 : 0) << 0x0D) // buildonslopes | (1 << 0x0E) // fullloadany | (1 << 0x0F) // planespeed | (0 << 0x10) // moreindustriesperclimate - obsolete | (0 << 0x11) // moretoylandfeatures | (1 << 0x12) // newstations | (1 << 0x13) // tracktypecostdiff | (1 << 0x14) // manualconvert | ((_settings_game.construction.build_on_slopes ? 1 : 0) << 0x15) // buildoncoasts | (1 << 0x16) // canals | (1 << 0x17) // newstartyear | ((_settings_game.vehicle.freight_trains > 1 ? 1 : 0) << 0x18) // freighttrains | (1 << 0x19) // newhouses | (1 << 0x1A) // newbridges | (1 << 0x1B) // newtownnames | (1 << 0x1C) // moreanimation | ((_settings_game.vehicle.wagon_speed_limits ? 1 : 0) << 0x1D) // wagonspeedlimits | (1 << 0x1E) // newshistory | (0 << 0x1F); // custombridgeheads _ttdpatch_flags[3] = (0 << 0x00) // newcargodistribution | (1 << 0x01) // windowsnap | ((_settings_game.economy.allow_town_roads || _generating_world ? 0 : 1) << 0x02) // townbuildnoroad | (1 << 0x03) // pathbasedsignalling | (0 << 0x04) // aichoosechance | (1 << 0x05) // resolutionwidth | (1 << 0x06) // resolutionheight | (1 << 0x07) // newindustries | ((_settings_game.order.improved_load ? 1 : 0) << 0x08) // fifoloading | (0 << 0x09) // townroadbranchprob | (0 << 0x0A) // tempsnowline | (1 << 0x0B) // newcargo | (1 << 0x0C) // enhancemultiplayer | (1 << 0x0D) // onewayroads | ((_settings_game.station.nonuniform_stations ? 1 : 0) << 0x0E) // irregularstations | (1 << 0x0F) // statistics | (1 << 0x10) // newsounds | (1 << 0x11) // autoreplace | (1 << 0x12) // autoslope | (0 << 0x13) // followvehicle | (1 << 0x14) // trams | (0 << 0x15) // enhancetunnels | (1 << 0x16) // shortrvs | (1 << 0x17) // articulatedrvs | ((_settings_game.vehicle.dynamic_engines ? 1 : 0) << 0x18) // dynamic engines | (1 << 0x1E) // variablerunningcosts | (1 << 0x1F); // any switch is on } static void ResetCustomStations() { for (GRFFile *file = _first_grffile; file != NULL; file = file->next) { if (file->stations == NULL) continue; for (uint i = 0; i < MAX_STATIONS; i++) { if (file->stations[i] == NULL) continue; StationSpec *statspec = file->stations[i]; /* Release renderdata, if it wasn't copied from another custom station spec */ if (!statspec->copied_renderdata) { for (uint t = 0; t < statspec->tiles; t++) { free((void*)statspec->renderdata[t].seq); } free(statspec->renderdata); } /* Release platforms and layouts */ if (!statspec->copied_layouts) { for (uint l = 0; l < statspec->lengths; l++) { for (uint p = 0; p < statspec->platforms[l]; p++) { free(statspec->layouts[l][p]); } free(statspec->layouts[l]); } free(statspec->layouts); free(statspec->platforms); } /* Release this station */ free(statspec); } /* Free and reset the station data */ free(file->stations); file->stations = NULL; } } static void ResetCustomHouses() { GRFFile *file; uint i; for (file = _first_grffile; file != NULL; file = file->next) { if (file->housespec == NULL) continue; for (i = 0; i < HOUSE_MAX; i++) { free(file->housespec[i]); } free(file->housespec); file->housespec = NULL; } } static void ResetCustomIndustries() { GRFFile *file; for (file = _first_grffile; file != NULL; file = file->next) { uint i; /* We are verifiying both tiles and industries specs loaded from the grf file * First, let's deal with industryspec */ if (file->industryspec != NULL) { for (i = 0; i < NUM_INDUSTRYTYPES; i++) { IndustrySpec *ind = file->industryspec[i]; if (ind != NULL) { /* We need to remove the sounds array */ if (HasBit(ind->cleanup_flag, CLEAN_RANDOMSOUNDS)) { free((void*)ind->random_sounds); } /* We need to remove the tiles layouts */ if (HasBit(ind->cleanup_flag, CLEAN_TILELSAYOUT) && ind->table != NULL) { for (int j = 0; j < ind->num_table; j++) { /* remove the individual layouts */ if (ind->table[j] != NULL) { free((IndustryTileTable*)ind->table[j]); } } /* remove the layouts pointers */ free((IndustryTileTable**)ind->table); ind->table = NULL; } free(ind); ind = NULL; } } free(file->industryspec); file->industryspec = NULL; } if (file->indtspec != NULL) { for (i = 0; i < NUM_INDUSTRYTILES; i++) { if (file->indtspec[i] != NULL) { free(file->indtspec[i]); file->indtspec[i] = NULL; } } free(file->indtspec); file->indtspec = NULL; } } } static void ResetNewGRF() { GRFFile *next; for (GRFFile *f = _first_grffile; f != NULL; f = next) { next = f->next; free(f->filename); free(f->cargo_list); free(f->railtype_list); free(f); } _first_grffile = NULL; _cur_grffile = NULL; } static void ResetNewGRFErrors() { for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) { if (!HasBit(c->flags, GCF_COPY) && c->error != NULL) { free(c->error->custom_message); free(c->error->data); free(c->error); c->error = NULL; } } } /** * Reset all NewGRF loaded data * TODO */ static void ResetNewGRFData() { CleanUpStrings(); CleanUpGRFTownNames(); /* Copy/reset original engine info data */ SetupEngines(); /* Copy/reset original bridge info data */ ResetBridges(); /* Reset rail type information */ ResetRailTypes(); /* Allocate temporary refit/cargo class data */ _gted = CallocT<GRFTempEngineData>(GetEnginePoolSize()); /* Reset GRM reservations */ memset(&_grm_engines, 0, sizeof(_grm_engines)); memset(&_grm_cargos, 0, sizeof(_grm_cargos)); /* Reset generic feature callback lists */ ResetGenericCallbacks(); /* Reset price base data */ ResetPriceBaseMultipliers(); /* Reset the curencies array */ ResetCurrencies(); /* Reset the house array */ ResetCustomHouses(); ResetHouses(); /* Reset the industries structures*/ ResetCustomIndustries(); ResetIndustries(); /* Reset station classes */ ResetStationClasses(); ResetCustomStations(); /* Reset canal sprite groups and flags */ memset(_water_feature, 0, sizeof(_water_feature)); /* Reset the snowline table. */ ClearSnowLine(); /* Reset NewGRF files */ ResetNewGRF(); /* Reset NewGRF errors. */ ResetNewGRFErrors(); /* Set up the default cargo types */ SetupCargoForClimate(_settings_game.game_creation.landscape); /* Reset misc GRF features and train list display variables */ _misc_grf_features = 0; _traininfo_vehicle_pitch = 0; _traininfo_vehicle_width = 29; _loaded_newgrf_features.has_2CC = false; _loaded_newgrf_features.has_newhouses = false; _loaded_newgrf_features.has_newindustries = false; _loaded_newgrf_features.shore = SHORE_REPLACE_NONE; /* Clear all GRF overrides */ _grf_id_overrides.clear(); InitializeSoundPool(); InitializeSpriteGroupPool(); } static void BuildCargoTranslationMap() { memset(_cur_grffile->cargo_map, 0xFF, sizeof(_cur_grffile->cargo_map)); for (CargoID c = 0; c < NUM_CARGO; c++) { const CargoSpec *cs = GetCargo(c); if (!cs->IsValid()) continue; if (_cur_grffile->cargo_max == 0) { /* Default translation table, so just a straight mapping to bitnum */ _cur_grffile->cargo_map[c] = cs->bitnum; } else { /* Check the translation table for this cargo's label */ for (uint i = 0; i < _cur_grffile->cargo_max; i++) { if (cs->label == _cur_grffile->cargo_list[i]) { _cur_grffile->cargo_map[c] = i; break; } } } } } static void InitNewGRFFile(const GRFConfig *config, int sprite_offset) { GRFFile *newfile = GetFileByFilename(config->filename); if (newfile != NULL) { /* We already loaded it once. */ newfile->sprite_offset = sprite_offset; _cur_grffile = newfile; return; } newfile = CallocT<GRFFile>(1); if (newfile == NULL) error ("Out of memory"); newfile->filename = strdup(config->filename); newfile->sprite_offset = sprite_offset; /* Copy the initial parameter list */ assert(lengthof(newfile->param) == lengthof(config->param) && lengthof(config->param) == 0x80); newfile->param_end = config->num_params; memcpy(newfile->param, config->param, sizeof(newfile->param)); if (_first_grffile == NULL) { _cur_grffile = newfile; _first_grffile = newfile; } else { _cur_grffile->next = newfile; _cur_grffile = newfile; } } /** List of what cargo labels are refittable for the given the vehicle-type. * Only currently active labels are applied. */ static const CargoLabel _default_refitmasks_rail[] = { 'PASS', 'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD', 'IORE', 'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE', 'WATR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL', 'PLST', 'FZDR', 0 }; static const CargoLabel _default_refitmasks_road[] = { 0 }; static const CargoLabel _default_refitmasks_ships[] = { 'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD', 'IORE', 'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE', 'WATR', 'RUBR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL', 'PLST', 'FZDR', 0 }; static const CargoLabel _default_refitmasks_aircraft[] = { 'PASS', 'MAIL', 'GOOD', 'VALU', 'GOLD', 'DIAM', 'FOOD', 'FRUT', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL', 'PLST', 'FZDR', 0 }; static const CargoLabel *_default_refitmasks[] = { _default_refitmasks_rail, _default_refitmasks_road, _default_refitmasks_ships, _default_refitmasks_aircraft, }; /** * Precalculate refit masks from cargo classes for all vehicles. */ static void CalculateRefitMasks() { Engine *e; FOR_ALL_ENGINES(e) { EngineID engine = e->index; EngineInfo *ei = &e->info; uint32 mask = 0; uint32 not_mask = 0; uint32 xor_mask = 0; if (ei->refit_mask != 0) { const GRFFile *file = e->grffile; if (file != NULL && file->cargo_max != 0) { /* Apply cargo translation table to the refit mask */ uint num_cargo = min(32, file->cargo_max); for (uint i = 0; i < num_cargo; i++) { if (!HasBit(ei->refit_mask, i)) continue; CargoID c = GetCargoIDByLabel(file->cargo_list[i]); if (c == CT_INVALID) continue; SetBit(xor_mask, c); } } else { /* No cargo table, so use the cargo bitnum values */ for (CargoID c = 0; c < NUM_CARGO; c++) { const CargoSpec *cs = GetCargo(c); if (!cs->IsValid()) continue; if (HasBit(ei->refit_mask, cs->bitnum)) SetBit(xor_mask, c); } } } if (_gted[engine].cargo_allowed != 0) { /* Build up the list of cargo types from the set cargo classes. */ for (CargoID i = 0; i < NUM_CARGO; i++) { const CargoSpec *cs = GetCargo(i); if (_gted[engine].cargo_allowed & cs->classes) SetBit(mask, i); if (_gted[engine].cargo_disallowed & cs->classes) SetBit(not_mask, i); } } else if (xor_mask == 0) { /* Don't apply default refit mask to wagons or engines with no capacity */ if (e->type != VEH_TRAIN || (e->u.rail.capacity != 0 && e->u.rail.railveh_type != RAILVEH_WAGON)) { const CargoLabel *cl = _default_refitmasks[e->type]; for (uint i = 0;; i++) { if (cl[i] == 0) break; CargoID cargo = GetCargoIDByLabel(cl[i]); if (cargo == CT_INVALID) continue; SetBit(xor_mask, cargo); } } } ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) & _cargo_mask; /* Check if this engine's cargo type is valid. If not, set to the first refittable * cargo type. Apparently cargo_type isn't a common property... */ switch (e->type) { default: NOT_REACHED(); case VEH_AIRCRAFT: if (FindFirstRefittableCargo(engine) == CT_INVALID) ei->climates = 0x80; break; case VEH_TRAIN: { RailVehicleInfo *rvi = &e->u.rail; if (rvi->cargo_type == CT_INVALID) rvi->cargo_type = FindFirstRefittableCargo(engine); if (rvi->cargo_type == CT_INVALID) ei->climates = 0x80; break; } case VEH_ROAD: { RoadVehicleInfo *rvi = &e->u.road; if (rvi->cargo_type == CT_INVALID) rvi->cargo_type = FindFirstRefittableCargo(engine); if (rvi->cargo_type == CT_INVALID) ei->climates = 0x80; break; } case VEH_SHIP: { ShipVehicleInfo *svi = &e->u.ship; if (svi->cargo_type == CT_INVALID) svi->cargo_type = FindFirstRefittableCargo(engine); if (svi->cargo_type == CT_INVALID) ei->climates = 0x80; break; } } } } /** Add all new houses to the house array. House properties can be set at any * time in the GRF file, so we can only add a house spec to the house array * after the file has finished loading. We also need to check the dates, due to * the TTDPatch behaviour described below that we need to emulate. */ static void FinaliseHouseArray() { /* If there are no houses with start dates before 1930, then all houses * with start dates of 1930 have them reset to 0. This is in order to be * compatible with TTDPatch, where if no houses have start dates before * 1930 and the date is before 1930, the game pretends that this is 1930. * If there have been any houses defined with start dates before 1930 then * the dates are left alone. * On the other hand, why 1930? Just 'fix' the houses with the lowest * minimum introduction date to 0. */ Year min_year = MAX_YEAR; for (GRFFile *file = _first_grffile; file != NULL; file = file->next) { if (file->housespec == NULL) continue; for (int i = 0; i < HOUSE_MAX; i++) { HouseSpec *hs = file->housespec[i]; if (hs != NULL) { _house_mngr.SetEntitySpec(hs); if (hs->min_year < min_year) min_year = hs->min_year; } } } if (min_year != 0) { for (int i = 0; i < HOUSE_MAX; i++) { HouseSpec *hs = GetHouseSpecs(i); if (hs->enabled && hs->min_year == min_year) hs->min_year = 0; } } } /** Add all new industries to the industry array. Industry properties can be set at any * time in the GRF file, so we can only add a industry spec to the industry array * after the file has finished loading. */ static void FinaliseIndustriesArray() { for (GRFFile *file = _first_grffile; file != NULL; file = file->next) { if (file->industryspec != NULL) { for (int i = 0; i < NUM_INDUSTRYTYPES; i++) { IndustrySpec *indsp = file->industryspec[i]; if (indsp != NULL && indsp->enabled) { StringID strid; /* process the conversion of text at the end, so to be sure everything will be fine * and available. Check if it does not return undefind marker, which is a very good sign of a * substitute industry who has not changed the string been examined, thus using it as such */ strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->name); if (strid != STR_UNDEFINED) indsp->name = strid; strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->closure_text); if (strid != STR_UNDEFINED) indsp->closure_text = strid; strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_up_text); if (strid != STR_UNDEFINED) indsp->production_up_text = strid; strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_down_text); if (strid != STR_UNDEFINED) indsp->production_down_text = strid; strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->new_industry_text); if (strid != STR_UNDEFINED) indsp->new_industry_text = strid; if (indsp->station_name != STR_NULL) { /* STR_NULL (0) can be set by grf. It has a meaning regarding assignation of the * station's name. Don't want to lose the value, therefore, do not process. */ strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->station_name); if (strid != STR_UNDEFINED) indsp->station_name = strid; } _industry_mngr.SetEntitySpec(indsp); _loaded_newgrf_features.has_newindustries = true; } } } if (file->indtspec != NULL) { for (int i = 0; i < NUM_INDUSTRYTILES; i++) { IndustryTileSpec *indtsp = file->indtspec[i]; if (indtsp != NULL) { _industile_mngr.SetEntitySpec(indtsp); } } } } for (uint j = 0; j < NUM_INDUSTRYTYPES; j++) { IndustrySpec *indsp = &_industry_specs[j]; if (indsp->enabled && indsp->grf_prop.grffile != NULL) { for (uint i = 0; i < 3; i++) { indsp->conflicting[i] = MapNewGRFIndustryType(indsp->conflicting[i], indsp->grf_prop.grffile->grfid); } } } } /* Here we perform initial decoding of some special sprites (as are they * described at http://www.ttdpatch.net/src/newgrf.txt, but this is only a very * partial implementation yet). * XXX: We consider GRF files trusted. It would be trivial to exploit OTTD by * a crafted invalid GRF file. We should tell that to the user somehow, or * better make this more robust in the future. */ static void DecodeSpecialSprite(byte *buf, uint num, GrfLoadingStage stage) { /* XXX: There is a difference between staged loading in TTDPatch and * here. In TTDPatch, for some reason actions 1 and 2 are carried out * during stage 1, whilst action 3 is carried out during stage 2 (to * "resolve" cargo IDs... wtf). This is a little problem, because cargo * IDs are valid only within a given set (action 1) block, and may be * overwritten after action 3 associates them. But overwriting happens * in an earlier stage than associating, so... We just process actions * 1 and 2 in stage 2 now, let's hope that won't get us into problems. * --pasky * We need a pre-stage to set up GOTO labels of Action 0x10 because the grf * is not in memory and scanning the file every time would be too expensive. * In other stages we skip action 0x10 since it's already dealt with. */ static const SpecialSpriteHandler handlers[][GLS_END] = { /* 0x00 */ { NULL, SafeChangeInfo, NULL, NULL, ReserveChangeInfo, FeatureChangeInfo, }, /* 0x01 */ { SkipAct1, SkipAct1, SkipAct1, SkipAct1, SkipAct1, NewSpriteSet, }, /* 0x02 */ { NULL, NULL, NULL, NULL, NULL, NewSpriteGroup, }, /* 0x03 */ { NULL, GRFUnsafe, NULL, NULL, NULL, FeatureMapSpriteGroup, }, /* 0x04 */ { NULL, NULL, NULL, NULL, NULL, FeatureNewName, }, /* 0x05 */ { SkipAct5, SkipAct5, SkipAct5, SkipAct5, SkipAct5, GraphicsNew, }, /* 0x06 */ { NULL, NULL, NULL, CfgApply, CfgApply, CfgApply, }, /* 0x07 */ { NULL, NULL, NULL, NULL, SkipIf, SkipIf, }, /* 0x08 */ { ScanInfo, NULL, NULL, GRFInfo, GRFInfo, GRFInfo, }, /* 0x09 */ { NULL, NULL, NULL, SkipIf, SkipIf, SkipIf, }, /* 0x0A */ { SkipActA, SkipActA, SkipActA, SkipActA, SkipActA, SpriteReplace, }, /* 0x0B */ { NULL, NULL, NULL, GRFLoadError, GRFLoadError, GRFLoadError, }, /* 0x0C */ { NULL, NULL, NULL, GRFComment, NULL, GRFComment, }, /* 0x0D */ { NULL, SafeParamSet, NULL, ParamSet, ParamSet, ParamSet, }, /* 0x0E */ { NULL, SafeGRFInhibit, NULL, GRFInhibit, GRFInhibit, GRFInhibit, }, /* 0x0F */ { NULL, GRFUnsafe, NULL, FeatureTownName, NULL, NULL, }, /* 0x10 */ { NULL, NULL, DefineGotoLabel, NULL, NULL, NULL, }, /* 0x11 */ { SkipAct11,GRFUnsafe, SkipAct11, SkipAct11, SkipAct11, GRFSound, }, /* 0x12 */ { SkipAct12, SkipAct12, SkipAct12, SkipAct12, SkipAct12, LoadFontGlyph, }, /* 0x13 */ { NULL, NULL, NULL, NULL, NULL, TranslateGRFStrings, }, }; GRFLocation location(_cur_grfconfig->grfid, _nfo_line); GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location); if (it == _grf_line_to_action6_sprite_override.end()) { /* No preloaded sprite to work with; read the * pseudo sprite content. */ FioReadBlock(buf, num); } else { /* Use the preloaded sprite data. */ buf = _grf_line_to_action6_sprite_override[location]; grfmsg(7, "DecodeSpecialSprite: Using preloaded pseudo sprite data"); /* Skip the real (original) content of this action. */ FioSeekTo(num, SEEK_CUR); } byte action = buf[0]; if (action == 0xFF) { grfmsg(7, "DecodeSpecialSprite: Handling data block in stage %d", stage); GRFDataBlock(buf, num); } else if (action == 0xFE) { grfmsg(7, "DecodeSpecialSprite: Handling import block in stage %d", stage); GRFImportBlock(buf, num); } else if (action >= lengthof(handlers)) { grfmsg(7, "DecodeSpecialSprite: Skipping unknown action 0x%02X", action); } else if (handlers[action][stage] == NULL) { grfmsg(7, "DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage); } else { grfmsg(7, "DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage); handlers[action][stage](buf, num); } } void LoadNewGRFFile(GRFConfig *config, uint file_index, GrfLoadingStage stage) { const char *filename = config->filename; uint16 num; /* A .grf file is activated only if it was active when the game was * started. If a game is loaded, only its active .grfs will be * reactivated, unless "loadallgraphics on" is used. A .grf file is * considered active if its action 8 has been processed, i.e. its * action 8 hasn't been skipped using an action 7. * * During activation, only actions 0, 1, 2, 3, 4, 5, 7, 8, 9, 0A and 0B are * carried out. All others are ignored, because they only need to be * processed once at initialization. */ if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) { _cur_grffile = GetFileByFilename(filename); if (_cur_grffile == NULL) usererror("File '%s' lost in cache.\n", filename); if (stage == GLS_RESERVE && config->status != GCS_INITIALISED) return; if (stage == GLS_ACTIVATION && !HasBit(config->flags, GCF_RESERVED)) return; _cur_grffile->is_ottdfile = config->IsOpenTTDBaseGRF(); } if (file_index > LAST_GRF_SLOT) { DEBUG(grf, 0, "'%s' is not loaded as the maximum number of GRFs has been reached", filename); config->status = GCS_DISABLED; config->error = CallocT<GRFError>(1); config->error->severity = STR_NEWGRF_ERROR_MSG_FATAL; config->error->message = STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED; return; } FioOpenFile(file_index, filename); _file_index = file_index; // XXX _palette_remap_grf[_file_index] = (config->windows_paletted != (_use_palette == PAL_WINDOWS)); _cur_grfconfig = config; DEBUG(grf, 2, "LoadNewGRFFile: Reading NewGRF-file '%s'", filename); /* Skip the first sprite; we don't care about how many sprites this * does contain; newest TTDPatches and George's longvehicles don't * neither, apparently. */ if (FioReadWord() == 4 && FioReadByte() == 0xFF) { FioReadDword(); } else { DEBUG(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format"); return; } _skip_sprites = 0; // XXX _nfo_line = 0; ReusableBuffer<byte> buf; while ((num = FioReadWord()) != 0) { byte type = FioReadByte(); _nfo_line++; if (type == 0xFF) { if (_skip_sprites == 0) { DecodeSpecialSprite(buf.Allocate(num), num, stage); /* Stop all processing if we are to skip the remaining sprites */ if (_skip_sprites == -1) break; continue; } else { FioSkipBytes(num); } } else { if (_skip_sprites == 0) { grfmsg(0, "LoadNewGRFFile: Unexpected sprite, disabling"); config->status = GCS_DISABLED; config->error = CallocT<GRFError>(1); config->error->severity = STR_NEWGRF_ERROR_MSG_FATAL; config->error->message = STR_NEWGRF_ERROR_UNEXPECTED_SPRITE; break; } FioSkipBytes(7); SkipSpriteData(type, num - 8); } if (_skip_sprites > 0) _skip_sprites--; } } /** * Relocates the old shore sprites at new positions. * * 1. If shore sprites are neither loaded by Action5 nor ActionA, the extra sprites from openttd(w/d).grf are used. (SHORE_REPLACE_ONLY_NEW) * 2. If a newgrf replaces some shore sprites by ActionA. The (maybe also replaced) grass tiles are used for corner shores. (SHORE_REPLACE_ACTION_A) * 3. If a newgrf replaces shore sprites by Action5 any shore replacement by ActionA has no effect. (SHORE_REPLACE_ACTION_5) */ static void ActivateOldShore() { /* Use default graphics, if no shore sprites were loaded. * Should not happen, as openttd(w/d).grf includes some. */ if (_loaded_newgrf_features.shore == SHORE_REPLACE_NONE) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_A; if (_loaded_newgrf_features.shore != SHORE_REPLACE_ACTION_5) { DupSprite(SPR_ORIGINALSHORE_START + 1, SPR_SHORE_BASE + 1); // SLOPE_W DupSprite(SPR_ORIGINALSHORE_START + 2, SPR_SHORE_BASE + 2); // SLOPE_S DupSprite(SPR_ORIGINALSHORE_START + 6, SPR_SHORE_BASE + 3); // SLOPE_SW DupSprite(SPR_ORIGINALSHORE_START , SPR_SHORE_BASE + 4); // SLOPE_E DupSprite(SPR_ORIGINALSHORE_START + 4, SPR_SHORE_BASE + 6); // SLOPE_SE DupSprite(SPR_ORIGINALSHORE_START + 3, SPR_SHORE_BASE + 8); // SLOPE_N DupSprite(SPR_ORIGINALSHORE_START + 7, SPR_SHORE_BASE + 9); // SLOPE_NW DupSprite(SPR_ORIGINALSHORE_START + 5, SPR_SHORE_BASE + 12); // SLOPE_NE } if (_loaded_newgrf_features.shore == SHORE_REPLACE_ACTION_A) { DupSprite(SPR_FLAT_GRASS_TILE + 16, SPR_SHORE_BASE + 0); // SLOPE_STEEP_S DupSprite(SPR_FLAT_GRASS_TILE + 17, SPR_SHORE_BASE + 5); // SLOPE_STEEP_W DupSprite(SPR_FLAT_GRASS_TILE + 7, SPR_SHORE_BASE + 7); // SLOPE_WSE DupSprite(SPR_FLAT_GRASS_TILE + 15, SPR_SHORE_BASE + 10); // SLOPE_STEEP_N DupSprite(SPR_FLAT_GRASS_TILE + 11, SPR_SHORE_BASE + 11); // SLOPE_NWS DupSprite(SPR_FLAT_GRASS_TILE + 13, SPR_SHORE_BASE + 13); // SLOPE_ENW DupSprite(SPR_FLAT_GRASS_TILE + 14, SPR_SHORE_BASE + 14); // SLOPE_SEN DupSprite(SPR_FLAT_GRASS_TILE + 18, SPR_SHORE_BASE + 15); // SLOPE_STEEP_E /* XXX - SLOPE_EW, SLOPE_NS are currently not used. * If they would be used somewhen, then these grass tiles will most like not look as needed */ DupSprite(SPR_FLAT_GRASS_TILE + 5, SPR_SHORE_BASE + 16); // SLOPE_EW DupSprite(SPR_FLAT_GRASS_TILE + 10, SPR_SHORE_BASE + 17); // SLOPE_NS } } void InitDepotWindowBlockSizes(); extern void InitGRFTownGeneratorNames(); static void AfterLoadGRFs() { for (StringIDToGRFIDMapping::iterator it = _string_to_grf_mapping.begin(); it != _string_to_grf_mapping.end(); it++) { *((*it).first) = MapGRFStringID((*it).second, *((*it).first)); } _string_to_grf_mapping.clear(); /* Free the action 6 override sprites. */ for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) { free((*it).second); } _grf_line_to_action6_sprite_override.clear(); /* Pre-calculate all refit masks after loading GRF files. */ CalculateRefitMasks(); /* Set the block size in the depot windows based on vehicle sprite sizes */ InitDepotWindowBlockSizes(); /* Add all new houses to the house array. */ FinaliseHouseArray(); /* Add all new industries to the industry array. */ FinaliseIndustriesArray(); /* Create dynamic list of industry legends for smallmap_gui.cpp */ BuildIndustriesLegend(); /* Update the townname generators list */ InitGRFTownGeneratorNames(); /* Run all queued vehicle list order changes */ CommitVehicleListOrderChanges(); /* Load old shore sprites in new position, if they were replaced by ActionA */ ActivateOldShore(); Engine *e; FOR_ALL_ENGINES_OF_TYPE(e, VEH_ROAD) { if (_gted[e->index].rv_max_speed != 0) { /* Set RV maximum speed from the mph/0.8 unit value */ e->u.road.max_speed = _gted[e->index].rv_max_speed * 4; } } SetYearEngineAgingStops(); /* Deallocate temporary loading data */ free(_gted); _grm_sprites.clear(); } void LoadNewGRF(uint load_index, uint file_index) { /* In case of networking we need to "sync" the start values * so all NewGRFs are loaded equally. For this we use the * start date of the game and we set the counters, etc. to * 0 so they're the same too. */ Date date = _date; Year year = _cur_year; DateFract date_fract = _date_fract; uint16 tick_counter = _tick_counter; byte display_opt = _display_opt; if (_networking) { _cur_year = _settings_game.game_creation.starting_year; _date = ConvertYMDToDate(_cur_year, 0, 1); _date_fract = 0; _tick_counter = 0; _display_opt = 0; } InitializeGRFSpecial(); ResetNewGRFData(); /* * Reset the status of all files, so we can 'retry' to load them. * This is needed when one for example rearranges the NewGRFs in-game * and a previously disabled NewGRF becomes useable. If it would not * be reset, the NewGRF would remain disabled even though it should * have been enabled. */ for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) { if (c->status != GCS_NOT_FOUND) c->status = GCS_UNKNOWN; } _cur_spriteid = load_index; /* Load newgrf sprites * in each loading stage, (try to) open each file specified in the config * and load information from it. */ for (GrfLoadingStage stage = GLS_LABELSCAN; stage <= GLS_ACTIVATION; stage++) { /* Set activated grfs back to will-be-activated between reservation- and activation-stage. * This ensures that action7/9 conditions 0x06 - 0x0A work correctly. */ for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) { if (c->status == GCS_ACTIVATED) c->status = GCS_INITIALISED; } uint slot = file_index; _cur_stage = stage; for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) { if (c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND) continue; if (stage > GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) continue; /* @todo usererror() */ if (!FioCheckFileExists(c->filename)) usererror("NewGRF file is missing '%s'", c->filename); if (stage == GLS_LABELSCAN) InitNewGRFFile(c, _cur_spriteid); LoadNewGRFFile(c, slot++, stage); if (stage == GLS_RESERVE) { SetBit(c->flags, GCF_RESERVED); } else if (stage == GLS_ACTIVATION) { ClrBit(c->flags, GCF_RESERVED); assert(GetFileByGRFID(c->grfid) == _cur_grffile); ClearTemporaryNewGRFData(_cur_grffile); BuildCargoTranslationMap(); DEBUG(sprite, 2, "LoadNewGRF: Currently %i sprites are loaded", _cur_spriteid); } else if (stage == GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) { /* We're not going to activate this, so free whatever data we allocated */ ClearTemporaryNewGRFData(_cur_grffile); } } } /* Call any functions that should be run after GRFs have been loaded. */ AfterLoadGRFs(); /* Now revert back to the original situation */ _cur_year = year; _date = date; _date_fract = date_fract; _tick_counter = tick_counter; _display_opt = display_opt; } bool HasGrfMiscBit(GrfMiscBit bit) { return HasBit(_misc_grf_features, bit); }