Refactor inventory handling and transaction structure.

Avanatiker · Avanatiker · commit cc8408a5edfe · 2025-01-01T23:30:37.000+01:00
Replaced `InventoryTransfer` with `TransactionExecutor` for improved naming and functionality. Renamed `InventoryTransferTask` to `SlotTransfer` and updated method calls accordingly. Introduced `QuickCraftTransaction` and `TransferSelection` for expanded transaction capabilities and added error handling in `InventoryChanges`.
diff --git a/common/src/main/java/com/lambda/mixin/entity/ClientPlayInteractionManagerMixin.java b/common/src/main/java/com/lambda/mixin/entity/ClientPlayInteractionManagerMixin.java
@@ -66,9 +66,11 @@ public void interactItemHead(PlayerEntity player, Hand hand, CallbackInfoReturna
         }
     }
 
-    @Inject(method = "attackBlock", at = @At("HEAD"))
+    @Inject(method = "attackBlock", at = @At("HEAD"), cancellable = true)
     public void onAttackBlock(BlockPos pos, Direction side, CallbackInfoReturnable<Boolean> cir) {
-        if (EventFlow.post(new PlayerEvent.Attack.Block(pos, side)).isCanceled()) cir.cancel();
+        if (EventFlow.post(new PlayerEvent.Attack.Block(pos, side)).isCanceled()) {
+            cir.setReturnValue(false);
+        }
     }
 
     @Inject(method = "attackEntity", at = @At("HEAD"), cancellable = true)
