unify CostIndex validation

Author: LeftofZen

DataSanitiser/Program.cs

@@ -93,12 +93,7 @@ static void QueryCostIndex()
 	//var index = ObjectIndex.CreateIndex(dir, logger);
 	//index.SaveIndexAsync(Path.Combine(dir, "objectIndex.json")).Wait();
 
-	var results = new List<(ObjectIndexEntry Obj, ObjectSource ObjectSource, byte CostIndex)>();
-
-	// Pseudocode plan:
-	// 1. Get all loaded assemblies (or just the relevant ones, e.g., Assembly.GetExecutingAssembly()).
-	// 2. For each type, check if it's a class, not abstract, implements ILocoStruct, and has a property named "CostIndex".
-	// 3. Iterate over these types in a foreach loop.
+	var results = new List<(ObjectIndexEntry Obj, ObjectSource ObjectSource, ObjectType ObjectType, byte CostIndex)>();
 
 	var locoStructTypesWithCostIndex = AppDomain.CurrentDomain.GetAssemblies()
 		.SelectMany(a => a.GetTypes())
@@ -115,9 +110,8 @@ static void QueryCostIndex()
 		Console.WriteLine($"Type: {type} implements ILocoStruct and has a CostIndex property.");
 	}
 
-	//foreach (var obj in index.Objects.Where(x => x.ObjectSource is ObjectSource.LocomotionSteam or ObjectSource.LocomotionGoG && locoStructTypesWithCostIndex.Contains(x.ObjectType)))
-
-	foreach (var obj in index.Objects.Where(x => locoStructTypesWithCostIndex.Contains(x.ObjectType)))
+	foreach (var obj in index.Objects.Where(x => x.ObjectSource is ObjectSource.LocomotionSteam or ObjectSource.LocomotionGoG && locoStructTypesWithCostIndex.Contains(x.ObjectType)))
+	//foreach (var obj in index.Objects.Where(x => locoStructTypesWithCostIndex.Contains(x.ObjectType)))
 	{
 		try
 		{
@@ -132,7 +126,7 @@ static void QueryCostIndex()
 				var header = o.DatFileInfo.S5Header;
 				var source = OriginalObjectFiles.GetFileSource(header.Name, header.Checksum);
 
-				results.Add((obj, source, costIndex));
+				results.Add((obj, source, o.LocoObject.ObjectType, costIndex));
 			}
 		}
 		catch (Exception ex)
@@ -145,7 +139,7 @@ static void QueryCostIndex()
 	foreach (var result in results.OrderBy(x => x.CostIndex))
 	{
 		// Print object index entry and its enabled flags
-		Console.WriteLine($"{result.Obj.DisplayName} - {result.ObjectSource} - CostIndex={result.CostIndex}");
+		Console.WriteLine($"{result.Obj.DisplayName} - {result.ObjectSource} - {result.ObjectType} - CostIndex={result.CostIndex}");
 	}
 }
 QueryCostIndex();

Definitions/ObjectModels/Constants.cs

@@ -0,0 +1,6 @@
+namespace Definitions.ObjectModels;
+
+public static class Constants
+{
+	public const int CurrencyMultiplicationFactorArraySize = 32; // this is the loco GameState::currencyMultiplicationFactor array size
+}

Definitions/ObjectModels/Objects/Airport/AirportObject.cs

@@ -33,9 +33,9 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
 			yield return result;
 		}
 
-		if (CostIndex > 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be between 0 and 32.", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)

Definitions/ObjectModels/Objects/Bridge/BridgeObject.cs

@@ -25,9 +25,9 @@ public class BridgeObject : ILocoStruct
 
 	public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
 	{
-		if (CostIndex > 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be between 0 and 32 inclusive.", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BaseCostFactor)

Definitions/ObjectModels/Objects/Dock/DockObject.cs

@@ -25,9 +25,9 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
 			yield return result;
 		}
 
-		if (CostIndex > 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be between 0 and 32 (inclusive).", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)

Definitions/ObjectModels/Objects/Land/LandObject.cs

@@ -20,9 +20,9 @@ public class LandObject : ILocoStruct
 
 	public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
 	{
-		if (CostIndex > 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be in the range 0-32.", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (CostFactor <= 0)

Definitions/ObjectModels/Objects/Road/RoadObject.cs

@@ -24,9 +24,9 @@ public class RoadObject : ILocoStruct
 
 	public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
 	{
-		if (CostIndex >= 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult("CostIndex must be less than 32", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)

Definitions/ObjectModels/Objects/RoadExtra/RoadExtraObject.cs

@@ -18,10 +18,9 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
 			yield return new ValidationResult("PaintStyle must be 0 or 1", [nameof(PaintStyle)]);
 		}
 
-		// This check missing from vanilla
-		if (CostIndex >= 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult("CostIndex must be less than 32", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)

Definitions/ObjectModels/Objects/RoadStation/RoadStationObject.cs

@@ -26,9 +26,9 @@ public class RoadStationObject : ILocoStruct
 
 	public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
 	{
-		if (CostIndex >= 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be between 0 and 31 inclusive.", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)

Definitions/ObjectModels/Objects/Track/TrackObject.cs

@@ -30,10 +30,9 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
 			yield return new ValidationResult($"{nameof(var_06)} must be 0, 1, or 2.", [nameof(var_06)]);
 		}
 
-		// vanilla missed this check
-		if (CostIndex > 32)
+		if (CostIndex >= Constants.CurrencyMultiplicationFactorArraySize)
 		{
-			yield return new ValidationResult($"{nameof(CostIndex)} must be between 0 and 32 inclusive.", [nameof(CostIndex)]);
+			yield return new ValidationResult($"{nameof(CostIndex)} must be less than {Constants.CurrencyMultiplicationFactorArraySize}", [nameof(CostIndex)]);
 		}
 
 		if (-SellCostFactor > BuildCostFactor)