Add a way for mods to be able to integrate their plant growth with AppleCore

 * API: Add IAppleCoreDispatcher interface and AppleCoreAPI.dispatcher to access it
  + Used for dispatching AppleCore events (for now, just the plant growth ones)
 * Add BlockCropsExample to example mod

Author: squeek502

TODO

@@ -1,7 +1,6 @@
 General:
 
 API:
- [ ] Add a way for mods to be able to integrate their plant growth with AppleCore
 
 Core/ASM:
   Plant growth modification:
@@ -68,3 +67,4 @@ Archive:
  [x] Implement event-driven starvation @done (2014-07-24 01:38) @project(API)
  [x] Implement event-driven configurable health regen @done (2014-07-24 01:38) @project(API)
  [x] Implement event-driven configurable exhaustion @done (2014-07-24 01:38) @project(API)
+ [x] Add a way for mods to be able to integrate their plant growth with AppleCore @done (15-01-27 14:50) @project(API)

java/squeek/applecore/AppleCore.java

@@ -5,6 +5,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import squeek.applecore.api_impl.AppleCoreAccessorMutatorImpl;
+import squeek.applecore.api_impl.AppleCoreDispatcherImpl;
 import squeek.applecore.asm.TransformerModuleHandler;
 import squeek.applecore.client.DebugInfoHandler;
 import squeek.applecore.client.HUDOverlayHandler;
@@ -40,8 +41,9 @@ public void preInit(FMLPreInitializationEvent event)
 		MetadataCollection metadataCollection = MetadataCollection.from(is, ModInfo.MODID);
 		Loader.instance().activeModContainer().bindMetadata(metadataCollection);
 
-		// force initialization of the singleton
+		// force initialization of the singletons
 		AppleCoreAccessorMutatorImpl.values();
+		AppleCoreDispatcherImpl.values();
 
 		ModConfig.init(event.getSuggestedConfigurationFile());
 

java/squeek/applecore/api/AppleCoreAPI.java

@@ -10,4 +10,5 @@ public abstract class AppleCoreAPI
 {
 	public static IAppleCoreAccessor accessor;
 	public static IAppleCoreMutator mutator;
+	public static IAppleCoreDispatcher dispatcher;
 }

java/squeek/applecore/api/IAppleCoreDispatcher.java

@@ -0,0 +1,22 @@
+package squeek.applecore.api;
+
+import java.util.Random;
+import net.minecraft.block.Block;
+import net.minecraft.world.World;
+import squeek.applecore.api.plants.PlantGrowthEvent;
+import cpw.mods.fml.common.eventhandler.Event;
+
+public interface IAppleCoreDispatcher
+{
+	/**
+	 * Fires a {@link PlantGrowthEvent.AllowGrowthTick} event and returns the result.
+	 * 
+	 * See {@link PlantGrowthEvent.AllowGrowthTick} for how to use the result.
+	 */
+	public Event.Result validatePlantGrowth(Block block, World world, int x, int y, int z, Random random);
+
+	/**
+	 * Fires a {@link PlantGrowthEvent.GrowthTick} event.
+	 */
+	public void announcePlantGrowth(Block block, World world, int x, int y, int z);
+}

java/squeek/applecore/api_impl/AppleCoreDispatcherImpl.java

