Cleanup and docs

Author: obvEve

SecretAPI.Examples/ExampleEntry.cs

@@ -13,7 +13,7 @@
     /// </summary>
     public class ExampleEntry : Plugin
     {
-        private Harmony? harmony;
+        private readonly Assembly assembly = typeof(ExampleEntry).Assembly;
 
         /// <inheritdoc/>
         public override string Name { get; } = "SecretAPI.Examples";
@@ -22,7 +22,7 @@ public class ExampleEntry : Plugin
         public override string Description { get; } = "An example plugin";
 
         /// <inheritdoc/>
-        public override string Author { get; } = "@misfiy";
+        public override string Author { get; } = "@misfiy / @obvEvelyn";
 
         /// <inheritdoc/>
         public override Version Version { get; } = typeof(SecretApi).Assembly.GetName().Version;
@@ -33,13 +33,7 @@ public class ExampleEntry : Plugin
         /// <inheritdoc/>
         public override void Enable()
         {
-            Assembly assembly = typeof(ExampleEntry).Assembly;
-
             CustomSetting.Register(new ExampleKeybindSetting(), new ExampleDropdownSetting());
-
-            harmony = new Harmony(nameof(ExampleEntry) + DateTime.Now.Ticks);
-            harmony.PatchAllNoCategory(assembly);
-            harmony.PatchCategory(nameof(ExampleEntry), assembly);
         }
 
         /// <inheritdoc/>

SecretAPI.Examples/Patches/ExamplePatch.cs

@@ -9,11 +9,14 @@
     /*[HarmonyPatch]*/
     public static class ExamplePatch
     {
+        // gets called before the original method is called
         private static bool Prefix()
         {
+            // prevent original method from running
             return false;
         }
 
+        // gets called after the original method is called
         private static void Postfix()
         {
         }

SecretAPI.Examples/SecretAPI.Examples.csproj

@@ -9,7 +9,7 @@
     <ItemGroup>
         <PackageReference Include="BepInEx.AssemblyPublicizer.MSBuild" Version="0.4.2" PrivateAssets="all" />
         <PackageReference Include="Lib.Harmony" Version="2.2.2" />
-        <PackageReference Include="Northwood.LabAPI" Version="1.1.1" IncludeAssets="All" PrivateAssets="All" />
+        <PackageReference Include="Northwood.LabAPI" Version="1.1.3" IncludeAssets="All" PrivateAssets="All" />
         <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" IncludeAssets="All" PrivateAssets="All" />
     </ItemGroup>
 

SecretAPI.Examples/Settings/ExampleDropdownSetting.cs

@@ -9,19 +9,19 @@
     /// </summary>
     public class ExampleDropdownSetting : CustomDropdownSetting
     {
-        private static string[] exampleOptions = ["hi", "test", "yum", "fish", "nugget"];
-        private static string[] exampleSupporterOptions = ["bucket", "lava", "wanted", "globe"];
+        private static readonly string[] ExampleOptions = ["hi", "test", "yum", "fish", "nugget"];
+        private static readonly string[] ExampleSupporterOptions = ["bucket", "lava", "wanted", "globe"];
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ExampleDropdownSetting"/> class.
         /// </summary>
         public ExampleDropdownSetting()
-            : base(901, "Example dropdown", exampleOptions)
+            : base(901, "Example dropdown", ExampleOptions)
         {
         }
 
         /// <inheritdoc/>
-        public override CustomHeader Header { get; } = CustomHeader.Examples;
+        public override CustomHeader Header => CustomHeader.Examples;
 
         /// <inheritdoc/>
         protected override CustomSetting CreateDuplicate() => new ExampleDropdownSetting();
@@ -32,7 +32,7 @@ protected override void PersonalizeSetting()
             if (KnownOwner == null || !KnownOwner.HasAnyPermission("example.supporter"))
                 return;
 
-            Options = exampleSupporterOptions;
+            Options = ExampleSupporterOptions;
         }
 
         /// <inheritdoc/>

SecretAPI.Examples/Settings/ExampleKeybindSetting.cs

@@ -17,7 +17,7 @@ public ExampleKeybindSetting()
         }
 
         /// <inheritdoc />
-        public override CustomHeader Header { get; } = CustomHeader.Examples;
+        public override CustomHeader Header => CustomHeader.Examples;
 
         /// <inheritdoc />
         protected override CustomSetting CreateDuplicate() => new ExampleKeybindSetting();

SecretAPI/Features/IRegister.cs

@@ -20,7 +20,7 @@ public interface IRegister
         public void TryRegister();
 
         /// <summary>
-        /// Attemps to unregister the object.
+        /// Attempts to unregister the object.
         /// </summary>
         public void TryUnregister()
         {

SecretAPI/Features/UserSettings/CustomDropdownSetting.cs

@@ -41,10 +41,16 @@ protected CustomDropdownSetting(
         /// <inheritdoc/>
         public new SSDropdownSetting Base { get; }
 
+        /// <summary>
+        /// Gets the index the client is claiming to have selected.
+        /// </summary>
+        /// <remarks>This is not validated, if you need it validated use <see cref="ValidatedSelectedIndex"/>.</remarks>
+        public int SyncedIndex => Base.SyncSelectionIndexRaw;
+
         /// <summary>
         /// Gets the selected index after validation.
         /// </summary>
-        public int ValidatedSelectedIndex => Math.Clamp(Base.SyncSelectionIndexRaw, 0, Options.Length - 1);
+        public int ValidatedSelectedIndex => Math.Clamp(SyncedIndex, 0, Options.Length - 1);
 
         /// <summary>
         /// Gets or sets the options.

SecretAPI/Features/UserSettings/CustomPlainTextSetting.cs

@@ -1,6 +1,5 @@
 namespace SecretAPI.Features.UserSettings
 {
-    using System;
     using global::UserSettings.ServerSpecific;
     using TMPro;
 

SecretAPI/Features/UserSettings/CustomSetting.cs

@@ -300,14 +300,12 @@ private static void OnSettingsUpdated(ReferenceHub hub, ServerSpecificSettingBas
             if (setting == null || !setting.CanView(player))
                 return;
 
+            // validate setting existence and then write data from client
             CustomSetting newSettingPlayer = EnsurePlayerSpecificSetting(player, setting);
-
-            // NetworkWriter entryWriter = new();
-            // settingBase.SerializeEntry(entryWriter);
-            // newSettingPlayer.Base.DeserializeEntry(new NetworkReader(entryWriter.buffer));
             NetworkWriterPooled valueWriter = NetworkWriterPool.Get();
             settingBase.SerializeValue(valueWriter);
             newSettingPlayer.Base.DeserializeValue(new NetworkReader(valueWriter.buffer));
+
             NetworkWriterPool.Return(valueWriter);
 
             newSettingPlayer.HandleSettingUpdate();

SecretAPI/Features/UserSettings/CustomSliderSetting.cs

@@ -1,6 +1,5 @@
 namespace SecretAPI.Features.UserSettings
 {
-    using System;
     using global::UserSettings.ServerSpecific;
 
     /// <summary>