% Tried to improve the logic for the Tree Farmer, to support Forestry 4.

% Moved COFH API related files.
+ Added a child mod, for misc handling.
$$ Borrowed some code from MFR, to attempt forestry support. (Credit left, will re-do if I even get it working).

6 files changed, 515 insertions, 0 deletions

diff --git a/src/Java/powercrystals/minefactoryreloaded/api/EmptyReplacement.java b/src/Java/powercrystals/minefactoryreloaded/api/EmptyReplacement.java
new file mode 100644
index 0000000000..ef3fd46bb2
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/EmptyReplacement.java
@@ -0,0 +1,20 @@
+package powercrystals.minefactoryreloaded.api;
+
+import net.minecraft.block.Block;
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+public class EmptyReplacement extends ReplacementBlock
+{
+	public static final EmptyReplacement INSTANCE = new EmptyReplacement();
+
+	public EmptyReplacement()
+	{
+		super((Block)null);
+	}
+
+	@Override
+	public boolean replaceBlock(World world, int x, int y, int z, ItemStack stack) {
+		return true;
+	}
+}
diff --git a/src/Java/powercrystals/minefactoryreloaded/api/HarvestType.java b/src/Java/powercrystals/minefactoryreloaded/api/HarvestType.java
new file mode 100644
index 0000000000..85ef23835c
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/HarvestType.java
@@ -0,0 +1,56 @@
+package powercrystals.minefactoryreloaded.api;
+
+/**
+ * Determines what algorithm the Harvester uses when it encounters this
+ * IFactoryHarvestable in the world.
+ *
+ * @author PowerCrystals
+ */
+public enum HarvestType {
+
+	/**
+	 * Just break the single block - no special action needed. e.g. Carrots,
+	 * flowers, wheat.
+	 */
+	Normal,
+	/**
+	 * Search for harvestable blocks adjacent to this block but leave this
+	 * block. e.g. Pumpkin, melon
+	 */
+	Gourd,
+	/**
+	 * Search for identical blocks above.
+	 */
+	Column,
+	/**
+	 * Search for identical blocks above but leave the bottom one for the
+	 * future. e.g. Cactus, sugarcane.
+	 */
+	LeaveBottom,
+	/**
+	 * This block is the base of a tree and the harvester should enter
+	 * tree-cutting mode.
+	 */
+	Tree,
+	/**
+	 * This block is the base of the tree and the harvester should enter
+	 * tree-cutting mode.
+	 * The tree is searched for in the negative y axis instead.
+	 */
+	TreeFlipped,
+	/**
+	 * This block is part of a tree as above, but leaves are cut before logs.
+	 * The tree is searched for in the current mode.
+	 * <p>
+	 * If not in tree-cutting mode, tree-cutting mode will be entered as though
+	 * the type was Tree.
+	 */
+	TreeLeaf,
+	/**
+	 * This block is part of a tree as above, but fruits are cut before logs.
+	 * e.g. cocoa
+	 * The tree is not searched for.
+	 */
+	TreeFruit
+
+}
diff --git a/src/Java/powercrystals/minefactoryreloaded/api/IFactoryFruit.java b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryFruit.java
new file mode 100644
index 0000000000..3f956422c0
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryFruit.java
@@ -0,0 +1,106 @@
+package powercrystals.minefactoryreloaded.api;
+
+import java.util.List;
+import java.util.Random;
+
+import net.minecraft.block.Block;
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+/**
+ * Defines a fruit entry for the Fruit Picker.
+ *
+ * @author powercrystals
+ *
+ */
+public interface IFactoryFruit {
+
+	/**
+	 * @return The block this fruit has in the world.
+	 */
+	public Block getPlant();
+
+	/**
+	 * Used to determine if this fruit can be picked (is it ripe yet, etc)
+	 *
+	 * @param world
+	 *            The world where the fruit is being picked
+	 * @param x
+	 *            The x-coordinate of the fruit
+	 * @param y
+	 *            The y-coordinate of the fruit
+	 * @param z
+	 *            The z-coordinate of the fruit
+	 *
+	 * @return True if the fruit can be picked
+	 */
+	public boolean canBePicked(World world, int x, int y, int z);
+
+	/**
+	 * @deprecated This method is no longer called. ReplacementBlock now handles
+	 *             interaction.
+	 */
+	@Deprecated
+	public boolean breakBlock();
+
+	/**
+	 * Called by the Fruit Picker to determine what block to replace the picked
+	 * block with. At the time this method is called, the fruit still exists.
+	 *
+	 * @param world
+	 *            The world where the fruit is being picked
+	 * @param x
+	 *            The x-coordinate of the fruit
+	 * @param y
+	 *            The y-coordinate of the fruit
+	 * @param z
+	 *            The z-coordinate of the fruit
+	 *
+	 * @return The block to replace the fruit block with, or null for air.
+	 */
+	public ReplacementBlock getReplacementBlock(World world, int x, int y, int z);
+
+	/**
+	 * Called by the Fruit Picker to determine what drops to generate. At the
+	 * time this method is called, the fruit still exists.
+	 *
+	 * @param world
+	 *            The world where the fruit is being picked
+	 * @param x
+	 *            The x-coordinate of the fruit
+	 * @param y
+	 *            The y-coordinate of the fruit
+	 * @param z
+	 *            The z-coordinate of the fruit
+	 */
+	public List<ItemStack> getDrops(World world, Random rand, int x, int y, int z);
+
+	/**
+	 * Called by the Fruit Picker after getDrops, prior to the block being
+	 * replaced/removed.
+	 *
+	 * @param world
+	 *            The world where the fruit is being picked
+	 * @param x
+	 *            The x-coordinate of the fruit
+	 * @param y
+	 *            The y-coordinate of the fruit
+	 * @param z
+	 *            The z-coordinate of the fruit
+	 */
+	public void prePick(World world, int x, int y, int z);
+
+	/**
+	 * Called by the Fruit Picker after the fruit is picked.
+	 *
+	 * @param world
+	 *            The world where the fruit is being picked
+	 * @param x
+	 *            The x-coordinate of the fruit
+	 * @param y
+	 *            The y-coordinate of the fruit
+	 * @param z
+	 *            The z-coordinate of the fruit
+	 */
+	public void postPick(World world, int x, int y, int z);
+}
diff --git a/src/Java/powercrystals/minefactoryreloaded/api/IFactoryHarvestable.java b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryHarvestable.java
new file mode 100644
index 0000000000..5b6be99f89
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryHarvestable.java
@@ -0,0 +1,104 @@
+package powercrystals.minefactoryreloaded.api;
+
+import java.util.*;
+
+import net.minecraft.block.Block;
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+/**
+ * Defines a harvestable block for the Harvester.
+ *
+ * @author PowerCrystals
+ */
+public interface IFactoryHarvestable {
+
+	/**
+	 * @return The block this harvestable instance is managing.
+	 */
+	public Block getPlant();
+
+	/**
+	 * @return The type of harvest the Harvester should perform on this block.
+	 */
+	public HarvestType getHarvestType();
+
+	/**
+	 * Used to determine if the harvester should replace this block with air.
+	 *
+	 * @return Whether or not the Harvester should break the block when
+	 *         harvesting. If false, no changes will be performed by the
+	 *         Harvester itself.
+	 */
+	public boolean breakBlock();
+
+	/**
+	 * Used to determine if this crop can be harvested (is it at a stage that
+	 * drops crops, etc.)
+	 *
+	 * @param world
+	 *            The world this block is in.
+	 * @param harvesterSettings
+	 *            The harvester's current settings. Do not modify these.
+	 * @param x
+	 *            The X coordinate of the block being harvested.
+	 * @param y
+	 *            The Y coordinate of the block being harvested.
+	 * @param z
+	 *            The Z coordinate of the block being harvested.
+	 *
+	 * @return True if this block can be harvested.
+	 */
+	public boolean canBeHarvested(World world, Map<String, Boolean> harvesterSettings, int x, int y, int z);
+
+	/**
+	 * @param world
+	 *            The world this block is in.
+	 * @param rand
+	 *            A Random instance to use when generating drops.
+	 * @param harvesterSettings
+	 *            The harvester's current settings. Do not modify these.
+	 * @param x
+	 *            The X coordinate of the block being harvested.
+	 * @param y
+	 *            The Y coordinate of the block being harvested.
+	 * @param z
+	 *            The Z coordinate of the block being harvested.
+	 *
+	 * @return The drops generated by breaking this block. For a default
+	 *         implementation, calling Block.getDrops() is usually
+	 *         sufficient.
+	 */
+	public List<ItemStack> getDrops(World world, Random rand, Map<String, Boolean> harvesterSettings, int x, int y, int z);
+
+	/**
+	 * Called before the block is going to be harvested, after getDrops. Usually
+	 * empty.
+	 *
+	 * @param world
+	 *            The world this block is in.
+	 * @param x
+	 *            The X coordinate of the block being harvested.
+	 * @param y
+	 *            The Y coordinate of the block being harvested.
+	 * @param z
+	 *            The Z coordinate of the block being harvested.
+	 */
+	public void preHarvest(World world, int x, int y, int z);
+
+	/**
+	 * Called after the block is going to be harvested. Used to re-till soil,
+	 * for example.
+	 *
+	 * @param world
+	 *            The world this block is in.
+	 * @param x
+	 *            The X coordinate of the block being harvested.
+	 * @param y
+	 *            The Y coordinate of the block being harvested.
+	 * @param z
+	 *            The Z coordinate of the block being harvested.
+	 */
+	public void postHarvest(World world, int x, int y, int z);
+
+}
diff --git a/src/Java/powercrystals/minefactoryreloaded/api/IFactoryPlantable.java b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryPlantable.java
new file mode 100644
index 0000000000..1d620b37ed
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/IFactoryPlantable.java
@@ -0,0 +1,94 @@
+package powercrystals.minefactoryreloaded.api;
+
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+/**
+ * Defines a plantable object for use in the Planter.
+ *
+ * @author PowerCrystals
+ */
+public interface IFactoryPlantable {
+
+	/**
+	 * @return The item this plantable is managing.
+	 */
+	public Item getSeed();
+
+	/**
+	 * @param stack
+	 *            The stack being planted.
+	 * @param forFermenting
+	 *            True if this stack will be converted to biofuel
+	 *
+	 * @return True if this plantable can be planted (useful for metadata
+	 *         items).
+	 */
+	public boolean canBePlanted(ItemStack stack, boolean forFermenting);
+
+	/**
+	 * @param world
+	 *            The world instance this block or item will be placed into.
+	 * @param x
+	 *            The destination X coordinate.
+	 * @param y
+	 *            The destination Y coordinate.
+	 * @param z
+	 *            The destination Z coordinate.
+	 * @param stack
+	 *            The stack being planted.
+	 *
+	 * @return The block that will be placed into the world.
+	 */
+	public ReplacementBlock getPlantedBlock(World world, int x, int y, int z, ItemStack stack);
+
+	/**
+	 * @param world
+	 *            The world instance this block or item will be placed into.
+	 * @param x
+	 *            The destination X coordinate.
+	 * @param y
+	 *            The destination Y coordinate.
+	 * @param z
+	 *            The destination Z coordinate.
+	 * @param stack
+	 *            The stack being planted.
+	 *
+	 * @return True if this plantable can be placed at the provided coordinates.
+	 */
+	public boolean canBePlantedHere(World world, int x, int y, int z, ItemStack stack);
+
+	/**
+	 * Called before planting is performed. Used to till soil, for example.
+	 *
+	 * @param world
+	 *            The world instance this block or item will be placed into.
+	 * @param x
+	 *            The destination X coordinate.
+	 * @param y
+	 *            The destination Y coordinate.
+	 * @param z
+	 *            The destination Z coordinate.
+	 * @param stack
+	 *            The stack being planted.
+	 */
+	public void prePlant(World world, int x, int y, int z, ItemStack stack);
+
+	/**
+	 * Called after planting is performed. Usually empty.
+	 *
+	 * @param world
+	 *            The world instance this block or item will be placed into.
+	 * @param x
+	 *            The destination X coordinate.
+	 * @param y
+	 *            The destination Y coordinate.
+	 * @param z
+	 *            The destination Z coordinate.
+	 * @param stack
+	 *            The stack being planted.
+	 */
+	public void postPlant(World world, int x, int y, int z, ItemStack stack);
+
+}
diff --git a/src/Java/powercrystals/minefactoryreloaded/api/ReplacementBlock.java b/src/Java/powercrystals/minefactoryreloaded/api/ReplacementBlock.java
new file mode 100644
index 0000000000..c67e8a39a2
--- /dev/null
+++ b/src/Java/powercrystals/minefactoryreloaded/api/ReplacementBlock.java
@@ -0,0 +1,135 @@
+package powercrystals.minefactoryreloaded.api;
+
+import net.minecraft.block.Block;
+import net.minecraft.item.*;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.tileentity.TileEntity;
+import net.minecraft.world.World;
+
+public class ReplacementBlock
+{
+	protected byte _hasMeta;
+	protected int _meta;
+	protected final Block _block;
+	protected final NBTTagCompound _tileTag;
+	
+	/**
+	 * Called to replace a block in the world.
+	 * @param world The world object
+	 * @param x The X coord
+	 * @param y The Y coord
+	 * @param z The Z coord
+	 * @param stack The ItemStack being used to replace the block (may be null)
+	 * @return True if the block was set successfully
+	 */
+	public boolean replaceBlock(World world, int x, int y, int z, ItemStack stack)
+	{
+		int meta = getMeta(world, x, y, z, stack);
+		if (world.setBlock(x, y, z, _block, meta, 3))
+		{
+			if (hasTag(stack) && _block.hasTileEntity(meta))
+			{
+				TileEntity tile = world.getTileEntity(x, y, z);
+				if (tile != null)
+					tile.readFromNBT(getTag(world, x, y, z, stack));
+			}
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Called to get the metadata of the replacement block in the world.
+	 * @param world The world object
+	 * @param x The X coord
+	 * @param y The Y coord
+	 * @param z The Z coord
+	 * @param stack The ItemStack being used to replace the block (may be null)
+	 * @return The metadata of the block
+	 */
+	protected int getMeta(World world, int x, int y, int z, ItemStack stack)
+	{
+		int m = 0;
+		if (_hasMeta > 0)
+		{
+			if (_hasMeta > 1)
+				return _meta;
+			m = stack.getItemDamage();
+			Item item = stack.getItem();
+			if (item instanceof ItemBlock)
+				m = ((ItemBlock)item).getMetadata(m);
+		}
+		return m;
+	}
+	
+	/**
+	 * Called to set the metdata of this ReplacementBlock to a fixed value
+	 * @param meta The metadata of the block 
+	 * @return This instance
+	 */
+	public ReplacementBlock setMeta(int meta)
+	{
+		if (meta >= 0)
+		{
+			_hasMeta = 2;
+			_meta = meta;
+		}
+		return this;
+	}
+	
+	/**
+	 * Called to set the metdata of this ReplacementBlock to a value read from an ItemStack
+	 * @param meta The metadata of the block 
+	 * @return This instance
+	 */
+	public ReplacementBlock setMeta(boolean hasMeta)
+	{
+		_hasMeta = (byte) (hasMeta ? 1 : 0);
+		return this;
+	}
+	
+	/**
+	 * Called to get the NBTTagCompound a TileEntity will read its state from
+	 * @param world The world object
+	 * @param x The X coord
+	 * @param y The Y coord
+	 * @param z The Z coord
+	 * @param stack The ItemStack being used to replace the block (may be null)
+	 * @return The NBTTagCompound a TileEntity will read its state from
+	 */
+	protected NBTTagCompound getTag(World world, int x, int y, int z, ItemStack stack)
+	{
+		return _tileTag;
+	}
+	
+	/**
+	 * Called to see if a TileEntity should have its state set
+	 * @param stack The ItemStack being used to replace the block (may be null)
+	 * @return True if the TileEntity should have its state set
+	 */
+	protected boolean hasTag(ItemStack stack)
+	{
+		return _tileTag != null;
+	}
+	
+	public ReplacementBlock(Item block)
+	{
+		this(Block.getBlockFromItem(block));
+	}
+	
+	public ReplacementBlock(Item block, NBTTagCompound tag)
+	{
+		this(Block.getBlockFromItem(block), tag);
+	}
+	
+	public ReplacementBlock(Block block)
+	{
+		this(block, null);
+	}
+	
+	public ReplacementBlock(Block block, NBTTagCompound tag)
+	{
+		_block = block;
+		_tileTag = tag;
+	}
+}