Implement custom mission support with CampaignTagSelector

ClientCore/ClientConfiguration.cs

@@ -372,6 +372,11 @@ private List<TranslationGameFile> ParseTranslationGameFiles()
 
         public int DefaultSkillLevelIndex => clientDefinitionsIni.GetIntValue(SETTINGS, "DefaultSkillLevelIndex", 0);
 
+
+        public bool CampaignTagSelectorEnabled => clientDefinitionsIni.GetBooleanValue(SETTINGS, "CampaignTagSelectorEnabled", false);
+
+        public bool ReturnToMainMenuOnMissionLaunch => clientDefinitionsIni.GetBooleanValue(SETTINGS, "ReturnToMainMenuOnMissionLaunch", true);
+
         public string GetGameExecutableName()
         {
             string[] exeNames = clientDefinitionsIni.GetStringListValue(SETTINGS, "GameExecutableNames", "Game.exe");
@@ -502,6 +507,10 @@ public List<string> GetIRCServers()
         }
 
         public bool DiscordIntegrationGloballyDisabled => string.IsNullOrWhiteSpace(DiscordAppId) || DisableDiscordIntegration;
+
+        public string CustomMissionPath => clientDefinitionsIni.GetStringValue(SETTINGS, "CustomMissionPath", "Maps/CustomMissions");
+        public string CustomMissionSupplementDefinition // e.g., "csf|stringtable99.csf|pal|custommission.pal|shp|custommission.shp"
+            => clientDefinitionsIni.GetStringValue(SETTINGS, "CustomMissionSupplementDefinition", string.Empty);
 
         public OSVersion GetOperatingSystemVersion()
         {

ClientGUI/DarkeningPanel.cs

@@ -11,6 +11,7 @@ namespace ClientGUI
     public class DarkeningPanel : XNAPanel
     {
         public const float ALPHA_RATE = 0.6f;
+        private bool _fadeEnabled = true;
 
         public DarkeningPanel(WindowManager windowManager) : base(windowManager)
         {
@@ -24,7 +25,7 @@ public override void Initialize()
             Name = "DarkeningPanel";
 
             SetPositionAndSize();
-            
+
             PanelBackgroundDrawMode = PanelBackgroundImageDrawMode.STRETCHED;
             BackgroundTexture = AssetLoader.CreateTexture(new Color(0, 0, 0, 128), 1, 1);
             DrawBorders = false;
@@ -67,8 +68,17 @@ public void Show()
         {
             Enabled = true;
             Visible = true;
-            AlphaRate = ALPHA_RATE;
-            Alpha = 0.01f;
+
+            if (_fadeEnabled)
+            {
+                AlphaRate = ALPHA_RATE;
+                Alpha = 0.01f;
+            }
+            else
+            {
+                AlphaRate = 1.0f;
+                Alpha = 1.0f;
+            }
 
             foreach (XNAControl child in Children)
             {
@@ -79,7 +89,16 @@ public void Show()
 
         public void Hide()
         {
-            AlphaRate = -ALPHA_RATE;
+            if (_fadeEnabled)
+            {
+                AlphaRate = -ALPHA_RATE;
+            }
+            else
+            {
+                Enabled = false;
+                Visible = false;
+                Hidden?.Invoke(this, EventArgs.Empty);
+            }
 
             foreach (XNAControl child in Children)
             {
@@ -106,5 +125,10 @@ public static void AddAndInitializeWithControl(WindowManager wm, XNAControl cont
             wm.AddAndInitializeControl(dp);
             dp.AddChild(control);
         }
+
+        public void ToggleFade(bool enabled)
+        {
+            _fadeEnabled = enabled;
+        }
     }
 }

ClientGUI/INItializableWindow.cs

@@ -29,29 +29,43 @@ public INItializableWindow(WindowManager windowManager) : base(windowManager)
         /// instead of the window's name.
         /// </summary>
         protected string IniNameOverride { get; set; }
+        private bool VisitChild(IEnumerable<XNAControl> list, Func<XNAControl, bool> judge)
+        {
+            foreach (XNAControl child in list)
+            {
+                bool stop = judge(child);
+                if (stop) return true;
+                stop = VisitChild(child.Children, judge);
+                if (stop) return true;
+            }
+            return false;
+        }
 
         public T FindChild<T>(string childName, bool optional = false) where T : XNAControl
         {
-            T child = FindChild<T>(Children, childName);
-            if (child == null && !optional)
+            XNAControl result = null;
+            VisitChild(new List<XNAControl>() { this }, control =>
+            {
+                if (control.Name != childName) return false;
+                result = control;
+                return true;
+            });
+            if (result == null && !optional)
                 throw new KeyNotFoundException("Could not find required child control: " + childName);
-
-            return child;
+            return (T)result;
         }
 
-        private T FindChild<T>(IEnumerable<XNAControl> list, string controlName) where T : XNAControl
+        public List<T> FindChildrenStartWith<T>(string prefix) where T : XNAControl
         {
-            foreach (XNAControl child in list)
+            List<T> result = new List<T>();
+            VisitChild(new List<XNAControl>() { this }, (control) =>
             {
-                if (child.Name == controlName)
-                    return (T)child;
-
-                T childOfChild = FindChild<T>(child.Children, controlName);
-                if (childOfChild != null)
-                    return childOfChild;
-            }
-
-            return null;
+                if (string.IsNullOrEmpty(prefix) ||
+                !string.IsNullOrEmpty(control.Name) && control.Name.StartsWith(prefix))
+                    result.Add((T)control);
+                return false;
+            });
+            return result;
         }
 
         /// <summary>

DTAConfig/OptionPanels/XNAOptionsPanel.cs

@@ -5,6 +5,8 @@
 using Rampastring.Tools;
 using Rampastring.XNAUI;
 using Rampastring.XNAUI.XNAControls;
+
+using System;
 using System.Collections.Generic;
 
 namespace DTAConfig.OptionPanels
@@ -33,6 +35,24 @@ public override void Initialize()
             PanelBackgroundDrawMode = PanelBackgroundImageDrawMode.STRETCHED;
 
             base.Initialize();
+
+            GameProcessLogic.GameProcessExited += GameProcessExited_Callback;
+        }
+
+        private void GameProcessExited_Callback()
+        {
+            foreach (IUserSetting setting in userSettings)
+            {
+                if (!setting.ResetToDefaultOnGameExit)
+                    continue;
+
+                if (setting is SettingCheckBoxBase cb)
+                    cb.Checked = cb.DefaultValue;
+                else if (setting is SettingDropDownBase dd)
+                    dd.SelectedIndex = dd.DefaultValue;
+
+                setting.Save();
+            }
         }
 
         /// <summary>

DTAConfig/Settings/IUserSetting.cs

@@ -1,6 +1,6 @@
 namespace DTAConfig.Settings
 {
-    interface IUserSetting
+    public interface IUserSetting
     {
 
         /// <summary>
@@ -19,6 +19,11 @@ interface IUserSetting
         /// </summary>
         bool RestartRequired { get; }
 
+        /// <summary>
+        /// Determines if the setting should reset to its default value where applicable once game process exits.
+        /// </summary>
+        public bool ResetToDefaultOnGameExit { get; }
+
         /// <summary>
         /// Loads the current value for the user setting.
         /// </summary>

DTAConfig/Settings/SettingCheckBoxBase.cs

@@ -9,12 +9,13 @@ public abstract class SettingCheckBoxBase : XNAClientCheckBox, IUserSetting
     {
         public SettingCheckBoxBase(WindowManager windowManager) : base(windowManager) { }
 
-        public SettingCheckBoxBase(WindowManager windowManager, bool defaultValue, string settingSection, string settingKey, bool restartRequired = false) : base(windowManager)
+        public SettingCheckBoxBase(WindowManager windowManager, bool defaultValue, string settingSection, string settingKey, bool restartRequired = false, bool resetPerGameSession = false) : base(windowManager)
         {
             DefaultValue = defaultValue;
             SettingSection = settingSection;
             SettingKey = settingKey;
             RestartRequired = restartRequired;
+            ResetToDefaultOnGameExit = resetPerGameSession;
         }
 
         public bool DefaultValue { get; set; }
@@ -34,6 +35,7 @@ public string SettingKey
         }
 
         public bool RestartRequired { get; set; }
+        public bool ResetToDefaultOnGameExit { get; set; }
 
         private string _parentCheckBoxName;
         /// <summary>
@@ -95,6 +97,9 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st
                 case "ParentCheckBoxRequiredValue":
                     ParentCheckBoxRequiredValue = Conversions.BooleanFromString(value, true);
                     return;
+                case "ResetToDefaultOnGameExit":
+                    ResetToDefaultOnGameExit = Conversions.BooleanFromString(value, false);
+                    return;
             }
 
             base.ParseControlINIAttribute(iniFile, key, value);

DTAConfig/Settings/SettingDropDownBase.cs

@@ -37,6 +37,7 @@ public string SettingKey
         }
 
         public bool RestartRequired { get; set; }
+        public bool ResetToDefaultOnGameExit { get; set; }
 
         protected string defaultSection = "CustomSettings";
         protected string defaultKeySuffix = "_SelectedIndex";

DXMainClient/DXGUI/GameClass.cs

@@ -278,7 +278,7 @@ private IServiceProvider BuildServiceProvider(WindowManager windowManager)
                             .AddSingletonXnaControl<MapPreviewBox>()
                             .AddSingletonXnaControl<GameLaunchButton>()
                             .AddSingletonXnaControl<PlayerExtraOptionsPanel>()
-                            .AddSingletonXnaControl<CampaignSelector>()
+                            .AddSingletonXnaControl<CampaignTagSelector>()
                             .AddSingletonXnaControl<GameLoadingWindow>()
                             .AddSingletonXnaControl<StatisticsWindow>()
                             .AddSingletonXnaControl<UpdateQueryWindow>()