openttd-mini: comparison grfspecial.c

equal deleted inserted replaced

-:3ad9aa36606c
+:3742b39b6cca
 	}
 #undef shift_buf
 }
-/* A sprite superset contains all sprites of a given vehicle (or multiple
+/* A sprite group contains all sprites of a given vehicle (or multiple
 * vehicles) when carrying given cargo. It consists of several sprite sets.
-* Superset ids are refered as "cargo id"s by TTDPatch documentation,
+* Group ids are refered as "cargo id"s by TTDPatch documentation,
 * contributing to the global confusion.
 *
 * A sprite set contains all sprites of a given vehicle carrying given cargo at
 * a given *stage* - that is usually its load stage. Ie. you can have a
 * spriteset for an empty wagon, wagon full of coal, half-filled wagon etc.
 static int _spriteset_numsets;
 static int _spriteset_numents;
 static int _spriteset_feature;
 static int _spritesset_count;
-static struct SpriteSuperSet *_spritesset;
+static struct SpriteGroup *_spritesset;
 /* Action 0x01 */
-static void SpriteNewSet(byte *buf, int len)
+static void NewSpriteSet(byte *buf, int len)
 {
 	/* <01> <feature> <num-sets> <num-ent>
 	 *
 	 * B feature       feature to define sprites for
 	 *                 0, 1, 2, 3: veh-type, 4: train stations
 	_spriteset_numsets = buf[2];
 	_spriteset_numents = buf[3];
 }
 /* Action 0x02 */
-static void SpriteNewSuperset(byte *buf, int len)
+static void NewSpriteGroup(byte *buf, int len)
 {
 	byte *bufend = buf + len;
 	/* <02> <feature> <set-id> <type/num-entries> <feature-specific-data...>
 	 *
 	 * when. --pasky */
 	uint8 feature;
 	uint8 setid;
 	uint8 numloaded;
 	uint8 numloading;
-	struct SpriteSuperSet *superset;
+	struct SpriteGroup *group;
 	int i;
-	check_length(len, 5, "SpriteNewSuperset");
+	check_length(len, 5, "SpriteNewGroup");
 	feature = buf[1];
 	setid = buf[2];
 	numloaded = buf[3];
 	numloading = buf[4];
 	if (feature == 4) {
-		grfmsg(GMS_WARN, "SpriteNewSuperset: Stations unsupported, skipping.");
+		grfmsg(GMS_WARN, "SpriteNewGroup: Stations unsupported, skipping.");
 		return;
 	}
 	if (numloaded == 0x81) {
 		// XXX: This is _VERY_ ad hoc just to handle Dm3. And that is
 		// a semi-futile ask because the great Patchman himself says
 		// this is just buggy. It dereferences last (first) byte of
 		// a schedule list pointer of the vehicle and if it's 0xff
-		// it uses superset 01, otherwise it uses superset 00. Now
+		// it uses group 01, otherwise it uses group 00. Now
 		// if _you_ understand _that_... We just assume it is never
-		// 0xff and therefore go for superset 00. --pasky
+		// 0xff and therefore go for group 00. --pasky
 		uint8 var = buf[4];
 		//uint8 shiftnum = buf[5];
 		//uint8 andmask = buf[6];
 		uint8 nvar = buf[7];
 		//uint32 val;
 		uint16 def;
-		grfmsg(GMS_WARN, "SpriteNewSuperset(0x81): Unsupported variable %x. Using default cid.", var);
+		grfmsg(GMS_WARN, "SpriteNewGroup(0x81): Unsupported variable %x. Using default cid.", var);
 		//val = (0xff << shiftnum) & andmask;
 		//Go for the default.
 		if (setid >= _spritesset_count) {
 			_spritesset_count = setid + 1;
-			_spritesset = realloc(_spritesset, _spritesset_count * sizeof(struct SpriteSuperSet));
+			_spritesset = realloc(_spritesset, _spritesset_count * sizeof(struct SpriteGroup));
 		}
 		buf += 8 + nvar * 4;
 		def = grf_load_word(&buf);
 		_spritesset[setid] = _spritesset[def];
 		return;
 	} else if (numloaded & 0x80) {
-		grfmsg(GMS_WARN, "SpriteNewSuperset(0x%x): Unsupported special superset.", numloaded);
+		grfmsg(GMS_WARN, "SpriteNewGroup(0x%x): Unsupported special group.", numloaded);
 		return;
 	}
 	if (!_spriteset_start) {
-		grfmsg(GMS_WARN, "SpriteNewSuperset: No sprite set to work on! Skipping.");
+		grfmsg(GMS_WARN, "SpriteNewGroup: No sprite set to work on! Skipping.");
 		return;
 	}
 	if (_spriteset_feature != feature) {
-		grfmsg(GMS_WARN, "SpriteNewSuperset: Superset feature %x doesn't match set feature %x! Skipping.", feature, _spriteset_feature);
+		grfmsg(GMS_WARN, "SpriteNewGroup: Group feature %x doesn't match set feature %x! Skipping.", feature, _spriteset_feature);
 		return;
 	}
 	if (setid >= _spritesset_count) {
 		_spritesset_count = setid + 1;
-		_spritesset = realloc(_spritesset, _spritesset_count * sizeof(struct SpriteSuperSet));
+		_spritesset = realloc(_spritesset, _spritesset_count * sizeof(struct SpriteGroup));
 	}
-	superset = &_spritesset[setid];
+	group = &_spritesset[setid];
-	memset(superset, 0, sizeof(struct SpriteSuperSet));
+	memset(group, 0, sizeof(struct SpriteGroup));
-	superset->sprites_per_set = _spriteset_numents;
+	group->sprites_per_set = _spriteset_numents;
 	buf += 5;
 	for (i = 0; buf < bufend && i < numloaded; i++) {
 		uint16 spriteset_id = grf_load_word(&buf);
 		if (_spritesset[setid].loaded_count > 16) {
-			grfmsg(GMS_WARN, "SpriteNewSuperset: More than 16 sprites in superset %x, skipping.", setid);
+			grfmsg(GMS_WARN, "SpriteNewGroup: More than 16 sprites in group %x, skipping.", setid);
 			return;
 		}
-		superset->loaded[superset->loaded_count++]
+		group->loaded[group->loaded_count++]
 			= _spriteset_start + spriteset_id * _spriteset_numents;
 	}
 	for (i = 0; buf < bufend && i < numloading; i++) {
 		uint16 spriteset_id = grf_load_word(&buf);
 		if (_spritesset[setid].loading_count > 16) {
-			grfmsg(GMS_WARN, "SpriteNewSuperset: More than 16 sprites in superset %x, skipping.", setid);
+			grfmsg(GMS_WARN, "SpriteNewGroup: More than 16 sprites in group %x, skipping.", setid);
 			return;
 		}
-		superset->loading[superset->loading_count++] = _spriteset_start + spriteset_id * _spriteset_numents;
+		group->loading[group->loading_count++] = _spriteset_start + spriteset_id * _spriteset_numents;
 	}
 }
 /* Action 0x03 */
-static void VehicleMapSpriteSuperset(byte *buf, int len)
+static void NewVehicle_SpriteGroupMapping(byte *buf, int len)
 {
 	/* <03> <feature> <n-id> <ids>... <num-cid> [<cargo-type> <cid>]... <def-cid>
 	 * id-list	:= [<id>] [id-list]
 	 * cargo-list	:= <cargo-type> <cid> [cargo-list]
 	 *
 	 * B feature       see action 0
 	 * B n-id          bits 0-6: how many IDs this definition applies to
 	 *                 bit 7: if set, this is a wagon override definition (see below)
 	 * B ids           the IDs for which this definition applies
-	 * B num-cid       number of cargo IDs in this definition
+	 * B num-cid       number of cargo IDs (sprite group IDs) in this definition
 	 *                 can be zero, in that case the def-cid is used always
 	 * B cargo-type    type of this cargo type (e.g. mail=2, wood=7, see below)
-	 * W cid           cargo ID for this type of cargo
+	 * W cid           cargo ID (sprite group ID) for this type of cargo
-	 * W def-cid       default cargo ID */
+	 * W def-cid       default cargo ID (sprite group ID) */
 	/* TODO: Only trains supported now. */
 	/* TODO: Multiple cargo support could be useful even for trains/cars -
 	 * cargo id 0xff is used for showing images in the build train list. */
 	static byte *last_engines;
 	uint8 idcount;
 	int wagover;
 	uint8 cidcount;
 	int c, i;
-	check_length(len, 7, "VehicleMapSpriteSuperset");
+	check_length(len, 7, "VehicleMapSpriteGroup");
 	feature = buf[1];
 	idcount = buf[2] & 0x7F;
 	wagover = buf[2] & 0x80;
 	cidcount = buf[3 + idcount];
 	if (feature == 4) {
-		grfmsg(GMS_WARN, "VehicleMapSpriteSuperset: Stations unsupported, skipping.");
+		grfmsg(GMS_WARN, "VehicleMapSpriteGroup: Stations unsupported, skipping.");
 		return;
 	}
 	// FIXME: Tropicset contains things like:
 	// 03 00 01 19 01 00 00 00 00 - this is missing one 00 at the end,
 	// what should we exactly do with that? --pasky
 	if (!_spriteset_start || !_spritesset) {
-		grfmsg(GMS_WARN, "VehicleMapSpriteSuperset: No sprite set to work on! Skipping.");
+		grfmsg(GMS_WARN, "VehicleMapSpriteGroup: No sprite set to work on! Skipping.");
 		return;
 	}
 	if (!wagover && last_engines_count != idcount) {
 		last_engines = realloc(last_engines, idcount);
 		uint8 engine = buf[3 + i] + _vehshifts[feature];
 		byte *bp = &buf[4 + idcount];
 		for (c = 0; c < cidcount; c++) {
 			uint8 ctype = grf_load_byte(&bp);
-			uint16 supersetid = grf_load_word(&bp);
+			uint16 groupid = grf_load_word(&bp);
-			if (supersetid >= _spritesset_count) {
+			if (groupid >= _spritesset_count) {
-				grfmsg(GMS_WARN, "VehicleMapSpriteSuperset: Spriteset %x out of range %x, skipping.", supersetid, _spritesset_count);
+				grfmsg(GMS_WARN, "VehicleMapSpriteGroup: Spriteset %x out of range %x, skipping.", groupid, _spritesset_count);
 				return;
 			}
 			if (ctype == 0xFF)
 				ctype = CID_PURCHASE;
 			if (wagover) {
 				// TODO: No multiple cargo types per vehicle yet. --pasky
-				SetWagonOverrideSprites(engine, &_spritesset[supersetid], last_engines, last_engines_count);
+				SetWagonOverrideSprites(engine, &_spritesset[groupid], last_engines, last_engines_count);
 			} else {
-				SetCustomEngineSprites(engine, ctype, &_spritesset[supersetid]);
+				SetCustomEngineSprites(engine, ctype, &_spritesset[groupid]);
 				last_engines[i] = engine;
 			}
 		}
 	}
 	{
 		byte *bp = buf + 4 + idcount + cidcount * 3;
-		uint16 supersetid = grf_load_word(&bp);
+		uint16 groupid = grf_load_word(&bp);
 		for (i = 0; i < idcount; i++) {
 			uint8 engine = buf[3 + i] + _vehshifts[feature];
 			// Don't tell me you don't love duplicated code!
-			if (supersetid >= _spritesset_count) {
+			if (groupid >= _spritesset_count) {
-				grfmsg(GMS_WARN, "VehicleMapSpriteSuperset: Spriteset %x out of range %x, skipping.", supersetid, _spritesset_count);
+				grfmsg(GMS_WARN, "VehicleMapSpriteGroup: Spriteset %x out of range %x, skipping.", groupid, _spritesset_count);
 				return;
 			}
 			if (wagover) {
 				// TODO: No multiple cargo types per vehicle yet. --pasky
-				SetWagonOverrideSprites(engine, &_spritesset[supersetid], last_engines, last_engines_count);
+				SetWagonOverrideSprites(engine, &_spritesset[groupid], last_engines, last_engines_count);
 			} else {
-				SetCustomEngineSprites(engine, CID_DEFAULT, &_spritesset[supersetid]);
+				SetCustomEngineSprites(engine, CID_DEFAULT, &_spritesset[groupid]);
 				last_engines[i] = engine;
 			}
 		}
 	}
 }
 void DecodeSpecialSprite(const char *filename, int num, int spriteid, int stage)
 {
 #define NUM_ACTIONS 0xF
 	static const SpecialSpriteHandler handlers[NUM_ACTIONS] = {
 		/* 0x0 */ VehicleChangeInfo,
-		/* 0x1 */ SpriteNewSet,
+		/* 0x1 */ NewSpriteSet,
-		/* 0x2 */ SpriteNewSuperset,
+		/* 0x2 */ NewSpriteGroup,
-		/* 0x3 */ VehicleMapSpriteSuperset,
+		/* 0x3 */ NewVehicle_SpriteGroupMapping,
 		/* 0x4 */ VehicleNewName,
 		/* 0x5 */ GraphicsNew,
 		/* 0x6 */ CfgApply,
 		/* 0x7 */ SkipIf,
 		/* 0x8 */ GRFInfo,
 	action = buf[0];
 	/* XXX: Action 0x03 is temporarily processed together with actions 0x01
 	 * and 0x02 before it is fixed to be reentrant (probably storing the
-	 * superset information in {struct GRFFile}). --pasky */
+	 * group information in {struct GRFFile}). --pasky */
 	if (stage == 0) {
 		/* During initialization, actions 0, 3, 4, 5 and 7 are ignored. */
 		if ((action == 0x00) /*|| (action == 0x03)*/ || (action == 0x04)

changeset 369	3742b39b6cca
parent 368	3ad9aa36606c
child 372	ec1e802872c7