Generated from f960aba

InscryptionModding · Aug 25, 2024 · 6d58c98 · 6d58c98
1 parent 9e034ad
commit 6d58c98
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 6 deletions.
diff --git a/api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html b/api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html
@@ -306,7 +306,9 @@ <h5 class="returns">Returns</h5>
   </table>
   <a id="InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_" data-uid="InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy*"></a>
   <h4 id="InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_DiskCardGame_ResourcesManager_System_Int32_" data-uid="InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager,System.Int32)">RemoveMaxEnergy(ResourcesManager, Int32)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Removes a given amount of energy cells, which determines how much energy a player has available at the start of a turn.
+Affected by &apos;ResourcesManager.preventNextEnergyLoss&apos;.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -325,11 +327,67 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><span class="xref">DiskCardGame.ResourcesManager</span></td>
         <td><span class="parametername">instance</span></td>
+        <td><p>The ResourcesManager Instance.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Int32</span></td>
+        <td><span class="parametername">amount</span></td>
+        <td><p>How many energy cells to close. Gets capped to the current number of open energy cells.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Collections.IEnumerator</span></td>
         <td></td>
       </tr>
+    </tbody>
+  </table>
+  <a id="InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_" data-uid="InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy*"></a>
+  <h4 id="InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_DiskCardGame_ResourcesManager_System_Int32_System_Boolean_" data-uid="InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager,System.Int32,System.Boolean)">RemoveMaxEnergy(ResourcesManager, Int32, Boolean)</h4>
+  <div class="markdown level1 summary"><p>A variant of RemoveMaxEnergy that can bypass ResourcesManager.PreventNextEnergyLoss.
+Affected by &apos;ResourcesManager.preventNextEnergyLoss&apos;.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public static IEnumerator RemoveMaxEnergy(this ResourcesManager instance, int amount, bool preventable)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">DiskCardGame.ResourcesManager</span></td>
+        <td><span class="parametername">instance</span></td>
+        <td><p>The ResourcesManager Instance.</p>
+</td>
+      </tr>
       <tr>
         <td><span class="xref">System.Int32</span></td>
         <td><span class="parametername">amount</span></td>
+        <td><p>How many energy cells to close. Gets capped to the current number of open energy cells.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Boolean</span></td>
+        <td><span class="parametername">preventable</span></td>
         <td></td>
       </tr>
     </tbody>

diff --git a/api/InscryptionAPI.Sound.html b/api/InscryptionAPI.Sound.html
@@ -73,7 +73,7 @@
 
   <h1 id="InscryptionAPI_Sound" data-uid="InscryptionAPI.Sound" class="text-break">Namespace InscryptionAPI.Sound
   </h1>
-  <div class="markdown level0 summary"><p>This namespace is dedicated to managing custom talking cards. Talking cards use an animated portrait rather than a static Sprite, and will speak using dialogue events.</p>
+  <div class="markdown level0 summary"><p>This namespace is dedicated to managing custom sound files, as well as custom tracks for the Gramophone in Act 1.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="markdown level0 remarks"></div>

