Verify GameObject icons

Author: AnakinRaW

src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.Icons.cs

@@ -0,0 +1,41 @@
+using AET.ModVerify.Reporting;
+using PG.StarWarsGame.Engine.GameObjects;
+
+namespace AET.ModVerify.Verifiers.GameObjects;
+
+public sealed partial class GameObjectTypeVerifier
+{
+    private void VerifyIcons(GameObject gameObject, string[] context)
+    {
+        VerifyObjectIcon(gameObject, context);
+    }
+
+    private void VerifyObjectIcon(GameObject gameObject, string[] context)
+    {
+        if (string.IsNullOrEmpty(gameObject.IconName))
+            return;
+
+        /*
+         * The engine loads game object icons with different strategies, depending on where the icon is displayed:
+         * 1.   the game loads the texture from MTD and supports the faction prefixes e.g, r_ or e_
+         *      Faction prefixes have higher priority than the non-prefix versions. The player's faction (not the object owner) is used.
+         *      This applies to all command bar components (such as build buttons)
+         * 2.   the game loads the texture form MTD and does NOT support faction prefix.
+         *      If the texture is not found, the game searches the texture with forced .dds name in the Textures folder.
+         *      This applies to the GUI dialogs (such as battle summary)
+         * 3.   the game only loads the texture from MTD NOT supporting faction prefix nor textures folder fallback.
+         *      This applies (only) to the neutralize hero dialog
+         *
+         * We only verify whether the icon exists in the MTD data, as this is the primary case to all strategies
+         * (and it's what really should only be used for mods)
+         * Faction-specific icons are not verified as they are statically not decidable.
+         */
+
+        if (!GameEngine.CommandBar.IconExists(gameObject))
+        {
+            AddError(VerificationError.Create(this, VerifierErrorCodes.FileNotFound, 
+                $"Could not find icon '{gameObject.IconName}' for game object type '{gameObject.Name}'.",
+                VerificationSeverity.Warning, context, gameObject.IconName!));
+        }
+    }
+}

src/ModVerify/Verifiers/GameObjects/GameObjectTypeVerifier.cs

@@ -31,6 +31,7 @@ protected override void VerifyEntity(GameObject entity, string[] context, double
     {
         VerifyXRefs(entity, context);
         VerifyModels(entity, context, token);
+        VerifyIcons(entity, context);
     }
 
     protected override void PostEntityVerify(CancellationToken token)

src/PetroglyphTools/PG.StarWarsGame.Engine/CommandBar/CommandBarGameManager.cs

@@ -90,13 +90,11 @@ public bool IconExists(GameObject gameObject)
         if (MtdFile is null)
             return false;
 
-        //if (string.IsNullOrEmpty(gameObject.IconName))
-        //    return false;
-
-        //var crc = _hashingService.GetCrc32Upper(gameObject.IconName);
+        if (string.IsNullOrEmpty(gameObject.IconName))
+            return false;
 
-        //return MtdFile.Content.Contains(crc);
+        var crc = _hashingService.GetCrc32Upper(gameObject.IconName, PGConstants.DefaultPGEncoding);
 
-        return false;
+        return MtdFile.Content.Contains(crc);
     }
 }

src/PetroglyphTools/PG.StarWarsGame.Engine/GameObjects/GameObject.cs

@@ -47,7 +47,8 @@ public sealed class GameObject : NamedXmlObject
     public string? DamagedSmokeAssetModel { get; internal set; }
 
     public IReadOnlyList<(string terrain, string model)> LandTerrainModelMappingValues { get; }
-    
+    public string? IconName { get; internal set; }
+
     internal GameObject(
         string name,
         string classification,
@@ -69,6 +70,7 @@ internal void ApplyBaseType(GameObject baseType)
         // The following properties must not be inherited from the base type:
         // ID, CRC, Name, Location, IsLoadingComplete, ClassificationName and VariantOfExistingType[Name], LuaScript
 
+        // TODO
         GalacticModel = baseType.GalacticModel;
         DestroyedGalacticModel = baseType.DestroyedGalacticModel;
         LandModel = baseType.LandModel;
@@ -80,6 +82,8 @@ internal void ApplyBaseType(GameObject baseType)
         SpaceAnimOverrideModel = baseType.SpaceAnimOverrideModel;
         DamagedSmokeAssetModel = baseType.DamagedSmokeAssetModel;
         InternalLandTerrainModelMapping.ClearAddRange(baseType.InternalLandTerrainModelMapping);
+
+        IconName = baseType.IconName;
     }
 
     internal void PostLoadFixup()

src/PetroglyphTools/PG.StarWarsGame.Engine/Xml/Parsers/NamedObjects/GameObjectParser.cs

@@ -185,12 +185,17 @@ protected override void BuildMappings()
                 PetroglyphXmlStringParser.Instance.Parse,
                 (obj, val) => obj.DamagedSmokeAssetModel = val);
 
-
+            
             AddMapping(
                 GameObjectXmlTags.GuiModelName,
                 PetroglyphXmlStringParser.Instance.Parse,
                 (obj, val) => obj.GuiModel = val);
 
+            AddMapping(
+                GameObjectXmlTags.IconName,
+                PetroglyphXmlStringParser.Instance.Parse,
+                (obj, val) => obj.IconName = val);
+
             AddMapping(
                 GameObjectXmlTags.VariantOfExistingType,
                 PetroglyphXmlStringParser.Instance.Parse,
@@ -215,5 +220,7 @@ internal static class GameObjectXmlTags
         public const string DamagedSmokeAssetName = "Damaged_Smoke_Asset_Name";
 
         public const string VariantOfExistingType = "Variant_Of_Existing_Type";
+
+        public const string IconName = "Icon_Name";
     }
 }