Skip to content

Implement Quick Stack hook #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SignatureBeef merged 3 commits into from
Jan 28, 2026
Merged

Implement Quick Stack hook #157

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
932a295
Implement Quick Stack hook for
Arthri Jan 28, 2026
215bc34
Fix references
Arthri Jan 28, 2026
234a9a0
Fix hook
Arthri Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 119 additions & 1 deletion OTAPI.Scripts/Patches/HookChestQuickStack.Server.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ You should have received a copy of the GNU General Public License
using MonoMod;
using MonoMod.Cil;
using System;
using System.Collections.Generic;
using System.Linq;
using Terraria;
using Terraria.GameContent;
using Terraria.ID;

/// <summary>
/// @doc Creates Hooks.Chest.QuickStack.
Expand All @@ -39,7 +43,121 @@ partial class ChestHooks
static void HookChestQuickStack(ModFwModder modder)
{
#if TerrariaServer_1450_OrAbove || Terraria__1450_OrAbove || tModLoader_1450_OrAbove
Console.WriteLine("[TODO] reimplement HookChestQuickStack for 1.4.5+");
{
// DO NOT use GetILCursor(). The instruction body does not have jumps transformed into labels,
// a process which is required to happen for the edits below to work.
var ctx = new ILContext(modder.GetMethodDefinition(() => QuickStacking.BuildDestinationMetricsAndStackItems(default, default, default)));

// Hooks onto quick stacking into existing slot
ctx.Invoke((ctx) =>
{
var csr = new ILCursor(ctx);

ILLabel endLabel = null!;
csr.GotoNext(
MoveType.After,
i => i.MatchLdarg(1),
i => i.MatchLdcI4(1),
i => i.MatchStfld(typeof(QuickStacking.DestinationHelper), nameof(QuickStacking.DestinationHelper.transferBlocked)),
i => i.MatchBr(out endLabel)
);
// AfterLabel is not the same as After + MoveAfterLabels for some reason
csr.MoveAfterLabels();

// Load player ID (source.slots[0].Player.whoAmI)
// source
csr.Emit(OpCodes.Ldarg_0);
// ^.slots
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(QuickStacking.SourceInventory).slots));
// ^[0]
csr.Emit(OpCodes.Ldc_I4_0);
csr.Emit(OpCodes.Ldelem_Any, modder.GetDefinition<PlayerItemSlotID.SlotReference>());
// ^.Player
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(PlayerItemSlotID.SlotReference).Player));
// ^.whoAmI
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(Player)!.whoAmI));

// Load item
// NOTE: this is very fragile, but I can't think of a way to write it better without significantly bloating the code
csr.Emit(OpCodes.Ldloc_S, (byte)3);

// Load chest index
csr.Emit(OpCodes.Ldarg_S, (byte)1);
// ^.ChestIndex (property get)
csr.Emit(OpCodes.Callvirt, modder.GetDefinition<QuickStacking.DestinationHelper>().Properties.Single(p => p.Name == "ChestIndex")!.GetMethod);

// Call hook
csr.Emit(OpCodes.Call, modder.GetMethodDefinition(() => OTAPI.Hooks.Chest.InvokeQuickStack(default, default!, default)));

// Continue if handled
csr.Emit(OpCodes.Brfalse, endLabel);
});
}
{
// used for the out parameter only
List<int> _blockedChests;

// DO NOT use GetILCursor(). The instruction body does not have jumps transformed into labels,
// a process which is required to happen for the edits below to work.
var ctx = new ILContext(modder.GetMethodDefinition(() => QuickStacking.Transfer(default, default, out _blockedChests, default)));

// Hooks onto quick stacking overflowing into a new stack
ctx.Invoke((ctx) =>
{
var csr = new ILCursor(ctx);
int count = 0;

while (csr.TryGotoNext(
MoveType.Before,
i => i.MatchLdarg(0),
i => i.MatchLdloc(out _),
i => i.MatchCall(typeof(QuickStacking), nameof(QuickStacking.Consolidate))
))
{
if (++count > 2)
{
throw new Exception($"More than two matches of {nameof(QuickStacking.Consolidate)}.");
}

// Both targets are preceded by a jump instruction exiting the loop
var endInstruction = csr.Prev.Operand;

csr.MoveAfterLabels();

// Load player ID (source.slots[0].Player.whoAmI)
// source
csr.Emit(OpCodes.Ldarg_0);
// ^.slots
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(QuickStacking.SourceInventory).slots));
// ^[0]
csr.Emit(OpCodes.Ldc_I4_0);
csr.Emit(OpCodes.Ldelem_Any, modder.GetDefinition<PlayerItemSlotID.SlotReference>());
// ^.Player
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(PlayerItemSlotID.SlotReference).Player));
// ^.whoAmI
csr.Emit(OpCodes.Ldfld, modder.GetFieldDefinition(() => default(Player)!.whoAmI));

// Load item
// NOTE: this is very fragile, but I can't think of a way to write it better without significantly bloating the code
csr.Emit(OpCodes.Ldloc_S, (byte)(count == 1 ? 6 : 9));

// Load chest index
// NOTE: this is very fragile, but I can't think of a way to write it better without significantly bloating the code
csr.Emit(OpCodes.Ldloc_S, (byte)(count == 1 ? 7 : 10));
// ^.ChestIndex (property get)
csr.Emit(OpCodes.Callvirt, modder.GetDefinition<QuickStacking.DestinationHelper>().Properties.Single(p => p.Name == "ChestIndex")!.GetMethod);

// Call hook
csr.Emit(OpCodes.Call, modder.GetMethodDefinition(() => OTAPI.Hooks.Chest.InvokeQuickStack(default, default!, default)));

// Continue if handled
csr.Emit(OpCodes.Brfalse, endInstruction);

// Move after Consolidate call
csr.Goto(csr.Index + 3);
}
});
}
#else
var csr = modder.GetILCursor(() => Terraria.Chest.PutItemInNearbyChest(null, default));
PutItemInNearbyChest = csr.Method;
Expand Down
Loading