Cleanup shear unit logic and add support for the new trim item ability

Author: pupnewfster

src/main/java/mekanism/common/config/GearConfig.java

@@ -101,6 +101,7 @@ public class GearConfig extends BaseMekanismConfig {
     public final CachedLongValue mekaToolEnergyUsageShovel;
     public final CachedLongValue mekaToolEnergyUsageAxe;
     public final CachedLongValue mekaToolEnergyUsageShearEntity;
+    public final CachedLongValue mekaToolEnergyUsageShearTrim;
     public final CachedBooleanValue mekaToolExtendedMining;
     //MekaSuit
     public final CachedLongValue mekaSuitBaseEnergyCapacity;
@@ -280,6 +281,8 @@ public class GearConfig extends BaseMekanismConfig {
               "energyUsageAxe", 10L);
         mekaToolEnergyUsageShearEntity = CachedLongValue.definePositive(this, builder, "Cost in Joules of using the Meka-Tool to shear entities.",
               "energyUsageShearEntity", 10L);
+        mekaToolEnergyUsageShearTrim = CachedLongValue.definePositive(this, builder, "Cost in Joules of using the Meka-Tool to carefully shear and trim blocks.",
+              "energyUsageShearTrim", 10L);
         mekaToolExtendedMining = CachedBooleanValue.wrap(this, builder.comment("Enable the 'Extended Vein Mining' mode for the Meka-Tool. (Allows vein mining everything not just ores/logs)")
               .define("extendedMining", true));
         builder.pop();

src/main/java/mekanism/common/content/gear/mekatool/ModuleShearingUnit.java

@@ -11,30 +11,25 @@
 import mekanism.common.config.MekanismConfig;
 import mekanism.common.item.gear.ItemMekaTool;
 import mekanism.common.registries.MekanismModules;
+import net.minecraft.advancements.CriteriaTriggers;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.core.dispenser.BlockSource;
 import net.minecraft.server.level.ServerLevel;
-import net.minecraft.sounds.SoundEvents;
-import net.minecraft.sounds.SoundSource;
-import net.minecraft.tags.BlockTags;
+import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.world.InteractionHand;
 import net.minecraft.world.InteractionResult;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.entity.LivingEntity;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
-import net.minecraft.world.item.Items;
+import net.minecraft.world.item.context.UseOnContext;
 import net.minecraft.world.level.Level;
-import net.minecraft.world.level.block.BeehiveBlock;
-import net.minecraft.world.level.block.Block;
-import net.minecraft.world.level.block.Blocks;
-import net.minecraft.world.level.block.CarvedPumpkinBlock;
 import net.minecraft.world.level.block.DispenserBlock;
-import net.minecraft.world.level.block.entity.BeehiveBlockEntity;
 import net.minecraft.world.level.block.state.BlockState;
 import net.minecraft.world.level.gameevent.GameEvent;
 import net.minecraft.world.phys.AABB;
+import net.neoforged.neoforge.common.CommonHooks;
 import net.neoforged.neoforge.common.IShearable;
 import net.neoforged.neoforge.common.ItemAbilities;
 import net.neoforged.neoforge.common.ItemAbility;
@@ -64,6 +59,8 @@ public boolean canPerformAction(IModule<ModuleShearingUnit> module, IModuleConta
             //Note: If for some reason we are installed on something that is not the Meka-Tool don't stop the action from being enabled
             // as it may not actually require energy
             return !(stack.getItem() instanceof ItemMekaTool) || ItemMekaTool.hasEnergyForDigAction(container, module.getEnergyContainer(stack));
+        } else if (action == ItemAbilities.SHEARS_TRIM) {
+            return module.hasEnoughEnergy(stack, MekanismConfig.gear.mekaToolEnergyUsageShearTrim);
         }
         return ItemAbilities.DEFAULT_SHEARS_ACTIONS.contains(action);
     }
@@ -82,38 +79,45 @@ public InteractionResult onInteract(IModule<ModuleShearingUnit> module, Player p
         return InteractionResult.PASS;
     }
 
