Add XML to all classes in the Card folder, add GainMultipleGems ability class

InscryptionAPI/Ascension/AscensionChallengePaginator.cs

@@ -6,11 +6,18 @@
 using UnityEngine;
 
 namespace InscryptionAPI.Ascension;
+/// <summary>
+/// Class that handles adding displaying custom challenges and allows for multiple pages of challenges.
+/// </summary>
+public class AscensionChallengePaginator : MonoBehaviour {
+    // not sure if this will break any mods but it's not being used or assigned to.
+    //public bool initialized;
 
-public class AscensionChallengePaginator : MonoBehaviour
-{
-    public bool initialized;
-
+    /// <summary>
+    /// Initialises the challenge screen, adding custom challenges and UI elements.
+    /// </summary>
+    /// <param name="screen">The <see cref="AscensionChallengeScreen"/> to attach this paginator to.</param>
+    /// <param name="transition">The default transition object to use.</param>
     public void Initialize(AscensionChallengeScreen screen, AscensionMenuScreenTransition transition = null)
     {
         if (challengeObjectsForPages == null)
@@ -39,6 +46,10 @@ public void Initialize(AscensionChallengeScreen screen, AscensionMenuScreenTrans
 
         this.screen = screen;
     }
+    /// <summary>
+    /// Creates the <see cref="AscensionChallengeInfo"/> for the placeholder challenge.
+    /// This placeholder is used when errors occur when loading challenges.
+    /// </summary>
     public void InitialiseMissingChallengeInfo()
     {
         missingChallengeInfo = ScriptableObject.CreateInstance<AscensionChallengeInfo>();
@@ -51,6 +62,11 @@ public void InitialiseMissingChallengeInfo()
         missingChallengeInfo.pointValue = 0;
     }
 
+    /// <summary>
+    /// Adds a new page of challenges to the list of pages.
+    /// Pages contain (by default) up to 14 challenge icons. Excess challenges overflow onto new pages.
+    /// </summary>
+    /// <param name="challengeInfos"><see cref="AscensionChallengeInfo"/>s that will be displayed on this page.</param>
     public void AddPage(List<AscensionChallengeInfo> challengeInfos)
     {
         // create the challenge info for missingChallengeInfo challenges
@@ -165,6 +181,9 @@ private GameObject CreateIconGameObject(GameObject objectRef, int index, Ascensi
 
         return newIcon;
     }
+    /// <summary>
+    /// Initialise the challenge screen and pages whenever the challenge screen is enabled.
+    /// </summary>
     public void OnEnable()
     {
         // if there are still active challenges, don't rebuild the pages
@@ -291,6 +310,13 @@ public void OnEnable()
         InstantiateArrowObjects(icons);
     }
 
+    /// <summary>
+    /// Creates the <c>leftArrow</c> and <c>rightArrow</c> UI elements for the challenge screen.
+    /// Positioning is determined by the positions of the challenge icons.
+    /// By default, the API tries to place the arrows on the left and right sides of the screen.
+    /// If there isn't enough space due to screen resolution (or if the user has toggled the config option), the arrows are placed at the top of the screen instead.
+    /// </summary>
+    /// <param name="icons"></param>
     public void InstantiateArrowObjects(List<AscensionIconInteractable> icons)
     {
         Vector3 topRight = new(float.MinValue, float.MinValue);
@@ -343,6 +369,9 @@ public void InstantiateArrowObjects(List<AscensionIconInteractable> icons)
         rightArrow.ClearDelegates();
         rightArrow.CursorSelectStarted += (x) => NextPage();
     }
+    /// <summary>
+    /// Loads the next page. Wraps around to the first page if currently on the last page.
+    /// </summary>
     public void NextPage()
     {
         pageIndex++;
@@ -351,6 +380,9 @@ public void NextPage()
 
         LoadPage(pageIndex);
     }
+    /// <summary>
+    /// Loads the previous page. Wraps around to the last page if currently on the first page.
+    /// </summary>
     public void PreviousPage()
     {
         pageIndex--;
@@ -359,7 +391,10 @@ public void PreviousPage()
 
         LoadPage(pageIndex);
     }
-
+    /// <summary>
+    /// Loads the challenge page at the given index.
+    /// </summary>
+    /// <param name="page">Index of the page to load.</param>
     public void LoadPage(int page)
     {
         // if page index corresponds to an index in challengeObjects
@@ -463,17 +498,41 @@ private char DebugArrayCode(GameObject icon, AscensionChallengeInfo info = null)
     /// </summary>
     public List<List<GameObject>> challengeObjectsForPages;
 
+    /// <summary>
+    /// The current page index. Determines what challenges are currently displayed.
+    /// </summary>
     public int pageIndex;
+    /// <summary>
+    /// How many icons are displayed on each page.
+    /// </summary>
     public int pageLength;
 
+    /// <summary>
+    /// Object that handles displaying challenges.
+    /// </summary>
     public AscensionChallengeScreen screen;
 
+    /// <summary>
+    /// Object that handles the transition to and from the menu screens.
+    /// </summary>
     public AscensionMenuScreenTransition transition;
 
+    /// <summary>
+    /// The UI interactable for moving to the previous page.
+    /// </summary>
     public AscensionMenuInteractable leftArrow;
+    /// <summary>
+    /// The UI interactable for moving to the next page.
+    /// </summary>
     public AscensionMenuInteractable rightArrow;
 
+    /// <summary>
+    /// <see cref="Sprite"/> for the placeholder challenge that appears in empty slots or when an error occurs.
+    /// </summary>
     public static Sprite missingChallengeSprite;
+    /// <summary>
+    /// <see cref="AscensionChallengeInfo"/> for the placeholder challenge that appears in empty slots or when an error occurs.
+    /// </summary>
     public static AscensionChallengeInfo missingChallengeInfo;
 
     private class NoneChallengeDisplayer : MonoBehaviour

InscryptionAPI/Ascension/AscensionChallengePaginatorSetupifier.cs

@@ -3,8 +3,14 @@
 namespace InscryptionAPI.Ascension;
 
 // adding this comment to say that setupifier is a ridiculous word, very fun
+/// <summary>
+/// Handles adding the <see cref="AscensionChallengePaginator"/> to the ascension menu object.
+/// </summary>
 public class AscensionChallengePaginatorSetupifier : ManagedBehaviour
 {
+    /// <summary>
+    /// Adds the <see cref="AscensionChallengePaginator"/> to the ascension menu object.
+    /// </summary>
     public void Start()
     {
         AscensionMenuScreenTransition screen = gameObject.GetComponent<AscensionMenuScreenTransition>();