Refactor BE interaction methods (#4702)

Author: gustovafing

docs/content/Modpacks/Changes/v8.0.0.md

@@ -145,4 +145,5 @@ A large number of machine feature interfaces have been removed, and have had the
 - `BlastingRecipeBuilder`, `CampfireRecipeBuilder`, `SmeltingRecipeBuilder` and `SmokingRecipeBuilder` have been merged into `SimpleCookingRecipeBuilder`
     - Example usage: `SimpleCookingRecipeBuilder.campfireCooking("cooking_chicken").input(new ItemStack(Items.CHICKEN)).output(new ItemStacks(Items.COOKED_CHICKEN)).cookingTime(100).experience(100).save(provider);`
 - `GTFluidImpl` has been merged into `GTFluid`, use `GTFluid.Flowing` and `GTFluid.Source` instead of `GTFluidImpl.Flowing` and `GTFluidImpl.Source`.
-- Item behaviors have been moved to `common/item/behavior`, and some items have been moved from `api/item` to `common/item`
+- Item behaviors have been moved to `common/item/behavior`, and some items have been moved from `api/item` to `common/item`.
+- Methods for processing machine interactions have changed, and all now take a single `ExtendedUseOnContext` argument.

src/main/java/com/gregtechceu/gtceu/api/block/MetaMachineBlock.java

@@ -11,6 +11,7 @@
 import com.gregtechceu.gtceu.api.sync_system.ManagedSyncBlockEntity;
 import com.gregtechceu.gtceu.common.data.GTItems;
 import com.gregtechceu.gtceu.common.machine.owner.MachineOwner;
+import com.gregtechceu.gtceu.utils.ExtendedUseOnContext;
 import com.gregtechceu.gtceu.utils.GTUtil;
 
 import net.minecraft.MethodsReturnNonnullByDefault;
@@ -273,7 +274,13 @@ public InteractionResult use(BlockState state, Level world, BlockPos pos, Player
             machine.setOwnerUUID(sPlayer.getUUID());
         }
 
-        InteractionResult machineInteractResult = machine.onUse(state, world, pos, player, hand, hit);
+        InteractionResult machineInteractResult;
+        if (itemStack.isEmpty()) {
+            machineInteractResult = machine.onUse(new ExtendedUseOnContext(player, hand, hit));
+        } else {
+            machineInteractResult = machine.onUseWithItem(new ExtendedUseOnContext(player, hand, hit));
+        }
+
         if (machineInteractResult != InteractionResult.PASS) return machineInteractResult;
 
         if (itemStack.is(GTItems.PORTABLE_SCANNER.get())) {

src/main/java/com/gregtechceu/gtceu/api/block/PipeBlock.java

@@ -21,6 +21,7 @@
 import com.gregtechceu.gtceu.common.item.behavior.CoverPlaceBehavior;
 import com.gregtechceu.gtceu.config.ConfigHolder;
 import com.gregtechceu.gtceu.data.recipe.VanillaRecipeHelper;
+import com.gregtechceu.gtceu.utils.ExtendedUseOnContext;
 import com.gregtechceu.gtceu.utils.GTMath;
 import com.gregtechceu.gtceu.utils.GTUtil;
 
@@ -352,8 +353,8 @@ public InteractionResult use(BlockState state, Level level, BlockPos pos, Player
         }
 
         Set<GTToolType> types = ToolHelper.getToolTypes(itemStack);
-        if ((!types.isEmpty() && ToolHelper.canUse(itemStack)) || (types.isEmpty() && player.isShiftKeyDown())) {
-            var result = pipeBlockEntity.onToolClick(types, itemStack, new UseOnContext(player, hand, hit));
+        if ((!types.isEmpty() && ToolHelper.canUse(itemStack))) {
+            var result = pipeBlockEntity.onToolClick(new ExtendedUseOnContext(player, hand, hit));
             if (result.getSecond() == InteractionResult.CONSUME && player instanceof ServerPlayer serverPlayer) {
                 ToolHelper.playToolSound(result.getFirst(), serverPlayer);
 

src/main/java/com/gregtechceu/gtceu/api/blockentity/PipeBlockEntity.java

@@ -2,8 +2,6 @@
 
 import com.gregtechceu.gtceu.api.GTValues;
 import com.gregtechceu.gtceu.api.block.MaterialPipeBlock;
-import com.gregtechceu.gtceu.api.capability.ICoverable;
-import com.gregtechceu.gtceu.api.capability.IToolable;
 import com.gregtechceu.gtceu.api.cover.CoverBehavior;
 import com.gregtechceu.gtceu.api.data.chemical.material.Material;
 import com.gregtechceu.gtceu.api.data.tag.TagPrefix;
@@ -18,6 +16,7 @@
 import com.gregtechceu.gtceu.api.sync_system.annotations.SyncToClient;
 import com.gregtechceu.gtceu.common.data.GTMaterialBlocks;
 import com.gregtechceu.gtceu.common.data.GTMaterials;
+import com.gregtechceu.gtceu.utils.ExtendedUseOnContext;
 import com.gregtechceu.gtceu.utils.GTUtil;
 
 import com.lowdragmc.lowdraglib.gui.texture.ResourceTexture;
@@ -32,13 +31,11 @@
 import net.minecraft.world.InteractionResult;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
-import net.minecraft.world.item.context.UseOnContext;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.block.Block;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
-import net.minecraft.world.phys.BlockHitResult;
 
 import com.mojang.datafixers.util.Pair;
 import lombok.Getter;
@@ -55,7 +52,7 @@
 @MethodsReturnNonnullByDefault
 public abstract class PipeBlockEntity<PipeType extends Enum<PipeType> & IPipeType<NodeDataType>, NodeDataType>
                                      extends ManagedSyncBlockEntity
-                                     implements IPipeNode<PipeType, NodeDataType>, IToolGridHighlight, IToolable,
+                                     implements IPipeNode<PipeType, NodeDataType>, IToolGridHighlight,
                                      ICopyable {
 
     private final long offset = GTValues.RNG.nextInt(20);
@@ -350,56 +347,41 @@ public ResourceTexture getPipeTexture(boolean isBlock) {
         return null;
     }
 
-    @Override
-    public Pair<@Nullable GTToolType, InteractionResult> onToolClick(Set<GTToolType> toolTypes, ItemStack itemStack,
-                                                                     UseOnContext context) {
+    public Pair<@Nullable GTToolType, InteractionResult> onToolClick(ExtendedUseOnContext context) {
         // the side hit from the machine grid
-        var playerIn = context.getPlayer();
-        if (playerIn == null) return Pair.of(null, InteractionResult.PASS);
-
-        var hand = context.getHand();
-        var hitResult = new BlockHitResult(context.getClickLocation(), context.getClickedFace(),
-                context.getClickedPos(), false);
-        Direction gridSide = ICoverable.determineGridSideHit(hitResult);
-        CoverBehavior coverBehavior = gridSide == null ? null : coverContainer.getCoverAtSide(gridSide);
-        if (gridSide == null) gridSide = hitResult.getDirection();
-
-        // Prioritize covers where they apply (Screwdriver, Soft Mallet)
-        if (toolTypes.isEmpty() && playerIn.isShiftKeyDown()) {
-            if (coverBehavior != null) {
-                return Pair.of(null, coverBehavior.onScrewdriverClick(playerIn, hand, hitResult));
+        var player = context.getPlayer();
+        var toolType = context.getToolType();
+        var gridSide = context.getGridSide();
+
+        if (player == null) return Pair.of(null, InteractionResult.PASS);
+
+        // Prioritize covers
+        var cover = getCoverContainer().getCoverAtSide(context.getClickedFace());
+        if (cover != null) {
+            var result = cover.onToolClick(context);
+            if (result.getSecond() != InteractionResult.PASS) return result;
+
+            if (toolType.contains(GTToolType.CROWBAR) && !isRemote()) {
+                getCoverContainer().removeCover(context.getGridSide(), player);
+                return Pair.of(GTToolType.CROWBAR, InteractionResult.SUCCESS);
             }
         }
-        if (toolTypes.contains(GTToolType.SCREWDRIVER)) {
-            if (coverBehavior != null) {
-                return Pair.of(GTToolType.SCREWDRIVER, coverBehavior.onScrewdriverClick(playerIn, hand, hitResult));
-            }
-        } else if (toolTypes.contains(GTToolType.SOFT_MALLET)) {
-            if (coverBehavior != null) {
-                return Pair.of(GTToolType.SOFT_MALLET, coverBehavior.onSoftMalletClick(playerIn, hand, hitResult));
-            }
-        } else if (toolTypes.contains(getPipeTuneTool())) {
-            if (playerIn.isShiftKeyDown() && this.canHaveBlockedFaces()) {
+
+        if (toolType.contains(getPipeTuneTool())) {
+            if (player.isShiftKeyDown() && this.canHaveBlockedFaces()) {
                 boolean isBlocked = this.isBlocked(gridSide);
                 this.setBlocked(gridSide, !isBlocked);
             } else {
                 boolean isOpen = this.isConnected(gridSide);
                 this.setConnection(gridSide, !isOpen, false);
             }
-            return Pair.of(getPipeTuneTool(), InteractionResult.sidedSuccess(playerIn.level().isClientSide));
-        } else if (toolTypes.contains(GTToolType.CROWBAR)) {
-            if (coverBehavior != null) {
-                if (!isRemote()) {
-                    getCoverContainer().removeCover(gridSide, playerIn);
-                    return Pair.of(GTToolType.CROWBAR, InteractionResult.sidedSuccess(playerIn.level().isClientSide));
-                }
-            } else {
-                if (!frameMaterial.isNull()) {
-                    Block.popResource(getLevel(), this.getBlockPos(),
-                            GTMaterialBlocks.MATERIAL_BLOCKS.get(TagPrefix.frameGt, frameMaterial).asStack());
-                    frameMaterial = GTMaterials.NULL;
-                    return Pair.of(GTToolType.CROWBAR, InteractionResult.sidedSuccess(playerIn.level().isClientSide));
-                }
+            return Pair.of(getPipeTuneTool(), InteractionResult.sidedSuccess(isRemote()));
+        } else if (toolType.contains(GTToolType.CROWBAR)) {
+            if (!frameMaterial.isNull()) {
+                Block.popResource(context.getLevel(), this.getBlockPos(),
+                        GTMaterialBlocks.MATERIAL_BLOCKS.get(TagPrefix.frameGt, frameMaterial).asStack());
+                frameMaterial = GTMaterials.NULL;
+                return Pair.of(GTToolType.CROWBAR, InteractionResult.sidedSuccess(isRemote()));
             }
         }
 

src/main/java/com/gregtechceu/gtceu/api/capability/GTCapability.java

@@ -14,7 +14,6 @@ public class GTCapability {
     public static final Capability<IEnergyInfoProvider> CAPABILITY_ENERGY_INFO_PROVIDER = CapabilityManager
             .get(new CapabilityToken<>() {});
     public static final Capability<ICoverable> CAPABILITY_COVERABLE = CapabilityManager.get(new CapabilityToken<>() {});
-    public static final Capability<IToolable> CAPABILITY_TOOLABLE = CapabilityManager.get(new CapabilityToken<>() {});
     public static final Capability<IWorkable> CAPABILITY_WORKABLE = CapabilityManager.get(new CapabilityToken<>() {});
     public static final Capability<IControllable> CAPABILITY_CONTROLLABLE = CapabilityManager
             .get(new CapabilityToken<>() {});
@@ -40,7 +39,6 @@ public static void register(RegisterCapabilitiesEvent event) {
         event.register(IEnergyContainer.class);
         event.register(IEnergyInfoProvider.class);
         event.register(ICoverable.class);
-        event.register(IToolable.class);
         event.register(IWorkable.class);
         event.register(IControllable.class);
         event.register(IElectricItem.class);

src/main/java/com/gregtechceu/gtceu/api/capability/GTCapabilityHelper.java

@@ -53,11 +53,6 @@ public static ICoverable getCoverable(Level level, BlockPos pos, @Nullable Direc
         return getBlockEntityCapability(GTCapability.CAPABILITY_COVERABLE, level, pos, side);
     }
 
-    @Nullable
-    public static IToolable getToolable(Level level, BlockPos pos, @Nullable Direction side) {
-        return getBlockEntityCapability(GTCapability.CAPABILITY_TOOLABLE, level, pos, side);
-    }
-
     @Nullable
     public static IWorkable getWorkable(Level level, BlockPos pos, @Nullable Direction side) {
         return getBlockEntityCapability(GTCapability.CAPABILITY_WORKABLE, level, pos, side);

src/main/java/com/gregtechceu/gtceu/api/capability/IToolable.java

@@ -16,22 +16,22 @@
 import com.gregtechceu.gtceu.api.transfer.fluid.IFluidHandlerModifiable;
 import com.gregtechceu.gtceu.client.renderer.cover.ICoverRenderer;
 import com.gregtechceu.gtceu.client.renderer.cover.IDynamicCoverRenderer;
+import com.gregtechceu.gtceu.utils.ExtendedUseOnContext;
 
 import com.lowdragmc.lowdraglib.gui.texture.ResourceTexture;
 
 import net.minecraft.MethodsReturnNonnullByDefault;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.server.level.ServerPlayer;
-import net.minecraft.world.InteractionHand;
 import net.minecraft.world.InteractionResult;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.block.Block;
 import net.minecraft.world.level.block.state.BlockState;
-import net.minecraft.world.phys.BlockHitResult;
 import net.minecraftforge.items.IItemHandlerModifiable;
 
+import com.mojang.datafixers.util.Pair;
 import lombok.Getter;
 import org.jetbrains.annotations.MustBeInvokedByOverriders;
 import org.jetbrains.annotations.Nullable;
@@ -150,17 +150,28 @@ public boolean canConnectRedstone() {
     //////////////////////////////////////
     // ******* Interaction *******//
     //////////////////////////////////////
-    public InteractionResult onScrewdriverClick(Player playerIn, InteractionHand hand, BlockHitResult hitResult) {
+
+    public final Pair<@Nullable GTToolType, InteractionResult> onToolClick(ExtendedUseOnContext context) {
+        var toolType = context.getToolType();
+        if (toolType.contains(GTToolType.SCREWDRIVER)) {
+            return Pair.of(GTToolType.SCREWDRIVER, onScrewdriverClick(context));
+        } else if (toolType.contains(GTToolType.SOFT_MALLET)) {
+            return Pair.of(GTToolType.SOFT_MALLET, onSoftMalletClick(context));
+        }
+        return Pair.of(null, InteractionResult.PASS);
+    }
+
+    public InteractionResult onScrewdriverClick(ExtendedUseOnContext context) {
         if (this instanceof IUICover) {
-            if (playerIn instanceof ServerPlayer serverPlayer) {
+            if (context.getPlayer() instanceof ServerPlayer serverPlayer) {
                 CoverUIFactory.INSTANCE.openUI(this, serverPlayer);
             }
-            return InteractionResult.sidedSuccess(playerIn.level().isClientSide);
+            return InteractionResult.sidedSuccess(coverHolder.isRemote());
         }
         return InteractionResult.PASS;
     }
 
-    public InteractionResult onSoftMalletClick(Player playerIn, InteractionHand hand, BlockHitResult hitResult) {
+    public InteractionResult onSoftMalletClick(ExtendedUseOnContext context) {
         return InteractionResult.PASS;
     }