tron@2186: /* $Id$ */
tron@2186: 
rubidium@9111: /** @file newgrf.cpp Base of all NewGRF support. */
belugas@6348: 
dominik@452: #include "stdafx.h"
dominik@452: 
dominik@452: #include <stdarg.h>
dominik@452: 
Darkvater@1891: #include "openttd.h"
tron@1299: #include "debug.h"
rubidium@10039: #include "fileio_func.h"
rubidium@8786: #include "engine_func.h"
peter1138@9070: #include "engine_base.h"
tron@2342: #include "spritecache.h"
dominik@452: #include "sprite.h"
dominik@452: #include "newgrf.h"
tron@2159: #include "variables.h"
peter1138@2478: #include "bridge.h"
maedhros@6332: #include "town.h"
peter1138@2962: #include "newgrf_engine.h"
belugas@3601: #include "newgrf_text.h"
peter1138@5108: #include "fontcache.h"
belugas@4377: #include "currency.h"
maedhros@6343: #include "landscape.h"
peter1138@5228: #include "newgrf_config.h"
maedhros@6332: #include "newgrf_house.h"
peter1138@4656: #include "newgrf_sound.h"
peter1138@3595: #include "newgrf_spritegroup.h"
rubidium@8787: #include "newgrf_station.h"
peter1138@6091: #include "cargotype.h"
belugas@6533: #include "industry.h"
peter1138@6583: #include "newgrf_canal.h"
belugas@6629: #include "newgrf_commons.h"
glx@6956: #include "newgrf_townname.h"
rubidium@7233: #include "newgrf_industries.h"
rubidium@7772: #include "gfxinit.h"
smatz@9085: #include "rev.h"
rubidium@7805: #include "fios.h"
rubidium@8103: #include "rail.h"
rubidium@8114: #include "strings_func.h"
rubidium@8123: #include "gfx_func.h"
rubidium@8140: #include "date_func.h"
rubidium@8144: #include "vehicle_func.h"
rubidium@8157: #include "sound_func.h"
rubidium@8214: #include "string_func.h"
rubidium@8236: #include "road_func.h"
rubidium@10208: #include "company_base.h"
rubidium@8270: #include "settings_type.h"
rubidium@9556: #include "network/network.h"
belugas@8391: #include "map_func.h"
peter1138@9070: #include <map>
peter1138@3595: 
rubidium@8264: #include "table/strings.h"
rubidium@8264: #include "table/sprites.h"
rubidium@8264: #include "table/town_land.h"
rubidium@8264: #include "table/build_industry.h"
rubidium@8264: #include "table/landscape_sprite.h"
rubidium@8264: 
dominik@452: /* TTDPatch extended GRF format codec
dominik@452:  * (c) Petr Baudis 2004 (GPL'd)
dominik@452:  * Changes by Florian octo Forster are (c) by the OpenTTD development team.
dominik@452:  *
dominik@452:  * Contains portions of documentation by TTDPatch team.
dominik@452:  * Thanks especially to Josef Drexler for the documentation as well as a lot
dominik@452:  * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which
dominik@452:  * served as subject to the initial testing of this codec. */
dominik@452: 
dominik@455: 
tron@2342: static int _skip_sprites; // XXX
tron@2342: static uint _file_index; // XXX
dominik@452: 
tron@2340: static GRFFile *_cur_grffile;
tron@1477: GRFFile *_first_grffile;
peter1138@3707: static SpriteID _cur_spriteid;
peter1138@5225: static GrfLoadingStage _cur_stage;
Darkvater@3561: static uint32 _nfo_line;
dominik@452: 
peter1138@5228: static GRFConfig *_cur_grfconfig;
peter1138@5228: 
peter1138@3814: /* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */
peter1138@3814: static byte _misc_grf_features = 0;
peter1138@3814: 
dominik@452: /* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */
dominik@452: static uint32 _ttdpatch_flags[8];
dominik@452: 
belugas@6769: /* Indicates which are the newgrf features currently loaded ingame */
belugas@6914: GRFLoadedFeatures _loaded_newgrf_features;
dominik@452: 
rubidium@6248: enum GrfDataType {
peter1138@4656: 	GDT_SOUND,
rubidium@6248: };
peter1138@4656: 
peter1138@4656: static byte _grf_data_blocks;
peter1138@4656: static GrfDataType _grf_data_type;
peter1138@4656: 
peter1138@4656: 
glx@9146: typedef void (*SpecialSpriteHandler)(byte *buf, size_t len);
dominik@452: 
peter1138@3768: enum {
peter1138@3768: 	MAX_STATIONS = 256,
peter1138@3768: };
peter1138@3768: 
peter1138@9025: /* Temporary data used when loading only */
peter1138@9025: struct GRFTempEngineData {
peter1138@9025: 	uint16 cargo_allowed;
peter1138@9025: 	uint16 cargo_disallowed;
peter1138@9025: };
peter1138@9025: 
peter1138@9025: static GRFTempEngineData *_gted;
dominik@452: 
peter1138@9070: /* Contains the GRF ID of the owner of a vehicle if it has been reserved.
peter1138@9070:  * GRM for vehicles is only used if dynamic engine allocation is disabled,
peter1138@9070:  * so 256 is the number of original engines. */
peter1138@9070: static uint32 _grm_engines[256];
peter1138@4961: 
peter1138@6781: /* Contains the GRF ID of the owner of a cargo if it has been reserved */
peter1138@8675: static uint32 _grm_cargos[NUM_CARGO * 2];
peter1138@6781: 
peter1138@9113: struct GRFLocation {
peter1138@9098: 	uint32 grfid;
peter1138@9098: 	uint32 nfoline;
peter1138@9098: 
peter1138@9113: 	GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { }
peter1138@9113: 
peter1138@9113: 	bool operator<(const GRFLocation &other) const
peter1138@9098: 	{
peter1138@9098: 		return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline);
peter1138@9098: 	}
rubidium@9947: 
rubidium@9947: 	bool operator==(const GRFLocation &other) const
rubidium@9947: 	{
rubidium@9947: 		return this->grfid == other.grfid && this->nfoline == other.nfoline;
rubidium@9947: 	}
peter1138@9098: };
peter1138@9098: 
peter1138@9113: static std::map<GRFLocation, SpriteID> _grm_sprites;
rubidium@9947: typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride;
rubidium@9947: GRFLineToSpriteOverride _grf_line_to_action6_sprite_override;
peter1138@9098: 
Darkvater@5380: /** DEBUG() function dedicated to newGRF debugging messages
Darkvater@5380:  * Function is essentialy the same as DEBUG(grf, severity, ...) with the
Darkvater@5380:  * addition of file:line information when parsing grf files.
Darkvater@5380:  * NOTE: for the above reason(s) grfmsg() should ONLY be used for
Darkvater@5380:  * loading/parsing grf files, not for runtime debug messages as there
Darkvater@5380:  * is no file information available during that time.
Darkvater@5380:  * @param severity debugging severity level, see debug.h
belugas@6481:  * @param str message in printf() format */
Darkvater@5380: void CDECL grfmsg(int severity, const char *str, ...)
dominik@452: {
dominik@452: 	char buf[1024];
dominik@452: 	va_list va;
dominik@452: 
dominik@452: 	va_start(va, str);
tron@1477: 	vsnprintf(buf, sizeof(buf), str, va);
dominik@452: 	va_end(va);
dominik@452: 
Darkvater@5380: 	DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf);
dominik@452: }
dominik@452: 
glx@9146: static inline bool check_length(size_t real, size_t wanted, const char *str)
Darkvater@5379: {
peter1138@5590: 	if (real >= wanted) return true;
Darkvater@5379: 	grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted);
peter1138@5590: 	return false;
Darkvater@5379: }
dominik@452: 
tron@500: static inline byte grf_load_byte(byte **buf)
dominik@452: {
dominik@452: 	return *(*buf)++;
dominik@452: }
dominik@452: 
dominik@452: static uint16 grf_load_word(byte **buf)
dominik@452: {
Darkvater@3711: 	uint16 val = grf_load_byte(buf);
Darkvater@3711: 	return val | (grf_load_byte(buf) << 8);
dominik@452: }
dominik@452: 
tron@2346: static uint16 grf_load_extended(byte** buf)
tron@2346: {
tron@2346: 	uint16 val;
tron@2346: 	val = grf_load_byte(buf);
tron@2346: 	if (val == 0xFF) val = grf_load_word(buf);
tron@2346: 	return val;
tron@2346: }
tron@2346: 
miham@2324: static uint32 grf_load_dword(byte **buf)
dominik@452: {
Darkvater@3711: 	uint32 val = grf_load_word(buf);
Darkvater@3711: 	return val | (grf_load_word(buf) << 16);
dominik@452: }
dominik@452: 
peter1138@3668: static uint32 grf_load_var(byte size, byte **buf)
peter1138@3668: {
peter1138@3668: 	switch (size) {
peter1138@3668: 		case 1: return grf_load_byte(buf);
peter1138@3668: 		case 2: return grf_load_word(buf);
peter1138@3668: 		case 4: return grf_load_dword(buf);
peter1138@3668: 		default:
peter1138@3668: 			NOT_REACHED();
peter1138@3668: 			return 0;
peter1138@3668: 	}
peter1138@3668: }
dominik@452: 
maedhros@6090: static const char *grf_load_string(byte **buf, size_t max_len)
maedhros@6090: {
maedhros@6090: 	const char *string   = *(const char **)buf;
maedhros@6090: 	size_t string_length = ttd_strnlen(string, max_len);
maedhros@6090: 
maedhros@6090: 	if (string_length == max_len) {
maedhros@6090: 		/* String was not NUL terminated, so make sure it is now. */
maedhros@6090: 		(*buf)[string_length - 1] = '\0';
maedhros@6090: 		grfmsg(7, "String was not terminated with a zero byte.");
maedhros@6090: 	} else {
maedhros@6090: 		/* Increase the string length to include the NUL byte. */
maedhros@6090: 		string_length++;
maedhros@6090: 	}
maedhros@6090: 	*buf += string_length;
maedhros@6090: 
maedhros@6090: 	return string;
maedhros@6090: }
maedhros@6090: 
tron@1477: static GRFFile *GetFileByGRFID(uint32 grfid)
dominik@452: {
tron@1477: 	GRFFile *file;
dominik@452: 
tron@1477: 	for (file = _first_grffile; file != NULL; file = file->next) {
tron@1477: 		if (file->grfid == grfid) break;
tron@1477: 	}
dominik@452: 	return file;
dominik@452: }
dominik@452: 
tron@1477: static GRFFile *GetFileByFilename(const char *filename)
dominik@452: {
tron@1477: 	GRFFile *file;
dominik@452: 
tron@1477: 	for (file = _first_grffile; file != NULL; file = file->next) {
tron@1477: 		if (strcmp(file->filename, filename) == 0) break;
tron@1477: 	}
dominik@452: 	return file;
dominik@452: }
dominik@452: 
rubidium@9619: /** Reset all NewGRFData that was used only while processing data */
rubidium@9619: static void ClearTemporaryNewGRFData()
rubidium@9619: {
rubidium@9619: 	/* Clear the GOTO labels used for GRF processing */
rubidium@9619: 	for (GRFLabel *l = _cur_grffile->label; l != NULL;) {
rubidium@9619: 		GRFLabel *l2 = l->next;
rubidium@9619: 		free(l);
rubidium@9619: 		l = l2;
rubidium@9619: 	}
rubidium@9619: 	_cur_grffile->label = NULL;
rubidium@9619: 
rubidium@9619: 	/* Clear the list of spritegroups */
rubidium@9619: 	free(_cur_grffile->spritegroups);
rubidium@9619: 	_cur_grffile->spritegroups = NULL;
rubidium@9619: 	_cur_grffile->spritegroups_count = 0;
rubidium@9619: }
rubidium@9619: 
dominik@452: 
rubidium@8959: typedef std::map<StringID *, uint32> StringIDToGRFIDMapping;
rubidium@8959: StringIDToGRFIDMapping _string_to_grf_mapping;
rubidium@8959: 
maedhros@6332: /** Used when setting an object's property to map to the GRF's strings
maedhros@6332:  * while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one
belugas@6481:  * @param grfid Id of the grf file
maedhros@6332:  * @param str StringID that we want to have the equivalent in OoenTTD
maedhros@6332:  * @return the properly adjusted StringID
maedhros@6332:  */
glx@7615: StringID MapGRFStringID(uint32 grfid, StringID str)
maedhros@6332: {
glx@7879: 	/* StringID table for TextIDs 0x4E->0x6D */
glx@7879: 	static StringID units_volume[] = {
glx@7879: 		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,
glx@7879: 		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,
glx@7879: 		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,
glx@7879: 		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,
glx@7879: 		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,
glx@7879: 		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,
glx@7879: 		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,
glx@7879: 		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING
glx@7879: 	};
peter1138@8655: 
maedhros@6332: 	/* 0xD0 and 0xDC stand for all the TextIDs in the range
belugas@6348: 	 * of 0xD000 (misc graphics texts) and 0xDC00 (misc persistent texts).
maedhros@6332: 	 * These strings are unique to each grf file, and thus require to be used with the
maedhros@6332: 	 * grfid in which they are declared */
peter1138@8655: 	switch (GB(str, 8, 8)) {
peter1138@8655: 		case 0xD0: case 0xD1: case 0xD2: case 0xD3:
peter1138@8655: 		case 0xDC:
peter1138@8655: 			return GetGRFStringID(grfid, str);
peter1138@8655: 
peter1138@8655: 		case 0xD4: case 0xD5: case 0xD6: case 0xD7:
peter1138@8655: 			/* Strings embedded via 0x81 have 0x400 added to them (no real
peter1138@8655: 			 * explanation why...) */
peter1138@8655: 			return GetGRFStringID(grfid, str - 0x400);
peter1138@8655: 
peter1138@8655: 		default: break;
maedhros@6332: 	}
peter1138@8655: 
glx@7602: #define TEXID_TO_STRINGID(begin, end, stringid) if (str >= begin && str <= end) return str + (stringid - begin)
peter1138@6359: 	/* We have some changes in our cargo strings, resulting in some missing. */
glx@7602: 	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);
glx@7602: 	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);
glx@7879: 	if (str >= 0x004E && str <= 0x006D) str = units_volume[str - 0x004E];
glx@7602: 	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);
glx@7602: 	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);
peter1138@6359: 
maedhros@8150: 	/* Map building names according to our lang file changes. There are several
maedhros@8150: 	 * ranges of house ids, all of which need to be remapped to allow newgrfs
maedhros@8150: 	 * to use original house names. */
glx@7602: 	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);
maedhros@8150: 	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);
maedhros@8150: 	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);
glx@7602: 
glx@7602: 	/* Same thing for industries, since the introduction of 4 new strings above STR_482A_PRODUCTION_LAST_MONTH */
glx@7602: 	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);
glx@7602: #undef TEXTID_TO_STRINGID
maedhros@6332: 
rubidium@7605: 	if (str == STR_NULL) return STR_EMPTY;
rubidium@7605: 
maedhros@6332: 	return str;
maedhros@6332: }
maedhros@6332: 
frosch@10063: static inline uint8 MapDOSColour(uint8 colour)
peter1138@6375: {
frosch@10063: 	extern const byte _palmap_d2w[];
frosch@10063: 	return (_use_palette == PAL_DOS ? colour : _palmap_d2w[colour]);
peter1138@6375: }
peter1138@6375: 
peter1138@9070: static std::map<uint32, uint32> _grf_id_overrides;
peter1138@9070: 
peter1138@9070: static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)
peter1138@9070: {
peter1138@9070: 	_grf_id_overrides[source_grfid] = target_grfid;
peter1138@9070: 	grfmsg(5, "SetNewGRFOverride: Added override of 0x%X to 0x%X", BSWAP32(source_grfid), BSWAP32(target_grfid));
peter1138@9070: }
peter1138@9070: 
peter1138@9070: static Engine *GetNewEngine(const GRFFile *file, VehicleType type, uint16 internal_id)
peter1138@9070: {
peter1138@9070: 	/* Hack for add-on GRFs that need to modify another GRF's engines. This lets
peter1138@9070: 	 * them use the same engine slots. */
peter1138@9070: 	const GRFFile *grf_match = NULL;
rubidium@9413: 	if (_settings_game.vehicle.dynamic_engines) {
peter1138@9070: 		uint32 override = _grf_id_overrides[file->grfid];
peter1138@9070: 		if (override != 0) {
peter1138@9070: 			grf_match = GetFileByGRFID(override);
peter1138@9070: 			if (grf_match == NULL) {
peter1138@9070: 				grfmsg(5, "Tried mapping from GRFID %x to %x but target is not loaded", BSWAP32(file->grfid), BSWAP32(override));
peter1138@9070: 			} else {
peter1138@9070: 				grfmsg(5, "Mapping from GRFID %x to %x", BSWAP32(file->grfid), BSWAP32(override));
peter1138@9070: 			}
peter1138@9070: 		}
peter1138@9070: 	}
peter1138@9070: 
peter1138@9070: 	/* Check if this vehicle is already defined... */
peter1138@9070: 	Engine *e = NULL;
peter1138@9070: 	FOR_ALL_ENGINES(e) {
rubidium@9413: 		if (_settings_game.vehicle.dynamic_engines && e->grffile != NULL && e->grffile != file && e->grffile != grf_match) continue;
peter1138@9070: 		if (e->type != type) continue;
peter1138@9070: 		if (e->internal_id != internal_id) continue;
peter1138@9070: 
peter1138@9070: 		if (e->grffile == NULL) {
peter1138@9070: 			e->grffile = file;
peter1138@9070: 			grfmsg(5, "Replaced engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);
peter1138@9070: 		}
peter1138@9070: 		return e;
peter1138@9070: 	}
peter1138@9070: 
peter1138@9070: 	uint engine_pool_size = GetEnginePoolSize();
peter1138@9070: 
peter1138@9070: 	/* ... it's not, so create a new one based off an existing engine */
peter1138@9070: 	e = new Engine(type, internal_id);
peter1138@9070: 	e->grffile = file;
peter1138@9070: 
peter1138@9070: 	if (engine_pool_size != GetEnginePoolSize()) {
peter1138@9070: 		/* Resize temporary engine data ... */
peter1138@9070: 		_gted = ReallocT(_gted, GetEnginePoolSize());
peter1138@9070: 
peter1138@9070: 		/* and blank the new block. */
peter1138@9070: 		size_t len = (GetEnginePoolSize() - engine_pool_size) * sizeof(*_gted);
peter1138@9070: 		memset(_gted + engine_pool_size, 0, len);
peter1138@9070: 	}
peter1138@9070: 
peter1138@9070: 	grfmsg(5, "Created new engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);
peter1138@9070: 
peter1138@9070: 	return e;
peter1138@9070: }
peter1138@9070: 
peter1138@9073: EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
peter1138@9073: {
peter1138@9073: 	extern uint32 GetNewGRFOverride(uint32 grfid);
peter1138@9073: 
peter1138@9073: 	const GRFFile *grf_match = NULL;
rubidium@9413: 	if (_settings_game.vehicle.dynamic_engines) {
peter1138@9073: 		uint32 override = _grf_id_overrides[file->grfid];
peter1138@9073: 		if (override != 0) grf_match = GetFileByGRFID(override);
peter1138@9073: 	}
peter1138@9073: 
peter1138@9073: 	const Engine *e = NULL;
peter1138@9073: 	FOR_ALL_ENGINES(e) {
rubidium@9413: 		if (_settings_game.vehicle.dynamic_engines && e->grffile != file && (grf_match == NULL || e->grffile != grf_match)) continue;
peter1138@9073: 		if (e->type != type) continue;
peter1138@9073: 		if (e->internal_id != internal_id) continue;
peter1138@9073: 
peter1138@9073: 		return e->index;
peter1138@9073: 	}
peter1138@9073: 
peter1138@9073: 	return INVALID_ENGINE;
peter1138@9073: }
peter1138@9073: 
belugas@8577: /** Map the colour modifiers of TTDPatch to those that Open is using.
belugas@8577:  * @param grf_sprite pointer to the structure been modified
belugas@8577:  */
belugas@8577: static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)
belugas@8577: {
belugas@8577: 	if (HasBit(grf_sprite->pal, 14)) {
belugas@8577: 		ClrBit(grf_sprite->pal, 14);
belugas@8577: 		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);
belugas@8577: 	}
belugas@8577: 
belugas@8577: 	if (HasBit(grf_sprite->sprite, 14)) {
belugas@8577: 		ClrBit(grf_sprite->sprite, 14);
belugas@8577: 		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);
belugas@8577: 	}
belugas@8577: 
belugas@8577: 	if (HasBit(grf_sprite->sprite, 15)) {
belugas@8577: 		ClrBit(grf_sprite->sprite, 15);
belugas@8577: 		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);
belugas@8577: 	}
belugas@8577: }
maedhros@6332: 
peter1138@10043: enum ChangeInfoResult {
peter1138@10043: 	CIR_SUCCESS,    ///< Variable was parsed and read
peter1138@10043: 	CIR_UNHANDLED,  ///< Variable was parsed but unread
peter1138@10043: 	CIR_UNKNOWN,    ///< Variable is unknown
peter1138@10043: 	CIR_INVALID_ID, ///< Attempt to modify an invalid ID
peter1138@10043: };
peter1138@10043: 
peter1138@10043: typedef ChangeInfoResult (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len);
peter1138@10043: 
peter1138@10043: static ChangeInfoResult CommonVehicleChangeInfo(EngineInfo *ei, int prop, byte **buf)
peter1138@10038: {
peter1138@10038: 	switch (prop) {
peter1138@10038: 		case 0x00: // Introduction date
peter1138@10038: 			ei->base_intro = grf_load_word(buf) + DAYS_TILL_ORIGINAL_BASE_YEAR;
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		case 0x02: // Decay speed
peter1138@10038: 			ei->decay_speed = grf_load_byte(buf);
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		case 0x03: // Vehicle life
peter1138@10038: 			ei->lifelength = grf_load_byte(buf);
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		case 0x04: // Model life
peter1138@10038: 			ei->base_life = grf_load_byte(buf);
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		case 0x06: // Climates available
peter1138@10038: 			ei->climates = grf_load_byte(buf);
peter1138@10038: 			/* Sometimes a GRF wants hidden vehicles. Setting climates to
peter1138@10038: 			 * zero may cause the ID to be reallocated. */
peter1138@10038: 			if (ei->climates == 0) ei->climates = 0x80;
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		case 0x07: // Loading speed
peter1138@10038: 			/* Amount of cargo loaded during a vehicle's "loading tick" */
peter1138@10038: 			ei->load_amount = grf_load_byte(buf);
peter1138@10038: 			break;
peter1138@10038: 
peter1138@10038: 		default:
peter1138@10043: 			return CIR_UNKNOWN;
peter1138@10043: 	}
peter1138@10043: 
peter1138@10043: 	return CIR_SUCCESS;
peter1138@10038: }
peter1138@10038: 
peter1138@10043: static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)
dominik@452: {
dominik@452: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
dominik@452: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
peter1138@9070: 		Engine *e = GetNewEngine(_cur_grffile, VEH_TRAIN, engine + i);
peter1138@9070: 		EngineInfo *ei = &e->info;
peter1138@9070: 		RailVehicleInfo *rvi = &e->u.rail;
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x05: { // Track type
dominik@452: 				uint8 tracktype = grf_load_byte(&buf);
dominik@452: 
peter1138@3026: 				switch (tracktype) {
maedhros@7159: 					case 0: rvi->railtype = rvi->engclass >= 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;
maedhros@7159: 					case 1: rvi->railtype = RAILTYPE_MONO; break;
maedhros@7159: 					case 2: rvi->railtype = RAILTYPE_MAGLEV; break;
peter1138@3026: 					default:
Darkvater@5380: 						grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);
peter1138@3026: 						break;
peter1138@3026: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x08: // AI passenger service
peter1138@8449: 				/* Tells the AI that this engine is designed for
maedhros@7162: 				 * passenger services and shouldn't be used for freight. */
peter1138@8449: 				rvi->ai_passenger_only = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x09: { // Speed (1 unit is 1 kmh)
dominik@452: 				uint16 speed = grf_load_word(&buf);
tron@3033: 				if (speed == 0xFFFF) speed = 0;
dominik@452: 
maedhros@7159: 				rvi->max_speed = speed;
maedhros@7159: 			} break;
maedhros@7159: 
peter1138@9208: 			case 0x0B: // Power
peter1138@9208: 				rvi->power = grf_load_word(&buf);
peter1138@9468: 
peter1138@9468: 				/* Set engine / wagon state based on power */
peter1138@9468: 				if (rvi->power != 0) {
peter1138@9468: 					if (rvi->railveh_type == RAILVEH_WAGON) {
peter1138@9468: 						rvi->railveh_type = RAILVEH_SINGLEHEAD;
peter1138@9468: 					}
peter1138@9468: 				} else {
peter1138@9468: 					rvi->railveh_type = RAILVEH_WAGON;
peter1138@9468: 				}
peter1138@9208: 				break;
peter1138@9208: 
peter1138@9208: 			case 0x0D: // Running cost factor
peter1138@9208: 				rvi->running_cost = grf_load_byte(&buf);
peter1138@9208: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: { // Running cost base
dominik@452: 				uint32 base = grf_load_dword(&buf);
dominik@452: 
peter1138@8626: 				/* These magic numbers are used in GRFs to specify the base cost:
peter1138@8626: 				 * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts
peter1138@8626: 				 */
peter1138@8626: 				if (base == 0) {
peter1138@8626: 					rvi->running_cost_class = 0xFF;
peter1138@8626: 				} else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) {
peter1138@8626: 					grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base);
peter1138@8626: 				} else {
peter1138@8626: 					/* Convert the magic number to an index into the price data */
peter1138@8626: 					rvi->running_cost_class = (base - 0x4B34) / 6;
dominik@452: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x12: { // Sprite ID
dominik@452: 				uint8 spriteid = grf_load_byte(&buf);
dominik@452: 
peter1138@2895: 				/* TTD sprite IDs point to a location in a 16bit array, but we use it
peter1138@2895: 				 * as an array index, so we need it to be half the original value. */
tron@3033: 				if (spriteid < 0xFD) spriteid >>= 1;
peter1138@2895: 
maedhros@7159: 				rvi->image_index = spriteid;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x13: { // Dual-headed
dominik@452: 				uint8 dual = grf_load_byte(&buf);
dominik@452: 
dominik@452: 				if (dual != 0) {
maedhros@7159: 					rvi->railveh_type = RAILVEH_MULTIHEAD;
dominik@452: 				} else {
maedhros@7159: 					rvi->railveh_type = rvi->power == 0 ?
peter1138@5875: 						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;
dominik@452: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x14: // Cargo capacity
maedhros@7159: 				rvi->capacity = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x15: { // Cargo type
dominik@452: 				uint8 ctype = grf_load_byte(&buf);
dominik@452: 
skidd13@7928: 				if (ctype < NUM_CARGO && HasBit(_cargo_mask, ctype)) {
maedhros@7159: 					rvi->cargo_type = ctype;
peter1138@10029: 				} else if (ctype == 0xFF) {
peter1138@10029: 					/* 0xFF is specified as 'use first refittable' */
peter1138@10029: 					rvi->cargo_type = CT_INVALID;
peter1138@2846: 				} else {
maedhros@7159: 					rvi->cargo_type = CT_INVALID;
peter1138@6142: 					grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);
peter1138@2846: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x16: // Weight
maedhros@7159: 				SB(rvi->weight, 0, 8, grf_load_byte(&buf));
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: // Cost factor
peter1138@9923: 				rvi->cost_factor = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x18: // AI rank
maedhros@7159: 				rvi->ai_rank = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x19: { // Engine traction type
maedhros@7159: 				/* What do the individual numbers mean?
maedhros@7159: 				 * 0x00 .. 0x07: Steam
maedhros@7159: 				 * 0x08 .. 0x27: Diesel
maedhros@7159: 				 * 0x28 .. 0x31: Electric
maedhros@7159: 				 * 0x32 .. 0x37: Monorail
maedhros@7159: 				 * 0x38 .. 0x41: Maglev
maedhros@7159: 				 */
dominik@452: 				uint8 traction = grf_load_byte(&buf);
rubidium@6581: 				EngineClass engclass;
dominik@452: 
tron@3033: 				if (traction <= 0x07) {
rubidium@6581: 					engclass = EC_STEAM;
tron@3033: 				} else if (traction <= 0x27) {
rubidium@6581: 					engclass = EC_DIESEL;
celestar@3355: 				} else if (traction <= 0x31) {
rubidium@6581: 					engclass = EC_ELECTRIC;
rubidium@6585: 				} else if (traction <= 0x37) {
rubidium@6585: 					engclass = EC_MONORAIL;
tron@3033: 				} else if (traction <= 0x41) {
rubidium@6585: 					engclass = EC_MAGLEV;
tron@3033: 				} else {
dominik@452: 					break;
tron@3033: 				}
maedhros@7159: 				if (rvi->railtype == RAILTYPE_RAIL     && engclass >= EC_ELECTRIC) rvi->railtype = RAILTYPE_ELECTRIC;
maedhros@7159: 				if (rvi->railtype == RAILTYPE_ELECTRIC && engclass  < EC_ELECTRIC) rvi->railtype = RAILTYPE_RAIL;
maedhros@7159: 
maedhros@7159: 				rvi->engclass = engclass;
maedhros@7159: 			} break;
maedhros@7159: 
peter1138@9070: 			case 0x1A: // Alter purchase list sort order
peter1138@9715: 				AlterVehicleListOrder(e->index, grf_load_extended(&buf));
peter1138@9070: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1B: // Powered wagons power bonus
maedhros@7159: 				rvi->pow_wag_power = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1C: // Refit cost
maedhros@7159: 				ei->refit_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1D: // Refit cargo
maedhros@7159: 				ei->refit_mask = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1E: // Callback
maedhros@7159: 				ei->callbackmask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1F: // Tractive effort coefficient
maedhros@7159: 				rvi->tractive_effort = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
glx@7791: 			case 0x20: // Air drag
glx@7791: 				/** @todo Air drag for trains. */
glx@7791: 				grf_load_byte(&buf);
peter1138@10043: 				ret = CIR_UNHANDLED;
glx@7791: 				break;
glx@7791: 
maedhros@7159: 			case 0x21: // Shorter vehicle
maedhros@7159: 				rvi->shorten_factor = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x22: // Visual effect
maedhros@7162: 				/** @see note in engine.h about rvi->visual_effect */
maedhros@7159: 				rvi->visual_effect = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x23: // Powered wagons weight bonus
maedhros@7159: 				rvi->pow_wag_weight = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x24: { // High byte of vehicle weight
peter1138@2542: 				byte weight = grf_load_byte(&buf);
peter1138@2542: 
peter1138@2545: 				if (weight > 4) {
Darkvater@5380: 					grfmsg(2, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8);
peter1138@2542: 				} else {
maedhros@7159: 					SB(rvi->weight, 8, 8, weight);
peter1138@2542: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x25: // User-defined bit mask to set when checking veh. var. 42
maedhros@7159: 				rvi->user_def_data = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x26: // Retire vehicle early
maedhros@7159: 				ei->retire_early = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x27: // Miscellaneous flags
maedhros@7159: 				ei->misc_flags = grf_load_byte(&buf);
skidd13@7928: 				_loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x28: // Cargo classes allowed
peter1138@9070: 				_gted[e->index].cargo_allowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x29: // Cargo classes disallowed
peter1138@9070: 				_gted[e->index].cargo_disallowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x2A: // Long format introduction date (days since year 0)
maedhros@7159: 				ei->base_intro = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CommonVehicleChangeInfo(ei, prop, &buf);
maedhros@7159: 				break;
maedhros@7159: 		}
dominik@452: 	}
maedhros@7159: 
dominik@452: 	*bufp = buf;
dominik@452: 	return ret;
dominik@452: }
dominik@452: 
peter1138@10043: static ChangeInfoResult RoadVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)
dominik@452: {
dominik@452: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
dominik@452: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
peter1138@9070: 		Engine *e = GetNewEngine(_cur_grffile, VEH_ROAD, engine + i);
peter1138@9070: 		EngineInfo *ei = &e->info;
peter1138@9070: 		RoadVehicleInfo *rvi = &e->u.road;
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: // Speed (1 unit is 0.5 kmh)
maedhros@7159: 				rvi->max_speed = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Running cost factor
maedhros@7159: 				rvi->running_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
peter1138@8626: 			case 0x0A: { // Running cost base
peter1138@10038: 				uint32 base = grf_load_dword(&buf);
peter1138@8626: 
peter1138@8626: 				/* These magic numbers are used in GRFs to specify the base cost:
peter1138@8626: 				 * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts
peter1138@8626: 				 */
peter1138@8626: 				if (base == 0) {
peter1138@8626: 					rvi->running_cost_class = 0xFF;
peter1138@8626: 				} else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) {
peter1138@8626: 					grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base);
peter1138@8626: 				} else {
peter1138@8626: 					/* Convert the magic number to an index into the price data */
peter1138@8626: 					rvi->running_cost_class = (base - 0x4B34) / 6;
peter1138@8626: 				}
peter1138@8626: 
peter1138@8626: 				break;
peter1138@8626: 			}
maedhros@7159: 
maedhros@7159: 			case 0x0E: { // Sprite ID
dominik@452: 				uint8 spriteid = grf_load_byte(&buf);
dominik@452: 
belugas@6348: 				/* cars have different custom id in the GRF file */
tron@3033: 				if (spriteid == 0xFF) spriteid = 0xFD;
tron@3033: 
tron@3033: 				if (spriteid < 0xFD) spriteid >>= 1;
peter1138@2895: 
maedhros@7159: 				rvi->image_index = spriteid;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: // Cargo capacity
maedhros@7159: 				rvi->capacity = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x10: { // Cargo type
dominik@452: 				uint8 cargo = grf_load_byte(&buf);
dominik@452: 
skidd13@7928: 				if (cargo < NUM_CARGO && HasBit(_cargo_mask, cargo)) {
maedhros@7159: 					rvi->cargo_type = cargo;
peter1138@10029: 				} else if (cargo == 0xFF) {
peter1138@10029: 					rvi->cargo_type = CT_INVALID;
peter1138@2846: 				} else {
peter1138@10030: 					rvi->cargo_type = CT_INVALID;
peter1138@6142: 					grfmsg(2, "RoadVehicleChangeInfo: Invalid cargo type %d, using first refittable", cargo);
peter1138@2846: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x11: // Cost factor
peter1138@9923: 				rvi->cost_factor = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: // SFX
maedhros@7159: 				rvi->sfx = (SoundFx)grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: // Power in 10hp
maedhros@7159: 			case 0x14: // Weight in 1/4 tons
maedhros@7159: 			case 0x15: // Speed in mph*0.8
maedhros@7162: 				/** @todo Support for road vehicles realistic power
maedhros@7159: 				 * computations (called rvpower in TTDPatch) is just
maedhros@7159: 				 * missing in OTTD yet. --pasky */
maedhros@7159: 				grf_load_byte(&buf);
peter1138@10043: 				ret = CIR_UNHANDLED;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x16: // Cargos available for refitting
maedhros@7159: 				ei->refit_mask = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: // Callback mask
maedhros@7159: 				ei->callbackmask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
glx@7791: 			case 0x18: // Tractive effort
glx@7791: 			case 0x19: // Air drag
glx@7791: 				/** @todo Tractive effort and air drag for road vehicles. */
glx@7791: 				grf_load_byte(&buf);
peter1138@10043: 				ret = CIR_UNHANDLED;
glx@7791: 				break;
glx@7791: 
maedhros@7159: 			case 0x1A: // Refit cost
maedhros@7159: 				ei->refit_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1B: // Retire vehicle early
maedhros@7159: 				ei->retire_early = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1C: // Miscellaneous flags
maedhros@7159: 				ei->misc_flags = grf_load_byte(&buf);
skidd13@7928: 				_loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1D: // Cargo classes allowed
peter1138@9070: 				_gted[e->index].cargo_allowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1E: // Cargo classes disallowed
peter1138@9070: 				_gted[e->index].cargo_disallowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1F: // Long format introduction date (days since year 0)
maedhros@7159: 				ei->base_intro = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
peter1138@9674: 			case 0x20: // Alter purchase list sort order
peter1138@9715: 				AlterVehicleListOrder(e->index, grf_load_extended(&buf));
peter1138@9674: 				break;
peter1138@9674: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CommonVehicleChangeInfo(ei, prop, &buf);
maedhros@7159: 				break;
maedhros@7159: 		}
dominik@452: 	}
dominik@452: 
dominik@452: 	*bufp = buf;
dominik@452: 	return ret;
dominik@452: }
dominik@452: 
peter1138@10043: static ChangeInfoResult ShipVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)
dominik@452: {
dominik@452: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
dominik@452: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
peter1138@9070: 		Engine *e = GetNewEngine(_cur_grffile, VEH_SHIP, engine + i);
peter1138@9070: 		EngineInfo *ei = &e->info;
peter1138@9070: 		ShipVehicleInfo *svi = &e->u.ship;
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: { // Sprite ID
dominik@452: 				uint8 spriteid = grf_load_byte(&buf);
dominik@452: 
belugas@6348: 				/* ships have different custom id in the GRF file */
tron@3033: 				if (spriteid == 0xFF) spriteid = 0xFD;
tron@3033: 
tron@3033: 				if (spriteid < 0xFD) spriteid >>= 1;
peter1138@2895: 
maedhros@7159: 				svi->image_index = spriteid;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Refittable
maedhros@7159: 				svi->refittable = (grf_load_byte(&buf) != 0);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: // Cost factor
peter1138@9923: 				svi->cost_factor = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: // Speed (1 unit is 0.5 kmh)
maedhros@7159: 				svi->max_speed = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: { // Cargo type
dominik@452: 				uint8 cargo = grf_load_byte(&buf);
dominik@452: 
skidd13@7928: 				if (cargo < NUM_CARGO && HasBit(_cargo_mask, cargo)) {
maedhros@7159: 					svi->cargo_type = cargo;
peter1138@10029: 				} else if (cargo == 0xFF) {
peter1138@10029: 					svi->cargo_type = CT_INVALID;
peter1138@2846: 				} else {
maedhros@7159: 					svi->cargo_type = CT_INVALID;
peter1138@6142: 					grfmsg(2, "ShipVehicleChangeInfo: Invalid cargo type %d, using first refittable", cargo);
peter1138@2846: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: // Cargo capacity
maedhros@7159: 				svi->capacity = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: // Running cost factor
maedhros@7159: 				svi->running_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x10: // SFX
maedhros@7159: 				svi->sfx = (SoundFx)grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x11: // Cargos available for refitting
maedhros@7159: 				ei->refit_mask = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: // Callback mask
maedhros@7159: 				ei->callbackmask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: // Refit cost
maedhros@7159: 				ei->refit_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
glx@7791: 			case 0x14: // Ocean speed fraction
glx@7791: 			case 0x15: // Canal speed fraction
glx@7791: 				/** @todo Speed fractions for ships on oceans and canals */
glx@7791: 				grf_load_byte(&buf);
peter1138@10043: 				ret = CIR_UNHANDLED;
glx@7791: 				break;
glx@7791: 
maedhros@7159: 			case 0x16: // Retire vehicle early
maedhros@7159: 				ei->retire_early = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: // Miscellaneous flags
maedhros@7159: 				ei->misc_flags = grf_load_byte(&buf);
skidd13@7928: 				_loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x18: // Cargo classes allowed
peter1138@9070: 				_gted[e->index].cargo_allowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x19: // Cargo classes disallowed
peter1138@9070: 				_gted[e->index].cargo_disallowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1A: // Long format introduction date (days since year 0)
maedhros@7159: 				ei->base_intro = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
peter1138@9674: 			case 0x1B: // Alter purchase list sort order
peter1138@9715: 				AlterVehicleListOrder(e->index, grf_load_extended(&buf));
peter1138@9674: 				break;
peter1138@9674: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CommonVehicleChangeInfo(ei, prop, &buf);
maedhros@7159: 				break;
maedhros@7159: 		}
dominik@452: 	}
dominik@452: 
dominik@452: 	*bufp = buf;
dominik@452: 	return ret;
dominik@452: }
dominik@452: 
peter1138@10043: static ChangeInfoResult AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)
dominik@452: {
dominik@452: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
dominik@452: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
peter1138@9070: 		Engine *e = GetNewEngine(_cur_grffile, VEH_AIRCRAFT, engine + i);
peter1138@9070: 		EngineInfo *ei = &e->info;
peter1138@9070: 		AircraftVehicleInfo *avi = &e->u.air;
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: { // Sprite ID
dominik@452: 				uint8 spriteid = grf_load_byte(&buf);
dominik@452: 
belugas@6348: 				/* aircraft have different custom id in the GRF file */
tron@3033: 				if (spriteid == 0xFF) spriteid = 0xFD;
tron@3033: 
tron@3033: 				if (spriteid < 0xFD) spriteid >>= 1;
peter1138@2895: 
maedhros@7159: 				avi->image_index = spriteid;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Helicopter
peter1138@4926: 				if (grf_load_byte(&buf) == 0) {
maedhros@7159: 					avi->subtype = AIR_HELI;
peter1138@4926: 				} else {
maedhros@7159: 					SB(avi->subtype, 0, 1, 1); // AIR_CTOL
peter1138@4926: 				}
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: // Large
maedhros@7159: 				SB(avi->subtype, 1, 1, (grf_load_byte(&buf) != 0 ? 1 : 0)); // AIR_FAST
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: // Cost factor
peter1138@9923: 				avi->cost_factor = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: // Speed (1 unit is 8 mph, we translate to 1 unit is 1 km/h)
maedhros@7159: 				avi->max_speed = (grf_load_byte(&buf) * 129) / 10;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: // Acceleration
maedhros@7159: 				avi->acceleration = (grf_load_byte(&buf) * 129) / 10;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: // Running cost factor
maedhros@7159: 				avi->running_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: // Passenger capacity
maedhros@7159: 				avi->passenger_capacity = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x11: // Mail capacity
maedhros@7159: 				avi->mail_capacity = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: // SFX
maedhros@7159: 				avi->sfx = (SoundFx)grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: // Cargos available for refitting
maedhros@7159: 				ei->refit_mask = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x14: // Callback mask
maedhros@7159: 				ei->callbackmask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x15: // Refit cost
maedhros@7159: 				ei->refit_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x16: // Retire vehicle early
maedhros@7159: 				ei->retire_early = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: // Miscellaneous flags
maedhros@7159: 				ei->misc_flags = grf_load_byte(&buf);
skidd13@7928: 				_loaded_newgrf_features.has_2CC |= HasBit(ei->misc_flags, EF_USES_2CC);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x18: // Cargo classes allowed
peter1138@9070: 				_gted[e->index].cargo_allowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x19: // Cargo classes disallowed
peter1138@9070: 				_gted[e->index].cargo_disallowed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1A: // Long format introduction date (days since year 0)
maedhros@7159: 				ei->base_intro = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
peter1138@9674: 			case 0x1B: // Alter purchase list sort order
peter1138@9715: 				AlterVehicleListOrder(e->index, grf_load_extended(&buf));
peter1138@9674: 				break;
peter1138@9674: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CommonVehicleChangeInfo(ei, prop, &buf);
maedhros@7159: 				break;
maedhros@7159: 		}
dominik@452: 	}
dominik@452: 
dominik@452: 	*bufp = buf;
dominik@452: 	return ret;
dominik@452: }
dominik@452: 
peter1138@10043: static ChangeInfoResult StationChangeInfo(uint stid, int numinfo, int prop, byte **bufp, int len)
dominik@452: {
dominik@452: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
dominik@452: 
peter1138@3768: 	if (stid + numinfo > MAX_STATIONS) {
Darkvater@5380: 		grfmsg(1, "StationChangeInfo: Station %u is invalid, max %u, ignoring", stid + numinfo, MAX_STATIONS);
peter1138@10043: 		return CIR_INVALID_ID;
peter1138@3768: 	}
peter1138@3768: 
peter1138@3501: 	/* Allocate station specs if necessary */
KUDr@5609: 	if (_cur_grffile->stations == NULL) _cur_grffile->stations = CallocT<StationSpec*>(MAX_STATIONS);
peter1138@3768: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
maedhros@7159: 		StationSpec *statspec = _cur_grffile->stations[stid + i];
maedhros@7159: 
maedhros@7159: 		/* Check that the station we are modifying is defined. */
maedhros@7159: 		if (statspec == NULL && prop != 0x08) {
maedhros@7159: 			grfmsg(2, "StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i);
peter1138@10043: 			return CIR_INVALID_ID;
peter1138@3501: 		}
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: { // Class ID
maedhros@7159: 				StationSpec **spec = &_cur_grffile->stations[stid + i];
maedhros@7159: 
peter1138@3768: 				/* Property 0x08 is special; it is where the station is allocated */
maedhros@7159: 				if (*spec == NULL) *spec = CallocT<StationSpec>(1);
peter1138@3768: 
Darkvater@3711: 				/* Swap classid because we read it in BE meaning WAYP or DFLT */
peter1138@6281: 				uint32 classid = grf_load_dword(&buf);
maedhros@7159: 				(*spec)->sclass = AllocateStationClass(BSWAP32(classid));
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Define sprite layout
belugas@3676: 				statspec->tiles = grf_load_extended(&buf);
KUDr@5609: 				statspec->renderdata = CallocT<DrawTileSprites>(statspec->tiles);
peter1138@3740: 				statspec->copied_renderdata = false;
peter1138@3740: 
peter1138@6281: 				for (uint t = 0; t < statspec->tiles; t++) {
belugas@3676: 					DrawTileSprites *dts = &statspec->renderdata[t];
peter1138@3570: 					uint seq_count = 0;
peter1138@2625: 
peter1138@3737: 					dts->seq = NULL;
frosch@8571: 					dts->ground.sprite = grf_load_word(&buf);
frosch@8571: 					dts->ground.pal = grf_load_word(&buf);
frosch@8571: 					if (dts->ground.sprite == 0) continue;
frosch@8571: 					if (HasBit(dts->ground.pal, 15)) {
frosch@8571: 						ClrBit(dts->ground.pal, 15);
frosch@8571: 						SetBit(dts->ground.sprite, SPRITE_MODIFIER_USE_OFFSET);
peter1138@5668: 					}
belugas@8577: 
belugas@8577: 					MapSpriteMappingRecolour(&dts->ground);
peter1138@2625: 
dominik@452: 					while (buf < *bufp + len) {
dominik@452: 						DrawTileSeqStruct *dtss;
dominik@452: 
belugas@6348: 						/* no relative bounding box support */
KUDr@5609: 						dts->seq = ReallocT((DrawTileSeqStruct*)dts->seq, ++seq_count);
dominik@452: 						dtss = (DrawTileSeqStruct*) &dts->seq[seq_count - 1];
dominik@452: 
dominik@452: 						dtss->delta_x = grf_load_byte(&buf);
dominik@452: 						if ((byte) dtss->delta_x == 0x80) break;
dominik@452: 						dtss->delta_y = grf_load_byte(&buf);
dominik@452: 						dtss->delta_z = grf_load_byte(&buf);
tron@4230: 						dtss->size_x = grf_load_byte(&buf);
tron@4230: 						dtss->size_y = grf_load_byte(&buf);
tron@4230: 						dtss->size_z = grf_load_byte(&buf);
frosch@8570: 						dtss->image.sprite = grf_load_word(&buf);
frosch@8570: 						dtss->image.pal = grf_load_word(&buf);
peter1138@3771: 
peter1138@3775: 						/* Remap flags as ours collide */
frosch@8570: 						if (HasBit(dtss->image.pal, 15)) {
frosch@8570: 							ClrBit(dtss->image.pal, 15);
frosch@8570: 							SetBit(dtss->image.sprite, SPRITE_MODIFIER_USE_OFFSET);
peter1138@8158: 						}
belugas@8577: 
belugas@8577: 						MapSpriteMappingRecolour(&dtss->image);
dominik@452: 					}
dominik@452: 				}
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: { // Copy sprite layout
dominik@452: 				byte srcid = grf_load_byte(&buf);
peter1138@3768: 				const StationSpec *srcstatspec = _cur_grffile->stations[srcid];
dominik@452: 
belugas@3676: 				statspec->tiles = srcstatspec->tiles;
peter1138@3738: 				statspec->renderdata = srcstatspec->renderdata;
peter1138@3740: 				statspec->copied_renderdata = true;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: // Callback mask
maedhros@7159: 				statspec->callbackmask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: // Disallowed number of platforms
maedhros@7159: 				statspec->disallowed_platforms = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: // Disallowed platform lengths
maedhros@7159: 				statspec->disallowed_lengths = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: // Define custom layout
peter1138@5060: 				statspec->copied_layouts = false;
peter1138@5060: 
dominik@452: 				while (buf < *bufp + len) {
dominik@452: 					byte length = grf_load_byte(&buf);
dominik@452: 					byte number = grf_load_byte(&buf);
dominik@452: 					StationLayout layout;
peter1138@3570: 					uint l, p;
dominik@452: 
dominik@452: 					if (length == 0 || number == 0) break;
dominik@452: 
dominik@452: 					//debug("l %d > %d ?", length, stat->lengths);
belugas@3676: 					if (length > statspec->lengths) {
KUDr@5609: 						statspec->platforms = ReallocT(statspec->platforms, length);
belugas@3676: 						memset(statspec->platforms + statspec->lengths, 0, length - statspec->lengths);
belugas@3676: 
KUDr@5609: 						statspec->layouts = ReallocT(statspec->layouts, length);
belugas@3676: 						memset(statspec->layouts + statspec->lengths, 0,
belugas@3676: 						       (length - statspec->lengths) * sizeof(*statspec->layouts));
belugas@3676: 
belugas@3676: 						statspec->lengths = length;
dominik@452: 					}
dominik@452: 					l = length - 1; // index is zero-based
dominik@452: 
dominik@452: 					//debug("p %d > %d ?", number, stat->platforms[l]);
belugas@3676: 					if (number > statspec->platforms[l]) {
KUDr@5609: 						statspec->layouts[l] = ReallocT(statspec->layouts[l], number);
belugas@6348: 						/* We expect NULL being 0 here, but C99 guarantees that. */
belugas@3676: 						memset(statspec->layouts[l] + statspec->platforms[l], 0,
belugas@3676: 						       (number - statspec->platforms[l]) * sizeof(**statspec->layouts));
belugas@3676: 
belugas@3676: 						statspec->platforms[l] = number;
dominik@452: 					}
dominik@452: 
truelight@542: 					p = 0;
KUDr@5609: 					layout = MallocT<byte>(length * number);
tron@3033: 					for (l = 0; l < length; l++) {
tron@3033: 						for (p = 0; p < number; p++) {
dominik@452: 							layout[l * number + p] = grf_load_byte(&buf);
tron@3033: 						}
tron@3033: 					}
dominik@452: 
dominik@452: 					l--;
dominik@452: 					p--;
belugas@3676: 					free(statspec->layouts[l][p]);
belugas@3676: 					statspec->layouts[l][p] = layout;
dominik@452: 				}
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: { // Copy custom layout
peter1138@5060: 				byte srcid = grf_load_byte(&buf);
peter1138@5060: 				const StationSpec *srcstatspec = _cur_grffile->stations[srcid];
peter1138@5060: 
peter1138@5060: 				statspec->lengths   = srcstatspec->lengths;
peter1138@5060: 				statspec->platforms = srcstatspec->platforms;
peter1138@5060: 				statspec->layouts   = srcstatspec->layouts;
peter1138@5060: 				statspec->copied_layouts = true;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x10: // Little/lots cargo threshold
maedhros@7159: 				statspec->cargo_threshold = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x11: // Pylon placement
maedhros@7159: 				statspec->pylons = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: // Cargo types for random triggers
maedhros@7159: 				statspec->cargo_triggers = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: // General flags
maedhros@7159: 				statspec->flags = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x14: // Overhead wire placement
maedhros@7159: 				statspec->wires = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x15: // Blocked tiles
maedhros@7159: 				statspec->blocked = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
peter1138@9003: 			case 0x16: // Animation info
peter1138@9003: 				statspec->anim_frames = grf_load_byte(&buf);
peter1138@9003: 				statspec->anim_status = grf_load_byte(&buf);
peter1138@9003: 				break;
peter1138@9003: 
peter1138@9003: 			case 0x17: // Animation speed
peter1138@9003: 				statspec->anim_speed = grf_load_byte(&buf);
peter1138@9003: 				break;
peter1138@9003: 
peter1138@9003: 			case 0x18: // Animation triggers
peter1138@9003: 				statspec->anim_triggers = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
dominik@452: 	}
dominik@452: 
dominik@452: 	*bufp = buf;
dominik@452: 	return ret;
dominik@452: }
dominik@452: 
peter1138@10043: static ChangeInfoResult CanalChangeInfo(uint id, int numinfo, int prop, byte **bufp, int len)
peter1138@8372: {
peter1138@8372: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
peter1138@8372: 
peter1138@8372: 	if (id + numinfo > CF_END) {
peter1138@8372: 		grfmsg(1, "CanalChangeInfo: Canal feature %u is invalid, max %u, ignoreing", id + numinfo, CF_END);
peter1138@10043: 		return CIR_INVALID_ID;
peter1138@8372: 	}
peter1138@8372: 
peter1138@8372: 	for (int i = 0; i < numinfo; i++) {
peter1138@8372: 		WaterFeature *wf = &_water_feature[id + i];
peter1138@8372: 
peter1138@8372: 		switch (prop) {
peter1138@8372: 			case 0x08:
peter1138@8372: 				wf->callbackmask = grf_load_byte(&buf);
peter1138@8372: 				break;
peter1138@8372: 
peter1138@8372: 			case 0x09:
peter1138@8372: 				wf->flags = grf_load_byte(&buf);
peter1138@8372: 				break;
peter1138@8372: 
peter1138@8372: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
peter1138@8372: 				break;
peter1138@8372: 		}
peter1138@8372: 	}
peter1138@8372: 
peter1138@8372: 	*bufp = buf;
peter1138@8372: 	return ret;
peter1138@8372: }
peter1138@8372: 
peter1138@10043: static ChangeInfoResult BridgeChangeInfo(uint brid, int numinfo, int prop, byte **bufp, int len)
peter1138@2478: {
peter1138@2478: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
peter1138@2478: 
maedhros@7159: 	if (brid + numinfo > MAX_BRIDGES) {
maedhros@7159: 		grfmsg(1, "BridgeChangeInfo: Bridge %u is invalid, max %u, ignoring", brid + numinfo, MAX_BRIDGES);
peter1138@10043: 		return CIR_INVALID_ID;
maedhros@7159: 	}
maedhros@7159: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
belugas@8535: 		BridgeSpec *bridge = &_bridge[brid + i];
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: // Year of availability
maedhros@7159: 				bridge->avail_year = ORIGINAL_BASE_YEAR + grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Minimum length
maedhros@7159: 				bridge->min_length = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: // Maximum length
maedhros@7159: 				bridge->max_length = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: // Cost factor
maedhros@7159: 				bridge->price = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: // Maximum speed
maedhros@7159: 				bridge->speed = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: { // Bridge sprite tables
peter1138@2478: 				byte tableid = grf_load_byte(&buf);
peter1138@2478: 				byte numtables = grf_load_byte(&buf);
peter1138@2478: 
peter1138@2478: 				if (bridge->sprite_table == NULL) {
Darkvater@3555: 					/* Allocate memory for sprite table pointers and zero out */
KUDr@5609: 					bridge->sprite_table = CallocT<PalSpriteID*>(7);
peter1138@2478: 				}
peter1138@2478: 
Darkvater@3555: 				for (; numtables-- != 0; tableid++) {
Darkvater@3555: 					if (tableid >= 7) { // skip invalid data
Darkvater@5380: 						grfmsg(1, "BridgeChangeInfo: Table %d >= 7, skipping", tableid);
peter1138@6281: 						for (byte sprite = 0; sprite < 32; sprite++) grf_load_dword(&buf);
Darkvater@3555: 						continue;
peter1138@2478: 					}
Darkvater@3555: 
Darkvater@3555: 					if (bridge->sprite_table[tableid] == NULL) {
KUDr@5609: 						bridge->sprite_table[tableid] = MallocT<PalSpriteID>(32);
Darkvater@3555: 					}
Darkvater@3555: 
peter1138@6281: 					for (byte sprite = 0; sprite < 32; sprite++) {
peter1138@5668: 						SpriteID image = grf_load_word(&buf);
peter1138@5668: 						SpriteID pal   = grf_load_word(&buf);
peter1138@5668: 
peter1138@5668: 						bridge->sprite_table[tableid][sprite].sprite = image;
peter1138@5668: 						bridge->sprite_table[tableid][sprite].pal    = pal;
belugas@8577: 
belugas@8577: 						MapSpriteMappingRecolour(&bridge->sprite_table[tableid][sprite]);
peter1138@5668: 					}
peter1138@2478: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: // Flags; bit 0 - disable far pillars
maedhros@7159: 				bridge->flags = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: // Long format year of availability (year since year 0)
skidd13@7922: 				bridge->avail_year = Clamp(grf_load_dword(&buf), MIN_YEAR, MAX_YEAR);
maedhros@7159: 				break;
maedhros@7159: 
belugas@8494: 			case 0x10: { // purchase string
belugas@8494: 				StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf));
belugas@8494: 				if (newone != STR_UNDEFINED) bridge->material = newone;
belugas@8494: 				} break;
belugas@8494: 
belugas@8540: 			case 0x11: // description of bridge with rails or roads
belugas@8540: 			case 0x12: {
belugas@8494: 				StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf));
belugas@8540: 				if (newone != STR_UNDEFINED) bridge->transport_name[prop - 0x11] = newone;
belugas@8494: 				} break;
belugas@8494: 
belugas@10013: 			case 0x13: // 16 bits cost multiplier
belugas@10013: 				bridge->price = grf_load_word(&buf);
belugas@10013: 				break;
belugas@10013: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
peter1138@2478: 	}
peter1138@2478: 
peter1138@2478: 	*bufp = buf;
peter1138@2478: 	return ret;
peter1138@2478: }
dominik@452: 
peter1138@10043: static ChangeInfoResult TownHouseChangeInfo(uint hid, int numinfo, int prop, byte **bufp, int len)
maedhros@6332: {
maedhros@6332: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
maedhros@6332: 
maedhros@7161: 	if (hid + numinfo > HOUSE_MAX) {
maedhros@7161: 		grfmsg(1, "TownHouseChangeInfo: Too many houses loaded (%u), max (%u). Ignoring.", hid + numinfo, HOUSE_MAX);
peter1138@10043: 		return CIR_INVALID_ID;
maedhros@6332: 	}
maedhros@6332: 
maedhros@6332: 	/* Allocate house specs if they haven't been allocated already. */
maedhros@6332: 	if (_cur_grffile->housespec == NULL) {
maedhros@6332: 		_cur_grffile->housespec = CallocT<HouseSpec*>(HOUSE_MAX);
maedhros@6332: 	}
maedhros@6332: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
maedhros@7159: 		HouseSpec *housespec = _cur_grffile->housespec[hid + i];
maedhros@7159: 
maedhros@7159: 		if (prop != 0x08 && housespec == NULL) {
maedhros@7159: 			grfmsg(2, "TownHouseChangeInfo: Attempt to modify undefined house %u. Ignoring.", hid + i);
peter1138@10043: 			return CIR_INVALID_ID;
maedhros@6332: 		}
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: { // Substitute building type, and definition of a new house
maedhros@7159: 				HouseSpec **house = &_cur_grffile->housespec[hid + i];
maedhros@6332: 				byte subs_id = grf_load_byte(&buf);
maedhros@6332: 
maedhros@6332: 				if (subs_id == 0xFF) {
maedhros@6332: 					/* Instead of defining a new house, a substitute house id
maedhros@6332: 					 * of 0xFF disables the old house with the current id. */
maedhros@6332: 					_house_specs[hid + i].enabled = false;
maedhros@6332: 					continue;
maedhros@6332: 				} else if (subs_id >= NEW_HOUSE_OFFSET) {
maedhros@6332: 					/* The substitute id must be one of the original houses. */
maedhros@6332: 					grfmsg(2, "TownHouseChangeInfo: Attempt to use new house %u as substitute house for %u. Ignoring.", subs_id, hid + i);
peter1138@10041: 					continue;
maedhros@6332: 				}
maedhros@6332: 
maedhros@6332: 				/* Allocate space for this house. */
maedhros@7159: 				if (*house == NULL) *house = CallocT<HouseSpec>(1);
maedhros@7159: 
maedhros@7159: 				housespec = *house;
maedhros@7159: 
maedhros@7159: 				memcpy(housespec, &_house_specs[subs_id], sizeof(_house_specs[subs_id]));
maedhros@7159: 
maedhros@7159: 				housespec->enabled = true;
maedhros@7159: 				housespec->local_id = hid + i;
maedhros@7159: 				housespec->substitute_id = subs_id;
maedhros@7159: 				housespec->grffile = _cur_grffile;
maedhros@7159: 				housespec->random_colour[0] = 0x04;  // those 4 random colours are the base colour
maedhros@7159: 				housespec->random_colour[1] = 0x08;  // for all new houses
maedhros@7159: 				housespec->random_colour[2] = 0x0C;  // they stand for red, blue, orange and green
maedhros@7159: 				housespec->random_colour[3] = 0x06;
maedhros@6332: 
maedhros@7431: 				/* Make sure that the third cargo type is valid in this
maedhros@7431: 				 * climate. This can cause problems when copying the properties
maedhros@7431: 				 * of a house that accepts food, where the new house is valid
maedhros@7431: 				 * in the temperate climate. */
maedhros@7431: 				if (!GetCargo(housespec->accepts_cargo[2])->IsValid()) {
maedhros@7431: 					housespec->cargo_acceptance[2] = 0;
maedhros@7431: 				}
maedhros@7431: 
maedhros@7162: 				/**
maedhros@7162: 				 * New houses do not (currently) expect to have a default start
maedhros@7162: 				 * date before 1930, as this breaks the build date stuff.
maedhros@7162: 				 * @see FinaliseHouseArray() for more details.
maedhros@7162: 				 */
belugas@9450: 				if (housespec->min_year < 1930) housespec->min_year = 1930;
maedhros@7159: 
maedhros@7159: 				_loaded_newgrf_features.has_newhouses = true;
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Building flags
maedhros@7159: 				housespec->building_flags = (BuildingFlags)grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: { // Availability years
maedhros@6332: 				uint16 years = grf_load_word(&buf);
belugas@9450: 				housespec->min_year = GB(years, 0, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 0, 8);
belugas@9450: 				housespec->max_year = GB(years, 8, 8) > 150 ? MAX_YEAR : ORIGINAL_BASE_YEAR + GB(years, 8, 8);
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: // Population
maedhros@7159: 				housespec->population = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: // Mail generation multiplier
maedhros@7159: 				housespec->mail_generation = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: // Passenger acceptance
maedhros@7159: 			case 0x0E: // Mail acceptance
maedhros@7159: 				housespec->cargo_acceptance[prop - 0x0D] = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: { // Goods/candy, food/fizzy drinks acceptance
maedhros@6332: 				int8 goods = grf_load_byte(&buf);
belugas@6341: 
belugas@6341: 				/* If value of goods is negative, it means in fact food or, if in toyland, fizzy_drink acceptance.
belugas@6341: 				 * Else, we have "standard" 3rd cargo type, goods or candy, for toyland once more */
rubidium@9413: 				CargoID cid = (goods >= 0) ? ((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_CANDY : CT_GOODS) :
rubidium@9413: 						((_settings_game.game_creation.landscape == LT_TOYLAND) ? CT_FIZZY_DRINKS : CT_FOOD);
belugas@6341: 
maedhros@7431: 				/* Make sure the cargo type is valid in this climate. */
maedhros@7431: 				if (!GetCargo(cid)->IsValid()) goods = 0;
maedhros@7431: 
maedhros@7431: 				housespec->accepts_cargo[2] = cid;
maedhros@7159: 				housespec->cargo_acceptance[2] = abs(goods); // but we do need positive value here
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x10: // Local authority rating decrease on removal
maedhros@7159: 				housespec->remove_rating_decrease = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x11: // Removal cost multiplier
maedhros@7159: 				housespec->removal_cost = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: // Building name ID
rubidium@8959: 				housespec->building_name = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&housespec->building_name] = _cur_grffile->grfid;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: // Building availability mask
maedhros@7159: 				housespec->building_availability = (HouseZones)grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x14: // House callback flags
maedhros@7159: 				housespec->callback_mask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x15: { // House override byte
maedhros@6332: 				byte override = grf_load_byte(&buf);
maedhros@6332: 
maedhros@6332: 				/* The house being overridden must be an original house. */
maedhros@6332: 				if (override >= NEW_HOUSE_OFFSET) {
maedhros@7160: 					grfmsg(2, "TownHouseChangeInfo: Attempt to override new house %u with house id %u. Ignoring.", override, hid + i);
maedhros@7159: 					continue;
maedhros@6332: 				}
maedhros@6332: 
glx@7873: 				_house_mngr.Add(hid + i, _cur_grffile->grfid, override);
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x16: // Periodic refresh multiplier
maedhros@7159: 				housespec->processing_time = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: // Four random colours to use
maedhros@7159: 				for (uint j = 0; j < 4; j++) housespec->random_colour[j] = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x18: // Relative probability of appearing
maedhros@7159: 				housespec->probability = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x19: // Extra flags
maedhros@7159: 				housespec->extra_flags = (HouseExtraFlags)grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1A: // Animation frames
maedhros@7159: 				housespec->animation_frames = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1B: // Animation speed
skidd13@7922: 				housespec->animation_speed = Clamp(grf_load_byte(&buf), 2, 16);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1C: // Class of the building type
maedhros@7159: 				housespec->class_id = AllocateHouseClassID(grf_load_byte(&buf), _cur_grffile->grfid);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1D: // Callback flags 2
maedhros@7159: 				housespec->callback_mask |= (grf_load_byte(&buf) << 8);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1E: { // Accepted cargo types
peter1138@6461: 				uint32 cargotypes = grf_load_dword(&buf);
peter1138@6461: 
peter1138@6461: 				/* Check if the cargo types should not be changed */
peter1138@6461: 				if (cargotypes == 0xFFFFFFFF) break;
peter1138@6461: 
peter1138@6461: 				for (uint j = 0; j < 3; j++) {
peter1138@6461: 					/* Get the cargo number from the 'list' */
peter1138@6461: 					uint8 cargo_part = GB(cargotypes, 8 * j, 8);
peter1138@6461: 					CargoID cargo = GetCargoTranslation(cargo_part, _cur_grffile);
peter1138@6461: 
peter1138@6461: 					if (cargo == CT_INVALID) {
peter1138@6461: 						/* Disable acceptance of invalid cargo type */
maedhros@7159: 						housespec->cargo_acceptance[j] = 0;
peter1138@6461: 					} else {
maedhros@7159: 						housespec->accepts_cargo[j] = cargo;
peter1138@6461: 					}
peter1138@6461: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x1F: // Minimum life span
maedhros@7159: 				housespec->minimum_life = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
glx@7791: 			case 0x20: { // @todo Cargo acceptance watch list
glx@7791: 				byte count = grf_load_byte(&buf);
glx@7791: 				for (byte j = 0; j < count; j++) grf_load_byte(&buf);
peter1138@10043: 				ret = CIR_UNHANDLED;
glx@7791: 			} break;
glx@7791: 
belugas@9483: 			case 0x21: // long introduction year
belugas@9483: 				housespec->min_year = grf_load_word(&buf);
belugas@9483: 				break;
belugas@9483: 
belugas@9483: 			case 0x22: // long maximum year
belugas@9483: 				housespec->max_year = grf_load_word(&buf);
belugas@9483: 				break;
belugas@9483: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
maedhros@6332: 	}
maedhros@6332: 
maedhros@6332: 	*bufp = buf;
maedhros@6332: 	return ret;
maedhros@6332: }
maedhros@6332: 
peter1138@10043: static ChangeInfoResult GlobalVarChangeInfo(uint gvid, int numinfo, int prop, byte **bufp, int len)
peter1138@2506: {
peter1138@2506: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
peter1138@2506: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
maedhros@7159: 		switch (prop) {
maedhros@7162: 			case 0x08: { // Cost base factor
peter1138@2506: 				byte factor = grf_load_byte(&buf);
peter1138@2508: 				uint price = gvid + i;
peter1138@2506: 
peter1138@2508: 				if (price < NUM_PRICES) {
peter1138@2508: 					SetPriceBaseMultiplier(price, factor);
peter1138@2508: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Price %d out of range, ignoring", price);
peter1138@2508: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@8478: 			case 0x09: // Cargo translation table
maedhros@8478: 				/* This is loaded during the reservation stage, so just skip it here. */
maedhros@8478: 				/* Each entry is 4 bytes. */
maedhros@8478: 				buf += 4;
maedhros@8478: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: { // Currency display names
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4625: 				StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf));
belugas@4377: 
belugas@4504: 				if ((newone != STR_UNDEFINED) && (curidx < NUM_CURRENCY)) {
belugas@4504: 					_currency_specs[curidx].name = newone;
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0B: { // Currency multipliers
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4377: 				uint32 rate = grf_load_dword(&buf);
belugas@4377: 
belugas@4377: 				if (curidx < NUM_CURRENCY) {
belugas@4602: 					/* TTDPatch uses a multiple of 1000 for its conversion calculations,
belugas@4602: 					 * which OTTD does not. For this reason, divide grf value by 1000,
belugas@4602: 					 * to be compatible */
belugas@4602: 					_currency_specs[curidx].rate = rate / 1000;
belugas@4377: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx);
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: { // Currency options
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4377: 				uint16 options = grf_load_word(&buf);
belugas@4377: 
belugas@4377: 				if (curidx < NUM_CURRENCY) {
belugas@4377: 					_currency_specs[curidx].separator = GB(options, 0, 8);
belugas@4602: 					/* By specifying only one bit, we prevent errors,
belugas@4602: 					 * since newgrf specs said that only 0 and 1 can be set for symbol_pos */
belugas@4602: 					_currency_specs[curidx].symbol_pos = GB(options, 8, 1);
belugas@4377: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx);
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: { // Currency prefix symbol
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4377: 				uint32 tempfix = grf_load_dword(&buf);
belugas@4377: 
belugas@4377: 				if (curidx < NUM_CURRENCY) {
maedhros@7162: 					memcpy(_currency_specs[curidx].prefix, &tempfix, 4);
belugas@4377: 					_currency_specs[curidx].prefix[4] = 0;
belugas@4377: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: { // Currency suffix symbol
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4377: 				uint32 tempfix = grf_load_dword(&buf);
belugas@4377: 
belugas@4377: 				if (curidx < NUM_CURRENCY) {
rubidium@6491: 					memcpy(&_currency_specs[curidx].suffix, &tempfix, 4);
belugas@4377: 					_currency_specs[curidx].suffix[4] = 0;
belugas@4377: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx);
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: { //  Euro introduction dates
belugas@4625: 				uint curidx = GetNewgrfCurrencyIdConverted(gvid + i);
belugas@4377: 				Year year_euro = grf_load_word(&buf);
belugas@4377: 
belugas@4377: 				if (curidx < NUM_CURRENCY) {
belugas@4377: 					_currency_specs[curidx].to_euro = year_euro;
belugas@4377: 				} else {
Darkvater@5380: 					grfmsg(1, "GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx);
belugas@4377: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7162: 			case 0x10: // Snow line height table
maedhros@7159: 				if (numinfo > 1 || IsSnowLineSet()) {
maedhros@7159: 					grfmsg(1, "GlobalVarChangeInfo: The snowline can only be set once (%d)", numinfo);
maedhros@7159: 				} else if (len < SNOW_LINE_MONTHS * SNOW_LINE_DAYS) {
maedhros@7159: 					grfmsg(1, "GlobalVarChangeInfo: Not enough entries set in the snowline table (%d)", len);
maedhros@7159: 				} else {
maedhros@7159: 					byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS];
maedhros@7159: 
maedhros@7159: 					for (uint i = 0; i < SNOW_LINE_MONTHS; i++) {
maedhros@7159: 						for (uint j = 0; j < SNOW_LINE_DAYS; j++) {
maedhros@7159: 							table[i][j] = grf_load_byte(&buf);
maedhros@7159: 						}
maedhros@6343: 					}
maedhros@7159: 					SetSnowLine(table);
maedhros@6343: 				}
maedhros@7159: 				break;
maedhros@7159: 
peter1138@9070: 			case 0x11: // GRF match for engine allocation
peter1138@9070: 				/* This is loaded during the reservation stage, so just skip it here. */
peter1138@9070: 				/* Each entry is 8 bytes. */
peter1138@9070: 				buf += 8;
peter1138@9070: 				break;
peter1138@9070: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
peter1138@2506: 	}
peter1138@3504: 
peter1138@2506: 	*bufp = buf;
peter1138@2506: 	return ret;
peter1138@2506: }
peter1138@2506: 
peter1138@10043: static ChangeInfoResult CargoChangeInfo(uint cid, int numinfo, int prop, byte **bufp, int len)
peter1138@6359: {
maedhros@7159: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
maedhros@7159: 
peter1138@6359: 	if (cid + numinfo > NUM_CARGO) {
peter1138@6359: 		grfmsg(2, "CargoChangeInfo: Cargo type %d out of range (max %d)", cid + numinfo, NUM_CARGO - 1);
peter1138@10043: 		return CIR_INVALID_ID;
peter1138@6359: 	}
peter1138@6359: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
maedhros@7159: 		CargoSpec *cs = &_cargo[cid + i];
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: /* Bit number of cargo */
maedhros@7159: 				cs->bitnum = grf_load_byte(&buf);
peter1138@6359: 				if (cs->IsValid()) {
frosch@9750: 					cs->grffile = _cur_grffile;
skidd13@7931: 					SetBit(_cargo_mask, cid + i);
peter1138@6359: 				} else {
skidd13@7929: 					ClrBit(_cargo_mask, cid + i);
peter1138@6359: 				}
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x09: /* String ID for cargo type name */
rubidium@8959: 				cs->name = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&cs->name] = _cur_grffile->grfid;
peter1138@7276: 				break;
peter1138@7276: 
peter1138@7276: 			case 0x0A: /* String for 1 unit of cargo */
rubidium@8959: 				cs->name_single = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&cs->name_single] = _cur_grffile->grfid;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0B:
maedhros@7159: 				/* String for units of cargo. This is different in OpenTTD to TTDPatch
maedhros@7159: 				 * (e.g. 10 tonnes of coal) */
rubidium@8959: 				cs->units_volume = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&cs->units_volume] = _cur_grffile->grfid;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0C: /* String for quantity of cargo (e.g. 10 tonnes of coal) */
rubidium@8959: 				cs->quantifier = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&cs->quantifier] = _cur_grffile->grfid;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0D: /* String for two letter cargo abbreviation */
rubidium@8959: 				cs->abbrev = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&cs->abbrev] = _cur_grffile->grfid;
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0E: /* Sprite ID for cargo icon */
maedhros@7159: 				cs->sprite = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0F: /* Weight of one unit of cargo */
maedhros@7159: 				cs->weight = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x10: /* Used for payment calculation */
maedhros@7159: 				cs->transit_days[0] = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x11: /* Used for payment calculation */
maedhros@7159: 				cs->transit_days[1] = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x12: /* Base cargo price */
maedhros@7159: 				cs->initial_payment = grf_load_dword(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x13: /* Colour for station rating bars */
maedhros@7159: 				cs->rating_colour = MapDOSColour(grf_load_byte(&buf));
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x14: /* Colour for cargo graph */
maedhros@7159: 				cs->legend_colour = MapDOSColour(grf_load_byte(&buf));
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x15: /* Freight status */
maedhros@7162: 				cs->is_freight = (grf_load_byte(&buf) != 0);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x16: /* Cargo classes */
maedhros@7159: 				cs->classes = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x17: /* Cargo label */
maedhros@7159: 				cs->label = grf_load_dword(&buf);
maedhros@7159: 				cs->label = BSWAP32(cs->label);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x18: { /* Town growth substitute type */
peter1138@6359: 				uint8 substitute_type = grf_load_byte(&buf);
maedhros@7159: 
peter1138@6359: 				switch (substitute_type) {
maedhros@7159: 					case 0x00: cs->town_effect = TE_PASSENGERS; break;
maedhros@7159: 					case 0x02: cs->town_effect = TE_MAIL; break;
maedhros@7159: 					case 0x05: cs->town_effect = TE_GOODS; break;
maedhros@7159: 					case 0x09: cs->town_effect = TE_WATER; break;
maedhros@7159: 					case 0x0B: cs->town_effect = TE_FOOD; break;
peter1138@6359: 					default:
peter1138@6359: 						grfmsg(1, "CargoChangeInfo: Unknown town growth substitute value %d, setting to none.", substitute_type);
maedhros@7159: 					case 0xFF: cs->town_effect = TE_NONE; break;
peter1138@6359: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			case 0x19: /* Town growth coefficient */
maedhros@7159: 				cs->multipliertowngrowth = grf_load_word(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x1A: /* Bitmask of callbacks to use */
maedhros@7159: 				cs->callback_mask = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
peter1138@6359: 	}
peter1138@6359: 
peter1138@6359: 	*bufp = buf;
peter1138@6359: 	return ret;
peter1138@6359: }
peter1138@6359: 
peter1138@6359: 
peter1138@10043: static ChangeInfoResult SoundEffectChangeInfo(uint sid, int numinfo, int prop, byte **bufp, int len)
peter1138@4656: {
peter1138@4656: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
peter1138@4656: 
peter1138@4656: 	if (_cur_grffile->sound_offset == 0) {
Darkvater@5380: 		grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping");
peter1138@10043: 		return CIR_INVALID_ID;
peter1138@4656: 	}
peter1138@4656: 
maedhros@7159: 	for (int i = 0; i < numinfo; i++) {
maedhros@7159: 		uint sound = sid + i + _cur_grffile->sound_offset - GetNumOriginalSounds();
maedhros@7159: 
maedhros@7159: 		if (sound >= GetNumSounds()) {
maedhros@7159: 			grfmsg(1, "SoundEffectChangeInfo: Sound %d not defined (max %d)", sound, GetNumSounds());
peter1138@10043: 			return CIR_INVALID_ID;
maedhros@7159: 		}
maedhros@7159: 
maedhros@7159: 		switch (prop) {
maedhros@7159: 			case 0x08: // Relative volume
maedhros@7159: 				GetSound(sound)->volume = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x09: // Priority
maedhros@7159: 				GetSound(sound)->priority = grf_load_byte(&buf);
maedhros@7159: 				break;
maedhros@7159: 
maedhros@7159: 			case 0x0A: { // Override old sound
peter1138@4656: 				uint orig_sound = grf_load_byte(&buf);
peter1138@4656: 
maedhros@7159: 				if (orig_sound >= GetNumSounds()) {
maedhros@7159: 					grfmsg(1, "SoundEffectChangeInfo: Original sound %d not defined (max %d)", orig_sound, GetNumSounds());
peter1138@4656: 				} else {
peter1138@4656: 					FileEntry *newfe = GetSound(sound);
peter1138@4656: 					FileEntry *oldfe = GetSound(orig_sound);
peter1138@4656: 
peter1138@4656: 					/* Literally copy the data of the new sound over the original */
tron@5024: 					*oldfe = *newfe;
peter1138@4656: 				}
maedhros@7159: 			} break;
maedhros@7159: 
maedhros@7159: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
maedhros@7159: 				break;
maedhros@7159: 		}
peter1138@4656: 	}
peter1138@4656: 
peter1138@4656: 	*bufp = buf;
peter1138@4656: 	return ret;
peter1138@4656: }
peter1138@4656: 
peter1138@10043: static ChangeInfoResult IndustrytilesChangeInfo(uint indtid, int numinfo, int prop, byte **bufp, int len)
belugas@7217: {
belugas@7217: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
belugas@7217: 
belugas@7217: 	if (indtid + numinfo > NUM_INDUSTRYTILES) {
belugas@7217: 		grfmsg(1, "IndustryTilesChangeInfo: Too many industry tiles loaded (%u), max (%u). Ignoring.", indtid + numinfo, NUM_INDUSTRYTILES);
peter1138@10043: 		return CIR_INVALID_ID;
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	/* Allocate industry tile specs if they haven't been allocated already. */
belugas@7217: 	if (_cur_grffile->indtspec == NULL) {
belugas@7217: 		_cur_grffile->indtspec = CallocT<IndustryTileSpec*>(NUM_INDUSTRYTILES);
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	for (int i = 0; i < numinfo; i++) {
belugas@7217: 		IndustryTileSpec *tsp = _cur_grffile->indtspec[indtid + i];
belugas@7217: 
belugas@7217: 		if (prop != 0x08 && tsp == NULL) {
belugas@7217: 			grfmsg(2, "IndustryTilesChangeInfo: Attempt to modify undefined industry tile %u. Ignoring.", indtid + i);
peter1138@10043: 			return CIR_INVALID_ID;
belugas@7217: 		}
belugas@7217: 
belugas@7217: 		switch (prop) {
belugas@7217: 			case 0x08: { // Substitute industry tile type
belugas@7217: 				IndustryTileSpec **tilespec = &_cur_grffile->indtspec[indtid + i];
belugas@7217: 				byte subs_id = grf_load_byte(&buf);
belugas@7217: 
belugas@7459: 				if (subs_id >= NEW_INDUSTRYTILEOFFSET) {
belugas@7217: 					/* The substitute id must be one of the original industry tile. */
belugas@7217: 					grfmsg(2, "IndustryTilesChangeInfo: Attempt to use new industry tile %u as substitute industry tile for %u. Ignoring.", subs_id, indtid + i);
peter1138@10041: 					continue;
belugas@7217: 				}
belugas@7217: 
belugas@7217: 				/* Allocate space for this industry. */
belugas@7217: 				if (*tilespec == NULL) {
belugas@7217: 					int tempid;
belugas@7217: 					*tilespec = CallocT<IndustryTileSpec>(1);
belugas@7217: 					tsp = *tilespec;
belugas@7217: 
belugas@7217: 					memcpy(tsp, &_industry_tile_specs[subs_id], sizeof(_industry_tile_specs[subs_id]));
belugas@7217: 					tsp->enabled = true;
belugas@8104: 
belugas@8104: 					/* A copied tile should not have the animation infos copied too.
belugas@8104: 					 * The anim_state should be left untouched, though
belugas@8104: 					 * It is up to the author to animate them himself */
belugas@8104: 					tsp->anim_production = INDUSTRYTILE_NOANIM;
belugas@8104: 					tsp->anim_next = INDUSTRYTILE_NOANIM;
belugas@8104: 
belugas@7217: 					tsp->grf_prop.local_id = indtid + i;
belugas@7217: 					tsp->grf_prop.subst_id = subs_id;
belugas@7217: 					tsp->grf_prop.grffile = _cur_grffile;
belugas@7217: 					tempid = _industile_mngr.AddEntityID(indtid + i, _cur_grffile->grfid, subs_id); // pre-reserve the tile slot
belugas@7217: 				}
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x09: { // Industry tile override
belugas@7217: 				byte ovrid = grf_load_byte(&buf);
belugas@7217: 
belugas@7217: 				/* The industry being overridden must be an original industry. */
belugas@7217: 				if (ovrid >= NEW_INDUSTRYTILEOFFSET) {
belugas@7217: 					grfmsg(2, "IndustryTilesChangeInfo: Attempt to override new industry tile %u with industry tile id %u. Ignoring.", ovrid, indtid + i);
peter1138@10041: 					continue;
belugas@7217: 				}
belugas@7217: 
glx@7873: 				_industile_mngr.Add(indtid + i, _cur_grffile->grfid, ovrid);
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x0A: // Tile acceptance
belugas@7217: 			case 0x0B:
belugas@7217: 			case 0x0C: {
belugas@7217: 				uint16 acctp = grf_load_word(&buf);
glx@7988: 				tsp->accepts_cargo[prop - 0x0A] = GetCargoTranslation(GB(acctp, 0, 8), _cur_grffile);
belugas@7631: 				tsp->acceptance[prop - 0x0A] = GB(acctp, 8, 8);
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x0D: // Land shape flags
belugas@7217: 				tsp->slopes_refused = (Slope)grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0E: // Callback flags
belugas@7217: 				tsp->callback_flags = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0F: // Animation information
rubidium@7229: 				tsp->animation_info = grf_load_word(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x10: // Animation speed
rubidium@7229: 				tsp->animation_speed = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x11: // Triggers for callback 25
rubidium@7229: 				tsp->animation_triggers = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x12: // Special flags
rubidium@7229: 				tsp->animation_special_flags = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
belugas@7217: 				break;
belugas@7217: 		}
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	*bufp = buf;
belugas@7217: 	return ret;
belugas@7217: }
belugas@7217: 
peter1138@10043: static ChangeInfoResult IndustriesChangeInfo(uint indid, int numinfo, int prop, byte **bufp, int len)
belugas@7217: {
belugas@7217: 	byte *buf = *bufp;
peter1138@10043: 	ChangeInfoResult ret = CIR_SUCCESS;
belugas@7217: 
belugas@7217: 	if (indid + numinfo > NUM_INDUSTRYTYPES) {
belugas@7217: 		grfmsg(1, "IndustriesChangeInfo: Too many industries loaded (%u), max (%u). Ignoring.", indid + numinfo, NUM_INDUSTRYTYPES);
peter1138@10043: 		return CIR_INVALID_ID;
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	grfmsg(1, "IndustriesChangeInfo: newid %u", indid);
belugas@7217: 
belugas@7217: 	/* Allocate industry specs if they haven't been allocated already. */
belugas@7217: 	if (_cur_grffile->industryspec == NULL) {
belugas@7217: 		_cur_grffile->industryspec = CallocT<IndustrySpec*>(NUM_INDUSTRYTYPES);
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	for (int i = 0; i < numinfo; i++) {
belugas@7217: 		IndustrySpec *indsp = _cur_grffile->industryspec[indid + i];
belugas@7217: 
belugas@7217: 		if (prop != 0x08 && indsp == NULL) {
belugas@7217: 			grfmsg(2, "IndustriesChangeInfo: Attempt to modify undefined industry %u. Ignoring.", indid + i);
peter1138@10043: 			return CIR_INVALID_ID;
belugas@7217: 		}
belugas@7217: 
belugas@7217: 		switch (prop) {
belugas@7217: 			case 0x08: { // Substitute industry type
belugas@7217: 				IndustrySpec **indspec = &_cur_grffile->industryspec[indid + i];
belugas@7217: 				byte subs_id = grf_load_byte(&buf);
belugas@7217: 
belugas@7217: 				if (subs_id == 0xFF) {
belugas@7217: 					/* Instead of defining a new industry, a substitute industry id
belugas@7217: 					 * of 0xFF disables the old industry with the current id. */
belugas@7217: 					_industry_specs[indid + i].enabled = false;
belugas@7217: 					continue;
belugas@7217: 				} else if (subs_id >= NEW_INDUSTRYOFFSET) {
belugas@7217: 					/* The substitute id must be one of the original industry. */
belugas@7217: 					grfmsg(2, "_industry_specs: Attempt to use new industry %u as substitute industry for %u. Ignoring.", subs_id, indid + i);
peter1138@10041: 					continue;
belugas@7217: 				}
belugas@7217: 
belugas@7217: 				/* Allocate space for this industry.
belugas@7217: 				 * Only need to do it once. If ever it is called again, it should not
belugas@7217: 				 * do anything */
belugas@7217: 				if (*indspec == NULL) {
belugas@7217: 					*indspec = CallocT<IndustrySpec>(1);
belugas@7217: 					indsp = *indspec;
belugas@7217: 
belugas@7217: 					memcpy(indsp, &_origin_industry_specs[subs_id], sizeof(_industry_specs[subs_id]));
belugas@7217: 					indsp->enabled = true;
belugas@7217: 					indsp->grf_prop.local_id = indid + i;
belugas@7217: 					indsp->grf_prop.subst_id = subs_id;
belugas@7217: 					indsp->grf_prop.grffile = _cur_grffile;
belugas@7716: 					/* If the grf industry needs to check its surounding upon creation, it should
belugas@7716: 					 * rely on callbacks, not on the original placement functions */
belugas@7716: 					indsp->check_proc = CHECK_NOTHING;
belugas@7217: 				}
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x09: { // Industry type override
belugas@7217: 				byte ovrid = grf_load_byte(&buf);
belugas@7217: 
belugas@7217: 				/* The industry being overridden must be an original industry. */
belugas@7217: 				if (ovrid >= NEW_INDUSTRYOFFSET) {
belugas@7217: 					grfmsg(2, "IndustriesChangeInfo: Attempt to override new industry %u with industry id %u. Ignoring.", ovrid, indid + i);
peter1138@10041: 					continue;
belugas@7217: 				}
belugas@7217: 				indsp->grf_prop.override = ovrid;
glx@7873: 				_industry_mngr.Add(indid + i, _cur_grffile->grfid, ovrid);
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x0A: { // Set industry layout(s)
belugas@7217: 				indsp->num_table = grf_load_byte(&buf); // Number of layaouts
belugas@7217: 				uint32 defsize = grf_load_dword(&buf);  // Total size of the definition
belugas@7217: 				IndustryTileTable **tile_table = CallocT<IndustryTileTable*>(indsp->num_table); // Table with tiles to compose an industry
belugas@7217: 				IndustryTileTable *itt = CallocT<IndustryTileTable>(defsize); // Temporary array to read the tile layouts from the GRF
belugas@7217: 				int size;
belugas@7217: 				IndustryTileTable *copy_from;
belugas@7217: 
belugas@7217: 				for (byte j = 0; j < indsp->num_table; j++) {
belugas@7217: 					for (int k = 0;; k++) {
belugas@7217: 						itt[k].ti.x = grf_load_byte(&buf); // Offsets from northermost tile
belugas@7217: 
belugas@7217: 						if (itt[k].ti.x == 0xFE && k == 0) {
belugas@7217: 							/* This means we have to borrow the layout from an old industry */
belugas@7217: 							IndustryType type = grf_load_byte(&buf);  //industry holding required layout
belugas@7217: 							byte laynbr = grf_load_byte(&buf);        //layout number to borrow
belugas@7217: 
belugas@7217: 							copy_from = (IndustryTileTable*)_origin_industry_specs[type].table[laynbr];
belugas@7217: 							for (size = 1;; size++) {
belugas@7746: 								if (copy_from[size - 1].ti.x == -0x80 && copy_from[size - 1].ti.y == 0) break;
belugas@7217: 							}
belugas@7217: 							break;
belugas@7217: 						}
belugas@7217: 
belugas@7217: 						itt[k].ti.y = grf_load_byte(&buf); // Or table definition finalisation
belugas@7217: 
belugas@7217: 						if (itt[k].ti.x == 0 && itt[k].ti.y == 0x80) {
belugas@7217: 							/*  Not the same terminator.  The one we are using is rather
belugas@7217: 							 x= -80, y = x .  So, adjust it. */
belugas@7217: 							itt[k].ti.x = -0x80;
belugas@7217: 							itt[k].ti.y =  0;
belugas@7217: 							itt[k].gfx  =  0;
belugas@7217: 
belugas@7217: 							size = k + 1;
belugas@7217: 							copy_from = itt;
belugas@7217: 							break;
belugas@7217: 						}
belugas@7217: 
belugas@7217: 						itt[k].gfx = grf_load_byte(&buf);
belugas@7217: 
belugas@7217: 						if (itt[k].gfx == 0xFE) {
belugas@7217: 							/* Use a new tile from this GRF */
belugas@7217: 							int local_tile_id = grf_load_word(&buf);
belugas@7217: 
belugas@7217: 							/* Read the ID from the _industile_mngr. */
belugas@7217: 							int tempid = _industile_mngr.GetID(local_tile_id, _cur_grffile->grfid);
belugas@7217: 
belugas@7217: 							if (tempid == INVALID_INDUSTRYTILE) {
belugas@7217: 								grfmsg(2, "IndustriesChangeInfo: Attempt to use industry tile %u with industry id %u, not yet defined. Ignoring.", local_tile_id, indid);
belugas@7217: 							} else {
belugas@7217: 								/* Declared as been valid, can be used */
belugas@7217: 								itt[k].gfx = tempid;
belugas@7217: 								size = k + 1;
belugas@7217: 								copy_from = itt;
belugas@7217: 							}
belugas@7630: 						} else if (itt[k].gfx == 0xFF) {
belugas@7630: 							itt[k].ti.x = (int8)GB(itt[k].ti.x, 0, 8);
belugas@7630: 							itt[k].ti.y = (int8)GB(itt[k].ti.y, 0, 8);
belugas@7633: 						}
belugas@7217: 					}
belugas@7217: 					tile_table[j] = CallocT<IndustryTileTable>(size);
belugas@7217: 					memcpy(tile_table[j], copy_from, sizeof(*copy_from) * size);
belugas@7217: 				}
belugas@7217: 				/* Install final layout construction in the industry spec */
belugas@7217: 				indsp->table = tile_table;
skidd13@7931: 				SetBit(indsp->cleanup_flag, 1);
belugas@7217: 				free(itt);
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x0B: // Industry production flags
belugas@7217: 				indsp->life_type = (IndustryLifeType)grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0C: // Industry closure message
rubidium@8959: 				indsp->closure_text = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->closure_text] = _cur_grffile->grfid;
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0D: // Production increase message
rubidium@8959: 				indsp->production_up_text = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->production_up_text] = _cur_grffile->grfid;
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0E: // Production decrease message
rubidium@8959: 				indsp->production_down_text = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->production_down_text] = _cur_grffile->grfid;
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x0F: // Fund cost multiplier
belugas@7217: 				indsp->cost_multiplier = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x10: // Production cargo types
belugas@7217: 				for (byte j = 0; j < 2; j++) {
glx@7988: 					indsp->produced_cargo[j] = GetCargoTranslation(grf_load_byte(&buf), _cur_grffile);
belugas@7217: 				}
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x11: // Acceptance cargo types
belugas@7217: 				for (byte j = 0; j < 3; j++) {
glx@7988: 					indsp->accepts_cargo[j] = GetCargoTranslation(grf_load_byte(&buf), _cur_grffile);
belugas@7217: 				}
belugas@7217: 				grf_load_byte(&buf); // Unnused, eat it up
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x12: // Production multipliers
belugas@7217: 			case 0x13:
belugas@7217: 				indsp->production_rate[prop - 0x12] = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x14: // Minimal amount of cargo distributed
belugas@7217: 				indsp->minimal_cargo = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x15: { // Random sound effects
belugas@7217: 				indsp->number_of_sounds = grf_load_byte(&buf);
belugas@7217: 				uint8 *sounds = MallocT<uint8>(indsp->number_of_sounds);
belugas@7217: 
belugas@7217: 				for (uint8 j = 0; j < indsp->number_of_sounds; j++) sounds[j] = grf_load_byte(&buf);
belugas@7217: 				indsp->random_sounds = sounds;
skidd13@7931: 				SetBit(indsp->cleanup_flag, 0);
belugas@7217: 			} break;
belugas@7217: 
belugas@7217: 			case 0x16: // Conflicting industry types
belugas@7217: 				for (byte j = 0; j < 3; j++) indsp->conflicting[j] = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x17: // Probability in random game
rubidium@9413: 				indsp->appear_creation[_settings_game.game_creation.landscape] = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x18: // Probability during gameplay
rubidium@9413: 				indsp->appear_ingame[_settings_game.game_creation.landscape] = grf_load_byte(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x19: // Map color
belugas@7217: 				indsp->map_colour = MapDOSColour(grf_load_byte(&buf));
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x1A: // Special industry flags to define special behavior
glx@7757: 				indsp->behaviour = (IndustryBehaviour)grf_load_dword(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x1B: // New industry text ID
rubidium@8959: 				indsp->new_industry_text = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->new_industry_text] = _cur_grffile->grfid;
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x1C: // Input cargo multipliers for the three input cargo types
belugas@7217: 			case 0x1D:
belugas@7217: 			case 0x1E: {
belugas@7217: 					uint32 multiples = grf_load_dword(&buf);
rubidium@8969: 					indsp->input_cargo_multiplier[prop - 0x1C][0] = GB(multiples, 0, 15);
rubidium@8969: 					indsp->input_cargo_multiplier[prop - 0x1C][1] = GB(multiples, 15, 15);
belugas@7217: 				} break;
belugas@7217: 
belugas@7217: 			case 0x1F: // Industry name
rubidium@8959: 				indsp->name = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->name] = _cur_grffile->grfid;
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x20: // Prospecting success chance
belugas@7217: 				indsp->prospecting_chance = grf_load_dword(&buf);
belugas@7217: 				break;
belugas@7217: 
belugas@7217: 			case 0x21:   // Callback flags
belugas@7217: 			case 0x22: { // Callback additional flags
belugas@7217: 				byte aflag = grf_load_byte(&buf);
belugas@7217: 				SB(indsp->callback_flags, (prop - 0x21) * 8, 8, aflag);
belugas@7217: 			} break;
belugas@7217: 
belugas@7978: 			case 0x23: // removal cost multiplier
belugas@7978: 				indsp->removal_cost_multiplier = grf_load_dword(&buf);
belugas@7978: 				break;
belugas@7978: 
belugas@8470: 			case 0x24: // name for nearby station
rubidium@8959: 				indsp->station_name = grf_load_word(&buf);
rubidium@8959: 				_string_to_grf_mapping[&indsp->station_name] = _cur_grffile->grfid;
belugas@8470: 				break;
belugas@8470: 
belugas@7217: 			default:
peter1138@10043: 				ret = CIR_UNKNOWN;
belugas@7217: 				break;
belugas@7217: 		}
belugas@7217: 	}
belugas@7217: 
belugas@7217: 	*bufp = buf;
belugas@7217: 	return ret;
belugas@7217: }
belugas@7217: 
dominik@452: /* Action 0x00 */
glx@9146: static void FeatureChangeInfo(byte *buf, size_t len)
dominik@452: {
dominik@452: 	byte *bufend = buf + len;
dominik@452: 
dominik@452: 	/* <00> <feature> <num-props> <num-info> <id> (<property <new-info>)...
dominik@452: 	 *
dominik@452: 	 * B feature       0, 1, 2 or 3 for trains, road vehicles, ships or planes
dominik@452: 	 *                 4 for defining new train station sets
dominik@452: 	 * B num-props     how many properties to change per vehicle/station
dominik@452: 	 * B num-info      how many vehicles/stations to change
glx@7892: 	 * E id            ID of first vehicle/station to change, if num-info is
dominik@452: 	 *                 greater than one, this one and the following
dominik@452: 	 *                 vehicles/stations will be changed
dominik@452: 	 * B property      what property to change, depends on the feature
dominik@452: 	 * V new-info      new bytes of info (variable size; depends on properties) */
dominik@452: 	/* TODO: Bridges, town houses. */
dominik@452: 
peter1138@2438: 	static const VCI_Handler handler[] = {
belugas@3825: 		/* GSF_TRAIN */        RailVehicleChangeInfo,
belugas@3825: 		/* GSF_ROAD */         RoadVehicleChangeInfo,
belugas@3825: 		/* GSF_SHIP */         ShipVehicleChangeInfo,
belugas@3825: 		/* GSF_AIRCRAFT */     AircraftVehicleChangeInfo,
belugas@3825: 		/* GSF_STATION */      StationChangeInfo,
peter1138@8372: 		/* GSF_CANAL */        CanalChangeInfo,
belugas@3825: 		/* GSF_BRIDGE */       BridgeChangeInfo,
maedhros@6332: 		/* GSF_TOWNHOUSE */    TownHouseChangeInfo,
maedhros@8478: 		/* GSF_GLOBALVAR */    GlobalVarChangeInfo,
belugas@7217: 		/* GSF_INDUSTRYTILES */IndustrytilesChangeInfo,
belugas@7217: 		/* GSF_INDUSTRIES */   IndustriesChangeInfo,
peter1138@6359: 		/* GSF_CARGOS */       NULL, /* Cargo is handled during reservation */
peter1138@4656: 		/* GSF_SOUNDFX */      SoundEffectChangeInfo,
dominik@452: 	};
dominik@452: 
peter1138@5590: 	if (!check_length(len, 6, "FeatureChangeInfo")) return;
peter1138@3714: 	buf++;
peter1138@6281: 	uint8 feature  = grf_load_byte(&buf);
peter1138@6281: 	uint8 numprops = grf_load_byte(&buf);
belugas@6288: 	uint numinfo  = grf_load_byte(&buf);
glx@7892: 	uint engine   = grf_load_extended(&buf);
dominik@452: 
Darkvater@5380: 	grfmsg(6, "FeatureChangeInfo: feature %d, %d properties, to apply to %d+%d",
dominik@452: 	               feature, numprops, engine, numinfo);
dominik@452: 
peter1138@2440: 	if (feature >= lengthof(handler) || handler[feature] == NULL) {
Darkvater@5380: 		grfmsg(1, "FeatureChangeInfo: Unsupported feature %d, skipping", feature);
dominik@452: 		return;
dominik@452: 	}
dominik@452: 
dominik@452: 	while (numprops-- && buf < bufend) {
dominik@452: 		uint8 prop = grf_load_byte(&buf);
peter1138@10038: 
peter1138@10043: 		ChangeInfoResult cir = handler[feature](engine, numinfo, prop, &buf, bufend - buf);
peter1138@10043: 		switch (cir) {
peter1138@10043: 			case CIR_SUCCESS:
peter1138@10043: 				break;
peter1138@10043: 
peter1138@10043: 			case CIR_UNHANDLED:
peter1138@10043: 				grfmsg(1, "FeatureChangeInfo: Ignoring property 0x%02X of feature 0x%02X (not implemented)", prop, feature);
peter1138@10043: 				break;
peter1138@10043: 
peter1138@10043: 			case CIR_UNKNOWN:
peter1138@10043: 				grfmsg(0, "FeatureChangeInfo: Unknown property 0x%02X of feature 0x%02X, disabling", prop, feature);
peter1138@10043: 				/* Fall through */
peter1138@10043: 
peter1138@10043: 			case CIR_INVALID_ID:
peter1138@10043: 				/* No debug message for an invalid ID, as it has already been output */
peter1138@10043: 				_skip_sprites = -1;
peter1138@10043: 				_cur_grfconfig->status = GCS_DISABLED;
peter1138@10043: 				_cur_grfconfig->error  = CallocT<GRFError>(1);
peter1138@10043: 				_cur_grfconfig->error->severity = STR_NEWGRF_ERROR_MSG_FATAL;
peter1138@10043: 				_cur_grfconfig->error->message  = (cir == CIR_INVALID_ID) ? STR_NEWGRF_ERROR_INVALID_ID : STR_NEWGRF_ERROR_UNKNOWN_PROPERTY;
peter1138@10043: 				return;
dominik@452: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@5525: /* Action 0x00 (GLS_SAFETYSCAN) */
glx@9146: static void SafeChangeInfo(byte *buf, size_t len)
peter1138@5525: {
peter1138@5590: 	if (!check_length(len, 6, "SafeChangeInfo")) return;
peter1138@5525: 	buf++;
peter1138@6281: 	uint8 feature  = grf_load_byte(&buf);
peter1138@6281: 	uint8 numprops = grf_load_byte(&buf);
glx@7892: 	grf_load_byte(&buf);     // num-info
glx@7892: 	grf_load_extended(&buf); // id
peter1138@5525: 
peter1138@5525: 	if (feature == GSF_BRIDGE && numprops == 1) {
peter1138@5525: 		uint8 prop = grf_load_byte(&buf);
peter1138@5525: 		/* Bridge property 0x0D is redefinition of sprite layout tables, which
peter1138@5525: 		 * is considered safe. */
peter1138@5525: 		if (prop == 0x0D) return;
peter1138@5525: 	}
peter1138@5525: 
skidd13@7931: 	SetBit(_cur_grfconfig->flags, GCF_UNSAFE);
peter1138@5525: 
peter1138@5525: 	/* Skip remainder of GRF */
peter1138@5525: 	_skip_sprites = -1;
peter1138@5525: }
peter1138@5525: 
peter1138@6359: /* Action 0x00 (GLS_RESERVE) */
glx@9146: static void ReserveChangeInfo(byte *buf, size_t len)
peter1138@6359: {
peter1138@6359: 	byte *bufend = buf + len;
peter1138@6359: 
maedhros@8478: 	if (!check_length(len, 6, "ReserveChangeInfo")) return;
peter1138@6359: 	buf++;
peter1138@6359: 	uint8 feature  = grf_load_byte(&buf);
peter1138@6359: 
glx@7941: 	if (feature != GSF_CARGOS && feature != GSF_GLOBALVAR) return;
peter1138@6359: 
peter1138@6359: 	uint8 numprops = grf_load_byte(&buf);
peter1138@6359: 	uint8 numinfo  = grf_load_byte(&buf);
glx@7892: 	uint8 index    = grf_load_extended(&buf);
peter1138@6359: 
peter1138@6359: 	while (numprops-- && buf < bufend) {
peter1138@6359: 		uint8 prop = grf_load_byte(&buf);
glx@7941: 		bool ignoring = false;
glx@7941: 
glx@7941: 		switch (feature) {
glx@7941: 			default: NOT_REACHED();
glx@7941: 			case GSF_CARGOS:
glx@7941: 				ignoring = CargoChangeInfo(index, numinfo, prop, &buf, bufend - buf);
glx@7941: 				break;
glx@7941: 			case GSF_GLOBALVAR:
maedhros@8478: 				switch (prop) {
maedhros@8478: 					case 0x09: // Cargo Translation Table
maedhros@8478: 						if (index != 0) {
maedhros@8478: 							grfmsg(1, "ReserveChangeInfo: Cargo translation table must start at zero");
maedhros@8478: 							return;
maedhros@8478: 						}
maedhros@8478: 
maedhros@8478: 						free(_cur_grffile->cargo_list);
maedhros@8478: 						_cur_grffile->cargo_max = numinfo;
maedhros@8478: 						_cur_grffile->cargo_list = MallocT<CargoLabel>(numinfo);
maedhros@8478: 
maedhros@8478: 						for (uint i = 0; i < numinfo; i++) {
maedhros@8478: 							CargoLabel cl = grf_load_dword(&buf);
maedhros@8478: 							_cur_grffile->cargo_list[i] = BSWAP32(cl);
maedhros@8478: 						}
maedhros@8478: 						break;
peter1138@9070: 
peter1138@9070: 					case 0x11: // GRF match for engine allocation
peter1138@9070: 						for (uint i = 0; i < numinfo; i++) {
peter1138@9070: 							uint32 s = grf_load_dword(&buf);
peter1138@9070: 							uint32 t = grf_load_dword(&buf);
peter1138@9070: 							SetNewGRFOverride(s, t);
peter1138@9070: 						}
peter1138@9070: 						break;
maedhros@8478: 				}
glx@7941: 				break;
peter1138@6359: 		}
glx@7941: 
glx@7941: 		if (ignoring) grfmsg(2, "ReserveChangeInfo: Ignoring property 0x%02X (not implemented)", prop);
peter1138@6359: 	}
peter1138@6359: }
peter1138@6359: 
hackykid@1883: /**
hackykid@1883:  * Creates a spritegroup representing a callback result
hackykid@1883:  * @param value The value that was used to represent this callback result
hackykid@1883:  * @return A spritegroup representing that callback result
hackykid@1883:  */
peter1138@4893: static const SpriteGroup* NewCallBackResultSpriteGroup(uint16 value)
hackykid@1883: {
peter1138@3595: 	SpriteGroup *group = AllocateSpriteGroup();
hackykid@1883: 
peter1138@2488: 	group->type = SGT_CALLBACK;
hackykid@1883: 
belugas@6348: 	/* Old style callback results have the highest byte 0xFF so signify it is a callback result
belugas@6348: 	 * New style ones only have the highest bit set (allows 15-bit results, instead of just 8) */
tron@3033: 	if ((value >> 8) == 0xFF) {
tron@3033: 		value &= ~0xFF00;
tron@3033: 	} else {
hackykid@1883: 		value &= ~0x8000;
tron@3033: 	}
hackykid@1883: 
peter1138@2488: 	group->g.callback.result = value;
hackykid@1883: 
hackykid@1883: 	return group;
hackykid@1883: }
dominik@452: 
peter1138@2489: /**
peter1138@2489:  * Creates a spritegroup representing a sprite number result.
belugas@6481:  * @param sprite The sprite number.
belugas@6481:  * @param num_sprites The number of sprites per set.
peter1138@2489:  * @return A spritegroup representing the sprite number result.
peter1138@2489:  */
peter1138@4893: static const SpriteGroup* NewResultSpriteGroup(SpriteID sprite, byte num_sprites)
peter1138@2489: {
peter1138@3595: 	SpriteGroup *group = AllocateSpriteGroup();
peter1138@2489: 	group->type = SGT_RESULT;
peter1138@3668: 	group->g.result.sprite = sprite;
peter1138@3668: 	group->g.result.num_sprites = num_sprites;
peter1138@2489: 	return group;
peter1138@2489: }
peter1138@2489: 
dominik@452: /* Action 0x01 */
glx@9146: static void NewSpriteSet(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <01> <feature> <num-sets> <num-ent>
dominik@452: 	 *
dominik@452: 	 * B feature       feature to define sprites for
dominik@452: 	 *                 0, 1, 2, 3: veh-type, 4: train stations
dominik@452: 	 * B num-sets      number of sprite sets
tron@2346: 	 * E num-ent       how many entries per sprite set
dominik@452: 	 *                 For vehicles, this is the number of different
dominik@452: 	 *                         vehicle directions in each sprite set
dominik@452: 	 *                         Set num-dirs=8, unless your sprites are symmetric.
dominik@452: 	 *                         In that case, use num-dirs=4.
peter1138@6281: 	 */
dominik@452: 
peter1138@5590: 	if (!check_length(len, 4, "NewSpriteSet")) return;
tron@2346: 	buf++;
peter1138@6281: 	uint8 feature   = grf_load_byte(&buf);
peter1138@6281: 	uint8 num_sets  = grf_load_byte(&buf);
peter1138@6281: 	uint16 num_ents = grf_load_extended(&buf);
dominik@452: 
tron@2342: 	_cur_grffile->spriteset_start = _cur_spriteid;
dominik@452: 	_cur_grffile->spriteset_feature = feature;
tron@2342: 	_cur_grffile->spriteset_numsets = num_sets;
tron@2342: 	_cur_grffile->spriteset_numents = num_ents;
tron@2342: 
Darkvater@5380: 	grfmsg(7, "New sprite set at %d of type %d, consisting of %d sets with %d views each (total %d)",
tron@2342: 		_cur_spriteid, feature, num_sets, num_ents, num_sets * num_ents
tron@2342: 	);
tron@2342: 
peter1138@8282: 	for (int i = 0; i < num_sets * num_ents; i++) {
rubidium@7953: 		_nfo_line++;
truelight@6908: 		LoadNextSprite(_cur_spriteid++, _file_index, _nfo_line);
tron@2342: 	}
dominik@452: }
dominik@452: 
peter1138@6576: /* Action 0x01 (SKIP) */
glx@9146: static void SkipAct1(byte *buf, size_t len)
peter1138@6576: {
peter1138@6576: 	if (!check_length(len, 4, "SkipAct1")) return;
peter1138@6576: 	buf++;
peter1138@6576: 	grf_load_byte(&buf);
peter1138@6576: 	uint8 num_sets  = grf_load_byte(&buf);
peter1138@6576: 	uint16 num_ents = grf_load_extended(&buf);
peter1138@6576: 
peter1138@6576: 	_skip_sprites = num_sets * num_ents;
peter1138@6576: 
peter1138@6576: 	grfmsg(3, "SkipAct1: Skipping %d sprites", _skip_sprites);
peter1138@6576: }
peter1138@6576: 
peter1138@3666: /* Helper function to either create a callback or link to a previously
peter1138@3666:  * defined spritegroup. */
peter1138@4893: static const SpriteGroup* GetGroupFromGroupID(byte setid, byte type, uint16 groupid)
peter1138@3666: {
skidd13@7928: 	if (HasBit(groupid, 15)) return NewCallBackResultSpriteGroup(groupid);
peter1138@3666: 
peter1138@3666: 	if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) {
belugas@6477: 		grfmsg(1, "GetGroupFromGroupID(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid);
peter1138@3666: 		return NULL;
peter1138@3666: 	}
peter1138@3666: 
peter1138@3666: 	return _cur_grffile->spritegroups[groupid];
peter1138@3666: }
peter1138@3666: 
peter1138@3666: /* Helper function to either create a callback or a result sprite group. */
peter1138@4893: static const SpriteGroup* CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid, uint16 num_sprites)
peter1138@3666: {
skidd13@7928: 	if (HasBit(spriteid, 15)) return NewCallBackResultSpriteGroup(spriteid);
peter1138@3666: 
peter1138@3667: 	if (spriteid >= _cur_grffile->spriteset_numsets) {
belugas@6477: 		grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set %u invalid, max %u", setid, type, spriteid, _cur_grffile->spriteset_numsets);
peter1138@3667: 		return NULL;
peter1138@3667: 	}
peter1138@3667: 
peter1138@3666: 	/* Check if the sprite is within range. This can fail if the Action 0x01
peter1138@3666: 	 * is skipped, as TTDPatch mandates that Action 0x02s must be processed.
peter1138@3666: 	 * We don't have that rule, but must live by the Patch... */
peter1138@3666: 	if (_cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites > _cur_spriteid) {
belugas@6477: 		grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Real Sprite IDs 0x%04X - 0x%04X do not (all) exist (max 0x%04X), leaving empty",
peter1138@3666: 				setid, type,
peter1138@3666: 				_cur_grffile->spriteset_start + spriteid * num_sprites,
peter1138@3666: 				_cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites - 1, _cur_spriteid - 1);
peter1138@3666: 		return NULL;
peter1138@3666: 	}
peter1138@3666: 
peter1138@3803: 	if (feature != _cur_grffile->spriteset_feature) {
belugas@6477: 		grfmsg(1, "CreateGroupFromGroupID(0x%02X:0x%02X): Sprite set feature 0x%02X does not match action feature 0x%02X, skipping",
peter1138@6885: 				setid, type,
peter1138@3803: 				_cur_grffile->spriteset_feature, feature);
peter1138@3803: 		return NULL;
peter1138@3803: 	}
peter1138@3803: 
peter1138@3666: 	return NewResultSpriteGroup(_cur_grffile->spriteset_start + spriteid * num_sprites, num_sprites);
peter1138@3666: }
peter1138@3666: 
dominik@452: /* Action 0x02 */
glx@9146: static void NewSpriteGroup(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <02> <feature> <set-id> <type/num-entries> <feature-specific-data...>
dominik@452: 	 *
dominik@452: 	 * B feature       see action 1
dominik@452: 	 * B set-id        ID of this particular definition
dominik@452: 	 * B type/num-entries
dominik@452: 	 *                 if 80 or greater, this is a randomized or variational
dominik@452: 	 *                 list definition, see below
dominik@452: 	 *                 otherwise it specifies a number of entries, the exact
dominik@452: 	 *                 meaning depends on the feature
dominik@452: 	 * V feature-specific-data (huge mess, don't even look it up --pasky) */
peter1138@3633: 	SpriteGroup *group = NULL;
peter1138@3633: 	byte *bufend = buf + len;
dominik@452: 
peter1138@5590: 	if (!check_length(len, 5, "NewSpriteGroup")) return;
peter1138@3633: 	buf++;
peter1138@3633: 
peter1138@6281: 	uint8 feature = grf_load_byte(&buf);
peter1138@6281: 	uint8 setid   = grf_load_byte(&buf);
peter1138@6281: 	uint8 type    = grf_load_byte(&buf);
dominik@452: 
peter1138@2444: 	if (setid >= _cur_grffile->spritegroups_count) {
belugas@6348: 		/* Allocate memory for new sprite group references. */
KUDr@5609: 		_cur_grffile->spritegroups = ReallocT(_cur_grffile->spritegroups, setid + 1);
belugas@6348: 		/* Initialise new space to NULL */
peter1138@2488: 		for (; _cur_grffile->spritegroups_count < (setid + 1); _cur_grffile->spritegroups_count++)
peter1138@2488: 			_cur_grffile->spritegroups[_cur_grffile->spritegroups_count] = NULL;
peter1138@2444: 	}
peter1138@2444: 
peter1138@3633: 	switch (type) {
peter1138@3633: 		/* Deterministic Sprite Group */
peter1138@3633: 		case 0x81: // Self scope, byte
peter1138@3633: 		case 0x82: // Parent scope, byte
peter1138@3668: 		case 0x85: // Self scope, word
peter1138@3668: 		case 0x86: // Parent scope, word
peter1138@3668: 		case 0x89: // Self scope, dword
peter1138@3668: 		case 0x8A: // Parent scope, dword
peter1138@3633: 		{
peter1138@3668: 			byte varadjust;
peter1138@3668: 			byte varsize;
peter1138@3668: 
peter1138@3668: 			/* Check we can load the var size parameter */
peter1138@5590: 			if (!check_length(bufend - buf, 1, "NewSpriteGroup (Deterministic) (1)")) return;
peter1138@3633: 
peter1138@3633: 			group = AllocateSpriteGroup();
peter1138@3633: 			group->type = SGT_DETERMINISTIC;
skidd13@7928: 			group->g.determ.var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
peter1138@3668: 
peter1138@3668: 			switch (GB(type, 2, 2)) {
peter1138@3672: 				default: NOT_REACHED();
peter1138@3668: 				case 0: group->g.determ.size = DSG_SIZE_BYTE;  varsize = 1; break;
peter1138@3668: 				case 1: group->g.determ.size = DSG_SIZE_WORD;  varsize = 2; break;
peter1138@3668: 				case 2: group->g.determ.size = DSG_SIZE_DWORD; varsize = 4; break;
peter1138@3633: 			}
peter1138@3633: 
peter1138@5590: 			if (!check_length(bufend - buf, 5 + varsize, "NewSpriteGroup (Deterministic) (2)")) return;
peter1138@3668: 
peter1138@3668: 			/* Loop through the var adjusts. Unfortunately we don't know how many we have
peter1138@3668: 			 * from the outset, so we shall have to keep reallocing. */
peter1138@3668: 			do {
peter1138@3668: 				DeterministicSpriteGroupAdjust *adjust;
peter1138@3668: 
peter1138@3668: 				if (group->g.determ.num_adjusts > 0) {
peter1138@5590: 					if (!check_length(bufend - buf, 2 + varsize + 3, "NewSpriteGroup (Deterministic) (3)")) return;
peter1138@3668: 				}
peter1138@3668: 
peter1138@3668: 				group->g.determ.num_adjusts++;
KUDr@5609: 				group->g.determ.adjusts = ReallocT(group->g.determ.adjusts, group->g.determ.num_adjusts);
peter1138@3668: 
peter1138@3668: 				adjust = &group->g.determ.adjusts[group->g.determ.num_adjusts - 1];
peter1138@3668: 
peter1138@3668: 				/* The first var adjust doesn't have an operation specified, so we set it to add. */
rubidium@5587: 				adjust->operation = group->g.determ.num_adjusts == 1 ? DSGA_OP_ADD : (DeterministicSpriteGroupAdjustOperation)grf_load_byte(&buf);
peter1138@3668: 				adjust->variable  = grf_load_byte(&buf);
maedhros@5617: 				if (adjust->variable == 0x7E) {
maedhros@5617: 					/* Link subroutine group */
maedhros@5617: 					adjust->subroutine = GetGroupFromGroupID(setid, type, grf_load_byte(&buf));
maedhros@5617: 				} else {
skidd13@7954: 					adjust->parameter = IsInsideMM(adjust->variable, 0x60, 0x80) ? grf_load_byte(&buf) : 0;
maedhros@5617: 				}
peter1138@3668: 
peter1138@3668: 				varadjust = grf_load_byte(&buf);
peter1138@3668: 				adjust->shift_num = GB(varadjust, 0, 5);
rubidium@5587: 				adjust->type      = (DeterministicSpriteGroupAdjustType)GB(varadjust, 6, 2);
peter1138@3668: 				adjust->and_mask  = grf_load_var(varsize, &buf);
peter1138@3668: 
peter1138@3668: 				if (adjust->type != DSGA_TYPE_NONE) {
peter1138@3668: 					adjust->add_val    = grf_load_var(varsize, &buf);
peter1138@3668: 					adjust->divmod_val = grf_load_var(varsize, &buf);
peter1138@3668: 				} else {
peter1138@3668: 					adjust->add_val    = 0;
peter1138@3668: 					adjust->divmod_val = 0;
peter1138@3668: 				}
peter1138@3668: 
peter1138@3668: 				/* Continue reading var adjusts while bit 5 is set. */
skidd13@7928: 			} while (HasBit(varadjust, 5));
peter1138@3668: 
peter1138@3668: 			group->g.determ.num_ranges = grf_load_byte(&buf);
peter1138@6659: 			if (group->g.determ.num_ranges > 0) group->g.determ.ranges = CallocT<DeterministicSpriteGroupRange>(group->g.determ.num_ranges);
peter1138@3668: 
peter1138@5590: 			if (!check_length(bufend - buf, 2 + (2 + 2 * varsize) * group->g.determ.num_ranges, "NewSpriteGroup (Deterministic)")) return;
peter1138@3668: 
peter1138@6281: 			for (uint i = 0; i < group->g.determ.num_ranges; i++) {
peter1138@3668: 				group->g.determ.ranges[i].group = GetGroupFromGroupID(setid, type, grf_load_word(&buf));
peter1138@3668: 				group->g.determ.ranges[i].low   = grf_load_var(varsize, &buf);
peter1138@3668: 				group->g.determ.ranges[i].high  = grf_load_var(varsize, &buf);
peter1138@3633: 			}
peter1138@3633: 
peter1138@3668: 			group->g.determ.default_group = GetGroupFromGroupID(setid, type, grf_load_word(&buf));
peter1138@3633: 			break;
dominik@452: 		}
dominik@452: 
peter1138@3633: 		/* Randomized Sprite Group */
peter1138@3633: 		case 0x80: // Self scope
peter1138@3633: 		case 0x83: // Parent scope
glx@8756: 		case 0x84: // Relative scope
peter1138@3633: 		{
glx@8756: 			if (!check_length(bufend - buf, HasBit(type, 2) ? 8 : 7, "NewSpriteGroup (Randomized) (1)")) return;
peter1138@3633: 
peter1138@3633: 			group = AllocateSpriteGroup();
peter1138@3633: 			group->type = SGT_RANDOMIZED;
skidd13@7928: 			group->g.random.var_scope = HasBit(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF;
peter1138@3668: 
glx@8758: 			if (HasBit(type, 2)) {
glx@8758: 				if (feature <= GSF_AIRCRAFT) group->g.random.var_scope = VSG_SCOPE_RELATIVE;
glx@8756: 				group->g.random.count = grf_load_byte(&buf);
glx@8756: 			}
glx@8756: 
peter1138@6281: 			uint8 triggers = grf_load_byte(&buf);
peter1138@3668: 			group->g.random.triggers       = GB(triggers, 0, 7);
skidd13@7928: 			group->g.random.cmp_mode       = HasBit(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY;
peter1138@3668: 			group->g.random.lowest_randbit = grf_load_byte(&buf);
peter1138@3668: 			group->g.random.num_groups     = grf_load_byte(&buf);
KUDr@5609: 			group->g.random.groups = CallocT<const SpriteGroup*>(group->g.random.num_groups);
peter1138@3668: 
peter1138@5590: 			if (!check_length(bufend - buf, 2 * group->g.random.num_groups, "NewSpriteGroup (Randomized) (2)")) return;
peter1138@3668: 
peter1138@6281: 			for (uint i = 0; i < group->g.random.num_groups; i++) {
peter1138@3668: 				group->g.random.groups[i] = GetGroupFromGroupID(setid, type, grf_load_word(&buf));
peter1138@3633: 			}
peter1138@3633: 
peter1138@3633: 			break;
peter1138@2489: 		}
peter1138@3633: 
peter1138@3668: 		/* Neither a variable or randomized sprite group... must be a real group */
peter1138@3633: 		default:
peter1138@3633: 		{
peter1138@3803: 
peter1138@3803: 
peter1138@3668: 			switch (feature) {
peter1138@3668: 				case GSF_TRAIN:
peter1138@3668: 				case GSF_ROAD:
peter1138@3668: 				case GSF_SHIP:
peter1138@3668: 				case GSF_AIRCRAFT:
peter1138@3668: 				case GSF_STATION:
peter1138@6583: 				case GSF_CANAL:
peter1138@6365: 				case GSF_CARGOS:
peter1138@3668: 				{
peter1138@3668: 					byte sprites     = _cur_grffile->spriteset_numents;
peter1138@3668: 					byte num_loaded  = type;
peter1138@3668: 					byte num_loading = grf_load_byte(&buf);
peter1138@3668: 
peter1138@3668: 					if (_cur_grffile->spriteset_start == 0) {
Darkvater@5380: 						grfmsg(0, "NewSpriteGroup: No sprite set to work on! Skipping");
peter1138@3668: 						return;
peter1138@3668: 					}
peter1138@3668: 
peter1138@5590: 					if (!check_length(bufend - buf, 2 * num_loaded + 2 * num_loading, "NewSpriteGroup (Real) (1)")) return;
peter1138@3668: 
peter1138@3668: 					group = AllocateSpriteGroup();
peter1138@3668: 					group->type = SGT_REAL;
peter1138@3668: 
peter1138@3668: 					group->g.real.num_loaded  = num_loaded;
peter1138@3668: 					group->g.real.num_loading = num_loading;
KUDr@5609: 					if (num_loaded  > 0) group->g.real.loaded = CallocT<const SpriteGroup*>(num_loaded);
KUDr@5609: 					if (num_loading > 0) group->g.real.loading = CallocT<const SpriteGroup*>(num_loading);
peter1138@3668: 
Darkvater@5380: 					grfmsg(6, "NewSpriteGroup: New SpriteGroup 0x%02X, %u views, %u loaded, %u loading",
peter1138@3668: 							setid, sprites, num_loaded, num_loading);
peter1138@3668: 
peter1138@6281: 					for (uint i = 0; i < num_loaded; i++) {
peter1138@3668: 						uint16 spriteid = grf_load_word(&buf);
peter1138@3803: 						group->g.real.loaded[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites);
Darkvater@5380: 						grfmsg(8, "NewSpriteGroup: + rg->loaded[%i]  = subset %u", i, spriteid);
peter1138@3668: 					}
peter1138@3668: 
peter1138@6281: 					for (uint i = 0; i < num_loading; i++) {
peter1138@3668: 						uint16 spriteid = grf_load_word(&buf);
peter1138@3803: 						group->g.real.loading[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites);
Darkvater@5380: 						grfmsg(8, "NewSpriteGroup: + rg->loading[%i] = subset %u", i, spriteid);
peter1138@3668: 					}
peter1138@3668: 
peter1138@3668: 					break;
peter1138@3668: 				}
peter1138@3668: 
belugas@7174: 				case GSF_TOWNHOUSE:
belugas@7174: 				case GSF_INDUSTRYTILES: {
maedhros@6332: 					byte sprites     = _cur_grffile->spriteset_numents;
maedhros@6332: 					byte num_sprites = max((uint8)1, type);
maedhros@6332: 					uint i;
maedhros@6332: 
maedhros@6332: 					group = AllocateSpriteGroup();
maedhros@6332: 					group->type = SGT_TILELAYOUT;
maedhros@6332: 					group->g.layout.num_sprites = sprites;
maedhros@6332: 					group->g.layout.dts = CallocT<DrawTileSprites>(1);
maedhros@6332: 
maedhros@6332: 					/* Groundsprite */
frosch@8571: 					group->g.layout.dts->ground.sprite = grf_load_word(&buf);
frosch@8571: 					group->g.layout.dts->ground.pal    = grf_load_word(&buf);
belugas@8577: 
maedhros@6332: 					/* Remap transparent/colour modifier bits */
belugas@8577: 					MapSpriteMappingRecolour(&group->g.layout.dts->ground);
belugas@8577: 
frosch@8571: 					if (HasBit(group->g.layout.dts->ground.pal, 15)) {
maedhros@6332: 						/* Bit 31 set means this is a custom sprite, so rewrite it to the
maedhros@6332: 						 * last spriteset defined. */
frosch@8571: 						SpriteID sprite = _cur_grffile->spriteset_start + GB(group->g.layout.dts->ground.sprite, 0, 14) * sprites;
frosch@8571: 						SB(group->g.layout.dts->ground.sprite, 0, SPRITE_WIDTH, sprite);
frosch@8571: 						ClrBit(group->g.layout.dts->ground.pal, 15);
maedhros@6332: 					}
maedhros@6332: 
maedhros@6332: 					group->g.layout.dts->seq = CallocT<DrawTileSeqStruct>(num_sprites + 1);
maedhros@6332: 
maedhros@6332: 					for (i = 0; i < num_sprites; i++) {
maedhros@6332: 						DrawTileSeqStruct *seq = (DrawTileSeqStruct*)&group->g.layout.dts->seq[i];
maedhros@6332: 
frosch@8570: 						seq->image.sprite = grf_load_word(&buf);
frosch@8570: 						seq->image.pal   = grf_load_word(&buf);
maedhros@6332: 						seq->delta_x = grf_load_byte(&buf);
maedhros@6332: 						seq->delta_y = grf_load_byte(&buf);
maedhros@6332: 
belugas@8577: 						MapSpriteMappingRecolour(&seq->image);
belugas@8577: 
frosch@8570: 						if (HasBit(seq->image.pal, 15)) {
maedhros@6332: 							/* Bit 31 set means this is a custom sprite, so rewrite it to the
maedhros@6332: 							 * last spriteset defined. */
frosch@8570: 							SpriteID sprite = _cur_grffile->spriteset_start + GB(seq->image.sprite, 0, 14) * sprites;
frosch@8570: 							SB(seq->image.sprite, 0, SPRITE_WIDTH, sprite);
frosch@8570: 							ClrBit(seq->image.pal, 15);
maedhros@6332: 						}
maedhros@6332: 
maedhros@6332: 						if (type > 0) {
maedhros@6332: 							seq->delta_z = grf_load_byte(&buf);
maedhros@6332: 							if ((byte)seq->delta_z == 0x80) continue;
maedhros@6332: 						}
maedhros@6332: 
maedhros@6332: 						seq->size_x = grf_load_byte(&buf);
maedhros@6332: 						seq->size_y = grf_load_byte(&buf);
maedhros@6332: 						seq->size_z = grf_load_byte(&buf);
maedhros@6332: 					}
maedhros@6332: 
maedhros@6332: 					/* Set the terminator value. */
maedhros@6332: 					((DrawTileSeqStruct*)group->g.layout.dts->seq)[i].delta_x = (byte)0x80;
maedhros@6332: 
maedhros@6332: 					break;
maedhros@6332: 				}
maedhros@6332: 
rubidium@7168: 				case GSF_INDUSTRIES: {
rubidium@7168: 					if (type > 1) {
rubidium@7168: 						grfmsg(1, "NewSpriteGroup: Unsupported industry production version %d, skipping", type);
rubidium@7168: 						break;
rubidium@7168: 					}
rubidium@7168: 
rubidium@7168: 					group = AllocateSpriteGroup();
rubidium@7168: 					group->type = SGT_INDUSTRY_PRODUCTION;
rubidium@7168: 					group->g.indprod.version = type;
rubidium@7168: 					if (type == 0) {
rubidium@7168: 						for (uint i = 0; i < 3; i++) {
rubidium@7168: 							group->g.indprod.substract_input[i] = grf_load_word(&buf);
rubidium@7168: 						}
rubidium@7168: 						for (uint i = 0; i < 2; i++) {
rubidium@7168: 							group->g.indprod.add_output[i] = grf_load_word(&buf);
rubidium@7168: 						}
rubidium@7168: 						group->g.indprod.again = grf_load_byte(&buf);
rubidium@7168: 					} else {
rubidium@7168: 						for (uint i = 0; i < 3; i++) {
rubidium@7168: 							group->g.indprod.substract_input[i] = grf_load_byte(&buf);
rubidium@7168: 						}
rubidium@7168: 						for (uint i = 0; i < 2; i++) {
rubidium@7168: 							group->g.indprod.add_output[i] = grf_load_byte(&buf);
rubidium@7168: 						}
rubidium@7168: 						group->g.indprod.again = grf_load_byte(&buf);
rubidium@7168: 					}
rubidium@7168: 					break;
rubidium@7168: 				}
rubidium@7168: 
peter1138@3668: 				/* Loading of Tile Layout and Production Callback groups would happen here */
Darkvater@5380: 				default: grfmsg(1, "NewSpriteGroup: Unsupported feature %d, skipping", feature);
peter1138@3633: 			}
peter1138@2489: 		}
dominik@452: 	}
peter1138@2444: 
peter1138@2444: 	_cur_grffile->spritegroups[setid] = group;
dominik@452: }
dominik@452: 
peter1138@6143: static CargoID TranslateCargo(uint8 feature, uint8 ctype)
peter1138@6143: {
peter1138@6143: 	/* Special cargo types for purchase list and stations */
peter1138@6148: 	if (feature == GSF_STATION && ctype == 0xFE) return CT_DEFAULT_NA;
peter1138@6148: 	if (ctype == 0xFF) return CT_PURCHASE;
peter1138@6143: 
peter1138@6361: 	if (_cur_grffile->cargo_max == 0) {
peter1138@6361: 		/* No cargo table, so use bitnum values */
peter1138@6361: 		if (ctype >= 32) {
belugas@6477: 			grfmsg(1, "TranslateCargo: Cargo bitnum %d out of range (max 31), skipping.", ctype);
peter1138@6361: 			return CT_INVALID;
peter1138@6361: 		}
peter1138@6361: 
peter1138@6361: 		for (CargoID c = 0; c < NUM_CARGO; c++) {
peter1138@6361: 			const CargoSpec *cs = GetCargo(c);
peter1138@6361: 			if (!cs->IsValid()) continue;
peter1138@6361: 
peter1138@6361: 			if (cs->bitnum == ctype) {
belugas@6477: 				grfmsg(6, "TranslateCargo: Cargo bitnum %d mapped to cargo type %d.", ctype, c);
peter1138@6361: 				return c;
peter1138@6361: 			}
peter1138@6361: 		}
peter1138@6361: 
belugas@6477: 		grfmsg(5, "TranslateCargo: Cargo bitnum %d not available in this climate, skipping.", ctype);
peter1138@6361: 		return CT_INVALID;
peter1138@6361: 	}
peter1138@6361: 
peter1138@6143: 	/* Check if the cargo type is out of bounds of the cargo translation table */
peter1138@6361: 	if (ctype >= _cur_grffile->cargo_max) {
belugas@6477: 		grfmsg(1, "TranslateCargo: Cargo type %d out of range (max %d), skipping.", ctype, _cur_grffile->cargo_max - 1);
peter1138@6143: 		return CT_INVALID;
peter1138@6143: 	}
peter1138@6143: 
peter1138@6143: 	/* Look up the cargo label from the translation table */
peter1138@6361: 	CargoLabel cl = _cur_grffile->cargo_list[ctype];
peter1138@6143: 	if (cl == 0) {
belugas@6477: 		grfmsg(5, "TranslateCargo: Cargo type %d not available in this climate, skipping.", ctype);
peter1138@6143: 		return CT_INVALID;
peter1138@6143: 	}
peter1138@6143: 
peter1138@6143: 	ctype = GetCargoIDByLabel(cl);
peter1138@6143: 	if (ctype == CT_INVALID) {
belugas@6477: 		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));
peter1138@6143: 		return CT_INVALID;
peter1138@6143: 	}
peter1138@6143: 
belugas@6477: 	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);
peter1138@6143: 	return ctype;
peter1138@6143: }
peter1138@6143: 
peter1138@6363: 
peter1138@9445: static bool IsValidGroupID(uint16 groupid, const char *function)
peter1138@9445: {
peter1138@9445: 	if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) {
peter1138@9445: 		grfmsg(1, "%s: Spriteset 0x%04X out of range (maximum 0x%02X) or empty, skipping.", function, groupid, _cur_grffile->spritegroups_count - 1);
peter1138@9445: 		return false;
peter1138@9445: 	}
peter1138@9445: 
peter1138@9445: 	return true;
peter1138@9445: }
peter1138@9445: 
peter1138@9446: static void VehicleMapSpriteGroup(byte *buf, byte feature, uint8 idcount)
dominik@452: {
peter1138@8198: 	static EngineID *last_engines;
peter1138@8198: 	static uint last_engines_count;
peter1138@9446: 	bool wagover = false;
peter1138@9446: 
peter1138@9446: 	/* Test for 'wagon override' flag */
peter1138@9446: 	if (HasBit(idcount, 7)) {
peter1138@9446: 		wagover = true;
peter1138@9446: 		/* Strip off the flag */
peter1138@9446: 		idcount = GB(idcount, 0, 7);
peter1138@9446: 
dominik@452: 		if (last_engines_count == 0) {
belugas@6477: 			grfmsg(0, "VehicleMapSpriteGroup: WagonOverride: No engine to do override with");
dominik@452: 			return;
dominik@452: 		}
peter1138@6363: 
belugas@6477: 		grfmsg(6, "VehicleMapSpriteGroup: WagonOverride: %u engines, %u wagons",
dominik@452: 				last_engines_count, idcount);
peter1138@9446: 	} else {
peter1138@9446: 		if (last_engines_count != idcount) {
peter1138@9446: 			last_engines = ReallocT(last_engines, idcount);
peter1138@9446: 			last_engines_count = idcount;
peter1138@9446: 		}
dominik@452: 	}
dominik@452: 
smatz@9488: 	EngineID *engines = AllocaM(EngineID, idcount);
peter1138@6281: 	for (uint i = 0; i < idcount; i++) {
peter1138@9502: 		engines[i] = GetNewEngine(_cur_grffile, (VehicleType)feature, grf_load_extended(&buf))->index;
peter1138@9446: 		if (!wagover) last_engines[i] = engines[i];
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	for (uint c = 0; c < cidcount; c++) {
peter1138@9446: 		uint8 ctype = grf_load_byte(&buf);
peter1138@9446: 		uint16 groupid = grf_load_word(&buf);
peter1138@9446: 		if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) continue;
peter1138@9446: 
peter1138@9446: 		grfmsg(8, "VehicleMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid);
peter1138@9446: 
peter1138@9446: 		ctype = TranslateCargo(feature, ctype);
peter1138@9446: 		if (ctype == CT_INVALID) continue;
peter1138@9446: 
peter1138@9446: 		for (uint i = 0; i < idcount; i++) {
peter1138@9446: 			EngineID engine = engines[i];
peter1138@9446: 
peter1138@9446: 			grfmsg(7, "VehicleMapSpriteGroup: [%d] Engine %d...", i, engine);
peter1138@5338: 
dominik@452: 			if (wagover) {
peter1138@4869: 				SetWagonOverrideSprites(engine, ctype, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count);
dominik@452: 			} else {
peter1138@2444: 				SetCustomEngineSprites(engine, ctype, _cur_grffile->spritegroups[groupid]);
dominik@452: 			}
dominik@452: 		}
dominik@452: 	}
dominik@452: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9446: 	if (!IsValidGroupID(groupid, "VehicleMapSpriteGroup")) return;
peter1138@9446: 
peter1138@9446: 	grfmsg(8, "-- Default group id 0x%04X", groupid);
peter1138@9446: 
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		EngineID engine = engines[i];
peter1138@9446: 
peter1138@9446: 		if (wagover) {
peter1138@9446: 			SetWagonOverrideSprites(engine, CT_DEFAULT, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count);
peter1138@9446: 		} else {
peter1138@9446: 			SetCustomEngineSprites(engine, CT_DEFAULT, _cur_grffile->spritegroups[groupid]);
peter1138@9446: 			SetEngineGRF(engine, _cur_grffile);
dominik@452: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@6363: 
peter1138@9446: static void CanalMapSpriteGroup(byte *buf, uint8 idcount)
peter1138@6583: {
smatz@9488: 	CanalFeature *cfs = AllocaM(CanalFeature, idcount);
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		cfs[i] = (CanalFeature)grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	buf += cidcount * 3;
peter1138@9446: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9445: 	if (!IsValidGroupID(groupid, "CanalMapSpriteGroup")) return;
peter1138@6583: 
peter1138@6583: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		CanalFeature cf = cfs[i];
peter1138@6583: 
peter1138@6583: 		if (cf >= CF_END) {
peter1138@6583: 			grfmsg(1, "CanalMapSpriteGroup: Canal subset %d out of range, skipping", cf);
peter1138@6583: 			continue;
peter1138@6583: 		}
peter1138@6583: 
frosch@9750: 		_water_feature[cf].grffile = _cur_grffile;
peter1138@8372: 		_water_feature[cf].group = _cur_grffile->spritegroups[groupid];
peter1138@6583: 	}
peter1138@6583: }
peter1138@6583: 
peter1138@6583: 
peter1138@9446: static void StationMapSpriteGroup(byte *buf, uint8 idcount)
peter1138@6363: {
smatz@9488: 	uint8 *stations = AllocaM(uint8, idcount);
peter1138@6363: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		stations[i] = grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	for (uint c = 0; c < cidcount; c++) {
peter1138@9446: 		uint8 ctype = grf_load_byte(&buf);
peter1138@9446: 		uint16 groupid = grf_load_word(&buf);
peter1138@9446: 		if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) continue;
peter1138@9446: 
peter1138@9446: 		ctype = TranslateCargo(GSF_STATION, ctype);
peter1138@9446: 		if (ctype == CT_INVALID) continue;
peter1138@9446: 
peter1138@9446: 		for (uint i = 0; i < idcount; i++) {
peter1138@9446: 			StationSpec *statspec = _cur_grffile->stations[stations[i]];
peter1138@9446: 
peter1138@9446: 			if (statspec == NULL) {
peter1138@9446: 				grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
peter1138@10042: 				continue;
peter1138@9446: 			}
peter1138@6363: 
peter1138@6363: 			statspec->spritegroup[ctype] = _cur_grffile->spritegroups[groupid];
peter1138@6363: 		}
peter1138@6363: 	}
peter1138@6363: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9446: 	if (!IsValidGroupID(groupid, "StationMapSpriteGroup")) return;
peter1138@9446: 
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		StationSpec *statspec = _cur_grffile->stations[stations[i]];
peter1138@9446: 
peter1138@9446: 		if (statspec == NULL) {
peter1138@9446: 			grfmsg(1, "StationMapSpriteGroup: Station with ID 0x%02X does not exist, skipping", stations[i]);
peter1138@9446: 			continue;
peter1138@6363: 		}
peter1138@9446: 
peter1138@9446: 		statspec->spritegroup[CT_DEFAULT] = _cur_grffile->spritegroups[groupid];
peter1138@9446: 		statspec->grffile = _cur_grffile;
peter1138@9446: 		statspec->localidx = stations[i];
peter1138@9446: 		SetCustomStationSpec(statspec);
peter1138@6363: 	}
peter1138@6363: }
peter1138@6363: 
peter1138@6363: 
peter1138@9446: static void TownHouseMapSpriteGroup(byte *buf, uint8 idcount)
peter1138@6363: {
smatz@9488: 	uint8 *houses = AllocaM(uint8, idcount);
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		houses[i] = grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	/* Skip the cargo type section, we only care about the default group */
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	buf += cidcount * 3;
peter1138@9446: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9445: 	if (!IsValidGroupID(groupid, "TownHouseMapSpriteGroup")) return;
peter1138@6363: 
peter1138@6363: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		HouseSpec *hs = _cur_grffile->housespec[houses[i]];
peter1138@6363: 
peter1138@6363: 		if (hs == NULL) {
peter1138@10042: 			grfmsg(1, "TownHouseMapSpriteGroup: House %d undefined, skipping.", houses[i]);
peter1138@10042: 			continue;
peter1138@6363: 		}
peter1138@6363: 
peter1138@6363: 		hs->spritegroup = _cur_grffile->spritegroups[groupid];
peter1138@6363: 	}
peter1138@6363: }
peter1138@6363: 
peter1138@9446: static void IndustryMapSpriteGroup(byte *buf, uint8 idcount)
belugas@7217: {
smatz@9488: 	uint8 *industries = AllocaM(uint8, idcount);
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		industries[i] = grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	/* Skip the cargo type section, we only care about the default group */
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	buf += cidcount * 3;
peter1138@9446: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9445: 	if (!IsValidGroupID(groupid, "IndustryMapSpriteGroup")) return;
belugas@7217: 
belugas@7217: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		IndustrySpec *indsp = _cur_grffile->industryspec[industries[i]];
belugas@7217: 
belugas@7217: 		if (indsp == NULL) {
peter1138@10042: 			grfmsg(1, "IndustryMapSpriteGroup: Industry %d undefined, skipping", industries[i]);
peter1138@10042: 			continue;
belugas@7217: 		}
belugas@7217: 
belugas@7217: 		indsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid];
belugas@7217: 	}
belugas@7217: }
belugas@7217: 
peter1138@9446: static void IndustrytileMapSpriteGroup(byte *buf, uint8 idcount)
belugas@7217: {
smatz@9488: 	uint8 *indtiles = AllocaM(uint8, idcount);
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		indtiles[i] = grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	/* Skip the cargo type section, we only care about the default group */
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	buf += cidcount * 3;
peter1138@9446: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9445: 	if (!IsValidGroupID(groupid, "IndustrytileMapSpriteGroup")) return;
belugas@7217: 
belugas@7217: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		IndustryTileSpec *indtsp = _cur_grffile->indtspec[indtiles[i]];
belugas@7217: 
belugas@7217: 		if (indtsp == NULL) {
peter1138@10042: 			grfmsg(1, "IndustrytileMapSpriteGroup: Industry tile %d undefined, skipping", indtiles[i]);
peter1138@10042: 			continue;
belugas@7217: 		}
belugas@7217: 
belugas@7217: 		indtsp->grf_prop.spritegroup = _cur_grffile->spritegroups[groupid];
belugas@7217: 	}
belugas@7217: }
peter1138@6365: 
peter1138@9446: static void CargoMapSpriteGroup(byte *buf, uint8 idcount)
peter1138@6365: {
smatz@9488: 	CargoID *cargos = AllocaM(CargoID, idcount);
peter1138@9446: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		cargos[i] = grf_load_byte(&buf);
peter1138@9446: 	}
peter1138@9446: 
peter1138@9446: 	/* Skip the cargo type section, we only care about the default group */
peter1138@9446: 	uint8 cidcount = grf_load_byte(&buf);
peter1138@9446: 	buf += cidcount * 3;
peter1138@9446: 
peter1138@9446: 	uint16 groupid = grf_load_word(&buf);
peter1138@9445: 	if (!IsValidGroupID(groupid, "CargoMapSpriteGroup")) return;
peter1138@6365: 
peter1138@6365: 	for (uint i = 0; i < idcount; i++) {
peter1138@9446: 		CargoID cid = cargos[i];
peter1138@6365: 
peter1138@6365: 		if (cid >= NUM_CARGO) {
peter1138@9446: 			grfmsg(1, "CargoMapSpriteGroup: Cargo ID %d out of range, skipping", cid);
peter1138@6365: 			continue;
peter1138@6365: 		}
peter1138@6365: 
peter1138@6365: 		CargoSpec *cs = &_cargo[cid];
frosch@9750: 		cs->grffile = _cur_grffile;
peter1138@6365: 		cs->group = _cur_grffile->spritegroups[groupid];
peter1138@6365: 	}
peter1138@6365: }
peter1138@6365: 
peter1138@6365: 
peter1138@6363: /* Action 0x03 */
glx@9146: static void FeatureMapSpriteGroup(byte *buf, size_t len)
peter1138@6363: {
peter1138@6363: 	/* <03> <feature> <n-id> <ids>... <num-cid> [<cargo-type> <cid>]... <def-cid>
peter1138@6363: 	 * id-list    := [<id>] [id-list]
peter1138@6363: 	 * cargo-list := <cargo-type> <cid> [cargo-list]
peter1138@6363: 	 *
peter1138@6363: 	 * B feature       see action 0
peter1138@6363: 	 * B n-id          bits 0-6: how many IDs this definition applies to
peter1138@6363: 	 *                 bit 7: if set, this is a wagon override definition (see below)
peter1138@6363: 	 * B ids           the IDs for which this definition applies
peter1138@6363: 	 * B num-cid       number of cargo IDs (sprite group IDs) in this definition
peter1138@6363: 	 *                 can be zero, in that case the def-cid is used always
peter1138@6363: 	 * B cargo-type    type of this cargo type (e.g. mail=2, wood=7, see below)
peter1138@6363: 	 * W cid           cargo ID (sprite group ID) for this type of cargo
peter1138@6363: 	 * W def-cid       default cargo ID (sprite group ID) */
peter1138@6363: 
peter1138@8544: 	if (_cur_grffile->spritegroups == 0) {
peter1138@8544: 		grfmsg(1, "FeatureMapSpriteGroup: No sprite groups to work on! Skipping");
peter1138@8544: 		return;
peter1138@8544: 	}
peter1138@8544: 
peter1138@6363: 	if (!check_length(len, 6, "FeatureMapSpriteGroup")) return;
peter1138@6363: 
peter1138@9446: 	buf++;
peter1138@9446: 	uint8 feature = grf_load_byte(&buf);
peter1138@9446: 	uint8 idcount = grf_load_byte(&buf);
peter1138@6363: 
peter1138@6363: 	/* If idcount is zero, this is a feature callback */
peter1138@6363: 	if (idcount == 0) {
peter1138@9446: 		/* Skip number of cargo ids? */
peter1138@9446: 		grf_load_byte(&buf);
peter1138@9446: 		uint16 groupid = grf_load_word(&buf);
peter1138@8544: 
peter1138@8544: 		grfmsg(6, "FeatureMapSpriteGroup: Adding generic feature callback for feature %d", feature);
peter1138@8544: 
peter1138@8544: 		AddGenericCallback(feature, _cur_grffile, _cur_grffile->spritegroups[groupid]);
peter1138@6363: 		return;
peter1138@6363: 	}
peter1138@6363: 
peter1138@9446: 	grfmsg(6, "FeatureMapSpriteGroup: Feature %d, %d ids", feature, idcount);
peter1138@6363: 
peter1138@6363: 	switch (feature) {
peter1138@6363: 		case GSF_TRAIN:
peter1138@6363: 		case GSF_ROAD:
peter1138@6363: 		case GSF_SHIP:
peter1138@6363: 		case GSF_AIRCRAFT:
peter1138@9446: 			VehicleMapSpriteGroup(buf, feature, idcount);
peter1138@6363: 			return;
peter1138@6363: 
peter1138@6583: 		case GSF_CANAL:
peter1138@9446: 			CanalMapSpriteGroup(buf, idcount);
peter1138@6583: 			return;
peter1138@6583: 
peter1138@6363: 		case GSF_STATION:
peter1138@9446: 			StationMapSpriteGroup(buf, idcount);
peter1138@6363: 			return;
peter1138@6363: 
peter1138@6363: 		case GSF_TOWNHOUSE:
peter1138@9446: 			TownHouseMapSpriteGroup(buf, idcount);
peter1138@6363: 			return;
peter1138@6363: 
belugas@7217: 		case GSF_INDUSTRIES:
peter1138@9446: 			IndustryMapSpriteGroup(buf, idcount);
belugas@7217: 			return;
belugas@7217: 
belugas@7217: 		case GSF_INDUSTRYTILES:
peter1138@9446: 			IndustrytileMapSpriteGroup(buf, idcount);
belugas@7217: 			return;
belugas@7217: 
peter1138@6365: 		case GSF_CARGOS:
peter1138@9446: 			CargoMapSpriteGroup(buf, idcount);
peter1138@6365: 			return;
peter1138@6365: 
peter1138@6363: 		default:
peter1138@6363: 			grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature %d, skipping", feature);
peter1138@6363: 			return;
peter1138@6363: 	}
peter1138@6363: }
peter1138@6363: 
dominik@452: /* Action 0x04 */
glx@9146: static void FeatureNewName(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <04> <veh-type> <language-id> <num-veh> <offset> <data...>
dominik@452: 	 *
belugas@3601: 	 * B veh-type      see action 0 (as 00..07, + 0A
belugas@3601: 	 *                 But IF veh-type = 48, then generic text
belugas@3601: 	 * B language-id   If bit 6 is set, This is the extended language scheme,
belugas@3601: 	                   with up to 64 language.
belugas@3601: 	                   Otherwise, it is a mapping where set bits have meaning
belugas@3601: 	                   0 = american, 1 = english, 2 = german, 3 = french, 4 = spanish
belugas@3601: 	                   Bit 7 set means this is a generic text, not a vehicle one (or else)
dominik@452: 	 * B num-veh       number of vehicles which are getting a new name
tron@2346: 	 * B/W offset      number of the first vehicle that gets a new name
belugas@3601: 	 *                 Byte : ID of vehicle to change
belugas@3601: 	 *                 Word : ID of string to change/add
dominik@452: 	 * S data          new texts, each of them zero-terminated, after
dominik@452: 	 *                 which the next name begins. */
peter1138@6281: 
peter1138@3643: 	bool new_scheme = _cur_grffile->grf_version >= 7;
dominik@452: 
peter1138@5590: 	if (!check_length(len, 6, "FeatureNewName")) return;
tron@2346: 	buf++;
peter1138@6281: 	uint8 feature  = grf_load_byte(&buf);
peter1138@6281: 	uint8 lang     = grf_load_byte(&buf);
peter1138@6281: 	uint8 num      = grf_load_byte(&buf);
skidd13@7928: 	bool generic   = HasBit(lang, 7);
peter1138@9502: 	uint16 id;
peter1138@9502: 	if (generic) {
peter1138@9502: 		id = grf_load_word(&buf);
peter1138@9502: 	} else if (feature <= GSF_AIRCRAFT) {
peter1138@9502: 		id = grf_load_extended(&buf);
peter1138@9502: 	} else {
peter1138@9502: 		id = grf_load_byte(&buf);
peter1138@9502: 	}
peter1138@4992: 
skidd13@7929: 	ClrBit(lang, 7);
tron@2346: 
peter1138@6281: 	uint16 endid = id + num;
dominik@452: 
Darkvater@5380: 	grfmsg(6, "FeatureNewName: About to rename engines %d..%d (feature %d) in language 0x%02X",
dominik@452: 	               id, endid, feature, lang);
dominik@452: 
peter1138@4992: 	len -= generic ? 6 : 5;
peter1138@4992: 
dominik@452: 	for (; id < endid && len > 0; id++) {
maedhros@6090: 		const char *name   = grf_load_string(&buf, len);
maedhros@6090: 		size_t name_length = strlen(name) + 1;
maedhros@6090: 
maedhros@6090: 		len -= (int)name_length;
maedhros@6090: 
peter1138@6607: 		grfmsg(8, "FeatureNewName: 0x%04X <- %s", id, name);
peter1138@6607: 
peter1138@6607: 		switch (feature) {
peter1138@6607: 			case GSF_TRAIN:
peter1138@6607: 			case GSF_ROAD:
peter1138@6607: 			case GSF_SHIP:
peter1138@6607: 			case GSF_AIRCRAFT:
peter1138@9453: 				if (!generic) {
peter1138@9070: 					Engine *e = GetNewEngine(_cur_grffile, (VehicleType)feature, id);
peter1138@9070: 					StringID string = AddGRFString(_cur_grffile->grfid, e->index, lang, new_scheme, name, e->info.string_id);
peter1138@9070: 					e->info.string_id = string;
peter1138@6607: 				} else {
peter1138@6607: 					AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, id);
peter1138@3614: 				}
peter1138@6607: 				break;
peter1138@6607: 
belugas@7182: 			case GSF_INDUSTRIES: {
belugas@7182: 				AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED);
belugas@7182: 				break;
belugas@7182: 			}
belugas@7182: 
peter1138@6607: 			case GSF_TOWNHOUSE:
peter1138@6607: 			default:
peter1138@6607: 				switch (GB(id, 8, 8)) {
peter1138@6607: 					case 0xC4: // Station class name
peter1138@6607: 						if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) {
peter1138@6607: 							grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
peter1138@6607: 						} else {
peter1138@6607: 							StationClassID sclass = _cur_grffile->stations[GB(id, 0, 8)]->sclass;
peter1138@6607: 							SetStationClassName(sclass, AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED));
maedhros@6332: 						}
peter1138@6607: 						break;
peter1138@6607: 
peter1138@6607: 					case 0xC5: // Station name
peter1138@6607: 						if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) {
peter1138@6607: 							grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8));
peter1138@6607: 						} else {
peter1138@6607: 							_cur_grffile->stations[GB(id, 0, 8)]->name = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED);
peter1138@6607: 						}
peter1138@6607: 						break;
peter1138@6607: 
peter1138@6607: 					case 0xC9: // House name
peter1138@6607: 						if (_cur_grffile->housespec == NULL || _cur_grffile->housespec[GB(id, 0, 8)] == NULL) {
peter1138@6607: 							grfmsg(1, "FeatureNewName: Attempt to name undefined house 0x%X, ignoring.", GB(id, 0, 8));
peter1138@6607: 						} else {
rubidium@8959: 							_cur_grffile->housespec[GB(id, 0, 8)]->building_name = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED);
peter1138@6607: 						}
peter1138@6607: 						break;
peter1138@6607: 
peter1138@6607: 					case 0xD0:
peter1138@8655: 					case 0xD1:
peter1138@8655: 					case 0xD2:
peter1138@8655: 					case 0xD3:
peter1138@6607: 					case 0xDC:
peter1138@6607: 						AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED);
peter1138@6607: 						break;
peter1138@6607: 
peter1138@6607: 					default:
peter1138@6607: 						grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id);
peter1138@6607: 						break;
peter1138@6607: 				}
peter1138@6607: 				break;
peter1138@3642: 
peter1138@3642: #if 0
belugas@3601: 				case GSF_CANAL :
belugas@3601: 				case GSF_BRIDGE :
belugas@3601: 					AddGRFString(_cur_spriteid, id, lang, name);
rubidium@6491: 					switch (GB(id, 8, 8)) {
belugas@6348: 						case 0xC9: // House name
belugas@3601: 						default:
Darkvater@5380: 							grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id);
belugas@3601: 					}
belugas@3601: 					break;
belugas@3601: 
belugas@3601: 				default :
Darkvater@5380: 					grfmsg(7, "FeatureNewName: Unsupported feature (0x%02X)", feature);
belugas@3601: 					break;
belugas@3601: #endif
dominik@452: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
rubidium@7882: /**
rubidium@7882:  * Sanitize incoming sprite offsets for Action 5 graphics replacements.
rubidium@7882:  * @param num         the number of sprites to load.
rubidium@7882:  * @param offset      offset from the base.
rubidium@7882:  * @param max_sprites the maximum number of sprites that can be loaded in this action 5.
rubidium@7882:  * @param name        used for error warnings.
rubidium@7882:  * @return the number of sprites that is going to be skipped
rubidium@7882:  */
rubidium@7882: static uint16 SanitizeSpriteOffset(uint16& num, uint16 offset, int max_sprites, const char *name)
rubidium@7882: {
rubidium@7882: 
rubidium@7882: 	if (offset >= max_sprites) {
rubidium@7882: 		grfmsg(1, "GraphicsNew: %s sprite offset must be less than %i, skipping", name, max_sprites);
rubidium@7882: 		uint orig_num = num;
rubidium@7882: 		num = 0;
rubidium@7882: 		return orig_num;
rubidium@7882: 	}
rubidium@7882: 
rubidium@7882: 	if (offset + num > max_sprites) {
rubidium@7882: 		grfmsg(4, "GraphicsNew: %s sprite overflow, truncating...", name);
rubidium@7882: 		uint orig_num = num;
rubidium@7882: 		num = max(max_sprites - offset, 0);
rubidium@7882: 		return orig_num - num;
rubidium@7882: 	}
rubidium@7882: 
rubidium@7882: 	return 0;
rubidium@7882: }
rubidium@7882: 
dominik@452: /* Action 0x05 */
glx@9146: static void GraphicsNew(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <05> <graphics-type> <num-sprites> <other data...>
dominik@452: 	 *
dominik@452: 	 * B graphics-type What set of graphics the sprites define.
tron@2346: 	 * E num-sprites   How many sprites are in this set?
dominik@452: 	 * V other data    Graphics type specific data.  Currently unused. */
dominik@452: 	/* TODO */
dominik@452: 
frosch@8243: 	enum Action5BlockType {
frosch@8243: 		A5BLOCK_FIXED,                ///< Only allow replacing a whole block of sprites. (TTDP compatible)
frosch@8243: 		A5BLOCK_ALLOW_OFFSET,         ///< Allow replacing any subset by specifiing an offset.
frosch@8243: 		A5BLOCK_INVALID,              ///< unknown/not-implemented type
frosch@8243: 	};
frosch@8243: 	struct Action5Type {
frosch@8243: 		Action5BlockType block_type;  ///< How is this Action5 type processed?
frosch@8243: 		SpriteID sprite_base;         ///< Load the sprites starting from this sprite.
frosch@8243: 		uint16 min_sprites;           ///< If the Action5 contains less sprites, the whole block will be ignored.
frosch@8243: 		uint16 max_sprites;           ///< If the Action5 contains more sprites, only the first max_sprites sprites will be used.
frosch@8243: 		const char *name;             ///< Name for error messages.
frosch@8243: 	};
frosch@8243: 
frosch@8243: 	static const Action5Type action5_types[] = {
frosch@8243: 		/* Note: min_sprites should not be changed. Therefore these constants are directly here and not in sprites.h */
rubidium@9493: 		/* 0x00 */ { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x00"             },
rubidium@9493: 		/* 0x01 */ { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x01"             },
rubidium@9493: 		/* 0x02 */ { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x02"             },
rubidium@9493: 		/* 0x03 */ { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x03"             },
rubidium@9493: 		/* 0x04 */ { A5BLOCK_FIXED,        SPR_SIGNALS_BASE,            48, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT,    "Signal graphics"       },
rubidium@9493: 		/* 0x05 */ { A5BLOCK_FIXED,        SPR_ELRAIL_BASE,             48, ELRAIL_SPRITE_COUNT,                         "Catenary graphics"     },
rubidium@9493: 		/* 0x06 */ { A5BLOCK_FIXED,        SPR_SLOPES_BASE,             74, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT, "Foundation graphics"   },
rubidium@9493: 		/* 0x07 */ { A5BLOCK_INVALID,      0,                           75, 0,                                           "TTDP GUI graphics"     }, // Not used by OTTD.
rubidium@9493: 		/* 0x08 */ { A5BLOCK_FIXED,        SPR_CANALS_BASE,             65, CANALS_SPRITE_COUNT,                         "Canal graphics"        },
rubidium@9493: 		/* 0x09 */ { A5BLOCK_FIXED,        SPR_ONEWAY_BASE,              6, ONEWAY_SPRITE_COUNT,                         "One way road graphics" },
rubidium@9493: 		/* 0x0A */ { A5BLOCK_FIXED,        SPR_2CCMAP_BASE,            256, TWOCCMAP_SPRITE_COUNT,                       "2CC colour maps"       },
rubidium@9493: 		/* 0x0B */ { A5BLOCK_FIXED,        SPR_TRAMWAY_BASE,           113, TRAMWAY_SPRITE_COUNT,                        "Tramway graphics"      },
rubidium@9493: 		/* 0x0C */ { A5BLOCK_INVALID,      0,                          133, 0,                                           "Snowy temperate tree"  }, // Not yet used by OTTD.
rubidium@9493: 		/* 0x0D */ { A5BLOCK_FIXED,        SPR_SHORE_BASE,              16, SPR_SHORE_SPRITE_COUNT,                      "Shore graphics"        },
rubidium@9493: 		/* 0x0E */ { A5BLOCK_INVALID,      0,                            0, 0,                                           "New Signals graphics"  }, // Not yet used by OTTD.
rubidium@9493: 		/* 0x0F */ { A5BLOCK_FIXED,        SPR_TRACKS_FOR_SLOPES_BASE,  12, TRACKS_FOR_SLOPES_SPRITE_COUNT,              "Sloped rail track"     },
rubidium@9493: 		/* 0x10 */ { A5BLOCK_FIXED,        SPR_AIRPORTX_BASE,           15, AIRPORTX_SPRITE_COUNT,                       "Airport graphics"      },
rubidium@9493: 		/* 0x11 */ { A5BLOCK_FIXED,        SPR_ROADSTOP_BASE,            8, ROADSTOP_SPRITE_COUNT,                       "Road stop graphics"    },
rubidium@9493: 		/* 0x12 */ { A5BLOCK_FIXED,        SPR_AQUEDUCT_BASE,            8, AQUEDUCT_SPRITE_COUNT,                       "Aqueduct graphics"     },
rubidium@9493: 		/* 0x13 */ { A5BLOCK_FIXED,        SPR_AUTORAIL_BASE,           55, AUTORAIL_SPRITE_COUNT,                       "Autorail graphics"     },
rubidium@9493: 		/* 0x14 */ { A5BLOCK_ALLOW_OFFSET, SPR_FLAGS_BASE,               1, FLAGS_SPRITE_COUNT,                          "Flag graphics"         },
rubidium@9493: 		/* 0x15 */ { A5BLOCK_ALLOW_OFFSET, SPR_OPENTTD_BASE,             1, OPENTTD_SPRITE_COUNT,                        "OpenTTD GUI graphics"  },
frosch@8243: 	};
dominik@452: 
peter1138@5590: 	if (!check_length(len, 2, "GraphicsNew")) return;
tron@2346: 	buf++;
peter1138@6281: 	uint8 type = grf_load_byte(&buf);
peter1138@6281: 	uint16 num = grf_load_extended(&buf);
skidd13@7928: 	uint16 offset = HasBit(type, 7) ? grf_load_extended(&buf) : 0;
skidd13@7929: 	ClrBit(type, 7); // Clear the high bit as that only indicates whether there is an offset.
dominik@452: 
frosch@8243: 	if ((type == 0x0D) && (num == 10) && _cur_grffile->is_ottdfile) {
frosch@8243: 		/* Special not-TTDP-compatible case used in openttd(d/w).grf
frosch@8243: 		 * Missing shore sprites and initialisation of SPR_SHORE_BASE */
frosch@8243: 		grfmsg(2, "GraphicsNew: Loading 10 missing shore sprites from openttd(d/w).grf.");
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE +  0, _file_index, _nfo_line++); // SLOPE_STEEP_S
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE +  5, _file_index, _nfo_line++); // SLOPE_STEEP_W
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE +  7, _file_index, _nfo_line++); // SLOPE_WSE
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 10, _file_index, _nfo_line++); // SLOPE_STEEP_N
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 11, _file_index, _nfo_line++); // SLOPE_NWS
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 13, _file_index, _nfo_line++); // SLOPE_ENW
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 14, _file_index, _nfo_line++); // SLOPE_SEN
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 15, _file_index, _nfo_line++); // SLOPE_STEEP_E
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 16, _file_index, _nfo_line++); // SLOPE_EW
peter1138@9454: 		LoadNextSprite(SPR_SHORE_BASE + 17, _file_index, _nfo_line++); // SLOPE_NS
frosch@8403: 		if (_loaded_newgrf_features.shore == SHORE_REPLACE_NONE) _loaded_newgrf_features.shore = SHORE_REPLACE_ONLY_NEW;
frosch@8243: 		return;
peter1138@3638: 	}
peter1138@3638: 
frosch@8243: 	/* Supported type? */
frosch@8243: 	if ((type >= lengthof(action5_types)) || (action5_types[type].block_type == A5BLOCK_INVALID)) {
frosch@8243: 		grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", type, num);
frosch@8243: 		_skip_sprites = num;
frosch@8243: 		return;
peter1138@3708: 	}
peter1138@3638: 
frosch@8243: 	const Action5Type *action5_type = &action5_types[type];
frosch@8243: 
frosch@8243: 	/* Ignore offset if not allowed */
frosch@8243: 	if ((action5_type->block_type != A5BLOCK_ALLOW_OFFSET) && (offset != 0)) {
frosch@8243: 		grfmsg(1, "GraphicsNew: %s (type 0x%02X) do not allow an <offset> field. Ignoring offset.", action5_type->name, type);
frosch@8243: 		offset = 0;
frosch@8243: 	}
frosch@8243: 
frosch@8243: 	/* Ignore action5 if too few sprites are specified. (for TTDP compatibility)
frosch@8243: 	 * This does not make sense, if <offset> is allowed */
frosch@8243: 	if ((action5_type->block_type == A5BLOCK_FIXED) && (num < action5_type->min_sprites)) {
frosch@8243: 		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);
frosch@8243: 		_skip_sprites = num;
frosch@8243: 		return;
frosch@8243: 	}
frosch@8243: 
frosch@8243: 	/* Load at most max_sprites sprites. Skip remaining sprites. (for compatibility with TTDP and future extentions) */
frosch@8243: 	uint16 skip_num = SanitizeSpriteOffset(num, offset, action5_type->max_sprites, action5_type->name);
frosch@8243: 	SpriteID replace = action5_type->sprite_base + offset;
frosch@8243: 
frosch@8243: 	/* Load <num> sprites starting from <replace>, then skip <skip_num> sprites. */
frosch@8243: 	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);
frosch@8243: 
peter1138@3638: 	for (; num > 0; num--) {
rubidium@7953: 		_nfo_line++;
truelight@6908: 		LoadNextSprite(replace == 0 ? _cur_spriteid++ : replace++, _file_index, _nfo_line);
peter1138@3638: 	}
rubidium@7882: 
frosch@8403: 	if (type == 0x0D) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_5;
frosch@8403: 
rubidium@7882: 	_skip_sprites = skip_num;
dominik@452: }
dominik@452: 
peter1138@6529: /* Action 0x05 (SKIP) */
glx@9146: static void SkipAct5(byte *buf, size_t len)
peter1138@6529: {
peter1138@6529: 	if (!check_length(len, 2, "SkipAct5")) return;
peter1138@6529: 	buf++;
peter1138@6529: 
peter1138@6529: 	/* Ignore type byte */
peter1138@6529: 	grf_load_byte(&buf);
peter1138@6529: 
peter1138@6529: 	/* Skip the sprites of this action */
peter1138@6529: 	_skip_sprites = grf_load_extended(&buf);
peter1138@6529: 
peter1138@6529: 	grfmsg(3, "SkipAct5: Skipping %d sprites", _skip_sprites);
peter1138@6529: }
peter1138@6529: 
frosch@8546: /**
frosch@8546:  * Reads a variable common to VarAction2 and Action7/9/D.
frosch@8546:  *
frosch@8546:  * Returns VarAction2 variable 'param' resp. Action7/9/D variable '0x80 + param'.
frosch@8546:  * If a variable is not accessible from all four actions, it is handled in the action specific functions.
frosch@8546:  *
frosch@8546:  * @param param variable number (as for VarAction2, for Action7/9/D you have to subtract 0x80 first).
frosch@8546:  * @param value returns the value of the variable.
frosch@8546:  * @return true iff the variable is known and the value is returned in 'value'.
frosch@8546:  */
frosch@8546: bool GetGlobalVariable(byte param, uint32 *value)
peter1138@3806: {
peter1138@3806: 	switch (param) {
frosch@8546: 		case 0x00: // current date
frosch@8546: 			*value = max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x01: // current year
frosch@8546: 			*value = Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
frosch@8546: 			return true;
frosch@8546: 
frosch@9570: 		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)
frosch@9570: 			YearMonthDay ymd;
frosch@9570: 			ConvertDateToYMD(_date, &ymd);
frosch@9570: 			Date start_of_year = ConvertYMDToDate(ymd.year, 0, 1);
frosch@9570: 			*value = ymd.month | (ymd.day - 1) << 8 | (IsLeapYear(ymd.year) ? 1 << 15 : 0) | (_date - start_of_year) << 16;
frosch@8546: 			return true;
frosch@9570: 		}
frosch@8546: 
frosch@8546: 		case 0x03: // current climate, 0=temp, 1=arctic, 2=trop, 3=toyland
rubidium@9413: 			*value = _settings_game.game_creation.landscape;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x06: // road traffic side, bit 4 clear=left, set=right
rubidium@9413: 			*value = _settings_game.vehicle.road_side << 4;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x09: // date fraction
frosch@8546: 			*value = _date_fract;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x0A: // animation counter
frosch@8546: 			*value = _tick_counter;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x0B: { // TTDPatch version
frosch@8546: 			uint major    = 2;
frosch@8546: 			uint minor    = 6;
frosch@8546: 			uint revision = 1; // special case: 2.0.1 is 2.0.10
frosch@8546: 			uint build    = 1382;
frosch@8546: 			*value = (major << 24) | (minor << 20) | (revision << 16) | build;
frosch@8546: 			return true;
frosch@8546: 		}
frosch@8546: 
frosch@8546: 		case 0x0D: // TTD Version, 00=DOS, 01=Windows
rubidium@10066: 			*value = _cur_grfconfig->windows_paletted;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x0E: // Y-offset for train sprites
frosch@8546: 			*value = _traininfo_vehicle_pitch;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x0F: // Rail track type cost factors
frosch@8546: 			*value = 0;
peter1138@10002: 			SB(*value, 0, 8, GetRailTypeInfo(RAILTYPE_RAIL)->cost_multiplier); // normal rail
rubidium@9413: 			if (_settings_game.vehicle.disable_elrails) {
frosch@8546: 				/* skip elrail multiplier - disabled */
peter1138@10002: 				SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_MONO)->cost_multiplier); // monorail
frosch@8546: 			} else {
peter1138@10002: 				SB(*value, 8, 8, GetRailTypeInfo(RAILTYPE_ELECTRIC)->cost_multiplier); // electified railway
frosch@8546: 				/* Skip monorail multiplier - no space in result */
frosch@8546: 			}
peter1138@10002: 			SB(*value, 16, 8, GetRailTypeInfo(RAILTYPE_MAGLEV)->cost_multiplier); // maglev
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x11: // current rail tool type
frosch@8546: 			*value = 0;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x12: // Game mode
frosch@8546: 			*value = _game_mode;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		/* case 0x13: // Tile refresh offset to left    not implemented */
frosch@8546: 		/* case 0x14: // Tile refresh offset to right   not implemented */
frosch@8546: 		/* case 0x15: // Tile refresh offset upwards    not implemented */
frosch@8546: 		/* case 0x16: // Tile refresh offset downwards  not implemented */
frosch@8546: 		/* case 0x17: // temperate snow line            not implemented */
frosch@8546: 
frosch@8546: 		case 0x1A: // Always -1
frosch@8546: 			*value = UINT_MAX;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x1B: // Display options
frosch@8546: 			*value = GB(_display_opt, 0, 6);
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x1D: // TTD Platform, 00=TTDPatch, 01=OpenTTD
frosch@8546: 			*value = 1;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		case 0x1E: // Miscellaneous GRF features
frosch@8546: 			*value = _misc_grf_features;
frosch@8546: 			return true;
frosch@8546: 
frosch@8546: 		/* case 0x1F: // locale dependent settings not implemented */
frosch@8546: 
frosch@8546: 		case 0x20: // snow line height
rubidium@9413: 			*value = _settings_game.game_creation.landscape == LT_ARCTIC ? GetSnowLine() : 0xFF;
frosch@8546: 			return true;
frosch@8546: 
smatz@9085: 		case 0x21: // OpenTTD version
frosch@8546: 			*value = _openttd_newgrf_version;
frosch@8546: 			return true;
frosch@8546: 
belugas@8753: 		case 0x22: // difficulty level
rubidium@9413: 			*value = _settings_game.difficulty.diff_level;
belugas@8753: 			return true;
belugas@8753: 
belugas@9458: 		case 0x23: // long format date
belugas@9458: 			*value = _date;
belugas@9458: 			return true;
belugas@9458: 
belugas@9458: 		case 0x24: // long format year
belugas@9458: 			*value = _cur_year;
belugas@9458: 			return true;
belugas@9458: 
frosch@8546: 		default: return false;
frosch@8546: 	}
frosch@8546: }
frosch@8546: 
frosch@8546: static uint32 GetParamVal(byte param, uint32 *cond_val)
frosch@8546: {
frosch@8546: 	/* First handle variable common with VarAction2 */
frosch@8546: 	uint32 value;
frosch@8546: 	if (GetGlobalVariable(param - 0x80, &value)) return value;
frosch@8546: 
frosch@8546: 	/* Non-common variable */
frosch@8546: 	switch (param) {
peter1138@6813: 		case 0x84: { // GRF loading stage
peter1138@6813: 			uint32 res = 0;
peter1138@6813: 
skidd13@7931: 			if (_cur_stage > GLS_INIT) SetBit(res, 0);
skidd13@7931: 			if (_cur_stage == GLS_RESERVE) SetBit(res, 8);
skidd13@7931: 			if (_cur_stage == GLS_ACTIVATION) SetBit(res, 9);
peter1138@6813: 			return res;
peter1138@6813: 		}
peter1138@3806: 
belugas@6348: 		case 0x85: // TTDPatch flags, only for bit tests
peter1138@3811: 			if (cond_val == NULL) {
peter1138@3811: 				/* Supported in Action 0x07 and 0x09, not 0x0D */
peter1138@3811: 				return 0;
peter1138@3811: 			} else {
peter1138@3811: 				uint32 param_val = _ttdpatch_flags[*cond_val / 0x20];
peter1138@3811: 				*cond_val %= 0x20;
peter1138@3811: 				return param_val;
peter1138@3811: 			}
peter1138@3806: 
belugas@6348: 		case 0x88: // GRF ID check
peter1138@3806: 			return 0;
peter1138@3806: 
frosch@8546: 		/* case 0x99: Global ID offest not implemented */
rubidium@7780: 
peter1138@3806: 		default:
peter1138@3806: 			/* GRF Parameter */
peter1138@3806: 			if (param < 0x80) return _cur_grffile->param[param];
peter1138@3806: 
peter1138@3806: 			/* In-game variable. */
Darkvater@5380: 			grfmsg(1, "Unsupported in-game variable 0x%02X", param);
rubidium@5587: 			return UINT_MAX;
peter1138@3806: 	}
peter1138@3806: }
peter1138@3806: 
peter1138@3895: /* Action 0x06 */
glx@9146: static void CfgApply(byte *buf, size_t len)
peter1138@3895: {
peter1138@3895: 	/* <06> <param-num> <param-size> <offset> ... <FF>
peter1138@3895: 	 *
peter1138@3895: 	 * B param-num     Number of parameter to substitute (First = "zero")
peter1138@3895: 	 *                 Ignored if that parameter was not specified in newgrf.cfg
peter1138@3895: 	 * B param-size    How many bytes to replace.  If larger than 4, the
peter1138@3895: 	 *                 bytes of the following parameter are used.  In that
peter1138@3895: 	 *                 case, nothing is applied unless *all* parameters
peter1138@3895: 	 *                 were specified.
peter1138@3895: 	 * B offset        Offset into data from beginning of next sprite
peter1138@3895: 	 *                 to place where parameter is to be stored. */
peter1138@3895: 
peter1138@3895: 	/* Preload the next sprite */
rubidium@9390: 	size_t pos = FioGetPos();
peter1138@3895: 	uint16 num = FioReadWord();
peter1138@3895: 	uint8 type = FioReadByte();
rubidium@9947: 	byte *preload_sprite = NULL;
peter1138@3895: 
peter1138@3895: 	/* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */
peter1138@3895: 	if (type == 0xFF) {
rubidium@9947: 		preload_sprite = MallocT<byte>(num);
rubidium@9947: 		FioReadBlock(preload_sprite, num);
peter1138@3895: 	}
peter1138@3895: 
peter1138@3895: 	/* Reset the file position to the start of the next sprite */
peter1138@3895: 	FioSeekTo(pos, SEEK_SET);
peter1138@3895: 
peter1138@3895: 	if (type != 0xFF) {
Darkvater@5380: 		grfmsg(2, "CfgApply: Ignoring (next sprite is real, unsupported)");
rubidium@9947: 		free(preload_sprite);
peter1138@3895: 		return;
peter1138@3895: 	}
peter1138@3895: 
rubidium@9947: 	GRFLocation location(_cur_grfconfig->grfid, _nfo_line + 1);
rubidium@9947: 	GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
rubidium@9947: 	if (it != _grf_line_to_action6_sprite_override.end()) {
rubidium@9947: 		free(preload_sprite);
rubidium@9947: 		preload_sprite = _grf_line_to_action6_sprite_override[location];
rubidium@9947: 	} else {
rubidium@9947: 		_grf_line_to_action6_sprite_override[location] = preload_sprite;
rubidium@9947: 	}
rubidium@9947: 
peter1138@3895: 	/* Now perform the Action 0x06 on our data. */
peter1138@3895: 	buf++;
peter1138@3895: 
peter1138@3895: 	for (;;) {
peter1138@3895: 		uint i;
peter1138@3895: 		uint param_num;
peter1138@3895: 		uint param_size;
peter1138@3895: 		uint offset;
peter1138@3895: 		bool add_value;
peter1138@3895: 
peter1138@3895: 		/* Read the parameter to apply. 0xFF indicates no more data to change. */
peter1138@3895: 		param_num = grf_load_byte(&buf);
peter1138@3895: 		if (param_num == 0xFF) break;
peter1138@3895: 
peter1138@3895: 		/* Get the size of the parameter to use. If the size covers multiple
peter1138@3895: 		 * double words, sequential parameter values are used. */
peter1138@3895: 		param_size = grf_load_byte(&buf);
peter1138@3895: 
peter1138@3895: 		/* Bit 7 of param_size indicates we should add to the original value
peter1138@3895: 		 * instead of replacing it. */
skidd13@7928: 		add_value  = HasBit(param_size, 7);
peter1138@3895: 		param_size = GB(param_size, 0, 7);
peter1138@3895: 
peter1138@3895: 		/* Where to apply the data to within the pseudo sprite data. */
peter1138@3895: 		offset     = grf_load_extended(&buf);
peter1138@3895: 
peter1138@3895: 		/* If the parameter is a GRF parameter (not an internal variable) check
peter1138@3895: 		 * if it (and all further sequential parameters) has been defined. */
peter1138@3895: 		if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur_grffile->param_end) {
Darkvater@5380: 			grfmsg(2, "CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4));
peter1138@3895: 			break;
peter1138@3895: 		}
peter1138@3895: 
Darkvater@5380: 		grfmsg(8, "CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset);
peter1138@3895: 
peter1138@6652: 		bool carry = false;
frosch@10421: 		for (i = 0; i < param_size && offset + i < num; i++) {
peter1138@3895: 			uint32 value = GetParamVal(param_num + i / 4, NULL);
peter1138@6652: 			/* Reset carry flag for each iteration of the variable (only really
peter1138@6652: 			 * matters if param_size is greater than 4) */
peter1138@6652: 			if (i == 0) carry = false;
peter1138@3895: 
peter1138@3895: 			if (add_value) {
rubidium@9947: 				uint new_value = preload_sprite[offset + i] + GB(value, (i % 4) * 8, 8) + (carry ? 1 : 0);
rubidium@9947: 				preload_sprite[offset + i] = GB(new_value, 0, 8);
peter1138@6652: 				/* Check if the addition overflowed */
peter1138@6652: 				carry = new_value >= 256;
peter1138@3895: 			} else {
rubidium@9947: 				preload_sprite[offset + i] = GB(value, (i % 4) * 8, 8);
peter1138@3895: 			}
peter1138@3895: 		}
peter1138@3895: 	}
peter1138@3895: }
peter1138@3895: 
rubidium@9556: /**
rubidium@9556:  * Disable a static NewGRF when it is influencing another (non-static)
rubidium@9556:  * NewGRF as this could cause desyncs.
rubidium@9556:  *
rubidium@9556:  * We could just tell the NewGRF querying that the file doesn't exist,
rubidium@9556:  * but that might give unwanted results. Disabling the NewGRF gives the
rubidium@9556:  * best result as no NewGRF author can complain about that.
rubidium@9556:  * @param c the NewGRF to disable.
rubidium@9556:  */
rubidium@9556: static void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig *c)
rubidium@9556: {
rubidium@9556: 	if (c->error != NULL) {
rubidium@9556: 		free(c->error->custom_message);
rubidium@9556: 		free(c->error->data);
rubidium@9556: 		free(c->error);
rubidium@9556: 	}
rubidium@9556: 	c->status = GCS_DISABLED;
rubidium@9556: 	c->error  = CallocT<GRFError>(1);
rubidium@9556: 	c->error->data = strdup(_cur_grfconfig->name);
rubidium@9556: 	c->error->severity = STR_NEWGRF_ERROR_MSG_FATAL;
rubidium@9556: 	c->error->message  = STR_NEWGRF_ERROR_STATIC_GRF_CAUSES_DESYNC;
rubidium@9619: 
rubidium@9619: 	ClearTemporaryNewGRFData();
rubidium@9619: 	_skip_sprites = -1;
rubidium@9556: }
rubidium@9556: 
dominik@452: /* Action 0x07 */
dominik@452: /* Action 0x09 */
glx@9146: static void SkipIf(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <07/09> <param-num> <param-size> <condition-type> <value> <num-sprites>
dominik@452: 	 *
dominik@452: 	 * B param-num
dominik@452: 	 * B param-size
dominik@452: 	 * B condition-type
dominik@452: 	 * V value
dominik@452: 	 * B num-sprites */
dominik@452: 	/* TODO: More params. More condition types. */
tron@2336: 	uint32 cond_val = 0;
peter1138@3806: 	uint32 mask = 0;
dominik@452: 	bool result;
dominik@452: 
peter1138@5590: 	if (!check_length(len, 6, "SkipIf")) return;
peter1138@3714: 	buf++;
peter1138@6281: 	uint8 param     = grf_load_byte(&buf);
peter1138@6281: 	uint8 paramsize = grf_load_byte(&buf);
peter1138@6281: 	uint8 condtype  = grf_load_byte(&buf);
dominik@452: 
dominik@452: 	if (condtype < 2) {
tron@1611: 		/* Always 1 for bit tests, the given value should be ignored. */
dominik@452: 		paramsize = 1;
dominik@452: 	}
dominik@452: 
tron@1611: 	switch (paramsize) {
peter1138@3806: 		case 4: cond_val = grf_load_dword(&buf); mask = 0xFFFFFFFF; break;
peter1138@3806: 		case 2: cond_val = grf_load_word(&buf);  mask = 0x0000FFFF; break;
peter1138@3806: 		case 1: cond_val = grf_load_byte(&buf);  mask = 0x000000FF; break;
tron@1611: 		default: break;
tron@1611: 	}
dominik@452: 
peter1138@3806: 	if (param < 0x80 && _cur_grffile->param_end <= param) {
belugas@6477: 		grfmsg(7, "SkipIf: Param %d undefined, skipping test", param);
peter1138@3806: 		return;
dominik@452: 	}
dominik@452: 
peter1138@6281: 	uint32 param_val = GetParamVal(param, &cond_val);
peter1138@3806: 
belugas@6477: 	grfmsg(7, "SkipIf: Test condtype %d, param 0x%08X, condval 0x%08X", condtype, param_val, cond_val);
peter1138@5452: 
rubidium@7808: 	/*
rubidium@7808: 	 * Parameter (variable in specs) 0x88 can only have GRF ID checking
rubidium@7808: 	 * conditions, except conditions 0x0B and 0x0C (cargo availability)
rubidium@7808: 	 * as those ignore the parameter. So, when the condition type is
rubidium@7808: 	 * either of those, the specific variable 0x88 code is skipped, so
rubidium@7808: 	 * the "general" code for the cargo availability conditions kicks in.
rubidium@7808: 	 */
rubidium@7808: 	if (param == 0x88 && condtype != 0x0B && condtype != 0x0C) {
peter1138@5452: 		/* GRF ID checks */
peter1138@5452: 
rubidium@9556: 		GRFConfig *c = GetGRFConfig(cond_val);
rubidium@9556: 
rubidium@9556: 		if (c != NULL && HasBit(c->flags, GCF_STATIC) && !HasBit(_cur_grfconfig->flags, GCF_STATIC) && c->status != GCS_DISABLED && _networking) {
rubidium@9556: 			DisableStaticNewGRFInfluencingNonStaticNewGRFs(c);
rubidium@9556: 			c = NULL;
rubidium@9556: 		}
peter1138@5452: 
peter1138@5452: 		if (condtype != 10 && c == NULL) {
belugas@6477: 			grfmsg(7, "SkipIf: GRFID 0x%08X unknown, skipping test", BSWAP32(cond_val));
peter1138@5452: 			return;
peter1138@5234: 		}
peter1138@5234: 
peter1138@5452: 		switch (condtype) {
rubidium@7808: 			/* Tests 0x06 to 0x0A are only for param 0x88, GRFID checks */
rubidium@7808: 			case 0x06: // Is GRFID active?
maedhros@6229: 				result = c->status == GCS_ACTIVATED;
peter1138@5452: 				break;
peter1138@5452: 
rubidium@7808: 			case 0x07: // Is GRFID non-active?
maedhros@6229: 				result = c->status != GCS_ACTIVATED;
peter1138@5452: 				break;
peter1138@5452: 
rubidium@7808: 			case 0x08: // GRFID is not but will be active?
maedhros@6229: 				result = c->status == GCS_INITIALISED;
peter1138@5452: 				break;
peter1138@5452: 
rubidium@7808: 			case 0x09: // GRFID is or will be active?
maedhros@6229: 				result = c->status == GCS_ACTIVATED || c->status == GCS_INITIALISED;
peter1138@5452: 				break;
peter1138@5452: 
rubidium@7808: 			case 0x0A: // GRFID is not nor will be active
peter1138@5452: 				/* This is the only condtype that doesn't get ignored if the GRFID is not found */
maedhros@6229: 				result = c == NULL || c->flags == GCS_DISABLED || c->status == GCS_NOT_FOUND;
peter1138@5452: 				break;
peter1138@5452: 
rubidium@7808: 			default: grfmsg(1, "SkipIf: Unsupported GRF condition type %02X. Ignoring", condtype); return;
peter1138@5234: 		}
peter1138@5452: 	} else {
peter1138@5452: 		/* Parameter or variable tests */
peter1138@5452: 		switch (condtype) {
rubidium@7808: 			case 0x00: result = !!(param_val & (1 << cond_val));
rubidium@7808: 				break;
rubidium@7808: 			case 0x01: result = !(param_val & (1 << cond_val));
rubidium@7808: 				break;
rubidium@7808: 			case 0x02: result = (param_val & mask) == cond_val;
rubidium@7808: 				break;
rubidium@7808: 			case 0x03: result = (param_val & mask) != cond_val;
rubidium@7808: 				break;
rubidium@7808: 			case 0x04: result = (param_val & mask) < cond_val;
rubidium@7808: 				break;
rubidium@7808: 			case 0x05: result = (param_val & mask) > cond_val;
rubidium@7808: 				break;
rubidium@7808: 			case 0x0B: result = GetCargoIDByLabel(BSWAP32(cond_val)) == CT_INVALID;
rubidium@7808: 				break;
rubidium@7808: 			case 0x0C: result = GetCargoIDByLabel(BSWAP32(cond_val)) != CT_INVALID;
rubidium@7808: 				break;
rubidium@7808: 
rubidium@7808: 			default: grfmsg(1, "SkipIf: Unsupported condition type %02X. Ignoring", condtype); return;
peter1138@5234: 		}
dominik@452: 	}
dominik@452: 
pasky@1607: 	if (!result) {
belugas@6477: 		grfmsg(2, "SkipIf: Not skipping sprites, test was false");
dominik@452: 		return;
dominik@452: 	}
dominik@452: 
peter1138@6281: 	uint8 numsprites = grf_load_byte(&buf);
Darkvater@3561: 
Darkvater@3561: 	/* numsprites can be a GOTO label if it has been defined in the GRF
Darkvater@3561: 	 * file. The jump will always be the first matching label that follows
Darkvater@3561: 	 * the current nfo_line. If no matching label is found, the first matching
Darkvater@3561: 	 * label in the file is used. */
peter1138@6281: 	GRFLabel *choice = NULL;
peter1138@6281: 	for (GRFLabel *label = _cur_grffile->label; label != NULL; label = label->next) {
Darkvater@3561: 		if (label->label != numsprites) continue;
Darkvater@3561: 
Darkvater@3561: 		/* Remember a goto before the current line */
Darkvater@3561: 		if (choice == NULL) choice = label;
Darkvater@3561: 		/* If we find a label here, this is definitely good */
Darkvater@3561: 		if (label->nfo_line > _nfo_line) {
Darkvater@3561: 			choice = label;
Darkvater@3561: 			break;
Darkvater@3561: 		}
Darkvater@3561: 	}
Darkvater@3561: 
Darkvater@3561: 	if (choice != NULL) {
belugas@6477: 		grfmsg(2, "SkipIf: Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line);
Darkvater@3561: 		FioSeekTo(choice->pos, SEEK_SET);
Darkvater@3561: 		_nfo_line = choice->nfo_line;
Darkvater@3561: 		return;
Darkvater@3561: 	}
Darkvater@3561: 
belugas@6477: 	grfmsg(2, "SkipIf: Skipping %d sprites, test was true", numsprites);
dominik@452: 	_skip_sprites = numsprites;
dominik@452: 	if (_skip_sprites == 0) {
dominik@452: 		/* Zero means there are no sprites to skip, so
dominik@452: 		 * we use -1 to indicate that all further
dominik@452: 		 * sprites should be skipped. */
dominik@452: 		_skip_sprites = -1;
maedhros@6096: 
maedhros@6096: 		/* If an action 8 hasn't been encountered yet, disable the grf. */
rubidium@8089: 		if (_cur_grfconfig->status != GCS_ACTIVATED) {
maedhros@6925: 			_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 			ClearTemporaryNewGRFData();
maedhros@6925: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@5317: 
peter1138@5502: /* Action 0x08 (GLS_FILESCAN) */
glx@9146: static void ScanInfo(byte *buf, size_t len)
peter1138@5228: {
peter1138@6281: 	if (!check_length(len, 8, "Info")) return;
peter1138@6281: 	buf++;
peter1138@6281: 	grf_load_byte(&buf);
peter1138@6281: 	uint32 grfid  = grf_load_dword(&buf);
peter1138@5228: 
peter1138@5228: 	_cur_grfconfig->grfid = grfid;
peter1138@5317: 
peter1138@5329: 	/* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */
skidd13@7931: 	if (GB(grfid, 24, 8) == 0xFF) SetBit(_cur_grfconfig->flags, GCF_SYSTEM);
peter1138@5329: 
peter1138@5317: 	len -= 6;
peter1138@6281: 	const char *name = grf_load_string(&buf, len);
peter1138@8656: 	_cur_grfconfig->name = TranslateTTDPatchCodes(grfid, name);
rubidium@6186: 
rubidium@6186: 	len -= strlen(name) + 1;
rubidium@6186: 	if (len > 0) {
peter1138@6281: 		const char *info = grf_load_string(&buf, len);
peter1138@8656: 		_cur_grfconfig->info = TranslateTTDPatchCodes(grfid, info);
peter1138@5317: 	}
peter1138@5329: 
peter1138@5329: 	/* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */
peter1138@5228: 	_skip_sprites = -1;
peter1138@5228: }
peter1138@5228: 
peter1138@3640: /* Action 0x08 */
glx@9146: static void GRFInfo(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <08> <version> <grf-id> <name> <info>
dominik@452: 	 *
dominik@452: 	 * B version       newgrf version, currently 06
dominik@452: 	 * 4*B grf-id      globally unique ID of this .grf file
dominik@452: 	 * S name          name of this .grf set
dominik@452: 	 * S info          string describing the set, and e.g. author and copyright */
peter1138@6281: 
peter1138@6281: 	if (!check_length(len, 8, "GRFInfo")) return;
peter1138@6281: 	buf++;
peter1138@6281: 	uint8 version    = grf_load_byte(&buf);
peter1138@6281: 	uint32 grfid     = grf_load_dword(&buf);
peter1138@6281: 	const char *name = grf_load_string(&buf, len - 6);
dominik@452: 
dominik@452: 	_cur_grffile->grfid = grfid;
peter1138@3640: 	_cur_grffile->grf_version = version;
peter1138@6806: 	_cur_grfconfig->status = _cur_stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED;
dominik@452: 
Darkvater@3711: 	/* Do swap the GRFID for displaying purposes since people expect that */
rubidium@10066: 	DEBUG(grf, 1, "GRFInfo: Loaded GRFv%d set %08lX - %s (palette: %s)", version, BSWAP32(grfid), name, _cur_grfconfig->windows_paletted ? "Windows" : "DOS");
dominik@452: }
dominik@452: 
peter1138@3640: /* Action 0x0A */
glx@9146: static void SpriteReplace(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <0A> <num-sets> <set1> [<set2> ...]
dominik@452: 	 * <set>: <num-sprites> <first-sprite>
dominik@452: 	 *
dominik@452: 	 * B num-sets      How many sets of sprites to replace.
dominik@452: 	 * Each set:
dominik@452: 	 * B num-sprites   How many sprites are in this set
dominik@452: 	 * W first-sprite  First sprite number to replace */
dominik@452: 
belugas@6348: 	buf++; // skip action byte
peter1138@6281: 	uint8 num_sets = grf_load_byte(&buf);
peter1138@6281: 
peter1138@6281: 	for (uint i = 0; i < num_sets; i++) {
tron@2342: 		uint8 num_sprites = grf_load_byte(&buf);
tron@2342: 		uint16 first_sprite = grf_load_word(&buf);
dominik@452: 
Darkvater@5380: 		grfmsg(2, "SpriteReplace: [Set %d] Changing %d sprites, beginning with %d",
tron@2342: 			i, num_sprites, first_sprite
tron@2342: 		);
dominik@452: 
peter1138@6281: 		for (uint j = 0; j < num_sprites; j++) {
belugas@8183: 			int load_index = first_sprite + j;
rubidium@7953: 			_nfo_line++;
belugas@8183: 			LoadNextSprite(load_index, _file_index, _nfo_line); // XXX
belugas@8183: 
frosch@8403: 			/* Shore sprites now located at different addresses.
frosch@8403: 			 * So detect when the old ones get replaced. */
frosch@8403: 			if (IsInsideMM(load_index, SPR_ORIGINALSHORE_START, SPR_ORIGINALSHORE_END + 1)) {
frosch@8403: 				if (_loaded_newgrf_features.shore != SHORE_REPLACE_ACTION_5) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_A;
frosch@8403: 			}
dominik@452: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@6529: /* Action 0x0A (SKIP) */
glx@9146: static void SkipActA(byte *buf, size_t len)
peter1138@6529: {
peter1138@6529: 	buf++;
peter1138@6529: 	uint8 num_sets = grf_load_byte(&buf);
peter1138@6529: 
peter1138@6529: 	for (uint i = 0; i < num_sets; i++) {
peter1138@6529: 		/* Skip the sprites this replaces */
peter1138@6529: 		_skip_sprites += grf_load_byte(&buf);
peter1138@6529: 		/* But ignore where they go */
peter1138@6529: 		grf_load_word(&buf);
peter1138@6529: 	}
peter1138@6529: 
peter1138@6529: 	grfmsg(3, "SkipActA: Skipping %d sprites", _skip_sprites);
peter1138@6529: }
peter1138@6529: 
peter1138@3715: /* Action 0x0B */
glx@9146: static void GRFLoadError(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <0B> <severity> <language-id> <message-id> [<message...> 00] [<data...>] 00 [<parnum>]
dominik@452: 	 *
dominik@452: 	 * B severity      00: notice, contine loading grf file
dominik@452: 	 *                 01: warning, continue loading grf file
dominik@452: 	 *                 02: error, but continue loading grf file, and attempt
dominik@452: 	 *                     loading grf again when loading or starting next game
dominik@452: 	 *                 03: error, abort loading and prevent loading again in
dominik@452: 	 *                     the future (only when restarting the patch)
dominik@452: 	 * B language-id   see action 4, use 1F for built-in error messages
dominik@452: 	 * B message-id    message to show, see below
dominik@452: 	 * S message       for custom messages (message-id FF), text of the message
dominik@452: 	 *                 not present for built-in messages.
dominik@452: 	 * V data          additional data for built-in (or custom) messages
maedhros@6139: 	 * B parnum        parameter numbers to be shown in the message (maximum of 2) */
maedhros@6139: 
maedhros@6139: 	static const StringID msgstr[] = {
maedhros@6139: 		STR_NEWGRF_ERROR_VERSION_NUMBER,
maedhros@6139: 		STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
maedhros@6139: 		STR_NEWGRF_ERROR_UNSET_SWITCH,
maedhros@6139: 		STR_NEWGRF_ERROR_INVALID_PARAMETER,
maedhros@6139: 		STR_NEWGRF_ERROR_LOAD_BEFORE,
rubidium@7780: 		STR_NEWGRF_ERROR_LOAD_AFTER,
rubidium@7780: 		STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
dominik@452: 	};
Darkvater@5379: 
maedhros@6139: 	static const StringID sevstr[] = {
maedhros@6139: 		STR_NEWGRF_ERROR_MSG_INFO,
maedhros@6139: 		STR_NEWGRF_ERROR_MSG_WARNING,
maedhros@6139: 		STR_NEWGRF_ERROR_MSG_ERROR,
maedhros@6139: 		STR_NEWGRF_ERROR_MSG_FATAL
Darkvater@5379: 	};
dominik@452: 
maedhros@6139: 	if (!check_length(len, 6, "GRFLoadError")) return;
maedhros@6139: 
maedhros@6139: 	/* For now we can only show one message per newgrf file. */
maedhros@6139: 	if (_cur_grfconfig->error != NULL) return;
maedhros@6090: 
belugas@6348: 	buf++; // Skip the action byte.
maedhros@6095: 	byte severity   = grf_load_byte(&buf);
maedhros@6139: 	byte lang       = grf_load_byte(&buf);
maedhros@6095: 	byte message_id = grf_load_byte(&buf);
maedhros@6095: 	len -= 4;
maedhros@6095: 
maedhros@6873: 	/* Skip the error if it isn't valid for the current language. */
maedhros@6873: 	if (!CheckGrfLangID(lang, _cur_grffile->grf_version)) return;
maedhros@6873: 
maedhros@6095: 	/* Skip the error until the activation stage unless bit 7 of the severity
maedhros@6095: 	 * is set. */
skidd13@7928: 	if (!HasBit(severity, 7) && _cur_stage == GLS_INIT) {
peter1138@6805: 		grfmsg(7, "GRFLoadError: Skipping non-fatal GRFLoadError in stage %d", _cur_stage);
dominik@452: 		return;
peter1138@3588: 	}
skidd13@7929: 	ClrBit(severity, 7);
maedhros@6095: 
maedhros@6095: 	if (severity >= lengthof(sevstr)) {
maedhros@6139: 		grfmsg(7, "GRFLoadError: Invalid severity id %d. Setting to 2 (non-fatal error).", severity);
maedhros@6095: 		severity = 2;
maedhros@6095: 	} else if (severity == 3) {
maedhros@6095: 		/* This is a fatal error, so make sure the GRF is deactivated and no
maedhros@6095: 		 * more of it gets loaded. */
maedhros@6229: 		_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 		ClearTemporaryNewGRFData();
maedhros@6095: 		_skip_sprites = -1;
maedhros@6095: 	}
maedhros@6095: 
maedhros@6095: 	if (message_id >= lengthof(msgstr) && message_id != 0xFF) {
maedhros@6139: 		grfmsg(7, "GRFLoadError: Invalid message id.");
maedhros@6095: 		return;
maedhros@6095: 	}
maedhros@6095: 
maedhros@6095: 	if (len <= 1) {
maedhros@6139: 		grfmsg(7, "GRFLoadError: No message data supplied.");
maedhros@6095: 		return;
maedhros@6095: 	}
maedhros@6095: 
maedhros@6139: 	GRFError *error = CallocT<GRFError>(1);
maedhros@6139: 
maedhros@6139: 	error->severity = sevstr[severity];
maedhros@6139: 
maedhros@6139: 	if (message_id == 0xFF) {
maedhros@6139: 		/* This is a custom error message. */
maedhros@6139: 		const char *message = grf_load_string(&buf, len);
maedhros@6139: 		len -= (strlen(message) + 1);
maedhros@6139: 
peter1138@8656: 		error->custom_message = TranslateTTDPatchCodes(_cur_grffile->grfid, message);
maedhros@6139: 	} else {
maedhros@6139: 		error->message = msgstr[message_id];
maedhros@6103: 	}
maedhros@6103: 
maedhros@6139: 	if (len > 0) {
maedhros@6139: 		const char *data = grf_load_string(&buf, len);
maedhros@6139: 		len -= (strlen(data) + 1);
maedhros@6139: 
peter1138@8656: 		error->data = TranslateTTDPatchCodes(_cur_grffile->grfid, data);
maedhros@6139: 	}
maedhros@6139: 
maedhros@6139: 	/* Only two parameter numbers can be used in the string. */
maedhros@6139: 	uint i = 0;
maedhros@6139: 	for (; i < 2 && len > 0; i++) {
maedhros@6139: 		error->param_number[i] = grf_load_byte(&buf);
maedhros@6139: 		len--;
maedhros@6139: 	}
maedhros@6139: 	error->num_params = i;
maedhros@6139: 
maedhros@6139: 	_cur_grfconfig->error = error;
dominik@452: }
dominik@452: 
peter1138@3715: /* Action 0x0C */
glx@9146: static void GRFComment(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <0C> [<ignored...>]
dominik@452: 	 *
dominik@452: 	 * V ignored       Anything following the 0C is ignored */
Darkvater@3561: 
Darkvater@3561: 	if (len == 1) return;
Darkvater@3561: 
glx@9146: 	size_t text_len = len - 1;
tron@6107: 	const char *text = (const char*)(buf + 1);
tron@6107: 	grfmsg(2, "GRFComment: %.*s", text_len, text);
dominik@452: }
dominik@452: 
peter1138@5525: /* Action 0x0D (GLS_SAFETYSCAN) */
glx@9146: static void SafeParamSet(byte *buf, size_t len)
peter1138@5525: {
peter1138@5590: 	if (!check_length(len, 5, "SafeParamSet")) return;
peter1138@5525: 	buf++;
peter1138@6281: 	uint8 target = grf_load_byte(&buf);
peter1138@5525: 
peter1138@5525: 	/* Only writing GRF parameters is considered safe */
peter1138@5525: 	if (target < 0x80) return;
peter1138@5525: 
peter1138@5525: 	/* GRM could be unsafe, but as here it can only happen after other GRFs
peter1138@5525: 	 * are loaded, it should be okay. If the GRF tried to use the slots it
peter1138@5525: 	 * reserved, it would be marked unsafe anyway. GRM for (e.g. bridge)
peter1138@5525: 	 * sprites  is considered safe. */
peter1138@5525: 
skidd13@7931: 	SetBit(_cur_grfconfig->flags, GCF_UNSAFE);
peter1138@5525: 
peter1138@5525: 	/* Skip remainder of GRF */
peter1138@5525: 	_skip_sprites = -1;
peter1138@5525: }
peter1138@5525: 
peter1138@6515: 
peter1138@6515: static uint32 GetPatchVariable(uint8 param)
peter1138@6515: {
peter1138@6515: 	switch (param) {
peter1138@6515: 		/* start year - 1920 */
rubidium@9413: 		case 0x0B: return max(_settings_game.game_creation.starting_year, ORIGINAL_BASE_YEAR) - ORIGINAL_BASE_YEAR;
belugas@8391: 
peter1138@6515: 		/* freight trains weight factor */
rubidium@9413: 		case 0x0E: return _settings_game.vehicle.freight_trains;
belugas@8391: 
peter1138@6515: 		/* empty wagon speed increase */
peter1138@6515: 		case 0x0F: return 0;
belugas@8391: 
peter1138@8649: 		/* plane speed factor; our patch option is reversed from TTDPatch's,
peter1138@8649: 		 * the following is good for 1x, 2x and 4x (most common?) and...
peter1138@8649: 		 * well not really for 3x. */
peter1138@8649: 		case 0x10:
rubidium@9413: 			switch (_settings_game.vehicle.plane_speed) {
peter1138@8649: 				default:
peter1138@8649: 				case 4: return 1;
peter1138@8649: 				case 3: return 2;
peter1138@8649: 				case 2: return 2;
peter1138@8649: 				case 1: return 4;
peter1138@8649: 			}
peter1138@8649: 
belugas@8391: 
peter1138@6515: 		/* 2CC colormap base sprite */
peter1138@6515: 		case 0x11: return SPR_2CCMAP_BASE;
peter1138@6515: 
belugas@8391: 		/* map size: format = -MABXYSS
belugas@8391: 		 * M  : the type of map
belugas@8391: 		 *       bit 0 : set   : squared map. Bit 1 is now not relevant
belugas@8391: 		 *               clear : rectangle map. Bit 1 will indicate the bigger edge of the map
belugas@8391: 		 *       bit 1 : set   : Y is the bigger edge. Bit 0 is clear
belugas@8391: 		 *               clear : X is the bigger edge.
belugas@8391: 		 * A  : minimum edge(log2) of the map
belugas@8391: 		 * B  : maximum edge(log2) of the map
belugas@8391: 		 * XY : edges(log2) of each side of the map.
belugas@8391: 		 * SS : combination of both X and Y, thus giving the size(log2) of the map
belugas@8391: 		 */
belugas@8391: 		case 0x13: {
belugas@8391: 			byte map_bits = 0;
belugas@8393: 			byte log_X = MapLogX() - 6; // substraction is required to make the minimal size (64) zero based
belugas@8391: 			byte log_Y = MapLogY() - 6;
belugas@8391: 			byte max_edge = max(log_X, log_Y);
belugas@8391: 
belugas@8391: 			if (log_X == log_Y) { // we have a squared map, since both edges are identical
belugas@8391: 				SetBit(map_bits ,0);
belugas@8391: 			} else {
belugas@8391: 				if (max_edge == log_Y) SetBit(map_bits, 1); // edge Y been the biggest, mark it
belugas@8391: 			}
belugas@8391: 
belugas@8391: 			return (map_bits << 24) | (min(log_X, log_Y) << 20) | (max_edge << 16) |
belugas@8391: 				(log_X << 12) | (log_Y << 8) | (log_X + log_Y);
belugas@8391: 		}
belugas@8391: 
peter1138@6515: 		default:
peter1138@6515: 			grfmsg(2, "ParamSet: Unknown Patch variable 0x%02X.", param);
peter1138@6515: 			return 0;
peter1138@6515: 	}
peter1138@6515: }
peter1138@6515: 
peter1138@6515: 
peter1138@6781: static uint32 PerformGRM(uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target, const char *type)
peter1138@6781: {
peter1138@6781: 	uint start = 0;
peter1138@6781: 	uint size  = 0;
peter1138@6781: 
peter1138@6781: 	if (op == 6) {
peter1138@6781: 		/* Return GRFID of set that reserved ID */
peter1138@6781: 		return grm[_cur_grffile->param[target]];
peter1138@6781: 	}
peter1138@6781: 
peter1138@6781: 	/* With an operation of 2 or 3, we want to reserve a specific block of IDs */
peter1138@6781: 	if (op == 2 || op == 3) start = _cur_grffile->param[target];
peter1138@6781: 
peter1138@6781: 	for (uint i = start; i < num_ids; i++) {
peter1138@6781: 		if (grm[i] == 0) {
peter1138@6781: 			size++;
peter1138@6781: 		} else {
peter1138@6781: 			if (op == 2 || op == 3) break;
peter1138@6781: 			start = i + 1;
peter1138@6781: 			size = 0;
peter1138@6781: 		}
peter1138@6781: 
peter1138@6781: 		if (size == count) break;
peter1138@6781: 	}
peter1138@6781: 
peter1138@6781: 	if (size == count) {
peter1138@6781: 		/* Got the slot... */
peter1138@6781: 		if (op == 0 || op == 3) {
peter1138@6781: 			grfmsg(2, "ParamSet: GRM: Reserving %d %s at %d", count, type, start);
peter1138@6781: 			for (uint i = 0; i < count; i++) grm[start + i] = _cur_grffile->grfid;
peter1138@6781: 		}
peter1138@6781: 		return start;
peter1138@6781: 	}
peter1138@6781: 
peter1138@6781: 	/* Unable to allocate */
peter1138@6781: 	if (op != 4 && op != 5) {
peter1138@6781: 		/* Deactivate GRF */
peter1138@6781: 		grfmsg(0, "ParamSet: GRM: Unable to allocate %d %s, deactivating", count, type);
peter1138@6781: 		_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 		ClearTemporaryNewGRFData();
peter1138@6781: 		_skip_sprites = -1;
peter1138@6781: 		return UINT_MAX;
peter1138@6781: 	}
peter1138@6781: 
peter1138@6781: 	grfmsg(1, "ParamSet: GRM: Unable to allocate %d %s", count, type);
peter1138@6781: 	return UINT_MAX;
peter1138@6781: }
peter1138@6781: 
peter1138@6781: 
dominik@452: /* Action 0x0D */
glx@9146: static void ParamSet(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <0D> <target> <operation> <source1> <source2> [<data>]
dominik@452: 	 *
dominik@452: 	 * B target        parameter number where result is stored
dominik@452: 	 * B operation     operation to perform, see below
dominik@452: 	 * B source1       first source operand
dominik@452: 	 * B source2       second source operand
dominik@452: 	 * D data          data to use in the calculation, not necessary
dominik@452: 	 *                 if both source1 and source2 refer to actual parameters
dominik@452: 	 *
dominik@452: 	 * Operations
dominik@452: 	 * 00      Set parameter equal to source1
dominik@452: 	 * 01      Addition, source1 + source2
dominik@452: 	 * 02      Subtraction, source1 - source2
dominik@452: 	 * 03      Unsigned multiplication, source1 * source2 (both unsigned)
dominik@452: 	 * 04      Signed multiplication, source1 * source2 (both signed)
dominik@452: 	 * 05      Unsigned bit shift, source1 by source2 (source2 taken to be a
dominik@452: 	 *         signed quantity; left shift if positive and right shift if
dominik@452: 	 *         negative, source1 is unsigned)
dominik@452: 	 * 06      Signed bit shift, source1 by source2
dominik@452: 	 *         (source2 like in 05, and source1 as well)
dominik@452: 	 */
dominik@452: 
peter1138@5590: 	if (!check_length(len, 5, "ParamSet")) return;
dominik@452: 	buf++;
peter1138@6281: 	uint8 target = grf_load_byte(&buf);
peter1138@6281: 	uint8 oper   = grf_load_byte(&buf);
peter1138@6281: 	uint32 src1  = grf_load_byte(&buf);
peter1138@6281: 	uint32 src2  = grf_load_byte(&buf);
peter1138@6281: 
peter1138@6281: 	uint32 data = 0;
tron@2345: 	if (len >= 8) data = grf_load_dword(&buf);
dominik@452: 
dominik@452: 	/* You can add 80 to the operation to make it apply only if the target
dominik@452: 	 * is not defined yet.  In this respect, a parameter is taken to be
dominik@452: 	 * defined if any of the following applies:
dominik@452: 	 * - it has been set to any value in the newgrf(w).cfg parameter list
dominik@452: 	 * - it OR A PARAMETER WITH HIGHER NUMBER has been set to any value by
dominik@452: 	 *   an earlier action D */
skidd13@7928: 	if (HasBit(oper, 7)) {
peter1138@3807: 		if (target < 0x80 && target < _cur_grffile->param_end) {
belugas@6477: 			grfmsg(7, "ParamSet: Param %u already defined, skipping", target);
dominik@452: 			return;
peter1138@3807: 		}
peter1138@3807: 
peter1138@6281: 		oper = GB(oper, 0, 7);
dominik@452: 	}
dominik@452: 
peter1138@3808: 	if (src2 == 0xFE) {
peter1138@3808: 		if (GB(data, 0, 8) == 0xFF) {
peter1138@3808: 			if (data == 0x0000FFFF) {
peter1138@3808: 				/* Patch variables */
peter1138@6515: 				src1 = GetPatchVariable(src1);
peter1138@3808: 			} else {
peter1138@3808: 				/* GRF Resource Management */
peter1138@9098: 				uint8  op      = src1;
peter1138@9098: 				uint8  feature = GB(data, 8, 8);
peter1138@9098: 				uint16 count   = GB(data, 16, 16);
peter1138@9098: 
peter1138@9098: 				if (_cur_stage == GLS_RESERVE) {
peter1138@9098: 					if (feature == 0x08) {
peter1138@9098: 						/* General sprites */
peter1138@9098: 						if (op == 0) {
peter1138@9098: 							/* Check if the allocated sprites will fit below the original sprite limit */
peter1138@9098: 							if (_cur_spriteid + count >= 16384) {
peter1138@9098: 								grfmsg(0, "ParamSet: GRM: Unable to allocate %d sprites; try changing NewGRF order", count);
peter1138@9098: 								_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 								ClearTemporaryNewGRFData();
peter1138@9098: 								_skip_sprites = -1;
peter1138@9098: 								return;
peter1138@9098: 							}
peter1138@9098: 
peter1138@9098: 							/* Reserve space at the current sprite ID */
peter1138@9098: 							grfmsg(4, "ParamSet: GRM: Allocated %d sprites at %d", count, _cur_spriteid);
peter1138@9113: 							_grm_sprites[GRFLocation(_cur_grffile->grfid, _nfo_line)] = _cur_spriteid;
peter1138@9098: 							_cur_spriteid += count;
peter1138@9098: 						}
peter1138@9098: 					}
peter1138@9098: 					/* Ignore GRM result during reservation */
peter1138@4961: 					src1 = 0;
peter1138@9098: 				} else if (_cur_stage == GLS_ACTIVATION) {
peter1138@4961: 					switch (feature) {
belugas@6348: 						case 0x00: // Trains
belugas@6348: 						case 0x01: // Road Vehicles
belugas@6348: 						case 0x02: // Ships
belugas@6348: 						case 0x03: // Aircraft
rubidium@9413: 							if (!_settings_game.vehicle.dynamic_engines) {
peter1138@9070: 								src1 = PerformGRM(&_grm_engines[_engine_offsets[feature]], _engine_counts[feature], count, op, target, "vehicles");
peter1138@9070: 								if (_skip_sprites == -1) return;
peter1138@9070: 							} else {
peter1138@9070: 								// GRM does not apply for dynamic engine allocation.
peter1138@9070: 								switch (op) {
peter1138@9070: 									case 2:
peter1138@9070: 									case 3:
peter1138@9070: 										src1 = _cur_grffile->param[target];
peter1138@9070: 										break;
peter1138@9070: 
peter1138@9070: 									default:
peter1138@9070: 										src1 = 0;
peter1138@9070: 										break;
peter1138@9070: 								}
peter1138@9070: 							}
peter1138@4961: 							break;
peter1138@4961: 
belugas@6348: 						case 0x08: // General sprites
peter1138@4961: 							switch (op) {
peter1138@4961: 								case 0:
peter1138@9098: 									/* Return space reserved during reservation stage */
peter1138@9113: 									src1 = _grm_sprites[GRFLocation(_cur_grffile->grfid, _nfo_line)];
peter1138@9098: 									grfmsg(4, "ParamSet: GRM: Using pre-allocated sprites at %d", src1);
peter1138@4961: 									break;
peter1138@4961: 
peter1138@4961: 								case 1:
peter1138@4961: 									src1 = _cur_spriteid;
peter1138@4961: 									break;
peter1138@4961: 
peter1138@4961: 								default:
belugas@6477: 									grfmsg(1, "ParamSet: GRM: Unsupported operation %d for general sprites", op);
peter1138@4961: 									return;
peter1138@4961: 							}
peter1138@4961: 							break;
peter1138@4961: 
peter1138@6781: 						case 0x0B: // Cargo
rubidium@7690: 							/* There are two ranges: one for cargo IDs and one for cargo bitmasks */
rubidium@7690: 							src1 = PerformGRM(_grm_cargos, NUM_CARGO * 2, count, op, target, "cargos");
peter1138@6781: 							if (_skip_sprites == -1) return;
peter1138@6781: 							break;
peter1138@6781: 
belugas@6477: 						default: grfmsg(1, "ParamSet: GRM: Unsupported feature 0x%X", feature); return;
peter1138@4961: 					}
peter1138@9098: 				} else {
peter1138@9098: 					/* Ignore GRM during initialization */
peter1138@9098: 					src1 = 0;
peter1138@4961: 				}
peter1138@3808: 			}
peter1138@3808: 		} else {
peter1138@3808: 			/* Read another GRF File's parameter */
peter1138@3808: 			const GRFFile *file = GetFileByGRFID(data);
rubidium@9556: 			GRFConfig *c = GetGRFConfig(data);
rubidium@9556: 			if (c != NULL && HasBit(c->status, GCF_STATIC) && !HasBit(_cur_grfconfig->status, GCF_STATIC) && _networking) {
rubidium@9556: 				/* Disable the read GRF if it is a static NewGRF. */
rubidium@9556: 				DisableStaticNewGRFInfluencingNonStaticNewGRFs(c);
rubidium@9556: 				src1 = 0;
rubidium@9556: 			} else if (file == NULL || src1 >= file->param_end || (c != NULL && c->status == GCS_DISABLED)) {
peter1138@3808: 				src1 = 0;
peter1138@3808: 			} else {
peter1138@3808: 				src1 = file->param[src1];
peter1138@3808: 			}
peter1138@3808: 		}
dominik@452: 	} else {
peter1138@3808: 		/* The source1 and source2 operands refer to the grf parameter number
peter1138@3808: 		 * like in action 6 and 7.  In addition, they can refer to the special
peter1138@3808: 		 * variables available in action 7, or they can be FF to use the value
peter1138@3808: 		 * of <data>.  If referring to parameters that are undefined, a value
peter1138@3808: 		 * of 0 is used instead.  */
peter1138@3811: 		src1 = (src1 == 0xFF) ? data : GetParamVal(src1, NULL);
peter1138@3811: 		src2 = (src2 == 0xFF) ? data : GetParamVal(src2, NULL);
dominik@452: 	}
dominik@452: 
dominik@452: 	/* TODO: You can access the parameters of another GRF file by using
dominik@452: 	 * source2=FE, source1=the other GRF's parameter number and data=GRF
dominik@452: 	 * ID.  This is only valid with operation 00 (set).  If the GRF ID
dominik@452: 	 * cannot be found, a value of 0 is used for the parameter value
dominik@452: 	 * instead. */
dominik@452: 
peter1138@6281: 	uint32 res;
dominik@452: 	switch (oper) {
dominik@452: 		case 0x00:
tron@2345: 			res = src1;
dominik@452: 			break;
tron@2345: 
tron@2345: 		case 0x01:
tron@2345: 			res = src1 + src2;
dominik@452: 			break;
tron@2345: 
tron@2345: 		case 0x02:
tron@2345: 			res = src1 - src2;
tron@2345: 			break;
tron@2345: 
dominik@452: 		case 0x03:
tron@2345: 			res = src1 * src2;
dominik@452: 			break;
tron@2345: 
dominik@452: 		case 0x04:
tron@2345: 			res = (int32)src1 * (int32)src2;
dominik@452: 			break;
tron@2345: 
dominik@452: 		case 0x05:
tron@4077: 			if ((int32)src2 < 0) {
tron@2345: 				res = src1 >> -(int32)src2;
tron@4077: 			} else {
tron@2345: 				res = src1 << src2;
tron@4077: 			}
dominik@452: 			break;
tron@2345: 
dominik@452: 		case 0x06:
tron@4077: 			if ((int32)src2 < 0) {
tron@2345: 				res = (int32)src1 >> -(int32)src2;
tron@4077: 			} else {
tron@2345: 				res = (int32)src1 << src2;
tron@4077: 			}
dominik@452: 			break;
tron@2345: 
belugas@6348: 		case 0x07: // Bitwise AND
peter1138@2442: 			res = src1 & src2;
peter1138@2442: 			break;
peter1138@2442: 
belugas@6348: 		case 0x08: // Bitwise OR
peter1138@2442: 			res = src1 | src2;
peter1138@2442: 			break;
peter1138@2442: 
belugas@6348: 		case 0x09: // Unsigned division
peter1138@2442: 			if (src2 == 0) {
peter1138@2442: 				res = src1;
peter1138@2442: 			} else {
peter1138@2442: 				res = src1 / src2;
peter1138@2442: 			}
peter1138@2442: 			break;
peter1138@2442: 
belugas@6348: 		case 0x0A: // Signed divison
peter1138@2442: 			if (src2 == 0) {
peter1138@2442: 				res = src1;
peter1138@2442: 			} else {
peter1138@2442: 				res = (int32)src1 / (int32)src2;
peter1138@2442: 			}
peter1138@2442: 			break;
peter1138@2442: 
belugas@6348: 		case 0x0B: // Unsigned modulo
peter1138@2442: 			if (src2 == 0) {
peter1138@2442: 				res = src1;
peter1138@2442: 			} else {
peter1138@2442: 				res = src1 % src2;
peter1138@2442: 			}
peter1138@2442: 			break;
peter1138@2442: 
belugas@6348: 		case 0x0C: // Signed modulo
peter1138@2442: 			if (src2 == 0) {
peter1138@2442: 				res = src1;
peter1138@2442: 			} else {
peter1138@2442: 				res = (int32)src1 % (int32)src2;
peter1138@2442: 			}
peter1138@2442: 			break;
peter1138@2442: 
Darkvater@5380: 		default: grfmsg(0, "ParamSet: Unknown operation %d, skipping", oper); return;
tron@2345: 	}
tron@2345: 
tron@2345: 	switch (target) {
tron@2345: 		case 0x8E: // Y-Offset for train sprites
tron@2345: 			_traininfo_vehicle_pitch = res;
tron@2345: 			break;
tron@2345: 
peter1138@10002: 		case 0x8F: { // Rail track type cost factors
peter1138@10002: 			extern RailtypeInfo _railtypes[RAILTYPE_END];
peter1138@10002: 			_railtypes[RAILTYPE_RAIL].cost_multiplier = GB(res, 0, 8);
rubidium@9413: 			if (_settings_game.vehicle.disable_elrails) {
peter1138@10002: 				_railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 0, 8);
peter1138@10002: 				_railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 8, 8);
maedhros@7730: 			} else {
peter1138@10002: 				_railtypes[RAILTYPE_ELECTRIC].cost_multiplier = GB(res, 8, 8);
peter1138@10002: 				_railtypes[RAILTYPE_MONO].cost_multiplier = GB(res, 16, 8);
maedhros@7730: 			}
peter1138@10002: 			_railtypes[RAILTYPE_MAGLEV].cost_multiplier = GB(res, 16, 8);
maedhros@7730: 			break;
peter1138@10002: 		}
maedhros@7730: 
belugas@6348: 		/* @todo implement */
tron@2345: 		case 0x93: // Tile refresh offset to left
tron@2345: 		case 0x94: // Tile refresh offset to right
tron@2345: 		case 0x95: // Tile refresh offset upwards
tron@2345: 		case 0x96: // Tile refresh offset downwards
tron@2345: 		case 0x97: // Snow line height
tron@2345: 		case 0x99: // Global ID offset
Darkvater@5380: 			grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
tron@2345: 			break;
tron@2345: 
belugas@6348: 		case 0x9E: // Miscellaneous GRF features
peter1138@3814: 			_misc_grf_features = res;
peter1138@3845: 			/* Set train list engine width */
maedhros@6541: 			_traininfo_vehicle_width = HasGrfMiscBit(GMB_TRAIN_WIDTH_32_PIXELS) ? 32 : 29;
peter1138@3814: 			break;
peter1138@3814: 
frosch@8546: 		case 0x9F: // locale-dependent settings
frosch@8546: 			grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target);
frosch@8546: 			break;
frosch@8546: 
tron@2345: 		default:
tron@2345: 			if (target < 0x80) {
tron@2345: 				_cur_grffile->param[target] = res;
tron@2345: 				if (target + 1U > _cur_grffile->param_end) _cur_grffile->param_end = target + 1;
tron@2345: 			} else {
Darkvater@5380: 				grfmsg(7, "ParamSet: Skipping unknown target 0x%02X", target);
tron@2345: 			}
tron@2345: 			break;
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@5502: /* Action 0x0E (GLS_SAFETYSCAN) */
glx@9146: static void SafeGRFInhibit(byte *buf, size_t len)
peter1138@5502: {
peter1138@5502: 	/* <0E> <num> <grfids...>
peter1138@5502: 	 *
peter1138@5502: 	 * B num           Number of GRFIDs that follow
peter1138@5502: 	 * D grfids        GRFIDs of the files to deactivate */
peter1138@5502: 
peter1138@6281: 	if (!check_length(len, 2, "GRFInhibit")) return;
peter1138@6281: 	buf++;
peter1138@6281: 	uint8 num = grf_load_byte(&buf);
peter1138@6281: 	if (!check_length(len, 2 + 4 * num, "GRFInhibit")) return;
peter1138@6281: 
peter1138@6281: 	for (uint i = 0; i < num; i++) {
peter1138@5502: 		uint32 grfid = grf_load_dword(&buf);
peter1138@5502: 
peter1138@5502: 		/* GRF is unsafe it if tries to deactivate other GRFs */
peter1138@5502: 		if (grfid != _cur_grfconfig->grfid) {
skidd13@7931: 			SetBit(_cur_grfconfig->flags, GCF_UNSAFE);
peter1138@5502: 
peter1138@5502: 			/* Skip remainder of GRF */
peter1138@5502: 			_skip_sprites = -1;
peter1138@5502: 
peter1138@5502: 			return;
peter1138@5502: 		}
peter1138@5502: 	}
peter1138@5502: }
peter1138@5502: 
peter1138@3715: /* Action 0x0E */
glx@9146: static void GRFInhibit(byte *buf, size_t len)
dominik@452: {
dominik@452: 	/* <0E> <num> <grfids...>
dominik@452: 	 *
dominik@452: 	 * B num           Number of GRFIDs that follow
dominik@452: 	 * D grfids        GRFIDs of the files to deactivate */
dominik@452: 
peter1138@6281: 	if (!check_length(len, 2, "GRFInhibit")) return;
peter1138@6281: 	buf++;
peter1138@6281: 	uint8 num = grf_load_byte(&buf);
peter1138@6281: 	if (!check_length(len, 2 + 4 * num, "GRFInhibit")) return;
peter1138@6281: 
peter1138@6281: 	for (uint i = 0; i < num; i++) {
dominik@452: 		uint32 grfid = grf_load_dword(&buf);
peter1138@5333: 		GRFConfig *file = GetGRFConfig(grfid);
dominik@452: 
dominik@452: 		/* Unset activation flag */
peter1138@5369: 		if (file != NULL && file != _cur_grfconfig) {
Darkvater@5380: 			grfmsg(2, "GRFInhibit: Deactivating file '%s'", file->filename);
maedhros@6229: 			file->status = GCS_DISABLED;
dominik@452: 		}
dominik@452: 	}
dominik@452: }
dominik@452: 
glx@6956: /* Action 0x0F */
glx@9146: static void FeatureTownName(byte *buf, size_t len)
glx@6956: {
glx@6956: 	/* <0F> <id> <style-name> <num-parts> <parts>
glx@6956: 	 *
glx@6956: 	 * B id          ID of this definition in bottom 7 bits (final definition if bit 7 set)
glx@6956: 	 * V style-name  Name of the style (only for final definition)
glx@6956: 	 * B num-parts   Number of parts in this definition
glx@6956: 	 * V parts       The parts */
glx@6956: 
glx@6956: 	if (!check_length(len, 1, "FeatureTownName: definition ID")) return;
glx@6956: 	buf++; len--;
glx@6956: 
glx@6956: 	uint32 grfid = _cur_grffile->grfid;
glx@6956: 
glx@6956: 	GRFTownName *townname = AddGRFTownName(grfid);
glx@6956: 
glx@6956: 	byte id = grf_load_byte(&buf);
glx@6956: 	len--;
glx@6956: 	grfmsg(6, "FeatureTownName: definition 0x%02X", id & 0x7F);
glx@6956: 
skidd13@7928: 	if (HasBit(id, 7)) {
glx@6956: 		/* Final definition */
skidd13@7929: 		ClrBit(id, 7);
glx@6956: 		bool new_scheme = _cur_grffile->grf_version >= 7;
glx@6956: 
glx@6956: 		if (!check_length(len, 1, "FeatureTownName: lang_id")) return;
glx@6956: 		byte lang = grf_load_byte(&buf);
glx@6956: 		len--;
glx@6956: 
glx@6956: 		byte nb_gen = townname->nb_gen;
glx@6956: 		do {
skidd13@7929: 			ClrBit(lang, 7);
glx@6956: 
glx@6956: 			if (!check_length(len, 1, "FeatureTownName: style name")) return;
glx@6956: 			const char *name = grf_load_string(&buf, len);
glx@6956: 			len -= strlen(name) + 1;
peter1138@8656: 			grfmsg(6, "FeatureTownName: lang 0x%X -> '%s'", lang, TranslateTTDPatchCodes(grfid, name));
glx@6956: 
glx@6956: 			townname->name[nb_gen] = AddGRFString(grfid, id, lang, new_scheme, name, STR_UNDEFINED);
glx@6956: 
glx@6956: 			if (!check_length(len, 1, "FeatureTownName: lang_id")) return;
glx@6956: 			lang = grf_load_byte(&buf);
glx@6956: 			len--;
glx@6956: 		} while (lang != 0);
glx@6956: 		townname->id[nb_gen] = id;
glx@6956: 		townname->nb_gen++;
glx@6956: 	}
glx@6956: 
glx@6956: 	if (!check_length(len, 1, "FeatureTownName: number of parts")) return;
glx@6956: 	byte nb = grf_load_byte(&buf);
glx@6956: 	len--;
glx@6956: 	grfmsg(6, "FeatureTownName: %d parts", nb, nb);
glx@6956: 
glx@6956: 	townname->nbparts[id] = nb;
glx@6956: 	townname->partlist[id] = CallocT<NamePartList>(nb);
glx@6956: 
glx@6956: 	for (int i = 0; i < nb; i++) {
glx@6956: 		if (!check_length(len, 3, "FeatureTownName: parts header")) return;
glx@6956: 		byte nbtext =  grf_load_byte(&buf);
glx@6956: 		townname->partlist[id][i].bitstart  = grf_load_byte(&buf);
glx@6956: 		townname->partlist[id][i].bitcount  = grf_load_byte(&buf);
glx@6956: 		townname->partlist[id][i].maxprob   = 0;
glx@6956: 		townname->partlist[id][i].partcount = nbtext;
glx@6956: 		townname->partlist[id][i].parts     = CallocT<NamePart>(nbtext);
glx@6956: 		len -= 3;
glx@6956: 		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);
glx@6956: 
glx@6956: 		for (int j = 0; j < nbtext; j++) {
glx@6956: 			if (!check_length(len, 2, "FeatureTownName: part")) return;
glx@6956: 			byte prob = grf_load_byte(&buf);
glx@6956: 			len--;
glx@6956: 
skidd13@7928: 			if (HasBit(prob, 7)) {
glx@6956: 				byte ref_id = grf_load_byte(&buf);
glx@6956: 				len--;
glx@6956: 
glx@6956: 				if (townname->nbparts[ref_id] == 0) {
glx@6956: 					grfmsg(0, "FeatureTownName: definition 0x%02X doesn't exist, deactivating", ref_id);
glx@6956: 					DelGRFTownName(grfid);
glx@6956: 					_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 					ClearTemporaryNewGRFData();
glx@6956: 					_skip_sprites = -1;
glx@6956: 					return;
glx@6956: 				}
glx@6956: 
glx@6956: 				grfmsg(6, "FeatureTownName: part %d, text %d, uses intermediate definition 0x%02X (with probability %d)", i, j, ref_id, prob & 0x7F);
glx@6956: 				townname->partlist[id][i].parts[j].data.id = ref_id;
glx@6956: 			} else {
glx@6956: 				const char *text = grf_load_string(&buf, len);
glx@6956: 				len -= strlen(text) + 1;
peter1138@8656: 				townname->partlist[id][i].parts[j].data.text = TranslateTTDPatchCodes(grfid, text);
glx@6956: 				grfmsg(6, "FeatureTownName: part %d, text %d, '%s' (with probability %d)", i, j, townname->partlist[id][i].parts[j].data.text, prob);
glx@6956: 			}
glx@6956: 			townname->partlist[id][i].parts[j].prob = prob;
glx@6956: 			townname->partlist[id][i].maxprob += GB(prob, 0, 7);
glx@6956: 		}
glx@6956: 		grfmsg(6, "FeatureTownName: part %d, total probability %d", i, townname->partlist[id][i].maxprob);
glx@6956: 	}
glx@6956: }
glx@6956: 
peter1138@3715: /* Action 0x10 */
glx@9146: static void DefineGotoLabel(byte *buf, size_t len)
Darkvater@3561: {
Darkvater@3561: 	/* <10> <label> [<comment>]
Darkvater@3561: 	 *
Darkvater@3561: 	 * B label      The label to define
Darkvater@3561: 	 * V comment    Optional comment - ignored */
Darkvater@3561: 
peter1138@5590: 	if (!check_length(len, 1, "DefineGotoLabel")) return;
Darkvater@3561: 	buf++; len--;
Darkvater@3561: 
peter1138@6281: 	GRFLabel *label = MallocT<GRFLabel>(1);
Darkvater@3561: 	label->label    = grf_load_byte(&buf);
Darkvater@3561: 	label->nfo_line = _nfo_line;
Darkvater@3561: 	label->pos      = FioGetPos();
Darkvater@3561: 	label->next     = NULL;
Darkvater@3561: 
Darkvater@3561: 	/* Set up a linked list of goto targets which we will search in an Action 0x7/0x9 */
Darkvater@3561: 	if (_cur_grffile->label == NULL) {
Darkvater@3561: 		_cur_grffile->label = label;
Darkvater@3561: 	} else {
Darkvater@3561: 		/* Attach the label to the end of the list */
Darkvater@3561: 		GRFLabel *l;
smatz@8695: 		for (l = _cur_grffile->label; l->next != NULL; l = l->next) {}
Darkvater@3561: 		l->next = label;
Darkvater@3561: 	}
Darkvater@3561: 
Darkvater@5380: 	grfmsg(2, "DefineGotoLabel: GOTO target with label 0x%02X", label->label);
Darkvater@3561: }
dominik@452: 
peter1138@4656: /* Action 0x11 */
glx@9146: static void GRFSound(byte *buf, size_t len)
peter1138@4656: {
peter1138@4656: 	/* <11> <num>
peter1138@4656: 	 *
peter1138@4656: 	 * W num      Number of sound files that follow */
peter1138@4656: 
peter1138@5590: 	if (!check_length(len, 1, "GRFSound")) return;
peter1138@4656: 	buf++;
peter1138@6281: 	uint16 num = grf_load_word(&buf);
peter1138@4656: 
peter1138@4656: 	_grf_data_blocks = num;
peter1138@4656: 	_grf_data_type   = GDT_SOUND;
peter1138@4656: 
peter1138@4656: 	if (_cur_grffile->sound_offset == 0) _cur_grffile->sound_offset = GetNumSounds();
peter1138@4656: }
peter1138@4656: 
frosch@8431: /* Action 0x11 (SKIP) */
glx@9146: static void SkipAct11(byte *buf, size_t len)
frosch@8431: {
frosch@8431: 	/* <11> <num>
frosch@8431: 	 *
frosch@8431: 	 * W num      Number of sound files that follow */
frosch@8431: 
frosch@8431: 	if (!check_length(len, 1, "SkipAct11")) return;
frosch@8431: 	buf++;
frosch@8431: 	_skip_sprites = grf_load_word(&buf);
frosch@8431: 
frosch@8431: 	grfmsg(3, "SkipAct11: Skipping %d sprites", _skip_sprites);
frosch@8431: }
frosch@8431: 
peter1138@4818: static void ImportGRFSound(byte *buf, int len)
peter1138@4818: {
peter1138@4818: 	const GRFFile *file;
peter1138@4818: 	FileEntry *se = AllocateFileEntry();
peter1138@4818: 	uint32 grfid = grf_load_dword(&buf);
peter1138@4818: 	uint16 sound = grf_load_word(&buf);
peter1138@4818: 
peter1138@4818: 	file = GetFileByGRFID(grfid);
peter1138@4818: 	if (file == NULL || file->sound_offset == 0) {
Darkvater@5380: 		grfmsg(1, "ImportGRFSound: Source file not available");
peter1138@4818: 		return;
peter1138@4818: 	}
peter1138@4818: 
peter1138@4818: 	if (file->sound_offset + sound >= GetNumSounds()) {
Darkvater@5380: 		grfmsg(1, "ImportGRFSound: Sound effect %d is invalid", sound);
peter1138@4818: 		return;
peter1138@4818: 	}
peter1138@4818: 
Darkvater@5380: 	grfmsg(2, "ImportGRFSound: Copying sound %d (%d) from file %X", sound, file->sound_offset + sound, grfid);
peter1138@4818: 
tron@5024: 	*se = *GetSound(file->sound_offset + sound);
peter1138@4818: 
peter1138@4818: 	/* Reset volume and priority, which TTDPatch doesn't copy */
peter1138@4818: 	se->volume   = 128;
peter1138@4818: 	se->priority = 0;
peter1138@4818: }
peter1138@4818: 
peter1138@4818: /* 'Action 0xFE' */
peter1138@4818: static void GRFImportBlock(byte *buf, int len)
peter1138@4818: {
peter1138@4818: 	if (_grf_data_blocks == 0) {
Darkvater@5380: 		grfmsg(2, "GRFImportBlock: Unexpected import block, skipping");
peter1138@4818: 		return;
peter1138@4818: 	}
peter1138@4818: 
peter1138@4818: 	buf++;
peter1138@4818: 
peter1138@4818: 	_grf_data_blocks--;
peter1138@4818: 
peter1138@4818: 	/* XXX 'Action 0xFE' isn't really specified. It is only mentioned for
peter1138@4818: 	 * importing sounds, so this is probably all wrong... */
peter1138@4818: 	if (grf_load_byte(&buf) != _grf_data_type) {
Darkvater@5380: 		grfmsg(1, "GRFImportBlock: Import type mismatch");
peter1138@4818: 	}
peter1138@4818: 
peter1138@4818: 	switch (_grf_data_type) {
peter1138@4818: 		case GDT_SOUND: ImportGRFSound(buf, len - 1); break;
peter1138@4818: 		default: NOT_REACHED(); break;
peter1138@4818: 	}
peter1138@4818: }
peter1138@4818: 
peter1138@4656: static void LoadGRFSound(byte *buf, int len)
peter1138@4656: {
peter1138@4656: 	byte *buf_start = buf;
peter1138@4656: 
peter1138@4656: 	/* Allocate a sound entry. This is done even if the data is not loaded
peter1138@4656: 	 * so that the indices used elsewhere are still correct. */
peter1138@6281: 	FileEntry *se = AllocateFileEntry();
peter1138@4656: 
Darkvater@5379: 	if (grf_load_dword(&buf) != BSWAP32('RIFF')) {
Darkvater@5380: 		grfmsg(1, "LoadGRFSound: Missing RIFF header");
peter1138@4656: 		return;
peter1138@4656: 	}
peter1138@4656: 
peter1138@4656: 	/* Size of file -- we ignore this */
peter1138@4656: 	grf_load_dword(&buf);
peter1138@4656: 
Darkvater@5379: 	if (grf_load_dword(&buf) != BSWAP32('WAVE')) {
Darkvater@5380: 		grfmsg(1, "LoadGRFSound: Invalid RIFF type");
peter1138@4656: 		return;
peter1138@4656: 	}
peter1138@4656: 
peter1138@4656: 	for (;;) {
peter1138@4656: 		uint32 tag  = grf_load_dword(&buf);
peter1138@4656: 		uint32 size = grf_load_dword(&buf);
peter1138@4656: 
peter1138@4656: 		switch (tag) {
belugas@6348: 			case ' tmf': // 'fmt '
peter1138@4656: 				/* Audio format, must be 1 (PCM) */
peter1138@4656: 				if (grf_load_word(&buf) != 1) {
Darkvater@5380: 					grfmsg(1, "LoadGRFSound: Invalid audio format");
peter1138@4656: 					return;
peter1138@4656: 				}
peter1138@4656: 				se->channels = grf_load_word(&buf);
peter1138@4656: 				se->rate = grf_load_dword(&buf);
peter1138@4656: 				grf_load_dword(&buf);
peter1138@4656: 				grf_load_word(&buf);
peter1138@4656: 				se->bits_per_sample = grf_load_word(&buf);
peter1138@4656: 
peter1138@4656: 				/* Consume any extra bytes */
peter1138@4656: 				for (; size > 16; size--) grf_load_byte(&buf);
peter1138@4656: 				break;
peter1138@4656: 
belugas@6348: 			case 'atad': // 'data'
truelight@7570: 				se->file_size   = size;
truelight@7570: 				se->file_offset = FioGetPos() - (len - (buf - buf_start)) + 1;
truelight@7570: 				se->file_slot   = _file_index;
peter1138@4656: 
peter1138@4656: 				/* Set default volume and priority */
peter1138@4656: 				se->volume = 0x80;
peter1138@4656: 				se->priority = 0;
peter1138@4656: 
Darkvater@5380: 				grfmsg(2, "LoadGRFSound: channels %u, sample rate %u, bits per sample %u, length %u", se->channels, se->rate, se->bits_per_sample, size);
peter1138@4656: 				return;
peter1138@4656: 
peter1138@4656: 			default:
peter1138@4656: 				se->file_size = 0;
peter1138@4656: 				return;
peter1138@4656: 		}
peter1138@4656: 	}
peter1138@4656: }
peter1138@4656: 
peter1138@5108: /* Action 0x12 */
glx@9146: static void LoadFontGlyph(byte *buf, size_t len)
peter1138@5108: {
peter1138@5108: 	/* <12> <num_def> <font_size> <num_char> <base_char>
peter1138@5108: 	 *
peter1138@5108: 	 * B num_def      Number of definitions
peter1138@5108: 	 * B font_size    Size of font (0 = normal, 1 = small, 2 = large)
peter1138@5108: 	 * B num_char     Number of consecutive glyphs
peter1138@5108: 	 * W base_char    First character index */
peter1138@5108: 
peter1138@5108: 	buf++; len--;
peter1138@5590: 	if (!check_length(len, 1, "LoadFontGlyph")) return;
peter1138@5108: 
peter1138@6281: 	uint8 num_def = grf_load_byte(&buf);
peter1138@5108: 
peter1138@5590: 	if (!check_length(len, 1 + num_def * 4, "LoadFontGlyph")) return;
peter1138@5108: 
peter1138@6281: 	for (uint i = 0; i < num_def; i++) {
rubidium@5587: 		FontSize size    = (FontSize)grf_load_byte(&buf);
peter1138@5108: 		uint8  num_char  = grf_load_byte(&buf);
peter1138@5108: 		uint16 base_char = grf_load_word(&buf);
peter1138@5108: 
Darkvater@5380: 		grfmsg(7, "LoadFontGlyph: Loading %u glyph(s) at 0x%04X for size %u", num_char, base_char, size);
peter1138@5108: 
peter1138@6281: 		for (uint c = 0; c < num_char; c++) {
peter1138@5108: 			SetUnicodeGlyph(size, base_char + c, _cur_spriteid);
rubidium@7953: 			_nfo_line++;
truelight@6908: 			LoadNextSprite(_cur_spriteid++, _file_index, _nfo_line);
peter1138@5108: 		}
peter1138@5108: 	}
peter1138@5108: }
peter1138@5108: 
frosch@8431: /* Action 0x12 (SKIP) */
glx@9146: static void SkipAct12(byte *buf, size_t len)
frosch@8431: {
frosch@8431: 	/* <12> <num_def> <font_size> <num_char> <base_char>
frosch@8431: 	 *
frosch@8431: 	 * B num_def      Number of definitions
frosch@8431: 	 * B font_size    Size of font (0 = normal, 1 = small, 2 = large)
frosch@8431: 	 * B num_char     Number of consecutive glyphs
frosch@8431: 	 * W base_char    First character index */
frosch@8431: 
frosch@8431: 	buf++; len--;
frosch@8431: 	if (!check_length(len, 1, "SkipAct12")) return;
frosch@8431: 	uint8 num_def = grf_load_byte(&buf);
frosch@8431: 
frosch@8431: 	if (!check_length(len, 1 + num_def * 4, "SkipAct12")) return;
frosch@8431: 
frosch@8431: 	for (uint i = 0; i < num_def; i++) {
frosch@8431: 		/* Ignore 'size' byte */
frosch@8431: 		grf_load_byte(&buf);
frosch@8431: 
frosch@8431: 		/* Sum up number of characters */
frosch@8431: 		_skip_sprites += grf_load_byte(&buf);
frosch@8431: 
frosch@8431: 		/* Ignore 'base_char' word */
frosch@8431: 		grf_load_word(&buf);
frosch@8431: 	}
frosch@8431: 
frosch@8431: 	grfmsg(3, "SkipAct12: Skipping %d sprites", _skip_sprites);
frosch@8431: }
frosch@8431: 
maedhros@6234: /* Action 0x13 */
glx@9146: static void TranslateGRFStrings(byte *buf, size_t len)
maedhros@6234: {
maedhros@6234: 	/* <13> <grfid> <num-ent> <offset> <text...>
maedhros@6234: 	 *
maedhros@6234: 	 * 4*B grfid     The GRFID of the file whose texts are to be translated
maedhros@6234: 	 * B   num-ent   Number of strings
maedhros@6234: 	 * W   offset    First text ID
maedhros@6234: 	 * S   text...   Zero-terminated strings */
maedhros@6234: 
maedhros@6234: 	buf++; len--;
maedhros@6234: 	if (!check_length(len, 7, "TranslateGRFString")) return;
maedhros@6234: 
maedhros@6234: 	uint32 grfid = grf_load_dword(&buf);
maedhros@6234: 	const GRFConfig *c = GetGRFConfig(grfid);
maedhros@6234: 	if (c == NULL || (c->status != GCS_INITIALISED && c->status != GCS_ACTIVATED)) {
belugas@6477: 		grfmsg(7, "TranslateGRFStrings: GRFID 0x%08x unknown, skipping action 13", BSWAP32(grfid));
maedhros@6234: 		return;
maedhros@6234: 	}
maedhros@6234: 
maedhros@6234: 	if (c->status == GCS_INITIALISED) {
maedhros@6234: 		/* If the file is not active but will be activated later, give an error
maedhros@6234: 		 * and disable this file. */
maedhros@6234: 		GRFError *error = CallocT<GRFError>(1);
maedhros@6873: 
maedhros@6873: 		char tmp[256];
maedhros@6873: 		GetString(tmp, STR_NEWGRF_ERROR_AFTER_TRANSLATED_FILE, lastof(tmp));
maedhros@6873: 		error->data = strdup(tmp);
maedhros@6873: 
maedhros@6234: 		error->message  = STR_NEWGRF_ERROR_LOAD_AFTER;
maedhros@6234: 		error->severity = STR_NEWGRF_ERROR_MSG_FATAL;
maedhros@6234: 
maedhros@6234: 		if (_cur_grfconfig->error != NULL) free(_cur_grfconfig->error);
maedhros@6234: 		_cur_grfconfig->error = error;
maedhros@6234: 
maedhros@6234: 		_cur_grfconfig->status = GCS_DISABLED;
rubidium@9619: 		ClearTemporaryNewGRFData();
maedhros@6234: 		_skip_sprites = -1;
maedhros@6234: 		return;
maedhros@6234: 	}
maedhros@6234: 
maedhros@6234: 	byte num_strings = grf_load_byte(&buf);
maedhros@6234: 	uint16 first_id  = grf_load_word(&buf);
maedhros@6234: 
maedhros@6234: 	if (!((first_id >= 0xD000 && first_id + num_strings <= 0xD3FF) || (first_id >= 0xDC00 && first_id + num_strings <= 0xDCFF))) {
belugas@6477: 		grfmsg(7, "TranslateGRFStrings: Attempting to set out-of-range string IDs in action 13 (first: 0x%4X, number: 0x%2X)", first_id, num_strings);
maedhros@6234: 		return;
maedhros@6234: 	}
maedhros@6234: 
maedhros@6234: 	len -= 7;
maedhros@6234: 
maedhros@6234: 	for (uint i = 0; i < num_strings && len > 0; i++) {
maedhros@6234: 		const char *string   = grf_load_string(&buf, len);
maedhros@6234: 		size_t string_length = strlen(string) + 1;
maedhros@6234: 
maedhros@6234: 		len -= (int)string_length;
maedhros@6234: 
maedhros@6234: 		if (string_length == 1) {
maedhros@6234: 			grfmsg(7, "TranslateGRFString: Ignoring empty string.");
maedhros@6234: 			continue;
maedhros@6234: 		}
maedhros@6234: 
maedhros@6234: 		/* Since no language id is supplied this string has to be added as a
maedhros@6234: 		 * generic string, thus the language id of 0x7F. For this to work
maedhros@6234: 		 * new_scheme has to be true as well. A language id of 0x7F will be
maedhros@6234: 		 * overridden by a non-generic id, so this will not change anything if
maedhros@6234: 		 * a string has been provided specifically for this language. */
maedhros@6234: 		AddGRFString(grfid, first_id + i, 0x7F, true, string, STR_UNDEFINED);
maedhros@6234: 	}
maedhros@6234: }
maedhros@6234: 
peter1138@4656: /* 'Action 0xFF' */
peter1138@4656: static void GRFDataBlock(byte *buf, int len)
peter1138@4656: {
peter1138@4656: 	if (_grf_data_blocks == 0) {
Darkvater@5380: 		grfmsg(2, "GRFDataBlock: unexpected data block, skipping");
peter1138@4656: 		return;
peter1138@4656: 	}
peter1138@4656: 
peter1138@4656: 	buf++;
peter1138@6281: 	uint8 name_len = grf_load_byte(&buf);
peter1138@6281: 	const char *name = (const char *)buf;
peter1138@4656: 	buf += name_len + 1;
peter1138@4656: 
Darkvater@5380: 	grfmsg(2, "GRFDataBlock: block name '%s'...", name);
peter1138@4656: 
peter1138@4656: 	_grf_data_blocks--;
peter1138@4656: 
peter1138@4656: 	switch (_grf_data_type) {
peter1138@4656: 		case GDT_SOUND: LoadGRFSound(buf, len - name_len - 2); break;
peter1138@4656: 		default: NOT_REACHED(); break;
peter1138@4656: 	}
peter1138@4656: }
peter1138@4656: 
peter1138@5329: 
peter1138@5329: /* Used during safety scan on unsafe actions */
glx@9146: static void GRFUnsafe(byte *buf, size_t len)
peter1138@5329: {
skidd13@7931: 	SetBit(_cur_grfconfig->flags, GCF_UNSAFE);
peter1138@5329: 
peter1138@5502: 	/* Skip remainder of GRF */
peter1138@5502: 	_skip_sprites = -1;
peter1138@5329: }
peter1138@5329: 
peter1138@5329: 
rubidium@6247: static void InitializeGRFSpecial()
dominik@452: {
rubidium@9413: 	_ttdpatch_flags[0] =  ((_settings_game.station.always_small_airport ? 1 : 0) << 0x0C)  // keepsmallairport
rubidium@9354: 	                   |                                                 (1 << 0x0D)  // newairports
rubidium@9354: 	                   |                                                 (1 << 0x0E)  // largestations
rubidium@9413: 	                   |      ((_settings_game.construction.longbridges ? 1 : 0) << 0x0F)  // longbridges
rubidium@9354: 	                   |                                                 (0 << 0x10)  // loadtime
rubidium@9354: 	                   |                                                 (1 << 0x12)  // presignals
rubidium@9354: 	                   |                                                 (1 << 0x13)  // extpresignals
rubidium@9413: 	                   | ((_settings_game.vehicle.never_expire_vehicles ? 1 : 0) << 0x16)  // enginespersist
rubidium@9354: 	                   |                                                 (1 << 0x1B)  // multihead
rubidium@9354: 	                   |                                                 (1 << 0x1D)  // lowmemory
rubidium@9354: 	                   |                                                 (1 << 0x1E); // generalfixes
rubidium@9354: 
rubidium@9413: 	_ttdpatch_flags[1] =   ((_settings_game.economy.station_noise_level ? 1 : 0) << 0x07)  // moreairports - based on units of noise
rubidium@9413: 	                   |        ((_settings_game.vehicle.mammoth_trains ? 1 : 0) << 0x08)  // mammothtrains
rubidium@9354: 	                   |                                                 (1 << 0x09)  // trainrefit
rubidium@9354: 	                   |                                                 (0 << 0x0B)  // subsidiaries
rubidium@9413: 	                   |         ((_settings_game.order.gradual_loading ? 1 : 0) << 0x0C)  // gradualloading
rubidium@9354: 	                   |                                                 (1 << 0x12)  // unifiedmaglevmode - set bit 0 mode. Not revelant to OTTD
rubidium@9354: 	                   |                                                 (1 << 0x13)  // unifiedmaglevmode - set bit 1 mode
rubidium@9354: 	                   |                                                 (1 << 0x14)  // bridgespeedlimits
rubidium@9354: 	                   |                                                 (1 << 0x16)  // eternalgame
rubidium@9354: 	                   |                                                 (1 << 0x17)  // newtrains
rubidium@9354: 	                   |                                                 (1 << 0x18)  // newrvs
rubidium@9354: 	                   |                                                 (1 << 0x19)  // newships
rubidium@9354: 	                   |                                                 (1 << 0x1A)  // newplanes
rubidium@9413: 	                   |      ((_settings_game.construction.signal_side ? 1 : 0) << 0x1B)  // signalsontrafficside
rubidium@9413: 	                   |       ((_settings_game.vehicle.disable_elrails ? 0 : 1) << 0x1C); // electrifiedrailway
rubidium@9354: 
rubidium@9354: 	_ttdpatch_flags[2] =                                                 (1 << 0x01)  // loadallgraphics - obsolote
rubidium@9354: 	                   |                                                 (1 << 0x03)  // semaphores
rubidium@9354: 	                   |                                                 (0 << 0x0B)  // enhancedgui
rubidium@9354: 	                   |                                                 (0 << 0x0C)  // newagerating
rubidium@9413: 	                   |  ((_settings_game.construction.build_on_slopes ? 1 : 0) << 0x0D)  // buildonslopes
rubidium@9354: 	                   |                                                 (1 << 0x0E)  // fullloadany
rubidium@9354: 	                   |                                                 (1 << 0x0F)  // planespeed
rubidium@9354: 	                   |                                                 (0 << 0x10)  // moreindustriesperclimate - obsolete
rubidium@9354: 	                   |                                                 (0 << 0x11)  // moretoylandfeatures
rubidium@9354: 	                   |                                                 (1 << 0x12)  // newstations
rubidium@9354: 	                   |                                                 (1 << 0x13)  // tracktypecostdiff
rubidium@9354: 	                   |                                                 (1 << 0x14)  // manualconvert
rubidium@9413: 	                   |  ((_settings_game.construction.build_on_slopes ? 1 : 0) << 0x15)  // buildoncoasts
rubidium@9354: 	                   |                                                 (1 << 0x16)  // canals
rubidium@9354: 	                   |                                                 (1 << 0x17)  // newstartyear
rubidium@9413: 	                   |    ((_settings_game.vehicle.freight_trains > 1 ? 1 : 0) << 0x18)  // freighttrains
rubidium@9354: 	                   |                                                 (1 << 0x19)  // newhouses
rubidium@9354: 	                   |                                                 (1 << 0x1A)  // newbridges
rubidium@9354: 	                   |                                                 (1 << 0x1B)  // newtownnames
rubidium@9354: 	                   |                                                 (1 << 0x1C)  // moreanimation
rubidium@9413: 	                   |    ((_settings_game.vehicle.wagon_speed_limits ? 1 : 0) << 0x1D)  // wagonspeedlimits
rubidium@9354: 	                   |                                                 (1 << 0x1E)  // newshistory
rubidium@9354: 	                   |                                                 (0 << 0x1F); // custombridgeheads
rubidium@9354: 
rubidium@9354: 	_ttdpatch_flags[3] =                                                 (0 << 0x00)  // newcargodistribution
rubidium@9354: 	                   |                                                 (1 << 0x01)  // windowsnap
rubidium@9354: 	                   |                                                 (0 << 0x02)  // townbuildnoroad
rubidium@9354: 	                   |                                                 (0 << 0x03)  // pathbasedsignalling. To enable if ever pbs is back
rubidium@9354: 	                   |                                                 (0 << 0x04)  // aichoosechance
rubidium@9354: 	                   |                                                 (1 << 0x05)  // resolutionwidth
rubidium@9354: 	                   |                                                 (1 << 0x06)  // resolutionheight
rubidium@9354: 	                   |                                                 (1 << 0x07)  // newindustries
rubidium@9413: 	                   |           ((_settings_game.order.improved_load ? 1 : 0) << 0x08)  // fifoloading
rubidium@9354: 	                   |                                                 (0 << 0x09)  // townroadbranchprob
rubidium@9354: 	                   |                                                 (0 << 0x0A)  // tempsnowline
rubidium@9354: 	                   |                                                 (1 << 0x0B)  // newcargo
rubidium@9354: 	                   |                                                 (1 << 0x0C)  // enhancemultiplayer
rubidium@9354: 	                   |                                                 (1 << 0x0D)  // onewayroads
rubidium@9413: 	                   |   ((_settings_game.station.nonuniform_stations ? 1 : 0) << 0x0E)  // irregularstations
rubidium@9354: 	                   |                                                 (1 << 0x0F)  // statistics
rubidium@9354: 	                   |                                                 (1 << 0x10)  // newsounds
rubidium@9354: 	                   |                                                 (1 << 0x11)  // autoreplace
rubidium@9354: 	                   |                                                 (1 << 0x12)  // autoslope
rubidium@9354: 	                   |                                                 (0 << 0x13)  // followvehicle
rubidium@9354: 	                   |                                                 (1 << 0x14)  // trams
rubidium@9354: 	                   |                                                 (0 << 0x15)  // enhancetunnels
rubidium@9354: 	                   |                                                 (1 << 0x16)  // shortrvs
rubidium@9354: 	                   |                                                 (1 << 0x17)  // articulatedrvs
rubidium@9413: 	                   |       ((_settings_game.vehicle.dynamic_engines ? 1 : 0) << 0x18)  // dynamic engines
rubidium@9354: 	                   |                                                 (1 << 0x1E); // variablerunningcosts
dominik@452: }
dominik@452: 
rubidium@6247: static void ResetCustomStations()
peter1138@2625: {
peter1138@6281: 	for (GRFFile *file = _first_grffile; file != NULL; file = file->next) {
peter1138@3768: 		if (file->stations == NULL) continue;
peter1138@6281: 		for (uint i = 0; i < MAX_STATIONS; i++) {
peter1138@3768: 			if (file->stations[i] == NULL) continue;
peter1138@6281: 			StationSpec *statspec = file->stations[i];
peter1138@3740: 
peter1138@3740: 			/* Release renderdata, if it wasn't copied from another custom station spec  */
peter1138@3740: 			if (!statspec->copied_renderdata) {
peter1138@6281: 				for (uint t = 0; t < statspec->tiles; t++) {
peter1138@3740: 					free((void*)statspec->renderdata[t].seq);
peter1138@3740: 				}
peter1138@3740: 				free(statspec->renderdata);
peter1138@3740: 			}
peter1138@3740: 
peter1138@5061: 			/* Release platforms and layouts */
peter1138@5061: 			if (!statspec->copied_layouts) {
peter1138@6281: 				for (uint l = 0; l < statspec->lengths; l++) {
peter1138@6281: 					for (uint p = 0; p < statspec->platforms[l]; p++) {
peter1138@5061: 						free(statspec->layouts[l][p]);
peter1138@5061: 					}
peter1138@5061: 					free(statspec->layouts[l]);
peter1138@5061: 				}
peter1138@5061: 				free(statspec->layouts);
peter1138@5061: 				free(statspec->platforms);
peter1138@5061: 			}
peter1138@3768: 
peter1138@3768: 			/* Release this station */
peter1138@3768: 			free(statspec);
peter1138@2625: 		}
peter1138@3501: 
peter1138@3501: 		/* Free and reset the station data */
peter1138@3501: 		free(file->stations);
peter1138@3501: 		file->stations = NULL;
peter1138@2625: 	}
peter1138@2625: }
peter1138@2625: 
maedhros@6332: static void ResetCustomHouses()
maedhros@6332: {
maedhros@6332: 	GRFFile *file;
maedhros@6332: 	uint i;
maedhros@6332: 
maedhros@6332: 	for (file = _first_grffile; file != NULL; file = file->next) {
maedhros@6332: 		if (file->housespec == NULL) continue;
belugas@6848: 		for (i = 0; i < HOUSE_MAX; i++) {
belugas@6848: 			free(file->housespec[i]);
belugas@6848: 		}
maedhros@6332: 
maedhros@6332: 		free(file->housespec);
maedhros@6332: 		file->housespec = NULL;
maedhros@6332: 	}
maedhros@6332: }
maedhros@6332: 
belugas@6759: static void ResetCustomIndustries()
belugas@6759: {
belugas@6759: 	GRFFile *file;
belugas@6759: 
belugas@6759: 	for (file = _first_grffile; file != NULL; file = file->next) {
belugas@6759: 		uint i;
belugas@6759: 		/* We are verifiying both tiles and industries specs loaded from the grf file
belugas@6759: 		 * First, let's deal with industryspec */
belugas@6759: 		if (file->industryspec != NULL) {
belugas@6759: 
belugas@6759: 			for (i = 0; i < NUM_INDUSTRYTYPES; i++) {
belugas@6759: 				IndustrySpec *ind = file->industryspec[i];
belugas@6759: 
belugas@6759: 				if (ind != NULL) {
belugas@6765: 					/* We need to remove the sounds array */
skidd13@7928: 					if (HasBit(ind->cleanup_flag, CLEAN_RANDOMSOUNDS)) {
belugas@6765: 						free((void*)ind->random_sounds);
belugas@6765: 					}
belugas@6765: 
belugas@6765: 					/* We need to remove the tiles layouts */
skidd13@7928: 					if (HasBit(ind->cleanup_flag, CLEAN_TILELSAYOUT) && ind->table != NULL) {
belugas@6765: 						for (int j = 0; j < ind->num_table; j++) {
belugas@6765: 							/* remove the individual layouts */
belugas@6765: 							if (ind->table[j] != NULL) {
belugas@6765: 								free((IndustryTileTable*)ind->table[j]);
belugas@6765: 							}
belugas@6765: 						}
belugas@6765: 						/* remove the layouts pointers */
belugas@6765: 						free((IndustryTileTable**)ind->table);
belugas@6765: 						ind->table = NULL;
belugas@6765: 					}
belugas@6765: 
belugas@6759: 					free(ind);
belugas@6759: 					ind = NULL;
belugas@6759: 				}
belugas@6759: 			}
belugas@6759: 
belugas@6759: 			free(file->industryspec);
belugas@6759: 			file->industryspec = NULL;
belugas@6759: 		}
belugas@6759: 
belugas@6759: 		if (file->indtspec != NULL) {
belugas@6759: 			for (i = 0; i < NUM_INDUSTRYTILES; i++) {
belugas@6759: 				if (file->indtspec[i] != NULL) {
belugas@6759: 					free(file->indtspec[i]);
belugas@6759: 					file->indtspec[i] = NULL;
belugas@6759: 				}
belugas@6759: 			}
belugas@6759: 
belugas@6759: 			free(file->indtspec);
belugas@6759: 			file->indtspec = NULL;
belugas@6759: 		}
belugas@6759: 	}
belugas@6759: }
belugas@6759: 
rubidium@6247: static void ResetNewGRF()
peter1138@4953: {
peter1138@6281: 	GRFFile *next;
peter1138@6281: 
peter1138@6281: 	for (GRFFile *f = _first_grffile; f != NULL; f = next) {
peter1138@4953: 		next = f->next;
peter1138@4953: 
peter1138@4953: 		free(f->filename);
peter1138@6684: 		free(f->cargo_list);
peter1138@4953: 		free(f);
peter1138@4953: 	}
peter1138@4953: 
peter1138@4953: 	_first_grffile = NULL;
peter1138@4953: 	_cur_grffile   = NULL;
peter1138@4953: }
peter1138@4953: 
maedhros@6870: static void ResetNewGRFErrors()
maedhros@6870: {
maedhros@6870: 	for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) {
skidd13@7928: 		if (!HasBit(c->flags, GCF_COPY) && c->error != NULL) {
maedhros@6873: 			free(c->error->custom_message);
maedhros@6873: 			free(c->error->data);
maedhros@6870: 			free(c->error);
maedhros@6870: 			c->error = NULL;
maedhros@6870: 		}
maedhros@6870: 	}
maedhros@6870: }
maedhros@6870: 
peter1138@2491: /**
peter1138@2463:  * Reset all NewGRF loaded data
peter1138@2463:  * TODO
peter1138@2463:  */
rubidium@6247: static void ResetNewGRFData()
peter1138@2463: {
belugas@3601: 	CleanUpStrings();
glx@6956: 	CleanUpGRFTownNames();
belugas@3601: 
belugas@6348: 	/* Copy/reset original engine info data */
peter1138@8221: 	SetupEngines();
peter1138@2478: 
belugas@8489: 	/* Copy/reset original bridge info data */
belugas@8489: 	ResetBridges();
peter1138@2491: 
peter1138@10001: 	/* Reset rail type information */
peter1138@10001: 	ResetRailTypes();
peter1138@10001: 
peter1138@9025: 	/* Allocate temporary refit/cargo class data */
peter1138@9070: 	_gted = CallocT<GRFTempEngineData>(GetEnginePoolSize());
peter1138@2611: 
belugas@6348: 	/* Reset GRM reservations */
peter1138@4961: 	memset(&_grm_engines, 0, sizeof(_grm_engines));
peter1138@6781: 	memset(&_grm_cargos, 0, sizeof(_grm_cargos));
peter1138@4961: 
peter1138@8544: 	/* Reset generic feature callback lists */
peter1138@8544: 	ResetGenericCallbacks();
peter1138@8544: 
belugas@6348: 	/* Reset price base data */
peter1138@2506: 	ResetPriceBaseMultipliers();
peter1138@2625: 
belugas@4377: 	/* Reset the curencies array */
belugas@4377: 	ResetCurrencies();
belugas@4377: 
maedhros@6332: 	/* Reset the house array */
maedhros@6332: 	ResetCustomHouses();
maedhros@6332: 	ResetHouses();
maedhros@6332: 
belugas@6743: 	/* Reset the industries structures*/
belugas@6759: 	ResetCustomIndustries();
belugas@6743: 	ResetIndustries();
belugas@6743: 
belugas@6348: 	/* Reset station classes */
peter1138@2625: 	ResetStationClasses();
peter1138@2625: 	ResetCustomStations();
peter1138@2812: 
peter1138@8372: 	/* Reset canal sprite groups and flags */
peter1138@8372: 	memset(_water_feature, 0, sizeof(_water_feature));
peter1138@6583: 
maedhros@6343: 	/* Reset the snowline table. */
maedhros@6343: 	ClearSnowLine();
maedhros@6343: 
peter1138@4953: 	/* Reset NewGRF files */
peter1138@4953: 	ResetNewGRF();
peter1138@4953: 
maedhros@6870: 	/* Reset NewGRF errors. */
maedhros@6870: 	ResetNewGRFErrors();
maedhros@6870: 
peter1138@6091: 	/* Set up the default cargo types */
rubidium@9413: 	SetupCargoForClimate(_settings_game.game_creation.landscape);
peter1138@6091: 
peter1138@3845: 	/* Reset misc GRF features and train list display variables */
peter1138@3845: 	_misc_grf_features = 0;
peter1138@3845: 	_traininfo_vehicle_pitch = 0;
peter1138@3845: 	_traininfo_vehicle_width = 29;
belugas@6769: 
belugas@6914: 	_loaded_newgrf_features.has_2CC           = false;
belugas@6914: 	_loaded_newgrf_features.has_newhouses     = false;
belugas@7661: 	_loaded_newgrf_features.has_newindustries = false;
frosch@8403: 	_loaded_newgrf_features.shore             = SHORE_REPLACE_NONE;
peter1138@3845: 
peter1138@9070: 	/* Clear all GRF overrides */
peter1138@9070: 	_grf_id_overrides.clear();
peter1138@9070: 
peter1138@4656: 	InitializeSoundPool();
peter1138@3595: 	InitializeSpriteGroupPool();
peter1138@2463: }
peter1138@2463: 
peter1138@6147: static void BuildCargoTranslationMap()
peter1138@6147: {
peter1138@6147: 	memset(_cur_grffile->cargo_map, 0xFF, sizeof(_cur_grffile->cargo_map));
peter1138@6147: 
peter1138@6147: 	for (CargoID c = 0; c < NUM_CARGO; c++) {
peter1138@6147: 		const CargoSpec *cs = GetCargo(c);
peter1138@6147: 		if (!cs->IsValid()) continue;
peter1138@6147: 
peter1138@6147: 		if (_cur_grffile->cargo_max == 0) {
peter1138@6147: 			/* Default translation table, so just a straight mapping to bitnum */
peter1138@6147: 			_cur_grffile->cargo_map[c] = cs->bitnum;
peter1138@6147: 		} else {
peter1138@6147: 			/* Check the translation table for this cargo's label */
peter1138@6147: 			for (uint i = 0; i < _cur_grffile->cargo_max; i++) {
peter1138@6147: 				if (cs->label == _cur_grffile->cargo_list[i]) {
peter1138@6147: 					_cur_grffile->cargo_map[c] = i;
peter1138@6147: 					break;
peter1138@6147: 				}
peter1138@6147: 			}
peter1138@6147: 		}
peter1138@6147: 	}
peter1138@6147: }
peter1138@6147: 
Darkvater@3628: static void InitNewGRFFile(const GRFConfig *config, int sprite_offset)
dominik@452: {
peter1138@6281: 	GRFFile *newfile = GetFileByFilename(config->filename);
pasky@490: 	if (newfile != NULL) {
pasky@489: 		/* We already loaded it once. */
pasky@489: 		newfile->sprite_offset = sprite_offset;
pasky@489: 		_cur_grffile = newfile;
pasky@489: 		return;
pasky@489: 	}
pasky@489: 
KUDr@5609: 	newfile = CallocT<GRFFile>(1);
dominik@452: 
tron@3033: 	if (newfile == NULL) error ("Out of memory");
dominik@452: 
rubidium@7034: 	newfile->filename = strdup(config->filename);
dominik@452: 	newfile->sprite_offset = sprite_offset;
dominik@452: 
Darkvater@3628: 	/* Copy the initial parameter list */
Darkvater@3628: 	assert(lengthof(newfile->param) == lengthof(config->param) && lengthof(config->param) == 0x80);
Darkvater@3628: 	newfile->param_end = config->num_params;
Darkvater@5430: 	memcpy(newfile->param, config->param, sizeof(newfile->param));
Darkvater@3628: 
dominik@452: 	if (_first_grffile == NULL) {
dominik@452: 		_cur_grffile = newfile;
dominik@452: 		_first_grffile = newfile;
dominik@452: 	} else {
dominik@452: 		_cur_grffile->next = newfile;
dominik@452: 		_cur_grffile = newfile;
dominik@452: 	}
dominik@452: }
dominik@452: 
peter1138@5037: 
peter1138@6145: /** List of what cargo labels are refittable for the given the vehicle-type.
peter1138@6145:  * Only currently active labels are applied. */
peter1138@6145: static const CargoLabel _default_refitmasks_rail[] = {
peter1138@6145: 	'PASS', 'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD',
peter1138@6145: 	'IORE', 'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE',
peter1138@6145: 	'WATR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL',
peter1138@6145: 	'PLST', 'FZDR',
peter1138@6145: 	0 };
peter1138@6145: 
peter1138@6145: static const CargoLabel _default_refitmasks_road[] = {
peter1138@6145: 	0 };
peter1138@6145: 
peter1138@6145: static const CargoLabel _default_refitmasks_ships[] = {
peter1138@6145: 	'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD', 'IORE',
peter1138@6145: 	'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE', 'WATR',
peter1138@6145: 	'RUBR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL',
peter1138@6145: 	'PLST', 'FZDR',
peter1138@6145: 	0 };
peter1138@6145: 
peter1138@6145: static const CargoLabel _default_refitmasks_aircraft[] = {
peter1138@6145: 	'PASS', 'MAIL', 'GOOD', 'VALU', 'GOLD', 'DIAM', 'FOOD', 'FRUT', 'SUGR',
peter1138@6145: 	'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL', 'PLST', 'FZDR',
peter1138@6145: 	0 };
peter1138@6145: 
peter1138@6145: static const CargoLabel *_default_refitmasks[] = {
peter1138@6145: 	_default_refitmasks_rail,
peter1138@6145: 	_default_refitmasks_road,
peter1138@6145: 	_default_refitmasks_ships,
peter1138@6145: 	_default_refitmasks_aircraft,
peter1138@5037: };
peter1138@5037: 
peter1138@5037: 
peter1138@2611: /**
peter1138@2611:  * Precalculate refit masks from cargo classes for all vehicles.
peter1138@2611:  */
rubidium@6247: static void CalculateRefitMasks()
peter1138@2611: {
peter1138@9070: 	Engine *e;
peter1138@9070: 
peter1138@9070: 	FOR_ALL_ENGINES(e) {
peter1138@9070: 		EngineID engine = e->index;
peter1138@9070: 		EngineInfo *ei = &e->info;
peter1138@2611: 		uint32 mask = 0;
peter1138@2611: 		uint32 not_mask = 0;
peter1138@6284: 		uint32 xor_mask = 0;
peter1138@6284: 
peter1138@8754: 		if (ei->refit_mask != 0) {
peter1138@9070: 			const GRFFile *file = e->grffile;
peter1138@6284: 			if (file != NULL && file->cargo_max != 0) {
peter1138@6284: 				/* Apply cargo translation table to the refit mask */
peter1138@6284: 				uint num_cargo = min(32, file->cargo_max);
peter1138@6284: 				for (uint i = 0; i < num_cargo; i++) {
peter1138@8754: 					if (!HasBit(ei->refit_mask, i)) continue;
peter1138@6284: 
peter1138@6284: 					CargoID c = GetCargoIDByLabel(file->cargo_list[i]);
peter1138@6284: 					if (c == CT_INVALID) continue;
peter1138@6284: 
skidd13@7931: 					SetBit(xor_mask, c);
peter1138@6284: 				}
peter1138@6284: 			} else {
peter1138@6284: 				/* No cargo table, so use the cargo bitnum values */
peter1138@6284: 				for (CargoID c = 0; c < NUM_CARGO; c++) {
peter1138@6284: 					const CargoSpec *cs = GetCargo(c);
peter1138@6284: 					if (!cs->IsValid()) continue;
peter1138@6284: 
peter1138@8754: 					if (HasBit(ei->refit_mask, cs->bitnum)) SetBit(xor_mask, c);
peter1138@6284: 				}
peter1138@6284: 			}
peter1138@6284: 		}
peter1138@2611: 
peter1138@9025: 		if (_gted[engine].cargo_allowed != 0) {
belugas@6348: 			/* Build up the list of cargo types from the set cargo classes. */
peter1138@6281: 			for (CargoID i = 0; i < NUM_CARGO; i++) {
peter1138@6113: 				const CargoSpec *cs = GetCargo(i);
peter1138@9025: 				if (_gted[engine].cargo_allowed    & cs->classes) SetBit(mask,     i);
peter1138@9025: 				if (_gted[engine].cargo_disallowed & cs->classes) SetBit(not_mask, i);
peter1138@2611: 			}
peter1138@9070: 		} else if (xor_mask == 0) {
belugas@6348: 			/* Don't apply default refit mask to wagons or engines with no capacity */
peter1138@9070: 			if (e->type != VEH_TRAIN || (e->u.rail.capacity != 0 && e->u.rail.railveh_type != RAILVEH_WAGON)) {
peter1138@9070: 				const CargoLabel *cl = _default_refitmasks[e->type];
peter1138@6145: 				for (uint i = 0;; i++) {
peter1138@6145: 					if (cl[i] == 0) break;
peter1138@6145: 
peter1138@6145: 					CargoID cargo = GetCargoIDByLabel(cl[i]);
peter1138@6145: 					if (cargo == CT_INVALID) continue;
peter1138@6145: 
skidd13@7931: 					SetBit(xor_mask, cargo);
peter1138@6145: 				}
tron@3033: 			}
peter1138@2611: 		}
peter1138@8754: 
peter1138@8754: 		ei->refit_mask = ((mask & ~not_mask) ^ xor_mask) & _cargo_mask;
peter1138@6142: 
peter1138@6142: 		/* Check if this engine's cargo type is valid. If not, set to the first refittable
peter1138@6142: 		 * cargo type. Apparently cargo_type isn't a common property... */
peter1138@9070: 		switch (e->type) {
rubidium@6638: 			default: NOT_REACHED();
rubidium@6638: 			case VEH_AIRCRAFT: break;
rubidium@6259: 			case VEH_TRAIN: {
peter1138@9070: 				RailVehicleInfo *rvi = &e->u.rail;
peter1138@6142: 				if (rvi->cargo_type == CT_INVALID) rvi->cargo_type = FindFirstRefittableCargo(engine);
peter1138@9070: 				if (rvi->cargo_type == CT_INVALID) ei->climates = 0x80;
peter1138@6142: 				break;
peter1138@6142: 			}
rubidium@6259: 			case VEH_ROAD: {
peter1138@9070: 				RoadVehicleInfo *rvi = &e->u.road;
peter1138@6142: 				if (rvi->cargo_type == CT_INVALID) rvi->cargo_type = FindFirstRefittableCargo(engine);
peter1138@9070: 				if (rvi->cargo_type == CT_INVALID) ei->climates = 0x80;
peter1138@6142: 				break;
peter1138@6142: 			}
rubidium@6259: 			case VEH_SHIP: {
peter1138@9070: 				ShipVehicleInfo *svi = &e->u.ship;
peter1138@6142: 				if (svi->cargo_type == CT_INVALID) svi->cargo_type = FindFirstRefittableCargo(engine);
peter1138@9070: 				if (svi->cargo_type == CT_INVALID) ei->climates = 0x80;
peter1138@6142: 				break;
peter1138@6142: 			}
peter1138@6142: 		}
peter1138@2611: 	}
peter1138@2611: }
dominik@452: 
maedhros@6332: /** Add all new houses to the house array. House properties can be set at any
maedhros@6332:  * time in the GRF file, so we can only add a house spec to the house array
maedhros@6332:  * after the file has finished loading. We also need to check the dates, due to
maedhros@6332:  * the TTDPatch behaviour described below that we need to emulate. */
maedhros@6332: static void FinaliseHouseArray()
maedhros@6332: {
maedhros@6332: 	/* If there are no houses with start dates before 1930, then all houses
maedhros@6332: 	 * with start dates of 1930 have them reset to 0. This is in order to be
maedhros@6332: 	 * compatible with TTDPatch, where if no houses have start dates before
maedhros@6332: 	 * 1930 and the date is before 1930, the game pretends that this is 1930.
maedhros@6332: 	 * If there have been any houses defined with start dates before 1930 then
rubidium@8165: 	 * the dates are left alone.
rubidium@8165: 	 * On the other hand, why 1930? Just 'fix' the houses with the lowest
rubidium@8165: 	 * minimum introduction date to 0.
rubidium@8165: 	 */
belugas@9450: 	Year min_year = MAX_YEAR;
maedhros@6332: 
maedhros@6332: 	for (GRFFile *file = _first_grffile; file != NULL; file = file->next) {
maedhros@6332: 		if (file->housespec == NULL) continue;
maedhros@6332: 
maedhros@6332: 		for (int i = 0; i < HOUSE_MAX; i++) {
maedhros@6332: 			HouseSpec *hs = file->housespec[i];
maedhros@6332: 			if (hs != NULL) {
belugas@6629: 				_house_mngr.SetEntitySpec(hs);
belugas@9450: 				if (hs->min_year < min_year) min_year = hs->min_year;
maedhros@6332: 			}
maedhros@6332: 		}
maedhros@6332: 	}
maedhros@6332: 
belugas@9450: 	if (min_year != 0) {
rubidium@8165: 		for (int i = 0; i < HOUSE_MAX; i++) {
maedhros@6332: 			HouseSpec *hs = GetHouseSpecs(i);
maedhros@6332: 
belugas@9450: 			if (hs->enabled && hs->min_year == min_year) hs->min_year = 0;
maedhros@6332: 		}
maedhros@6332: 	}
maedhros@6332: }
maedhros@6332: 
belugas@7183: /** Add all new industries to the industry array. Industry properties can be set at any
belugas@7183:  * time in the GRF file, so we can only add a industry spec to the industry array
belugas@7183:  * after the file has finished loading. */
belugas@7183: static void FinaliseIndustriesArray()
belugas@7183: {
belugas@7183: 	for (GRFFile *file = _first_grffile; file != NULL; file = file->next) {
belugas@7183: 		if (file->industryspec != NULL) {
belugas@7183: 			for (int i = 0; i < NUM_INDUSTRYTYPES; i++) {
belugas@7183: 				IndustrySpec *indsp = file->industryspec[i];
belugas@7183: 
belugas@7217: 				if (indsp != NULL && indsp->enabled) {
belugas@7217: 					StringID strid;
belugas@7217: 					/* process the conversion of text at the end, so to be sure everything will be fine
belugas@7217: 					 * and available.  Check if it does not return undefind marker, which is a very good sign of a
belugas@7217: 					 * substitute industry who has not changed the string been examined, thus using it as such */
belugas@7217: 					strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->name);
belugas@7217: 					if (strid != STR_UNDEFINED) indsp->name = strid;
belugas@7217: 
belugas@7217: 					strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->closure_text);
belugas@7217: 					if (strid != STR_UNDEFINED) indsp->closure_text = strid;
belugas@7217: 
belugas@7217: 					strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_up_text);
belugas@7217: 					if (strid != STR_UNDEFINED) indsp->production_up_text = strid;
belugas@7217: 
belugas@7217: 					strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->production_down_text);
belugas@7217: 					if (strid != STR_UNDEFINED) indsp->production_down_text = strid;
belugas@7217: 
belugas@7217: 					strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->new_industry_text);
belugas@7217: 					if (strid != STR_UNDEFINED) indsp->new_industry_text = strid;
belugas@7217: 
belugas@8470: 					if (indsp->station_name != STR_NULL) {
belugas@8470: 						/* STR_NULL (0) can be set by grf.  It has a meaning regarding assignation of the
smatz@10015: 						 * station's name. Don't want to lose the value, therefore, do not process. */
belugas@8470: 						strid = GetGRFStringID(indsp->grf_prop.grffile->grfid, indsp->station_name);
belugas@8470: 						if (strid != STR_UNDEFINED) indsp->station_name = strid;
belugas@8470: 					}
belugas@8470: 
belugas@7183: 					_industry_mngr.SetEntitySpec(indsp);
belugas@7183: 					_loaded_newgrf_features.has_newindustries = true;
belugas@7183: 				}
belugas@7183: 			}
belugas@7183: 		}
belugas@7183: 
belugas@7183: 		if (file->indtspec != NULL) {
belugas@7183: 			for (int i = 0; i < NUM_INDUSTRYTILES; i++) {
belugas@7183: 				IndustryTileSpec *indtsp = file->indtspec[i];
belugas@7183: 				if (indtsp != NULL) {
belugas@7183: 					_industile_mngr.SetEntitySpec(indtsp);
belugas@7183: 				}
belugas@7183: 			}
belugas@7183: 		}
belugas@7183: 	}
rubidium@7233: 
rubidium@7233: 	for (uint j = 0; j < NUM_INDUSTRYTYPES; j++) {
rubidium@7233: 		IndustrySpec *indsp = &_industry_specs[j];
rubidium@7233: 		if (indsp->enabled && indsp->grf_prop.grffile != NULL) {
rubidium@7233: 			for (uint i = 0; i < 3; i++) {
rubidium@7233: 				indsp->conflicting[i] = MapNewGRFIndustryType(indsp->conflicting[i], indsp->grf_prop.grffile->grfid);
rubidium@7233: 			}
rubidium@7233: 		}
rubidium@7233: 	}
belugas@7183: }
peter1138@6359: 
dominik@452: /* Here we perform initial decoding of some special sprites (as are they
dominik@452:  * described at http://www.ttdpatch.net/src/newgrf.txt, but this is only a very
dominik@452:  * partial implementation yet). */
dominik@452: /* XXX: We consider GRF files trusted. It would be trivial to exploit OTTD by
dominik@452:  * a crafted invalid GRF file. We should tell that to the user somehow, or
dominik@452:  * better make this more robust in the future. */
peter1138@5008: static void DecodeSpecialSprite(uint num, GrfLoadingStage stage)
dominik@452: {
dominik@452: 	/* XXX: There is a difference between staged loading in TTDPatch and
dominik@452: 	 * here.  In TTDPatch, for some reason actions 1 and 2 are carried out
Darkvater@3561: 	 * during stage 1, whilst action 3 is carried out during stage 2 (to
dominik@452: 	 * "resolve" cargo IDs... wtf). This is a little problem, because cargo
dominik@452: 	 * IDs are valid only within a given set (action 1) block, and may be
dominik@452: 	 * overwritten after action 3 associates them. But overwriting happens
dominik@452: 	 * in an earlier stage than associating, so...  We just process actions
Darkvater@3561: 	 * 1 and 2 in stage 2 now, let's hope that won't get us into problems.
dominik@452: 	 * --pasky */
Darkvater@3561: 	/* We need a pre-stage to set up GOTO labels of Action 0x10 because the grf
Darkvater@3561: 	 * is not in memory and scanning the file every time would be too expensive.
Darkvater@3561: 	 * In other stages we skip action 0x10 since it's already dealt with. */
peter1138@5008: 	static const SpecialSpriteHandler handlers[][GLS_END] = {
glx@7899: 		/* 0x00 */ { NULL,     SafeChangeInfo, NULL,       NULL,           ReserveChangeInfo, FeatureChangeInfo, },
peter1138@6576: 		/* 0x01 */ { SkipAct1, SkipAct1,  SkipAct1,        SkipAct1,       SkipAct1,          NewSpriteSet, },
peter1138@6576: 		/* 0x02 */ { NULL,     NULL,      NULL,            NULL,           NULL,              NewSpriteGroup, },
peter1138@6359: 		/* 0x03 */ { NULL,     GRFUnsafe, NULL,            NULL,           NULL,              FeatureMapSpriteGroup, },
peter1138@6359: 		/* 0x04 */ { NULL,     NULL,      NULL,            NULL,           NULL,              FeatureNewName, },
peter1138@6529: 		/* 0x05 */ { SkipAct5, SkipAct5,  SkipAct5,        SkipAct5,       SkipAct5,          GraphicsNew, },
peter1138@6373: 		/* 0x06 */ { NULL,     NULL,      NULL,            CfgApply,       CfgApply,          CfgApply, },
peter1138@6359: 		/* 0x07 */ { NULL,     NULL,      NULL,            NULL,           SkipIf,            SkipIf, },
peter1138@6806: 		/* 0x08 */ { ScanInfo, NULL,      NULL,            GRFInfo,        GRFInfo,           GRFInfo, },
peter1138@6359: 		/* 0x09 */ { NULL,     NULL,      NULL,            SkipIf,         SkipIf,            SkipIf, },
peter1138@6529: 		/* 0x0A */ { SkipActA, SkipActA,  SkipActA,        SkipActA,       SkipActA,          SpriteReplace, },
peter1138@6359: 		/* 0x0B */ { NULL,     NULL,      NULL,            GRFLoadError,   GRFLoadError,      GRFLoadError, },
peter1138@6359: 		/* 0x0C */ { NULL,     NULL,      NULL,            GRFComment,     NULL,              GRFComment, },
peter1138@6359: 		/* 0x0D */ { NULL,     SafeParamSet, NULL,         ParamSet,       ParamSet,          ParamSet, },
peter1138@6359: 		/* 0x0E */ { NULL,     SafeGRFInhibit, NULL,       GRFInhibit,     GRFInhibit,        GRFInhibit, },
glx@6956: 		/* 0x0F */ { NULL,     GRFUnsafe, NULL,            FeatureTownName, NULL,             NULL, },
peter1138@6359: 		/* 0x10 */ { NULL,     NULL,      DefineGotoLabel, NULL,           NULL,              NULL, },
frosch@8431: 		/* 0x11 */ { SkipAct11,GRFUnsafe, SkipAct11,       SkipAct11,      SkipAct11,         GRFSound, },
frosch@8431: 		/* 0x12 */ { SkipAct12, SkipAct12, SkipAct12,      SkipAct12,      SkipAct12,         LoadFontGlyph, },
peter1138@6359: 		/* 0x13 */ { NULL,     NULL,      NULL,            NULL,           NULL,              TranslateGRFStrings, },
tron@2342: 	};
dominik@452: 
rubidium@9947: 	bool preloaded_sprite = true;
rubidium@9947: 	GRFLocation location(_cur_grfconfig->grfid, _nfo_line);
rubidium@9947: 	byte *buf;
rubidium@9947: 
rubidium@9947: 	GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.find(location);
rubidium@9947: 	if (it == _grf_line_to_action6_sprite_override.end()) {
peter1138@3895: 		/* No preloaded sprite to work with; allocate and read the
peter1138@3895: 		 * pseudo sprite content. */
KUDr@5609: 		buf = MallocT<byte>(num);
peter1138@3895: 		FioReadBlock(buf, num);
rubidium@9947: 		preloaded_sprite = false;
peter1138@3895: 	} else {
peter1138@3895: 		/* Use the preloaded sprite data. */
rubidium@9947: 		buf = _grf_line_to_action6_sprite_override[location];
Darkvater@5380: 		grfmsg(7, "DecodeSpecialSprite: Using preloaded pseudo sprite data");
peter1138@3895: 
peter1138@3895: 		/* Skip the real (original) content of this action. */
peter1138@3895: 		FioSeekTo(num, SEEK_CUR);
peter1138@3895: 	}
peter1138@3895: 
peter1138@6281: 	byte action = buf[0];
tron@2342: 
peter1138@4656: 	if (action == 0xFF) {
belugas@6477: 		grfmsg(7, "DecodeSpecialSprite: Handling data block in stage %d", stage);
peter1138@4656: 		GRFDataBlock(buf, num);
peter1138@4818: 	} else if (action == 0xFE) {
glx@7899: 		grfmsg(7, "DecodeSpecialSprite: Handling import block in stage %d", stage);
peter1138@4818: 		GRFImportBlock(buf, num);
peter1138@4656: 	} else if (action >= lengthof(handlers)) {
belugas@6477: 		grfmsg(7, "DecodeSpecialSprite: Skipping unknown action 0x%02X", action);
peter1138@5008: 	} else if (handlers[action][stage] == NULL) {
belugas@6477: 		grfmsg(7, "DecodeSpecialSprite: Skipping action 0x%02X in stage %d", action, stage);
tron@2645: 	} else {
belugas@6477: 		grfmsg(7, "DecodeSpecialSprite: Handling action 0x%02X in stage %d", action, stage);
peter1138@5008: 		handlers[action][stage](buf, num);
tron@2342: 	}
rubidium@9947: 	if (!preloaded_sprite) free(buf);
tron@2342: }
tron@2342: 
tron@2342: 
belugas@8194: void LoadNewGRFFile(GRFConfig *config, uint file_index, GrfLoadingStage stage)
tron@2342: {
rubidium@7034: 	const char *filename = config->filename;
tron@2342: 	uint16 num;
tron@2342: 
tron@2342: 	/* A .grf file is activated only if it was active when the game was
tron@2342: 	 * started.  If a game is loaded, only its active .grfs will be
tron@2342: 	 * reactivated, unless "loadallgraphics on" is used.  A .grf file is
tron@2342: 	 * considered active if its action 8 has been processed, i.e. its
tron@2342: 	 * action 8 hasn't been skipped using an action 7.
tron@2342: 	 *
tron@2342: 	 * During activation, only actions 0, 1, 2, 3, 4, 5, 7, 8, 9, 0A and 0B are
tron@2342: 	 * carried out.  All others are ignored, because they only need to be
tron@2342: 	 * processed once at initialization.  */
peter1138@5329: 	if (stage != GLS_FILESCAN && stage != GLS_SAFETYSCAN && stage != GLS_LABELSCAN) {
tron@2342: 		_cur_grffile = GetFileByFilename(filename);
glx@9470: 		if (_cur_grffile == NULL) usererror("File '%s' lost in cache.\n", filename);
peter1138@6806: 		if (stage == GLS_RESERVE && config->status != GCS_INITIALISED) return;
skidd13@7928: 		if (stage == GLS_ACTIVATION && !HasBit(config->flags, GCF_RESERVED)) return;
belugas@8194: 		_cur_grffile->is_ottdfile = config->IsOpenTTDBaseGRF();
tron@2342: 	}
tron@2342: 
rubidium@7805: 	if (file_index > LAST_GRF_SLOT) {
rubidium@7805: 		DEBUG(grf, 0, "'%s' is not loaded as the maximum number of GRFs has been reached", filename);
rubidium@7805: 		config->status = GCS_DISABLED;
rubidium@7805: 		config->error  = CallocT<GRFError>(1);
rubidium@7805: 		config->error->severity = STR_NEWGRF_ERROR_MSG_FATAL;
rubidium@7805: 		config->error->message  = STR_NEWGRF_ERROR_TOO_MANY_NEWGRFS_LOADED;
rubidium@7805: 		return;
rubidium@7805: 	}
rubidium@7805: 
tron@2342: 	FioOpenFile(file_index, filename);
tron@2342: 	_file_index = file_index; // XXX
rubidium@10066: 	_palette_remap_grf[_file_index] = (config->windows_paletted != (_use_palette == PAL_WINDOWS));
tron@2342: 
peter1138@5228: 	_cur_grfconfig = config;
peter1138@5228: 
belugas@6477: 	DEBUG(grf, 2, "LoadNewGRFFile: Reading NewGRF-file '%s'", filename);
tron@2342: 
tron@2342: 	/* Skip the first sprite; we don't care about how many sprites this
tron@2342: 	 * does contain; newest TTDPatches and George's longvehicles don't
tron@2342: 	 * neither, apparently. */
tron@2342: 	if (FioReadWord() == 4 && FioReadByte() == 0xFF) {
tron@2342: 		FioReadDword();
tron@2342: 	} else {
belugas@6477: 		DEBUG(grf, 7, "LoadNewGRFFile: Custom .grf has invalid format");
peter1138@5228: 		return;
tron@2342: 	}
tron@2342: 
tron@2342: 	_skip_sprites = 0; // XXX
peter1138@3557: 	_nfo_line = 0;
tron@2342: 
tron@2342: 	while ((num = FioReadWord()) != 0) {
tron@2342: 		byte type = FioReadByte();
peter1138@3557: 		_nfo_line++;
tron@2342: 
tron@2342: 		if (type == 0xFF) {
tron@2342: 			if (_skip_sprites == 0) {
tron@2958: 				DecodeSpecialSprite(num, stage);
peter1138@5011: 
peter1138@5011: 				/* Stop all processing if we are to skip the remaining sprites */
peter1138@5011: 				if (_skip_sprites == -1) break;
peter1138@5011: 
tron@2342: 				continue;
tron@2342: 			} else {
tron@2342: 				FioSkipBytes(num);
tron@1611: 			}
dominik@452: 		} else {
peter1138@10025: 			if (_skip_sprites == 0) {
peter1138@10025: 				grfmsg(0, "LoadNewGRFFile: Unexpected sprite, disabling");
peter1138@10025: 				config->status = GCS_DISABLED;
peter1138@10025: 				config->error  = CallocT<GRFError>(1);
peter1138@10025: 				config->error->severity = STR_NEWGRF_ERROR_MSG_FATAL;
peter1138@10025: 				config->error->message  = STR_NEWGRF_ERROR_UNEXPECTED_SPRITE;
peter1138@10025: 				break;
peter1138@10025: 			}
tron@2342: 
tron@2342: 			FioSkipBytes(7);
rubidium@10032: 			SkipSpriteData(type, num - 8);
dominik@452: 		}
tron@2342: 
tron@2342: 		if (_skip_sprites > 0) _skip_sprites--;
tron@2342: 	}
tron@2342: }
tron@2342: 
frosch@8403: /**
frosch@8403:  * Relocates the old shore sprites at new positions.
frosch@8403:  *
frosch@8403:  * 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)
frosch@8403:  * 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)
frosch@8403:  * 3. If a newgrf replaces shore sprites by Action5 any shore replacement by ActionA has no effect. (SHORE_REPLACE_ACTION_5)
frosch@8403:  */
frosch@8403: static void ActivateOldShore()
frosch@8403: {
frosch@8403: 	/* Use default graphics, if no shore sprites were loaded.
frosch@8403: 	 * Should not happen, as openttd(w/d).grf includes some. */
frosch@8403: 	if (_loaded_newgrf_features.shore == SHORE_REPLACE_NONE) _loaded_newgrf_features.shore = SHORE_REPLACE_ACTION_A;
frosch@8403: 
frosch@8403: 	if (_loaded_newgrf_features.shore != SHORE_REPLACE_ACTION_5) {
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  1, SPR_SHORE_BASE +  1); // SLOPE_W
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  2, SPR_SHORE_BASE +  2); // SLOPE_S
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  6, SPR_SHORE_BASE +  3); // SLOPE_SW
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START     , SPR_SHORE_BASE +  4); // SLOPE_E
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  4, SPR_SHORE_BASE +  6); // SLOPE_SE
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  3, SPR_SHORE_BASE +  8); // SLOPE_N
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  7, SPR_SHORE_BASE +  9); // SLOPE_NW
frosch@8403: 		DupSprite(SPR_ORIGINALSHORE_START +  5, SPR_SHORE_BASE + 12); // SLOPE_NE
frosch@8403: 	}
frosch@8403: 
frosch@8403: 	if (_loaded_newgrf_features.shore == SHORE_REPLACE_ACTION_A) {
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 16, SPR_SHORE_BASE +  0); // SLOPE_STEEP_S
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 17, SPR_SHORE_BASE +  5); // SLOPE_STEEP_W
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE +  7, SPR_SHORE_BASE +  7); // SLOPE_WSE
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 15, SPR_SHORE_BASE + 10); // SLOPE_STEEP_N
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 11, SPR_SHORE_BASE + 11); // SLOPE_NWS
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 13, SPR_SHORE_BASE + 13); // SLOPE_ENW
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 14, SPR_SHORE_BASE + 14); // SLOPE_SEN
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 18, SPR_SHORE_BASE + 15); // SLOPE_STEEP_E
frosch@8403: 
frosch@8403: 		/* XXX - SLOPE_EW, SLOPE_NS are currently not used.
frosch@8403: 		 *       If they would be used somewhen, then these grass tiles will most like not look as needed */
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE +  5, SPR_SHORE_BASE + 16); // SLOPE_EW
frosch@8403: 		DupSprite(SPR_FLAT_GRASS_TILE + 10, SPR_SHORE_BASE + 17); // SLOPE_NS
frosch@8403: 	}
frosch@8403: }
frosch@8403: 
rubidium@6247: void InitDepotWindowBlockSizes();
tron@2342: 
glx@8323: extern void InitGRFTownGeneratorNames();
glx@6956: 
maedhros@6332: static void AfterLoadGRFs()
maedhros@6332: {
rubidium@8959: 	for (StringIDToGRFIDMapping::iterator it = _string_to_grf_mapping.begin(); it != _string_to_grf_mapping.end(); it++) {
rubidium@8959: 		*((*it).first) = MapGRFStringID((*it).second, *((*it).first));
rubidium@8959: 	}
rubidium@8959: 	_string_to_grf_mapping.clear();
rubidium@8959: 
rubidium@9947: 	/* Free the action 6 override sprites. */
rubidium@9947: 	for (GRFLineToSpriteOverride::iterator it = _grf_line_to_action6_sprite_override.begin(); it != _grf_line_to_action6_sprite_override.end(); it++) {
rubidium@9947: 		free((*it).second);
rubidium@9947: 	}
rubidium@9947: 	_grf_line_to_action6_sprite_override.clear();
rubidium@9947: 
maedhros@6332: 	/* Pre-calculate all refit masks after loading GRF files. */
maedhros@6332: 	CalculateRefitMasks();
maedhros@6332: 
maedhros@6332: 	/* Set the block size in the depot windows based on vehicle sprite sizes */
maedhros@6332: 	InitDepotWindowBlockSizes();
maedhros@6332: 
maedhros@6332: 	/* Add all new houses to the house array. */
maedhros@6332: 	FinaliseHouseArray();
peter1138@6359: 
belugas@7183: 	/* Add all new industries to the industry array. */
belugas@7183: 	FinaliseIndustriesArray();
belugas@7183: 
belugas@6533: 	/* Create dynamic list of industry legends for smallmap_gui.cpp */
belugas@6533: 	BuildIndustriesLegend();
belugas@6533: 
glx@6956: 	/* Update the townname generators list */
glx@8323: 	InitGRFTownGeneratorNames();
frosch@8403: 
peter1138@9070: 	/* Run all queued vehicle list order changes */
peter1138@9672: 	CommitVehicleListOrderChanges();
peter1138@9070: 
frosch@8403: 	/* Load old shore sprites in new position, if they were replaced by ActionA */
frosch@8403: 	ActivateOldShore();
peter1138@9025: 
peter1138@9025: 	/* Deallocate temporary loading data */
peter1138@9025: 	free(_gted);
peter1138@9098: 	_grm_sprites.clear();
maedhros@6332: }
maedhros@6332: 
tron@2342: void LoadNewGRF(uint load_index, uint file_index)
tron@2342: {
peter1138@2930: 	InitializeGRFSpecial();
dominik@452: 
peter1138@2463: 	ResetNewGRFData();
peter1138@2463: 
rubidium@8159: 	/*
rubidium@8159: 	 * Reset the status of all files, so we can 'retry' to load them.
rubidium@8159: 	 * This is needed when one for example rearranges the NewGRFs in-game
rubidium@8159: 	 * and a previously disabled NewGRF becomes useable. If it would not
rubidium@8159: 	 * be reset, the NewGRF would remain disabled even though it should
rubidium@8159: 	 * have been enabled.
rubidium@8159: 	 */
rubidium@8159: 	for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) {
rubidium@8159: 		if (c->status != GCS_NOT_FOUND) c->status = GCS_UNKNOWN;
rubidium@8159: 	}
rubidium@8159: 
peter1138@9098: 	_cur_spriteid = load_index;
peter1138@9098: 
tron@2342: 	/* Load newgrf sprites
tron@2342: 	 * in each loading stage, (try to) open each file specified in the config
tron@2342: 	 * and load information from it. */
glx@7830: 	for (GrfLoadingStage stage = GLS_LABELSCAN; stage <= GLS_ACTIVATION; stage++) {
frosch@8668: 		/* Set activated grfs back to will-be-activated between reservation- and activation-stage.
frosch@8668: 		 * This ensures that action7/9 conditions 0x06 - 0x0A work correctly. */
frosch@8668: 		for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) {
frosch@8668: 			if (c->status == GCS_ACTIVATED) c->status = GCS_INITIALISED;
frosch@8668: 		}
frosch@8668: 
tron@2400: 		uint slot = file_index;
tron@2342: 
tron@2342: 		_cur_stage = stage;
peter1138@6281: 		for (GRFConfig *c = _grfconfig; c != NULL; c = c->next) {
maedhros@6229: 			if (c->status == GCS_DISABLED || c->status == GCS_NOT_FOUND) continue;
skidd13@7928: 			if (stage > GLS_INIT && HasBit(c->flags, GCF_INIT_ONLY)) continue;
peter1138@5228: 
belugas@6348: 			/* @todo usererror() */
glx@9470: 			if (!FioCheckFileExists(c->filename)) usererror("NewGRF file is missing '%s'", c->filename);
Darkvater@3628: 
peter1138@5008: 			if (stage == GLS_LABELSCAN) InitNewGRFFile(c, _cur_spriteid);
belugas@8194: 			LoadNewGRFFile(c, slot++, stage);
peter1138@6820: 			if (stage == GLS_RESERVE) {
skidd13@7931: 				SetBit(c->flags, GCF_RESERVED);
glx@7830: 			} else if (stage == GLS_ACTIVATION) {
skidd13@7929: 				ClrBit(c->flags, GCF_RESERVED);
peter1138@5476: 				ClearTemporaryNewGRFData();
peter1138@6147: 				BuildCargoTranslationMap();
belugas@6477: 				DEBUG(sprite, 2, "LoadNewGRF: Currently %i sprites are loaded", _cur_spriteid);
peter1138@5476: 			}
tron@2342: 		}
tron@2342: 	}
peter1138@2611: 
maedhros@6332: 	/* Call any functions that should be run after GRFs have been loaded. */
maedhros@6332: 	AfterLoadGRFs();
dominik@452: }
maedhros@6541: 
maedhros@6541: bool HasGrfMiscBit(GrfMiscBit bit)
maedhros@6541: {
skidd13@7928: 	return HasBit(_misc_grf_features, bit);
maedhros@6541: }