Merge branch 'upcoming' into upcoming-nuget-release

SignatureBeef · SignatureBeef · commit 19de186fd9de · 2025-01-05T22:37:22.000+10:00
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "dotnet-ilverify": {
-      "version": "5.0.0",
+      "version": "9.0.0",
       "commands": [
         "ilverify"
       ]
diff --git a/OTAPI.Patcher/Common.cs b/OTAPI.Patcher/Common.cs
@@ -23,6 +23,7 @@ You should have received a copy of the GNU General Public License
 using System.Linq;
 using System.Net.Http;
 using System.Reflection;
+using System.Threading.Tasks;
 
 namespace OTAPI.Patcher;
 
@@ -59,7 +60,7 @@ public static void Log(string message)
         return null;
     }
 
-    public static string DownloadZip(string url)
+    public static async Task<string> DownloadZipAsync(string url)
     {
         Console.WriteLine($"Downloading {url}");
         var uri = new Uri(url);
@@ -71,7 +72,7 @@ public static string DownloadZip(string url)
             if (!File.Exists(savePath))
             {
                 using var client = new HttpClient();
-                var data = client.GetByteArrayAsync(url).Result;
+                var data = await client.GetByteArrayAsync(url);
                 File.WriteAllBytes(savePath, data);
             }
 
diff --git a/OTAPI.Patcher/OTAPI.Patcher.csproj b/OTAPI.Patcher/OTAPI.Patcher.csproj
@@ -3,7 +3,7 @@
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
 		<TargetFramework>net9.0</TargetFramework>
-		<Version>3.2.3</Version>
+		<Version>3.2.4</Version>
 		<PreserveCompilationContext>true</PreserveCompilationContext>
 		<RuntimeIdentifiers>win;osx;linux;</RuntimeIdentifiers>
 		<Nullable>enable</Nullable>
diff --git a/OTAPI.Patcher/Program.cs b/OTAPI.Patcher/Program.cs
@@ -17,14 +17,16 @@ You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
+using System.Threading.Tasks;
+
 namespace OTAPI.Patcher;
 
 [MonoMod.MonoModIgnore]
 static class Program
 {
-    static void Main(string[] args)
+    static async Task Main(string[] args)
     {
         var target = Targets.PatchTargets.DeterminePatchTarget();
-        target.Patch();
+        await target.PatchAsync();
     }
 }
diff --git a/OTAPI.Patcher/Targets/IPatchTarget.cs b/OTAPI.Patcher/Targets/IPatchTarget.cs
@@ -25,6 +25,7 @@ You should have received a copy of the GNU General Public License
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Threading.Tasks;
 using static ModFramework.ModContext;
 
 namespace OTAPI.Patcher.Targets;
@@ -34,7 +35,7 @@ public interface IPatchTarget
 {
     string DisplayText { get; }
     string InstallDestination { get; }
-    void Patch();
+    Task PatchAsync();
 }
 
 [MonoMod.MonoModIgnore]
diff --git a/OTAPI.Patcher/Targets/PCClientTarget.cs b/OTAPI.Patcher/Targets/PCClientTarget.cs
@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Runtime.Loader;
+using System.Threading.Tasks;
 using static ModFramework.ModContext;
 
 namespace OTAPI.Patcher.Targets;
@@ -158,7 +159,7 @@ void CopyRequiredLibs(ClientInstallPath<IInstallDiscoverer> discoverer)
         }
     }
 
-    public void Patch()
+    public Task PatchAsync()
     {
         Console.WriteLine($"Open Terraria API v{Common.GetVersion()}");
 
@@ -316,6 +317,7 @@ public void Patch()
         InstallModules();
 
         SetStatus("Patching has completed.");
+        return Task.CompletedTask;
     }
 
     void CompileModules(string otapiexe)
diff --git a/OTAPI.Patcher/Targets/PCServerTarget.cs b/OTAPI.Patcher/Targets/PCServerTarget.cs
@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Runtime.Loader;
+using System.Threading.Tasks;
 using static ModFramework.ModContext;
 
 namespace OTAPI.Patcher.Targets;
