An unfinished mod selector

ModMenu/Helpers.cs

@@ -2,6 +2,7 @@
 using Kingmaker;
 using Kingmaker.Localization;
 using Kingmaker.Localization.Shared;
+using Kingmaker.Utility;
 using Kingmaker.UI.MVVM._PCView.Settings.Entities;
 using Kingmaker.UI.MVVM._PCView.Settings;
 using Kingmaker.UI.MVVM._VM.Settings.Entities;
@@ -19,12 +20,14 @@ namespace ModMenu
   internal static class Helpers
   {
     private static readonly List<LocalString> Strings = new();
+    internal static LocalizedString EmptyString = CreateString("", "");
 
-    internal static LocalizedString CreateString(string key, string enGB, string ruRU = "")
+    internal static LocalizedString CreateString(string key, string enGB, string ruRU = null, string zhCN = null, string deDE = null, string frFR = null)
     {
-      var localString = new LocalString(key, enGB, ruRU);
+      var localString = new LocalString(key, enGB, ruRU, zhCN, deDE, frFR);
       Strings.Add(localString);
-      localString.Register();
+      if (LocalizationManager.Initialized)
+        localString.Register();
       return localString.LocalizedString;
     }
 
@@ -45,24 +48,43 @@ private class LocalString
       public readonly LocalizedString LocalizedString;
       private readonly string enGB;
       private readonly string ruRU;
+      private readonly string zhCN;
+      private readonly string deDE;
+      private readonly string frFR;
+      const string NullString = "<null>";
 
-      public LocalString(string key, string enGB, string ruRU)
+      public LocalString(string key, string enGB, string ruRU, string zhCN, string deDE, string frFR)
       {
         LocalizedString = new LocalizedString() { m_Key = key };
         this.enGB = enGB;
         this.ruRU = ruRU;
+        this.zhCN = zhCN;
+        this.deDE = deDE;
+        this.frFR = frFR;
       }
 
       public void Register()
       {
-        var localized = enGB;
-        switch (LocalizationManager.CurrentPack.Locale)
+        string localized;
+        if (LocalizationManager.CurrentPack.Locale == Locale.enGB)
         {
-          case Locale.ruRU:
-            if (!string.IsNullOrEmpty(ruRU))
-              localized = ruRU;
-            break;
+          localized = enGB;
+          goto putString;
         }
+
+        localized = (LocalizationManager.CurrentPack.Locale) switch
+        {
+          Locale.ruRU => ruRU,
+          Locale.zhCN => zhCN,
+          Locale.deDE => deDE,
+          Locale.frFR => frFR,
+          _ => ""
+        };
+
+        if (localized.IsNullOrEmpty() || localized == NullString)
+          localized = enGB;
+
+        ;putString:
         LocalizationManager.CurrentPack.PutString(LocalizedString.m_Key, localized);
       }
     }

ModMenu/Main.cs

@@ -1,27 +1,33 @@
 using HarmonyLib;
+using Kingmaker.Blueprints.Classes.Spells;
 using Kingmaker.Blueprints.JsonSystem;
+using Kingmaker.Utility;
 using ModMenu.Settings;
 using System;
+using System.Linq;
+using System.Reflection;
 using static UnityModManagerNet.UnityModManager;
 using static UnityModManagerNet.UnityModManager.ModEntry;
 
 namespace ModMenu
 {
-  public static class Main
+  internal static class Main
   {
     internal static ModLogger Logger;
-    private static Harmony Harmony;
+    internal static ModEntry Entry;
+    internal static Harmony Harmony;
 
     public static bool Load(ModEntry modEntry)
     {
       try
       {
+        Entry = modEntry;
         Logger = modEntry.Logger;
         modEntry.OnUnload = OnUnload;
 
         Harmony = new(modEntry.Info.Id);
+        Harmony.DEBUG = true;
         Harmony.PatchAll();
-
         Logger.Log("Finished loading.");
       }
       catch (Exception e)
@@ -56,6 +62,7 @@ static void Postfix()
           Logger.LogException("BlueprintsCache.Init", e);
         }
       }
+
     }
 #endif
   }

ModMenu/ModMenu.cs

@@ -1,4 +1,5 @@
-using Kingmaker.Settings;
+using JetBrains.Annotations;
+using Kingmaker.Settings;
 using Kingmaker.UI.SettingsUI;
 using ModMenu.Settings;
 using System;
