Add XML Docs to the Community Patch Sequencers Module

Author: Chaosyr

InscryptionCommunityPatch/Sequencers/BuyPeltsSmallTags.cs

@@ -4,6 +4,9 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
+/// <summary>
+/// Patches in Smaller Price tags and a moved Price tag when either the <see cref="PatchPlugin.configDisplaySmallerPriceTags"/> and <see cref="PatchPlugin.configDisplayPriceTagsOnTheRight"/> are true respectively.
+/// </summary>
 [HarmonyPatch]
 internal class BuyPeltsSmallTags
 {

InscryptionCommunityPatch/Sequencers/CardCostChoiceNodePatch.cs

@@ -5,6 +5,9 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
+/// <summary>
+/// Patches in Our Cost Card Backs into the <see cref="CardSingleChoicesSequencer.GetCardbackTexture"/> function for Energy and Mox costs.
+/// </summary>
 [HarmonyPatch]
 internal static class ChoiceNodePatch
 {
@@ -21,5 +24,11 @@ private static void CardSingleChoicesSequencer_GetCardbackTexture(ref Texture __
                 break;
         }
     }
-    public static string MoxTextureName(int index) => "moxCost" + (index switch { 1 => "Green", 2 => "Orange", 3 => "Blue", _ => "" }) + ".png";
+    
+    /// <summary>
+    /// Handles getting the correct Mox Texture Name for usage in the <see cref="CardSingleChoicesSequencer_GetCardbackTexture"/> patch.
+    /// </summary>
+    /// <param name="index">1 -> <c>Green</c>, 2 -> <c>Orange</c>, 3 -> <c>Blue</c>, otherwise -> <c>Empty</c></param>
+    /// <returns>A string texture name in the form of <c>moxCost{Color}.png</c></returns>
+    private static string MoxTextureName(int index) => "moxCost" + (index switch { 1 => "Green", 2 => "Orange", 3 => "Blue", _ => "" }) + ".png";
 }

InscryptionCommunityPatch/Sequencers/CardStatBoostSequencerPatch.cs

@@ -7,6 +7,9 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
+/// <summary>
+/// This patches in a conditional check as to whether or not the card has Boostable Stats or not.
+/// </summary>
 [HarmonyPatch]
 internal class CardStatBoostSequencerPatch
 {

InscryptionCommunityPatch/Sequencers/LeshyResetRedEyes.cs

@@ -4,6 +4,10 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
+/// <summary>
+/// This patch applies when <see cref="InscryptionCommunityPatch.PatchPlugin.configResetEyesToNormalAfter8BearsFights"/> is set to true.
+/// When set to true after the boss has been beat, it resets their eyes back to normal rather than remaining red.
+/// </summary>
 [HarmonyPatch]
 internal class LeshyResetRedEyes
 {

InscryptionCommunityPatch/Sequencers/PackRatNodeBackgroundFix.cs

@@ -4,7 +4,9 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
-// 'fixes' the pack rat card not being rare
+/// <summary>
+/// Corrects the Pack Rat Card to be a Rare Card.
+/// </summary>
 [HarmonyPatch]
 internal class PackRatNodeBackgroundFix
 {

InscryptionCommunityPatch/Sequencers/TradeableTalkingCardFix.cs

@@ -6,9 +6,19 @@
 
 namespace InscryptionCommunityPatch.Sequencers;
 
+/// <summary>
+/// This patch fixes Tradable Talking Card related Issues.
+/// </summary>
 [HarmonyPatch]
 public class TradeableTalkingCardFix
 {
+    /// <summary>
+    /// Patches the <see cref="TradeCardsForPelts.OnTradableSelected"/> to allow for better handling regarding the Trade of Talking Cards.
+    /// </summary>
+    /// <param name="__instance">The Class Instance associated with the function e.g. <see cref="TradeCardsForPelts"/>.</param>
+    /// <param name="slot">The slot the card was found in.</param>
+    /// <param name="card">The card being traded for.</param>
+    /// <returns>This only returns our patched variant if the card is a talking card, otherwise it uses vanilla handling.</returns>
     [HarmonyPrefix, HarmonyPatch(typeof(TradeCardsForPelts), nameof(TradeCardsForPelts.OnTradableSelected))]
     private static bool OnTalkingCardSelected(TradeCardsForPelts __instance, HighlightedInteractable slot, PlayableCard card)
     {
@@ -42,6 +52,11 @@ private static bool OnTalkingCardSelected(TradeCardsForPelts __instance, Highlig
         return false;
     }
 
+    /// <summary>
+    /// Handles the View associated with a trade specific to Talking Cards.
+    /// </summary>
+    /// <param name="card">The card in which is being given to the player.</param>
+    /// <returns>The card added to hand, then a switch back to the trading pool.</returns>
     public static IEnumerator TradeForTalkingCard(PlayableCard card)
     {
         yield return Singleton<PlayerHand>.Instance.AddCardToHand(CardSpawner.SpawnPlayableCard(card.Info), new Vector3(0f, 0.5f, -3f), 0f);