From 612df4bb3c1e2b20504d57c16491b2943c467ea4 Mon Sep 17 00:00:00 2001
From: XtraCube <72575280+XtraCube@users.noreply.github.com>
Date: Thu, 22 Aug 2024 13:41:48 -0400
Subject: [PATCH] update example
---
.../Options/Roles/CustomRole2Settings.cs | 1 -
.../Options/Roles/CustomRoleSettings.cs | 1 -
MiraAPI/GameOptions/IModdedOptionGroup.cs | 15 +++++++++++++++
MiraAPI/Patches/Options/LobbyViewPanePatches.cs | 1 -
4 files changed, 15 insertions(+), 3 deletions(-)
diff --git a/MiraAPI.Example/Options/Roles/CustomRole2Settings.cs b/MiraAPI.Example/Options/Roles/CustomRole2Settings.cs
index 9712dcdc..e0e9d1a3 100644
--- a/MiraAPI.Example/Options/Roles/CustomRole2Settings.cs
+++ b/MiraAPI.Example/Options/Roles/CustomRole2Settings.cs
@@ -2,7 +2,6 @@
using MiraAPI.Example.Roles;
using MiraAPI.GameOptions;
using MiraAPI.GameOptions.Attributes;
-using MiraAPI.GameOptions.OptionTypes;
namespace MiraAPI.Example.Options.Roles;
diff --git a/MiraAPI.Example/Options/Roles/CustomRoleSettings.cs b/MiraAPI.Example/Options/Roles/CustomRoleSettings.cs
index 484ad6fc..98882aed 100644
--- a/MiraAPI.Example/Options/Roles/CustomRoleSettings.cs
+++ b/MiraAPI.Example/Options/Roles/CustomRoleSettings.cs
@@ -2,7 +2,6 @@
using MiraAPI.Example.Roles;
using MiraAPI.GameOptions;
using MiraAPI.GameOptions.Attributes;
-using MiraAPI.GameOptions.OptionTypes;
namespace MiraAPI.Example.Options.Roles;
diff --git a/MiraAPI/GameOptions/IModdedOptionGroup.cs b/MiraAPI/GameOptions/IModdedOptionGroup.cs
index d5d23fae..62970119 100644
--- a/MiraAPI/GameOptions/IModdedOptionGroup.cs
+++ b/MiraAPI/GameOptions/IModdedOptionGroup.cs
@@ -5,8 +5,23 @@ namespace MiraAPI.GameOptions;
public interface IModdedOptionGroup
{
+ ///
+ /// The name of the group. Visible in options menu.
+ ///
public string GroupName { get; }
+
+ ///
+ /// A function that returns whether the group should be visible or not.
+ ///
public Func GroupVisible => () => true;
+
+ ///
+ /// The group color. This is used to color the group in the options menu.
+ ///
public Color GroupColor => Color.clear;
+
+ ///
+ /// The role the group is associated with. This is used for the advanced role options menu.
+ ///
public Type AdvancedRole => null;
}
\ No newline at end of file
diff --git a/MiraAPI/Patches/Options/LobbyViewPanePatches.cs b/MiraAPI/Patches/Options/LobbyViewPanePatches.cs
index 011b4217..0f2fc49c 100644
--- a/MiraAPI/Patches/Options/LobbyViewPanePatches.cs
+++ b/MiraAPI/Patches/Options/LobbyViewPanePatches.cs
@@ -1,6 +1,5 @@
using HarmonyLib;
using MiraAPI.Utilities.Assets;
-using TMPro;
using UnityEngine;
using UnityEngine.Events;
using UnityEngine.UI;