@@ -25,8 +26,8 @@ public static class ModMenu
     /// </exception>
     public static void AddSettings(SettingsBuilder settings)
     {
-      var settingsGroup = settings.Build();
-      foreach (var setting in settingsGroup.settings)
+      var result = settings.Build();
+      foreach (var setting in result.settings)
       {
         if (Settings.ContainsKey(setting.Key))
         {
@@ -35,28 +36,111 @@ public static void AddSettings(SettingsBuilder settings)
         }
         Settings.Add(setting.Key, setting.Value);
       }
-      ModsMenuEntity.Add(settingsGroup.group);
+      ModsMenuEntity.Add(result.info, result.groups);
     }
 
     /// <summary>
-    /// Adds a new group of settings to the Mods menu page.
+    /// Adds a new entry containing the group of settings to the Mods menu dropdown. 
+    /// Group's title will be displayed instead of the mod name.
     /// </summary>
     /// 
     /// <remarks>
     /// <para>
     /// Using <see cref="AddSettings(SettingsBuilder)"/> is recommended. If you prefer to construct the settings
-    /// on your own you can use this method.
+    /// on your own you can use this method, but better choose a less deprecated overload using ModsMenuEntry.
+    /// The name of the settings group will be used as the display name for the mod in the selection dropdown .
     /// </para>
     /// 
     /// <para>
     /// Settings added in this way cannot be retrieved using <see cref="GetSetting{T, TValue}(string)"/> or
     /// <see cref="GetSettingValue{T}(string)"/>.
     /// </para>
     /// </remarks>
-    public static void AddSettings(UISettingsGroup settingsGroup)
-    {
-      ModsMenuEntity.Add(settingsGroup);
-    }
+    /// <exception cref="ArgumentException">
+    /// settingGroups argument must not be null, have at least 1 group in it and none can be null
+    /// </exception> 
+    [Obsolete("Please, use AddSettings(ModsMenuEntry modInfo) instead")]
+    public static void AddSettings([NotNull] UISettingsGroup settingsGroup) 
+      => ModsMenuEntity.Add(default, new UISettingsGroup[1] { settingsGroup });
+
+    /// <summary>
+    /// Adds a new entry containing groups of settings to the Mods menu dropdown. 
+    /// The title of the first group will displayed instead of the mod name
+    /// </summary>
+    /// 
+    /// <remarks>
+    /// <para>
+    /// Using <see cref="AddSettings(SettingsBuilder)"/> is recommended. If you prefer to construct the settings
+    /// on your own you can use this method, but better choose a less deprecated overload using ModsMenuEntry.
+    /// The name of the first settings group from the list will be used as the display name for the mod in the selection dropdown .
+    /// </para>
+    /// 
+    /// <para>
+    /// Settings added in this way cannot be retrieved using <see cref="GetSetting{T, TValue}(string)"/> or
+    /// <see cref="GetSettingValue{T}(string)"/>.
+    /// </para>
+    /// </remarks>
+    /// <exception cref="ArgumentException">
+    /// settingGroups argument must not be null, have at least 1 group in it and none can be null
+    /// </exception> 
+    [Obsolete("Please, use AddSettings(ModsMenuEntry modInfo) instead")]
+    public static void AddSettings([NotNull] List<UISettingsGroup> settingsGroups)
+      => ModsMenuEntity.Add(default, settingsGroups);
+
+    /// <summary>
+    /// Adds a new entry containing groups of settings to the Mods menu page. 
+    /// </summary>
+    /// 
+    /// <remarks>
+    /// <para>
+    /// Use this method if you prefer to construct settings on your own; you can use this method
+    /// instead of using the recommended <see cref="AddSettings(SettingsBuilder)"/>. 
+    /// </para>
+    /// 
+    /// <param name="modInfo"> Structure containing basic info about the mod - name, version, description, author name et cetera. 
+    /// This information will be displayed when user is choosing the mod from the dropdown
+    /// </param>
+    /// <param name="group"> Group of settings created with original Owlcat API. If you did not set any mod name inside the modInfo structure,
+    /// name of this settings group will be instead used as the display name of the mod.
+    /// </param>
+    /// 
+    /// <para>
+    /// Settings added in this way cannot be retrieved using <see cref="GetSetting{T, TValue}(string)"/> or
+    /// <see cref="GetSettingValue{T}(string)"/>.
+    /// </para>
+    /// </remarks>
+    /// <exception cref="ArgumentException">
+    /// settingGroups argument must not be null, have at least 1 group in it and none can be null
+    /// </exception> 
+    /// 
+    public static void AddSettings(Info modInfo, [NotNull] UISettingsGroup group) 
+      => ModsMenuEntity.Add(modInfo, new UISettingsGroup[1] { group });
+
+    /// <summary>
+    /// Adds a new entry containing groups of settings to the Mods menu page. 
+    /// </summary>
+    /// 
+    /// <remarks>
+    /// <para>
+    /// Use this method if you prefer to construct settings on your own; you can use this method
+    /// instead of using the recommended <see cref="AddSettings(SettingsBuilder)"/>. 
+    /// 
+    /// Settings added in this way cannot be retrieved using <see cref="GetSetting{T, TValue}(string)"/> or
+    /// <see cref="GetSettingValue{T}(string)"/>.
+    /// </para>
+    /// </remarks>
+    /// 
+    /// <param name="modInfo"> Structure containing basic info about the mod - name, version, description, author name et cetera. 
+    /// This information will be displayed when user is choosing the mod from the dropdown
+    /// </param>param>
+    /// <param name="groups"> Groups of settings created with original Owlcat API. If you did not set any mod name inside the modInfo structure,
+    /// name of the first settings group from the list will be instead used as the display name of the mod.
+    /// </param>param>
+    /// <exception cref="ArgumentException">
+    /// settingGroups argument must not be null, have at least 1 group in it and none can be null
+    /// </exception> 
+    public static void AddSettings(Info modInfo, [NotNull] List<UISettingsGroup> groups) 
+      => ModsMenuEntity.Add(modInfo, groups);
 
     /// <returns>
     /// The setting with the specified <paramref name="key"/>, or null if it does not exist or has the wrong type.

