mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Codechange: Use GrfSpecFeature type instead of uint8_t. (#14253)

pull/14255/head
Peter Nelson 2025-05-12 08:44:39 +01:00 committed by GitHub
parent 2516c435b7
commit 0aacd7acb3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 69 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/economy_type.h
View File

@ -207,16 +207,6 @@ enum PriceCategory : uint8_t {
PCAT_CONSTRUCTION, ///< Price is affected by "construction cost" difficulty setting PCAT_CONSTRUCTION, ///< Price is affected by "construction cost" difficulty setting
}; };
/**
* Describes properties of price bases.
*/
struct PriceBaseSpec {
Money start_price; ///< Default value at game start, before adding multipliers.
PriceCategory category; ///< Price is affected by certain difficulty settings.
uint grf_feature; ///< GRF Feature that decides whether price multipliers apply locally or globally, #GSF_END if none.
Price fallback_price; ///< Fallback price multiplier for new prices but old grfs.
};
/** The "steps" in loan size, in British Pounds! */ /** The "steps" in loan size, in British Pounds! */
static const int LOAN_INTERVAL = 10000; static const int LOAN_INTERVAL = 10000;
/** The size of loan for a new company, in British Pounds! */ /** The size of loan for a new company, in British Pounds! */

28
src/newgrf.cpp
View File