@@ -0,0 +1,35 @@
+package squeek.applecore.api_impl;
+
+import java.util.Random;
+import net.minecraft.block.Block;
+import net.minecraft.world.World;
+import net.minecraftforge.common.MinecraftForge;
+import squeek.applecore.api.AppleCoreAPI;
+import squeek.applecore.api.IAppleCoreDispatcher;
+import squeek.applecore.api.plants.PlantGrowthEvent;
+import cpw.mods.fml.common.eventhandler.Event;
+
+public enum AppleCoreDispatcherImpl implements IAppleCoreDispatcher
+{
+	INSTANCE;
+
+	private AppleCoreDispatcherImpl()
+	{
+		AppleCoreAPI.dispatcher = this;
+	}
+
+	@Override
+	public Event.Result validatePlantGrowth(Block block, World world, int x, int y, int z, Random random)
+	{
+		PlantGrowthEvent.AllowGrowthTick event = new PlantGrowthEvent.AllowGrowthTick(block, world, x, y, z, random);
+		MinecraftForge.EVENT_BUS.post(event);
+		return event.getResult();
+	}
+
+	@Override
+	public void announcePlantGrowth(Block block, World world, int x, int y, int z)
+	{
+		PlantGrowthEvent.GrowthTick event = new PlantGrowthEvent.GrowthTick(block, world, x, y, z);
+		MinecraftForge.EVENT_BUS.post(event);
+	}
+}

java/squeek/applecore/asm/Hooks.java

@@ -17,7 +17,6 @@
 import squeek.applecore.api.hunger.ExhaustionEvent;
 import squeek.applecore.api.hunger.HealthRegenEvent;
 import squeek.applecore.api.hunger.StarvationEvent;
-import squeek.applecore.api.plants.PlantGrowthEvent;
 import cpw.mods.fml.common.eventhandler.Event.Result;
 
 public class Hooks