diff --git a/common/src/main/kotlin/com/lambda/interaction/construction/result/BreakResult.kt b/common/src/main/kotlin/com/lambda/interaction/construction/result/BreakResult.kt
@@ -110,7 +110,7 @@ sealed class BreakResult : BuildResult() {
                 ?: selectStack {
                     isItem(badItem).not()
                 }.transfer(MainHandContainer)
-                ?: MaterialContainer.Nothing()
+                ?: MaterialContainer.Nothing("Couldn't find a tool for ${blockState.block.name.string} with $badItem in main hand.")
 
         override fun SafeContext.buildRenderer() {
             withPos(blockPos, color)
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/container/containers/ChestContainer.kt b/common/src/main/kotlin/com/lambda/interaction/material/container/containers/ChestContainer.kt
@@ -18,8 +18,8 @@
 package com.lambda.interaction.material.container.containers
 
 import com.lambda.interaction.material.StackSelection
-import com.lambda.interaction.material.transfer.InventoryTransferTask.Companion.deposit
-import com.lambda.interaction.material.transfer.InventoryTransferTask.Companion.withdraw
+import com.lambda.interaction.material.transfer.SlotTransfer.Companion.deposit
+import com.lambda.interaction.material.transfer.SlotTransfer.Companion.withdraw
 import com.lambda.interaction.material.container.MaterialContainer
 import com.lambda.task.tasks.OpenContainer
 import com.lambda.util.Communication.info
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/container/containers/HotbarContainer.kt b/common/src/main/kotlin/com/lambda/interaction/material/container/containers/HotbarContainer.kt
@@ -21,7 +21,7 @@ import com.lambda.Lambda.mc
 import com.lambda.context.SafeContext
 import com.lambda.interaction.material.ContainerTask
 import com.lambda.interaction.material.StackSelection
-import com.lambda.interaction.material.transfer.InventoryTransferTask.Companion.deposit
+import com.lambda.interaction.material.transfer.SlotTransfer.Companion.deposit
 import com.lambda.interaction.material.container.MaterialContainer
 import com.lambda.util.player.SlotUtils.hotbar
 import com.lambda.util.text.buildText
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/container/containers/MainHandContainer.kt b/common/src/main/kotlin/com/lambda/interaction/material/container/containers/MainHandContainer.kt
@@ -20,7 +20,7 @@ package com.lambda.interaction.material.container.containers
 import com.lambda.Lambda.mc
 import com.lambda.context.SafeContext
 import com.lambda.interaction.material.ContainerTask
-import com.lambda.interaction.material.transfer.InventoryTransfer.Companion.transfer
+import com.lambda.interaction.material.transfer.TransactionExecutor.Companion.transfer
 import com.lambda.interaction.material.StackSelection
 import com.lambda.interaction.material.container.MaterialContainer
 import com.lambda.util.item.ItemStackUtils.equal
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/container/containers/ShulkerBoxContainer.kt b/common/src/main/kotlin/com/lambda/interaction/material/container/containers/ShulkerBoxContainer.kt
@@ -21,8 +21,8 @@ import com.lambda.context.SafeContext
 import com.lambda.interaction.material.StackSelection
 import com.lambda.task.Task
 import com.lambda.task.tasks.BuildTask.Companion.breakAndCollectBlock
-import com.lambda.interaction.material.transfer.InventoryTransferTask.Companion.deposit
-import com.lambda.interaction.material.transfer.InventoryTransferTask.Companion.withdraw
+import com.lambda.interaction.material.transfer.SlotTransfer.Companion.deposit
+import com.lambda.interaction.material.transfer.SlotTransfer.Companion.withdraw
 import com.lambda.interaction.material.container.MaterialContainer
 import com.lambda.task.tasks.OpenContainer
 import com.lambda.task.tasks.PlaceContainer
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/InventoryChanges.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/InventoryChanges.kt
@@ -1,25 +1,41 @@
 package com.lambda.interaction.material.transfer
 
-import com.lambda.context.SafeContext
 import com.lambda.interaction.material.StackSelection
+import com.lambda.util.item.ItemStackUtils.equal
 import net.minecraft.item.ItemStack
 import net.minecraft.screen.slot.Slot
 
+/**
+ * A class representing changes in an inventory's state over time. It acts as a tracker for
+ * detecting, storing, and merging differences between the original and updated states of
+ * inventory slots. This class extends a map-like structure, where the key is the slot index
+ * and the value is a list of pairs representing the original and updated states of an inventory slot.
+ *
+ * Example:
+ * ```
+ * #0: 64 obsidian -> 0 air, 0 air -> 64 obsidian
+ * #36: 12 observer -> 11 observer
+ * ```
+ * - Where `#0` is the slot id, first it was emptied and then got `64 obsidian` again
+ * - Where `#36` is the slot id, that was reduced by `1 observer`
+ *
+ * @property slots A list of `Slot` objects representing the current inventory slots being tracked.
+ * Defaults to an empty list.
+ */
 class InventoryChanges(
-    ctx: SafeContext
+    private var slots: List<Slot>,
 ) : MutableMap<Int, MutableList<Pair<ItemStack, ItemStack>>> by HashMap() {
-
-    private var slots = ctx.player.currentScreenHandler.slots
-    private val originalStacks = slots.map { it.stack.copy() } // Snapshot of the initial state
+    private val originalStacks = slots.map { it.stack.copy() }
 
     /**
      * Detect and store changes directly in the map.
      */
     fun detectChanges() {
+        require(slots.isNotEmpty()) { "Cannot detect changes on an empty slots list" }
         slots.forEachIndexed { index, slot ->
             val originalStack = originalStacks[index]
             val updatedStack = slot.stack
-            if (!ItemStack.areEqual(originalStack, updatedStack)) {
+            if (!originalStack.equal(updatedStack)) {
                 getOrPut(index) { mutableListOf() }.add(originalStack to updatedStack.copy())
             }
         }
@@ -32,12 +48,23 @@ class InventoryChanges(
      * @return A new `InventoryChanges` instance containing merged entries.
      */
     infix fun merge(other: InventoryChanges) {
+        require(slots.isNotEmpty()) { "Cannot merge changes to an empty slots list" }
         other.forEach { (key, value) ->
             getOrPut(key) { mutableListOf() }.addAll(value)
         }
     }
 
+    /**
+     * Evaluates if the current inventory changes fulfill the given selection requirement.
+     *
+     * @param to A list of `Slot` objects to evaluate for the selection criteria.
+     * @param selection A `StackSelection` object that specifies the selection criteria, including the
+     *                  target items and their required count.
+     * @return `true` if the total count of matching items across the filtered slots meets or exceeds
+     *         the required count specified in the `StackSelection`; `false` otherwise.
+     */
     fun fulfillsSelection(to: List<Slot>, selection: StackSelection): Boolean {
+        require(slots.isNotEmpty()) { "Cannot evaluate selection on an empty slots list" }
         val targetSlots = selection.filterSlots(to).map { it.id }
         return filter { it.key in targetSlots }.entries.sumOf { (_, changes) ->
             changes.lastOrNull()?.second?.count ?: 0
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/InventoryTransaction.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/InventoryTransaction.kt
@@ -22,19 +22,16 @@ import com.lambda.task.Task
 import com.lambda.threading.runSafe
 
 abstract class InventoryTransaction : Task<InventoryChanges>() {
-    private var changes: InventoryChanges? = null
+    private lateinit var changes: InventoryChanges
 
     override fun SafeContext.onStart() {
-        changes = InventoryChanges(this)
+        changes = InventoryChanges(player.currentScreenHandler.slots)
     }
 
     fun finish() {
         runSafe {
-            changes?.let {
-                it.detectChanges()
-                success(it)
-            }
+            changes.detectChanges()
+            success(changes)
         } ?: failure("Failed to finish transaction")
     }
-
 }
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/SlotTransfer.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/SlotTransfer.kt
@@ -23,15 +23,15 @@ import com.lambda.context.SafeContext
 import com.lambda.event.events.TickEvent
 import com.lambda.event.listener.SafeListener.Companion.listen
 import com.lambda.interaction.material.StackSelection
-import com.lambda.interaction.material.transfer.InventoryTransfer.Companion.transfer
+import com.lambda.interaction.material.transfer.TransactionExecutor.Companion.transfer
 import com.lambda.module.modules.client.TaskFlowModule
 import com.lambda.task.Task
 import com.lambda.util.extension.containerSlots
 import com.lambda.util.extension.inventorySlots
 import net.minecraft.screen.ScreenHandler
 import net.minecraft.screen.slot.Slot
 
-class InventoryTransferTask @Ta5kBuilder constructor(
+class SlotTransfer @Ta5kBuilder constructor(
     val screen: ScreenHandler,
     private val selection: StackSelection,
     val from: List<Slot>,
@@ -41,25 +41,25 @@ class InventoryTransferTask @Ta5kBuilder constructor(
 ) : Task<Unit>() {
     private var selectedFrom = selection.filterSlots(from)
     private var selectedTo = to.filter { it.stack.isEmpty } // + to.filter { it.stack.item.block in TaskFlowModule.disposables }
-    private val screenName = runCatching { screen.type::class.simpleName }.getOrNull() ?: screen::class.simpleName
     override val name: String
-        get() = "Moving $selection from [${selectedFrom.joinToString { "${it.id}" }}] to [${selectedTo.joinToString { "${it.id}" }}] in $screenName"
+        get() = "Moving $selection from slots [${selectedFrom.joinToString { "${it.id}" }}] to slots [${selectedTo.joinToString { "${it.id}" }}] in ${screen::class.simpleName}"
 
     private var delay = 0
-    private var changes: InventoryChanges? = null
+    private lateinit var changes: InventoryChanges
 
     override fun SafeContext.onStart() {
-        changes = InventoryChanges(this)
+        changes = InventoryChanges(player.currentScreenHandler.slots)
     }
 
     init {
         listen<TickEvent.Pre> {
-            if (player.currentScreenHandler != screen) {
-                failure("Screen has changed")
+            val current = player.currentScreenHandler
+            if (current != screen) {
+                failure("Screen has changed. Expected ${screen::class.simpleName} (revision ${screen.revision}, got ${current::class.simpleName} (revision ${current.revision})")
                 return@listen
             }
 
-            if (changes?.fulfillsSelection(to, selection) == true) {
+            if (changes.fulfillsSelection(to, selection)) {
                 if (closeScreen) player.closeHandledScreen()
                 success()
                 return@listen
@@ -79,8 +79,8 @@ class InventoryTransferTask @Ta5kBuilder constructor(
             transfer {
                 moveSlot(nextFrom.id, nextTo.id)
             }.finally { change ->
-                changes?.merge(change)
-            }.execute(this@InventoryTransferTask)
+                changes merge change
+            }.execute(this@SlotTransfer)
 
 //            if (transfer.fulfillsSelection(selection)) {
 //                info("Transfer complete")
@@ -99,7 +99,7 @@ class InventoryTransferTask @Ta5kBuilder constructor(
             from: List<Slot>,
             to: List<Slot>,
             closeScreen: Boolean = true
-        ) = InventoryTransferTask(screen, selection, from, to, closeScreen)
+        ) = SlotTransfer(screen, selection, from, to, closeScreen)
 
         @Ta5kBuilder
         fun withdraw(screen: ScreenHandler, selection: StackSelection, closeScreen: Boolean = true) =
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/TransactionExecutor.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/TransactionExecutor.kt
@@ -24,34 +24,33 @@ import com.lambda.interaction.material.transfer.transaction.*
 import com.lambda.task.Task
 import net.minecraft.screen.slot.SlotActionType
 
-class InventoryTransfer @Ta5kBuilder constructor() : Task<InventoryChanges>() {
-    override val name: String get() = "Inventory Transfer" 
+class TransactionExecutor @Ta5kBuilder constructor(
+    private val transactions: MutableList<InventoryTransaction> = mutableListOf()
+) : Task<InventoryChanges>() {
+    override val name: String get() = "Execution of ${transactions.size} transactions left"
 
-    @DslMarker
-    annotation class InvTransfer
-
-    private var transactions = mutableListOf<InventoryTransaction>()
-    private var changes: InventoryChanges? = null
+    private lateinit var changes: InventoryChanges
 
     override fun SafeContext.onStart() {
-        changes = InventoryChanges(this)
+        changes = InventoryChanges(player.currentScreenHandler.slots)
     }
 
     init {
         listen<TickEvent.Pre> {
             if (transactions.isEmpty()) {
-                changes?.let {
-                    success(it)
-                }
+                success(changes)
                 return@listen
             }
 
             transactions.removeFirstOrNull()?.finally { change ->
-                changes?.merge(change)
-            }?.execute(this@InventoryTransfer)
+                changes merge change
+            }?.execute(this@TransactionExecutor)
         }
     }
 
+    @DslMarker
+    annotation class InvTransfer
+
     @InvTransfer
     fun click(slotId: Int, button: Int, actionType: SlotActionType) {
         transactions.add(ClickSlotTransaction(slotId, button, actionType))
@@ -132,8 +131,8 @@ class InventoryTransfer @Ta5kBuilder constructor() : Task<InventoryChanges>() {
 
     companion object {
         @InvTransfer
-        fun transfer(block: InventoryTransfer.() -> Unit) =
-            InventoryTransfer().apply {
+        fun transfer(block: TransactionExecutor.() -> Unit) =
+            TransactionExecutor().apply {
                 block(this)
             }
     }
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/TransferSelection.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/TransferSelection.kt
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2025 Lambda
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.lambda.interaction.material.transfer
+
+class TransferSelection {
+}
diff --git a/common/src/main/kotlin/com/lambda/interaction/material/transfer/transaction/QuickCraftTransaction.kt b/common/src/main/kotlin/com/lambda/interaction/material/transfer/transaction/QuickCraftTransaction.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2025 Lambda
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.lambda.interaction.material.transfer.transaction
+
+import com.lambda.interaction.material.transfer.InventoryTransaction
+
+class QuickCraftTransaction @Ta5kBuilder constructor(
+    private val slots: List<Int>,
+    private val mode: Mode = Mode.SINGLE
+) : InventoryTransaction() {
+    override val name: String get() = "Drag and drop ${slots.size} slots"
+
+    enum class Mode {
+        SINGLE, SPLIT
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,11 @@ public void interactItemHead(PlayerEntity player, Hand hand, CallbackInfoReturna`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`
`69`		`- @Inject(method = "attackBlock", at = @At("HEAD"))`
	`69`	`+ @Inject(method = "attackBlock", at = @At("HEAD"), cancellable = true)`
`70`	`70`	`public void onAttackBlock(BlockPos pos, Direction side, CallbackInfoReturnable<Boolean> cir) {`
`71`		`- if (EventFlow.post(new PlayerEvent.Attack.Block(pos, side)).isCanceled()) cir.cancel();`
	`71`	`+ if (EventFlow.post(new PlayerEvent.Attack.Block(pos, side)).isCanceled()) {`
	`72`	`+ cir.setReturnValue(false);`
	`73`	`+ }`
`72`	`74`	`}`
`73`	`75`
`74`	`76`	`@Inject(method = "attackEntity", at = @At("HEAD"), cancellable = true)`