ModMenu/ModMenu.csproj

@@ -45,22 +45,25 @@
   <ItemGroup>
     <!-- Main Wrath Assembly, Publicized -->
     <Reference Include="Assembly-CSharp.dll">
-      <HintPath>$(SolutionDir)lib\Assembly-CSharp.dll</HintPath>
+      <HintPath>$(SolutionDir)lib\Assembly-CSharp_public.dll</HintPath>
     </Reference>
+    <Reference Include="Newtonsoft.Json">
+      <HintPath>..\..\..\..\..\..\Program Files (x86)\Steam\steamapps\common\Pathfinder Second Adventure\Wrath_Data\Managed\Newtonsoft.Json.dll</HintPath>
+    </Reference>
+    <Reference Include="Owlcat.Runtime.UI.dll">
+      <HintPath>$(SolutionDir)lib\Owlcat.Runtime.UI_public.dll</HintPath>
+    </Reference>
+	<Reference Include="Unity.TextMeshPro">
+	  <HintPath>$(SolutionDir)lib\Unity.TextMeshPro_public.dll</HintPath>
+	</Reference>
 
     <!-- Wrath Assemblies -->
     <Reference Include="Assembly-CSharp-firstpass.dll">
       <HintPath>$(WrathPath)\Wrath_Data\Managed\Assembly-CSharp-firstpass.dll</HintPath>
     </Reference>
-    <Reference Include="Owlcat.Runtime.UI.dll">
-      <HintPath>$(WrathPath)\Wrath_Data\Managed\Owlcat.Runtime.UI.dll</HintPath>
-    </Reference>
     <Reference Include="Owlcat.Runtime.Validation.dll">
       <HintPath>$(WrathPath)\Wrath_Data\Managed\Owlcat.Runtime.Validation.dll</HintPath>
     </Reference>
-    <Reference Include="Unity.TextMeshPro.dll">
-      <HintPath>$(WrathPath)\Wrath_Data\Managed\Unity.TextMeshPro.dll</HintPath>
-    </Reference>
     <Reference Include="UnityEngine.CoreModule.dll">
       <HintPath>$(WrathPath)\Wrath_Data\Managed\UnityEngine.CoreModule.dll</HintPath>
     </Reference>
@@ -89,16 +92,16 @@
     </None>
   </ItemGroup>
 
