Merge pull request #516 from ow-mods/dev

Some menu fixes/improvements, and deprecate ModHelper.Events

docs/content/pages/guides/mod_settings.md

@@ -126,3 +126,7 @@ public class MyMod : ModBehaviour {
     }
 }
 ```
+
+## Config Updates
+
+Something important to note is that when the manager pulls and update for your mod, the `config.json` file is preserved. The issue with this is menus are generated from the `config.json` file. When changing options like slider minimums and maximums or choices, you may want to create a new property rather than edit an existing one to make sure the UI is correct.

src/OWML.Common/Interfaces/IModEvents.cs

@@ -3,14 +3,19 @@
 
 namespace OWML.Common
 {
+	[Obsolete("Use HarmonyHelper instead.")]
 	public interface IModEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		IModPlayerEvents Player { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		IModSceneEvents Scenes { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		IModUnityEvents Unity { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action<MonoBehaviour, Events> Event;
 
 		[Obsolete("Use Event instead.")]

src/OWML.Common/Interfaces/IModPlayerEvents.cs

@@ -4,6 +4,7 @@ namespace OWML.Common
 {
 	public interface IModPlayerEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action<PlayerBody> OnPlayerAwake;
 
 		void Init(IModEvents events);

src/OWML.Common/Interfaces/IModSceneEvents.cs

@@ -4,8 +4,10 @@ namespace OWML.Common
 {
 	public interface IModSceneEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action<OWScene, OWScene> OnStartSceneChange;
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action<OWScene, OWScene> OnCompleteSceneChange;
 	}
 }

src/OWML.Common/Interfaces/IModUnityEvents.cs

@@ -4,10 +4,13 @@ namespace OWML.Common
 {
 	public interface IModUnityEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action OnUpdate;
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action OnFixedUpdate;
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		event Action OnLateUpdate;
 
 		void FireOnNextUpdate(Action action);

src/OWML.Launcher/OWML.Manifest.json

@@ -3,7 +3,7 @@
   "author": "Alek",
   "name": "OWML",
   "uniqueName": "Alek.OWML",
-  "version": "2.7.5",
+  "version": "2.8.0",
   "minGameVersion": "1.1.13.393",
   "maxGameVersion": "1.1.13.456"
 }

src/OWML.ModHelper.Events/ModEvents.cs

@@ -6,14 +6,19 @@
 
 namespace OWML.ModHelper.Events
 {
+	[Obsolete("Use HarmonyHelper instead.")]
 	public class ModEvents : IModEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		public IModPlayerEvents Player { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public IModSceneEvents Scenes { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public IModUnityEvents Unity { get; }
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action<MonoBehaviour, Common.Events> Event;
 
 		[Obsolete("Use Event instead.")]
@@ -57,6 +62,7 @@ private void OnPatchEvent(MonoBehaviour behaviour, Common.Events ev)
 			}
 		}
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public void Subscribe<T>(Common.Events ev) where T : MonoBehaviour
 		{
 			SubscribeToEvent<T>(ev);

src/OWML.ModHelper.Events/ModPlayerEvents.cs

@@ -6,6 +6,7 @@ namespace OWML.ModHelper.Events
 {
 	public class ModPlayerEvents : IModPlayerEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action<PlayerBody> OnPlayerAwake;
 
 		public void Init(IModEvents events)

src/OWML.ModHelper.Events/ModSceneEvents.cs

@@ -5,7 +5,9 @@ namespace OWML.ModHelper.Events
 {
 	public class ModSceneEvents : IModSceneEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action<OWScene, OWScene> OnStartSceneChange;
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action<OWScene, OWScene> OnCompleteSceneChange;
 
 		public ModSceneEvents()

src/OWML.ModHelper.Events/ModUnityEvents.cs

@@ -7,10 +7,13 @@ namespace OWML.ModHelper.Events
 {
 	public class ModUnityEvents : MonoBehaviour, IModUnityEvents
 	{
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action OnUpdate;
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action OnFixedUpdate;
 
+		[Obsolete("Use HarmonyHelper instead.")]
 		public event Action OnLateUpdate;
 
 		public void FireOnNextUpdate(Action action) => 

src/OWML.ModHelper.Menus/ModConfigMenuBase.cs

@@ -164,7 +164,7 @@ private void AddSeparator(string key, int index, JObject obj)
 			separator.Show();
 		}
 
-		private void SetupInputTooltip<T>(IModInput<T> input, string tooltip)
+		internal void SetupInputTooltip<T>(IModInput<T> input, string tooltip)
 		{
 			var menuOption = input.Element.GetComponent<MenuOption>();
 			menuOption.SetValue("_tooltipTextType", UITextType.None);

src/OWML.ModHelper.Menus/OwmlConfigMenu.cs

@@ -6,7 +6,11 @@ namespace OWML.ModHelper.Menus
 	public class OwmlConfigMenu : ModConfigMenuBase
 	{
 		private const string DebugModeTitle = "Debug mode";
+		private const string DebugModeTooltip = "Enable verbose logging. Some effects only enable/disable when game is reloaded.";
 		private const string ForceExeTitle = "Force run through .exe";
+		private const string ForceExeTooltip = "Force OWML to run the game's exe, rather than going through Steam/Epic.";
+		private const string IncrementalGCTitle = "Enable incremental GC";
+		private const string IncrementalGCTooltip = "Incremental GC (garbage collection) can help reduce lag spikes with some mods. Only has effect after game is reloaded.";
 
 		private readonly IOwmlConfig _config;
 		private readonly IOwmlConfig _defaultConfig;
@@ -27,20 +31,31 @@ protected override void AddInputs()
 		{
 			AddConfigInput(DebugModeTitle, _config.DebugMode, 2);
 			AddConfigInput(ForceExeTitle, _config.ForceExe, 3);
+			AddConfigInput(IncrementalGCTitle, _config.IncrementalGC, 4);
 			UpdateNavigation();
 			SelectFirst();
 		}
 
 		public override void UpdateUIValues()
 		{
-			GetToggleInput(DebugModeTitle).Value = _config.DebugMode;
-			GetToggleInput(ForceExeTitle).Value = _config.ForceExe;
+			var debug = GetToggleInput(DebugModeTitle);
+			debug.Value = _config.DebugMode;
+			SetupInputTooltip(debug, DebugModeTooltip);
+
+			var exe = GetToggleInput(ForceExeTitle);
+			exe.Value = _config.ForceExe;
+			SetupInputTooltip(exe, ForceExeTooltip);
+
+			var gc = GetToggleInput(IncrementalGCTitle);
+			gc.Value = _config.IncrementalGC;
+			SetupInputTooltip(gc, IncrementalGCTooltip);
 		}
 
 		protected override void OnSave()
 		{
 			_config.DebugMode = GetInputValue<bool>(DebugModeTitle);
 			_config.ForceExe = GetInputValue<bool>(ForceExeTitle);
+			_config.IncrementalGC = GetInputValue<bool>(IncrementalGCTitle);
 			JsonHelper.SaveJsonObject($"{_config.OWMLPath}{Constants.OwmlConfigFileName}", _config);
 			Close();
 		}
@@ -50,6 +65,7 @@ protected override void OnReset()
 			_config.GamePath = _defaultConfig.GamePath;
 			_config.DebugMode = _defaultConfig.DebugMode;
 			_config.ForceExe = _defaultConfig.ForceExe;
+			_config.IncrementalGC = _defaultConfig.IncrementalGC;
 			UpdateUIValues();
 		}
 	}