+    @NotNull
+    @Override
+    public InteractionResult onItemUse(IModule<ModuleShearingUnit> module, UseOnContext context) {
+        long cost = MekanismConfig.gear.mekaToolEnergyUsageShearTrim.get();
+        ItemStack stack = context.getItemInHand();
+        IEnergyContainer energyContainer = module.getEnergyContainer(stack);
+        if (cost == 0L || energyContainer != null && energyContainer.getEnergy() >= cost) {
+            //Copy of ShearsItem#useOn
+            Level level = context.getLevel();
+            BlockPos blockpos = context.getClickedPos();
+            BlockState state = level.getBlockState(blockpos);
+            BlockState trimmedState = state.getToolModifiedState(context, ItemAbilities.SHEARS_TRIM, false);
+            if (trimmedState != null) {
+                if (context.getPlayer() instanceof ServerPlayer player) {
+                    CriteriaTriggers.ITEM_USED_ON_BLOCK.trigger(player, blockpos, stack);
+                }
+                level.setBlockAndUpdate(blockpos, trimmedState);
+                level.gameEvent(GameEvent.BLOCK_CHANGE, blockpos, GameEvent.Context.of(context.getPlayer(), trimmedState));
+                if (cost > 0) {
+                    energyContainer.extract(cost, Action.EXECUTE, AutomationType.MANUAL);
+                }
+                return InteractionResult.sidedSuccess(level.isClientSide);
+            }
+        }
+        return InteractionResult.PASS;
+    }
+
     @NotNull
     @Override
     public ModuleDispenseResult onDispense(IModule<ModuleShearingUnit> module, IModuleContainer moduleContainer, ItemStack stack, BlockSource source) {
         ServerLevel world = source.level();
         Direction facing = source.state().getValue(DispenserBlock.FACING);
         BlockPos pos = source.pos().relative(facing);
-        if (tryShearBlock(world, pos, facing.getOpposite()) || tryShearLivingEntity(module.getEnergyContainer(stack), world, pos, stack)) {
+        if (CommonHooks.tryDispenseShearsHarvestBlock(source, stack, world, pos) || tryShearLivingEntity(module.getEnergyContainer(stack), world, pos, stack)) {
             return ModuleDispenseResult.HANDLED;
         }
         return ModuleDispenseResult.FAIL_PREVENT_DROP;
     }
 
-    //Slightly modified copy of ShearsDispenseItemBehavior#tryShearBeehive modified to not crash if the tag has a block that isn't a
-    // beehive block instance in it, and also to support shearing pumpkins via the dispenser
-    private boolean tryShearBlock(ServerLevel world, BlockPos pos, Direction sideClicked) {
-        BlockState state = world.getBlockState(pos);
-        if (state.is(BlockTags.BEEHIVES) && state.getBlock() instanceof BeehiveBlock beehive && state.getValue(BeehiveBlock.HONEY_LEVEL) >= 5) {
-            world.playSound(null, pos, SoundEvents.BEEHIVE_SHEAR, SoundSource.BLOCKS, 1.0F, 1.0F);
-            BeehiveBlock.dropHoneycomb(world, pos);
-            beehive.releaseBeesAndResetHoneyLevel(world, state, pos, null, BeehiveBlockEntity.BeeReleaseStatus.BEE_RELEASED);
-            return true;
-        } else if (state.is(Blocks.PUMPKIN)) {
-            //Carve pumpkin - copy from Pumpkin Block's onBlockActivated
-            Direction side = sideClicked.getAxis() == Direction.Axis.Y ? Direction.NORTH : sideClicked;
-            world.playSound(null, pos, SoundEvents.PUMPKIN_CARVE, SoundSource.BLOCKS, 1, 1);
-            world.setBlock(pos, Blocks.CARVED_PUMPKIN.defaultBlockState().setValue(CarvedPumpkinBlock.FACING, side), Block.UPDATE_ALL_IMMEDIATE);
-            Block.popResource(world, pos, new ItemStack(Items.PUMPKIN_SEEDS, 4));
-            return true;
-        }
-        return false;
-    }
-
     //Modified copy of ShearsDispenseItemBehavior#tryShearLivingEntity to work with IForgeShearable
     private boolean tryShearLivingEntity(@Nullable IEnergyContainer energyContainer, ServerLevel world, BlockPos pos, ItemStack stack) {
         long cost = MekanismConfig.gear.mekaToolEnergyUsageShearEntity.get();