@ -1461,7 +1461,7 @@ static void FinalisePriceBaseMultipliers()
{ {
extern const PriceBaseSpec _price_base_specs[]; extern const PriceBaseSpec _price_base_specs[];
/** Features, to which '_grf_id_overrides' applies. Currently vehicle features only. */ /** Features, to which '_grf_id_overrides' applies. Currently vehicle features only. */
static const uint32_t override_features = (1 << GSF_TRAINS) | (1 << GSF_ROADVEHICLES) | (1 << GSF_SHIPS) | (1 << GSF_AIRCRAFT); static constexpr GrfSpecFeatures override_features{GSF_TRAINS, GSF_ROADVEHICLES, GSF_SHIPS, GSF_AIRCRAFT};
/* Evaluate grf overrides */ /* Evaluate grf overrides */
int num_grfs = (uint)_grf_files.size(); int num_grfs = (uint)_grf_files.size();
@ -1485,13 +1485,13 @@ static void FinalisePriceBaseMultipliers()
GRFFile &source = _grf_files[i]; GRFFile &source = _grf_files[i];
GRFFile &dest = _grf_files[grf_overrides[i]]; GRFFile &dest = _grf_files[grf_overrides[i]];
uint32_t features = (source.grf_features | dest.grf_features) & override_features; GrfSpecFeatures features = (source.grf_features | dest.grf_features) & override_features;
source.grf_features |= features; source.grf_features.Set(features);
dest.grf_features |= features; dest.grf_features.Set(features);
for (Price p = PR_BEGIN; p < PR_END; p++) { for (Price p = PR_BEGIN; p < PR_END; p++) {
/* No price defined -> nothing to do */ /* No price defined -> nothing to do */
if (!HasBit(features, _price_base_specs[p].grf_feature) || source.price_base_multipliers[p] == INVALID_PRICE_MODIFIER) continue; if (!features.Test(_price_base_specs[p].grf_feature) || source.price_base_multipliers[p] == INVALID_PRICE_MODIFIER) continue;
Debug(grf, 3, "'{}' overrides price base multiplier {} of '{}'", source.filename, p, dest.filename); Debug(grf, 3, "'{}' overrides price base multiplier {} of '{}'", source.filename, p, dest.filename);
dest.price_base_multipliers[p] = source.price_base_multipliers[p]; dest.price_base_multipliers[p] = source.price_base_multipliers[p];
} }
@ -1503,13 +1503,13 @@ static void FinalisePriceBaseMultipliers()
GRFFile &source = _grf_files[i]; GRFFile &source = _grf_files[i];
GRFFile &dest = _grf_files[grf_overrides[i]]; GRFFile &dest = _grf_files[grf_overrides[i]];
uint32_t features = (source.grf_features | dest.grf_features) & override_features; GrfSpecFeatures features = (source.grf_features | dest.grf_features) & override_features;
source.grf_features |= features; source.grf_features.Set(features);
dest.grf_features |= features; dest.grf_features.Set(features);
for (Price p = PR_BEGIN; p < PR_END; p++) { for (Price p = PR_BEGIN; p < PR_END; p++) {
/* Already a price defined -> nothing to do */ /* Already a price defined -> nothing to do */
if (!HasBit(features, _price_base_specs[p].grf_feature) || dest.price_base_multipliers[p] != INVALID_PRICE_MODIFIER) continue; if (!features.Test(_price_base_specs[p].grf_feature) || dest.price_base_multipliers[p] != INVALID_PRICE_MODIFIER) continue;
Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, source.filename, dest.filename); Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, source.filename, dest.filename);
dest.price_base_multipliers[p] = source.price_base_multipliers[p]; dest.price_base_multipliers[p] = source.price_base_multipliers[p];
} }
@ -1521,12 +1521,12 @@ static void FinalisePriceBaseMultipliers()
GRFFile &source = _grf_files[i]; GRFFile &source = _grf_files[i];
GRFFile &dest = _grf_files[grf_overrides[i]]; GRFFile &dest = _grf_files[grf_overrides[i]];
uint32_t features = (source.grf_features | dest.grf_features) & override_features; GrfSpecFeatures features = (source.grf_features | dest.grf_features) & override_features;
source.grf_features |= features; source.grf_features.Set(features);
dest.grf_features |= features; dest.grf_features.Set(features);
for (Price p = PR_BEGIN; p < PR_END; p++) { for (Price p = PR_BEGIN; p < PR_END; p++) {
if (!HasBit(features, _price_base_specs[p].grf_feature)) continue; if (!features.Test(_price_base_specs[p].grf_feature)) continue;
if (source.price_base_multipliers[p] != dest.price_base_multipliers[p]) { if (source.price_base_multipliers[p] != dest.price_base_multipliers[p]) {
Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, dest.filename, source.filename); Debug(grf, 3, "Price base multiplier {} from '{}' propagated to '{}'", p, dest.filename, source.filename);
} }
@ -1556,7 +1556,7 @@ static void FinalisePriceBaseMultipliers()
/* No multiplier was set; set it to a neutral value */ /* No multiplier was set; set it to a neutral value */
price_base_multipliers[p] = 0; price_base_multipliers[p] = 0;
} else { } else {
if (!HasBit(file.grf_features, _price_base_specs[p].grf_feature)) { if (!file.grf_features.Test(_price_base_specs[p].grf_feature)) {
/* The grf does not define any objects of the feature, /* The grf does not define any objects of the feature,
* so it must be a difficulty setting. Apply it globally */ * so it must be a difficulty setting. Apply it globally */
Debug(grf, 3, "'{}' sets global price base multiplier {}", file.filename, p); Debug(grf, 3, "'{}' sets global price base multiplier {}", file.filename, p);

14
src/newgrf.h
View File

@ -95,6 +95,8 @@ enum GrfSpecFeature : uint8_t {
GSF_FAKE_TOWNS = GSF_END, ///< Fake town GrfSpecFeature for NewGRF debugging (parent scope) GSF_FAKE_TOWNS = GSF_END, ///< Fake town GrfSpecFeature for NewGRF debugging (parent scope)
GSF_FAKE_END, ///< End of the fake features GSF_FAKE_END, ///< End of the fake features
GSF_ORIGINAL_STRINGS = 0x48,
GSF_INVALID = 0xFF, ///< An invalid spec feature GSF_INVALID = 0xFF, ///< An invalid spec feature
}; };
using GrfSpecFeatures = EnumBitSet<GrfSpecFeature, uint32_t, GrfSpecFeature::GSF_END>; using GrfSpecFeatures = EnumBitSet<GrfSpecFeature, uint32_t, GrfSpecFeature::GSF_END>;
@ -153,7 +155,7 @@ struct GRFFile {
int traininfo_vehicle_pitch = 0; ///< Vertical offset for drawing train images in depot GUI and vehicle details int traininfo_vehicle_pitch = 0; ///< Vertical offset for drawing train images in depot GUI and vehicle details
uint traininfo_vehicle_width = 0; ///< Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details uint traininfo_vehicle_width = 0; ///< Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details
uint32_t grf_features = 0; ///< Bitset of GrfSpecFeature the grf uses GrfSpecFeatures grf_features{}; ///< Bitset of GrfSpecFeature the grf uses
PriceMultipliers price_base_multipliers{}; ///< Price base multipliers as set by the grf. PriceMultipliers price_base_multipliers{}; ///< Price base multipliers as set by the grf.
GRFFile(const struct GRFConfig &config); GRFFile(const struct GRFConfig &config);
@ -190,6 +192,16 @@ struct GRFLoadedFeatures {
TramReplacement tram; ///< In which way tram depots were replaced. TramReplacement tram; ///< In which way tram depots were replaced.
}; };
/**
* Describes properties of price bases.
*/
struct PriceBaseSpec {
Money start_price; ///< Default value at game start, before adding multipliers.
PriceCategory category; ///< Price is affected by certain difficulty settings.
GrfSpecFeature grf_feature; ///< GRF Feature that decides whether price multipliers apply locally or globally, #GSF_END if none.
Price fallback_price; ///< Fallback price multiplier for new prices but old grfs.
};
/** /**
* Check for grf miscellaneous bits * Check for grf miscellaneous bits
* @param bit The bit to check. * @param bit The bit to check.

4
src/newgrf/newgrf_act0.cpp
View File

@ -109,7 +109,7 @@ std::vector<BadgeID> ReadBadgeList(ByteReader &buf, GrfSpecFeature feature)
return badges; return badges;
} }
bool HandleChangeInfoResult(std::string_view caller, ChangeInfoResult cir, uint8_t feature, uint8_t property) bool HandleChangeInfoResult(std::string_view caller, ChangeInfoResult cir, GrfSpecFeature feature, uint8_t property)
{ {
switch (cir) { switch (cir) {
default: NOT_REACHED(); default: NOT_REACHED();
@ -204,7 +204,7 @@ static void FeatureChangeInfo(ByteReader &buf)
} }
/* Mark the feature as used by the grf */ /* Mark the feature as used by the grf */
SetBit(_cur_gps.grffile->grf_features, feature); _cur_gps.grffile->grf_features.Set(feature);
while (numprops-- && buf.HasData()) { while (numprops-- && buf.HasData()) {
uint8_t prop = buf.ReadByte(); uint8_t prop = buf.ReadByte();

2
src/newgrf/newgrf_act1.cpp
View File

@ -32,7 +32,7 @@ static void NewSpriteSet(ByteReader &buf)
* In that case, use num-dirs=4. * In that case, use num-dirs=4.
*/ */
uint8_t feature = buf.ReadByte(); GrfSpecFeature feature{buf.ReadByte()};
uint16_t num_sets = buf.ReadByte(); uint16_t num_sets = buf.ReadByte();
uint16_t first_set = 0; uint16_t first_set = 0;

8
src/newgrf/newgrf_act2.cpp
View File

@ -60,7 +60,7 @@ void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)
* @param[out] max_palette_offset Optionally returns the number of sprites in the spriteset of the palette. (0 if no spritset) * @param[out] max_palette_offset Optionally returns the number of sprites in the spriteset of the palette. (0 if no spritset)
* @return Read TileLayoutFlags. * @return Read TileLayoutFlags.
*/ */
TileLayoutFlags ReadSpriteLayoutSprite(ByteReader &buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, int feature, PalSpriteID *grf_sprite, uint16_t *max_sprite_offset, uint16_t *max_palette_offset) TileLayoutFlags ReadSpriteLayoutSprite(ByteReader &buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, GrfSpecFeature feature, PalSpriteID *grf_sprite, uint16_t *max_sprite_offset, uint16_t *max_palette_offset)
{ {
grf_sprite->sprite = buf.ReadWord(); grf_sprite->sprite = buf.ReadWord();
grf_sprite->pal = buf.ReadWord(); grf_sprite->pal = buf.ReadWord();
@ -171,7 +171,7 @@ static void ReadSpriteLayoutRegisters(ByteReader &buf, TileLayoutFlags flags, bo
* @param dts Layout container to output into * @param dts Layout container to output into
* @return True on error (GRF was disabled). * @return True on error (GRF was disabled).
*/ */
bool ReadSpriteLayout(ByteReader &buf, uint num_building_sprites, bool use_cur_spritesets, uint8_t feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts) bool ReadSpriteLayout(ByteReader &buf, uint num_building_sprites, bool use_cur_spritesets, GrfSpecFeature feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts)
{ {
bool has_flags = HasBit(num_building_sprites, 6); bool has_flags = HasBit(num_building_sprites, 6);
ClrBit(num_building_sprites, 6); ClrBit(num_building_sprites, 6);
@ -314,7 +314,7 @@ static const SpriteGroup *GetGroupFromGroupID(uint8_t setid, uint8_t type, uint1
* @param spriteid Raw value from the GRF for the new spritegroup; describes either the return value or the referenced spritegroup. * @param spriteid Raw value from the GRF for the new spritegroup; describes either the return value or the referenced spritegroup.
* @return Created spritegroup. * @return Created spritegroup.
*/ */
static const SpriteGroup *CreateGroupFromGroupID(uint8_t feature, uint8_t setid, uint8_t type, uint16_t spriteid) static const SpriteGroup *CreateGroupFromGroupID(GrfSpecFeature feature, uint8_t setid, uint8_t type, uint16_t spriteid)
{ {
if (HasBit(spriteid, 15)) return GetCallbackResultGroup(spriteid); if (HasBit(spriteid, 15)) return GetCallbackResultGroup(spriteid);
@ -348,7 +348,7 @@ static void NewSpriteGroup(ByteReader &buf)
* V feature-specific-data (huge mess, don't even look it up --pasky) */ * V feature-specific-data (huge mess, don't even look it up --pasky) */
const SpriteGroup *act_group = nullptr; const SpriteGroup *act_group = nullptr;
uint8_t feature = buf.ReadByte(); GrfSpecFeature feature{buf.ReadByte()};
if (feature >= GSF_END) { if (feature >= GSF_END) {
GrfMsg(1, "NewSpriteGroup: Unsupported feature 0x{:02X}, skipping", feature); GrfMsg(1, "NewSpriteGroup: Unsupported feature 0x{:02X}, skipping", feature);
return; return;

10
src/newgrf/newgrf_act3.cpp
View File

@ -33,7 +33,7 @@
#include "../safeguards.h" #include "../safeguards.h"
static CargoType TranslateCargo(uint8_t feature, uint8_t ctype) static CargoType TranslateCargo(GrfSpecFeature feature, uint8_t ctype)
{ {
/* Special cargo types for purchase list and stations */ /* Special cargo types for purchase list and stations */
if ((feature == GSF_STATIONS || feature == GSF_ROADSTOPS) && ctype == 0xFE) return CargoGRFFileProps::SG_DEFAULT_NA; if ((feature == GSF_STATIONS || feature == GSF_ROADSTOPS) && ctype == 0xFE) return CargoGRFFileProps::SG_DEFAULT_NA;
@ -75,7 +75,7 @@ static bool IsValidGroupID(uint16_t groupid, std::string_view function)
return true; return true;
} }
static void VehicleMapSpriteGroup(ByteReader &buf, uint8_t feature, uint8_t idcount) static void VehicleMapSpriteGroup(ByteReader &buf, GrfSpecFeature feature, uint8_t idcount)
{ {
static std::vector<EngineID> last_engines; // Engine IDs are remembered in case the next action is a wagon override. static std::vector<EngineID> last_engines; // Engine IDs are remembered in case the next action is a wagon override.
bool wagover = false; bool wagover = false;
@ -104,7 +104,7 @@ static void VehicleMapSpriteGroup(ByteReader &buf, uint8_t feature, uint8_t idco
/* No engine could be allocated?!? Deal with it. Okay, /* No engine could be allocated?!? Deal with it. Okay,
* this might look bad. Also make sure this NewGRF * this might look bad. Also make sure this NewGRF
* gets disabled, as a half loaded one is bad. */ * gets disabled, as a half loaded one is bad. */
HandleChangeInfoResult("VehicleMapSpriteGroup", CIR_INVALID_ID, 0, 0); HandleChangeInfoResult("VehicleMapSpriteGroup", CIR_INVALID_ID, feature, 0);
return; return;
} }
@ -714,7 +714,7 @@ static void FeatureMapSpriteGroup(ByteReader &buf)
* W cid cargo ID (sprite group ID) for this type of cargo * W cid cargo ID (sprite group ID) for this type of cargo
* W def-cid default cargo ID (sprite group ID) */ * W def-cid default cargo ID (sprite group ID) */
uint8_t feature = buf.ReadByte(); GrfSpecFeature feature{buf.ReadByte()};
uint8_t idcount = buf.ReadByte(); uint8_t idcount = buf.ReadByte();
if (feature >= GSF_END) { if (feature >= GSF_END) {
@ -736,7 +736,7 @@ static void FeatureMapSpriteGroup(ByteReader &buf)
} }
/* Mark the feature as used by the grf (generic callbacks do not count) */ /* Mark the feature as used by the grf (generic callbacks do not count) */
SetBit(_cur_gps.grffile->grf_features, feature); _cur_gps.grffile->grf_features.Set(feature);
GrfMsg(6, "FeatureMapSpriteGroup: Feature 0x{:02X}, {} ids", feature, idcount); GrfMsg(6, "FeatureMapSpriteGroup: Feature 0x{:02X}, {} ids", feature, idcount);

4
src/newgrf/newgrf_act4.cpp
View File

@ -48,8 +48,8 @@ static void FeatureNewName(ByteReader &buf)
bool new_scheme = _cur_gps.grffile->grf_version >= 7; bool new_scheme = _cur_gps.grffile->grf_version >= 7;
uint8_t feature = buf.ReadByte(); GrfSpecFeature feature{buf.ReadByte()};
if (feature >= GSF_END && feature != 0x48) { if (feature >= GSF_END && feature != GSF_ORIGINAL_STRINGS) {
GrfMsg(1, "FeatureNewName: Unsupported feature 0x{:02X}, skipping", feature); GrfMsg(1, "FeatureNewName: Unsupported feature 0x{:02X}, skipping", feature);
return; return;
} }

16
src/newgrf/newgrf_actd.cpp
View File

@ -234,11 +234,11 @@ static void ParamSet(ByteReader &buf)
} else { } else {
/* GRF Resource Management */ /* GRF Resource Management */
uint8_t op = src1; uint8_t op = src1;
uint8_t feature = GB(data, 8, 8); GrfSpecFeature feature{static_cast<uint8_t>(GB(data, 8, 8))};
uint16_t count = GB(data, 16, 16); uint16_t count = GB(data, 16, 16);
if (_cur_gps.stage == GLS_RESERVE) { if (_cur_gps.stage == GLS_RESERVE) {
if (feature == 0x08) { if (feature == GSF_GLOBALVAR) {
/* General sprites */ /* General sprites */
if (op == 0) { if (op == 0) {
/* Check if the allocated sprites will fit below the original sprite limit */ /* Check if the allocated sprites will fit below the original sprite limit */
@ -258,10 +258,10 @@ static void ParamSet(ByteReader &buf)
src1 = 0; src1 = 0;
} else if (_cur_gps.stage == GLS_ACTIVATION) { } else if (_cur_gps.stage == GLS_ACTIVATION) {
switch (feature) { switch (feature) {
case 0x00: // Trains case GSF_TRAINS:
case 0x01: // Road Vehicles case GSF_ROADVEHICLES:
case 0x02: // Ships case GSF_SHIPS:
case 0x03: // Aircraft case GSF_AIRCRAFT:
if (!_settings_game.vehicle.dynamic_engines) { if (!_settings_game.vehicle.dynamic_engines) {
src1 = PerformGRM({std::begin(_grm_engines) + _engine_offsets[feature], _engine_counts[feature]}, count, op, target, "vehicles"); src1 = PerformGRM({std::begin(_grm_engines) + _engine_offsets[feature], _engine_counts[feature]}, count, op, target, "vehicles");
if (_cur_gps.skip_sprites == -1) return; if (_cur_gps.skip_sprites == -1) return;
@ -280,7 +280,7 @@ static void ParamSet(ByteReader &buf)
} }
break; break;
case 0x08: // General sprites case GSF_GLOBALVAR: // General sprites
switch (op) { switch (op) {
case 0: case 0:
/* Return space reserved during reservation stage */ /* Return space reserved during reservation stage */
@ -298,7 +298,7 @@ static void ParamSet(ByteReader &buf)
} }
break; break;
case 0x0B: // Cargo case GSF_CARGOES: // Cargo
/* There are two ranges: one for cargo IDs and one for cargo bitmasks */ /* There are two ranges: one for cargo IDs and one for cargo bitmasks */
src1 = PerformGRM(_grm_cargoes, count, op, target, "cargoes"); src1 = PerformGRM(_grm_cargoes, count, op, target, "cargoes");
if (_cur_gps.skip_sprites == -1) return; if (_cur_gps.skip_sprites == -1) return;

16
src/newgrf/newgrf_internal.h
View File

@ -95,7 +95,7 @@ public:
* @param numsets Number of sets to define. * @param numsets Number of sets to define.
* @param numents Number of sprites per set to define. * @param numents Number of sprites per set to define.
*/ */
void AddSpriteSets(uint8_t feature, SpriteID first_sprite, uint first_set, uint numsets, uint numents) void AddSpriteSets(GrfSpecFeature feature, SpriteID first_sprite, uint first_set, uint numsets, uint numents)
{ {
assert(feature < GSF_END); assert(feature < GSF_END);
for (uint i = 0; i < numsets; i++) { for (uint i = 0; i < numsets; i++) {
@ -111,7 +111,7 @@ public:
* @return true if there are any valid sets. * @return true if there are any valid sets.
* @note Spritesets with zero sprites are valid to allow callback-failures. * @note Spritesets with zero sprites are valid to allow callback-failures.
*/ */
bool HasValidSpriteSets(uint8_t feature) const bool HasValidSpriteSets(GrfSpecFeature feature) const
{ {
assert(feature < GSF_END); assert(feature < GSF_END);
return !this->spritesets[feature].empty(); return !this->spritesets[feature].empty();
@ -124,7 +124,7 @@ public:
* @return true if the set is valid. * @return true if the set is valid.
* @note Spritesets with zero sprites are valid to allow callback-failures. * @note Spritesets with zero sprites are valid to allow callback-failures.
*/ */
bool IsValidSpriteSet(uint8_t feature, uint set) const bool IsValidSpriteSet(GrfSpecFeature feature, uint set) const
{ {
assert(feature < GSF_END); assert(feature < GSF_END);
return this->spritesets[feature].find(set) != this->spritesets[feature].end(); return this->spritesets[feature].find(set) != this->spritesets[feature].end();
@ -136,7 +136,7 @@ public:
* @param set Set to query. * @param set Set to query.
* @return First sprite of the set. * @return First sprite of the set.
*/ */
SpriteID GetSprite(uint8_t feature, uint set) const SpriteID GetSprite(GrfSpecFeature feature, uint set) const
{ {
assert(IsValidSpriteSet(feature, set)); assert(IsValidSpriteSet(feature, set));
return this->spritesets[feature].find(set)->second.sprite; return this->spritesets[feature].find(set)->second.sprite;
@ -148,7 +148,7 @@ public:
* @param set Set to query. * @param set Set to query.
* @return Number of sprites in the set. * @return Number of sprites in the set.
*/ */
uint GetNumEnts(uint8_t feature, uint set) const uint GetNumEnts(GrfSpecFeature feature, uint set) const
{ {
assert(IsValidSpriteSet(feature, set)); assert(IsValidSpriteSet(feature, set));
return this->spritesets[feature].find(set)->second.num_sprites; return this->spritesets[feature].find(set)->second.num_sprites;
@ -192,13 +192,13 @@ void SkipBadgeList(ByteReader &buf);
std::vector<BadgeID> ReadBadgeList(ByteReader &buf, GrfSpecFeature feature); std::vector<BadgeID> ReadBadgeList(ByteReader &buf, GrfSpecFeature feature);
void MapSpriteMappingRecolour(PalSpriteID *grf_sprite); void MapSpriteMappingRecolour(PalSpriteID *grf_sprite);
TileLayoutFlags ReadSpriteLayoutSprite(ByteReader &buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, int feature, PalSpriteID *grf_sprite, uint16_t *max_sprite_offset = nullptr, uint16_t *max_palette_offset = nullptr); TileLayoutFlags ReadSpriteLayoutSprite(ByteReader &buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, GrfSpecFeature feature, PalSpriteID *grf_sprite, uint16_t *max_sprite_offset = nullptr, uint16_t *max_palette_offset = nullptr);
bool ReadSpriteLayout(ByteReader &buf, uint num_building_sprites, bool use_cur_spritesets, uint8_t feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts); bool ReadSpriteLayout(ByteReader &buf, uint num_building_sprites, bool use_cur_spritesets, GrfSpecFeature feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts);
GRFFile *GetFileByGRFID(uint32_t grfid); GRFFile *GetFileByGRFID(uint32_t grfid);
GRFError *DisableGrf(StringID message = {}, GRFConfig *config = nullptr); GRFError *DisableGrf(StringID message = {}, GRFConfig *config = nullptr);
void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig &c); void DisableStaticNewGRFInfluencingNonStaticNewGRFs(GRFConfig &c);
bool HandleChangeInfoResult(std::string_view caller, ChangeInfoResult cir, uint8_t feature, uint8_t property); bool HandleChangeInfoResult(std::string_view caller, ChangeInfoResult cir, GrfSpecFeature feature, uint8_t property);
uint32_t GetParamVal(uint8_t param, uint32_t *cond_val); uint32_t GetParamVal(uint8_t param, uint32_t *cond_val);
void GRFUnsafe(ByteReader &); void GRFUnsafe(ByteReader &);

8
src/newgrf_generic.cpp
View File

@ -28,7 +28,7 @@ struct GenericScopeResolver : public ScopeResolver {
uint8_t count; uint8_t count;
uint8_t station_size; uint8_t station_size;
uint8_t feature; GrfSpecFeature feature;
/** /**
* Generic scope resolver. * Generic scope resolver.
@ -105,7 +105,7 @@ void ResetGenericCallbacks()
* @param file The GRF of the callback. * @param file The GRF of the callback.
* @param group The sprite group of the callback. * @param group The sprite group of the callback.
*/ */
void AddGenericCallback(uint8_t feature, const GRFFile *file, const SpriteGroup *group) void AddGenericCallback(GrfSpecFeature feature, const GRFFile *file, const SpriteGroup *group)
{ {
if (feature >= lengthof(_gcl)) { if (feature >= lengthof(_gcl)) {
GrfMsg(5, "AddGenericCallback: Unsupported feature 0x{:02X}", feature); GrfMsg(5, "AddGenericCallback: Unsupported feature 0x{:02X}", feature);
@ -164,7 +164,7 @@ GenericResolverObject::GenericResolverObject(bool ai_callback, CallbackID callba
* @param[out] regs100 Additional result values from registers 100+ * @param[out] regs100 Additional result values from registers 100+
* @return answering GRFFile and callback value if successful, or CALLBACK_FAILED * @return answering GRFFile and callback value if successful, or CALLBACK_FAILED
*/ */
static std::pair<const GRFFile *, uint16_t> GetGenericCallbackResult(uint8_t feature, ResolverObject &object, uint32_t param1_grfv7, uint32_t param1_grfv8, std::span<int32_t> regs100 = {}) static std::pair<const GRFFile *, uint16_t> GetGenericCallbackResult(GrfSpecFeature feature, ResolverObject &object, uint32_t param1_grfv7, uint32_t param1_grfv8, std::span<int32_t> regs100 = {})
{ {
assert(feature < lengthof(_gcl)); assert(feature < lengthof(_gcl));
@ -199,7 +199,7 @@ static std::pair<const GRFFile *, uint16_t> GetGenericCallbackResult(uint8_t fea
* @param station_size 'Station size' to pass to callback. (Variable 88) * @param station_size 'Station size' to pass to callback. (Variable 88)
* @return answering GRFFile and callback value if successful, or CALLBACK_FAILED * @return answering GRFFile and callback value if successful, or CALLBACK_FAILED
*/ */
std::pair<const GRFFile *, uint16_t> GetAiPurchaseCallbackResult(uint8_t feature, CargoType cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size) std::pair<const GRFFile *, uint16_t> GetAiPurchaseCallbackResult(GrfSpecFeature feature, CargoType cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size)
{ {
GenericResolverObject object(true, CBID_GENERIC_AI_PURCHASE_SELECTION); GenericResolverObject object(true, CBID_GENERIC_AI_PURCHASE_SELECTION);

4
src/newgrf_generic.h
View File

@ -45,9 +45,9 @@ static const IndustryType IT_AI_UNKNOWN = 0xFE; ///< The AI has no specific indu
static const IndustryType IT_AI_TOWN = 0xFF; ///< The AI actually wants to transport to/from a town, not an industry. static const IndustryType IT_AI_TOWN = 0xFF; ///< The AI actually wants to transport to/from a town, not an industry.
void ResetGenericCallbacks(); void ResetGenericCallbacks();
void AddGenericCallback(uint8_t feature, const GRFFile *file, const SpriteGroup *group); void AddGenericCallback(GrfSpecFeature feature, const GRFFile *file, const SpriteGroup *group);
std::pair<const GRFFile *, uint16_t> GetAiPurchaseCallbackResult(uint8_t feature, CargoType cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size); std::pair<const GRFFile *, uint16_t> GetAiPurchaseCallbackResult(GrfSpecFeature feature, CargoType cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size);
void AmbientSoundEffectCallback(TileIndex tile); void AmbientSoundEffectCallback(TileIndex tile);
/** Play an ambient sound effect for an empty tile. */ /** Play an ambient sound effect for an empty tile. */

5
src/newgrf_storage.h
View File

@ -11,6 +11,7 @@
#define NEWGRF_STORAGE_H #define NEWGRF_STORAGE_H
#include "core/pool_type.hpp" #include "core/pool_type.hpp"
#include "newgrf.h"
#include "tile_type.h" #include "tile_type.h"
/** /**
@ -31,7 +32,7 @@ enum PersistentStorageMode : uint8_t {
*/ */
struct BasePersistentStorageArray { struct BasePersistentStorageArray {
uint32_t grfid = 0; ///< GRFID associated to this persistent storage. A value of zero means "default". uint32_t grfid = 0; ///< GRFID associated to this persistent storage. A value of zero means "default".
uint8_t feature = 0; ///< NOSAVE: Used to identify in the owner of the array in debug output. GrfSpecFeature feature = GSF_INVALID; ///< NOSAVE: Used to identify in the owner of the array in debug output.
TileIndex tile = INVALID_TILE; ///< NOSAVE: Used to identify in the owner of the array in debug output. TileIndex tile = INVALID_TILE; ///< NOSAVE: Used to identify in the owner of the array in debug output.
virtual ~BasePersistentStorageArray(); virtual ~BasePersistentStorageArray();
@ -197,7 +198,7 @@ extern PersistentStoragePool _persistent_storage_pool;
*/ */
struct PersistentStorage : PersistentStorageArray<int32_t, 256>, PersistentStoragePool::PoolItem<&_persistent_storage_pool> { struct PersistentStorage : PersistentStorageArray<int32_t, 256>, PersistentStoragePool::PoolItem<&_persistent_storage_pool> {
/** We don't want GCC to zero our struct! It already is zeroed and has an index! */ /** We don't want GCC to zero our struct! It already is zeroed and has an index! */
PersistentStorage(const uint32_t new_grfid, uint8_t feature, TileIndex tile) PersistentStorage(const uint32_t new_grfid, GrfSpecFeature feature, TileIndex tile)
{ {
this->grfid = new_grfid; this->grfid = new_grfid;
this->feature = feature; this->feature = feature;

2
src/saveload/industry_sl.cpp
View File

@ -220,7 +220,7 @@ struct INDYChunkHandler : ChunkHandler {
if (IsSavegameVersionBefore(SLV_161) && !IsSavegameVersionBefore(SLV_76)) { if (IsSavegameVersionBefore(SLV_161) && !IsSavegameVersionBefore(SLV_76)) {
/* Store the old persistent storage. The GRFID will be added later. */ /* Store the old persistent storage. The GRFID will be added later. */
assert(PersistentStorage::CanAllocateItem()); assert(PersistentStorage::CanAllocateItem());
i->psa = new PersistentStorage(0, 0, TileIndex{}); i->psa = new PersistentStorage(0, GSF_INVALID, TileIndex{});
std::copy(std::begin(_old_ind_persistent_storage.storage), std::end(_old_ind_persistent_storage.storage), std::begin(i->psa->storage)); std::copy(std::begin(_old_ind_persistent_storage.storage), std::end(_old_ind_persistent_storage.storage), std::begin(i->psa->storage));
} }
if (IsSavegameVersionBefore(SLV_EXTEND_INDUSTRY_CARGO_SLOTS)) { if (IsSavegameVersionBefore(SLV_EXTEND_INDUSTRY_CARGO_SLOTS)) {

2
src/saveload/station_sl.cpp
View File

@ -399,7 +399,7 @@ public:
if (IsSavegameVersionBefore(SLV_161) && !IsSavegameVersionBefore(SLV_145) && st->facilities.Test(StationFacility::Airport)) { if (IsSavegameVersionBefore(SLV_161) && !IsSavegameVersionBefore(SLV_145) && st->facilities.Test(StationFacility::Airport)) {
/* Store the old persistent storage. The GRFID will be added later. */ /* Store the old persistent storage. The GRFID will be added later. */
assert(PersistentStorage::CanAllocateItem()); assert(PersistentStorage::CanAllocateItem());
st->airport.psa = new PersistentStorage(0, 0, TileIndex{}); st->airport.psa = new PersistentStorage(0, GSF_INVALID, TileIndex{});
std::copy(std::begin(_old_st_persistent_storage.storage), std::end(_old_st_persistent_storage.storage), std::begin(st->airport.psa->storage)); std::copy(std::begin(_old_st_persistent_storage.storage), std::end(_old_st_persistent_storage.storage), std::begin(st->airport.psa->storage));
} }

2
src/saveload/storage_sl.cpp
View File

@ -35,7 +35,7 @@ struct PSACChunkHandler : ChunkHandler {
while ((index = SlIterateArray()) != -1) { while ((index = SlIterateArray()) != -1) {
assert(PersistentStorage::CanAllocateItem()); assert(PersistentStorage::CanAllocateItem());
PersistentStorage *ps = new (PersistentStorageID(index)) PersistentStorage(0, 0, TileIndex{}); PersistentStorage *ps = new (PersistentStorageID(index)) PersistentStorage(0, GSF_INVALID, TileIndex{});
SlObject(ps, slt); SlObject(ps, slt);
} }
} }