Add support for DTA's TiberiumOverlays hack

Author: Rampastring

src/TSMapEditor/CCEngine/TileSet.cs

@@ -1,6 +1,8 @@
 using Microsoft.Xna.Framework;
 using Rampastring.Tools;
 using Rampastring.XNAUI;
+using System;
+using System.Collections.Generic;
 using TSMapEditor.Models;
 
 namespace TSMapEditor.CCEngine
@@ -43,6 +45,9 @@ public TileSet(int index)
         /// <param name="tileIndex">The index of the tile.</param>
         public bool ContainsTile(int tileIndex) => tileIndex >= StartTileIndex && tileIndex < StartTileIndex + LoadedTileCount;
 
+        public Dictionary<TiberiumType, OverlayType> TiberiumGraphicsOverrides { get; set; }
+        public List<(string tiberiumTypeName, string graphicalOverlayName)> ParsedTiberiumGraphicsOverrides { get; set; }
+
         private static string[] only1x1TileSets = new string[] { "cliffs", "rivers", "shores", "dirt road" };
 
         public void Read(IniSection iniSection)
@@ -58,6 +63,31 @@ public void Read(IniSection iniSection)
             const string colorKeyName = "EditorColor";
             if (iniSection.KeyExists(colorKeyName))
                 Color = iniSection.GetColorValue(colorKeyName, UISettings.ActiveSettings.AltColor);
+
+            // Support for DTA TiberiumOverlays graphics override feature
+            // TiberiumOverlays=Riparius:TIB1S_01,Vinifera:TIB2S_01,Ore:ORESNO01,Gems:GEMSRA01,GreenGems:GEMSRA01,BlueGems:GEMSRA01
+            const string tiberiumOverlaysKeyName = "TiberiumOverlays";
+            if (iniSection.KeyExists(tiberiumOverlaysKeyName))
+            {
+                ParsedTiberiumGraphicsOverrides = new List<(string tiberiumTypeName, string graphicalOverlayName)>();
+                string value = iniSection.GetStringValue(tiberiumOverlaysKeyName, null);
+                if (!string.IsNullOrWhiteSpace(value))
+                {
+                    string[] values = value.Split(',', StringSplitOptions.RemoveEmptyEntries);
+
+                    foreach (string overrideValue in values)
+                    {
+                        string[] parts = overrideValue.Split(':');
+
+                        if (parts.Length != 2)
+                        {
+                            throw new INIConfigException($"Failed to parse TiberiumOverlays= of TileSet {SetName} (#{Index}).");
+                        }
+
+                        ParsedTiberiumGraphicsOverrides.Add((parts[0], parts[1]));
+                    }
+                }
+            }
         }
     }
 }

src/TSMapEditor/Models/EditorConfig.cs

@@ -356,6 +356,45 @@ private void ReadTiberiumOverlays(Rules rules)
             }
         }
 
+        public void PostTheaterInit(Rules rules)
+        {
+            // Re-assign Theater Tiberium graphics overrides
+            foreach (var theater in Theaters)
+            {
+                foreach (var tileSet in theater.TileSets)
+                {
+                    tileSet.TiberiumGraphicsOverrides?.Clear();
+
+                    if (tileSet.ParsedTiberiumGraphicsOverrides != null &&
+                        tileSet.ParsedTiberiumGraphicsOverrides.Count > 0)
+                    {
+                        tileSet.TiberiumGraphicsOverrides = new Dictionary<TiberiumType, OverlayType>();
+
+                        foreach (var tiberiumGraphicsOverride in tileSet.ParsedTiberiumGraphicsOverrides)
+                        {
+                            TiberiumType tiberiumType = rules.TiberiumTypes.Find(tt => tt.ININame == tiberiumGraphicsOverride.tiberiumTypeName);
+
+                            if (tiberiumType == null)
+                            {
+                                throw new INIConfigException($"Failed to find TiberiumType \"{tiberiumGraphicsOverride.tiberiumTypeName}\" for " +
+                                    $"TiberiumOverlays= of TileSet {tileSet.SetName} ({tileSet.Index}) of Theater \"{theater.UIName}\"!");
+                            }
+
+                            OverlayType overlayType = rules.OverlayTypes.Find(ot => ot.ININame == tiberiumGraphicsOverride.graphicalOverlayName);
+
+                            if (overlayType == null)
+                            {
+                                throw new INIConfigException($"Failed to find OverlayType \"{tiberiumGraphicsOverride.graphicalOverlayName}\" for " +
+                                    $"TiberiumOverlays= of TileSet {tileSet.SetName} ({tileSet.Index}) of Theater \"{theater.UIName}\"!");
+                            }
+
+                            tileSet.TiberiumGraphicsOverrides.Add(tiberiumType, overlayType);
+                        }
+                    }
+                }
+            }
+        }
+
         private void ReadTeamTypeFlags()
         {
             TeamTypeFlags.Clear();

src/TSMapEditor/Rendering/ObjectRenderers/OverlayRenderer.cs

@@ -16,10 +16,30 @@ public OverlayRenderer(RenderDependencies renderDependencies) : base(renderDepen
 
         protected override CommonDrawParams GetDrawParams(Overlay gameObject)
         {
+            ShapeImage shape = TheaterGraphics.OverlayTextures[gameObject.OverlayType.Index];
+
+            // If this is an image for a Tiberium overlay type, check if the cell's underlying TileSet defines an override for the
+            // Tiberium overlay's graphics
+            if (gameObject.OverlayType.TiberiumType != null)
+            {
+                var cell = Map.GetTile(gameObject.Position);
+                var tileSet = Map.TheaterInstance.Theater.TileSets[Map.TheaterInstance.GetTileSetId(cell.TileIndex)];
+
+                if (tileSet.TiberiumGraphicsOverrides != null &&
+                    tileSet.TiberiumGraphicsOverrides.TryGetValue(gameObject.OverlayType.TiberiumType, out OverlayType startGraphicalOverlayType))
+                {
+                    // This comes with the assumption that a TiberiumType's Overlays are in the same order as they have been defined in Rules.ini
+                    int indexWithinOverlays = gameObject.OverlayType.TiberiumType.Overlays.IndexOf(gameObject.OverlayType);
+
+                    int totalOverrideIndex = startGraphicalOverlayType.Index + indexWithinOverlays;
+                    shape = TheaterGraphics.OverlayTextures[totalOverrideIndex];
+                }
+            }
+
             return new CommonDrawParams()
             {
                 IniName = gameObject.OverlayType.ININame,
-                ShapeImage = TheaterGraphics.OverlayTextures[gameObject.OverlayType.Index]
+                ShapeImage = shape
             };
         }
 

src/TSMapEditor/UI/Windows/MainMenuWindows/MapSetup.cs

@@ -124,6 +124,8 @@ public static void LoadTheaterGraphics(WindowManager windowManager, string gameD
 
             EditorGraphics editorGraphics = new EditorGraphics();
 
+            LoadedMap.EditorConfig.PostTheaterInit(LoadedMap.Rules);
+
             var uiManager = new UIManager(windowManager, LoadedMap, theaterGraphics, editorGraphics);
             windowManager.AddAndInitializeControl(uiManager);