@@ -31,7 +30,7 @@ public static void onPostFoodStatsAdded(FoodStats foodStats, ItemFood itemFood,
 	{
 		MinecraftForge.EVENT_BUS.post(new FoodEvent.FoodEaten(player, itemStack, foodValues, hungerAdded, saturationAdded));
 	}
-	
+
 	public static int getItemInUseMaxDuration(EntityPlayer player, int savedMaxDuration)
 	{
 		EnumAction useAction = player.getItemInUse().getItemUseAction();
@@ -143,15 +142,12 @@ public static boolean fireFoodStatsAdditionEvent(EntityPlayer player, FoodValues
 
 	public static Result fireAllowPlantGrowthEvent(Block block, World world, int x, int y, int z, Random random)
 	{
-		PlantGrowthEvent.AllowGrowthTick event = new PlantGrowthEvent.AllowGrowthTick(block, world, x, y, z, random);
-		MinecraftForge.EVENT_BUS.post(event);
-		return event.getResult();
+		return AppleCoreAPI.dispatcher.validatePlantGrowth(block, world, x, y, z, random);
 	}
 
 	public static void fireOnGrowthEvent(Block block, World world, int x, int y, int z)
 	{
-		PlantGrowthEvent.GrowthTick event = new PlantGrowthEvent.GrowthTick(block, world, x, y, z);
-		MinecraftForge.EVENT_BUS.post(event);
+		AppleCoreAPI.dispatcher.announcePlantGrowth(block, world, x, y, z);
 	}
 
 	public static int toolTipX, toolTipY, toolTipW, toolTipH;

java/squeek/applecore/example/AppleCoreExample.java

@@ -1,5 +1,6 @@
 package squeek.applecore.example;
 
+import net.minecraft.block.Block;
 import net.minecraft.item.Item;
 import net.minecraftforge.common.MinecraftForge;
 import org.apache.logging.log4j.LogManager;
@@ -26,15 +27,19 @@ public class AppleCoreExample
 
 	public static Item testFood;
 	public static Item testMetadataFood;
+	public static Block testBlockCrops;
 
 	@EventHandler
 	public void preInit(FMLPreInitializationEvent event)
 	{
 		testFood = new ItemNonStandardFood().setUnlocalizedName("testNonStandardFood");
 		GameRegistry.registerItem(testFood, "testNonStandardFood");
 
-		testMetadataFood = new ItemMetadataFood(new int[] {1, 10}, new float[] {2f, 0.1f}).setUnlocalizedName("testMetadataFood");
+		testMetadataFood = new ItemMetadataFood(new int[]{1, 10}, new float[]{2f, 0.1f}).setUnlocalizedName("testMetadataFood");
 		GameRegistry.registerItem(testMetadataFood, "testMetadataFood");
+
+		testBlockCrops = new BlockCropsExample();
+		GameRegistry.registerBlock(testBlockCrops, "testBlockCrops");
 	}
 
 	@EventHandler

java/squeek/applecore/example/BlockCropsExample.java

@@ -0,0 +1,78 @@
+package squeek.applecore.example;
+
+import java.util.Random;
+import net.minecraft.block.BlockCrops;
+import net.minecraft.world.World;
+import squeek.applecore.api.AppleCoreAPI;
+import cpw.mods.fml.common.Loader;
+import cpw.mods.fml.common.Optional;
+import cpw.mods.fml.common.eventhandler.Event;
+import cpw.mods.fml.common.eventhandler.Event.Result;
+
+public class BlockCropsExample extends BlockCrops
+{
+	// abstract the AppleCoreAPI reference into an Optional.Method so that AppleCore is not a hard dependency
+	@Optional.Method(modid = "AppleCore")
+	public Event.Result validateAppleCoreGrowthTick(World world, int x, int y, int z, Random random)
+	{
+		return AppleCoreAPI.dispatcher.validatePlantGrowth(this, world, x, y, z, random);
+	}
+
+	// abstract the AppleCoreAPI reference into an Optional.Method so that AppleCore is not a hard dependency
+	@Optional.Method(modid = "AppleCore")
+	public void announceAppleCoreGrowthTick(World world, int x, int y, int z)
+	{
+		AppleCoreAPI.dispatcher.announcePlantGrowth(this, world, x, y, z);
+	}
+
+	/**
+	 * A custom updateTick implementation (that doesn't call super.updateTick)
+	 * will not fire the AppleCore events that get inserted into BlockCrops.updateTick,
+	 * which means that the custom implementation will need to fire and handle them
+	 */
+	@Override
+	public void updateTick(World world, int x, int y, int z, Random random)
+	{
+		// get the result of the event
+		Event.Result allowGrowthResult = Event.Result.DEFAULT;
+		if (Loader.isModLoaded("AppleCore"))
+		{
+			allowGrowthResult = validateAppleCoreGrowthTick(world, x, y, z, random);
+		}
+
+		// note: you could return early here if plant growth is the only thing
+		// that this method does. This would allow for skipping the allowGrowthResult == Event.Result.DEFAULT
+		// check in the template below, changing it to: allowGrowthResult == Result.ALLOW || (DEFAULT CONDITIONS)
+		if (allowGrowthResult == Event.Result.DENY)
+			return;
+
+		// for each growth requirement/conditional in updateTick, the following  template should be applied:
+		// allowGrowthResult == Result.ALLOW || (allowGrowthResult == Result.DEFAULT && (DEFAULT CONDITIONS))
+		// this follows the PlantGrowthEvent.AllowGrowthTick specifications:
+		//  - Event.Result.ALLOW means to always allow the growth tick without condition
+		//  - Event.Result.DEFAULT means to continue with the conditionals as normal
+		//  - Event.Result.DENY means to always disallow the growth tick
+		if (allowGrowthResult == Event.Result.ALLOW || (allowGrowthResult == Event.Result.DEFAULT && world.getBlockLightValue(x, y + 1, z) >= 9))
+		{
+			int meta = world.getBlockMetadata(x, y, z);
+
+			if (meta < 7)
+			{
+				// same template as above is applied here, but the default conditional is
+				// moved into a variable for clarity
+				boolean defaultGrowthCondition = random.nextInt(50) == 0;
+				if (allowGrowthResult == Result.ALLOW || (allowGrowthResult == Result.DEFAULT && defaultGrowthCondition))
+				{
+					++meta;
+					world.setBlockMetadataWithNotify(x, y, z, meta, 2);
+
+					// *After* the actual growth occurs, we simply let everyone know that it happened
+					if (Loader.isModLoaded("AppleCore"))
+					{
+						announceAppleCoreGrowthTick(world, x, y, z);
+					}
+				}
+			}
+		}
+	}
+}