Update docs

gurrenm3 · Dec 13, 2023 · cf2fb67 · cf2fb67
1 parent 69a0b36
commit cf2fb67
Show file tree

Hide file tree

Showing 28 changed files with 1,070 additions and 21 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -77,7 +77,7 @@ jobs:
 
 
       - name: Upload Mod DLL
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         with:
           # Artifact name
           name: ${{ env.PROJECT_NAME }}.dll

diff --git a/BloonsTD6 Mod Helper/Api/Helpers/MapHelper.cs b/BloonsTD6 Mod Helper/Api/Helpers/MapHelper.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Il2CppAssets.Scripts.Models.Map;
 using Il2CppAssets.Scripts.Models.Map.Spawners;
 using UnityEngine;
@@ -10,6 +11,7 @@ namespace BTD_Mod_Helper.Api.Helpers;
 /// <summary>
 /// Contains helper methods for working with maps and custom maps.
 /// </summary>
+[Obsolete]
 public class MapHelper
 {
     private static readonly Random rand = new();
@@ -92,7 +94,7 @@ public static PathSpawnerModel CreateSpawner(PathModel[] paths)
         for (var i = 0; i < paths.Length; i++)
             pathNames[i] = paths[i].pathId;
 
-        return new PathSpawnerModel("", new SplitterModel("", pathNames), new SplitterModel("", pathNames));
+        return new PathSpawnerModel("", new SplitterModel("", pathNames, ""), new SplitterModel("", pathNames, ""));
     }
 
     internal static Texture2D ResizeForGame(Texture2D texture2D) =>

diff --git a/BloonsTD6 Mod Helper/UI/Menus/ModsMenu.cs b/BloonsTD6 Mod Helper/UI/Menus/ModsMenu.cs
@@ -98,7 +98,7 @@ public override bool OnMenuOpened(Object data)
         var panel = panelTransform.gameObject;
         panel.DestroyAllChildren();
 
-        var modsMenu = panel.AddModHelperPanel(new Info("ModsMenu", MenuWidth, MenuHeight));
+        var modsMenu = panel.AddModHelperPanel(new Info("ModsMenu", 0, 100, MenuWidth, MenuHeight));
 
         CreateLeftMenu(modsMenu);
         CreateRightMenu(modsMenu);

diff --git a/Documentation/BTD_Mod_Helper.Api.Display.ModDisplay.md b/Documentation/BTD_Mod_Helper.Api.Display.ModDisplay.md
@@ -227,6 +227,27 @@ public virtual void Apply(TowerModel towerModel);
 
 `towerModel` [Il2CppAssets.Scripts.Models.Towers.TowerModel](https://docs.microsoft.com/en-us/dotnet/api/Il2CppAssets.Scripts.Models.Towers.TowerModel 'Il2CppAssets.Scripts.Models.Towers.TowerModel')
 
+<a name='BTD_Mod_Helper.Api.Display.ModDisplay.GetBloonDisplay(string)'></a>
+
+## ModDisplay.GetBloonDisplay(string) Method
+
+Gets the Display for a given bloon
+
+```csharp
+protected string GetBloonDisplay(string bloon);
+```
+#### Parameters
+
+<a name='BTD_Mod_Helper.Api.Display.ModDisplay.GetBloonDisplay(string).bloon'></a>
+
+`bloon` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The bloon base id
+
+#### Returns
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
+The display GUID
+
 <a name='BTD_Mod_Helper.Api.Display.ModDisplay.GetDisplay(string,int,int,int)'></a>
 
 ## ModDisplay.GetDisplay(string, int, int, int) Method

diff --git a/Documentation/BTD_Mod_Helper.Api.Display.ModTowerDisplay.md b/Documentation/BTD_Mod_Helper.Api.Display.ModTowerDisplay.md
@@ -105,7 +105,7 @@ public virtual void ApplyToTower(TowerModel towerModel);
 If the tower tiers make it count as a Paragon
 
 ```csharp
-protected bool IsParagon(int[] tiers);
+protected bool IsParagon(params int[] tiers);
 ```
 #### Parameters
 
@@ -142,7 +142,7 @@ The UnityDisplayNode
 Returns true if this display should be used by its Tower for the given tiers
 
 ```csharp
-public abstract bool UseForTower(int[] tiers);
+public abstract bool UseForTower(params int[] tiers);
 ```
 #### Parameters