Merge pull request #1 from EmberSL/main

pull

Author: moddedmcplayer

AdvancedHints.sln

@@ -1,16 +1,28 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AdvancedHints", "AdvancedHints\AdvancedHints.csproj", "{410CB435-091A-4141-92C9-8EEC16CD1DDA}"
+# Visual Studio Version 17
+VisualStudioVersion = 17.11.35431.28
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AdvancedHints", "AdvancedHints\AdvancedHints.csproj", "{410CB435-091A-4141-92C9-8EEC16CD1DDA}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
+		Debug|x64 = Debug|x64
 		Release|Any CPU = Release|Any CPU
+		Release|x64 = Release|x64
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Debug|x64.ActiveCfg = Debug|x64
+		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Debug|x64.Build.0 = Debug|x64
 		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Release|Any CPU.Build.0 = Release|Any CPU
+		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Release|x64.ActiveCfg = Release|x64
+		{410CB435-091A-4141-92C9-8EEC16CD1DDA}.Release|x64.Build.0 = Release|x64
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
 	EndGlobalSection
 EndGlobal

AdvancedHints/AdvancedHints.csproj

@@ -10,20 +10,34 @@
     <CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <LangVersion>9</LangVersion>
+    <Platforms>AnyCPU;x64</Platforms>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="EXILED" Version="8.0.0" />
+    <PackageReference Include="ExMod.Exiled" Version="9.2.2" />
     <PackageReference Include="Lib.Harmony" Version="2.2.2" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
   </ItemGroup>
 
   <ItemGroup>
-    <Reference Include="Assembly-CSharp" HintPath="$(EXILED_References)\Assembly-CSharp-Publicized.dll" Private="false" />
-    <Reference Include="Assembly-CSharp-firstpass" HintPath="$(EXILED_References)\Assembly-CSharp-firstpass.dll" Private="false" />
+    <Reference Include="Assembly-CSharp">
+      <HintPath>$(EXILED_REFERENCES)\Assembly-CSharp-Publicized.dll</HintPath>
+    </Reference>
+    <Reference Include="Assembly-CSharp-firstpass">
+      <HintPath>$(EXILED_REFERENCES)\Assembly-CSharp-firstpass.dll</HintPath>
+    </Reference>
     <Reference Include="CommandSystem.Core" HintPath="$(EXILED_References)\CommandSystem.Core.dll" Private="false" />
     <Reference Include="Mirror" HintPath="$(EXILED_References)\Mirror.dll" Private="false" />
     <Reference Include="NorthwoodLib" HintPath="$(EXILED_References)\NorthwoodLib.dll" Private="false" />
+    <Reference Include="UnityEngine">
+      <HintPath>$(EXILED_REFERENCES)\UnityEngine.dll</HintPath>
+    </Reference>
+    <Reference Include="UnityEngine.AnimationModule">
+      <HintPath>$(EXILED_REFERENCES)\UnityEngine.AnimationModule.dll</HintPath>
+    </Reference>
+    <Reference Include="UnityEngine.AssetBundleModule">
+      <HintPath>$(EXILED_REFERENCES)\UnityEngine.AssetBundleModule.dll</HintPath>
+    </Reference>
     <Reference Include="UnityEngine.CoreModule" HintPath="$(EXILED_References)\UnityEngine.CoreModule.dll" Private="false" />
     <Reference Include="UnityEngine.AudioModule" HintPath="$(EXILED_References)\UnityEngine.AudioModule.dll" Private="false" />
     <Reference Include="UnityEngine.PhysicsModule" HintPath="$(EXILED_References)\UnityEngine.PhysicsModule.dll" Private="false" />

AdvancedHints/Components/HudManager.cs

@@ -9,12 +9,10 @@ namespace AdvancedHints.Components
 {
     using System;
     using System.Collections.Generic;
-    using System.IO;
     using System.Linq;
     using AdvancedHints.Enums;
     using AdvancedHints.Models;
     using Exiled.API.Features;
-    using Hints;
     using UnityEngine;
 
     /// <summary>
@@ -67,6 +65,11 @@ public HudManager()
                 [DisplayLocation.Bottom] = new HudDisplay(),
             };
 
+        /// <summary>
+        /// Gets or sets a value indicating whether debug mode is enabled.
+        /// </summary>
+        public bool Debug { get; set; } = false;
+
         /// <summary>
         /// Displays a hint to a player.
         /// </summary>
@@ -122,7 +125,11 @@ private void UpdateHints()
             toFormat = Displays.Values.Select(display => FormatStringForHud(
                 display.Content ?? display.DefaultText, Plugin.Singleton.Config.LinesPerPosition))
                 .ToArray<object>();
-            hint = string.Format(Plugin.Singleton.Config.HudTemplate, toFormat);
+
+            string newHint = string.Format(Plugin.Singleton.Config.HudTemplate, toFormat);
+            if (Debug && newHint != hint)
+                player.SendConsoleMessage(newHint, "white");
+            hint = newHint;
 
             player.ShowHint(Plugin.HintPrefix + hint, Plugin.Singleton.Config.HintDuration);
         }

AdvancedHints/DebugCommand.cs

@@ -0,0 +1,39 @@
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+#pragma warning disable SA1600 // Elements should be documented
+#pragma warning disable SA1516 // Elements should be separated by blank line
+
+namespace AdvancedHints
+{
+    using System;
+    using AdvancedHints.Components;
+    using CommandSystem;
+    using Exiled.API.Features;
+    using RemoteAdmin;
+
+    [CommandHandler(typeof(ClientCommandHandler))]
+    public class DebugCommand : ICommand
+    {
+        public bool Execute(ArraySegment<string> arguments, ICommandSender sender, out string response)
+        {
+            if (Player.TryGet(sender, out Player ply))
+            {
+                if (!HudManager.Instances.TryGetValue(ply, out HudManager hudManager))
+                {
+                    response = "You do not have a HudManager instance.";
+                    return false;
+                }
+
+                hudManager.Debug = !hudManager.Debug;
+                response = $"Debug mode {(hudManager.Debug ? "enabled" : "disabled")} (check client console).";
+                return true;
+            }
+
+            response = "You must be a player to use this command.";
+            return false;
+        }
+
+        public string Command { get; } = "toggleadvhdebug";
+        public string[] Aliases { get; } = { "tahd" };
+        public string Description { get; } = "Toggles debug mode for AdvancedHints.";
+    }
+}

AdvancedHints/Models/HudDisplay.cs

@@ -20,7 +20,7 @@ namespace AdvancedHints.Models
     public class HudDisplay
     {
         /// <summary>
-        /// Gets or sets a <see cref="Func"/> that returns the default text to be displayed.
+        /// Gets or sets a Func that returns the default text to be displayed.
         /// May or may not override the one from the Config.
         /// </summary>
         [CanBeNull]