Add support for farmblock trample listeners.

Author: Darkhax

Common/src/main/java/net/darkhax/bookshelf/api/event/IEventHelper.java

@@ -1,5 +1,6 @@
 package net.darkhax.bookshelf.api.event;
 
+import net.darkhax.bookshelf.api.event.block.IFarmlandTrampleListener;
 import net.darkhax.bookshelf.api.event.client.IRecipeSyncEvent;
 import net.darkhax.bookshelf.api.event.entity.player.IPlayerWakeUpEvent;
 import net.darkhax.bookshelf.api.event.item.IItemTooltipEvent;
@@ -30,4 +31,11 @@ public interface IEventHelper {
      * @param listener The event listener.
      */
     void addRecipeSyncListener(IRecipeSyncEvent listener);
+
+    /**
+     * Registers a listener that will be invoked when a farmland block is trampled by an entity.
+     *
+     * @param listener The event listener.
+     */
+    void addFarmlandTrampleListener(IFarmlandTrampleListener listener);
 }

Common/src/main/java/net/darkhax/bookshelf/api/event/block/IFarmlandTrampleListener.java

@@ -0,0 +1,18 @@
+package net.darkhax.bookshelf.api.event.block;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.entity.Entity;
+import net.minecraft.world.level.block.state.BlockState;
+
+public interface IFarmlandTrampleListener {
+
+    /**
+     * A neutral event listener that will be invoked when an entity tramples on farmland.
+     *
+     * @param trampler The entity that trampled the farmland.
+     * @param pos      The position of the farmland.
+     * @param state    The farmland's blockstate.
+     * @return The cancel state of the listener. If true the farmland will not be trampled.
+     */
+    boolean apply(Entity trampler, BlockPos pos, BlockState state);
+}

Fabric/src/main/java/net/darkhax/bookshelf/impl/event/EventHelperFabric.java

@@ -2,6 +2,7 @@
 
 import net.darkhax.bookshelf.api.Services;
 import net.darkhax.bookshelf.api.event.IEventHelper;
+import net.darkhax.bookshelf.api.event.block.IFarmlandTrampleListener;
 import net.darkhax.bookshelf.api.event.client.IRecipeSyncEvent;
 import net.darkhax.bookshelf.api.event.entity.player.IPlayerWakeUpEvent;
 import net.darkhax.bookshelf.api.event.item.IItemTooltipEvent;
@@ -40,4 +41,10 @@ public void addRecipeSyncListener(IRecipeSyncEvent listener) {
             FabricBookshelfEvents.RECIPE_SYNC.register(listener);
         }
     }
+
+    @Override
+    public void addFarmlandTrampleListener(IFarmlandTrampleListener listener) {
+
+        FabricBookshelfEvents.FARMLAND_TRAMPLE_EVENT.register(listener);
+    }
 }

Fabric/src/main/java/net/darkhax/bookshelf/impl/event/FabricBookshelfEvents.java

@@ -1,5 +1,6 @@
 package net.darkhax.bookshelf.impl.event;
 
+import net.darkhax.bookshelf.api.event.block.IFarmlandTrampleListener;
 import net.darkhax.bookshelf.api.event.client.IRecipeSyncEvent;
 import net.fabricmc.fabric.api.event.Event;
 import net.fabricmc.fabric.api.event.EventFactory;
@@ -16,4 +17,20 @@ public class FabricBookshelfEvents {
             callback.apply(recipeManager);
         }
     });
+
+    /**
+     * This event is posted when an entity tramples on farmland.
+     */
+    public static final Event<IFarmlandTrampleListener> FARMLAND_TRAMPLE_EVENT = EventFactory.createArrayBacked(IFarmlandTrampleListener.class, callbacks -> (player, pos, state) -> {
+
+        for (IFarmlandTrampleListener callback : callbacks) {
+
+            if (callback.apply(player, pos, state)) {
+
+                return true;
+            }
+        }
+
+        return false;
+    });
 }

Fabric/src/main/java/net/darkhax/bookshelf/mixin/block/MixinFarmBlock.java

@@ -0,0 +1,25 @@
+package net.darkhax.bookshelf.mixin.block;
+
+import net.darkhax.bookshelf.impl.event.FabricBookshelfEvents;
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.entity.Entity;
+import net.minecraft.world.level.Level;
+import net.minecraft.world.level.block.FarmBlock;
+import net.minecraft.world.level.block.state.BlockState;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(FarmBlock.class)
+public class MixinFarmBlock {
+
+    @Inject(method = "fallOn", at = @At("HEAD"), cancellable = true)
+    private void fallOn(Level level, BlockState blockState, BlockPos blockPos, Entity entity, float f, CallbackInfo ci) {
+
+        if (FabricBookshelfEvents.FARMLAND_TRAMPLE_EVENT.invoker().apply(entity, blockPos, blockState)) {
+
+            ci.cancel();
+        }
+    }
+}

Fabric/src/main/resources/bookshelf.fabric.mixins.json

@@ -4,6 +4,7 @@
   "package": "net.darkhax.bookshelf.mixin",
   "compatibilityLevel": "JAVA_17",
   "mixins": [
+    "block.MixinFarmBlock"
   ],
   "client": [
     "client.AccessorItemBlockRenderTypes",

Forge/src/main/java/net/darkhax/bookshelf/impl/event/EventHelperForge.java

@@ -2,13 +2,16 @@
 
 import net.darkhax.bookshelf.api.Services;
 import net.darkhax.bookshelf.api.event.IEventHelper;
+import net.darkhax.bookshelf.api.event.block.IFarmlandTrampleListener;
 import net.darkhax.bookshelf.api.event.client.IRecipeSyncEvent;
 import net.darkhax.bookshelf.api.event.entity.player.IPlayerWakeUpEvent;
 import net.darkhax.bookshelf.api.event.item.IItemTooltipEvent;
 import net.minecraftforge.client.event.RecipesUpdatedEvent;
 import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.event.entity.player.ItemTooltipEvent;
 import net.minecraftforge.event.entity.player.PlayerWakeUpEvent;
+import net.minecraftforge.event.world.BlockEvent;
+import net.minecraftforge.eventbus.api.Event;
 import net.minecraftforge.eventbus.api.EventPriority;
 
 public class EventHelperForge implements IEventHelper {
@@ -36,4 +39,16 @@ public void addRecipeSyncListener(IRecipeSyncEvent listener) {
             MinecraftForge.EVENT_BUS.addListener(EventPriority.NORMAL, false, RecipesUpdatedEvent.class, e -> listener.apply(e.getRecipeManager()));
         }
     }
+
+    @Override
+    public void addFarmlandTrampleListener(IFarmlandTrampleListener listener) {
+
+        MinecraftForge.EVENT_BUS.addListener(EventPriority.NORMAL, false, BlockEvent.FarmlandTrampleEvent.class, e -> {
+
+            if (listener.apply(e.getEntity(), e.getPos(), e.getState())) {
+
+                e.setCanceled(true);
+            }
+        });
+    }
 }