@@ -38,10 +39,10 @@ public virtual string GetEmbeddedResourcesDirectory(string fileinput)
         return Path.Combine(ModContext.BaseDirectory, Path.GetDirectoryName(fileinput));
     }
 
-    public virtual string DownloadServer()
+    public virtual async Task<string> DownloadServerAsync()
     {
         var zipUrl = this.GetZipUrl();
-        var zipPath = Common.DownloadZip(zipUrl);
+        var zipPath = await Common.DownloadZipAsync(zipUrl);
         var extracted = Common.ExtractZip(zipPath);
 
         return FileResolver.DetermineInputAssembly(extracted);
@@ -77,7 +78,7 @@ public virtual void LoadModifications()
         ModContext.PluginLoader.AddFromFolder(Path.Combine(ModContext.BaseDirectory, "modifications"));
     }
 
-    public void Patch()
+    public async Task PatchAsync()
     {
         Console.WriteLine($"Open Terraria API v{Common.GetVersion()}");
 
@@ -86,7 +87,7 @@ public void Patch()
         {
             Common.AddMarkdownFormatter();
 
-            var vanillaDllPath = DownloadServer();
+            var vanillaDllPath = await DownloadServerAsync();
             var vanillaName = Path.GetFileNameWithoutExtension(vanillaDllPath);
 
             Console.WriteLine("[OTAPI] Extracting embedded binaries and packing into one binary...");
@@ -210,12 +211,15 @@ public void Patch()
                             mm.Module.GetType("Terraria.NPC").CreateHooks(mm);
                             mm.Module.GetType("Terraria.WorldGen").CreateHooks(mm);
                             mm.Module.GetType("Terraria.Chat.ChatHelper").CreateHooks(mm);
+                            mm.Module.GetType("Terraria.GameContent.ItemDropRules.CommonCode").CreateHooks(mm);
                             mm.Module.GetType("Terraria.IO.WorldFile").CreateHooks(mm);
                             mm.Module.GetType("Terraria.Net.NetManager").CreateHooks(mm);
                             mm.Module.GetType("Terraria.Projectile").CreateHooks(mm);
                             mm.Module.GetType("Terraria.RemoteClient").CreateHooks(mm);
                             mm.Module.GetType("Terraria.Liquid").CreateHooks(mm);
                             mm.Module.GetType("Terraria.Program").CreateHooks(mm);
+                            mm.Module.GetType("Terraria.Wiring").CreateHooks(mm);
+                            mm.Module.GetType("Terraria.GameContent.PressurePlateHelper").CreateHooks(mm);
                             Console.WriteLine("Done");
                         }
                         else if (modType == ModType.Write)
diff --git a/OTAPI.Scripts/Mods/HookNpcBossBag.Server.cs b/OTAPI.Scripts/Mods/HookNpcBossBag.Server.cs
@@ -1,5 +1,5 @@
 ﻿/*
-Copyright (C) 2020 DeathCradle
+Copyright (C) 2020-2024 SignatureBeef & sors89
 
 This file is part of Open Terraria API v3 (OTAPI)
 
@@ -26,46 +26,52 @@ You should have received a copy of the GNU General Public License
 using Mono.Cecil.Cil;
 
 /// <summary>
-/// @doc Creates Hooks.NPC.BossBag. Allows plugins to cancel boss bag items.
+/// @doc Creates Hooks.NPC.BossBag. Allows plugins to customize boss loot as well as the distribution.
 /// </summary>
-[Modification(ModType.PreMerge, "Hooking npc boss bags")]
+[Modification(ModType.PreMerge, "Hooking NPC Boss Bag drops")]
 [MonoMod.MonoModIgnore]
 void HookNpcBossBag(ModFramework.ModFwModder modder)
 {
     // replace NewItem calls, and handle the -1 result to cancel the method from actioning.
-
-    var csr = modder.GetILCursor(() => (new Terraria.NPC()).DropItemInstanced(default, default, 0, 0, false));
-    var callback = csr.Module.ImportReference(
+    foreach (var csr in new[] {
+         modder.GetILCursor(() => (new Terraria.NPC()).DropItemInstanced(default, default, 0, 0, false)),
+         modder.GetILCursor(() => Terraria.GameContent.ItemDropRules.CommonCode.DropItemLocalPerClientAndSetNPCMoneyTo0(default, default, default, default))
+    })
+    {
+        var callback = csr.Module.ImportReference(
 #if TerrariaServer_EntitySourcesActive || Terraria_EntitySourcesActive || tModLoader_EntitySourcesActive
-        modder.GetMethodDefinition(() => OTAPI.Hooks.NPC.InvokeBossBag(null, 0, 0, 0, 0, 0, 0, false, 0, false, false, null))
+            modder.GetMethodDefinition(() => OTAPI.Hooks.NPC.InvokeBossBag(null, 0, 0, 0, 0, 0, 0, false, 0, false, false, null))
 #else
-        modder.GetMethodDefinition(() => OTAPI.Hooks.NPC.InvokeBossBag(0, 0, 0, 0, 0, 0, false, 0, false, false, null))
+            modder.GetMethodDefinition(() => OTAPI.Hooks.NPC.InvokeBossBag(0, 0, 0, 0, 0, 0, false, 0, false, false, null))
 #endif
-    );
+        );
 
-    var instructions = csr.Body.Instructions.Where(x => x.OpCode == OpCodes.Call
-                                                        && x.Operand is MethodReference mref && mref.Name == "NewItem"
-                                                        && x.Next.OpCode == OpCodes.Stloc_0);
+        var instructions = csr.Body.Instructions.Where(x => x.OpCode == OpCodes.Call
+                                                            && x.Operand is MethodReference mref && mref.Name == "NewItem"
+                                                            && x.Next.OpCode == OpCodes.Stloc_0);
 
-    if (instructions.Count() != 1) throw new NotSupportedException("Only one server NewItem call expected in DropBossBags.");
+        if (instructions.Count() != 1) throw new NotSupportedException("Only one server NewItem call expected in DropBossBags.");
 
-    var ins = instructions.First();
+        var ins = instructions.First();
 
-    ins.Operand = callback;
+        ins.Operand = callback;
 
-    csr.Goto(ins);
-    csr.EmitAll(
-        new { OpCodes.Ldarg_0 }
-    );
+        csr.Goto(ins);
+        csr.EmitAll(
+             // reference to the npc works for both the instance, and the static method, only since the latter has the 
+             // variable first in the argument list.
+            new { OpCodes.Ldarg_0 }
+        );
 
-    csr.Goto(ins.Next.Next);
-    csr.EmitAll(
-        new { OpCodes.Ldloc_0 },
-        new { OpCodes.Ldc_I4_M1 },
-        new { OpCodes.Ceq },
-        new { OpCodes.Brfalse_S, Operand = ins.Next.Next },
-        new { OpCodes.Ret }
-    );
+        csr.Goto(ins.Next.Next);
+        csr.EmitAll(
+            new { OpCodes.Ldloc_0 },
+            new { OpCodes.Ldc_I4_M1 },
+            new { OpCodes.Ceq },
+            new { OpCodes.Brfalse_S, Operand = ins.Next.Next },
+            new { OpCodes.Ret }
+        );
+    }
 }
 
 namespace OTAPI
@@ -142,4 +148,4 @@ Terraria.NPC npc
             }
         }
     }
-}
+}
diff --git a/examples/RuntimeExample.Client/RuntimeExample.Client.csproj b/examples/RuntimeExample.Client/RuntimeExample.Client.csproj
@@ -25,6 +25,6 @@
 		</Reference>
 	</ItemGroup>
 	<ItemGroup>
-		<PackageReference Include="ImGui.NET" Version="1.78.0" />
+		<PackageReference Include="ImGui.NET" Version="1.91.0.1" />
 	</ItemGroup>
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"isRoot": true,`
`4`	`4`	`"tools": {`
`5`	`5`	`"dotnet-ilverify": {`
`6`		`- "version": "5.0.0",`
	`6`	`+ "version": "9.0.0",`
`7`	`7`	`"commands": [`
`8`	`8`	`"ilverify"`
`9`	`9`	`]`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ You should have received a copy of the GNU General Public License`
`23`	`23`	`using System.Linq;`
`24`	`24`	`using System.Net.Http;`
`25`	`25`	`using System.Reflection;`
	`26`	`+using System.Threading.Tasks;`
`26`	`27`
`27`	`28`	`namespace OTAPI.Patcher;`
`28`	`29`
`@@ -59,7 +60,7 @@ public static void Log(string message)`
`59`	`60`	`return null;`
`60`	`61`	`}`
`61`	`62`
`62`		`- public static string DownloadZip(string url)`
	`63`	`+ public static async Task<string> DownloadZipAsync(string url)`
`63`	`64`	`{`
`64`	`65`	`Console.WriteLine($"Downloading {url}");`
`65`	`66`	`var uri = new Uri(url);`
`@@ -71,7 +72,7 @@ public static string DownloadZip(string url)`
`71`	`72`	`if (!File.Exists(savePath))`
`72`	`73`	`{`
`73`	`74`	`using var client = new HttpClient();`
`74`		`- var data = client.GetByteArrayAsync(url).Result;`
	`75`	`+ var data = await client.GetByteArrayAsync(url);`
`75`	`76`	`File.WriteAllBytes(savePath, data);`
`76`	`77`	`}`
`77`	`78`
Original file line number	Diff line number	Diff line change
`@@ -17,14 +17,16 @@ You should have received a copy of the GNU General Public License`
`17`	`17`	`along with this program. If not, see <http://www.gnu.org/licenses/>.`
`18`	`18`	`*/`
`19`	`19`
	`20`	`+using System.Threading.Tasks;`
	`21`	`+`
`20`	`22`	`namespace OTAPI.Patcher;`
`21`	`23`
`22`	`24`	`[MonoMod.MonoModIgnore]`
`23`	`25`	`static class Program`
`24`	`26`	`{`
`25`		`- static void Main(string[] args)`
	`27`	`+ static async Task Main(string[] args)`
`26`	`28`	`{`
`27`	`29`	`var target = Targets.PatchTargets.DeterminePatchTarget();`
`28`		`- target.Patch();`
	`30`	`+ await target.PatchAsync();`
`29`	`31`	`}`
`30`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ You should have received a copy of the GNU General Public License`
`25`	`25`	`using System.Collections.Generic;`
`26`	`26`	`using System.IO;`
`27`	`27`	`using System.Linq;`
	`28`	`+using System.Threading.Tasks;`
`28`	`29`	`using static ModFramework.ModContext;`
`29`	`30`
`30`	`31`	`namespace OTAPI.Patcher.Targets;`
`@@ -34,7 +35,7 @@ public interface IPatchTarget`
`34`	`35`	`{`
`35`	`36`	`string DisplayText { get; }`
`36`	`37`	`string InstallDestination { get; }`
`37`		`- void Patch();`
	`38`	`+ Task PatchAsync();`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`[MonoMod.MonoModIgnore]`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`using System.Linq;`
`9`	`9`	`using System.Reflection;`
`10`	`10`	`using System.Runtime.Loader;`
	`11`	`+using System.Threading.Tasks;`
`11`	`12`	`using static ModFramework.ModContext;`
`12`	`13`
`13`	`14`	`namespace OTAPI.Patcher.Targets;`
`@@ -158,7 +159,7 @@ void CopyRequiredLibs(ClientInstallPath<IInstallDiscoverer> discoverer)`
`158`	`159`	`}`
`159`	`160`	`}`
`160`	`161`
`161`		`- public void Patch()`
	`162`	`+ public Task PatchAsync()`
`162`	`163`	`{`
`163`	`164`	`Console.WriteLine($"Open Terraria API v{Common.GetVersion()}");`
`164`	`165`
`@@ -316,6 +317,7 @@ public void Patch()`
`316`	`317`	`InstallModules();`
`317`	`318`
`318`	`319`	`SetStatus("Patching has completed.");`
	`320`	`+ return Task.CompletedTask;`
`319`	`321`	`}`
`320`	`322`
`321`	`323`	`void CompileModules(string otapiexe)`