-  <!-- Generates Assembly-CSharp_public.dll -->
-  <Target Name="Publicize" AfterTargets="Clean">
-    <ItemGroup>
-      <Assemblies Include="$(WrathPath)\Wrath_Data\Managed\Assembly-CSharp.dll" />
-      <PublicAssembly Include="$(SolutionDir)lib\Assembly-CSharp_public.dll" />
-      <RenamedAssembly Include="$(SolutionDir)lib\Assembly-CSharp.dll" />
+  <!-- Generates Assembly-CSharp_public.dll and Owlcat.Runtime.UI_public.dll -->
+	<Target Name="Publicize" AfterTargets="Clean">
+		<ItemGroup>
+      <Assemblies Include="$(WrathPath)\Wrath_Data\Managed\Owlcat.Runtime.UI.dll" />
+     <Assemblies Include="$(WrathPath)\Wrath_Data\Managed\Assembly-CSharp.dll" />
+	  <Assemblies Include="$(WrathPath)\Wrath_Data\Managed\Unity.TextMeshPro.dll" />
+
     </ItemGroup>
 
-    <PublicizeTask InputAssemblies="@(Assemblies)" OutputDir="$(SolutionDir)lib/" />
-    <Move SourceFiles="@(PublicAssembly)" DestinationFiles="@(RenamedAssembly)" />
+    <PublicizeTask InputAssemblies="@(Assemblies)" OutputDir="$(SolutionDir)lib\" />
   </Target>
 
   <!-- Automatically deploys the mod on build -->

ModMenu/NewTypes/DropdownItemWithHighlightCallback.cs

@@ -0,0 +1,56 @@
+using Owlcat.Runtime.UI.MVVM;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using TMPro;
+using UniRx.Triggers;
+using UniRx;
+using HarmonyLib;
+using Epic.OnlineServices;
+using UnityEngine.EventSystems;
+using Steamworks;
+
+namespace ModMenu.NewTypes
+{
+  [HarmonyPatch]
+  internal class DropdownOptionWithHighlightCallback : TMP_Dropdown.OptionData
+  {
+    public List<Action<TMP_Dropdown.DropdownItem>> OnMouseEnter = new();
+    public List<Action<TMP_Dropdown.DropdownItem>> OnMouseExit = new();
+
+
+    [HarmonyPatch(typeof(TMP_Dropdown), nameof(TMP_Dropdown.AddItem))]
+    [HarmonyPostfix]
+    static void TMP_Dropdown_AddItem_Patch(TMP_Dropdown.OptionData data, TMP_Dropdown __instance, TMP_Dropdown.DropdownItem __result)
+    {
+      if (data is not DropdownOptionWithHighlightCallback workaround)
+        return;
+      else
+      {
+        var observer = __result.gameObject.AddComponent<PointerObserverWorkaround>();
+        foreach (var action in workaround.OnMouseEnter)
+          observer.PointerEnter += action;
+        foreach (var action in workaround.OnMouseExit)
+          observer.PointerExit += action;
+      }          
+    }
+
+
+    class PointerObserverWorkaround : UIBehaviour, IPointerEnterHandler, IPointerExitHandler
+    {
+      internal event Action<TMP_Dropdown.DropdownItem> PointerEnter;
+      internal event Action<TMP_Dropdown.DropdownItem> PointerExit;
+
+      public void OnPointerEnter(PointerEventData eventData)
+      {
+        PointerEnter?.Invoke(GetComponent<TMP_Dropdown.DropdownItem>());
+      }
+      public void OnPointerExit(PointerEventData eventData)
+      {
+        PointerExit?.Invoke(GetComponent<TMP_Dropdown.DropdownItem>());
+      }
+    }
+  }
+}

ModMenu/NewTypes/SettingsEntityCollapsibleHeader.cs

@@ -100,16 +100,16 @@ public override VirtualListLayoutElementSettings LayoutSettings
     public OwlcatMultiButton Button;
     public ExpandableCollapseMultiButtonPC ButtonPC;
 
-    protected override void BindViewImplementation()
+    public override void BindViewImplementation()
     {
       Title.text = UIUtility.GetSaberBookFormat(ViewModel.Tittle, size: GetFontSize());
       Button.OnLeftClick.RemoveAllListeners();
       Button.OnLeftClick.AddListener(() => ViewModel.Toggle(ButtonPC));
       ViewModel.Init(ButtonPC);
     }
 
-    protected virtual int GetFontSize() { return 140; }
+    public virtual int GetFontSize() { return 140; }
 
-    protected override void DestroyViewImplementation() { }
+    public override void DestroyViewImplementation() { }
   }
 }