Add BlockEvent.HarvestDropsEvent and its respective firing method, WorldEvents.fireBlockHarvesting

Author: GammaWhiskey

patchwork-events-world/src/main/java/net/minecraftforge/event/world/BlockEvent.java

@@ -19,8 +19,12 @@
 
 package net.minecraftforge.event.world;
 
+import java.util.List;
+
 import net.minecraftforge.eventbus.api.Event;
 
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.DefaultedList;
 import net.minecraft.block.BlockState;
 import net.minecraft.entity.player.PlayerEntity;
 import net.minecraft.util.math.BlockPos;
@@ -109,4 +113,54 @@ public boolean isCancelable() {
 			return true;
 		}
 	}
+
+	/**
+	 * Fired when a block is about to drop it's harvested items. The {@link #drops} array can be amended, as can the {@link #dropChance}.
+	 * <strong>Note well:</strong> the {@link #harvester} player field is null in a variety of scenarios. Code expecting null.
+	 *
+	 * <p>The {@link #dropChance} is used to determine which items in this array will actually drop, compared to a random number. If you wish, you
+	 * can pre-filter yourself, and set {@link #dropChance} to 1.0f to always drop the contents of the {@link #drops} array.
+	 *
+	 * <p>{@link #isSilkTouching} is set if this is considered a silk touch harvesting operation, vs a normal harvesting operation. Act accordingly.
+	 */
+	public static class HarvestDropsEvent extends BlockEvent {
+		private final int fortuneLevel;
+		private final DefaultedList<ItemStack> drops;
+		private final boolean isSilkTouching;
+		private final PlayerEntity harvester; // May be null for non-player harvesting such as explosions or machines
+		private float dropChance; // Change to e.g. 1.0f, if you manipulate the list and want to guarantee it always drops
+
+		public HarvestDropsEvent(World world, BlockPos pos, BlockState state, int fortuneLevel, float dropChance, DefaultedList<ItemStack> drops, PlayerEntity harvester, boolean isSilkTouching) {
+			super(world, pos, state);
+			this.fortuneLevel = fortuneLevel;
+			this.setDropChance(dropChance);
+			this.drops = drops;
+			this.isSilkTouching = isSilkTouching;
+			this.harvester = harvester;
+		}
+
+		public int getFortuneLevel() {
+			return fortuneLevel;
+		}
+
+		public List<ItemStack> getDrops() {
+			return drops;
+		}
+
+		public boolean isSilkTouching() {
+			return isSilkTouching;
+		}
+
+		public float getDropChance() {
+			return dropChance;
+		}
+
+		public void setDropChance(float dropChance) {
+			this.dropChance = dropChance;
+		}
+
+		public PlayerEntity getHarvester() {
+			return harvester;
+		}
+	}
 }

patchwork-events-world/src/main/java/net/patchworkmc/impl/event/world/WorldEvents.java

@@ -23,8 +23,14 @@
 import java.util.List;
 
 import net.minecraftforge.common.MinecraftForge;
+import net.minecraftforge.event.world.BlockEvent;
 import net.minecraftforge.event.world.WorldEvent;
 
+import net.minecraft.block.BlockState;
+import net.minecraft.entity.player.PlayerEntity;
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.DefaultedList;
+import net.minecraft.world.World;
 import net.minecraft.entity.EntityCategory;
 import net.minecraft.util.math.BlockPos;
 import net.minecraft.world.IWorld;
@@ -57,4 +63,11 @@ public static void onWorldUnload(IWorld world) {
 	public static void onWorldSave(IWorld world) {
 		MinecraftForge.EVENT_BUS.post(new WorldEvent.Save(world));
 	}
+
+	// TODO: Leaving this unimplemented is intentional. See: https://github.com/MinecraftForge/MinecraftForge/issues/5828
+	public static float fireBlockHarvesting(DefaultedList<ItemStack> drops, World world, BlockPos pos, BlockState state, int fortune, float dropChance, boolean silkTouch, PlayerEntity player) {
+		BlockEvent.HarvestDropsEvent event = new BlockEvent.HarvestDropsEvent(world, pos, state, fortune, dropChance, drops, player, silkTouch);
+		MinecraftForge.EVENT_BUS.post(event);
+		return event.getDropChance();
+	}
 }

patchwork-god-classes/build.gradle

@@ -7,5 +7,6 @@ dependencies {
 	compile project(path: ':patchwork-events-entity', configuration: 'dev')
 	compile project(path: ':patchwork-events-lifecycle', configuration: 'dev')
 	compile project(path: ':patchwork-events-rendering', configuration: 'dev')
+	compile project(path: ':patchwork-events-world', configuration: 'dev')
 	compile project(path: ':patchwork-loot', configuration: 'dev')
 }

patchwork-god-classes/src/main/java/net/minecraftforge/event/ForgeEventFactory.java

@@ -34,10 +34,15 @@
 import net.minecraft.world.IWorld;
 import net.minecraft.world.MobSpawnerLogic;
 import net.minecraft.world.World;
+import net.minecraft.block.BlockState;
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.DefaultedList;
+import net.minecraft.util.math.BlockPos;
 
 import net.patchworkmc.impl.capability.CapabilityEvents;
 import net.patchworkmc.impl.event.entity.EntityEvents;
 import net.patchworkmc.impl.event.loot.LootEvents;
+import net.patchworkmc.impl.event.world.WorldEvents;
 
 /*
  * Note: this class is intended for mod use only, to dispatch to the implementations kept in their own modules.
@@ -73,4 +78,8 @@ public static boolean doSpecialSpawn(MobEntity entity, World world, float x, flo
 	public static LootTable loadLootTable(Identifier name, LootTable table, LootManager lootTableManager) {
 		return LootEvents.loadLootTable(name, table, lootTableManager);
 	}
+
+	public static float fireBlockHarvesting(DefaultedList<ItemStack> drops, World world, BlockPos pos, BlockState state, int fortune, float dropChance, boolean silkTouch, PlayerEntity player) {
+		return WorldEvents.fireBlockHarvesting(drops, world, pos, state, fortune, dropChance, silkTouch, player);
+	}
 }