diff --git a/index.json b/index.json
@@ -482,7 +482,7 @@
   "api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html": {
     "href": "api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html",
     "title": "Class ResourcesManagerHelpers | InscryptionAPI",
-    "keywords": "Class ResourcesManagerHelpers Inheritance System.Object ResourcesManagerHelpers Namespace : InscryptionAPI.Helpers Assembly : InscryptionAPI.dll Syntax public static class ResourcesManagerHelpers Methods GemCount(Boolean, GemType) Declaration public static int GemCount(bool playerGems, GemType gemToCheck) Parameters Type Name Description System.Boolean playerGems DiskCardGame.GemType gemToCheck Returns Type Description System.Int32 GemsOfType(ResourcesManager, GemType) Declaration public static int GemsOfType(this ResourcesManager instance, GemType gem) Parameters Type Name Description DiskCardGame.ResourcesManager instance DiskCardGame.GemType gem Returns Type Description System.Int32 OpponentHasGems(GemType[]) Declaration public static bool OpponentHasGems(params GemType[] gems) Parameters Type Name Description DiskCardGame.GemType [] gems Returns Type Description System.Boolean OwnerHasGems(Boolean, GemType[]) Declaration public static bool OwnerHasGems(bool playerGems, params GemType[] gems) Parameters Type Name Description System.Boolean playerGems DiskCardGame.GemType [] gems Returns Type Description System.Boolean PlayerHasGems(GemType[]) Declaration public static bool PlayerHasGems(params GemType[] gems) Parameters Type Name Description DiskCardGame.GemType [] gems Returns Type Description System.Boolean RemoveMaxEnergy(ResourcesManager, Int32) Declaration public static IEnumerator RemoveMaxEnergy(this ResourcesManager instance, int amount) Parameters Type Name Description DiskCardGame.ResourcesManager instance System.Int32 amount Returns Type Description System.Collections.IEnumerator ShowRemoveMaxEnergy(ResourcesManager, Int32) Declaration public static IEnumerator ShowRemoveMaxEnergy(this ResourcesManager instance, int amount) Parameters Type Name Description DiskCardGame.ResourcesManager instance System.Int32 amount Returns Type Description System.Collections.IEnumerator"
+    "keywords": "Class ResourcesManagerHelpers Inheritance System.Object ResourcesManagerHelpers Namespace : InscryptionAPI.Helpers Assembly : InscryptionAPI.dll Syntax public static class ResourcesManagerHelpers Methods GemCount(Boolean, GemType) Declaration public static int GemCount(bool playerGems, GemType gemToCheck) Parameters Type Name Description System.Boolean playerGems DiskCardGame.GemType gemToCheck Returns Type Description System.Int32 GemsOfType(ResourcesManager, GemType) Declaration public static int GemsOfType(this ResourcesManager instance, GemType gem) Parameters Type Name Description DiskCardGame.ResourcesManager instance DiskCardGame.GemType gem Returns Type Description System.Int32 OpponentHasGems(GemType[]) Declaration public static bool OpponentHasGems(params GemType[] gems) Parameters Type Name Description DiskCardGame.GemType [] gems Returns Type Description System.Boolean OwnerHasGems(Boolean, GemType[]) Declaration public static bool OwnerHasGems(bool playerGems, params GemType[] gems) Parameters Type Name Description System.Boolean playerGems DiskCardGame.GemType [] gems Returns Type Description System.Boolean PlayerHasGems(GemType[]) Declaration public static bool PlayerHasGems(params GemType[] gems) Parameters Type Name Description DiskCardGame.GemType [] gems Returns Type Description System.Boolean RemoveMaxEnergy(ResourcesManager, Int32) Removes a given amount of energy cells, which determines how much energy a player has available at the start of a turn. Affected by 'ResourcesManager.preventNextEnergyLoss'. Declaration public static IEnumerator RemoveMaxEnergy(this ResourcesManager instance, int amount) Parameters Type Name Description DiskCardGame.ResourcesManager instance The ResourcesManager Instance. System.Int32 amount How many energy cells to close. Gets capped to the current number of open energy cells. Returns Type Description System.Collections.IEnumerator RemoveMaxEnergy(ResourcesManager, Int32, Boolean) A variant of RemoveMaxEnergy that can bypass ResourcesManager.PreventNextEnergyLoss. Affected by 'ResourcesManager.preventNextEnergyLoss'. Declaration public static IEnumerator RemoveMaxEnergy(this ResourcesManager instance, int amount, bool preventable) Parameters Type Name Description DiskCardGame.ResourcesManager instance The ResourcesManager Instance. System.Int32 amount How many energy cells to close. Gets capped to the current number of open energy cells. System.Boolean preventable Returns Type Description System.Collections.IEnumerator ShowRemoveMaxEnergy(ResourcesManager, Int32) Declaration public static IEnumerator ShowRemoveMaxEnergy(this ResourcesManager instance, int amount) Parameters Type Name Description DiskCardGame.ResourcesManager instance System.Int32 amount Returns Type Description System.Collections.IEnumerator"
   },
   "api/InscryptionAPI.Helpers.TextureHelper.html": {
     "href": "api/InscryptionAPI.Helpers.TextureHelper.html",
@@ -877,7 +877,7 @@
   "api/InscryptionAPI.Sound.html": {
     "href": "api/InscryptionAPI.Sound.html",
     "title": "Namespace InscryptionAPI.Sound | InscryptionAPI",
-    "keywords": "Namespace InscryptionAPI.Sound This namespace is dedicated to managing custom talking cards. Talking cards use an animated portrait rather than a static Sprite, and will speak using dialogue events. Classes GramophoneManager A static class that contains helper methods for adding tracks to the Gramophone in Leshy's cabin. SoundManager A static class that contains helper methods for working with audio."
+    "keywords": "Namespace InscryptionAPI.Sound This namespace is dedicated to managing custom sound files, as well as custom tracks for the Gramophone in Act 1. Classes GramophoneManager A static class that contains helper methods for adding tracks to the Gramophone in Leshy's cabin. SoundManager A static class that contains helper methods for working with audio."
   },
   "api/InscryptionAPI.Sound.SoundManager.html": {
     "href": "api/InscryptionAPI.Sound.SoundManager.html",

diff --git a/manifest.json b/manifest.json
@@ -1177,7 +1177,7 @@
       "output": {
         ".html": {
           "relative_path": "api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html",
-          "hash": "l4Or0bvNooq6kk1noDlyRanJnocVGOOylQXMlWdxmTA="
+          "hash": "afJzj4XNtH+1hHOBIgwYfiwISZ7d5zHWZokdlGr+O3A="
         }
       },
       "is_incremental": false,
@@ -2137,7 +2137,7 @@
       "output": {
         ".html": {
           "relative_path": "api/InscryptionAPI.Sound.html",
-          "hash": "Uf1wB1xJNFjF3X33dF2/FRvSvx0l6C0xUcqWeQ5FydU="
+          "hash": "eyRuDhWWIsP3as5W6tCZ0CZVE1PrrciH0O/3uI8akaE="
         }
       },
       "is_incremental": false,

diff --git a/xrefmap.yml b/xrefmap.yml
@@ -11934,6 +11934,12 @@ references:
   commentId: M:InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager,System.Int32)
   fullName: InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager, System.Int32)
   nameWithType: ResourcesManagerHelpers.RemoveMaxEnergy(ResourcesManager, Int32)
+- uid: InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager,System.Int32,System.Boolean)
+  name: RemoveMaxEnergy(ResourcesManager, Int32, Boolean)
+  href: api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html#InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_DiskCardGame_ResourcesManager_System_Int32_System_Boolean_
+  commentId: M:InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager,System.Int32,System.Boolean)
+  fullName: InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy(DiskCardGame.ResourcesManager, System.Int32, System.Boolean)
+  nameWithType: ResourcesManagerHelpers.RemoveMaxEnergy(ResourcesManager, Int32, Boolean)
 - uid: InscryptionAPI.Helpers.ResourcesManagerHelpers.RemoveMaxEnergy*
   name: RemoveMaxEnergy
   href: api/InscryptionAPI.Helpers.ResourcesManagerHelpers.html#InscryptionAPI_Helpers_ResourcesManagerHelpers_RemoveMaxEnergy_