Add support for better option notfs

MiraAPI.Example/Options/Roles/FreezerRoleSettings.cs

@@ -2,11 +2,19 @@
 using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using TMPro;
+using UnityEngine;
 
 namespace MiraAPI.Example.Options.Roles;
 
 public class FreezerRoleSettings : AbstractOptionGroup<FreezerRole>
 {
+    public override OptionNotifConfiguration Configuration => new(
+        Palette.Blue,
+        TmpSpriteUtils.CreateSpriteAsset(
+            MiraAssets.ImpostorFile.LoadAsset(),
+            "ApiExample.Role.Impostor.FreezerRole"));
     public override string GroupName => "Custom Role";
 
     [ModdedNumberOption("Freeze Duration", 1, 15, 1, MiraNumberSuffixes.Seconds)]

MiraAPI/GameOptions/AbstractOptionGroup.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using Il2CppInterop.Runtime.Attributes;
 using MiraAPI.Modifiers;
+using TMPro;
 using UnityEngine;
 
 namespace MiraAPI.GameOptions;
@@ -58,6 +60,11 @@ public abstract class AbstractOptionGroup
     /// </summary>
     public virtual uint GroupPriority => uint.MaxValue;
 
+    /// <summary>
+    /// Gets the default notification settings for the group.
+    /// </summary>
+    public virtual OptionNotifConfiguration Configuration => new(new Color(0.7333f, 0.7333f, 0.7333f, 1));
+
     internal bool AllOptionsHidden { get; set; }
 
     internal CategoryHeaderMasked? Header { get; set; }

MiraAPI/GameOptions/IModdedOption.cs

@@ -21,6 +21,16 @@ public interface IModdedOption
     /// </summary>
     string Title { get; set; }
 
+    /// <summary>
+    /// Gets or sets the parent <see cref="AbstractOptionGroup"/> of the option.
+    /// </summary>
+    AbstractOptionGroup ParentGroup { get; set; }
+
+    /// <summary>
+    /// Gets the notification settings for the option.
+    /// </summary>
+    OptionNotifConfiguration Configuration { get; }
+
     /// <summary>
     /// Gets the <see cref="StringNames"/> for the option, used for localization.
     /// </summary>

MiraAPI/GameOptions/ModdedOptionsManager.cs

@@ -12,6 +12,8 @@ using MiraAPI.PluginLoading;
 using MiraAPI.Utilities;
 using Reactor.Networking.Rpc;
 using Reactor.Utilities;
+using TMPro;
+using UnityEngine;
 
 namespace MiraAPI.GameOptions;
 
@@ -30,6 +32,36 @@ public static class ModdedOptionsManager
     internal static uint NextId => _nextId++;
     private static uint _nextId = 1;
 
+    public static void AddSettingsChangeMessage(NotificationPopper notif, StringNames key, string value, Color textColor, TMP_SpriteAsset? sprite, bool playSound = true)
+    {
+        var item = string.Empty;
+        var text = textColor.ToTextColor();
+        if (sprite != null)
+        {
+            item = TranslationController.Instance.GetString(
+                StringNames.LobbyChangeSettingNotification,
+                string.Concat(
+                    "<sprite name=\"",
+                    sprite.name,
+                    "\"><font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">",
+                    text,
+                    TranslationController.Instance.GetString(key),
+                    "</color></font>"),
+                "<font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">" + value + "</font>"
+            );
+        }
+        else
+        {
+            item = TranslationController.Instance.GetString(
+                StringNames.LobbyChangeSettingNotification,
+                "<font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">" +
+                text +
+                TranslationController.Instance.GetString(key) + "</color></font>",
+                "<font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">" + value + "</font>");
+        }
+        notif.SettingsChangeMessageLogic(key, item, playSound);
+    }
+
     internal static bool RegisterGroup(Type type, MiraPluginInfo pluginInfo)
     {
         if (Activator.CreateInstance(type) is not AbstractOptionGroup group)
@@ -123,6 +155,7 @@ public static class ModdedOptionsManager
 
         option.ConfigDefinition = new ConfigDefinition(groupName, propertyName);
 
+        option.ParentGroup = group;
         option.ParentMod = pluginInfo.MiraPlugin;
         pluginInfo.InternalOptions.Add(option);
         ModdedOptions.Add(option.Id, option);

MiraAPI/GameOptions/OptionNotifConfiguration.cs

@@ -0,0 +1,53 @@
+using System;
+using Il2CppInterop.Runtime.Attributes;
+using TMPro;
+using UnityEngine;
+namespace MiraAPI.GameOptions;
+
+/// <summary>
+/// Used to configure the specific visuals for option notifications.
+/// </summary>
+public record struct OptionNotifConfiguration
+{
+#pragma warning disable S1133
+    [Obsolete("Default constructor is not supported")]
+#pragma warning restore S1133
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+    public OptionNotifConfiguration()
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+    {
+        throw new NotImplementedException("Default constructor is not supported.");
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OptionNotifConfiguration"/> struct based on a group.
+    /// </summary>
+    /// <param name="group">The <see cref="AbstractOptionGroup"/> in which you are configuring.</param>
+    public OptionNotifConfiguration(AbstractOptionGroup group)
+    {
+        PopUpIconTmp = group.Configuration.PopUpIconTmp;
+        PopUpTextColor = group.Configuration.PopUpTextColor;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OptionNotifConfiguration"/> struct from scratch.
+    /// </summary>
+    /// <param name="color">The text <see cref="Color"/> for the configuration.</param>
+    /// <param name="asset">The <see cref="TMP_SpriteAsset"/> icon for the configuration.</param>
+    public OptionNotifConfiguration(Color color, TMP_SpriteAsset asset = null!)
+    {
+        PopUpIconTmp = asset;
+        PopUpTextColor = color;
+    }
+
+    /// <summary>
+    /// Gets or sets the <see cref="TMP_SpriteAsset"/> for the icon on the options pop-up.
+    /// </summary>
+    public TMP_SpriteAsset PopUpIconTmp { get; set; }
+
+    /// <summary>
+    /// Gets or sets the <see cref="Color"/> for the text on the options pop-up.
+    /// </summary>
+    [HideFromIl2Cpp]
+    public Color PopUpTextColor { get; set; }
+}

MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs

@@ -90,7 +90,13 @@ public class ModdedEnumOption : ModdedOption<int>
     /// <inheritdoc />
     protected override void OnValueChanged(int newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data.GetValueString(newValue), false);
+        ModdedOptionsManager.AddSettingsChangeMessage(
+            HudManager.Instance.Notifier,
+            StringName,
+            Data.GetValueString(newValue),
+            Configuration.PopUpTextColor,
+            Configuration.PopUpIconTmp,
+            false);
         if (!OptionBehaviour)
         {
             return;
@@ -183,7 +189,13 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
     /// <inheritdoc />
     protected override void OnValueChanged(T newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)), false);
+        ModdedOptionsManager.AddSettingsChangeMessage(
+            HudManager.Instance.Notifier,
+            StringName,
+            Data.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)),
+            Configuration.PopUpTextColor,
+            Configuration.PopUpIconTmp,
+            false);
         if (!OptionBehaviour)
         {
             return;

MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs

@@ -225,9 +225,12 @@ public class ModdedNumberOption : ModdedOption<float>
     protected override void OnValueChanged(float newValue)
     {
         Value = Mathf.Clamp(newValue, Min, Max);
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(
+        ModdedOptionsManager.AddSettingsChangeMessage(
+            HudManager.Instance.Notifier,
             StringName,
-            Data.GetValueString(Value),
+            Data.GetValueString(newValue),
+            Configuration.PopUpTextColor,
+            Configuration.PopUpIconTmp,
             false);
 
         if (OptionBehaviour is NumberOption opt)

MiraAPI/GameOptions/OptionTypes/ModdedOption.cs

@@ -1,10 +1,11 @@
 using System;
 using BepInEx.Configuration;
+using Il2CppInterop.Runtime.Attributes;
 using MiraAPI.Networking;
 using MiraAPI.PluginLoading;
 using Reactor.Localization.Utilities;
 using Reactor.Networking.Rpc;
-using Reactor.Utilities;
+using TMPro;
 using UnityEngine;
 
 namespace MiraAPI.GameOptions.OptionTypes;
@@ -190,4 +191,10 @@ public abstract class ModdedOption<T> : IModdedOption
     {
         return option.Value;
     }
+
+    /// <inheritdoc />
+    public AbstractOptionGroup ParentGroup { get; set; }
+
+    /// <inheritdoc />
+    public OptionNotifConfiguration Configuration => new(ParentGroup);
 }

MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs

@@ -126,7 +126,13 @@ public class ModdedPlayerOption : ModdedOption<int>
     /// <inheritdoc />
     protected override void OnValueChanged(int newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data.GetValueString(newValue), false);
+        ModdedOptionsManager.AddSettingsChangeMessage(
+            HudManager.Instance.Notifier,
+            StringName,
+            Data.GetValueString(newValue),
+            Configuration.PopUpTextColor,
+            Configuration.PopUpIconTmp,
+            false);
         if (!OptionBehaviour)
         {
             return;

MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs

@@ -71,7 +71,13 @@ public class ModdedToggleOption : ModdedOption<bool>
     /// <inheritdoc />
     protected override void OnValueChanged(bool newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, newValue ? "On" : "Off", false);
+        ModdedOptionsManager.AddSettingsChangeMessage(
+            HudManager.Instance.Notifier,
+            StringName,
+            newValue ? "On" : "Off",
+            Configuration.PopUpTextColor,
+            Configuration.PopUpIconTmp,
+            false);
         if (!OptionBehaviour)
         {
             return;

MiraAPI/Patches/Options/NotificationPopperPatch.cs

@@ -33,7 +33,7 @@ public static class NotificationPopperPatch
                 icon,
                 "<font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">",
                 textColor,
-                TranslationController.Instance.GetString(key, Array.Empty<Object>()),
+                TranslationController.Instance.GetString(key),
                 "</color></font>"
             ),
             "<font=\"Barlow-Black SDF\" material=\"Barlow-Black Outline\">" + roleCount + "</font>",