diff --git a/api/forestry b/api/forestry
deleted file mode 160000
index 5e44fe9c6..000000000
--- a/api/forestry
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 5e44fe9c6a9cfb4415b3e6f1d522f6ae057b9294
diff --git a/api/redstoneflux b/api/redstoneflux
deleted file mode 160000
index 10e10af21..000000000
--- a/api/redstoneflux
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 10e10af21489e351624813120ed6474c44b09ff6
diff --git a/build.gradle b/build.gradle
index 3252d89f1..11f6d5358 100755
--- a/build.gradle
+++ b/build.gradle
@@ -39,8 +39,8 @@ targetCompatibility = 1.7
minecraft {
version = mcversion + "-" + forgeversion
runDir = "run"
-
- mappings = "stable_20"
+ useDepAts = true
+ mappings = mcp_mappings
replace '@VERSION@', project.version
replace '@BUILD_NUMBER@', getBuildNumber()
@@ -59,6 +59,13 @@ sourceSets {
}
repositories {
+ maven {
+ url "http://dvs1.progwml6.com/files/maven"
+ }
+}
+
+dependencies {
+ deobfCompile "mezz.jei:jei_${mcversion}:${jei_version}"
}
configurations {
@@ -68,9 +75,6 @@ configurations {
compile.extendsFrom shade
}
-dependencies {
-}
-
processResources {
// this will ensure that this task is redone when the versions change.
diff --git a/gradle.properties b/gradle.properties
index 871f3031a..c606f99cf 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,5 +1,9 @@
mcversion=1.8.9
-forgeversion=11.15.0.1708
-version_major=4
-version_minor=3
+forgeversion=11.15.1.1755
+mcp_mappings=snapshot_20160219
+
+jei_version=2.28.+
+
+version_major=5
+version_minor=0
version_patch=0
diff --git a/src/main/java/cofh/LICENSE - LGPLv3.txt b/src/main/java/cofh/LICENSE - LGPLv3.txt
new file mode 100644
index 000000000..65c5ca88a
--- /dev/null
+++ b/src/main/java/cofh/LICENSE - LGPLv3.txt
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/src/main/java/cofh/README.md b/src/main/java/cofh/README.md
new file mode 100644
index 000000000..3f855b753
--- /dev/null
+++ b/src/main/java/cofh/README.md
@@ -0,0 +1,11 @@
+Redstone Flux API
+====================================
+This is the standalone CoFH Energy API - also known as the "Redstone Flux" API.
+
+Make great use of it.
+
+You are of course free to modify any/all of this code and even repackage it, but then it wouldn't be an awesome crossmod API anymore, now would it?
+
+Don't be a jerk.
+
+~Team CoFH
\ No newline at end of file
diff --git a/src/main/java/cofh/api/CoFHAPIProps.java b/src/main/java/cofh/api/CoFHAPIProps.java
new file mode 100644
index 000000000..eb2e05ade
--- /dev/null
+++ b/src/main/java/cofh/api/CoFHAPIProps.java
@@ -0,0 +1,11 @@
+package cofh.api;
+
+public class CoFHAPIProps {
+
+ private CoFHAPIProps() {
+
+ }
+
+ public static final String VERSION = "1.8.9R1.2.0B1";
+
+}
diff --git a/src/main/java/cofh/api/energy/EnergyStorage.java b/src/main/java/cofh/api/energy/EnergyStorage.java
new file mode 100644
index 000000000..dd7dd3e02
--- /dev/null
+++ b/src/main/java/cofh/api/energy/EnergyStorage.java
@@ -0,0 +1,162 @@
+package cofh.api.energy;
+
+import net.minecraft.nbt.NBTTagCompound;
+
+/**
+ * Reference implementation of {@link IEnergyStorage}. Use/extend this or implement your own.
+ *
+ * @author King Lemming
+ *
+ */
+public class EnergyStorage implements IEnergyStorage {
+
+ protected int energy;
+ protected int capacity;
+ protected int maxReceive;
+ protected int maxExtract;
+
+ public EnergyStorage(int capacity) {
+
+ this(capacity, capacity, capacity);
+ }
+
+ public EnergyStorage(int capacity, int maxTransfer) {
+
+ this(capacity, maxTransfer, maxTransfer);
+ }
+
+ public EnergyStorage(int capacity, int maxReceive, int maxExtract) {
+
+ this.capacity = capacity;
+ this.maxReceive = maxReceive;
+ this.maxExtract = maxExtract;
+ }
+
+ public EnergyStorage readFromNBT(NBTTagCompound nbt) {
+
+ this.energy = nbt.getInteger("Energy");
+
+ if (energy > capacity) {
+ energy = capacity;
+ }
+ return this;
+ }
+
+ public NBTTagCompound writeToNBT(NBTTagCompound nbt) {
+
+ if (energy < 0) {
+ energy = 0;
+ }
+ nbt.setInteger("Energy", energy);
+ return nbt;
+ }
+
+ public EnergyStorage setCapacity(int capacity) {
+
+ this.capacity = capacity;
+
+ if (energy > capacity) {
+ energy = capacity;
+ }
+ return this;
+ }
+
+ public EnergyStorage setMaxTransfer(int maxTransfer) {
+
+ setMaxReceive(maxTransfer);
+ setMaxExtract(maxTransfer);
+ return this;
+ }
+
+ public EnergyStorage setMaxReceive(int maxReceive) {
+
+ this.maxReceive = maxReceive;
+ return this;
+ }
+
+ public EnergyStorage setMaxExtract(int maxExtract) {
+
+ this.maxExtract = maxExtract;
+ return this;
+ }
+
+ public int getMaxReceive() {
+
+ return maxReceive;
+ }
+
+ public int getMaxExtract() {
+
+ return maxExtract;
+ }
+
+ /**
+ * This function is included to allow for server to client sync. Do not call this externally to the containing Tile Entity, as not all IEnergyHandlers
+ * are guaranteed to have it.
+ *
+ * @param energy
+ */
+ public void setEnergyStored(int energy) {
+
+ this.energy = energy;
+
+ if (this.energy > capacity) {
+ this.energy = capacity;
+ } else if (this.energy < 0) {
+ this.energy = 0;
+ }
+ }
+
+ /**
+ * This function is included to allow the containing tile to directly and efficiently modify the energy contained in the EnergyStorage. Do not rely on this
+ * externally, as not all IEnergyHandlers are guaranteed to have it.
+ *
+ * @param energy
+ */
+ public void modifyEnergyStored(int energy) {
+
+ this.energy += energy;
+
+ if (this.energy > capacity) {
+ this.energy = capacity;
+ } else if (this.energy < 0) {
+ this.energy = 0;
+ }
+ }
+
+ /* IEnergyStorage */
+ @Override
+ public int receiveEnergy(int maxReceive, boolean simulate) {
+
+ int energyReceived = Math.min(capacity - energy, Math.min(this.maxReceive, maxReceive));
+
+ if (!simulate) {
+ energy += energyReceived;
+ }
+ return energyReceived;
+ }
+
+ @Override
+ public int extractEnergy(int maxExtract, boolean simulate) {
+
+ int energyExtracted = Math.min(energy, Math.min(this.maxExtract, maxExtract));
+
+ if (!simulate) {
+ energy -= energyExtracted;
+ }
+ return energyExtracted;
+ }
+
+ @Override
+ public int getEnergyStored() {
+
+ return energy;
+ }
+
+ @Override
+ public int getMaxEnergyStored() {
+
+ return capacity;
+ }
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyConnection.java b/src/main/java/cofh/api/energy/IEnergyConnection.java
new file mode 100644
index 000000000..29ef0a1ce
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyConnection.java
@@ -0,0 +1,22 @@
+package cofh.api.energy;
+
+import net.minecraft.util.EnumFacing;
+
+
+/**
+ * Implement this interface on TileEntities which should connect to energy transportation blocks. This is intended for blocks which generate energy but do not
+ * accept it; otherwise just use IEnergyHandler.
+ *
+ * Note that {@link IEnergyHandler} is an extension of this.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyConnection {
+
+ /**
+ * Returns TRUE if the TileEntity can connect on a given side.
+ */
+ boolean canConnectEnergy(EnumFacing from);
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyContainerItem.java b/src/main/java/cofh/api/energy/IEnergyContainerItem.java
new file mode 100644
index 000000000..3ef725765
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyContainerItem.java
@@ -0,0 +1,52 @@
+package cofh.api.energy;
+
+import net.minecraft.item.ItemStack;
+
+/**
+ * Implement this interface on Item classes that support external manipulation of their internal energy storages.
+ *
+ * A reference implementation is provided {@link ItemEnergyContainer}.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyContainerItem {
+
+ /**
+ * Adds energy to a container item. Returns the quantity of energy that was accepted. This should always return 0 if the item cannot be externally charged.
+ *
+ * @param container
+ * ItemStack to be charged.
+ * @param maxReceive
+ * Maximum amount of energy to be sent into the item.
+ * @param simulate
+ * If TRUE, the charge will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) received by the item.
+ */
+ int receiveEnergy(ItemStack container, int maxReceive, boolean simulate);
+
+ /**
+ * Removes energy from a container item. Returns the quantity of energy that was removed. This should always return 0 if the item cannot be externally
+ * discharged.
+ *
+ * @param container
+ * ItemStack to be discharged.
+ * @param maxExtract
+ * Maximum amount of energy to be extracted from the item.
+ * @param simulate
+ * If TRUE, the discharge will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) extracted from the item.
+ */
+ int extractEnergy(ItemStack container, int maxExtract, boolean simulate);
+
+ /**
+ * Get the amount of energy currently stored in the container item.
+ */
+ int getEnergyStored(ItemStack container);
+
+ /**
+ * Get the max amount of energy that can be stored in the container item.
+ */
+ int getMaxEnergyStored(ItemStack container);
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyHandler.java b/src/main/java/cofh/api/energy/IEnergyHandler.java
new file mode 100644
index 000000000..16b236e7a
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyHandler.java
@@ -0,0 +1,27 @@
+package cofh.api.energy;
+
+import net.minecraft.util.EnumFacing;
+
+/**
+ * Implement this interface on Tile Entities which should handle energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
+ *
+ * A reference implementation is provided {@link TileEnergyHandler}.
+ *
+ * Note that {@link IEnergyReceiver} and {@link IEnergyProvider} are extensions of this.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyHandler extends IEnergyConnection {
+
+ /**
+ * Returns the amount of energy currently stored.
+ */
+ int getEnergyStored(EnumFacing from);
+
+ /**
+ * Returns the maximum amount of energy that can be stored.
+ */
+ int getMaxEnergyStored(EnumFacing from);
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyProvider.java b/src/main/java/cofh/api/energy/IEnergyProvider.java
new file mode 100644
index 000000000..ef0e09d06
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyProvider.java
@@ -0,0 +1,29 @@
+package cofh.api.energy;
+
+import net.minecraft.util.EnumFacing;
+
+
+/**
+ * Implement this interface on Tile Entities which should provide energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
+ *
+ * A reference implementation is provided {@link TileEnergyHandler}.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyProvider extends IEnergyHandler {
+
+ /**
+ * Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
+ *
+ * @param from
+ * Orientation the energy is extracted from.
+ * @param maxExtract
+ * Maximum amount of energy to extract.
+ * @param simulate
+ * If TRUE, the extraction will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) extracted.
+ */
+ int extractEnergy(EnumFacing from, int maxExtract, boolean simulate);
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyReceiver.java b/src/main/java/cofh/api/energy/IEnergyReceiver.java
new file mode 100644
index 000000000..989e9baa5
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyReceiver.java
@@ -0,0 +1,29 @@
+package cofh.api.energy;
+
+import net.minecraft.util.EnumFacing;
+
+
+/**
+ * Implement this interface on Tile Entities which should receive energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
+ *
+ * A reference implementation is provided {@link TileEnergyHandler}.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyReceiver extends IEnergyHandler {
+
+ /**
+ * Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver.
+ *
+ * @param from
+ * Orientation the energy is received from.
+ * @param maxReceive
+ * Maximum amount of energy to receive.
+ * @param simulate
+ * If TRUE, the charge will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) received.
+ */
+ int receiveEnergy(EnumFacing from, int maxReceive, boolean simulate);
+
+}
diff --git a/src/main/java/cofh/api/energy/IEnergyStorage.java b/src/main/java/cofh/api/energy/IEnergyStorage.java
new file mode 100644
index 000000000..414b26566
--- /dev/null
+++ b/src/main/java/cofh/api/energy/IEnergyStorage.java
@@ -0,0 +1,46 @@
+package cofh.api.energy;
+
+/**
+ * An energy storage is the unit of interaction with Energy inventories.
+ * This is not to be implemented on TileEntities. This is for internal use only.
+ *
+ * A reference implementation can be found at {@link EnergyStorage}.
+ *
+ * @author King Lemming
+ *
+ */
+public interface IEnergyStorage {
+
+ /**
+ * Adds energy to the storage. Returns quantity of energy that was accepted.
+ *
+ * @param maxReceive
+ * Maximum amount of energy to be inserted.
+ * @param simulate
+ * If TRUE, the insertion will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) accepted by the storage.
+ */
+ int receiveEnergy(int maxReceive, boolean simulate);
+
+ /**
+ * Removes energy from the storage. Returns quantity of energy that was removed.
+ *
+ * @param maxExtract
+ * Maximum amount of energy to be extracted.
+ * @param simulate
+ * If TRUE, the extraction will only be simulated.
+ * @return Amount of energy that was (or would have been, if simulated) extracted from the storage.
+ */
+ int extractEnergy(int maxExtract, boolean simulate);
+
+ /**
+ * Returns the amount of energy currently stored.
+ */
+ int getEnergyStored();
+
+ /**
+ * Returns the maximum amount of energy that can be stored.
+ */
+ int getMaxEnergyStored();
+
+}
diff --git a/src/main/java/cofh/api/energy/ItemEnergyContainer.java b/src/main/java/cofh/api/energy/ItemEnergyContainer.java
new file mode 100644
index 000000000..0fb36dab6
--- /dev/null
+++ b/src/main/java/cofh/api/energy/ItemEnergyContainer.java
@@ -0,0 +1,113 @@
+package cofh.api.energy;
+
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+
+/**
+ * Reference implementation of {@link IEnergyContainerItem}. Use/extend this or implement your own.
+ *
+ * @author King Lemming
+ *
+ */
+public class ItemEnergyContainer extends Item implements IEnergyContainerItem {
+
+ protected int capacity;
+ protected int maxReceive;
+ protected int maxExtract;
+
+ public ItemEnergyContainer() {
+
+ }
+
+ public ItemEnergyContainer(int capacity) {
+
+ this(capacity, capacity, capacity);
+ }
+
+ public ItemEnergyContainer(int capacity, int maxTransfer) {
+
+ this(capacity, maxTransfer, maxTransfer);
+ }
+
+ public ItemEnergyContainer(int capacity, int maxReceive, int maxExtract) {
+
+ this.capacity = capacity;
+ this.maxReceive = maxReceive;
+ this.maxExtract = maxExtract;
+ }
+
+ public ItemEnergyContainer setCapacity(int capacity) {
+
+ this.capacity = capacity;
+ return this;
+ }
+
+ public ItemEnergyContainer setMaxTransfer(int maxTransfer) {
+
+ setMaxReceive(maxTransfer);
+ setMaxExtract(maxTransfer);
+ return this;
+ }
+
+ public ItemEnergyContainer setMaxReceive(int maxReceive) {
+
+ this.maxReceive = maxReceive;
+ return this;
+ }
+
+ public ItemEnergyContainer setMaxExtract(int maxExtract) {
+
+ this.maxExtract = maxExtract;
+ return this;
+ }
+
+ /* IEnergyContainerItem */
+ @Override
+ public int receiveEnergy(ItemStack container, int maxReceive, boolean simulate) {
+
+ if (!container.hasTagCompound()) {
+ container.setTagCompound(new NBTTagCompound());
+ }
+ int energy = container.getTagCompound().getInteger("Energy");
+ int energyReceived = Math.min(capacity - energy, Math.min(this.maxReceive, maxReceive));
+
+ if (!simulate) {
+ energy += energyReceived;
+ container.getTagCompound().setInteger("Energy", energy);
+ }
+ return energyReceived;
+ }
+
+ @Override
+ public int extractEnergy(ItemStack container, int maxExtract, boolean simulate) {
+
+ if (container.getTagCompound() == null || !container.getTagCompound().hasKey("Energy")) {
+ return 0;
+ }
+ int energy = container.getTagCompound().getInteger("Energy");
+ int energyExtracted = Math.min(energy, Math.min(this.maxExtract, maxExtract));
+
+ if (!simulate) {
+ energy -= energyExtracted;
+ container.getTagCompound().setInteger("Energy", energy);
+ }
+ return energyExtracted;
+ }
+
+ @Override
+ public int getEnergyStored(ItemStack container) {
+
+ if (container.getTagCompound() == null || !container.getTagCompound().hasKey("Energy")) {
+ return 0;
+ }
+ return container.getTagCompound().getInteger("Energy");
+ }
+
+ @Override
+ public int getMaxEnergyStored(ItemStack container) {
+
+ return capacity;
+ }
+
+}
diff --git a/src/main/java/cofh/api/energy/TileEnergyHandler.java b/src/main/java/cofh/api/energy/TileEnergyHandler.java
new file mode 100644
index 000000000..3ba60a664
--- /dev/null
+++ b/src/main/java/cofh/api/energy/TileEnergyHandler.java
@@ -0,0 +1,67 @@
+package cofh.api.energy;
+
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.tileentity.TileEntity;
+import net.minecraft.util.EnumFacing;
+
+/**
+ * Reference implementation of {@link IEnergyReceiver} and {@link IEnergyProvider}. Use/extend this or implement your own.
+ *
+ * This class is really meant to summarize how each interface is properly used.
+ *
+ * @author King Lemming
+ *
+ */
+public class TileEnergyHandler extends TileEntity implements IEnergyReceiver, IEnergyProvider {
+
+ protected EnergyStorage storage = new EnergyStorage(32000);
+
+ @Override
+ public void readFromNBT(NBTTagCompound nbt) {
+
+ super.readFromNBT(nbt);
+ storage.readFromNBT(nbt);
+ }
+
+ @Override
+ public void writeToNBT(NBTTagCompound nbt) {
+
+ super.writeToNBT(nbt);
+ storage.writeToNBT(nbt);
+ }
+
+ /* IEnergyConnection */
+ @Override
+ public boolean canConnectEnergy(EnumFacing from) {
+
+ return true;
+ }
+
+ /* IEnergyReceiver */
+ @Override
+ public int receiveEnergy(EnumFacing from, int maxReceive, boolean simulate) {
+
+ return storage.receiveEnergy(maxReceive, simulate);
+ }
+
+ /* IEnergyProvider */
+ @Override
+ public int extractEnergy(EnumFacing from, int maxExtract, boolean simulate) {
+
+ return storage.extractEnergy(maxExtract, simulate);
+ }
+
+ /* IEnergyHandler */
+ @Override
+ public int getEnergyStored(EnumFacing from) {
+
+ return storage.getEnergyStored();
+ }
+
+ @Override
+ public int getMaxEnergyStored(EnumFacing from) {
+
+ return storage.getMaxEnergyStored();
+ }
+
+}
diff --git a/src/main/java/cofh/api/energy/package-info.java b/src/main/java/cofh/api/energy/package-info.java
new file mode 100644
index 000000000..da8566735
--- /dev/null
+++ b/src/main/java/cofh/api/energy/package-info.java
@@ -0,0 +1,10 @@
+/**
+ * (C) 2014-2016 Team CoFH / CoFH / Cult of the Full Hub
+ * http://www.teamcofh.com
+ */
+@API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHAPI", provides = "CoFHAPI|energy")
+package cofh.api.energy;
+
+import net.minecraftforge.fml.common.API;
+import cofh.api.CoFHAPIProps;
+
diff --git a/src/main/java/cofh/api/package-info.java b/src/main/java/cofh/api/package-info.java
new file mode 100644
index 000000000..e2847daad
--- /dev/null
+++ b/src/main/java/cofh/api/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * (C) 2014-2016 Team CoFH / CoFH / Cult of the Full Hub
+ * http://www.teamcofh.com
+ */
+@API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHLib", provides = "CoFHAPI")
+package cofh.api;
+
+import net.minecraftforge.fml.common.API;
+
diff --git a/src/main/java/forestry/api/LICENSE.txt b/src/main/java/forestry/api/LICENSE.txt
new file mode 100644
index 000000000..45bdcf0c8
--- /dev/null
+++ b/src/main/java/forestry/api/LICENSE.txt
@@ -0,0 +1,11 @@
+License („MIT“)
+
+Forestry API
+
+Copyright (c) 2011 - 2014 SirSengir.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/src/main/java/forestry/api/README.md b/src/main/java/forestry/api/README.md
new file mode 100644
index 000000000..e080d790c
--- /dev/null
+++ b/src/main/java/forestry/api/README.md
@@ -0,0 +1,26 @@
+Forestry API
+====================================
+
+### What is it?
+
+Forestry is a modification for the game Minecraft and known primarily for its farms and bees. This is the API for inter-mod operations.
+
+### Homepage
+
+[Wiki](http://forestry.sengir.net/)
+
+[Forums](http://forestry.sengir.net/forum/)
+
+[IRC #forestry on esper.net](http://webchat.esper.net/?nick=ForestryWiki...&channels=forestry&prompt=1)
+
+### Notes
+
+This is only the API. It is not intended to be used by itself, but rather for use either with Forestry itself or another mod which wants to use a functionality of Forestry.
+
+Package versioning follows the rules laid out by http://semver.org/
+
+Bugfixes are generally welcome. If you want to contribute something which changes game mechanics, please talk to someone with commit privileges first. Nothing is more frustrating than putting a lot of work and effort into a new game mechanic and then having the PR rejected because it doesn’t fit gameplay-wise.
+
+### License & Copyright
+
+Forestry API is (c) 2011 - 2014 SirSengir and licensed under MIT. See the LICENSE.txt for more information. Note that the core Forestry source is licensed differently! The Forestry API may also contain code contributed by CovertJaguar, Player, MysteriousAges, Binnie and others.
diff --git a/src/main/java/forestry/api/apiculture/BeeManager.java b/src/main/java/forestry/api/apiculture/BeeManager.java
new file mode 100644
index 000000000..280ee751f
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/BeeManager.java
@@ -0,0 +1,54 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+
+import net.minecraft.item.ItemStack;
+/**
+ *
+ * Some miscellaneous lists and settings for bees.
+ *
+ * @author SirSengir
+ */
+public class BeeManager {
+
+ /**
+ * 0 - Common Village Bees 1 - Uncommon Village Bees (20 % of spawns)
+ */
+ public static ArrayList[] villageBees;
+
+ /**
+ * List of items that can induce swarming. Integer denotes x in 1000 chance.
+ */
+ public static HashMap inducers = new HashMap();
+
+ /**
+ * Convenient access to AlleleManager.alleleRegistry.getSpeciesRoot("rootBees")
+ */
+ public static IBeeRoot beeRoot;
+
+ /**
+ * Used to create new bees.
+ */
+ public static IBeeFactory beeFactory;
+
+ /**
+ * Used to create new bee mutations.
+ */
+ public static IBeeMutationFactory beeMutationFactory;
+
+ /**
+ * Used to get Forestry's jubilance implementations.
+ */
+ public static IJubilanceFactory jubilanceFactory;
+
+ /**
+ * Used to check whether a player is wearing Apiarist Armor.
+ */
+ public static IArmorApiaristHelper armorApiaristHelper;
+}
diff --git a/src/main/java/forestry/api/apiculture/DefaultBeeListener.java b/src/main/java/forestry/api/apiculture/DefaultBeeListener.java
new file mode 100644
index 000000000..8e76cf28d
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/DefaultBeeListener.java
@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IIndividual;
+
+/**
+ * Easily extendable default IBeeListener.
+ * By itself, this IBeeListener does nothing.
+ * BeeListeners should inherit from this class unless they need to listen for everything.
+ */
+public class DefaultBeeListener implements IBeeListener {
+ @Override
+ public void wearOutEquipment(int amount) {
+
+ }
+
+ @Override
+ public void onQueenDeath() {
+
+ }
+
+ @Override
+ public boolean onPollenRetrieved(IIndividual pollen) {
+ return false;
+ }
+
+}
diff --git a/src/main/java/forestry/api/apiculture/DefaultBeeModifier.java b/src/main/java/forestry/api/apiculture/DefaultBeeModifier.java
new file mode 100644
index 000000000..69c7f7194
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/DefaultBeeModifier.java
@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+/**
+ * Easily extendable default IBeeModifier.
+ * By itself, this IBeeModifier does nothing.
+ * BeeModifiers should inherit from this class unless they modify everything.
+ */
+public class DefaultBeeModifier implements IBeeModifier {
+
+ @Override
+ public float getTerritoryModifier(IBeeGenome genome, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public float getMutationModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public float getLifespanModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public float getProductionModifier(IBeeGenome genome, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public float getFloweringModifier(IBeeGenome genome, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public float getGeneticDecay(IBeeGenome genome, float currentModifier) {
+ return 1.0f;
+ }
+
+ @Override
+ public boolean isSealed() {
+ return false;
+ }
+
+ @Override
+ public boolean isSelfLighted() {
+ return false;
+ }
+
+ @Override
+ public boolean isSunlightSimulated() {
+ return false;
+ }
+
+ @Override
+ public boolean isHellish() {
+ return false;
+ }
+
+}
diff --git a/src/main/java/forestry/api/apiculture/EnumBeeChromosome.java b/src/main/java/forestry/api/apiculture/EnumBeeChromosome.java
new file mode 100644
index 000000000..d23b0f5d7
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/EnumBeeChromosome.java
@@ -0,0 +1,104 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.Locale;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IAlleleArea;
+import forestry.api.genetics.IAlleleBoolean;
+import forestry.api.genetics.IAlleleFloat;
+import forestry.api.genetics.IAlleleFlowers;
+import forestry.api.genetics.IAlleleInteger;
+import forestry.api.genetics.IAlleleTolerance;
+import forestry.api.genetics.IChromosomeType;
+import forestry.api.genetics.ISpeciesRoot;
+
+/**
+ * Enum representing the order of chromosomes in a bee's genome and what they control.
+ *
+ * @author SirSengir
+ */
+public enum EnumBeeChromosome implements IChromosomeType {
+ /**
+ * Species of the bee. Alleles here must implement {@link IAlleleBeeSpecies}.
+ */
+ SPECIES(IAlleleBeeSpecies.class),
+ /**
+ * (Production) Speed of the bee.
+ */
+ SPEED(IAlleleFloat.class),
+ /**
+ * Lifespan of the bee.
+ */
+ LIFESPAN(IAlleleInteger.class),
+ /**
+ * Fertility of the bee. Determines number of offspring.
+ */
+ FERTILITY(IAlleleInteger.class),
+ /**
+ * Temperature difference to its native supported one the bee can tolerate.
+ */
+ TEMPERATURE_TOLERANCE(IAlleleTolerance.class),
+ /**
+ * Slightly incorrectly named. If true, a naturally dirunal bee can work during the night. If true, a naturally nocturnal bee can work during the day.
+ */
+ NOCTURNAL(IAlleleBoolean.class),
+ /**
+ * Not used / superseded by fixed values for the species. Probably going to be replaced with a boolean for FIRE_RESIST.
+ */
+ @Deprecated
+ HUMIDITY(IAllele.class),
+ /**
+ * Humidity difference to its native supported one the bee can tolerate.
+ */
+ HUMIDITY_TOLERANCE(IAlleleTolerance.class),
+ /**
+ * If true the bee can work during rain.
+ */
+ TOLERANT_FLYER(IAlleleBoolean.class),
+ /**
+ * If true, the bee can work without a clear view of the sky.
+ */
+ CAVE_DWELLING(IAlleleBoolean.class),
+ /**
+ * Contains the supported flower provider.
+ */
+ FLOWER_PROVIDER(IAlleleFlowers.class),
+ /**
+ * Determines pollination speed.
+ */
+ FLOWERING(IAlleleInteger.class),
+ /**
+ * Determines the size of the bee's territory.
+ */
+ TERRITORY(IAlleleArea.class),
+ /**
+ * Determines the bee's effect.
+ */
+ EFFECT(IAlleleBeeEffect.class);
+
+ Class extends IAllele> clss;
+
+ EnumBeeChromosome(Class extends IAllele> clss) {
+ this.clss = clss;
+ }
+
+ @Override
+ public Class extends IAllele> getAlleleClass() {
+ return clss;
+ }
+
+ @Override
+ public String getName() {
+ return this.toString().toLowerCase(Locale.ENGLISH);
+ }
+
+ @Override
+ public ISpeciesRoot getSpeciesRoot() {
+ return BeeManager.beeRoot;
+ }
+}
diff --git a/src/main/java/forestry/api/apiculture/EnumBeeType.java b/src/main/java/forestry/api/apiculture/EnumBeeType.java
new file mode 100644
index 000000000..c1b6244a1
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/EnumBeeType.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.Locale;
+
+import forestry.api.genetics.ISpeciesType;
+
+public enum EnumBeeType implements ISpeciesType {
+ DRONE, PRINCESS, QUEEN, LARVAE, NONE;
+
+ public static final EnumBeeType[] VALUES = values();
+
+ String name;
+
+ EnumBeeType() {
+ this.name = this.toString().toLowerCase(Locale.ENGLISH);
+ }
+
+ public String getName() {
+ return name;
+ }
+}
diff --git a/src/main/java/forestry/api/apiculture/FlowerManager.java b/src/main/java/forestry/api/apiculture/FlowerManager.java
new file mode 100644
index 000000000..2acaf61de
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/FlowerManager.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.ArrayList;
+
+import net.minecraft.item.ItemStack;
+
+import forestry.api.genetics.IFlowerRegistry;
+
+public class FlowerManager {
+ /**
+ *
e.g. FlowerManager.flowerRegister.registerPlantableFlower(new ItemStack(Blocks.red_flower), 1.0, FlowerManager.FlowerTypeVanilla, FlowerManager.FlowerTypeSnow);
+ */
+ public static IFlowerRegistry flowerRegistry;
+
+ public static final String FlowerTypeVanilla = "flowersVanilla";
+ public static final String FlowerTypeNether = "flowersNether";
+ public static final String FlowerTypeCacti = "flowersCacti";
+ public static final String FlowerTypeMushrooms = "flowersMushrooms";
+ public static final String FlowerTypeEnd = "flowersEnd";
+ public static final String FlowerTypeJungle = "flowersJungle";
+ public static final String FlowerTypeSnow = "flowersSnow";
+ public static final String FlowerTypeWheat = "flowersWheat";
+ public static final String FlowerTypeGourd = "flowersGourd";
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IAlleleBeeEffect.java b/src/main/java/forestry/api/apiculture/IAlleleBeeEffect.java
new file mode 100644
index 000000000..b2dddb319
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IAlleleBeeEffect.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IAlleleEffect;
+import forestry.api.genetics.IEffectData;
+
+public interface IAlleleBeeEffect extends IAlleleEffect {
+
+ /**
+ * Called by apiaries to cause an effect in the world.
+ *
+ * @param genome
+ * Genome of the bee queen causing this effect
+ * @param storedData
+ * Object containing the stored effect data for the apiary/hive the bee is in.
+ * @param housing {@link IBeeHousing} the bee currently resides in.
+ * @return storedData, may have been manipulated.
+ */
+ IEffectData doEffect(IBeeGenome genome, IEffectData storedData, IBeeHousing housing);
+
+ /**
+ * Is called to produce bee effects.
+ *
+ * @param genome
+ * @param storedData
+ * Object containing the stored effect data for the apiary/hive the bee is in.
+ * @param housing {@link IBeeHousing} the bee currently resides in.
+ * @return storedData, may have been manipulated.
+ */
+ IEffectData doFX(IBeeGenome genome, IEffectData storedData, IBeeHousing housing);
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IAlleleBeeSpecies.java b/src/main/java/forestry/api/apiculture/IAlleleBeeSpecies.java
new file mode 100644
index 000000000..b1d198421
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IAlleleBeeSpecies.java
@@ -0,0 +1,55 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.Map;
+
+import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+import forestry.api.genetics.IAlleleSpecies;
+
+public interface IAlleleBeeSpecies extends IAlleleSpecies {
+
+ /**
+ * @return the IBeeRoot
+ */
+ @Override
+ IBeeRoot getRoot();
+
+ /**
+ * @return true if this species is only active at night.
+ */
+ boolean isNocturnal();
+
+ /**
+ * @return Map of possible products with the chance for drop each bee cycle. (0 - 1]
+ */
+ Map getProductChances();
+
+ /**
+ * @return Map of possible specialities with the chance for drop each bee cycle. (0 - 1]
+ */
+ Map getSpecialtyChances();
+
+ /**
+ * Only jubilant bees produce specialities.
+ * @return true if the bee is jubilant, false otherwise.
+ */
+ boolean isJubilant(IBeeGenome genome, IBeeHousing housing);
+
+ @SideOnly(Side.CLIENT)
+ ModelResourceLocation getModel(EnumBeeType type);
+
+ /**
+ * @deprecated since Forestry 3.6.
+ * @return Path of the texture to use for entity rendering.
+ */
+ @Deprecated
+ String getEntityTexture();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IAlleleBeeSpeciesCustom.java b/src/main/java/forestry/api/apiculture/IAlleleBeeSpeciesCustom.java
new file mode 100644
index 000000000..9f7de5a51
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IAlleleBeeSpeciesCustom.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.item.ItemStack;
+
+import forestry.api.genetics.IAlleleSpeciesCustom;
+
+public interface IAlleleBeeSpeciesCustom extends IAlleleBeeSpecies, IAlleleSpeciesCustom {
+
+ /**
+ * Add a product for this bee species.
+ * Chance is between 0 and 1.
+ */
+ IAlleleBeeSpeciesCustom addProduct(ItemStack product, Float chance);
+
+ /**
+ * Add a specialty product for this bee species.
+ * Bees only produce their specialty when they are Jubilant (see IJubilanceProvider)
+ * Chance is between 0 and 1.
+ */
+ IAlleleBeeSpeciesCustom addSpecialty(ItemStack specialty, Float chance);
+
+ /**
+ * Set the Jubilance Provider for this bee species.
+ * Bees only produce their specialty when they are Jubilant (see IJubilanceProvider)
+ */
+ IAlleleBeeSpeciesCustom setJubilanceProvider(IJubilanceProvider provider);
+
+ /**
+ * Make this species only active at night.
+ */
+ IAlleleBeeSpeciesCustom setNocturnal();
+
+ /** Use this if you have custom icons for bees. */
+ IAlleleBeeSpeciesCustom setCustomBeeModelProvider(IBeeModelProvider beeIconProvider);
+
+ /** Use this if you have custom icon colours for bees (other than the default static primary + secondary colours). */
+ IAlleleBeeSpeciesCustom setCustomBeeSpriteColourProvider(IBeeSpriteColourProvider beeIconColourProvider);
+}
diff --git a/src/main/java/forestry/api/apiculture/IApiaristTracker.java b/src/main/java/forestry/api/apiculture/IApiaristTracker.java
new file mode 100644
index 000000000..0c65f56be
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IApiaristTracker.java
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IBreedingTracker;
+import forestry.api.genetics.IIndividual;
+
+/**
+ * Can be used to garner information on bee breeding. See {@link forestry.api.genetics.ISpeciesRoot} for retrieval functions.
+ *
+ * @author SirSengir
+ */
+public interface IApiaristTracker extends IBreedingTracker {
+
+ /**
+ * Register the birth of a queen. Will mark species as discovered.
+ *
+ * @param queen
+ * Created queen.
+ */
+ void registerQueen(IIndividual queen);
+
+ /**
+ * @return Amount of queens bred with this tracker.
+ */
+ int getQueenCount();
+
+ /**
+ * Register the birth of a princess. Will mark species as discovered.
+ *
+ * @param princess
+ * Created princess.
+ */
+ void registerPrincess(IIndividual princess);
+
+ /**
+ * @return Amount of princesses bred with this tracker.
+ */
+ int getPrincessCount();
+
+ /**
+ * Register the birth of a drone. Will mark species as discovered.
+ *
+ * @param drone
+ * Created drone.
+ */
+ void registerDrone(IIndividual drone);
+
+ /**
+ * @return Amount of drones bred with this tracker.
+ */
+ int getDroneCount();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IArmorApiarist.java b/src/main/java/forestry/api/apiculture/IArmorApiarist.java
new file mode 100644
index 000000000..ef87163ef
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IArmorApiarist.java
@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.entity.EntityLivingBase;
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+
+/**
+ * When implemented by armor piece items, allows them to act as apiarist's armor.
+ */
+public interface IArmorApiarist {
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ *
+ * @param entity Entity being attacked
+ * @param armor Armor item
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return Whether or not the armor should protect the player from that attack
+ */
+ boolean protectEntity(EntityLivingBase entity, ItemStack armor, String cause, boolean doProtect);
+
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ *
+ * @param player Player being attacked
+ * @param armor Armor item
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return Whether or not the armor should protect the player from that attack
+ * @deprecated since Forestry 4.2. Use protectEntity
+ */
+ @Deprecated
+ public boolean protectPlayer(EntityPlayer player, ItemStack armor, String cause, boolean doProtect);
+}
diff --git a/src/main/java/forestry/api/apiculture/IArmorApiaristHelper.java b/src/main/java/forestry/api/apiculture/IArmorApiaristHelper.java
new file mode 100644
index 000000000..b0f652f0d
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IArmorApiaristHelper.java
@@ -0,0 +1,62 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.entity.EntityLivingBase;
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+
+/**
+ * Helper class for checking whether an entity is wearing Apiarist Armor
+ *
+ * @author Vexatos
+ */
+public interface IArmorApiaristHelper {
+
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ * @param stack ItemStack to check
+ * @param entity Entity being attacked
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return Whether or not the item is valid Apiarist Armor and should protect the player from that attack
+ * @since Forestry 4.2
+ */
+ boolean isArmorApiarist(ItemStack stack, EntityLivingBase entity, String cause, boolean doProtect);
+
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ * @param entity Entity being attacked
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return The number of valid Apiarist Armor pieces the player is wearing that are actually protecting
+ * @since Forestry 4.2
+ */
+ int wearsItems(EntityLivingBase entity, String cause, boolean doProtect);
+
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ * @param stack ItemStack to check
+ * @param player Player being attacked
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return Whether or not the item is valid Apiarist Armor and should protect the player from that attack
+ * @deprecated since Forestry 4.2. use the EntityLivingBase version
+ */
+ @Deprecated
+ boolean isArmorApiarist(ItemStack stack, EntityPlayer player, String cause, boolean doProtect);
+
+ /**
+ * Called when the apiarist's armor acts as protection against an attack.
+ * @param player Player being attacked
+ * @param cause Optional cause of attack, such as a bee effect identifier
+ * @param doProtect Whether or not to actually do the side effects of protection
+ * @return The number of valid Apiarist Armor pieces the player is wearing that are actually protecting
+ * @deprecated since Forestry 4.2. use the EntityLivingBase version
+ */
+ @Deprecated
+ int wearsItems(EntityPlayer player, String cause, boolean doProtect);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBee.java b/src/main/java/forestry/api/apiculture/IBee.java
new file mode 100644
index 000000000..7b65a40bc
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBee.java
@@ -0,0 +1,88 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.List;
+import java.util.Set;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.biome.BiomeGenBase;
+
+import forestry.api.core.IErrorState;
+import forestry.api.genetics.IEffectData;
+import forestry.api.genetics.IIndividual;
+import forestry.api.genetics.IIndividualLiving;
+
+/**
+ * Other implementations than Forestry's default one are not supported.
+ *
+ * @author SirSengir
+ */
+public interface IBee extends IIndividualLiving {
+
+ /**
+ * @return Bee's genetic information.
+ */
+ @Override
+ IBeeGenome getGenome();
+
+ /**
+ * @return Genetic information of the bee's mate, null if unmated.
+ */
+ @Override
+ IBeeGenome getMate();
+
+ /**
+ * @return true if the individual is originally of natural origin.
+ */
+ boolean isNatural();
+
+ /**
+ * @return generation this individual is removed from the original individual.
+ */
+ int getGeneration();
+
+ /**
+ * Set the natural flag on this bee.
+ * @param flag
+ */
+ void setIsNatural(boolean flag);
+
+ IEffectData[] doEffect(IEffectData[] storedData, IBeeHousing housing);
+
+ IEffectData[] doFX(IEffectData[] storedData, IBeeHousing housing);
+
+ /**
+ * @return true if the bee may spawn offspring
+ */
+ boolean canSpawn();
+
+ /**
+ * Determines whether the queen can work.
+ * @param housing the {@link IBeeHousing} the bee currently resides in.
+ * @return an empty set if the queen can work, a set of error states if the queen can not work
+ */
+ Set getCanWork(IBeeHousing housing);
+
+ List getSuitableBiomes();
+
+ ItemStack[] getProduceList();
+
+ ItemStack[] getSpecialtyList();
+
+ ItemStack[] produceStacks(IBeeHousing housing);
+
+ IBee spawnPrincess(IBeeHousing housing);
+
+ IBee[] spawnDrones(IBeeHousing housing);
+
+ void plantFlowerRandom(IBeeHousing housing);
+
+ IIndividual retrievePollen(IBeeHousing housing);
+
+ boolean pollinateRandom(IBeeHousing housing, IIndividual pollen);
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeFactory.java b/src/main/java/forestry/api/apiculture/IBeeFactory.java
new file mode 100644
index 000000000..c164731ce
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeFactory.java
@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IClassification;
+
+public interface IBeeFactory {
+
+ /**
+ * Creates a new bee species.
+ * Automatically registered with AlleleManager.alleleRegistry.registerAllele()
+ * See IAlleleBeeSpeciesCustom and IAlleleSpeciesCustom for adding additional properties to the returned species.
+ *
+ * @param uid Unique Identifier for this species
+ * @param dominant Whether this species is genetically dominant (false means it is recessive)
+ * @param authority Authority for the binomial name, e.g. "Sengir" on species of base Forestry.
+ * @param unlocalizedName Unlocalized name for this species
+ * @param unlocalizedDescription Unlocalized description for this species
+ * @param branch Classification of this species
+ * @param binomial Binomial name of the species sans genus ("Apis"). "humboldti" will have the bee species flavour name be "Apis humboldti". Feel free to use fun names or null.
+ * @param primaryColor The outline color of this species
+ * @param secondaryColor The body color of this species
+ * @return a new bee species allele.
+ */
+ IAlleleBeeSpeciesCustom createSpecies(String uid, boolean dominant, String authority, String unlocalizedName, String unlocalizedDescription, IClassification branch, String binomial, int primaryColor, int secondaryColor);
+
+ /**
+ * Creates a new bee branch.
+ * Must be registered with AlleleManager.alleleRegistry.getClassification("family.apidae").addMemberGroup();
+ *
+ * @param uid Unique Identifier for this branch
+ * @param scientific approximates a "genus" in real life. Real life examples: "Micrapis", "Megapis"
+ * @return a new bee branch
+ */
+ IClassification createBranch(String uid, String scientific);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeGenome.java b/src/main/java/forestry/api/apiculture/IBeeGenome.java
new file mode 100644
index 000000000..f759fc72e
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeGenome.java
@@ -0,0 +1,50 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.EnumTolerance;
+import forestry.api.genetics.IFlowerProvider;
+import forestry.api.genetics.IGenome;
+
+/**
+ * Only the default implementation is supported.
+ *
+ * @author SirSengir
+ *
+ */
+public interface IBeeGenome extends IGenome {
+
+ @Override
+ IAlleleBeeSpecies getPrimary();
+
+ @Override
+ IAlleleBeeSpecies getSecondary();
+
+ float getSpeed();
+
+ int getLifespan();
+
+ int getFertility();
+
+ EnumTolerance getToleranceTemp();
+
+ EnumTolerance getToleranceHumid();
+
+ boolean getNocturnal();
+
+ boolean getTolerantFlyer();
+
+ boolean getCaveDwelling();
+
+ IFlowerProvider getFlowerProvider();
+
+ int getFlowering();
+
+ int[] getTerritory();
+
+ IAlleleBeeEffect getEffect();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeHousing.java b/src/main/java/forestry/api/apiculture/IBeeHousing.java
new file mode 100644
index 000000000..520a57243
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeHousing.java
@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.util.Vec3;
+import net.minecraft.world.World;
+import net.minecraft.world.biome.BiomeGenBase;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+import forestry.api.core.IErrorLogicSource;
+import forestry.api.genetics.IHousing;
+
+public interface IBeeHousing extends IHousing, IErrorLogicSource {
+
+ /**
+ * Used by BeeManager.beeRoot.createBeeHousingModifier(IBeeHousing housing)
+ * to combine bee modifiers from several sources that can change over time.
+ * @return IBeeModifiers from the housing, frames, etc.
+ */
+ Iterable getBeeModifiers();
+
+ /**
+ * Used by BeeManager.beeRoot.createBeeHousingListener(IBeeHousing housing)
+ * to combine bee listeners from several sources that can change over time.
+ * @return IBeeListeners from the housing, multiblock parts, etc.
+ */
+ Iterable getBeeListeners();
+
+ IBeeHousingInventory getBeeInventory();
+ IBeekeepingLogic getBeekeepingLogic();
+
+ EnumTemperature getTemperature();
+ EnumHumidity getHumidity();
+ int getBlockLightValue();
+ boolean canBlockSeeTheSky();
+
+ World getWorld();
+ BiomeGenBase getBiome();
+ GameProfile getOwner();
+
+ /**
+ * @since Forestry 4.2
+ * @return exact coordinates where bee FX should spawn from
+ */
+ Vec3 getBeeFXCoordinates();
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeHousingInventory.java b/src/main/java/forestry/api/apiculture/IBeeHousingInventory.java
new file mode 100644
index 000000000..c579a19f7
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeHousingInventory.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.item.ItemStack;
+
+public interface IBeeHousingInventory {
+
+ ItemStack getQueen();
+ ItemStack getDrone();
+
+ void setQueen(ItemStack itemstack);
+ void setDrone(ItemStack itemstack);
+
+ /**
+ * Adds products to the housing's inventory.
+ *
+ * @param product ItemStack with the product to add.
+ * @param all if true, success requires that all products are added
+ * @return boolean indicating success or failure.
+ */
+ boolean addProduct(ItemStack product, boolean all);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeListener.java b/src/main/java/forestry/api/apiculture/IBeeListener.java
new file mode 100644
index 000000000..eaab40af2
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeListener.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IIndividual;
+
+public interface IBeeListener {
+
+ /**
+ * Called when the bees wear out the housing's equipment.
+ * @param amount Integer indicating the amount worn out.
+ */
+ void wearOutEquipment(int amount);
+
+ /**
+ * Called after the children have been spawned, and before the new princess is spawned.
+ */
+ void onQueenDeath();
+
+ /**
+ * Called when the bees have retrieved some pollen.
+ * @return true if this bee listener handled the pollen.
+ */
+ boolean onPollenRetrieved(IIndividual pollen);
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeModelProvider.java b/src/main/java/forestry/api/apiculture/IBeeModelProvider.java
new file mode 100644
index 000000000..1bab611ba
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeModelProvider.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.core.IModelManager;
+import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraft.item.Item;
+
+public interface IBeeModelProvider {
+ void registerModels(Item item, IModelManager manager);
+ ModelResourceLocation getModel(EnumBeeType type);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeModifier.java b/src/main/java/forestry/api/apiculture/IBeeModifier.java
new file mode 100644
index 000000000..134f441d2
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeModifier.java
@@ -0,0 +1,70 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+public interface IBeeModifier {
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @param currentModifier Current modifier.
+ * @return Float used to modify the base territory.
+ */
+ float getTerritoryModifier(IBeeGenome genome, float currentModifier);
+
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @param mate Genome of the bee mate this modifier is called for.
+ * @param currentModifier Current modifier.
+ * @return Float used to modify the base mutation chance.
+ */
+ float getMutationModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier);
+
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @param currentModifier Current modifier.
+ * @return Float used to modify the life span of queens.
+ */
+ float getLifespanModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier);
+
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @param currentModifier Current modifier.
+ * @return Float modifying the production speed of queens.
+ */
+ float getProductionModifier(IBeeGenome genome, float currentModifier);
+
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @return Float modifying the flowering of queens.
+ */
+ float getFloweringModifier(IBeeGenome genome, float currentModifier);
+
+ /**
+ * @param genome Genome of the bee this modifier is called for.
+ * @return Float modifying the chance for a swarmer queen to die off.
+ */
+ float getGeneticDecay(IBeeGenome genome, float currentModifier);
+
+ /**
+ * @return Boolean indicating if housing can ignore rain
+ */
+ boolean isSealed();
+
+ /**
+ * @return Boolean indicating if housing can ignore darkness/night
+ */
+ boolean isSelfLighted();
+
+ /**
+ * @return Boolean indicating if housing can ignore not seeing the sky
+ */
+ boolean isSunlightSimulated();
+
+ /**
+ * @return Boolean indicating whether this housing simulates the nether
+ */
+ boolean isHellish();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeMutation.java b/src/main/java/forestry/api/apiculture/IBeeMutation.java
new file mode 100644
index 000000000..ead92f84d
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeMutation.java
@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IMutation;
+
+public interface IBeeMutation extends IMutation {
+
+ @Override
+ IBeeRoot getRoot();
+
+ /**
+ * @return float representing the chance for mutation to occur. note that this is 0 - 100 based, since it was an integer previously!
+ */
+ float getChance(IBeeHousing housing, IAlleleBeeSpecies allele0, IAlleleBeeSpecies allele1, IBeeGenome genome0, IBeeGenome genome1);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeMutationCustom.java b/src/main/java/forestry/api/apiculture/IBeeMutationCustom.java
new file mode 100644
index 000000000..d97a839a1
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeMutationCustom.java
@@ -0,0 +1,12 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IMutationCustom;
+
+public interface IBeeMutationCustom extends IBeeMutation, IMutationCustom {
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeMutationFactory.java b/src/main/java/forestry/api/apiculture/IBeeMutationFactory.java
new file mode 100644
index 000000000..315a4c6f1
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeMutationFactory.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import forestry.api.genetics.IAllele;
+
+public interface IBeeMutationFactory {
+ /**
+ * Creates a new bee mutation.
+ * Automatically registered with BeeManager.beeRoot.registerMutation()
+ * See IBeeMutationCustom and IMutationCustom for adding additional properties to the returned mutation.
+ *
+ * @param parentBee0 A parent bee for this mutation
+ * @param parentBee1 A parent bee for this mutation
+ * @param result The resulting alleles for this mutation
+ * @param chance The chance that breeding the two parent bees will result in this mutation
+ * @return a new bee mutation.
+ */
+ IBeeMutationCustom createMutation(IAlleleBeeSpecies parentBee0, IAlleleBeeSpecies parentBee1, IAllele[] result, int chance);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeRoot.java b/src/main/java/forestry/api/apiculture/IBeeRoot.java
new file mode 100644
index 000000000..3621fb50c
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeRoot.java
@@ -0,0 +1,133 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.world.World;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.ISpeciesRoot;
+
+public interface IBeeRoot extends ISpeciesRoot {
+
+ /**
+ * @return true if passed item is a Forestry bee. Equal to getType(ItemStack stack) != EnumBeeType.NONE
+ */
+ @Override
+ boolean isMember(ItemStack stack);
+
+ /**
+ * @return {@link IBee} pattern parsed from the passed stack's nbt data.
+ */
+ @Override
+ IBee getMember(ItemStack stack);
+
+ @Override
+ IBee getMember(NBTTagCompound compound);
+
+ /* GENOME CONVERSION */
+ @Override
+ IBee templateAsIndividual(IAllele[] template);
+
+ @Override
+ IBee templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive);
+
+ @Override
+ IBeeGenome templateAsGenome(IAllele[] template);
+
+ @Override
+ IBeeGenome templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive);
+
+ /* BREEDING TRACKER */
+ /**
+ * @param world
+ * @return {@link IApiaristTracker} associated with the passed world.
+ */
+ @Override
+ IApiaristTracker getBreedingTracker(World world, GameProfile player);
+
+ /* BEE SPECIFIC */
+ /**
+ * @return type of bee encoded on the itemstack. EnumBeeType.NONE if it isn't a bee.
+ */
+ @Override
+ EnumBeeType getType(ItemStack stack);
+
+ /**
+ * @return true if passed item is a drone. Equal to getType(ItemStack stack) == EnumBeeType.DRONE
+ */
+ boolean isDrone(ItemStack stack);
+
+ /**
+ * @return true if passed item is mated (i.e. a queen)
+ */
+ boolean isMated(ItemStack stack);
+
+ /**
+ * @param genome
+ * Valid {@link IBeeGenome}
+ * @return {@link IBee} from the passed genome
+ */
+ IBee getBee(World world, IBeeGenome genome);
+
+ /**
+ * Creates an IBee suitable for a queen containing the necessary second genome for the mate.
+ *
+ * @param genome
+ * Valid {@link IBeeGenome}
+ * @param mate
+ * Valid {@link IBee} representing the mate.
+ * @return Mated {@link IBee} from the passed genomes.
+ */
+ IBee getBee(World world, IBeeGenome genome, IBee mate);
+
+ /* TEMPLATES */
+ @Override
+ ArrayList getIndividualTemplates();
+
+ /* MUTATIONS */
+ @Override
+ Collection getMutations(boolean shuffle);
+
+ /* GAME MODE */
+ void resetBeekeepingMode();
+
+ ArrayList getBeekeepingModes();
+
+ IBeekeepingMode getBeekeepingMode(World world);
+
+ IBeekeepingMode getBeekeepingMode(String name);
+
+ void registerBeekeepingMode(IBeekeepingMode mode);
+
+ void setBeekeepingMode(World world, String name);
+
+ /* MISC */
+ /**
+ * Creates beekeepingLogic for a housing.
+ * Should be used when the housing is created, see IBeekeepingLogic
+ */
+ IBeekeepingLogic createBeekeepingLogic(IBeeHousing housing);
+
+ /**
+ * Combines multiple modifiers from an IBeeHousing into one.
+ * Stays up to date with changes to the housing's modifiers.
+ */
+ IBeeModifier createBeeHousingModifier(IBeeHousing housing);
+
+ /**
+ * Combines multiple listeners from an IBeeHousing into one.
+ * Stays up to date with changes to the housing's listeners.
+ */
+ IBeeListener createBeeHousingListener(IBeeHousing housing);
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeeSpriteColourProvider.java b/src/main/java/forestry/api/apiculture/IBeeSpriteColourProvider.java
new file mode 100644
index 000000000..72f42ee72
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeeSpriteColourProvider.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+/**
+ * Custom colour provider for bees with complicated colors.
+ */
+public interface IBeeSpriteColourProvider {
+ int getSpriteColour(int renderPass);
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeekeepingLogic.java b/src/main/java/forestry/api/apiculture/IBeekeepingLogic.java
new file mode 100644
index 000000000..d591c4b3c
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeekeepingLogic.java
@@ -0,0 +1,61 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.entity.player.EntityPlayerMP;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * Stores beekeeping logic for bee housings.
+ * Get one with BeeManager.beeRoot.createBeekeepingLogic(IBeeHousing housing)
+ * Save and load it to NBT using the INBTTagable methods.
+ */
+public interface IBeekeepingLogic extends INBTTagable {
+
+ /* SERVER */
+
+ /**
+ * Checks that the bees can work, setting error conditions on the housing where needed
+ * @return true if no errors are present and doWork should be called
+ */
+ boolean canWork();
+
+ /**
+ * Performs actual work, breeding, production, etc.
+ */
+ void doWork();
+
+
+ /* CLIENT */
+
+ /**
+ * Call this when the housing comes into view of the client.
+ * (i.e. when tile.getDescriptionPacket() is called)
+ */
+ void syncToClient();
+ void syncToClient(EntityPlayerMP player);
+
+ /**
+ * Get the progress bar for breeding and production.
+ * To avoid network spam, this is only available server-side,
+ * and must be synced manually to the client when a GUI is open.
+ */
+ int getBeeProgressPercent();
+
+ /**
+ * Whether bee fx should be active.
+ * Internally, this is automatically synced to the client.
+ */
+ boolean canDoBeeFX();
+
+ /**
+ * Display bee fx. Calls IBee.doFX(IEffectData[] storedData, IBeeHousing housing) on the queen.
+ * Internally, the queen is automatically synced to the client for the fx.
+ */
+ void doBeeFX();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/IBeekeepingMode.java b/src/main/java/forestry/api/apiculture/IBeekeepingMode.java
new file mode 100644
index 000000000..b3a469c44
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IBeekeepingMode.java
@@ -0,0 +1,74 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.ArrayList;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IBeekeepingMode {
+
+ /**
+ * @return Localized name of this beekeeping mode.
+ */
+ String getName();
+
+ /**
+ * @return Localized list of strings outlining the behaviour of this beekeeping mode.
+ */
+ ArrayList getDescription();
+
+ /**
+ * @return Float used to modify the wear on comb frames.
+ */
+ float getWearModifier();
+
+ /**
+ * @param queen
+ * @return fertility taking into account the birthing queen and surroundings.
+ */
+ int getFinalFertility(IBee queen, World world, BlockPos pos);
+
+ /**
+ * @param queen
+ * @return true if the queen is genetically "fatigued" and should not be reproduced anymore.
+ */
+ boolean isFatigued(IBee queen, IBeeHousing housing);
+
+ /**
+ * @param queen
+ * @param housing
+ * @return true if the queen is being overworked in the bee housing (with chance). will trigger a negative effect.
+ */
+ boolean isOverworked(IBee queen, IBeeHousing housing);
+
+ /**
+ *
+ * @param queen
+ * @param offspring
+ * @param housing
+ * @return true if the genetic structure of the queen is breaking down during spawning of the offspring (with chance). will trigger a negative effect.
+ */
+ boolean isDegenerating(IBee queen, IBee offspring, IBeeHousing housing);
+
+ /**
+ * @param queen
+ * @return true if an offspring of this queen is considered a natural
+ */
+ boolean isNaturalOffspring(IBee queen);
+
+ /**
+ * @param queen
+ * @return true if this mode allows the passed queen or princess to be multiplied
+ */
+ boolean mayMultiplyPrincess(IBee queen);
+
+ /**
+ * @return the bee modifier for this mode
+ */
+ IBeeModifier getBeeModifier();
+}
diff --git a/src/main/java/forestry/api/apiculture/IHiveDrop.java b/src/main/java/forestry/api/apiculture/IHiveDrop.java
new file mode 100644
index 000000000..151be26d6
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IHiveDrop.java
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+/**
+ * Bees can be seeded either as hive drops or as mutation results.
+ *
+ * Add IHiveDrops with HiveManager.get___Hive.addDrop
+ *
+ * @author SirSengir
+ */
+public interface IHiveDrop {
+
+ ItemStack getPrincess(World world, BlockPos pos, int fortune);
+
+ Collection getDrones(World world, BlockPos pos, int fortune);
+
+ Collection getAdditional(World world, BlockPos pos, int fortune);
+
+ /**
+ * Chance to drop. Default drops have 80 (= 80 %).
+ *
+ * @param world Minecraft world this is called for.
+ * @param pos Coordinates of the broken hive.
+ * @return Chance for drop as an integer of 0 - 100.
+ */
+ int getChance(World world, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/apiculture/IHiveFrame.java b/src/main/java/forestry/api/apiculture/IHiveFrame.java
new file mode 100644
index 000000000..08259cae7
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IHiveFrame.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.item.ItemStack;
+
+public interface IHiveFrame {
+
+ /**
+ * Wears out a frame.
+ *
+ * @param housing IBeeHousing the frame is contained in.
+ * @param frame ItemStack containing the actual frame.
+ * @param queen Current queen in the caller.
+ * @param wear Integer denoting the amount worn out. The wear modifier of the current beekeeping mode has already been taken into account.
+ * @return ItemStack containing the actual frame with adjusted damage, or null if it has been broken.
+ */
+ ItemStack frameUsed(IBeeHousing housing, ItemStack frame, IBee queen, int wear);
+
+ IBeeModifier getBeeModifier();
+}
diff --git a/src/main/java/forestry/api/apiculture/IJubilanceFactory.java b/src/main/java/forestry/api/apiculture/IJubilanceFactory.java
new file mode 100644
index 000000000..1b81a9d06
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IJubilanceFactory.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+import net.minecraft.block.Block;
+
+public interface IJubilanceFactory {
+ /** The default Jubilance Provider is satisfied when the humidity and temperature are ideal for the bee. */
+ IJubilanceProvider getDefault();
+
+ /** The Requires Resource Jubilance Provider is satisfied when a specific block is under the hive. */
+ IJubilanceProvider getRequiresResource(Block block, int meta);
+}
diff --git a/src/main/java/forestry/api/apiculture/IJubilanceProvider.java b/src/main/java/forestry/api/apiculture/IJubilanceProvider.java
new file mode 100644
index 000000000..faf34d05e
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/IJubilanceProvider.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture;
+
+public interface IJubilanceProvider {
+
+ /**
+ * Returns true when conditions are right to make this species Jubilant.
+ * Jubilant bees can produce their Specialty products.
+ */
+ boolean isJubilant(IAlleleBeeSpecies species, IBeeGenome genome, IBeeHousing housing);
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/HiveManager.java b/src/main/java/forestry/api/apiculture/hives/HiveManager.java
new file mode 100644
index 000000000..17ca7d20e
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/HiveManager.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture.hives;
+
+public class HiveManager {
+
+ public static IHiveRegistry hiveRegistry;
+ public static IHiveGenHelper genHelper;
+
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/IHiveDescription.java b/src/main/java/forestry/api/apiculture/hives/IHiveDescription.java
new file mode 100644
index 000000000..52e248b31
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/IHiveDescription.java
@@ -0,0 +1,49 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture.hives;
+
+import net.minecraft.block.Block;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+import net.minecraft.world.biome.BiomeGenBase;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+
+public interface IHiveDescription {
+
+ /**
+ * The hive generator for this hive.
+ */
+ IHiveGen getHiveGen();
+
+ /**
+ * The hive block to be placed in the world.
+ */
+ Block getBlock();
+ int getMeta();
+
+ /**
+ * returns true if the hive can be generated in these conditions.
+ * Used as a fast early-elimination check for hives that have no hope of spawning in the area.
+ */
+ boolean isGoodBiome(BiomeGenBase biome);
+ boolean isGoodHumidity(EnumHumidity humidity);
+ boolean isGoodTemperature(EnumTemperature temperature);
+
+ /**
+ * float representing the relative chance a hive will generate in a chunk.
+ * Default is 1.0, higher numbers result in more hives, smaller will result in fewer.
+ * Tree hives want around 3.0 to 4.0 since there are less locations to generate on.
+ */
+ float getGenChance();
+
+ /**
+ * Called after successful hive generation.
+ * world, x, y, z give the location of the new hive.
+ **/
+ void postGen(World world, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/IHiveGen.java b/src/main/java/forestry/api/apiculture/hives/IHiveGen.java
new file mode 100644
index 000000000..2021b71ae
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/IHiveGen.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture.hives;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IHiveGen {
+
+ /**
+ * return a Y value that the hive should try to generate at.
+ * returns negative if the hive can't be placed anywhere.
+ */
+ int getYForHive(World world, int x, int z);
+
+ /**
+ * returns true if the hive can be generated at this location.
+ * Used for advanced conditions, like checking that the ground below the hive is a certain type.
+ */
+ boolean isValidLocation(World world, BlockPos pos);
+
+ /**
+ * returns true if the hive can safely replace the block at this location.
+ */
+ boolean canReplace(World world, BlockPos pos);
+
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/IHiveGenHelper.java b/src/main/java/forestry/api/apiculture/hives/IHiveGenHelper.java
new file mode 100644
index 000000000..0eb6400cb
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/IHiveGenHelper.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture.hives;
+
+import net.minecraft.block.Block;
+
+public interface IHiveGenHelper {
+
+ /**
+ * Returns a hiveGen for a hive that spawns on the ground.
+ * validGroundBlocks specifies which block materials it can spawn on.
+ */
+ IHiveGen ground(Block... validGroundBlocks);
+
+ /**
+ * Returns a hiveGen for a hive that spawns in trees.
+ */
+ IHiveGen tree();
+
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/IHiveRegistry.java b/src/main/java/forestry/api/apiculture/hives/IHiveRegistry.java
new file mode 100644
index 000000000..68bbea5f7
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/IHiveRegistry.java
@@ -0,0 +1,53 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.apiculture.hives;
+
+import java.util.List;
+
+import forestry.api.apiculture.IHiveDrop;
+import net.minecraft.util.IStringSerializable;
+
+public interface IHiveRegistry {
+
+ /* Forestry Hive Names */
+ public static enum HiveType implements IStringSerializable{
+ FOREST("Forestry:forest"),
+ MEADOWS("Forestry:meadows"),
+ DESERT("Forestry:desert"),
+ JUNGLE("Forestry:jungle"),
+ END("Forestry:end"),
+ SNOW("Forestry:snow"),
+ SWAMP("Forestry:swamp");
+
+ private HiveType(String name) {
+ this.name = name;
+ }
+
+ public String name;
+
+ public String getHiveName()
+ {
+ return name;
+ }
+
+ @Override
+ public String getName() {
+ return name().toLowerCase();
+ }
+
+ }
+
+ /**
+ * Adds a new hive to be generated in the world.
+ */
+ void registerHive(String hiveName, IHiveDescription hiveDescription);
+
+ /**
+ * Add drops to a registered hive.
+ */
+ void addDrops(String hiveName, IHiveDrop... drops);
+ void addDrops(String hiveName, List drop);
+}
diff --git a/src/main/java/forestry/api/apiculture/hives/package-info.java b/src/main/java/forestry/api/apiculture/hives/package-info.java
new file mode 100644
index 000000000..0750c5d17
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/hives/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="4.1.0", owner="ForestryAPI|apiculture", provides="ForestryAPI|hives")
+package forestry.api.apiculture.hives;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/apiculture/package-info.java b/src/main/java/forestry/api/apiculture/package-info.java
new file mode 100644
index 000000000..bde28aea1
--- /dev/null
+++ b/src/main/java/forestry/api/apiculture/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="4.8.0", owner="ForestryAPI|core", provides="ForestryAPI|apiculture")
+package forestry.api.apiculture;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/arboriculture/EnumFruitFamily.java b/src/main/java/forestry/api/arboriculture/EnumFruitFamily.java
new file mode 100644
index 000000000..85a995d90
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumFruitFamily.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.StatCollector;
+
+import forestry.api.genetics.AlleleManager;
+import forestry.api.genetics.IFruitFamily;
+
+public enum EnumFruitFamily implements IFruitFamily {
+ PRUNES("prunes", "Prunus domestica"),
+ POMES("pomes", "Pomum"),
+ JUNGLE("jungle", "Tropicus"),
+ NUX("nuts", "Nux");
+
+ private final String uid;
+ private final String scientific;
+
+ EnumFruitFamily(String uid, String scientific) {
+ this.uid = uid;
+ this.scientific = scientific;
+ AlleleManager.alleleRegistry.registerFruitFamily(this);
+ }
+
+ @Override
+ public String getUID() {
+ return "forestry." + uid;
+ }
+
+ @Override
+ public String getScientific() {
+ return this.scientific;
+ }
+
+ @Override
+ public String getName() {
+ return StatCollector.translateToLocal("for.family." + uid);
+ }
+
+ @Override
+ public String getDescription() {
+ return StatCollector.translateToLocal("for.family." + uid + ".description");
+ }
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/EnumGermlingType.java b/src/main/java/forestry/api/arboriculture/EnumGermlingType.java
new file mode 100644
index 000000000..ead88b1d7
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumGermlingType.java
@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.ISpeciesType;
+
+public enum EnumGermlingType implements ISpeciesType {
+ SAPLING("sapling"), BLOSSOM("blossom"), POLLEN("pollen"), GERMLING("germling"), NONE("none");
+
+ public static final EnumGermlingType[] VALUES = values();
+
+ private final String name;
+
+ EnumGermlingType(String name) {
+ this.name = name;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/EnumGrowthConditions.java b/src/main/java/forestry/api/arboriculture/EnumGrowthConditions.java
new file mode 100644
index 000000000..8b28601c1
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumGrowthConditions.java
@@ -0,0 +1,10 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+public enum EnumGrowthConditions {
+ HOSTILE, PALTRY, NORMAL, GOOD, EXCELLENT
+}
diff --git a/src/main/java/forestry/api/arboriculture/EnumLeafType.java b/src/main/java/forestry/api/arboriculture/EnumLeafType.java
new file mode 100644
index 000000000..472b3555a
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumLeafType.java
@@ -0,0 +1,10 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+public enum EnumLeafType {
+ DECIDUOUS, CONIFERS, JUNGLE, WILLOW, MAPLE, PALM
+}
diff --git a/src/main/java/forestry/api/arboriculture/EnumTreeChromosome.java b/src/main/java/forestry/api/arboriculture/EnumTreeChromosome.java
new file mode 100644
index 000000000..29fcebad3
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumTreeChromosome.java
@@ -0,0 +1,98 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.Locale;
+
+import net.minecraftforge.common.EnumPlantType;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IAlleleArea;
+import forestry.api.genetics.IAlleleBoolean;
+import forestry.api.genetics.IAlleleFloat;
+import forestry.api.genetics.IAlleleInteger;
+import forestry.api.genetics.IAllelePlantType;
+import forestry.api.genetics.IChromosomeType;
+import forestry.api.genetics.IFruitFamily;
+import forestry.api.genetics.ISpeciesRoot;
+
+public enum EnumTreeChromosome implements IChromosomeType {
+
+ /**
+ * Determines the following: - WorldGen, including the used wood blocks - {@link IFruitFamily}s supported. Limits which {@link IFruitProvider}
+ * will actually yield fruit with this species. - Native {@link EnumPlantType} for this tree. Combines with the PLANT chromosome.
+ */
+ SPECIES(IAlleleTreeSpecies.class),
+ /**
+ * {@link IGrowthProvider}, determines conditions required by the tree to grow.
+ */
+ GROWTH(IAlleleGrowth.class),
+ /**
+ * A float modifying the height of the tree. Taken into account at worldgen.
+ */
+ HEIGHT(IAlleleFloat.class),
+ /**
+ * Chance for saplings.
+ */
+ FERTILITY(IAlleleFloat.class),
+ /**
+ * {@link IFruitProvider}, determines if and what fruits are grown on the tree. Limited by the {@link IFruitFamily}s the species supports.
+ */
+ FRUITS(IAlleleFruit.class),
+ /**
+ * Chance for fruit leaves and/or drops.
+ */
+ YIELD(IAlleleFloat.class),
+ /**
+ * May add additional tolerances for {@link EnumPlantTypes}.
+ */
+ PLANT(IAllelePlantType.class),
+ /**
+ * Determines the speed at which fruit will ripen on this tree.
+ */
+ SAPPINESS(IAlleleFloat.class),
+ /**
+ * Territory for leaf effects. Unused.
+ */
+ TERRITORY(IAlleleArea.class),
+ /**
+ * Leaf effect. Unused.
+ */
+ EFFECT(IAlleleLeafEffect.class),
+ /**
+ * Amount of random ticks which need to elapse before a sapling will grow into a tree.
+ */
+ MATURATION(IAlleleInteger.class),
+
+ GIRTH(IAlleleInteger.class),
+ /**
+ * Determines if the tree can burn.
+ */
+ FIREPROOF(IAlleleBoolean.class),
+ ;
+
+ Class extends IAllele> clss;
+
+ EnumTreeChromosome(Class extends IAllele> clss) {
+ this.clss = clss;
+ }
+
+ @Override
+ public Class extends IAllele> getAlleleClass() {
+ return clss;
+ }
+
+ @Override
+ public String getName() {
+ return this.toString().toLowerCase(Locale.ENGLISH);
+ }
+
+ @Override
+ public ISpeciesRoot getSpeciesRoot() {
+ return TreeManager.treeRoot;
+ }
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/EnumWoodType.java b/src/main/java/forestry/api/arboriculture/EnumWoodType.java
new file mode 100644
index 000000000..57b291166
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/EnumWoodType.java
@@ -0,0 +1,55 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.Locale;
+import java.util.Random;
+
+import net.minecraft.block.properties.PropertyEnum;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.util.IStringSerializable;
+
+public enum EnumWoodType implements IStringSerializable {
+ LARCH, TEAK, ACACIA, LIME, CHESTNUT,
+ WENGE, BAOBAB, SEQUOIA(4.0f), KAPOK, EBONY,
+ MAHOGANY, BALSA(1.0f), WILLOW, WALNUT, GREENHEART(7.5f),
+ CHERRY, MAHOE, POPLAR, PALM, PAPAYA,
+ PINE(3.0f), PLUM, MAPLE, CITRUS, GIGANTEUM,
+ IPE, PADAUK, COCOBOLO, ZEBRAWOOD;
+
+ public static final PropertyEnum WOODTYPE = PropertyEnum.create("woodtype", EnumWoodType.class);
+
+ public static final float DEFAULT_HARDNESS = 2.0f;
+ public static final EnumWoodType[] VALUES = values();
+
+ private final float hardness;
+
+ EnumWoodType() {
+ this.hardness = DEFAULT_HARDNESS;
+ }
+
+ EnumWoodType(float hardness) {
+ this.hardness = hardness;
+ }
+
+ public float getHardness() {
+ return hardness;
+ }
+
+ public static EnumWoodType getRandom(Random random) {
+ return VALUES[random.nextInt(VALUES.length)];
+ }
+
+ @Override
+ public String toString() {
+ return super.toString().toLowerCase(Locale.ENGLISH);
+ }
+
+ @Override
+ public String getName() {
+ return toString();
+ }
+}
diff --git a/src/main/java/forestry/api/arboriculture/IAlleleFruit.java b/src/main/java/forestry/api/arboriculture/IAlleleFruit.java
new file mode 100644
index 000000000..4fee1c62a
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IAlleleFruit.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.IAllele;
+
+/**
+ * Simple allele encapsulating an {@link IFruitProvider}.
+ */
+public interface IAlleleFruit extends IAllele, Comparable {
+
+ IFruitProvider getProvider();
+
+ String getModelName();
+
+ String getModID();
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IAlleleGrowth.java b/src/main/java/forestry/api/arboriculture/IAlleleGrowth.java
new file mode 100644
index 000000000..6cb4b4389
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IAlleleGrowth.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.IAllele;
+
+/**
+ * Simple allele encapsulating an {@link IGrowthProvider}.
+ */
+public interface IAlleleGrowth extends IAllele {
+
+ IGrowthProvider getProvider();
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IAlleleLeafEffect.java b/src/main/java/forestry/api/arboriculture/IAlleleLeafEffect.java
new file mode 100644
index 000000000..2fe4bd054
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IAlleleLeafEffect.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+import forestry.api.genetics.IAlleleEffect;
+import forestry.api.genetics.IEffectData;
+
+/**
+ * Simple allele encapsulating a leaf effect. (Not implemented)
+ */
+public interface IAlleleLeafEffect extends IAlleleEffect {
+
+ IEffectData doEffect(ITreeGenome genome, IEffectData storedData, World world, BlockPos pos);
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IAlleleTreeSpecies.java b/src/main/java/forestry/api/arboriculture/IAlleleTreeSpecies.java
new file mode 100644
index 000000000..daa8c8a84
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IAlleleTreeSpecies.java
@@ -0,0 +1,64 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.Collection;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraftforge.common.EnumPlantType;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+import forestry.api.core.IModelManager;
+import forestry.api.genetics.IAlleleSpecies;
+import forestry.api.genetics.IFruitFamily;
+
+public interface IAlleleTreeSpecies extends IAlleleSpecies, Comparable {
+
+ @Override
+ ITreeRoot getRoot();
+
+ /**
+ * @return Native plant type of this species.
+ */
+ EnumPlantType getPlantType();
+
+ /**
+ * @return List of all {@link IFruitFamily}s which can grow on leaves generated by this species.
+ */
+ Collection getSuitableFruit();
+
+ /**
+ * @return Tree generator for this species.
+ */
+ ITreeGenerator getGenerator();
+
+ /**
+ * @return The ModID from the mod.
+ */
+ String getModID();
+
+ /**
+ * @return The name of the model from the tree.
+ */
+ String getModelName();
+
+ /* TEXTURES AND OVERRIDES */
+ int getLeafColour(boolean pollinated);
+
+ @SideOnly(Side.CLIENT)
+ TextureAtlasSprite getLeafSprite(boolean pollinated, boolean fancy);
+
+ @SideOnly(Side.CLIENT)
+ ModelResourceLocation getGermlingModel(EnumGermlingType type);
+
+ @SideOnly(Side.CLIENT)
+ void registerModels(IModelManager manager);
+
+ @SideOnly(Side.CLIENT)
+ int getGermlingColour(EnumGermlingType type, int renderPass);
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IAlleleTreeSpeciesCustom.java b/src/main/java/forestry/api/arboriculture/IAlleleTreeSpeciesCustom.java
new file mode 100644
index 000000000..d5bf25b7e
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IAlleleTreeSpeciesCustom.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraftforge.common.EnumPlantType;
+
+import forestry.api.genetics.IAlleleSpeciesCustom;
+import forestry.api.genetics.IFruitFamily;
+
+public interface IAlleleTreeSpeciesCustom extends IAlleleSpeciesCustom, IAlleleTreeSpecies {
+
+ /** Add a fruit family for this tree. Trees can have multiple fruit families. */
+ IAlleleTreeSpeciesCustom addFruitFamily(IFruitFamily family);
+
+ /** Set the minecraft plant type for this tree. Default is Plains. */
+ IAlleleTreeSpeciesCustom setPlantType(EnumPlantType type);
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IArboristTracker.java b/src/main/java/forestry/api/arboriculture/IArboristTracker.java
new file mode 100644
index 000000000..9777e8763
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IArboristTracker.java
@@ -0,0 +1,12 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.IBreedingTracker;
+
+public interface IArboristTracker extends IBreedingTracker {
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IFruitProvider.java b/src/main/java/forestry/api/arboriculture/IFruitProvider.java
new file mode 100644
index 000000000..ff5916c85
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IFruitProvider.java
@@ -0,0 +1,73 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.IBlockAccess;
+import net.minecraft.world.World;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+import forestry.api.core.ITextureManager;
+import forestry.api.genetics.IFruitFamily;
+
+public interface IFruitProvider {
+
+ IFruitFamily getFamily();
+
+ int getColour(ITreeGenome genome, IBlockAccess world, BlockPos pos, int ripeningTime);
+
+ boolean markAsFruitLeaf(ITreeGenome genome, World world, BlockPos pos);
+
+ int getRipeningPeriod();
+
+ // / Products, Chance
+ ItemStack[] getProducts();
+
+ // / Specialty, Chance
+ ItemStack[] getSpecialty();
+
+ ItemStack[] getFruits(ITreeGenome genome, World world, BlockPos pos, int ripeningTime);
+
+ /**
+ * @return Short, human-readable identifier used in the treealyzer.
+ */
+ String getDescription();
+
+ String getModelName();
+
+ String getModID();
+
+ /* TEXTURE OVERLAY */
+ /**
+ * @param genome
+ * @param world
+ * @param pos
+ * @param ripeningTime
+ * Elapsed ripening time for the fruit.
+ * @param fancy
+ * @return IIcon index of the texture to overlay on the leaf block.
+ */
+ short getSpriteIndex(ITreeGenome genome, IBlockAccess world, BlockPos pos, int ripeningTime, boolean fancy);
+
+ /**
+ * @return true if this fruit provider requires fruit blocks to spawn, false otherwise.
+ */
+ boolean requiresFruitBlocks();
+
+ /**
+ * Tries to spawn a fruit block at the potential position when the tree generates.
+ *
+ * @param genome
+ * @param world
+ * @param pos
+ * @return true if a fruit block was spawned, false otherwise.
+ */
+ boolean trySpawnFruitBlock(ITreeGenome genome, World world, BlockPos pos);
+
+ @SideOnly(Side.CLIENT)
+ void registerSprites();
+}
diff --git a/src/main/java/forestry/api/arboriculture/IGermlingModelProvider.java b/src/main/java/forestry/api/arboriculture/IGermlingModelProvider.java
new file mode 100644
index 000000000..47f47c685
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IGermlingModelProvider.java
@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.core.IModelManager;
+import net.minecraft.client.resources.model.ModelResourceLocation;
+
+/**
+ * Provides icons for saplings, pollen, etc.
+ * You must implement this yourself to use TreeManager.treeFactory.createSpecies()
+ * There is no default implementation because every sapling has a unique icon.
+ */
+public interface IGermlingModelProvider {
+ void registerModels(IModelManager manager);
+ ModelResourceLocation getModel(EnumGermlingType type);
+}
diff --git a/src/main/java/forestry/api/arboriculture/IGrowthProvider.java b/src/main/java/forestry/api/arboriculture/IGrowthProvider.java
new file mode 100644
index 000000000..909762c4b
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IGrowthProvider.java
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IGrowthProvider {
+
+ /**
+ * Check to see whether a sapling at the given location with the given genome can grow into a tree.
+ *
+ * @param genome Genome of the tree this is called for.
+ * @param world Minecraft world the tree will inhabit.
+ * @param pos Coordinates to attempt growth at.
+ * @param expectedGirth Trunk size of the tree to generate.
+ * @param expectedHeight Height of the tree to generate.
+ * @return true if the tree can grow at the given coordinates, false otherwise.
+ */
+ boolean canGrow(ITreeGenome genome, World world, BlockPos pos, int expectedGirth, int expectedHeight);
+
+ EnumGrowthConditions getGrowthConditions(ITreeGenome genome, World world, BlockPos pos);
+
+ /**
+ * @return Short, human-readable identifier used in the treealyzer.
+ */
+ String getDescription();
+
+ /**
+ * @return Detailed description of growth behaviour used in the treealyzer.
+ */
+ String[] getInfo();
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/ILeafSpriteProvider.java b/src/main/java/forestry/api/arboriculture/ILeafSpriteProvider.java
new file mode 100644
index 000000000..fefda5f0c
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ILeafSpriteProvider.java
@@ -0,0 +1,20 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+
+/**
+ * Provides icons for leaves. Used by TreeManager.treeFactory.createSpecies()
+ * Get a default Forestry implementation from TreeManager.treeFactory.getLeafIconProvider() or implement your own.
+ *
+ * If you implement your own, be sure to register the icons.
+ * Icon registration is not done here because these icons are heavily reused.
+ */
+public interface ILeafSpriteProvider {
+ TextureAtlasSprite getSprite(boolean pollinated, boolean fancy);
+ int getColor(boolean pollinated);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ILeafTickHandler.java b/src/main/java/forestry/api/arboriculture/ILeafTickHandler.java
new file mode 100644
index 000000000..5a2112a42
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ILeafTickHandler.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface ILeafTickHandler {
+ boolean onRandomLeafTick(ITree tree, World world, BlockPos pos, boolean isDestroyed);
+}
diff --git a/src/main/java/forestry/api/arboriculture/IToolGrafter.java b/src/main/java/forestry/api/arboriculture/IToolGrafter.java
new file mode 100644
index 000000000..7273947dc
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IToolGrafter.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IToolGrafter {
+ /**
+ * Called by leaves to determine the increase in sapling droprate.
+ *
+ * @param stack ItemStack containing the grafter.
+ * @param world Minecraft world the player and the target block inhabit.
+ * @param pos Coordinate of the broken leaf block.
+ * @return Float representing the factor the usual drop chance is to be multiplied by.
+ */
+ float getSaplingModifier(ItemStack stack, World world, EntityPlayer player, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITree.java b/src/main/java/forestry/api/arboriculture/ITree.java
new file mode 100644
index 000000000..864200a8f
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITree.java
@@ -0,0 +1,90 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.EnumSet;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.IBlockAccess;
+import net.minecraft.world.World;
+import net.minecraft.world.gen.feature.WorldGenerator;
+
+import com.mojang.authlib.GameProfile;
+
+import net.minecraftforge.common.EnumPlantType;
+
+import forestry.api.genetics.IEffectData;
+import forestry.api.genetics.IIndividual;
+import forestry.api.world.ITreeGenData;
+
+public interface ITree extends IIndividual, ITreeGenData {
+
+ void mate(ITree other);
+
+ IEffectData[] doEffect(IEffectData[] storedData, World world, BlockPos pos);
+
+ IEffectData[] doFX(IEffectData[] storedData, World world, BlockPos pos);
+
+ @Override
+ ITreeGenome getGenome();
+
+ ITreeGenome getMate();
+
+ EnumSet getPlantTypes();
+
+ /**
+ * @since Forestry 4.0
+ */
+ ITree[] getSaplings(World world, GameProfile playerProfile, BlockPos pos, float modifier);
+
+ ItemStack[] getProduceList();
+
+ ItemStack[] getSpecialtyList();
+
+ ItemStack[] produceStacks(World world, BlockPos pos, int ripeningTime);
+
+ /**
+ * @return Boolean indicating whether a sapling can stay planted at the given position.
+ */
+ boolean canStay(IBlockAccess world, BlockPos pos);
+
+ /**
+ * @return Boolean indicating whether a sapling at the given position can grow into a tree.
+ */
+ @Override
+ boolean canGrow(World world, BlockPos pos, int expectedGirth, int expectedHeight);
+
+ /**
+ * @return Integer denoting the maturity (block ticks) required for a sapling to attempt to grow into a tree.
+ */
+ int getRequiredMaturity();
+
+ /**
+ * @return Integer denoting how resilient leaf blocks are against adverse influences (i.e. caterpillars).
+ */
+ int getResilience();
+
+ /**
+ * @return Integer denoting the size of the tree trunk.
+ */
+ @Override
+ int getGirth(World world, BlockPos pos);
+
+ /**
+ * @return Growth conditions at the given position.
+ */
+ EnumGrowthConditions getGrowthCondition(World world, BlockPos pos);
+
+ WorldGenerator getTreeGenerator(World world, BlockPos pos, boolean wasBonemealed);
+
+ @Override
+ ITree copy();
+
+ boolean isPureBred(EnumTreeChromosome chromosome);
+
+ boolean canBearFruit();
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeFactory.java b/src/main/java/forestry/api/arboriculture/ITreeFactory.java
new file mode 100644
index 000000000..2eb8b8b94
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeFactory.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.awt.Color;
+
+import forestry.api.genetics.IClassification;
+
+public interface ITreeFactory {
+ /**
+ * Creates a new tree species.
+ * Automatically registered with AlleleManager.alleleRegistry.registerAllele()
+ * See IAlleleTreeSpeciesCustom and IAlleleSpeciesCustom for adding additional properties to the returned species.
+ *
+ * @param uid Unique Identifier for this species
+ * @param unlocalizedName Unlocalized name for this species
+ * @param authority Authority for the binomial name, e.g. "Sengir" on species of base Forestry.
+ * @param unlocalizedDescription Unlocalized description for this species
+ * @param dominant Whether this species is genetically dominant (false means it is recessive)
+ * @param branch Classification of this species
+ * @param binomial Binomial name of the species sans genus. "humboldti" will have the bee species flavour name be "Apis humboldti". Feel free to use fun names or null.
+ * @param mdoelName The name of the model name for this species
+ * @param leafSpriteProvider The leaf sprite provider for this species
+ * @param germlingModelProvider The germling model provider for this species
+ * @param generator The tree generator
+ * @return a new tree species allele.
+ */
+ IAlleleTreeSpeciesCustom createSpecies(String uid, String unlocalizedName, String authority, String unlocalizedDescription, boolean dominant, IClassification branch, String binomial, String mdoelName, ILeafSpriteProvider leafSpriteProvider, IGermlingModelProvider germlingModelProvider, ITreeGenerator generator);
+
+ /** Get one of the built-in Forestry leaf types. Default type is deciduous. */
+ ILeafSpriteProvider getLeafIconProvider(EnumLeafType enumLeafType, Color color, Color colorPollinated);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeGenerator.java b/src/main/java/forestry/api/arboriculture/ITreeGenerator.java
new file mode 100644
index 000000000..cfb14fc3d
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeGenerator.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.util.EnumFacing;
+import net.minecraft.world.World;
+import net.minecraft.world.gen.feature.WorldGenerator;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.world.ITreeGenData;
+
+/**
+ * Implements the tree generation for a tree species.
+ */
+public interface ITreeGenerator {
+ WorldGenerator getWorldGenerator(ITreeGenData tree);
+
+ void setLogBlock(ITreeGenome genome, World world, BlockPos pos, EnumFacing facing);
+
+ void setLeaves(ITreeGenome genome, World world, GameProfile owner, BlockPos pos, boolean decorative);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeGenome.java b/src/main/java/forestry/api/arboriculture/ITreeGenome.java
new file mode 100644
index 000000000..fae3e72a0
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeGenome.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.EnumSet;
+
+import net.minecraftforge.common.EnumPlantType;
+
+import forestry.api.genetics.IGenome;
+
+public interface ITreeGenome extends IGenome {
+
+ @Override
+ IAlleleTreeSpecies getPrimary();
+
+ @Override
+ IAlleleTreeSpecies getSecondary();
+
+ IFruitProvider getFruitProvider();
+
+ IGrowthProvider getGrowthProvider();
+
+ float getHeight();
+
+ float getFertility();
+
+ /**
+ * @return Determines either a) how many fruit leaves there are or b) the chance for any fruit leave to drop a sapling. Exact usage determined by the
+ * IFruitProvider
+ */
+ float getYield();
+
+ float getSappiness();
+
+ EnumSet getPlantTypes();
+
+ /**
+ * @return Amount of random block ticks required for a sapling to mature into a fully grown tree.
+ */
+ int getMaturationTime();
+
+ int getGirth();
+
+ IAlleleLeafEffect getEffect();
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeModifier.java b/src/main/java/forestry/api/arboriculture/ITreeModifier.java
new file mode 100644
index 000000000..775f91ebe
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeModifier.java
@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+public interface ITreeModifier {
+
+ /**
+ *
+ * @param genome
+ * @return Float used to modify the height.
+ */
+ float getHeightModifier(ITreeGenome genome, float currentModifier);
+
+ /**
+ *
+ * @param genome
+ * @return Float used to modify the yield.
+ */
+ float getYieldModifier(ITreeGenome genome, float currentModifier);
+
+ /**
+ *
+ * @param genome
+ * @return Float used to modify the sappiness.
+ */
+ float getSappinessModifier(ITreeGenome genome, float currentModifier);
+
+ /**
+ *
+ * @param genome
+ * @return Float used to modify the maturation.
+ */
+ float getMaturationModifier(ITreeGenome genome, float currentModifier);
+
+ /**
+ * @param genome0
+ * @param genome1
+ * @return Float used to modify the base mutation chance.
+ */
+ float getMutationModifier(ITreeGenome genome0, ITreeGenome genome1, float currentModifier);
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeMutation.java b/src/main/java/forestry/api/arboriculture/ITreeMutation.java
new file mode 100644
index 000000000..ad2960cf2
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeMutation.java
@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+import forestry.api.genetics.IMutation;
+import forestry.api.genetics.ISpeciesRoot;
+
+public interface ITreeMutation extends IMutation {
+
+ /**
+ * @return {@link ISpeciesRoot} this mutation is associated with.
+ */
+ @Override
+ ITreeRoot getRoot();
+
+ /**
+ * @return float representing the percent chance for mutation to occur, from 0.0 to 100.0.
+ * @since Forestry 4.0
+ */
+ float getChance(World world, BlockPos pos, IAlleleTreeSpecies allele0, IAlleleTreeSpecies allele1, ITreeGenome genome0, ITreeGenome genome1);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeMutationCustom.java b/src/main/java/forestry/api/arboriculture/ITreeMutationCustom.java
new file mode 100644
index 000000000..b4d2075ad
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeMutationCustom.java
@@ -0,0 +1,12 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.IMutationCustom;
+
+public interface ITreeMutationCustom extends ITreeMutation, IMutationCustom {
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeMutationFactory.java b/src/main/java/forestry/api/arboriculture/ITreeMutationFactory.java
new file mode 100644
index 000000000..a6cf802fc
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeMutationFactory.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import forestry.api.genetics.IAllele;
+
+public interface ITreeMutationFactory {
+ /**
+ * Creates a new tree mutation.
+ * Automatically registered with TreeManager.treeRoot.registerMutation()
+ * See ITreeMutationCustom and IMutationCustom for adding additional properties to the returned mutation.
+ *
+ * @param parentTree0 A parent tree for this mutation
+ * @param parentTree1 A parent tree for this mutation
+ * @param result The resulting alleles for this mutation
+ * @param chance The chance that breeding the two parent trees will result in this mutation
+ * @return a new tree mutation.
+ */
+ ITreeMutationCustom createMutation(IAlleleTreeSpecies parentTree0, IAlleleTreeSpecies parentTree1, IAllele[] result, int chance);
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreeRoot.java b/src/main/java/forestry/api/arboriculture/ITreeRoot.java
new file mode 100644
index 000000000..85ad24410
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreeRoot.java
@@ -0,0 +1,100 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IChromosome;
+import forestry.api.genetics.ISpeciesRoot;
+
+public interface ITreeRoot extends ISpeciesRoot {
+
+ @Override
+ boolean isMember(ItemStack itemstack);
+
+ @Override
+ ITree getMember(ItemStack itemstack);
+
+ @Override
+ ITree getMember(NBTTagCompound compound);
+
+ @Override
+ ITree templateAsIndividual(IAllele[] template);
+
+ @Override
+ ITree templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive);
+
+ @Override
+ ITreeGenome templateAsGenome(IAllele[] template);
+
+ @Override
+ ITreeGenome templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive);
+
+ /**
+ * @param world
+ * @return {@link IArboristTracker} associated with the passed world.
+ */
+ @Override
+ IArboristTracker getBreedingTracker(World world, GameProfile player);
+
+ /* TREE SPECIFIC */
+ /**
+ * Register a leaf tick handler.
+ * @param handler the {@link ILeafTickHandler} to register.
+ */
+ void registerLeafTickHandler(ILeafTickHandler handler);
+
+ Collection getLeafTickHandlers();
+
+ /**
+ * @return type of tree encoded on the itemstack. EnumGermlingType.NONE if it isn't a tree.
+ */
+ @Override
+ EnumGermlingType getType(ItemStack stack);
+
+ ITree getTree(World world, BlockPos pos);
+
+ ITree getTree(World world, ITreeGenome genome);
+
+ boolean plantSapling(World world, ITree tree, GameProfile owner, BlockPos pos);
+
+ @Override
+ IChromosome[] templateAsChromosomes(IAllele[] template);
+
+ @Override
+ IChromosome[] templateAsChromosomes(IAllele[] templateActive, IAllele[] templateInactive);
+
+ boolean setFruitBlock(World world, IAlleleFruit allele, float sappiness, short[] indices, BlockPos pos);
+
+ /* GAME MODE */
+ ArrayList getTreekeepingModes();
+
+ ITreekeepingMode getTreekeepingMode(World world);
+
+ ITreekeepingMode getTreekeepingMode(String name);
+
+ void registerTreekeepingMode(ITreekeepingMode mode);
+
+ void setTreekeepingMode(World world, String name);
+
+ /* TEMPLATES */
+ @Override
+ ArrayList getIndividualTemplates();
+
+ /* MUTATIONS */
+ @Override
+ Collection getMutations(boolean shuffle);
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/ITreekeepingMode.java b/src/main/java/forestry/api/arboriculture/ITreekeepingMode.java
new file mode 100644
index 000000000..cc5224d8a
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/ITreekeepingMode.java
@@ -0,0 +1,22 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import java.util.ArrayList;
+
+public interface ITreekeepingMode extends ITreeModifier {
+
+ /**
+ * @return Localized name of this treekeeping mode.
+ */
+ String getName();
+
+ /**
+ * @return Localized list of strings outlining the behaviour of this treekeeping mode.
+ */
+ ArrayList getDescription();
+
+}
diff --git a/src/main/java/forestry/api/arboriculture/IWoodItemAccess.java b/src/main/java/forestry/api/arboriculture/IWoodItemAccess.java
new file mode 100644
index 000000000..023fdbd23
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/IWoodItemAccess.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+import net.minecraft.item.ItemStack;
+
+public interface IWoodItemAccess {
+ ItemStack getLog(EnumWoodType woodType, boolean fireproof);
+ ItemStack getPlanks(EnumWoodType woodType, boolean fireproof);
+ ItemStack getSlab(EnumWoodType woodType, boolean fireproof);
+ ItemStack getFence(EnumWoodType woodType, boolean fireproof);
+ ItemStack getStairs(EnumWoodType woodType, boolean fireproof);
+}
diff --git a/src/main/java/forestry/api/arboriculture/TreeManager.java b/src/main/java/forestry/api/arboriculture/TreeManager.java
new file mode 100644
index 000000000..e8e46c72e
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/TreeManager.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.arboriculture;
+
+public class TreeManager {
+
+ /**
+ * Convenient access to AlleleManager.alleleRegistry.getSpeciesRoot("rootTrees")
+ */
+ public static ITreeRoot treeRoot;
+
+ /**
+ * Convenient access to wood items.
+ */
+ public static IWoodItemAccess woodItemAccess;
+
+ /**
+ * Used to create new trees.
+ */
+ public static ITreeFactory treeFactory;
+
+ /**
+ * Used to create new tree mutations.
+ */
+ public static ITreeMutationFactory treeMutationFactory;
+}
diff --git a/src/main/java/forestry/api/arboriculture/package-info.java b/src/main/java/forestry/api/arboriculture/package-info.java
new file mode 100644
index 000000000..a2548cc83
--- /dev/null
+++ b/src/main/java/forestry/api/arboriculture/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion = "4.2.1", owner = "ForestryAPI|core", provides = "ForestryAPI|arboriculture")
+package forestry.api.arboriculture;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/circuits/ChipsetManager.java b/src/main/java/forestry/api/circuits/ChipsetManager.java
new file mode 100644
index 000000000..c5f0db5c3
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ChipsetManager.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+public class ChipsetManager {
+
+ public static ISolderManager solderManager;
+ public static ICircuitRegistry circuitRegistry;
+
+}
diff --git a/src/main/java/forestry/api/circuits/CircuitSocketType.java b/src/main/java/forestry/api/circuits/CircuitSocketType.java
new file mode 100644
index 000000000..f7f67091a
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/CircuitSocketType.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+public enum CircuitSocketType implements ICircuitSocketType {
+ NONE("none"),
+ FARM("forestry.farm"),
+ ELECTRIC_ENGINE("forestry.electric.engine"),
+ MACHINE("forestry.machine");
+
+ private final String uid;
+
+ CircuitSocketType(String uid) {
+ this.uid = uid;
+ }
+
+ @Override
+ public String getUid() {
+ return uid;
+ }
+
+ @Override
+ public boolean equals(ICircuitSocketType socketType) {
+ return uid.equals(socketType.getUid());
+ }
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuit.java b/src/main/java/forestry/api/circuits/ICircuit.java
new file mode 100644
index 000000000..62c35f358
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuit.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+import java.util.List;
+
+public interface ICircuit {
+ String getUID();
+
+ boolean requiresDiscovery();
+
+ int getLimit();
+
+ String getName();
+
+ boolean isCircuitable(Object tile);
+
+ void onInsertion(int slot, Object tile);
+
+ void onLoad(int slot, Object tile);
+
+ void onRemoval(int slot, Object tile);
+
+ void onTick(int slot, Object tile);
+
+ void addTooltip(List list);
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuitBoard.java b/src/main/java/forestry/api/circuits/ICircuitBoard.java
new file mode 100644
index 000000000..ef09575c2
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuitBoard.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+import java.util.List;
+
+import forestry.api.core.INBTTagable;
+
+public interface ICircuitBoard extends INBTTagable {
+
+ int getPrimaryColor();
+
+ int getSecondaryColor();
+
+ void addTooltip(List list);
+
+ void onInsertion(Object tile);
+
+ void onLoad(Object tile);
+
+ void onRemoval(Object tile);
+
+ void onTick(Object tile);
+
+ ICircuit[] getCircuits();
+
+ /**
+ * Specifies where a circuit can be used.
+ * @since Forestry 4.0
+ */
+ ICircuitSocketType getSocketType();
+
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuitLayout.java b/src/main/java/forestry/api/circuits/ICircuitLayout.java
new file mode 100644
index 000000000..8c49ab120
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuitLayout.java
@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+public interface ICircuitLayout {
+
+ /** unique ID for this circuit layout */
+ String getUID();
+
+ /** localized name for this circuit layout */
+ String getName();
+
+ /** localized string for how this circuit layout is used */
+ String getUsage();
+
+ /**
+ * Specifies where a circuit layout is used.
+ * @since Forestry 4.0
+ */
+ ICircuitSocketType getSocketType();
+
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuitLibrary.java b/src/main/java/forestry/api/circuits/ICircuitLibrary.java
new file mode 100644
index 000000000..0d65ba458
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuitLibrary.java
@@ -0,0 +1,10 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+public interface ICircuitLibrary {
+
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuitRegistry.java b/src/main/java/forestry/api/circuits/ICircuitRegistry.java
new file mode 100644
index 000000000..9fb2b94d5
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuitRegistry.java
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+public interface ICircuitRegistry {
+
+ /* CIRCUITS */
+ Map getRegisteredCircuits();
+
+ void registerCircuit(ICircuit circuit);
+
+ ICircuit getCircuit(String uid);
+
+ ICircuitLibrary getCircuitLibrary(World world, String playername);
+
+ /* LAYOUTS */
+ Map getRegisteredLayouts();
+
+ void registerLayout(ICircuitLayout layout);
+
+ ICircuitLayout getLayout(String uid);
+
+ ICircuitLayout getDefaultLayout();
+
+ ICircuitBoard getCircuitboard(ItemStack itemstack);
+
+ boolean isChipset(ItemStack itemstack);
+
+}
diff --git a/src/main/java/forestry/api/circuits/ICircuitSocketType.java b/src/main/java/forestry/api/circuits/ICircuitSocketType.java
new file mode 100644
index 000000000..60250f712
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ICircuitSocketType.java
@@ -0,0 +1,18 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+/**
+ * Specifies where a circuit layout can be used. (i.e. farm, machine, engine, etc)
+ * See CircuitSocketType for Forestry's uses.
+ */
+public interface ICircuitSocketType {
+ /** unique identifier for this socket type */
+ String getUid();
+
+ /** comparison using uid */
+ boolean equals(ICircuitSocketType socketType);
+}
diff --git a/src/main/java/forestry/api/circuits/ISolderManager.java b/src/main/java/forestry/api/circuits/ISolderManager.java
new file mode 100644
index 000000000..af9b41f1b
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/ISolderManager.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.circuits;
+
+import net.minecraft.item.ItemStack;
+
+public interface ISolderManager {
+
+ void addRecipe(ICircuitLayout layout, ItemStack resource, ICircuit circuit);
+
+}
diff --git a/src/main/java/forestry/api/circuits/package-info.java b/src/main/java/forestry/api/circuits/package-info.java
new file mode 100644
index 000000000..db28a65fa
--- /dev/null
+++ b/src/main/java/forestry/api/circuits/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion = "3.1.0", owner = "ForestryAPI|core", provides = "ForestryAPI|circuits")
+package forestry.api.circuits;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/core/BiomeHelper.java b/src/main/java/forestry/api/core/BiomeHelper.java
new file mode 100644
index 000000000..3b70ca63c
--- /dev/null
+++ b/src/main/java/forestry/api/core/BiomeHelper.java
@@ -0,0 +1,36 @@
+package forestry.api.core;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import net.minecraft.world.biome.BiomeGenBase;
+
+import net.minecraftforge.common.BiomeDictionary;
+
+public class BiomeHelper {
+
+ private static final Map isBiomeHellishCache = new HashMap();
+
+ /**
+ * Determines if it can rain or snow in the given biome.
+ */
+ public static boolean canRainOrSnow(BiomeGenBase biomeGenBase) {
+ return biomeGenBase.getEnableSnow() || biomeGenBase.canRain();
+ }
+
+ /**
+ * Determines if a given BiomeGenBase is of HELLISH temperature, since it is treated separately from actual temperature values.
+ * Uses the BiomeDictionary.
+ * @param biomeGen BiomeGenBase of the biome in question
+ * @return true, if the BiomeGenBase is a Nether-type biome; false otherwise.
+ */
+ public static boolean isBiomeHellish(BiomeGenBase biomeGen) {
+ if (isBiomeHellishCache.containsKey(biomeGen)) {
+ return isBiomeHellishCache.get(biomeGen);
+ }
+
+ boolean isBiomeHellish = BiomeDictionary.isBiomeOfType(biomeGen, BiomeDictionary.Type.NETHER);
+ isBiomeHellishCache.put(biomeGen, isBiomeHellish);
+ return isBiomeHellish;
+ }
+}
diff --git a/src/main/java/forestry/api/core/EnumHumidity.java b/src/main/java/forestry/api/core/EnumHumidity.java
new file mode 100644
index 000000000..a87431691
--- /dev/null
+++ b/src/main/java/forestry/api/core/EnumHumidity.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+/**
+ * Many things Forestry use temperature and humidity of a biome to determine whether they can or how they can work or spawn at a given location.
+ *
+ * This enum concerns humidity.
+ */
+public enum EnumHumidity {
+ ARID("Arid"), NORMAL("Normal"), DAMP("Damp");
+
+ public final String name;
+
+ private EnumHumidity(String name) {
+ this.name = name;
+ }
+
+ public String getName() {
+ return this.name;
+ }
+
+ /**
+ * Determines the EnumHumidity given a floating point representation of Minecraft Rainfall.
+ * To check if rainfall is possible in a biome, use BiomeHelper.canRainOrSnow().
+ * @param rawHumidity raw rainfall value
+ * @return EnumHumidity corresponding to rainfall value
+ */
+ public static EnumHumidity getFromValue(float rawHumidity) {
+ if (rawHumidity > 0.85f) { // matches BiomeGenBase.isHighHumidity()
+ return DAMP;
+ }
+ else if (rawHumidity >= 0.3f) {
+ return NORMAL;
+ }
+ else {
+ return ARID;
+ }
+ }
+}
diff --git a/src/main/java/forestry/api/core/EnumTemperature.java b/src/main/java/forestry/api/core/EnumTemperature.java
new file mode 100644
index 000000000..f38024ac2
--- /dev/null
+++ b/src/main/java/forestry/api/core/EnumTemperature.java
@@ -0,0 +1,79 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.biome.BiomeGenBase;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ * Many things Forestry use temperature and humidity of a biome to determine whether they can or how they can work or spawn at a given location.
+ *
+ * This enum concerns temperature.
+ */
+public enum EnumTemperature {
+ NONE("None", "habitats/ocean"), ICY("Icy", "habitats/snow"), COLD("Cold", "habitats/taiga"),
+ NORMAL("Normal", "habitats/plains"), WARM("Warm", "habitats/jungle"), HOT("Hot", "habitats/desert"), HELLISH("Hellish", "habitats/nether");
+
+ public final String name;
+ public final String iconIndex;
+
+ private EnumTemperature(String name, String iconIndex) {
+ this.name = name;
+ this.iconIndex = iconIndex;
+ }
+
+ public String getName() {
+ return this.name;
+ }
+
+ @SideOnly(Side.CLIENT)
+ public TextureAtlasSprite getIcon() {
+ return ForestryAPI.textureManager.getDefault(iconIndex);
+ }
+
+ /**
+ * Determines the EnumTemperature given a floating point representation of
+ * Minecraft temperature. Hellish biomes are handled based on their biome
+ * type - check BiomeHelper.isBiomeHellish.
+ * @param rawTemp raw temperature value
+ * @return EnumTemperature corresponding to value of rawTemp
+ */
+ public static EnumTemperature getFromValue(float rawTemp) {
+ if (rawTemp > 1.00f) {
+ return HOT;
+ }
+ else if (rawTemp > 0.85f) {
+ return WARM;
+ }
+ else if (rawTemp > 0.35f) {
+ return NORMAL;
+ }
+ else if (rawTemp > 0.0f) {
+ return COLD;
+ }
+ else {
+ return ICY;
+ }
+ }
+
+ public static EnumTemperature getFromBiome(BiomeGenBase biomeGenBase) {
+ if (BiomeHelper.isBiomeHellish(biomeGenBase)) {
+ return HELLISH;
+ }
+ return getFromValue(biomeGenBase.temperature);
+ }
+
+ public static EnumTemperature getFromBiome(BiomeGenBase biomeGenBase, BlockPos pos) {
+ if (BiomeHelper.isBiomeHellish(biomeGenBase)) {
+ return HELLISH;
+ }
+ float temperature = biomeGenBase.getFloatTemperature(pos);
+ return getFromValue(temperature);
+ }
+}
diff --git a/src/main/java/forestry/api/core/ForestryAPI.java b/src/main/java/forestry/api/core/ForestryAPI.java
new file mode 100644
index 000000000..d8854c237
--- /dev/null
+++ b/src/main/java/forestry/api/core/ForestryAPI.java
@@ -0,0 +1,72 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import java.util.Set;
+
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ * Forestry's API is divided into several subcategories to make it easier to understand.
+ *
+ * If you need to distribute API files, try to only include the parts you are actually
+ * using to minimize conflicts due to API changes.
+ *
+ * .core - Miscallenous base classes and interfaces as well as some basics for tools, armor, game modes and stuff needed by biome mods.
+ * .fuels - Managers and classes to facilitate adding fuels to various engines and machines.
+ * .recipes - Managers and helpers to facilitate adding new recipes to various machines.
+ * .storage - Managers, events and interfaces for defining new backpacks and handling backpack behaviour.
+ * .mail - Anything related to handling letters and adding new mail carrier systems.
+ * .genetics - Shared code for all genetic subclasses.
+ * \ .apiculture - Bees.
+ * \ .arboriculture - Trees.
+ * \ .lepidopterology - Butterflies.
+ *
+ * Note that if Forestry is not present, all these references will be null.
+ */
+public class ForestryAPI {
+
+ /**
+ * The main mod instance for Forestry.
+ */
+ public static Object instance;
+
+ /**
+ * A {@link ITextureManager} needed for some things in the API.
+ */
+ @SideOnly(Side.CLIENT)
+ public static ITextureManager textureManager;
+
+ /**
+ * A {@link IModelManager} needed for some things in the API.
+ */
+ @SideOnly(Side.CLIENT)
+ public static IModelManager modleManager;
+
+ /**
+ * The currently active {@link IGameMode}.
+ */
+ public static IGameMode activeMode;
+
+ /**
+ * Provides information on certain Forestry constants (Villager IDs, Chest gen keys, etc)
+ */
+ public static IForestryConstants forestryConstants;
+
+ /**
+ * The currently enabled Forestry plugins.
+ * Can be used to check if certain features are available, for example:
+ * ForestryAPI.enabledPlugins.contains("APICULTURE")
+ */
+ public static Set enabledPlugins;
+
+ /**
+ * Instance of the errorStateRegistry for registering errors.
+ * Also creates new instances of IErrorLogic.
+ */
+ public static IErrorStateRegistry errorStateRegistry;
+}
diff --git a/src/main/java/forestry/api/core/ForestryEvent.java b/src/main/java/forestry/api/core/ForestryEvent.java
new file mode 100644
index 000000000..d5fa539bc
--- /dev/null
+++ b/src/main/java/forestry/api/core/ForestryEvent.java
@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraftforge.fml.common.eventhandler.Event;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.genetics.IAlleleSpecies;
+import forestry.api.genetics.IBreedingTracker;
+import forestry.api.genetics.IMutation;
+import forestry.api.genetics.ISpeciesRoot;
+
+public abstract class ForestryEvent extends Event {
+
+ private static abstract class BreedingEvent extends ForestryEvent {
+ public final ISpeciesRoot root;
+ public final IBreedingTracker tracker;
+ public final GameProfile username;
+
+ private BreedingEvent(ISpeciesRoot root, GameProfile username, IBreedingTracker tracker) {
+ super();
+ this.root = root;
+ this.username = username;
+ this.tracker = tracker;
+ }
+ }
+
+ public static class SpeciesDiscovered extends BreedingEvent {
+ public final IAlleleSpecies species;
+ public SpeciesDiscovered(ISpeciesRoot root, GameProfile username, IAlleleSpecies species, IBreedingTracker tracker) {
+ super(root, username, tracker);
+ this.species = species;
+ }
+ }
+
+ public static class MutationDiscovered extends BreedingEvent {
+ public final IMutation allele;
+ public MutationDiscovered(ISpeciesRoot root, GameProfile username, IMutation allele, IBreedingTracker tracker) {
+ super(root, username, tracker);
+ this.allele = allele;
+ }
+ }
+
+ public static class SyncedBreedingTracker extends ForestryEvent {
+ public final IBreedingTracker tracker;
+ public final EntityPlayer player;
+ public SyncedBreedingTracker(IBreedingTracker tracker, EntityPlayer player) {
+ super();
+ this.tracker = tracker;
+ this.player = player;
+ }
+
+ }
+}
diff --git a/src/main/java/forestry/api/core/IArmorNaturalist.java b/src/main/java/forestry/api/core/IArmorNaturalist.java
new file mode 100644
index 000000000..87400e271
--- /dev/null
+++ b/src/main/java/forestry/api/core/IArmorNaturalist.java
@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+
+public interface IArmorNaturalist {
+
+ /**
+ * Called when the naturalist's armor acts as spectacles for seeing pollinated tree leaves/flowers.
+ *
+ * @param player
+ * Player doing the viewing
+ * @param armor
+ * Armor item
+ * @param doSee
+ * Whether or not to actually do the side effects of viewing
+ * @return true if the armor actually allows the player to see pollination.
+ */
+ public boolean canSeePollination(EntityPlayer player, ItemStack armor, boolean doSee);
+}
diff --git a/src/main/java/forestry/energy/circuits/CircuitElectricEfficiency.java b/src/main/java/forestry/api/core/IClimateControlled.java
old mode 100755
new mode 100644
similarity index 58%
rename from src/main/java/forestry/energy/circuits/CircuitElectricEfficiency.java
rename to src/main/java/forestry/api/core/IClimateControlled.java
index d44ebd816..01ae27638
--- a/src/main/java/forestry/energy/circuits/CircuitElectricEfficiency.java
+++ b/src/main/java/forestry/api/core/IClimateControlled.java
@@ -8,14 +8,16 @@
* Various Contributors including, but not limited to:
* SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges
******************************************************************************/
-package forestry.energy.circuits;
+package forestry.api.core;
-public class CircuitElectricEfficiency extends CircuitElectricChange {
-
- public CircuitElectricEfficiency(String uid) {
- super(uid, false);
- this.setLimit(1);
- this.configureChange(-1, 0);
- }
+public interface IClimateControlled {
+ /**
+ * Change the temperature, but not lower than boundaryDown or higher than boundaryUp.
+ */
+ void addTemperatureChange(float change, float boundaryDown, float boundaryUp);
+ /**
+ * Change the humidity, but not lower than boundaryDown or higher than boundaryUp.
+ */
+ void addHumidityChange(float change, float boundaryDown, float boundaryUp);
}
diff --git a/src/main/java/forestry/api/core/IErrorLogic.java b/src/main/java/forestry/api/core/IErrorLogic.java
new file mode 100644
index 000000000..03a9eb54f
--- /dev/null
+++ b/src/main/java/forestry/api/core/IErrorLogic.java
@@ -0,0 +1,44 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+
+/**
+ * Keeps track of all the IErrorStates for an object.
+ * Create a new IErrorLogic instance for your object with ForestryAPI.errorStateRegistry.createErrorLogic().
+ */
+public interface IErrorLogic extends IErrorSource {
+
+ /**
+ * Sets the errorState when condition is true, and unsets it when condition is false.
+ * @return condition
+ */
+ boolean setCondition(boolean condition, IErrorState errorState);
+
+ /**
+ * @return true if the error state is active.
+ */
+ boolean contains(IErrorState state);
+
+ /**
+ * @return true if there are any active error states.
+ */
+ boolean hasErrors();
+
+ /**
+ * Sets all active error states to false
+ */
+ void clearErrors();
+
+ /**
+ * Network serialization for syncing errors to the client from the server.
+ */
+ void writeData(DataOutputStream data) throws IOException;
+ void readData(DataInputStream data) throws IOException;
+}
diff --git a/src/main/java/forestry/api/core/IErrorLogicSource.java b/src/main/java/forestry/api/core/IErrorLogicSource.java
new file mode 100644
index 000000000..5161ae0ec
--- /dev/null
+++ b/src/main/java/forestry/api/core/IErrorLogicSource.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+/**
+ * An IErrorLogicSource uses an instance of IErrorLogic to deal with its errors.
+ */
+public interface IErrorLogicSource {
+ IErrorLogic getErrorLogic();
+}
diff --git a/src/main/java/forestry/api/core/IErrorSource.java b/src/main/java/forestry/api/core/IErrorSource.java
new file mode 100644
index 000000000..a594c4b2b
--- /dev/null
+++ b/src/main/java/forestry/api/core/IErrorSource.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import com.google.common.collect.ImmutableSet;
+
+public interface IErrorSource {
+ /**
+ * @return the active error states. An empty Set indicates no errors.
+ */
+ ImmutableSet getErrorStates();
+}
diff --git a/src/main/java/forestry/api/core/IErrorState.java b/src/main/java/forestry/api/core/IErrorState.java
new file mode 100644
index 000000000..e09fc2827
--- /dev/null
+++ b/src/main/java/forestry/api/core/IErrorState.java
@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ *
+ * @author CovertJaguar
+ */
+public interface IErrorState {
+
+ short getID();
+
+ String getUniqueName();
+
+ String getDescription();
+
+ String getHelp();
+
+ @SideOnly(Side.CLIENT)
+ void registerSprite();
+
+ @SideOnly(value = Side.CLIENT)
+ TextureAtlasSprite getSprite();
+
+}
diff --git a/src/main/java/forestry/api/core/IErrorStateRegistry.java b/src/main/java/forestry/api/core/IErrorStateRegistry.java
new file mode 100644
index 000000000..fc67ae78a
--- /dev/null
+++ b/src/main/java/forestry/api/core/IErrorStateRegistry.java
@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import java.util.Set;
+
+public interface IErrorStateRegistry {
+ void registerErrorState(IErrorState state);
+ void addAlias(IErrorState state, String name);
+
+ IErrorState getErrorState(short id);
+ IErrorState getErrorState(String name);
+ Set getErrorStates();
+
+ IErrorLogic createErrorLogic();
+}
diff --git a/src/main/java/forestry/api/core/IForestryConstants.java b/src/main/java/forestry/api/core/IForestryConstants.java
new file mode 100644
index 000000000..4cf876f67
--- /dev/null
+++ b/src/main/java/forestry/api/core/IForestryConstants.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+public interface IForestryConstants {
+
+ /**
+ * @return The villager ID for the Apiarist Villager.
+ */
+ public int getApicultureVillagerID();
+
+ /**
+ * @return The villager ID for the Arborist Villager.
+ */
+ public int getArboricultureVillagerID();
+
+ /**
+ * @return The ChestGenHooks key for adding items to the Forestry Villager chest.
+ */
+ public String getVillagerChestGenKey();
+}
diff --git a/src/main/java/forestry/api/core/IGameMode.java b/src/main/java/forestry/api/core/IGameMode.java
new file mode 100644
index 000000000..0b2b0c55d
--- /dev/null
+++ b/src/main/java/forestry/api/core/IGameMode.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.item.ItemStack;
+
+public interface IGameMode {
+
+ /**
+ * @return Human-readable identifier for the game mode. (i.e. 'EASY', 'NORMAL', 'HARD')
+ */
+ String getIdentifier();
+
+ /**
+ * @param ident Identifier for the setting. (See the gamemode config.)
+ * @return Value of the requested setting, false if unknown setting.
+ */
+ boolean getBooleanSetting(String ident);
+
+ /**
+ * @param ident Identifier for the setting. (See the gamemode config.)
+ * @return Value of the requested setting, 0 if unknown setting.
+ */
+ int getIntegerSetting(String ident);
+
+ /**
+ * @param ident Identifier for the setting. (See the gamemode config.)
+ * @return Value of the requested setting, 0 if unknown setting.
+ */
+ float getFloatSetting(String ident);
+
+ /**
+ * @param ident Identifier for the setting. (See the gamemode config.)
+ * @return Value of the requested setting, an itemstack containing an apple if unknown setting.
+ */
+ ItemStack getStackSetting(String ident);
+
+}
diff --git a/src/main/java/forestry/api/core/IItemModelRegister.java b/src/main/java/forestry/api/core/IItemModelRegister.java
new file mode 100644
index 000000000..d2d57da26
--- /dev/null
+++ b/src/main/java/forestry/api/core/IItemModelRegister.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.item.Item;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+public interface IItemModelRegister {
+
+ @SideOnly(Side.CLIENT)
+ void registerModel(Item item, IModelManager manager);
+
+}
diff --git a/src/main/java/forestry/api/core/IModelBaker.java b/src/main/java/forestry/api/core/IModelBaker.java
new file mode 100644
index 000000000..285de8bfb
--- /dev/null
+++ b/src/main/java/forestry/api/core/IModelBaker.java
@@ -0,0 +1,42 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.block.Block;
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.client.resources.model.IBakedModel;
+import net.minecraft.util.BlockPos;
+
+/**
+ * A model baker to make custom models in the mod
+ */
+public interface IModelBaker {
+
+ void setRenderBoundsFromBlock(Block block);
+
+ void setRenderBounds(double d, double e, double f, double g, double h, double i );
+
+ void setColorIndex(int color);
+
+ boolean renderStandardBlock(Block block, BlockPos pos, TextureAtlasSprite[] sprites, int colorIndex);
+
+ boolean renderStandardBlock(Block block, BlockPos pos, TextureAtlasSprite sprites, int colorIndex);
+
+ void renderFaceXNeg(BlockPos pos, TextureAtlasSprite sprite);
+
+ void renderFaceYNeg(BlockPos pos, TextureAtlasSprite sprite);
+
+ void renderFaceZNeg(BlockPos pos, TextureAtlasSprite sprite);
+
+ void renderFaceYPos(BlockPos pos, TextureAtlasSprite sprite);
+
+ void renderFaceZPos(BlockPos pos, TextureAtlasSprite sprite);
+
+ void renderFaceXPos(BlockPos pos, TextureAtlasSprite sprite);
+
+ IBakedModel bakeModel(boolean flip);
+
+}
diff --git a/src/main/java/forestry/api/core/IModelManager.java b/src/main/java/forestry/api/core/IModelManager.java
new file mode 100644
index 000000000..c510b7f31
--- /dev/null
+++ b/src/main/java/forestry/api/core/IModelManager.java
@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.renderer.ItemMeshDefinition;
+import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraft.item.Item;
+import net.minecraft.util.ResourceLocation;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+@SideOnly(Side.CLIENT)
+public interface IModelManager {
+
+ void registerItemModel(Item item, int meta, String modifier, String identifier);
+
+ void registerItemModel(Item item, int meta, String identifier);
+
+ void registerItemModel(Item item, int meta, boolean withMeta);
+
+ ModelResourceLocation getModelLocation(String identifier);
+
+ ModelResourceLocation getModelLocation(String modID, String identifier);
+
+ ModelResourceLocation getModelLocation(Item item);
+
+ ModelResourceLocation getModelLocation(Item item, String identifier);
+
+ ModelResourceLocation getModelLocation(Item item, String modifier, String identifier);
+
+ ModelResourceLocation getModelLocation(Item item, int meta);
+
+ ModelResourceLocation getModelLocation(Item item, int meta, String identifier);
+
+ ModelResourceLocation getModelLocation(Item item, int meta, String modifier, String identifier);
+
+ void registerItemModel(Item item, ItemMeshDefinition definition);
+
+ void registerVariant(Item item, ResourceLocation... resources);
+
+ IModelBaker createNewRenderer();
+
+}
diff --git a/src/main/java/forestry/api/core/IModelProvider.java b/src/main/java/forestry/api/core/IModelProvider.java
new file mode 100644
index 000000000..e6723f716
--- /dev/null
+++ b/src/main/java/forestry/api/core/IModelProvider.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.resources.model.ModelResourceLocation;
+import net.minecraft.item.Item;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ * Provides modles, needed in some interfaces, most notably for bees and trees.
+ */
+public interface IModelProvider {
+
+ @SideOnly(Side.CLIENT)
+ ModelResourceLocation getModel();
+
+ @SideOnly(Side.CLIENT)
+ void registerModels(Item item, IModelManager manager);
+
+}
diff --git a/src/main/java/forestry/api/core/INBTTagable.java b/src/main/java/forestry/api/core/INBTTagable.java
new file mode 100644
index 000000000..1d3f85808
--- /dev/null
+++ b/src/main/java/forestry/api/core/INBTTagable.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.nbt.NBTTagCompound;
+
+public interface INBTTagable {
+ void readFromNBT(NBTTagCompound nbttagcompound);
+
+ void writeToNBT(NBTTagCompound nbttagcompound);
+}
diff --git a/src/main/java/forestry/api/core/ISpriteProvider.java b/src/main/java/forestry/api/core/ISpriteProvider.java
new file mode 100644
index 000000000..4d6288adc
--- /dev/null
+++ b/src/main/java/forestry/api/core/ISpriteProvider.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ * Provides icons, needed in some interfaces, most notably for bees and trees.
+ */
+public interface ISpriteProvider {
+
+ @SideOnly(Side.CLIENT)
+ TextureAtlasSprite getSprite(short texUID);
+
+ @SideOnly(Side.CLIENT)
+ void registerSprites();
+
+}
diff --git a/src/main/java/forestry/api/core/IStateMapperRegister.java b/src/main/java/forestry/api/core/IStateMapperRegister.java
new file mode 100644
index 000000000..2be1168f5
--- /dev/null
+++ b/src/main/java/forestry/api/core/IStateMapperRegister.java
@@ -0,0 +1,12 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+public interface IStateMapperRegister {
+
+ void registerStateMapper();
+
+}
diff --git a/src/main/java/forestry/api/core/ITextureManager.java b/src/main/java/forestry/api/core/ITextureManager.java
new file mode 100644
index 000000000..6d0a061a4
--- /dev/null
+++ b/src/main/java/forestry/api/core/ITextureManager.java
@@ -0,0 +1,20 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraftforge.fml.relauncher.SideOnly;
+import net.minecraftforge.fml.relauncher.Side;
+
+@SideOnly(Side.CLIENT)
+public interface ITextureManager {
+
+ void registerIconProvider(ISpriteProvider provider);
+
+ TextureAtlasSprite getSprite(short texUID);
+
+ TextureAtlasSprite getDefault(String ident);
+}
diff --git a/src/main/java/forestry/api/core/IToolPipette.java b/src/main/java/forestry/api/core/IToolPipette.java
new file mode 100644
index 000000000..f5f1a6338
--- /dev/null
+++ b/src/main/java/forestry/api/core/IToolPipette.java
@@ -0,0 +1,54 @@
+/*******************************************************************************
+ * Copyright (c) 2011-2014 SirSengir.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the GNU Lesser Public License v3
+ * which accompanies this distribution, and is available at
+ * http://www.gnu.org/licenses/lgpl-3.0.txt
+ *
+ * Various Contributors including, but not limited to:
+ * SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.item.ItemStack;
+
+import net.minecraftforge.fluids.FluidStack;
+
+/**
+ * Taken from BuildCraft 5.0.x
+ */
+public interface IToolPipette {
+
+ /**
+ * @param pipette
+ * ItemStack of the pipette.
+ * @return Capacity of the pipette.
+ */
+ int getCapacity(ItemStack pipette);
+
+ /**
+ * @param pipette
+ * @return true if the pipette can pipette.
+ */
+ boolean canPipette(ItemStack pipette);
+
+ /**
+ * Fills the pipette with the given liquid stack.
+ *
+ * @param pipette
+ * @param liquid
+ * @param doFill
+ * @return Amount of liquid used in filling the pipette.
+ */
+ int fill(ItemStack pipette, FluidStack liquid, boolean doFill);
+
+ /**
+ * Drains liquid from the pipette
+ *
+ * @param pipette
+ * @param maxDrain
+ * @param doDrain
+ * @return Fluid stack representing the liquid and amount drained from the pipette.
+ */
+ FluidStack drain(ItemStack pipette, int maxDrain, boolean doDrain);
+}
diff --git a/src/main/java/forestry/api/core/IToolScoop.java b/src/main/java/forestry/api/core/IToolScoop.java
new file mode 100644
index 000000000..583b6c7ed
--- /dev/null
+++ b/src/main/java/forestry/api/core/IToolScoop.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+/**
+ * Marks a tool as a scoop.
+ */
+public interface IToolScoop {
+
+}
diff --git a/src/main/java/forestry/api/core/Tabs.java b/src/main/java/forestry/api/core/Tabs.java
new file mode 100644
index 000000000..4ce85838d
--- /dev/null
+++ b/src/main/java/forestry/api/core/Tabs.java
@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.core;
+
+import net.minecraft.creativetab.CreativeTabs;
+
+/**
+ * References to the specialised tabs added by Forestry to creative inventory.
+ */
+public class Tabs {
+
+ public static CreativeTabs tabApiculture;
+ public static CreativeTabs tabArboriculture;
+ public static CreativeTabs tabLepidopterology;
+
+}
diff --git a/src/main/java/forestry/api/core/package-info.java b/src/main/java/forestry/api/core/package-info.java
new file mode 100644
index 000000000..be9abfd21
--- /dev/null
+++ b/src/main/java/forestry/api/core/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion = "5.0.0", owner = "Forestry", provides = "ForestryAPI|core")
+package forestry.api.core;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/farming/DefaultFarmListener.java b/src/main/java/forestry/api/farming/DefaultFarmListener.java
new file mode 100644
index 000000000..79d041015
--- /dev/null
+++ b/src/main/java/forestry/api/farming/DefaultFarmListener.java
@@ -0,0 +1,49 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+
+/**
+ * Easily extendable default farmListener.
+ * By itself, this farmListener does nothing.
+ * FarmListeners should inherit from this class unless they need to listen for everything.
+ */
+public class DefaultFarmListener implements IFarmListener {
+ @Override
+ public boolean beforeCropHarvest(ICrop crop) {
+ return false;
+ }
+
+ @Override
+ public void afterCropHarvest(Collection harvested, ICrop crop) {
+
+ }
+
+ @Override
+ public void hasCollected(Collection collected, IFarmLogic logic) {
+
+ }
+
+ @Override
+ public void hasCultivated(IFarmLogic logic, BlockPos pos, FarmDirection direction, int extent) {
+
+ }
+
+ @Override
+ public void hasScheduledHarvest(Collection harvested, IFarmLogic logic, BlockPos pos, FarmDirection direction, int extent) {
+
+ }
+
+ @Override
+ public boolean cancelTask(IFarmLogic logic, FarmDirection direction) {
+ return false;
+ }
+
+}
diff --git a/src/main/java/forestry/api/farming/FarmDirection.java b/src/main/java/forestry/api/farming/FarmDirection.java
new file mode 100644
index 000000000..b65f3da2d
--- /dev/null
+++ b/src/main/java/forestry/api/farming/FarmDirection.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import net.minecraft.util.EnumFacing;
+
+public enum FarmDirection {
+ NORTH(EnumFacing.NORTH),
+ EAST(EnumFacing.EAST),
+ SOUTH(EnumFacing.SOUTH),
+ WEST(EnumFacing.WEST);
+
+ private final EnumFacing forgeDirection;
+
+ FarmDirection(EnumFacing forgeDirection) {
+ this.forgeDirection = forgeDirection;
+ }
+
+ public EnumFacing getForgeDirection() {
+ return forgeDirection;
+ }
+
+ public static FarmDirection getFarmDirection(EnumFacing forgeDirection) {
+ switch (forgeDirection) {
+ case NORTH: return NORTH;
+ case EAST: return EAST;
+ case SOUTH: return SOUTH;
+ case WEST: return WEST;
+ }
+ return null;
+ }
+}
diff --git a/src/main/java/forestry/api/farming/Farmables.java b/src/main/java/forestry/api/farming/Farmables.java
new file mode 100644
index 000000000..9816e64ee
--- /dev/null
+++ b/src/main/java/forestry/api/farming/Farmables.java
@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import java.util.Collection;
+import java.util.HashMap;
+
+public class Farmables {
+ /**
+ * Can be used to add IFarmables to some of the vanilla farm logics.
+ *
+ * Identifiers: farmArboreal farmWheat farmGourd farmInfernal farmPoales farmSucculentes farmVegetables farmShroom
+ */
+ public static HashMap> farmables = new HashMap>();
+
+}
diff --git a/src/main/java/forestry/api/farming/ICrop.java b/src/main/java/forestry/api/farming/ICrop.java
new file mode 100644
index 000000000..22575477d
--- /dev/null
+++ b/src/main/java/forestry/api/farming/ICrop.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+
+public interface ICrop {
+
+ /**
+ * Harvests this crop. Performs the necessary manipulations to set the crop into a "harvested" state.
+ *
+ * @return Products harvested.
+ */
+ Collection harvest();
+
+}
diff --git a/src/main/java/forestry/api/farming/IFarmHousing.java b/src/main/java/forestry/api/farming/IFarmHousing.java
new file mode 100644
index 000000000..81c01b215
--- /dev/null
+++ b/src/main/java/forestry/api/farming/IFarmHousing.java
@@ -0,0 +1,49 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+import net.minecraftforge.fluids.FluidStack;
+
+import forestry.api.core.IErrorLogicSource;
+
+public interface IFarmHousing extends IErrorLogicSource {
+
+ int[] getCoords();
+ int[] getArea();
+ int[] getOffset();
+ World getWorld();
+
+ /**
+ * @return true if any work was done, false otherwise.
+ */
+ boolean doWork();
+
+ boolean hasLiquid(FluidStack liquid);
+ void removeLiquid(FluidStack liquid);
+
+ /**
+ * Callback for {@link IFarmLogic}s to plant a sapling, seed, germling, stem.
+ * Will remove the appropriate germling from the farm's inventory.
+ * It's up to the logic to only call this on a valid location.
+ *
+ * @return true if planting was successful, false otherwise.
+ */
+ boolean plantGermling(IFarmable farmable, World world, BlockPos pos);
+
+ /* INTERACTION WITH HATCHES */
+ IFarmInventory getFarmInventory();
+
+ /* LOGIC */
+ void setFarmLogic(FarmDirection direction, IFarmLogic logic);
+ void resetFarmLogic(FarmDirection direction);
+ IFarmLogic getFarmLogic(FarmDirection direction);
+
+ /* GUI */
+ int getStoredFertilizerScaled(int scale);
+}
diff --git a/src/main/java/forestry/api/farming/IFarmInventory.java b/src/main/java/forestry/api/farming/IFarmInventory.java
new file mode 100644
index 000000000..36f45ea39
--- /dev/null
+++ b/src/main/java/forestry/api/farming/IFarmInventory.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import net.minecraft.inventory.IInventory;
+import net.minecraft.item.ItemStack;
+
+public interface IFarmInventory {
+ boolean hasResources(ItemStack[] resources);
+ void removeResources(ItemStack[] resources);
+
+ boolean acceptsAsGermling(ItemStack itemstack);
+ boolean acceptsAsResource(ItemStack itemstack);
+ boolean acceptsAsFertilizer(ItemStack itemstack);
+
+ IInventory getProductInventory();
+ IInventory getGermlingsInventory();
+ IInventory getResourcesInventory();
+ IInventory getFertilizerInventory();
+}
diff --git a/src/main/java/forestry/api/farming/IFarmListener.java b/src/main/java/forestry/api/farming/IFarmListener.java
new file mode 100644
index 000000000..20a98cadd
--- /dev/null
+++ b/src/main/java/forestry/api/farming/IFarmListener.java
@@ -0,0 +1,54 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+
+public interface IFarmListener {
+
+ /**
+ * Called before a crop is harvested.
+ *
+ * @param crop ICrop about to be harvested.
+ * @return true to cancel further processing of this crop.
+ */
+ boolean beforeCropHarvest(ICrop crop);
+
+ /**
+ * Called after a crop has been harvested, but before harvested items are stowed in the farms inventory.
+ *
+ * @param harvested Collection of harvested stacks. May be manipulated. Ensure removal of stacks with 0 or less items!
+ * @param crop Harvested {@link ICrop}
+ */
+ void afterCropHarvest(Collection harvested, ICrop crop);
+
+ /**
+ * Called after the stack of collected items has been returned by the farm logic, but before it is added to the farm's pending queue.
+ *
+ * @param collected Collection of collected stacks. May be manipulated. Ensure removal of stacks with 0 or less items!
+ */
+ void hasCollected(Collection collected, IFarmLogic logic);
+
+ /**
+ * Called after farmland has successfully been cultivated by a farm logic.
+ */
+ void hasCultivated(IFarmLogic logic, BlockPos pos, FarmDirection direction, int extent);
+
+ /**
+ * Called after the stack of harvested crops has been returned by the farm logic, but before it is added to the farm's pending queue.
+ */
+ void hasScheduledHarvest(Collection harvested, IFarmLogic logic, BlockPos pos, FarmDirection direction, int extent);
+
+ /**
+ * Can be used to cancel farm task on a per side/{@link IFarmLogic} basis.
+ *
+ * @return true to skip any work action on the given logic and direction for this work cycle.
+ */
+ boolean cancelTask(IFarmLogic logic, FarmDirection direction);
+}
diff --git a/src/main/java/forestry/api/farming/IFarmLogic.java b/src/main/java/forestry/api/farming/IFarmLogic.java
new file mode 100644
index 000000000..a6b426ee8
--- /dev/null
+++ b/src/main/java/forestry/api/farming/IFarmLogic.java
@@ -0,0 +1,42 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import java.util.Collection;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.util.ResourceLocation;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+public interface IFarmLogic {
+
+ int getFertilizerConsumption();
+
+ int getWaterConsumption(float hydrationModifier);
+
+ boolean isAcceptedResource(ItemStack itemstack);
+
+ boolean isAcceptedGermling(ItemStack itemstack);
+
+ Collection collect();
+
+ boolean cultivate(BlockPos pos, FarmDirection direction, int extent);
+
+ Collection harvest(BlockPos pos, FarmDirection direction, int extent);
+
+ IFarmLogic setManual(boolean manual);
+
+ @SideOnly(Side.CLIENT)
+ ResourceLocation getTextureMap();
+
+ String getName();
+
+ @SideOnly(Side.CLIENT)
+ ItemStack getStack();
+}
diff --git a/src/main/java/forestry/api/farming/IFarmable.java b/src/main/java/forestry/api/farming/IFarmable.java
new file mode 100644
index 000000000..e1438715d
--- /dev/null
+++ b/src/main/java/forestry/api/farming/IFarmable.java
@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.farming;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+/**
+ * IFarmable describes a crop or other harvestable object and can be used to inspect item stacks and blocks for matches.
+ */
+public interface IFarmable {
+
+ /**
+ * @return true if the block at the given location is a "sapling" for this type, i.e. a non-harvestable immature version of the crop.
+ */
+ boolean isSaplingAt(World world, BlockPos pos);
+
+ /**
+ * @return {@link ICrop} if the block at the given location is a harvestable and mature crop, null otherwise.
+ */
+ ICrop getCropAt(World world, BlockPos pos);
+
+ /**
+ * @return true if the item is a valid germling (plantable sapling, seed, etc.) for this type.
+ */
+ boolean isGermling(ItemStack itemstack);
+
+ /**
+ * @return true if the item is something that can drop from this type without actually being harvested as a crop. (Apples or sapling from decaying leaves.)
+ */
+ boolean isWindfall(ItemStack itemstack);
+
+ /**
+ * Plants a sapling by manipulating the world. The {@link IFarmLogic} should have verified the given location as valid. Called by the {@link IFarmHousing}
+ * which handles resources.
+ *
+ * @return true on success, false otherwise.
+ */
+ boolean plantSaplingAt(EntityPlayer player, ItemStack germling, World world, BlockPos pos);
+
+}
diff --git a/src/main/java/forestry/api/farming/package-info.java b/src/main/java/forestry/api/farming/package-info.java
new file mode 100644
index 000000000..d916d01bd
--- /dev/null
+++ b/src/main/java/forestry/api/farming/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="2.1.0", owner="ForestryAPI|core", provides="ForestryAPI|farming")
+package forestry.api.farming;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/food/BeverageManager.java b/src/main/java/forestry/api/food/BeverageManager.java
new file mode 100644
index 000000000..2b0143ab1
--- /dev/null
+++ b/src/main/java/forestry/api/food/BeverageManager.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.food;
+
+public class BeverageManager {
+ public static IBeverageEffect[] effectList = new IBeverageEffect[128];
+
+ public static IInfuserManager infuserManager;
+ public static IIngredientManager ingredientManager;
+}
diff --git a/src/main/java/forestry/api/food/IBeverageEffect.java b/src/main/java/forestry/api/food/IBeverageEffect.java
new file mode 100644
index 000000000..6a787411d
--- /dev/null
+++ b/src/main/java/forestry/api/food/IBeverageEffect.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.food;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.world.World;
+
+public interface IBeverageEffect {
+ int getId();
+
+ void doEffect(World world, EntityPlayer player);
+
+ String getDescription();
+}
diff --git a/src/main/java/forestry/api/food/IInfuserManager.java b/src/main/java/forestry/api/food/IInfuserManager.java
new file mode 100644
index 000000000..d778ffa41
--- /dev/null
+++ b/src/main/java/forestry/api/food/IInfuserManager.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.food;
+
+import net.minecraft.item.ItemStack;
+
+public interface IInfuserManager {
+
+ void addMixture(int meta, ItemStack ingredient, IBeverageEffect effect);
+
+ void addMixture(int meta, ItemStack[] ingredients, IBeverageEffect effect);
+
+ ItemStack getSeasoned(ItemStack base, ItemStack[] ingredients);
+
+ boolean hasMixtures(ItemStack[] ingredients);
+
+ boolean isIngredient(ItemStack itemstack);
+
+ ItemStack[] getRequired(ItemStack[] ingredients);
+
+}
diff --git a/src/main/java/forestry/api/food/IIngredientManager.java b/src/main/java/forestry/api/food/IIngredientManager.java
new file mode 100644
index 000000000..fab0e0129
--- /dev/null
+++ b/src/main/java/forestry/api/food/IIngredientManager.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.food;
+
+import net.minecraft.item.ItemStack;
+
+public interface IIngredientManager {
+
+ String getDescription(ItemStack itemstack);
+
+ void addIngredient(ItemStack ingredient, String description);
+
+}
diff --git a/src/main/java/forestry/api/food/package-info.java b/src/main/java/forestry/api/food/package-info.java
new file mode 100644
index 000000000..c7dbfd01f
--- /dev/null
+++ b/src/main/java/forestry/api/food/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="1.1.0", owner="ForestryAPI|core", provides="ForestryAPI|food")
+package forestry.api.food;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/fuels/EngineBronzeFuel.java b/src/main/java/forestry/api/fuels/EngineBronzeFuel.java
new file mode 100644
index 000000000..cbab0cafc
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/EngineBronzeFuel.java
@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraftforge.fluids.Fluid;
+
+public class EngineBronzeFuel {
+ /**
+ * Item that is valid fuel for a biogas engine.
+ */
+ public final Fluid liquid;
+ /**
+ * Power produced by this fuel per work cycle of the engine.
+ */
+ public final int powerPerCycle;
+ /**
+ * How many work cycles a single "stack" of this type lasts.
+ */
+ public final int burnDuration;
+ /**
+ * By how much the normal heat dissipation rate of 1 is multiplied when using this fuel type.
+ */
+ public final int dissipationMultiplier;
+
+ public EngineBronzeFuel(Fluid liquid, int powerPerCycle, int burnDuration, int dissipationMultiplier) {
+ this.liquid = liquid;
+ this.powerPerCycle = powerPerCycle;
+ this.burnDuration = burnDuration;
+ this.dissipationMultiplier = dissipationMultiplier;
+ }
+}
diff --git a/src/main/java/forestry/api/fuels/EngineCopperFuel.java b/src/main/java/forestry/api/fuels/EngineCopperFuel.java
new file mode 100644
index 000000000..af568dd41
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/EngineCopperFuel.java
@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraft.item.ItemStack;
+
+public class EngineCopperFuel {
+
+ /**
+ * Item that is valid fuel for a peat-fired engine.
+ */
+ public final ItemStack fuel;
+ /**
+ * Power produced by this fuel per work cycle.
+ */
+ public final int powerPerCycle;
+ /**
+ * Amount of work cycles this item lasts before being consumed.
+ */
+ public final int burnDuration;
+
+ public EngineCopperFuel(ItemStack fuel, int powerPerCycle, int burnDuration) {
+ this.fuel = fuel;
+ this.powerPerCycle = powerPerCycle;
+ this.burnDuration = burnDuration;
+ }
+
+}
diff --git a/src/main/java/forestry/api/fuels/FermenterFuel.java b/src/main/java/forestry/api/fuels/FermenterFuel.java
new file mode 100644
index 000000000..32989a803
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/FermenterFuel.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraft.item.ItemStack;
+
+public class FermenterFuel {
+ /**
+ * Item that is a valid fuel for the fermenter (i.e. fertilizer).
+ */
+ public final ItemStack item;
+ /**
+ * How much is fermeted per work cycle, i.e. how much biomass is produced per cycle.
+ */
+ public final int fermentPerCycle;
+ /**
+ * Amount of work cycles a single item of this fuel lasts before expiring.
+ */
+ public final int burnDuration;
+
+ public FermenterFuel(ItemStack item, int fermentPerCycle, int burnDuration) {
+ this.item = item;
+ this.fermentPerCycle = fermentPerCycle;
+ this.burnDuration = burnDuration;
+ }
+}
diff --git a/src/main/java/forestry/api/fuels/FuelManager.java b/src/main/java/forestry/api/fuels/FuelManager.java
new file mode 100644
index 000000000..f53d6fb71
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/FuelManager.java
@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraft.item.ItemStack;
+import net.minecraftforge.fluids.Fluid;
+
+import java.util.HashMap;
+
+
+public class FuelManager {
+ /**
+ * Add new fuels for the fermenter here (i.e. fertilizer).
+ */
+ public static HashMap fermenterFuel;
+ /**
+ * Add new resources for the moistener here (i.e. wheat)
+ */
+ public static HashMap moistenerResource;
+ /**
+ * Add new substrates for the rainmaker here
+ */
+ public static HashMap rainSubstrate;
+ /**
+ * Add new fuels for EngineBronze (= biogas engine) here
+ */
+ public static HashMap bronzeEngineFuel;
+ /**
+ * Add new fuels for EngineCopper (= peat-fired engine) here
+ */
+ public static HashMap copperEngineFuel;
+ /**
+ * Add new fuels for Generator here
+ */
+ public static HashMap generatorFuel;
+
+}
diff --git a/src/main/java/forestry/api/fuels/GeneratorFuel.java b/src/main/java/forestry/api/fuels/GeneratorFuel.java
new file mode 100644
index 000000000..16e2ee4d3
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/GeneratorFuel.java
@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraftforge.fluids.FluidStack;
+
+public class GeneratorFuel {
+
+ /**
+ * LiquidStack representing the fuel type and amount consumed per triggered cycle.
+ */
+ public final FluidStack fuelConsumed;
+ /**
+ * EU emitted per tick while this fuel is being consumed in the generator (i.e. biofuel = 32, biomass = 8).
+ */
+ public final int eu;
+ /**
+ * Rate at which the fuel is consumed. 1 - Every tick 2 - Every second tick 3 - Every third tick etc.
+ */
+ public final int rate;
+
+ public GeneratorFuel(FluidStack fuelConsumed, int eu, int rate) {
+ this.fuelConsumed = fuelConsumed;
+ this.eu = eu;
+ this.rate = rate;
+ }
+
+}
diff --git a/src/main/java/forestry/api/fuels/MoistenerFuel.java b/src/main/java/forestry/api/fuels/MoistenerFuel.java
new file mode 100644
index 000000000..4c4c7a0b6
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/MoistenerFuel.java
@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraft.item.ItemStack;
+
+public class MoistenerFuel {
+ /**
+ * The item to use
+ */
+ public final ItemStack item;
+ /**
+ * The item that leaves the moistener's working slot (i.e. mouldy wheat, decayed wheat, mulch)
+ */
+ public final ItemStack product;
+ /**
+ * How much this item contributes to the final product of the moistener (i.e. mycelium)
+ */
+ public final int moistenerValue;
+ /**
+ * What stage this product represents. Resources with lower stage value will be consumed first.
+ */
+ public final int stage;
+
+ public MoistenerFuel(ItemStack item, ItemStack product, int stage, int moistenerValue) {
+ this.item = item;
+ this.product = product;
+ this.stage = stage;
+ this.moistenerValue = moistenerValue;
+ }
+}
diff --git a/src/main/java/forestry/api/fuels/RainSubstrate.java b/src/main/java/forestry/api/fuels/RainSubstrate.java
new file mode 100644
index 000000000..ab0deb5a3
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/RainSubstrate.java
@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.fuels;
+
+import net.minecraft.item.ItemStack;
+
+public class RainSubstrate {
+ /**
+ * Rain substrate capable of activating the rainmaker.
+ */
+ public ItemStack item;
+ /**
+ * Duration of the rain shower triggered by this substrate in Minecraft ticks.
+ */
+ public int duration;
+ /**
+ * Speed of activation sequence triggered.
+ */
+ public float speed;
+
+ public boolean reverse;
+
+ public RainSubstrate(ItemStack item, int duration, float speed) {
+ this(item, duration, speed, false);
+ }
+
+ public RainSubstrate(ItemStack item, float speed) {
+ this(item, 0, speed, true);
+ }
+
+ public RainSubstrate(ItemStack item, int duration, float speed, boolean reverse) {
+ this.item = item;
+ this.duration = duration;
+ this.speed = speed;
+ this.reverse = reverse;
+ }
+}
diff --git a/src/main/java/forestry/api/fuels/package-info.java b/src/main/java/forestry/api/fuels/package-info.java
new file mode 100644
index 000000000..c6bf9e745
--- /dev/null
+++ b/src/main/java/forestry/api/fuels/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="2.0.1", owner="ForestryAPI|core", provides="ForestryAPI|fuels")
+package forestry.api.fuels;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/genetics/AlleleManager.java b/src/main/java/forestry/api/genetics/AlleleManager.java
new file mode 100644
index 000000000..6e3511621
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/AlleleManager.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.HashMap;
+
+import net.minecraft.item.ItemStack;
+
+/**
+ * Holds a static reference to the {@link IAlleleRegistry}.
+ */
+public class AlleleManager {
+ /**
+ * Main access point for all things related to genetics. See {@link IAlleleRegistry} for details.
+ */
+ public static IAlleleRegistry alleleRegistry;
+ /**
+ * Translates plain leaf blocks into genetic data. Used by bees and butterflies to convert and pollinate foreign leaf blocks.
+ */
+ public static HashMap ersatzSpecimen = new HashMap();
+ /**
+ * Translates plain saplings into genetic data. Used by the treealyzer and the farm to convert foreign saplings.
+ */
+ public static HashMap ersatzSaplings = new HashMap();
+ /**
+ * Queryable instance of an {@link IClimateHelper} for easier implementation.
+ */
+ public static IClimateHelper climateHelper;
+ /**
+ * Creates Forestry alleles.
+ */
+ public static IAlleleFactory alleleFactory;
+}
diff --git a/src/main/java/forestry/api/genetics/EnumTolerance.java b/src/main/java/forestry/api/genetics/EnumTolerance.java
new file mode 100644
index 000000000..6ff0085eb
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/EnumTolerance.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+public enum EnumTolerance {
+ NONE,
+
+ BOTH_1, BOTH_2, BOTH_3, BOTH_4, BOTH_5,
+
+ UP_1, UP_2, UP_3, UP_4, UP_5,
+
+ DOWN_1, DOWN_2, DOWN_3, DOWN_4, DOWN_5
+}
diff --git a/src/main/java/forestry/api/genetics/IAllele.java b/src/main/java/forestry/api/genetics/IAllele.java
new file mode 100644
index 000000000..527474102
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAllele.java
@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * An {@link IIndividual}'s {@link IGenome} is composed of {@link IChromosome}s consisting each of a primary and secondary {@link IAllele}.
+ *
+ * {@link IAllele}s hold all information regarding an {@link IIndividual}'s traits, from species to size, temperature tolerances, etc.
+ *
+ * Should be extended for different types of alleles. ISpeciesAllele, IBiomeAllele, etc.
+ *
+ * @author SirSengir
+ */
+public interface IAllele {
+
+ /**
+ * @return A unique string identifier for this allele.
+ */
+ String getUID();
+
+ /**
+ * @return true if the allele is dominant, false otherwise.
+ */
+ boolean isDominant();
+
+ /**
+ * @return Localized short, human-readable identifier used in tooltips and beealyzer.
+ */
+ String getName();
+
+ /**
+ * @return The unlocalized identifier
+ */
+ String getUnlocalizedName();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleArea.java b/src/main/java/forestry/api/genetics/IAlleleArea.java
new file mode 100644
index 000000000..7277ff0a1
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleArea.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Simple interface to allow adding additional alleles containing float values.
+ */
+public interface IAlleleArea extends IAllele {
+
+ int[] getValue();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleBoolean.java b/src/main/java/forestry/api/genetics/IAlleleBoolean.java
new file mode 100644
index 000000000..887da3b90
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleBoolean.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Simple interface to allow adding additional alleles containing float values.
+ */
+public interface IAlleleBoolean extends IAllele {
+
+ boolean getValue();
+
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleEffect.java b/src/main/java/forestry/api/genetics/IAlleleEffect.java
new file mode 100644
index 000000000..7b94e6b16
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleEffect.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Basic effect allele.
+ */
+public interface IAlleleEffect extends IAllele {
+ /**
+ * @return true if this effect can combine with the effect on other allele (i.e. run before or after). combination can only occur if both effects are
+ * combinable.
+ */
+ boolean isCombinable();
+
+ /**
+ * Returns the passed data storage if it is valid for this effect or a new one if the passed storage object was invalid for this effect.
+ *
+ * @param storedData
+ * @return {@link IEffectData} for the next cycle.
+ */
+ IEffectData validateStorage(IEffectData storedData);
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleFactory.java b/src/main/java/forestry/api/genetics/IAlleleFactory.java
new file mode 100644
index 000000000..573408007
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleFactory.java
@@ -0,0 +1,153 @@
+package forestry.api.genetics;
+
+/**
+ * Creates new alleles with smart localization.
+ *
+ *
+ * UID is created like this:
+ * modId + '.' + category + WordUtils.capitalize(valueName);
+ * For Example:
+ * modId:forestry, category:height, valueName:smallest => forestry.heightSmallest
+ * This is mainly for legacy compatibility and may change in future major versions.
+ *
+ *
+ * The default localization uses:
+ * [modId].allele.[valueName]
+ *
+ * Languages that need category-specific names can override it by defining:
+ * [modId].allele.[category].[valueName]
+ *
+ * For example:
+ * en_US
+ * forestry.allele.smallest=Smallest
+ * ru_RU
+ * forestry.allele.smallest=????? ?????????
+ * forestry.allele.height.smallest=????? ??????
+ */
+public interface IAlleleFactory {
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "height")
+ * @param valueName allele value name for uid and localization (i.e. "smallest")
+ * @param value allele float value
+ * @param isDominant allele dominance
+ * @param types allele chromosome type for registration (i.e. EnumTreeChromosome.HEIGHT)
+ * @return a new IAlleleFloat, registered with the allele registry.
+ * @since Forestry 4.2
+ */
+ IAlleleFloat createFloat(String modId, String category, String valueName, float value, boolean isDominant, IChromosomeType... types);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "territory")
+ * @param valueName allele value name for uid and localization (i.e. "large")
+ * @param xDimValue allele area X Size
+ * @param yDimValue allele area Y Size
+ * @param zDimValue allele area Z Size
+ * @param isDominant allele dominance
+ * @param types allele chromosome type for registration (i.e. EnumBeeChromosome.TERRITORY)
+ * @return a new IAlleleArea, registered with the allele registry.
+ * @since Forestry 4.2
+ */
+ IAlleleArea createArea(String modId, String category, String valueName, int xDimValue, int yDimValue, int zDimValue, boolean isDominant, IChromosomeType... types);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "fertility")
+ * @param valueName allele value name for uid and localization (i.e. "low")
+ * @param value allele int value
+ * @param isDominant allele dominance
+ * @param types allele chromosome type for registration (i.e. EnumBeeChromosome.FERTILITY)
+ * @return a new IAlleleInteger, registered with the allele registry.
+ * @since Forestry 4.2
+ */
+ IAlleleInteger createInteger(String modId, String category, String valueName, int value, boolean isDominant, IChromosomeType... types);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "fireproof")
+ * @param value allele boolean value
+ * @param isDominant allele dominance
+ * @param types allele chromosome type for registration (i.e. EnumTreeChromosome.FIREPROOF)
+ * @return a new IAlleleBoolean, registered with the allele registry.
+ * Note that valueName will always be "true" or "false"
+ * @since Forestry 4.2
+ */
+ IAlleleBoolean createBoolean(String modId, String category, boolean value, boolean isDominant, IChromosomeType... types);
+
+ /**
+ * @param modId mod prefix for uid (i.e. "forestry")
+ * @param category allele category for uid (i.e. "flowers")
+ * @param valueName allele value name for uid (i.e. "vanilla")
+ * @param value allele IFlowerProvider value
+ * @param isDominant allele dominance
+ * @param types allele chromosome type for registration (i.e. EnumBeeChromosome.FLOWER_PROVIDER)
+ * @return a new IAlleleFlowers, registered with the allele registry.
+ * IAlleleFlowers localization is handled by the IFlowerProvider.getDescription(), unlike the other alleles.
+ * @since Forestry 4.2
+ */
+ IAlleleFlowers createFlowers(String modId, String category, String valueName, IFlowerProvider value, boolean isDominant, IChromosomeType... types);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "height")
+ * @param valueName allele value name for uid and localization (i.e. "smallest")
+ * @param value allele float value
+ * @param isDominant allele dominance
+ * @return a new IAlleleFloat, registered with the allele registry.
+ * @deprecated since Forestry 4.2. Use the IChromosomeType version.
+ */
+ @Deprecated
+ IAlleleFloat createFloat(String modId, String category, String valueName, float value, boolean isDominant);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "territory")
+ * @param valueName allele value name for uid and localization (i.e. "large")
+ * @param xDimValue allele area X Size
+ * @param yDimValue allele area Y Size
+ * @param zDimValue allele area Z Size
+ * @param isDominant allele dominance
+ * @return a new IAlleleArea, registered with the allele registry.
+ * @deprecated since Forestry 4.2. Use the IChromosomeType version.
+ */
+ @Deprecated
+ IAlleleArea createArea(String modId, String category, String valueName, int xDimValue, int yDimValue, int zDimValue, boolean isDominant);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "fertility")
+ * @param valueName allele value name for uid and localization (i.e. "low")
+ * @param value allele int value
+ * @param isDominant allele dominance
+ * @return a new IAlleleInteger, registered with the allele registry.
+ * @deprecated since Forestry 4.2. Use the IChromosomeType version.
+ */
+ @Deprecated
+ IAlleleInteger createInteger(String modId, String category, String valueName, int value, boolean isDominant);
+
+ /**
+ * @param modId mod prefix for uid and localization (i.e. "forestry")
+ * @param category allele category for uid and localization (i.e. "fireproof")
+ * @param value allele boolean value
+ * @param isDominant allele dominance
+ * @return a new IAlleleBoolean, registered with the allele registry.
+ * Note that valueName will always be "true" or "false"
+ * @deprecated since Forestry 4.2. Use the IChromosomeType version.
+ */
+ @Deprecated
+ IAlleleBoolean createBoolean(String modId, String category, boolean value, boolean isDominant);
+
+ /**
+ * @param modId mod prefix for uid (i.e. "forestry")
+ * @param category allele category for uid (i.e. "flowers")
+ * @param valueName allele value name for uid (i.e. "vanilla")
+ * @param value allele IFlowerProvider value
+ * @param isDominant allele dominance
+ * @return a new IAlleleFlowers, registered with the allele registry.
+ * IAlleleFlowers localization is handled by the IFlowerProvider.getDescription(), unlike the other alleles.
+ * @deprecated since Forestry 4.2. Use the IChromosomeType version.
+ */
+ @Deprecated
+ IAlleleFlowers createFlowers(String modId, String category, String valueName, IFlowerProvider value, boolean isDominant);
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleFloat.java b/src/main/java/forestry/api/genetics/IAlleleFloat.java
new file mode 100644
index 000000000..6ca28776a
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleFloat.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Simple interface to allow adding additional alleles containing float values.
+ */
+public interface IAlleleFloat extends IAllele {
+
+ float getValue();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleFlowers.java b/src/main/java/forestry/api/genetics/IAlleleFlowers.java
new file mode 100644
index 000000000..0368ca41c
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleFlowers.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+
+public interface IAlleleFlowers extends IAllele {
+
+ /**
+ * @return FlowerProvider
+ */
+ IFlowerProvider getProvider();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleHandler.java b/src/main/java/forestry/api/genetics/IAlleleHandler.java
new file mode 100644
index 000000000..3d052afe4
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleHandler.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * @author Alex Binnie
+ *
+ * Handler for events that occur in IAlleleRegistry, such as registering alleles, branches etc. Useful for handling plugin specific behavior (i.e.
+ * creating a list of all bee species etc.)
+ *
+ */
+public interface IAlleleHandler {
+
+ /**
+ * Called when an allele is registered with {@link IAlleleRegistry}.
+ *
+ * @param allele
+ * Allele which was registered.
+ */
+ public void onRegisterAllele(IAllele allele);
+
+ /**
+ * Called when a classification is registered with {@link IAlleleRegistry}.
+ *
+ * @param classification
+ * Classification which was registered.
+ */
+ public void onRegisterClassification(IClassification classification);
+
+ /**
+ * Called when a fruit family is registered with {@link IAlleleRegistry}.
+ *
+ * @param family
+ * Fruit family which was registered.
+ */
+ public void onRegisterFruitFamily(IFruitFamily family);
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleInteger.java b/src/main/java/forestry/api/genetics/IAlleleInteger.java
new file mode 100644
index 000000000..6991efe5f
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleInteger.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Simple interface to allow adding additional alleles containing integer values.
+ */
+public interface IAlleleInteger extends IAllele {
+
+ int getValue();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAllelePlantType.java b/src/main/java/forestry/api/genetics/IAllelePlantType.java
new file mode 100644
index 000000000..211237f20
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAllelePlantType.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.EnumSet;
+
+import net.minecraftforge.common.EnumPlantType;
+
+public interface IAllelePlantType extends IAllele {
+
+ public EnumSet getPlantTypes();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleRegistry.java b/src/main/java/forestry/api/genetics/IAlleleRegistry.java
new file mode 100644
index 000000000..90f89940e
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleRegistry.java
@@ -0,0 +1,238 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.Collection;
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.genetics.IClassification.EnumClassLevel;
+
+/**
+ * Manages {@link ISpeciesRoot}, {@link IAllele}s, {@link IFruitFamily}s, {@link IClassification}, the blacklist and allows creation of research notes.
+ *
+ * @author SirSengir
+ */
+public interface IAlleleRegistry {
+
+ /* SPECIES ROOT CLASSES */
+ /**
+ * Register a {@link ISpeciesRoot}.
+ * @param root {@link ISpeciesRoot} to register.
+ */
+ void registerSpeciesRoot(ISpeciesRoot root);
+
+ /**
+ * @return Map of all registered {@link ISpeciesRoot}.
+ */
+ Map getSpeciesRoot();
+
+ /**
+ * Retrieve the {@link ISpeciesRoot} with the given uid.
+ * @param uid Unique id for the species class, i.e. "rootBees", "rootTrees", "rootButterflies".
+ * @return {@link ISpeciesRoot} if it exists, null otherwise.
+ */
+ ISpeciesRoot getSpeciesRoot(String uid);
+
+ /**
+ * Retrieve a matching {@link ISpeciesRoot} for the given itemstack.
+ * @param stack An itemstack possibly containing NBT data which can be converted by a species root.
+ * @return {@link ISpeciesRoot} if found, null otherwise.
+ */
+ ISpeciesRoot getSpeciesRoot(ItemStack stack);
+
+ /**
+ * Retrieve a matching {@link ISpeciesRoot} for the given {@link IIndividual}-class.
+ * @param clz Class extending {@link IIndividual}.
+ * @return {@link ISpeciesRoot} if found, null otherwise.
+ */
+ ISpeciesRoot getSpeciesRoot(Class extends IIndividual> clz);
+
+ /* INDIVIDUAL */
+ /**
+ * Tests the itemstack for genetic information.
+ *
+ * @param stack
+ * @return true if the itemstack is an individual.
+ */
+ boolean isIndividual(ItemStack stack);
+
+ /**
+ * Retrieve genetic information from an itemstack.
+ *
+ * @param stack
+ * Stack to retrieve genetic information for.
+ * @return IIndividual containing genetic information, null if none could be extracted.
+ */
+ IIndividual getIndividual(ItemStack stack);
+
+ /* ALLELES */
+
+ /**
+ * @return HashMap of all currently registered alleles.
+ */
+ Map getRegisteredAlleles();
+
+ /**
+ * Registers an allele.
+ *
+ * @param allele IAllele to register.
+ * @deprecated since Forestry 4.2. Use the IChromosomeType-specific version.
+ */
+ @Deprecated
+ void registerAllele(IAllele allele);
+
+ /**
+ * Registers an allele.
+ *
+ * NOTE: Where possible, it is recommended to use IAlleleFactory instead
+ * because it has built-in advanced localization support.
+ *
+ * @param allele IAllele to register.
+ * @param chromosomeTypes valid chromosomeTypes for this allele.
+ * @since Forestry 4.2
+ */
+ void registerAllele(IAllele allele, IChromosomeType... chromosomeTypes);
+
+ /**
+ * @return HashMap of all registered deprecated alleles and their corresponding replacements
+ */
+ Map getDeprecatedAlleleReplacements();
+
+ /**
+ * Registers an old allele UID and the new IAllele to replace instances of it with.
+ *
+ * @param deprecatedAlleleUID
+ * the old allele's UID
+ * @param replacement
+ * the IAllele that the deprecated Allele will be replaced with.
+ */
+ void registerDeprecatedAlleleReplacement(String deprecatedAlleleUID, IAllele replacement);
+
+ /**
+ * Gets an allele
+ *
+ * @param uid
+ * String based unique identifier of the allele to retrieve.
+ * @return IAllele if found or a replacement is found in the Deprecated Allele map, null otherwise.
+ */
+ IAllele getAllele(String uid);
+
+ /**
+ * @return unmodifiable collection of all the known allele variations for the given chromosome type.
+ * @since Forestry 4.2
+ */
+ Collection getRegisteredAlleles(IChromosomeType type);
+
+ /* CLASSIFICATIONS */
+ /**
+ * @return HashMap of all currently registered classifications.
+ */
+ Map getRegisteredClassifications();
+
+ /**
+ * Registers a classification.
+ *
+ * @param classification
+ * IClassification to register.
+ */
+ void registerClassification(IClassification classification);
+
+ /**
+ * Creates and returns a classification.
+ *
+ * @param level
+ * EnumClassLevel of the classification to create.
+ * @param uid
+ * String based unique identifier. Implementation will throw an exception if the key is already taken.
+ * @param scientific
+ * Binomial for the given classification.
+ * @return Created {@link IClassification} for easier chaining.
+ */
+ IClassification createAndRegisterClassification(EnumClassLevel level, String uid, String scientific);
+ IClassification createAndRegisterClassification(EnumClassLevel level, String uid, String scientific, IClassification... members);
+
+ /**
+ * Gets a classification.
+ *
+ * @param uid
+ * String based unique identifier of the classification to retrieve.
+ * @return {@link IClassification} if found, null otherwise.
+ */
+ IClassification getClassification(String uid);
+
+ /* FRUIT FAMILIES */
+ /**
+ * Get all registered fruit families.
+ *
+ * @return A map of registered fruit families and their UIDs.
+ */
+ Map getRegisteredFruitFamilies();
+
+ /**
+ * Registers a new fruit family.
+ *
+ * @param family
+ */
+ void registerFruitFamily(IFruitFamily family);
+
+ /**
+ * Retrieves a fruit family identified by uid.
+ *
+ * @param uid
+ * @return {IFruitFamily} if found, false otherwise.
+ */
+ IFruitFamily getFruitFamily(String uid);
+
+ /* ALLELE HANDLERS */
+ /**
+ * Registers a new IAlleleHandler
+ *
+ * @param handler
+ * IAlleleHandler to register.
+ */
+ void registerAlleleHandler(IAlleleHandler handler);
+
+ /* BLACKLIST */
+ /**
+ * Blacklist an allele identified by its UID from mutation.
+ *
+ * @param uid
+ * UID of the allele to blacklist.
+ */
+ void blacklistAllele(String uid);
+
+ /**
+ * @return Current blacklisted alleles.
+ */
+ Collection getAlleleBlacklist();
+
+ /**
+ * @param uid
+ * UID of the species to vet.
+ * @return true if the allele is blacklisted.
+ */
+ boolean isBlacklisted(String uid);
+
+ /* RESEARCH */
+ /**
+ * @param researcher Username of the player who researched this note.
+ * @param species {@link IAlleleSpecies} to encode on the research note.
+ * @return An itemstack containing a research note with the given species encoded onto it.
+ */
+ ItemStack getSpeciesNoteStack(GameProfile researcher, IAlleleSpecies species);
+
+ /**
+ * @param researcher Username of the player who researched this note.
+ * @param mutation {@link IMutation} to encode on the research note.
+ * @return An itemstack containing a research note with the given mutation encoded onto it.
+ */
+ ItemStack getMutationNoteStack(GameProfile researcher, IMutation mutation);
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleSpecies.java b/src/main/java/forestry/api/genetics/IAlleleSpecies.java
new file mode 100644
index 000000000..d3a355267
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleSpecies.java
@@ -0,0 +1,114 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+import forestry.api.core.IModelProvider;
+
+/**
+ * Basic species allele.
+ */
+public interface IAlleleSpecies extends IAllele {
+
+ /**
+ * @return the {@link ISpeciesRoot} associated with this species.
+ */
+ ISpeciesRoot getRoot();
+
+ /**
+ * @return Localized short description of this species. (May be null.)
+ */
+ String getDescription();
+
+ /**
+ * Binomial name of the species sans genus ("Apis"). Returning "humboldti" will have the bee species flavour name be "Apis humboldti". Feel free to use fun
+ * names or return null.
+ *
+ * @return flavour text (may be null)
+ */
+ String getBinomial();
+
+ /**
+ * Authority for the binomial name, e.g. "Sengir" on species of base Forestry.
+ *
+ * @return flavour text (may be null)
+ */
+ String getAuthority();
+
+ /**
+ * @return Branch this species is associated with.
+ */
+ IClassification getBranch();
+
+ /* RESEARCH */
+ /**
+ * Complexity determines the difficulty researching a species. The values of primary and secondary are
+ * added together (and rounded) to determine the amount of pairs needed for successful research.
+ * @return Values between 3 - 11 are useful.
+ */
+ int getComplexity();
+
+ /**
+ * @param itemstack
+ * @return A float signifying the chance for the passed itemstack to yield a research success.
+ */
+ float getResearchSuitability(ItemStack itemstack);
+
+ /**
+ * @param world
+ * @param gameProfile
+ * @param individual
+ * @param bountyLevel
+ * @return Array of itemstacks representing the bounty for this research success.
+ */
+ ItemStack[] getResearchBounty(World world, GameProfile gameProfile, IIndividual individual, int bountyLevel);
+
+ /* CLIMATE */
+ /**
+ * @return Preferred temperature
+ */
+ EnumTemperature getTemperature();
+
+ /**
+ * @return Preferred humidity
+ */
+ EnumHumidity getHumidity();
+
+ /* MISC */
+ /**
+ * @return true if the species icon should have a glowing effect.
+ */
+ boolean hasEffect();
+
+ /**
+ * @return true if the species should not be displayed in NEI or creative inventory.
+ */
+ boolean isSecret();
+
+ /**
+ * @return true to have the species count against the species total.
+ */
+ boolean isCounted();
+
+ /* APPEARANCE */
+ /**
+ * @param renderPass Render pass to get the colour for.
+ * @return Colour to use for the render pass.
+ */
+ int getSpriteColour(int renderPass);
+
+ @SideOnly(Side.CLIENT)
+ IModelProvider getModelProvider();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleSpeciesCustom.java b/src/main/java/forestry/api/genetics/IAlleleSpeciesCustom.java
new file mode 100644
index 000000000..ff1381628
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleSpeciesCustom.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+
+public interface IAlleleSpeciesCustom extends IAlleleSpecies {
+
+ IAlleleSpeciesCustom setTemperature(EnumTemperature temperature);
+ IAlleleSpeciesCustom setHumidity(EnumHumidity humidity);
+
+ IAlleleSpeciesCustom setHasEffect();
+
+ /** Secret species are not shown in creative mode. */
+ IAlleleSpeciesCustom setIsSecret();
+
+ /** Uncounted species do not count toward total species discovered. */
+ IAlleleSpeciesCustom setIsNotCounted();
+}
diff --git a/src/main/java/forestry/api/genetics/IAlleleTolerance.java b/src/main/java/forestry/api/genetics/IAlleleTolerance.java
new file mode 100644
index 000000000..f5ba9e670
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IAlleleTolerance.java
@@ -0,0 +1,15 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Simple interface to allow adding additional alleles containing float values.
+ */
+public interface IAlleleTolerance extends IAllele {
+
+ EnumTolerance getValue();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IBreedingTracker.java b/src/main/java/forestry/api/genetics/IBreedingTracker.java
new file mode 100644
index 000000000..7533a59a6
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IBreedingTracker.java
@@ -0,0 +1,106 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.nbt.NBTTagCompound;
+
+import forestry.api.apiculture.IBeekeepingMode;
+
+/**
+ * Keeps track of who bred, discovered, and researched which species in a world.
+ *
+ * @author SirSengir
+ */
+public interface IBreedingTracker {
+
+ /**
+ * @return Name of the current {@link IBeekeepingMode}.
+ */
+ String getModeName();
+
+ /**
+ * Set the current {@link IBeekeepingMode}.
+ */
+ void setModeName(String name);
+
+ /**
+ * @return Amount of species discovered.
+ */
+ int getSpeciesBred();
+
+ /**
+ * Register the birth of an individual. Will mark it as discovered.
+ *
+ * @param individual
+ */
+ void registerBirth(IIndividual individual);
+
+ /**
+ * Register the pickup of an individual.
+ *
+ * @param individual
+ */
+ void registerPickup(IIndividual individual);
+
+ /**
+ * Marks a species as discovered. Should only be called from registerIndividual normally.
+ *
+ * @param species
+ */
+ void registerSpecies(IAlleleSpecies species);
+
+ /**
+ * Register a successful mutation. Will mark it as discovered.
+ *
+ * @param mutation
+ */
+ void registerMutation(IMutation mutation);
+
+ /**
+ * Queries the tracker for discovered species.
+ *
+ * @param mutation
+ * Mutation to query for.
+ * @return true if the mutation has been discovered.
+ */
+ boolean isDiscovered(IMutation mutation);
+
+ /**
+ * Queries the tracker for discovered species.
+ *
+ * @param species
+ * Species to check.
+ * @return true if the species has been bred.
+ */
+ boolean isDiscovered(IAlleleSpecies species);
+
+ /**
+ * Register a successfully researched mutation.
+ * Mutations are normally researched in the Escritoire.
+ * Researched mutations may have bonuses such as occurring at a higher rate.
+ * Researched mutations count as discovered.
+ */
+ void researchMutation(IMutation mutation);
+
+ /**
+ * @return true if the mutation has been researched.
+ */
+ boolean isResearched(IMutation mutation);
+
+ /**
+ * Synchronizes the tracker to the client side.
+ * Before Forestry 4.2.1: Should be called before opening any gui needing that information.
+ * Since Forestry 4.2.1: Breeding tracker should be automatically synced, only Forestry should need to call this.
+ */
+ void synchToPlayer(EntityPlayer player);
+
+ /* LOADING & SAVING */
+ void decodeFromNBT(NBTTagCompound nbttagcompound);
+
+ void encodeToNBT(NBTTagCompound nbttagcompound);
+
+}
diff --git a/src/main/java/forestry/api/genetics/IChromosome.java b/src/main/java/forestry/api/genetics/IChromosome.java
new file mode 100644
index 000000000..d501efbac
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IChromosome.java
@@ -0,0 +1,25 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * Implementations other than Forestry's default one are not supported!
+ *
+ * @author SirSengir
+ */
+public interface IChromosome extends INBTTagable {
+
+ IAllele getPrimaryAllele();
+
+ IAllele getSecondaryAllele();
+
+ IAllele getInactiveAllele();
+
+ IAllele getActiveAllele();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IChromosomeType.java b/src/main/java/forestry/api/genetics/IChromosomeType.java
new file mode 100644
index 000000000..a3b1f8e0c
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IChromosomeType.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/*
+ * Interface to be implemented by the enums representing the various chromosomes
+ */
+public interface IChromosomeType {
+
+ /*
+ * Get class which all alleles on this chromosome must interface
+ */
+ Class extends IAllele> getAlleleClass();
+
+ String getName();
+
+ ISpeciesRoot getSpeciesRoot();
+
+ int ordinal();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IClassification.java b/src/main/java/forestry/api/genetics/IClassification.java
new file mode 100644
index 000000000..f365b915c
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IClassification.java
@@ -0,0 +1,107 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/**
+ * Biological classifications from domain down to genus.
+ *
+ * Used by the *alyzers to display hierarchies.
+ */
+public interface IClassification {
+
+ public enum EnumClassLevel {
+
+ DOMAIN(0x777fff, true), KINGDOM(0x77c3ff), PHYLUM(0x77ffb6, true), DIVISION(0x77ffb6, true), CLASS(0x7bff77), ORDER(0xbeff77), FAMILY(0xfffd77),
+ SUBFAMILY(0xfffd77), TRIBE(0xfffd77), GENUS(0xffba77);
+
+ private int colour;
+ private boolean isDroppable;
+
+ private EnumClassLevel(int colour) {
+ this(colour, false);
+ }
+
+ private EnumClassLevel(int colour, boolean isDroppable) {
+ this.colour = colour;
+ this.isDroppable = isDroppable;
+ }
+
+ /**
+ * @return Colour to use for displaying this classification.
+ */
+ public int getColour() {
+ return colour;
+ }
+
+ /**
+ * @return Indicates whether display of this classification level can be ommitted in case of space constraints.
+ */
+ public boolean isDroppable() {
+ return isDroppable;
+ }
+ }
+
+ /**
+ * @return Level inside the full hierarchy this particular classification is located at.
+ */
+ EnumClassLevel getLevel();
+
+ /**
+ * @return Unique String identifier.
+ */
+ String getUID();
+
+ /**
+ * @return Localized branch name for user display.
+ */
+ String getName();
+
+ /**
+ * A branch approximates a "genus" in real life. Real life examples: "Micrapis", "Megapis"
+ *
+ * @return flavour text (may be null)
+ */
+ String getScientific();
+
+ /**
+ * @return Localized description of this branch. (May be null.)
+ */
+ String getDescription();
+
+ /**
+ * @return Member groups of this one.
+ */
+ IClassification[] getMemberGroups();
+
+ /**
+ * Adds subgroups to this group.
+ */
+ void addMemberGroup(IClassification group);
+
+ /**
+ * @return Member species of this group.
+ */
+ IAlleleSpecies[] getMemberSpecies();
+
+ /**
+ * Used by the allele registry to populate internal collection of branch members on the fly.
+ *
+ * @param species
+ */
+ void addMemberSpecies(IAlleleSpecies species);
+
+ /**
+ * @return Parent classification, null if this is root.
+ */
+ IClassification getParent();
+
+ /**
+ * Only used internally by the AlleleRegistry if this classification has been added to another one.
+ *
+ * @param parent
+ */
+ void setParent(IClassification parent);
+}
diff --git a/src/main/java/forestry/api/genetics/IClimateHelper.java b/src/main/java/forestry/api/genetics/IClimateHelper.java
new file mode 100644
index 000000000..481460427
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IClimateHelper.java
@@ -0,0 +1,53 @@
+package forestry.api.genetics;
+
+import java.util.Collection;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+
+public interface IClimateHelper {
+ /**
+ * Determines whether the given temperature and humidity are within the given constraints.
+ * @param temperature The temperature to test.
+ * @param humidity The humidity to test.
+ * @param baseTemp Base temperature for the test.
+ * @param tolTemp Temperature tolerance to apply.
+ * @param baseHumid Base humidity for the test.
+ * @param tolHumid Humidity tolerance to apply.
+ * @return true if both temperature and humidity fit the given constraints.
+ */
+ boolean isWithinLimits(EnumTemperature temperature, EnumHumidity humidity,
+ EnumTemperature baseTemp, EnumTolerance tolTemp,
+ EnumHumidity baseHumid, EnumTolerance tolHumid);
+
+ boolean isWithinLimits(EnumTemperature temperature, EnumTemperature baseTemp, EnumTolerance tolTemp);
+ boolean isWithinLimits(EnumHumidity humidity, EnumHumidity baseHumid, EnumTolerance tolHumid);
+
+ /**
+ * Gets a collection of humidities which fit the given parameters.
+ * @param prefered Base humidity from which to measure.
+ * @param tolerance Tolerance to apply to the base humidity.
+ * @return A collection of humidities which fall within the given parameters.
+ */
+ Collection getToleratedHumidity(EnumHumidity prefered, EnumTolerance tolerance);
+ /**
+ * Gets a collection of temperatures which fit the given parameters.
+ * @param prefered Base temperature from which to measure.
+ * @param tolerance Tolerance to apply to the base temperatures.
+ * @return A collection of temperatures which fall within the given parameters.
+ */
+ Collection getToleratedTemperature(EnumTemperature prefered, EnumTolerance tolerance);
+
+ /**
+ * Gets a localized, human readable string for the given temperature.
+ * @param temperature Temperature to generate the string for.
+ * @return A localized, human readable string for the given temperature.
+ */
+ String toDisplay(EnumTemperature temperature);
+ /**
+ * Gets a localized, human readable string for the given humidity.
+ * @param humidity Humidity to generate the string for.
+ * @return A localized, human readable string for the given humidity.
+ */
+ String toDisplay(EnumHumidity humidity);
+}
\ No newline at end of file
diff --git a/src/main/java/forestry/api/genetics/IEffectData.java b/src/main/java/forestry/api/genetics/IEffectData.java
new file mode 100644
index 000000000..909ab78df
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IEffectData.java
@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * Container to hold some temporary data for bee, tree and butterfly effects.
+ *
+ * @author SirSengir
+ */
+public interface IEffectData extends INBTTagable {
+ void setInteger(int index, int val);
+
+ void setFloat(int index, float val);
+
+ void setBoolean(int index, boolean val);
+
+ int getInteger(int index);
+
+ float getFloat(int index);
+
+ boolean getBoolean(int index);
+}
diff --git a/src/main/java/forestry/api/genetics/IFlower.java b/src/main/java/forestry/api/genetics/IFlower.java
new file mode 100644
index 000000000..e37c16eaa
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlower.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.block.Block;
+
+/**
+ * @deprecated since Forestry 4.0. Use alternative methods in IFlowerRegistry.
+ */
+@Deprecated
+public interface IFlower extends Comparable {
+
+ Block getBlock();
+ int getMeta();
+
+ double getWeight();
+ void setWeight(double weight);
+
+ boolean isPlantable();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IFlowerAcceptableRule.java b/src/main/java/forestry/api/genetics/IFlowerAcceptableRule.java
new file mode 100644
index 000000000..c2fedf8b6
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlowerAcceptableRule.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IFlowerAcceptableRule {
+ /**
+ * Checks if the flower at this position is accepted by this rule.
+ * flowerType is passed in case this rule is registered for multiple flower types.
+ */
+ boolean isAcceptableFlower(String flowerType, World world, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/genetics/IFlowerGrowthHelper.java b/src/main/java/forestry/api/genetics/IFlowerGrowthHelper.java
new file mode 100644
index 000000000..fd3b6bc6b
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlowerGrowthHelper.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IFlowerGrowthHelper {
+ /**
+ * Plants a random flower from flowerType at the specified position.
+ * @return true if successful, false if it could not be planted.
+ */
+ boolean plantRandomFlower(String flowerType, World world, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/genetics/IFlowerGrowthRule.java b/src/main/java/forestry/api/genetics/IFlowerGrowthRule.java
new file mode 100644
index 000000000..1cef316fb
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlowerGrowthRule.java
@@ -0,0 +1,22 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+/**
+ * Basic condition for flower growing, such as checking that the soil is the correct type.
+ */
+public interface IFlowerGrowthRule {
+ /**
+ * Checks a position for suitability, and then plants a flower there.
+ * Returns true on success.
+ * For implementers, you can plant a random flower using IFlowerGrowthHelper.plantRandomFlower
+ * @since Forestry 4.0.8
+ */
+ boolean growFlower(IFlowerGrowthHelper helper, String flowerType, World world, BlockPos pos);
+}
diff --git a/src/main/java/forestry/api/genetics/IFlowerProvider.java b/src/main/java/forestry/api/genetics/IFlowerProvider.java
new file mode 100644
index 000000000..d7a8967b0
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlowerProvider.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.Set;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IFlowerProvider {
+
+ boolean isAcceptedPollinatable(World world, IPollinatable pollinatable);
+
+ /**
+ * @return The unique type used for the IFlowerRegistry
+ * @since Forestry 4.0.0
+ */
+ String getFlowerType();
+
+ /**
+ * @return Short, human-readable identifier used in the beealyzer.
+ */
+ String getDescription();
+
+ /**
+ * Allows the flower provider to affect the produce at the given location.
+ * If this flowerProvider does not affect the products, it should return the products unchanged.
+ * @return Array of itemstacks being the (modified or unmodified) produce.
+ */
+ ItemStack[] affectProducts(World world, IIndividual individual, BlockPos pos, ItemStack[] products);
+}
diff --git a/src/main/java/forestry/api/genetics/IFlowerRegistry.java b/src/main/java/forestry/api/genetics/IFlowerRegistry.java
new file mode 100644
index 000000000..44a3b9991
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFlowerRegistry.java
@@ -0,0 +1,92 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.Collection;
+import java.util.Random;
+import java.util.Set;
+
+import net.minecraft.block.Block;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+import forestry.api.apiculture.IBee;
+import forestry.api.apiculture.IBeeHousing;
+
+// See {@link forestry.api.apiculture.FlowerManager}.FlowerType___ for basic Forestry flower types.
+// Each IFlowerProvider has one flower type, and multiple IFlowerProviders may share one type.
+// "Acceptable flowers" allow nearby bees to do work.
+// "Plantable flowers" are "Acceptable flowers" and are also planted randomly by bees.
+public interface IFlowerRegistry {
+
+ /**
+ * Register a new flower growth rule.
+ * This defines the flower planting logic for the specified flower types.
+ * Without a flower growth rule, no flowers of that type can be planted.
+ */
+ void registerGrowthRule(IFlowerGrowthRule rule, String... flowerTypes);
+
+ /**
+ * Registers an accepted flower with any meta value.
+ */
+ void registerAcceptableFlower(Block flowerBlock, String... flowerTypes);
+ /**
+ * Registers an accepted flower with a specific meta value.
+ */
+ void registerAcceptableFlower(Block flowerBlock, int flowerMeta, String... flowerTypes);
+
+ /**
+ * Registers custom logic for accepted flowers.
+ * These rules are inefficient compared to ones made with registerAcceptableFlower, but may be necessary for tile entity flowers.
+ * The flower types built into Forestry can not be used here.
+ * @since Forestry 4.0.8
+ */
+ void registerAcceptableFlowerRule(IFlowerAcceptableRule flowerAcceptableRule, String... flowerTypes);
+
+ /**
+ * Registers a plantable flower.
+ * The distribution is based on its own weight and the total number of plants for this flowerType.
+ *
+ * @param weight Weight for the Flower (Vanilla = 1.0, Modded flowers < 1.0)
+ * @param flowerTypes See {@link forestry.api.apiculture.FlowerManager}.FlowerTypeXXX
+ */
+ void registerPlantableFlower(Block flowerBlock, int flowerMeta, double weight, String... flowerTypes);
+
+ /**
+ * Calls the appropriate IFlowerGrowthRule to grow a flower at a specified position.
+ */
+ boolean growFlower(String flowerType, World world, IIndividual individual, BlockPos pos);
+
+ /**
+ * @return the coordinates of a nearby accepted flower or null if there is none.
+ */
+ BlockPos getAcceptedFlowerCoordinates(IBeeHousing beeHousing, IBee bee, String flowerType);
+
+ /**
+ * Checks a single coordinate to see if it is an accepted flower.
+ */
+ boolean isAcceptedFlower(String flowerType, World world, BlockPos pos);
+
+ /**
+ * For use by IFlowerGrowthRule implementations
+ * @deprecated since Forestry 4.0.8 This will be accessible to IFlowerGrowthRule via IFlowerGrowthHelper
+ */
+ @Deprecated
+ IFlower getRandomPlantableFlower(String flowerType, Random rand);
+
+ /**
+ * Returns all known flower types.
+ * @deprecated since Forestry 4.0.8 This should only be used internally.
+ */
+ @Deprecated
+ Collection getFlowerTypes();
+
+ /**
+ * @deprecated since Forestry 4.0.8 This should only be used internally.
+ */
+ @Deprecated
+ Set getAcceptableFlowers(String flowerType);
+}
diff --git a/src/main/java/forestry/api/genetics/IFruitBearer.java b/src/main/java/forestry/api/genetics/IFruitBearer.java
new file mode 100644
index 000000000..5316f9ebc
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFruitBearer.java
@@ -0,0 +1,50 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.Collection;
+
+import net.minecraft.item.ItemStack;
+
+/**
+ * Can be implemented by tile entities which can bear fruit.
+ *
+ * @author SirSengir
+ */
+public interface IFruitBearer {
+
+ /**
+ * @return true if the actual tile can bear fruits.
+ */
+ boolean hasFruit();
+
+ /**
+ * @return Family of the potential fruits on this tile.
+ */
+ IFruitFamily getFruitFamily();
+
+ /**
+ * Picks the fruits of this tile, resetting it to unripe fruits.
+ *
+ * @param tool
+ * Tool used in picking the fruits. May be null.
+ * @return Picked fruits.
+ */
+ Collection pickFruit(ItemStack tool);
+
+ /**
+ * @return float indicating the ripeness of the fruit with >= 1.0f indicating full ripeness.
+ */
+ float getRipeness();
+
+ /**
+ * Increases the ripeness of the fruit.
+ *
+ * @param add
+ * Float to add to the ripeness. Will truncate to valid values.
+ */
+ void addRipeness(float add);
+}
diff --git a/src/main/java/forestry/api/genetics/IFruitFamily.java b/src/main/java/forestry/api/genetics/IFruitFamily.java
new file mode 100644
index 000000000..d48a4d8a1
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IFruitFamily.java
@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+public interface IFruitFamily {
+
+ /**
+ * @return Unique String identifier.
+ */
+ String getUID();
+
+ /**
+ * @return Localized family name for user display.
+ */
+ String getName();
+
+ /**
+ * A scientific-y name for this fruit family
+ *
+ * @return flavour text (may be null)
+ */
+ String getScientific();
+
+ /**
+ * @return Localized description of this fruit family. (May be null.)
+ */
+ String getDescription();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IGenome.java b/src/main/java/forestry/api/genetics/IGenome.java
new file mode 100644
index 000000000..0d3ad2319
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IGenome.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * Holds the {@link IChromosome}s which comprise the traits of a given individual.
+ *
+ * Only the default implementation is supported.
+ */
+public interface IGenome extends INBTTagable {
+
+ IAlleleSpecies getPrimary();
+
+ IAlleleSpecies getSecondary();
+
+ IChromosome[] getChromosomes();
+
+ IAllele getActiveAllele(IChromosomeType chromosomeType);
+
+ IAllele getInactiveAllele(IChromosomeType chromosomeType);
+
+ boolean isGeneticEqual(IGenome other);
+
+ ISpeciesRoot getSpeciesRoot();
+}
diff --git a/src/main/java/forestry/api/genetics/IHousing.java b/src/main/java/forestry/api/genetics/IHousing.java
new file mode 100644
index 000000000..e9ac7af1b
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IHousing.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.util.BlockPos;
+
+/**
+ * Any housing, hatchery or nest with a location in the world.
+ */
+public interface IHousing {
+
+ BlockPos getCoordinates();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IIndividual.java b/src/main/java/forestry/api/genetics/IIndividual.java
new file mode 100644
index 000000000..f86aa5829
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IIndividual.java
@@ -0,0 +1,53 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.List;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * An actual individual with genetic information.
+ *
+ * Only the default implementation is supported.
+ */
+public interface IIndividual extends INBTTagable {
+
+ String getIdent();
+
+ String getDisplayName();
+
+ void addTooltip(List list);
+
+ /**
+ * Call to mark the IIndividual as analyzed.
+ * @return true if the IIndividual has not been analyzed previously.
+ */
+ boolean analyze();
+
+ boolean isAnalyzed();
+
+ boolean hasEffect();
+
+ boolean isSecret();
+
+ IGenome getGenome();
+
+ /**
+ * Check whether the genetic makeup of two IIndividuals is identical. Ignores additional data like generations, irregular mating, etc..
+ * @param other
+ * @return true if the given other IIndividual has the amount of chromosomes and their alleles are identical.
+ */
+ boolean isGeneticEqual(IIndividual other);
+
+ /**
+ * @return A deep copy of this individual.
+ */
+ IIndividual copy();
+
+ boolean isPureBred(IChromosomeType chromosomeType);
+
+}
diff --git a/src/main/java/forestry/api/genetics/IIndividualLiving.java b/src/main/java/forestry/api/genetics/IIndividualLiving.java
new file mode 100644
index 000000000..67ce0a975
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IIndividualLiving.java
@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.world.World;
+
+public interface IIndividualLiving extends IIndividual {
+
+ /**
+ * @return Genetic information of the mate, null if unmated.
+ */
+ IGenome getMate();
+
+ /**
+ * @return Current health of the individual.
+ */
+ int getHealth();
+
+ /**
+ * @return Maximum health of the individual.
+ */
+ int getMaxHealth();
+
+ /**
+ * Age the individual.
+ * @param world
+ * @param ageModifier
+ */
+ void age(World world, float ageModifier);
+
+ /**
+ * Mate with the given individual.
+ * @param individual the {@link IIndividual} to mate this one with.
+ */
+ void mate(IIndividual individual);
+
+ /**
+ * @return true if the individual is among the living.
+ */
+ boolean isAlive();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IMutation.java b/src/main/java/forestry/api/genetics/IMutation.java
new file mode 100644
index 000000000..bf7ae62f1
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IMutation.java
@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.Collection;
+
+/**
+ * Individuals can be seeded either as hive drops or as mutation results.
+ *
+ * {@link IAlleleRegistry} manages these.
+ *
+ * @author SirSengir
+ */
+public interface IMutation {
+
+ /**
+ * @return {@link ISpeciesRoot} this mutation is associated with.
+ */
+ ISpeciesRoot getRoot();
+
+ /**
+ * @return first of the alleles implementing IAlleleSpecies required for this mutation.
+ */
+ IAlleleSpecies getAllele0();
+
+ /**
+ * @return second of the alleles implementing IAlleleSpecies required for this mutation.
+ */
+ IAlleleSpecies getAllele1();
+
+ /**
+ * @return Array of {@link IAllele} representing the full default genome of the mutated side.
+ *
+ * Make sure to return a proper array for the species class. Returning an allele of the wrong type will cause cast errors on runtime.
+ */
+ IAllele[] getTemplate();
+
+ /**
+ * @return Unmodified base chance for mutation to fire.
+ */
+ float getBaseChance();
+
+ /**
+ * @return Collection of localized, human-readable strings describing special mutation conditions, if any.
+ */
+ Collection getSpecialConditions();
+
+ /**
+ * @param allele
+ * @return true if the passed allele is one of the alleles participating in this mutation.
+ */
+ boolean isPartner(IAllele allele);
+
+ /**
+ * @param allele
+ * @return the other allele which was not passed as argument.
+ */
+ IAllele getPartner(IAllele allele);
+
+ /**
+ * @return true if the mutation should not be displayed in the beealyzer.
+ */
+ boolean isSecret();
+
+}
diff --git a/src/main/java/forestry/api/genetics/IMutationCondition.java b/src/main/java/forestry/api/genetics/IMutationCondition.java
new file mode 100644
index 000000000..0267d42de
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IMutationCondition.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+public interface IMutationCondition {
+
+ /**
+ * Returns a float from 0 to 1 representing the chance for mutation to occur.
+ * Most will return 1 if the condition is met and 0 otherwise,
+ * but the float offers flexibility for more advanced conditions.
+ */
+ float getChance(World world, BlockPos pos, IAllele allele0, IAllele allele1, IGenome genome0, IGenome genome1);
+
+ /**
+ * A localized description of the mutation condition. (i.e. "A temperature of HOT is required.")
+ */
+ String getDescription();
+}
diff --git a/src/main/java/forestry/api/genetics/IMutationCustom.java b/src/main/java/forestry/api/genetics/IMutationCustom.java
new file mode 100644
index 000000000..42235eee4
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IMutationCustom.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import net.minecraft.block.Block;
+
+import net.minecraftforge.common.BiomeDictionary;
+
+import forestry.api.core.EnumHumidity;
+import forestry.api.core.EnumTemperature;
+
+/** Set custom mutation requirements */
+public interface IMutationCustom extends IMutation {
+
+ /** Prevent this mutation from being shown in the analyzers */
+ IMutationCustom setIsSecret();
+
+ /** Require a specific temperature for this mutation to occur */
+ IMutationCustom restrictTemperature(EnumTemperature temperature);
+ IMutationCustom restrictTemperature(EnumTemperature minTemperature, EnumTemperature maxTemperature);
+
+ /** Require a specific humidity for this mutation to occur */
+ IMutationCustom restrictHumidity(EnumHumidity humidity);
+ IMutationCustom restrictHumidity(EnumHumidity minHumidity, EnumHumidity maxHumidity);
+
+ /**
+ * Restrict this mutation to certain types of biomes.
+ * @param types The types of biomes this mutation can occur.
+ */
+ IMutationCustom restrictBiomeType(BiomeDictionary.Type... types);
+
+ /** Restrict the days of the year that this mutation can occur */
+ IMutationCustom restrictDateRange(int startMonth, int startDay, int endMonth, int endDay);
+
+ /** Restrict the time of day that this mutation can occur */
+ IMutationCustom requireDay();
+ IMutationCustom requireNight();
+
+ /** Require a specific resource to be under the location of the mutation */
+ IMutationCustom requireResource(Block block, int meta);
+ IMutationCustom requireResource(String oreDictName);
+
+ /** Require some other custom mutation condition */
+ IMutationCustom addMutationCondition(IMutationCondition mutationCondition);
+}
diff --git a/src/main/java/forestry/api/genetics/IPollinatable.java b/src/main/java/forestry/api/genetics/IPollinatable.java
new file mode 100644
index 000000000..a3716789f
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/IPollinatable.java
@@ -0,0 +1,53 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.EnumSet;
+
+import net.minecraftforge.common.EnumPlantType;
+
+/**
+ * Can be implemented by tile entities, if they wish to be pollinatable.
+ *
+ * @author SirSengir
+ */
+public interface IPollinatable {
+
+ /**
+ * @return plant types this pollinatable is classified as. (Can be used by bees to determine whether to interact or not.
+ */
+ EnumSet getPlantType();
+
+ /**
+ * @return IIndividual containing the genetic information of this IPollinatable
+ */
+ IIndividual getPollen();
+
+ /**
+ * Checks whether this {@link IPollinatable} can mate with the given pollen.
+ *
+ * Must be the one to check genetic equivalency.
+ *
+ * @param pollen
+ * IIndividual representing the pollen.
+ * @return true if mating is possible, false otherwise.
+ */
+ boolean canMateWith(IIndividual pollen);
+
+ /**
+ * Pollinates this entity.
+ *
+ * @param pollen
+ * IIndividual representing the pollen.
+ */
+ void mateWith(IIndividual pollen);
+
+ /**
+ * @return true if this IPollinatable has already been pollinated.
+ * @since Forestry 4.1.0
+ */
+ boolean isPollinated();
+}
diff --git a/src/main/java/forestry/api/genetics/ISpeciesRoot.java b/src/main/java/forestry/api/genetics/ISpeciesRoot.java
new file mode 100644
index 000000000..f3652bea8
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/ISpeciesRoot.java
@@ -0,0 +1,179 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Random;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.world.World;
+
+import com.mojang.authlib.GameProfile;
+
+/**
+ * Describes a class of species (i.e. bees, trees, butterflies), provides helper functions and access to common functionality.
+ */
+public interface ISpeciesRoot {
+
+ /**
+ * @return A unique identifier for the species class. Should consist of "root" + a common name for the species class in camel-case, i.e. "rootBees", "rootTrees", "rootButterflies".
+ */
+ String getUID();
+
+ /**
+ * @return Class of the sub-interface inheriting from {@link IIndividual}.
+ */
+ Class extends IIndividual> getMemberClass();
+
+ /**
+ * @return Integer denoting the number of (counted) species of this type in the world.
+ */
+ int getSpeciesCount();
+
+ /**
+ * Used to check whether a given itemstack contains genetic data corresponding to an {@link IIndividual} of this class.
+ * @param stack itemstack to check.
+ * @return true if the itemstack contains an {@link IIndividual} of this class, false otherwise.
+ */
+ boolean isMember(ItemStack stack);
+
+ /**
+ * Used to check whether a given itemstack contains genetic data corresponding to an {@link IIndividual} of this class and matches the given type.
+ * @param stack itemstack to check.
+ * @param type Integer denoting the type needed to match. (i.e. butterfly vs. butterfly serum; bee queens, princesses, drones; etc.)
+ * @return true if the itemstack contains an {@link IIndividual} of this class, false otherwise.
+ */
+ boolean isMember(ItemStack stack, int type);
+
+ /**
+ * Used to check whether the given {@link IIndividual} is member of this class.
+ * @param individual {@link IIndividual} to check.
+ * @return true if the individual is member of this class, false otherwise.
+ */
+ boolean isMember(IIndividual individual);
+
+ IIndividual getMember(ItemStack stack);
+
+ IIndividual getMember(NBTTagCompound compound);
+
+ ISpeciesType getType(ItemStack itemStack);
+
+ ItemStack getMemberStack(IIndividual individual, int type);
+
+ /* BREEDING TRACKER */
+ IBreedingTracker getBreedingTracker(World world, GameProfile player);
+
+ /**
+ * @deprecated since Forestry 4.2.1. Breeding tracker should be automatically synced.
+ */
+ @Deprecated
+ void syncBreedingTrackerToPlayer(EntityPlayer player);
+
+ /* GENOME MANIPULATION */
+ IIndividual templateAsIndividual(IAllele[] template);
+
+ IIndividual templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive);
+
+ IChromosome[] templateAsChromosomes(IAllele[] template);
+
+ IChromosome[] templateAsChromosomes(IAllele[] templateActive, IAllele[] templateInactive);
+
+ IGenome templateAsGenome(IAllele[] template);
+
+ IGenome templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive);
+
+ /* TEMPLATES */
+ /**
+ * Registers a bee template using the UID of the first allele as identifier.
+ *
+ * @param template
+ */
+ void registerTemplate(IAllele[] template);
+
+ /**
+ * Registers a bee template using the passed identifier.
+ *
+ * @param template
+ */
+ void registerTemplate(String identifier, IAllele[] template);
+
+ /**
+ * Retrieves a registered template using the passed identifier.
+ *
+ * @param identifier
+ * @return Array of {@link IAllele} representing a genome.
+ */
+ IAllele[] getTemplate(String identifier);
+
+ /**
+ * @return Default individual template for use when stuff breaks.
+ */
+ IAllele[] getDefaultTemplate();
+
+ /**
+ * @param rand Random to use.
+ * @return A random template from the pool of registered species templates.
+ */
+ IAllele[] getRandomTemplate(Random rand);
+
+ Map getGenomeTemplates();
+ ArrayList extends IIndividual> getIndividualTemplates();
+
+ /* MUTATIONS */
+ /**
+ * Use to register mutations.
+ *
+ * @param mutation
+ */
+ void registerMutation(IMutation mutation);
+
+ /**
+ * @return All registered mutations.
+ */
+ Collection extends IMutation> getMutations(boolean shuffle);
+
+ /**
+ * @param other Allele to match mutations against.
+ * @return All registered mutations the given allele is part of.
+ */
+ Collection extends IMutation> getCombinations(IAllele other);
+
+ /**
+ * @since Forestry 3.7
+ * @return all possible mutations that result from breeding two species
+ */
+ List getCombinations(IAlleleSpecies parentSpecies0, IAlleleSpecies parentSpecies1, boolean shuffle);
+
+ Collection extends IMutation> getPaths(IAllele result, IChromosomeType chromosomeType);
+
+ /* RESEARCH */
+ /**
+ * @return List of generic catalysts which should be accepted for research by species of this class.
+ */
+ Map getResearchCatalysts();
+
+ /**
+ * Sets an item stack as a valid (generic) research catalyst for this class.
+ * @param itemstack ItemStack to set as suitable.
+ * @param suitability Float between 0 and 1 to indicate suitability.
+ */
+ void setResearchSuitability(ItemStack itemstack, float suitability);
+
+ /**
+ * @return Array of {@link IChromosomeType} which are in this species genome
+ */
+ IChromosomeType[] getKaryotype();
+
+ /**
+ * @return {@link IChromosomeType} which is the "key" for this species class, usually the species chromosome.
+ */
+ IChromosomeType getKaryotypeKey();
+}
diff --git a/src/main/java/forestry/api/genetics/ISpeciesType.java b/src/main/java/forestry/api/genetics/ISpeciesType.java
new file mode 100644
index 000000000..036b9b8cd
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/ISpeciesType.java
@@ -0,0 +1,10 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.genetics;
+
+/** Species types, implemented by enums and compared with == */
+public interface ISpeciesType {
+}
diff --git a/src/main/java/forestry/api/genetics/package-info.java b/src/main/java/forestry/api/genetics/package-info.java
new file mode 100644
index 000000000..1d7804648
--- /dev/null
+++ b/src/main/java/forestry/api/genetics/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion = "4.7.1", owner = "ForestryAPI|core", provides = "ForestryAPI|genetics")
+package forestry.api.genetics;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/energy/circuits/CircuitElectricChoke.java b/src/main/java/forestry/api/lepidopterology/ButterflyManager.java
old mode 100755
new mode 100644
similarity index 72%
rename from src/main/java/forestry/energy/circuits/CircuitElectricChoke.java
rename to src/main/java/forestry/api/lepidopterology/ButterflyManager.java
index 859aae6bc..1620b8849
--- a/src/main/java/forestry/energy/circuits/CircuitElectricChoke.java
+++ b/src/main/java/forestry/api/lepidopterology/ButterflyManager.java
@@ -8,13 +8,14 @@
* Various Contributors including, but not limited to:
* SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges
******************************************************************************/
-package forestry.energy.circuits;
+package forestry.api.lepidopterology;
-public class CircuitElectricChoke extends CircuitElectricChange {
+public class ButterflyManager {
- public CircuitElectricChoke(String uid) {
- super(uid, false);
- this.configureChange(-2, -10);
- this.setLimit(1);
- }
+ public static IButterflyRoot butterflyRoot;
+
+ /**
+ * Used to create new butterflies.
+ */
+ public static IButterflyFactory butterflyFactory;
}
diff --git a/src/main/java/forestry/api/lepidopterology/EnumButterflyChromosome.java b/src/main/java/forestry/api/lepidopterology/EnumButterflyChromosome.java
new file mode 100644
index 000000000..798c898f2
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/EnumButterflyChromosome.java
@@ -0,0 +1,99 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import java.util.Locale;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IAlleleArea;
+import forestry.api.genetics.IAlleleBoolean;
+import forestry.api.genetics.IAlleleFloat;
+import forestry.api.genetics.IAlleleFlowers;
+import forestry.api.genetics.IAlleleInteger;
+import forestry.api.genetics.IAlleleTolerance;
+import forestry.api.genetics.IChromosomeType;
+import forestry.api.genetics.ISpeciesRoot;
+
+public enum EnumButterflyChromosome implements IChromosomeType {
+ /**
+ * Species of the bee. Alleles here must implement {@link IAlleleButterflySpecies}.
+ */
+ SPECIES(IAlleleButterflySpecies.class),
+ /**
+ * Physical size.
+ */
+ SIZE(IAlleleFloat.class),
+ /**
+ * Flight speed.
+ */
+ SPEED(IAlleleFloat.class),
+ /**
+ * How long the butterfly can last without access to matching pollinatables.
+ */
+ LIFESPAN(IAlleleInteger.class),
+ /**
+ * Species with a higher metabolism have a higher appetite and may cause more damage to their environment.
+ */
+ METABOLISM(IAlleleInteger.class),
+ /**
+ * Determines likelyhood of caterpillars and length of caterpillar/pupation phase. Also: Number of max caterpillars after mating?
+ */
+ FERTILITY(IAlleleInteger.class),
+ /**
+ * Not sure yet.
+ */
+ TEMPERATURE_TOLERANCE(IAlleleTolerance.class),
+ /**
+ * Not sure yet.
+ */
+ HUMIDITY_TOLERANCE(IAlleleTolerance.class),
+ /**
+ * Only nocturnal butterflys/moths will fly at night. Allows daylight activity for naturally nocturnal species.
+ */
+ NOCTURNAL(IAlleleBoolean.class),
+ /**
+ * Only tolerant flyers will fly in the rain.
+ */
+ TOLERANT_FLYER(IAlleleBoolean.class),
+ /**
+ * Fire resistance.
+ */
+ FIRE_RESIST(IAlleleBoolean.class),
+ /**
+ * Required flowers/leaves.
+ */
+ FLOWER_PROVIDER(IAlleleFlowers.class),
+ /**
+ * Extra effect to surroundings. (?)
+ */
+ EFFECT(IAlleleButterflyEffect.class),
+ /**
+ * Not used yet
+ */
+ TERRITORY(IAlleleArea.class),
+ ;
+
+ Class extends IAllele> clss;
+
+ EnumButterflyChromosome(Class extends IAllele> clss) {
+ this.clss = clss;
+ }
+
+ @Override
+ public Class extends IAllele> getAlleleClass() {
+ return clss;
+ }
+
+ @Override
+ public String getName() {
+ return this.toString().toLowerCase(Locale.ENGLISH);
+ }
+
+ @Override
+ public ISpeciesRoot getSpeciesRoot() {
+ return ButterflyManager.butterflyRoot;
+ }
+}
diff --git a/src/main/java/forestry/api/lepidopterology/EnumFlutterType.java b/src/main/java/forestry/api/lepidopterology/EnumFlutterType.java
new file mode 100644
index 000000000..d0c7aee60
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/EnumFlutterType.java
@@ -0,0 +1,17 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.ISpeciesType;
+
+public enum EnumFlutterType implements ISpeciesType {
+ BUTTERFLY,
+ SERUM,
+ CATERPILLAR,
+ NONE;
+
+ public static final EnumFlutterType[] VALUES = values();
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IAlleleButterflyEffect.java b/src/main/java/forestry/api/lepidopterology/IAlleleButterflyEffect.java
new file mode 100644
index 000000000..6457dbe89
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IAlleleButterflyEffect.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.IAlleleEffect;
+import forestry.api.genetics.IEffectData;
+
+public interface IAlleleButterflyEffect extends IAlleleEffect {
+
+ /**
+ * Used by butterflies to trigger effects in the world.
+ * @param butterfly {@link IEntityButterfly}
+ * @param storedData
+ * @return {@link forestry.api.genetics.IEffectData} for the next cycle.
+ */
+ IEffectData doEffect(IEntityButterfly butterfly, IEffectData storedData);
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IAlleleButterflySpecies.java b/src/main/java/forestry/api/lepidopterology/IAlleleButterflySpecies.java
new file mode 100644
index 000000000..c397b0422
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IAlleleButterflySpecies.java
@@ -0,0 +1,62 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import java.util.EnumSet;
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+
+import net.minecraftforge.common.BiomeDictionary;
+import forestry.api.core.ISpriteProvider;
+import forestry.api.genetics.IAlleleSpecies;
+
+public interface IAlleleButterflySpecies extends IAlleleSpecies {
+
+ /**
+ * @return the IBeeRoot
+ */
+ @Override
+ IButterflyRoot getRoot();
+
+ /**
+ * @return Path of the texture to use for entity rendering.
+ */
+ String getEntityTexture();
+
+ /**
+ * Allows butterflies to restrict random spawns beyond the restrictions set by getTemperature() and getHumidity().
+ *
+ * @return EnumSet of biome tags this butterfly species can be spawned in.
+ */
+ EnumSet getSpawnBiomes();
+
+ /**
+ * @return true if a prospective spawn biome must not match a biome tag outside of getSpawnBiomes.
+ */
+ boolean strictSpawnMatch();
+
+ /**
+ * @return Float between 0 and 1 representing the rarity of the species, will affect spawn rate.
+ */
+ float getRarity();
+
+ /**
+ * @return Float representing the distance below which this butterfly will take flight if it detects a player which is not sneaking.
+ */
+ float getFlightDistance();
+
+ /**
+ * @return true if this species is only active at night.
+ */
+ boolean isNocturnal();
+
+ Map getButterflyLoot();
+
+ Map getCaterpillarLoot();
+
+ ISpriteProvider getSpriteProvider();
+}
diff --git a/src/main/java/forestry/energy/circuits/CircuitElectricBoost.java b/src/main/java/forestry/api/lepidopterology/IAlleleButterflySpeciesCustom.java
old mode 100755
new mode 100644
similarity index 61%
rename from src/main/java/forestry/energy/circuits/CircuitElectricBoost.java
rename to src/main/java/forestry/api/lepidopterology/IAlleleButterflySpeciesCustom.java
index 5cca5bf28..e89fd0fdd
--- a/src/main/java/forestry/energy/circuits/CircuitElectricBoost.java
+++ b/src/main/java/forestry/api/lepidopterology/IAlleleButterflySpeciesCustom.java
@@ -8,14 +8,12 @@
* Various Contributors including, but not limited to:
* SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges
******************************************************************************/
-package forestry.energy.circuits;
+package forestry.api.lepidopterology;
-public class CircuitElectricBoost extends CircuitElectricChange {
-
- public CircuitElectricBoost(String uid, int limit, int eu, int rf) {
- super(uid, false);
- this.setLimit(limit);
- this.configureChange(eu, rf);
- }
+import forestry.api.genetics.IAlleleSpeciesCustom;
+public interface IAlleleButterflySpeciesCustom extends IAlleleButterflySpecies, IAlleleSpeciesCustom {
+ IAlleleButterflySpeciesCustom setRarity(float rarity);
+ IAlleleButterflySpeciesCustom setFlightDistance(float flightDistance);
+ IAlleleButterflySpeciesCustom setNocturnal();
}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterfly.java b/src/main/java/forestry/api/lepidopterology/IButterfly.java
new file mode 100644
index 000000000..97aec520e
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterfly.java
@@ -0,0 +1,80 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+import forestry.api.genetics.IIndividualLiving;
+
+public interface IButterfly extends IIndividualLiving {
+
+ @Override
+ IButterflyGenome getGenome();
+
+ /**
+ * @return Genetic information of the mate, null if unmated.
+ */
+ @Override
+ IButterflyGenome getMate();
+
+ /**
+ * @return Physical size of the butterfly.
+ */
+ float getSize();
+
+ /**
+ * @param world
+ * @param x
+ * @param y
+ * @param z
+ * @return true if the butterfly can naturally spawn at the given location at this time. (Used to auto-spawn butterflies from tree leaves.)
+ */
+ boolean canSpawn(World world, double x, double y, double z);
+
+ /**
+ * @param world
+ * @param x
+ * @param y
+ * @param z
+ * @return true if the butterfly can take flight at the given location at this time. (Used to auto-spawn butterflies from dropped items.)
+ */
+ boolean canTakeFlight(World world, double x, double y, double z);
+
+ /**
+ * @param world
+ * @param x
+ * @param y
+ * @param z
+ * @return true if the environment (temperature, humidity) is valid for the butterfly at the given location.
+ */
+ boolean isAcceptedEnvironment(World world, double x, double y, double z);
+
+ IButterfly spawnCaterpillar(IButterflyNursery nursery);
+
+ /**
+ * @param entity
+ * @param playerKill Whether or not the butterfly was killed by a player.
+ * @param lootLevel Loot level according to the weapon used to kill the butterfly.
+ * @return Array of itemstacks to drop on death of the given entity.
+ */
+ ItemStack[] getLootDrop(IEntityButterfly entity, boolean playerKill, int lootLevel);
+
+ /**
+ * @param nursery
+ * @param playerKill Whether or not the nursery was broken by a player.
+ * @param lootLevel Fortune level.
+ * @return Array of itemstacks to drop on breaking of the nursery.
+ */
+ ItemStack[] getCaterpillarDrop(IButterflyNursery nursery, boolean playerKill, int lootLevel);
+
+ /**
+ * Create an exact copy of this butterfly.
+ */
+ @Override
+ IButterfly copy();
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterflyFactory.java b/src/main/java/forestry/api/lepidopterology/IButterflyFactory.java
new file mode 100644
index 000000000..b66407ab1
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterflyFactory.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright (c) 2011-2014 SirSengir.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the GNU Lesser Public License v3
+ * which accompanies this distribution, and is available at
+ * http://www.gnu.org/licenses/lgpl-3.0.txt
+ *
+ * Various Contributors including, but not limited to:
+ * SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import java.awt.Color;
+
+import forestry.api.genetics.IClassification;
+
+public interface IButterflyFactory {
+ /**
+ * Creates a new butterfly species.
+ * Automatically registered with AlleleManager.alleleRegistry.registerAllele()
+ * See IAlleleButterflySpeciesCustom and IAlleleSpeciesCustom for adding additional properties to the returned species.
+ *
+ * @param uid Unique Identifier for this species
+ * @param unlocalizedName Unlocalized name for this species
+ * @param authority Authority for the binomial name, e.g. "Sengir" on species of base Forestry.
+ * @param unlocalizedDescription Unlocalized description for this species
+ * @param texturePath String texture path for this butterfly e.g. "forestry:textures/entities/butterfly/..."
+ * @param dominant Whether this species is genetically dominant (false means it is recessive)
+ * @param branch Classification of this species
+ * @param binomial Binomial name of the species sans genus. "humboldti" will have the bee species flavour name be "Apis humboldti". Feel free to use fun names or null.
+ * @param serumColour The color of this butterfly's serum.
+ * @return a new butterfly species allele.
+ */
+ IAlleleButterflySpeciesCustom createSpecies(String uid, String unlocalizedName, String authority, String unlocalizedDescription, String texturePath, boolean dominant, IClassification branch, String binomial, Color serumColour);
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterflyGenome.java b/src/main/java/forestry/api/lepidopterology/IButterflyGenome.java
new file mode 100644
index 000000000..2659a3de3
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterflyGenome.java
@@ -0,0 +1,44 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.EnumTolerance;
+import forestry.api.genetics.IFlowerProvider;
+import forestry.api.genetics.IGenome;
+
+public interface IButterflyGenome extends IGenome {
+
+ @Override
+ IAlleleButterflySpecies getPrimary();
+
+ @Override
+ IAlleleButterflySpecies getSecondary();
+
+ float getSize();
+
+ int getLifespan();
+
+ int getMetabolism();
+
+ int getFertility();
+
+ float getSpeed();
+
+ EnumTolerance getToleranceTemp();
+
+ EnumTolerance getToleranceHumid();
+
+ boolean getNocturnal();
+
+ boolean getTolerantFlyer();
+
+ boolean getFireResist();
+
+ IFlowerProvider getFlowerProvider();
+
+ IAlleleButterflyEffect getEffect();
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterflyMutation.java b/src/main/java/forestry/api/lepidopterology/IButterflyMutation.java
new file mode 100644
index 000000000..027e96eb2
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterflyMutation.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IGenome;
+import forestry.api.genetics.IMutation;
+
+public interface IButterflyMutation extends IMutation {
+ float getChance(IButterflyNursery housing, IAllele allele0, IAllele allele1, IGenome genome0, IGenome genome1);
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterflyNursery.java b/src/main/java/forestry/api/lepidopterology/IButterflyNursery.java
new file mode 100644
index 000000000..56e42f2ec
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterflyNursery.java
@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.IHousing;
+import forestry.api.genetics.IIndividual;
+
+public interface IButterflyNursery extends IHousing {
+
+ IButterfly getCaterpillar();
+
+ IIndividual getNanny();
+
+ void setCaterpillar(IButterfly butterfly);
+
+ boolean canNurse(IButterfly butterfly);
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IButterflyRoot.java b/src/main/java/forestry/api/lepidopterology/IButterflyRoot.java
new file mode 100644
index 000000000..41ea06e4a
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IButterflyRoot.java
@@ -0,0 +1,76 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+import net.minecraft.entity.EntityLiving;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.world.World;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.genetics.IAllele;
+import forestry.api.genetics.IIndividual;
+import forestry.api.genetics.ISpeciesRoot;
+
+public interface IButterflyRoot extends ISpeciesRoot {
+
+ @Override
+ boolean isMember(ItemStack stack);
+
+ @Override
+ IButterfly getMember(ItemStack stack);
+
+ @Override
+ IButterfly getMember(NBTTagCompound compound);
+
+ @Override
+ ItemStack getMemberStack(IIndividual butterfly, int type);
+
+ /* GENOME CONVERSION */
+ @Override
+ IButterfly templateAsIndividual(IAllele[] template);
+
+ @Override
+ IButterfly templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive);
+
+ @Override
+ IButterflyGenome templateAsGenome(IAllele[] template);
+
+ @Override
+ IButterflyGenome templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive);
+
+ /* BUTTERFLY SPECIFIC */
+ @Override
+ ILepidopteristTracker getBreedingTracker(World world, GameProfile player);
+
+ /**
+ * Spawns the given butterfly in the world.
+ * @param butterfly
+ * @return butterfly entity on success, null otherwise.
+ */
+ EntityLiving spawnButterflyInWorld(World world, IButterfly butterfly, double x, double y, double z);
+
+ /**
+ * @return true if passed item is mated.
+ */
+ boolean isMated(ItemStack stack);
+
+ /* TEMPLATES */
+ @Override
+ ArrayList getIndividualTemplates();
+
+ /* MUTATIONS */
+ @Override
+ Collection getMutations(boolean shuffle);
+
+ @Override
+ EnumFlutterType getType(ItemStack stack);
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/IEntityButterfly.java b/src/main/java/forestry/api/lepidopterology/IEntityButterfly.java
new file mode 100644
index 000000000..963c72103
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/IEntityButterfly.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import net.minecraft.entity.EntityCreature;
+import net.minecraft.entity.passive.IAnimals;
+
+import forestry.api.genetics.IIndividual;
+
+public interface IEntityButterfly extends IAnimals {
+
+ void changeExhaustion(int change);
+
+ int getExhaustion();
+
+ IButterfly getButterfly();
+
+ /**
+ * @return The entity as an EntityCreature to save casting.
+ */
+ EntityCreature getEntity();
+
+ IIndividual getPollen();
+
+ void setPollen(IIndividual pollen);
+}
diff --git a/src/main/java/forestry/api/lepidopterology/ILepidopteristTracker.java b/src/main/java/forestry/api/lepidopterology/ILepidopteristTracker.java
new file mode 100644
index 000000000..79926975f
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/ILepidopteristTracker.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.lepidopterology;
+
+import forestry.api.genetics.IBreedingTracker;
+
+public interface ILepidopteristTracker extends IBreedingTracker {
+
+ void registerCatch(IButterfly butterfly);
+
+}
diff --git a/src/main/java/forestry/api/lepidopterology/package-info.java b/src/main/java/forestry/api/lepidopterology/package-info.java
new file mode 100644
index 000000000..827f1c9f1
--- /dev/null
+++ b/src/main/java/forestry/api/lepidopterology/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="1.3.0", owner="ForestryAPI|core", provides="ForestryAPI|lepidopterology")
+package forestry.api.lepidopterology;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/mail/EnumAddressee.java b/src/main/java/forestry/api/mail/EnumAddressee.java
new file mode 100644
index 000000000..64dc6b5e7
--- /dev/null
+++ b/src/main/java/forestry/api/mail/EnumAddressee.java
@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import java.util.Locale;
+
+public enum EnumAddressee {
+ PLAYER, TRADER;
+
+ public static EnumAddressee fromString(String ident) {
+ ident = ident.toLowerCase(Locale.ENGLISH);
+ for(EnumAddressee addr : values()) {
+ if(addr.toString().equals(ident))
+ return addr;
+ }
+
+ return null;
+ }
+
+ @Override
+ public String toString() {
+ return super.toString().toLowerCase(Locale.ENGLISH);
+ }
+}
diff --git a/src/main/java/forestry/api/mail/EnumPostage.java b/src/main/java/forestry/api/mail/EnumPostage.java
new file mode 100644
index 000000000..772114fb0
--- /dev/null
+++ b/src/main/java/forestry/api/mail/EnumPostage.java
@@ -0,0 +1,20 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+public enum EnumPostage {
+ P_0(0), P_1(1), P_2(2), P_5(5), P_10(10), P_20(20), P_50(50), P_100(100), P_200(200);
+
+ private final int value;
+
+ private EnumPostage(int value) {
+ this.value = value;
+ }
+
+ public int getValue() {
+ return this.value;
+ }
+}
diff --git a/src/main/java/forestry/api/mail/ILetter.java b/src/main/java/forestry/api/mail/ILetter.java
new file mode 100644
index 000000000..42df8acb5
--- /dev/null
+++ b/src/main/java/forestry/api/mail/ILetter.java
@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import java.util.List;
+
+import net.minecraft.inventory.IInventory;
+import net.minecraft.item.ItemStack;
+
+import forestry.api.core.INBTTagable;
+
+public interface ILetter extends IInventory, INBTTagable {
+
+ ItemStack[] getPostage();
+
+ void setProcessed(boolean flag);
+
+ boolean isProcessed();
+
+ boolean isMailable();
+
+ void setSender(IMailAddress address);
+
+ IMailAddress getSender();
+
+ boolean hasRecipient();
+
+ void setRecipient(IMailAddress address);
+
+ IMailAddress[] getRecipients();
+
+ String getRecipientString();
+
+ void setText(String text);
+
+ String getText();
+
+ void addTooltip(List list);
+
+ boolean isPostPaid();
+
+ int requiredPostage();
+
+ void invalidatePostage();
+
+ ItemStack[] getAttachments();
+
+ void addAttachment(ItemStack itemstack);
+
+ void addAttachments(ItemStack[] itemstacks);
+
+ int countAttachments();
+
+ void addStamps(ItemStack stamps);
+
+}
diff --git a/src/main/java/forestry/api/mail/ILetterHandler.java b/src/main/java/forestry/api/mail/ILetterHandler.java
new file mode 100644
index 000000000..576a0d7da
--- /dev/null
+++ b/src/main/java/forestry/api/mail/ILetterHandler.java
@@ -0,0 +1,13 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+public interface ILetterHandler {
+ IPostalState handleLetter(World world, IMailAddress recipient, ItemStack letterStack, boolean doLodge);
+}
diff --git a/src/main/java/forestry/api/mail/IMailAddress.java b/src/main/java/forestry/api/mail/IMailAddress.java
new file mode 100644
index 000000000..8441b09a4
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IMailAddress.java
@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import com.mojang.authlib.GameProfile;
+
+import forestry.api.core.INBTTagable;
+
+public interface IMailAddress extends INBTTagable {
+
+ EnumAddressee getType();
+ String getName();
+
+ boolean isValid();
+
+ boolean isPlayer();
+ boolean isTrader();
+
+ GameProfile getPlayerProfile();
+}
diff --git a/src/main/java/forestry/api/mail/IPostOffice.java b/src/main/java/forestry/api/mail/IPostOffice.java
new file mode 100644
index 000000000..a8a14eac1
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IPostOffice.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+public interface IPostOffice {
+
+ void collectPostage(ItemStack[] stamps);
+
+ IPostalState lodgeLetter(World world, ItemStack itemstack, boolean doLodge);
+
+ ItemStack getAnyStamp(int max);
+
+ ItemStack getAnyStamp(EnumPostage postage, int max);
+
+ ItemStack getAnyStamp(EnumPostage[] postages, int max);
+
+ void registerTradeStation(ITradeStation trade);
+
+ void deregisterTradeStation(ITradeStation trade);
+
+ Map getActiveTradeStations(World world);
+}
diff --git a/src/main/java/forestry/api/mail/IPostRegistry.java b/src/main/java/forestry/api/mail/IPostRegistry.java
new file mode 100644
index 000000000..f20352d93
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IPostRegistry.java
@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+
+import com.mojang.authlib.GameProfile;
+
+public interface IPostRegistry {
+
+ /* POST OFFICE */
+ IPostOffice getPostOffice(World world);
+
+ /* MAIL ADDRESSES */
+ IMailAddress getMailAddress(GameProfile gameProfile);
+ IMailAddress getMailAddress(String traderName);
+
+ /* LETTERS */
+ boolean isLetter(ItemStack itemstack);
+
+ ILetter createLetter(IMailAddress sender, IMailAddress recipient);
+
+ ILetter getLetter(ItemStack itemstack);
+
+ ItemStack createLetterStack(ILetter letter);
+
+ /* CARRIERS */
+ /**
+ * Registers a new {@link IPostalCarrier}. See {@link IPostalCarrier} for details.
+ * @param carrier {@link IPostalCarrier} to register.
+ */
+ void registerCarrier(IPostalCarrier carrier);
+
+ IPostalCarrier getCarrier(EnumAddressee uid);
+
+ Map getRegisteredCarriers();
+
+ /* TRADE STATIONS */
+ void deleteTradeStation(World world, IMailAddress address);
+
+ ITradeStation getOrCreateTradeStation(World world, GameProfile owner, IMailAddress address);
+
+ ITradeStation getTradeStation(World world, IMailAddress address);
+
+ boolean isAvailableTradeAddress(World world, IMailAddress address);
+
+ boolean isValidTradeAddress(World world, IMailAddress address);
+
+ /* PO BOXES */
+ boolean isValidPOBox(World world, IMailAddress address);
+
+}
diff --git a/src/main/java/forestry/api/mail/IPostalCarrier.java b/src/main/java/forestry/api/mail/IPostalCarrier.java
new file mode 100644
index 000000000..e3b22b1d0
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IPostalCarrier.java
@@ -0,0 +1,47 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.item.ItemStack;
+import net.minecraft.world.World;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
+
+/**
+ * Postal Carriers are systems which can be hooked into Forestry's mail system to handle mail delivery.
+ *
+ * The two available carriers in vanilla Forestry are
+ * "player" - Delivers mail to individual players.
+ * "trader" - Handles mail addressed to trade stations.
+ */
+public interface IPostalCarrier {
+
+ /**
+ * @return An EnumAddressee identifying the type of carrier
+ */
+ EnumAddressee getType();
+
+ /**
+ * @return A human-readable name for this carrier.
+ */
+ String getName();
+
+ @SideOnly(Side.CLIENT)
+ TextureAtlasSprite getSprite();
+
+ /**
+ * Handle delivery of a letter addressed to this carrier.
+ * @param world The world the {@link IPostOffice} handles.
+ * @param office {link @IPostOffice} which received this letter and handed it to the carrier.
+ * @param recipient An identifier for the recipient as typed by the player into the address field.
+ * @param letterstack ItemStack representing the letter. See {@link IPostRegistry} for helper functions to validate and extract it.
+ * @param doDeliver Whether or not the letter is supposed to actually be delivered or if delivery is only to be simulated.
+ * @return {link IPostalState} holding information on success or failure for delivery.
+ */
+ IPostalState deliverLetter(World world, IPostOffice office, IMailAddress recipient, ItemStack letterstack, boolean doDeliver);
+
+}
diff --git a/src/main/java/forestry/api/mail/IPostalState.java b/src/main/java/forestry/api/mail/IPostalState.java
new file mode 100644
index 000000000..bc843621a
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IPostalState.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+public interface IPostalState {
+ boolean isOk();
+
+ String getIdentifier();
+
+ int ordinal();
+}
diff --git a/src/main/java/forestry/api/mail/IStamps.java b/src/main/java/forestry/api/mail/IStamps.java
new file mode 100644
index 000000000..4332a811c
--- /dev/null
+++ b/src/main/java/forestry/api/mail/IStamps.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import net.minecraft.item.ItemStack;
+
+public interface IStamps {
+
+ EnumPostage getPostage(ItemStack itemstack);
+
+}
diff --git a/src/main/java/forestry/api/mail/ITradeStation.java b/src/main/java/forestry/api/mail/ITradeStation.java
new file mode 100644
index 000000000..78a498a04
--- /dev/null
+++ b/src/main/java/forestry/api/mail/ITradeStation.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import net.minecraft.inventory.IInventory;
+
+public interface ITradeStation extends ILetterHandler, IInventory {
+
+ IMailAddress getAddress();
+
+ boolean isValid();
+
+ void invalidate();
+
+ void setVirtual(boolean isVirtual);
+
+ boolean isVirtual();
+
+ TradeStationInfo getTradeInfo();
+
+}
diff --git a/src/main/java/forestry/api/mail/PostManager.java b/src/main/java/forestry/api/mail/PostManager.java
new file mode 100644
index 000000000..c3f0e45bb
--- /dev/null
+++ b/src/main/java/forestry/api/mail/PostManager.java
@@ -0,0 +1,11 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+
+public class PostManager {
+ public static IPostRegistry postRegistry;
+}
diff --git a/src/main/java/forestry/api/mail/TradeStationInfo.java b/src/main/java/forestry/api/mail/TradeStationInfo.java
new file mode 100644
index 000000000..14424bedf
--- /dev/null
+++ b/src/main/java/forestry/api/mail/TradeStationInfo.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.mail;
+
+import java.lang.IllegalArgumentException;
+import net.minecraft.item.ItemStack;
+import com.mojang.authlib.GameProfile;
+
+public class TradeStationInfo {
+ public final IMailAddress address;
+ public final GameProfile owner;
+ public final ItemStack tradegood;
+ public final ItemStack[] required;
+ public final IPostalState state;
+
+ public TradeStationInfo(IMailAddress address, GameProfile owner, ItemStack tradegood, ItemStack[] required, IPostalState state) {
+ if (!address.isTrader()) {
+ throw new IllegalArgumentException("TradeStation address must be a trader");
+ }
+ this.address = address;
+ this.owner = owner;
+ this.tradegood = tradegood;
+ this.required = required;
+ this.state = state;
+ }
+}
diff --git a/src/main/java/forestry/api/mail/package-info.java b/src/main/java/forestry/api/mail/package-info.java
new file mode 100644
index 000000000..3f5491f12
--- /dev/null
+++ b/src/main/java/forestry/api/mail/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion="3.0.0", owner="ForestryAPI|core", provides="ForestryAPI|mail")
+package forestry.api.mail;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/multiblock/IAlvearyComponent.java b/src/main/java/forestry/api/multiblock/IAlvearyComponent.java
new file mode 100644
index 000000000..92c96d387
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IAlvearyComponent.java
@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import forestry.api.apiculture.IBeeListener;
+import forestry.api.apiculture.IBeeModifier;
+import forestry.api.core.IClimateControlled;
+
+/**
+ * Needs to be implemented by TileEntities that want to be part of an alveary.
+ * The sub-interfaces can be implemented to alter the operation of the alveary.
+ * They are automatically detected and handled by the alveary when they join its structure.
+ */
+public interface IAlvearyComponent extends IMultiblockComponent {
+ /**
+ * @return the multiblock logic for this component
+ */
+ @Override
+ T getMultiblockLogic();
+
+ /**
+ * Implemented by alveary parts to apply a beeListener to the completed structure.
+ */
+ interface BeeListener extends IAlvearyComponent {
+ IBeeListener getBeeListener();
+ }
+
+ /**
+ * Implemented by alveary parts to apply a beeModifier to the completed structure.
+ */
+ interface BeeModifier extends IAlvearyComponent {
+ IBeeModifier getBeeModifier();
+ }
+
+ /**
+ * Implemented by alveary parts to apply a climate change to the completed structure.
+ */
+ interface Climatiser extends IAlvearyComponent {
+ /**
+ * Called every tick by the alveary.
+ * @param tickCount the number of ticks in the world
+ * @param alveary the climate controlled alveary
+ */
+ void changeClimate(int tickCount, IClimateControlled alveary);
+ }
+
+ /**
+ * Implemented by alveary parts to receive ticks from the completed structure.
+ */
+ interface Active extends IAlvearyComponent {
+ void updateServer(int tickCount);
+ void updateClient(int tickCount);
+ }
+
+}
diff --git a/src/main/java/forestry/api/multiblock/IAlvearyController.java b/src/main/java/forestry/api/multiblock/IAlvearyController.java
new file mode 100644
index 000000000..9645fc794
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IAlvearyController.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import forestry.api.apiculture.IBeeHousing;
+
+/**
+ * The IAlvearyController provides access to all the IMultiblockController and IBeeHousing methods
+ * necessary for an IAlvearyComponent to function.
+ */
+public interface IAlvearyController extends IMultiblockController, IBeeHousing {
+
+}
diff --git a/src/main/java/forestry/api/multiblock/IFarmComponent.java b/src/main/java/forestry/api/multiblock/IFarmComponent.java
new file mode 100644
index 000000000..28f22dacc
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IFarmComponent.java
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import forestry.api.farming.IFarmListener;
+
+/**
+ * Needs to be implemented by TileEntities that want to be part of a farm.
+ * The sub-interfaces can be implemented to alter the operation of the farm.
+ * They are automatically detected and handled by the farm when they join its structure.
+ */
+public interface IFarmComponent extends IMultiblockComponent {
+
+ /**
+ * @return the multiblock logic for this component
+ */
+ @Override
+ T getMultiblockLogic();
+
+ /**
+ * Implemented by farm parts to apply a farmListener to the completed structure.
+ */
+ interface Listener extends IFarmComponent {
+ IFarmListener getFarmListener();
+ }
+
+ /**
+ * Implemented by farm parts to receive ticks from the completed structure.
+ */
+ interface Active extends IFarmComponent {
+ void updateServer(int tickCount);
+ void updateClient(int tickCount);
+ }
+}
diff --git a/src/main/java/forestry/api/multiblock/IFarmController.java b/src/main/java/forestry/api/multiblock/IFarmController.java
new file mode 100644
index 000000000..7629a0e80
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IFarmController.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import forestry.api.farming.IFarmHousing;
+
+/**
+ * The IFarmController provides access to all the IMultiblockController and IFarmHousing methods
+ * necessary for an IFarmComponent to function.
+ */
+public interface IFarmController extends IMultiblockController, IFarmHousing {
+
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockComponent.java b/src/main/java/forestry/api/multiblock/IMultiblockComponent.java
new file mode 100644
index 000000000..305af916d
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockComponent.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import com.mojang.authlib.GameProfile;
+
+import net.minecraft.util.BlockPos;
+
+/**
+ * Basic interface for a multiblock machine component.
+ * Implemented by TileEntities.
+ */
+public interface IMultiblockComponent {
+
+ /**
+ * Returns the location of this tile entity in the world.
+ * @return ChunkCoordinates set to the location of this tile entity in the world.
+ */
+ BlockPos getCoordinates();
+
+ /**
+ * @return the gameProfile of the player who owns this single component (not the entire multiblock)
+ */
+ GameProfile getOwner();
+
+ /**
+ * @return the multiblock logic for this part
+ */
+ IMultiblockLogic getMultiblockLogic();
+
+ /**
+ * Called when a machine is fully assembled from the disassembled state, meaning
+ * it was constructed by a player/entity action, not by chunks loading.
+ * Note that, for non-square machines, the min/max coordinates may not actually be part
+ * of the machine! They form an outer bounding box for the whole machine itself.
+ * @param multiblockController The controller to which this part is being assembled.
+ */
+ void onMachineAssembled(IMultiblockController multiblockController, BlockPos minCoord, BlockPos maxCoord);
+
+ /**
+ * Called when the machine is broken for game reasons, e.g. a player removed a block
+ * or an explosion occurred.
+ */
+ void onMachineBroken();
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockController.java b/src/main/java/forestry/api/multiblock/IMultiblockController.java
new file mode 100644
index 000000000..f9e86bdd8
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockController.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import javax.annotation.Nonnull;
+import java.util.Collection;
+
+/**
+ * IMultiblockController is used to handle the assembly of Multiblocks.
+ * This class is created and updated by IMultiblockLogic and Forestry.
+ * This is a minimal interface to hide the ugly details from the multiblock tile entities.
+ */
+public interface IMultiblockController {
+ /**
+ * @return True if this multiblock machine is considered assembled and ready to go.
+ */
+ boolean isAssembled();
+
+ /**
+ * Call to force the controller to check the multiblock's validity.
+ * Use when important conditions around the multiblock change
+ * (i.e. Alveary slabs are removed and the alveary block detects it's neighbor changed)
+ * Changes to multiblock components are handled automatically and should not call this.
+ */
+ void reassemble();
+
+ /**
+ * @return A string representing the last error encountered when trying to assemble this
+ * multiblock, or null if there is no error.
+ */
+ String getLastValidationError();
+
+ /**
+ * @return all the multiblock components attached to this controller
+ */
+ @Nonnull
+ Collection getComponents();
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockLogic.java b/src/main/java/forestry/api/multiblock/IMultiblockLogic.java
new file mode 100644
index 000000000..cd1f4c531
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockLogic.java
@@ -0,0 +1,74 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.world.World;
+
+import forestry.api.core.INBTTagable;
+
+/**
+ * Multiblock Logic implements the basic logic for IMultiblockComponent tile entities.
+ * Instances must come from MultiblockManager.logicFactory, most of the implementation is hidden.
+ *
+ * IMultiblockComponent tile entities must wire up the methods in the "Updating and Synchronization" section.
+ * As a starting point, you can use MultiblockTileEntityBase.
+ */
+public interface IMultiblockLogic extends INBTTagable {
+
+ /**
+ * @return True if this block is connected to a multiblock controller. False otherwise.
+ */
+ boolean isConnected();
+
+ /**
+ * @return the multiblock controller for this logic
+ */
+ IMultiblockController getController();
+
+ /* Updating and Synchronization */
+
+ /**
+ * call on Tile.validate()
+ **/
+ void validate(World world, IMultiblockComponent part);
+
+ /**
+ * call on Tile.invalidate()
+ **/
+ void invalidate(World world, IMultiblockComponent part);
+
+ /**
+ * call on Tile.onChunkUnload()
+ **/
+ void onChunkUnload(World world, IMultiblockComponent part);
+
+ /**
+ * Writes data for client synchronization.
+ * Use this in Tile.getDescriptionPacket()
+ */
+ void encodeDescriptionPacket(NBTTagCompound packetData);
+
+ /**
+ * Reads data for client synchronization.
+ * Use this in Tile.onDataPacket()
+ */
+ void decodeDescriptionPacket(NBTTagCompound packetData);
+
+ /**
+ * Read the logic's data from file.
+ * Use this in Tile.readFromNBT()
+ */
+ @Override
+ void readFromNBT(NBTTagCompound nbttagcompound);
+
+ /**
+ * Write the logic's data to file.
+ * Use this in Tile.writeToNBT()
+ */
+ @Override
+ void writeToNBT(NBTTagCompound nbttagcompound);
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockLogicAlveary.java b/src/main/java/forestry/api/multiblock/IMultiblockLogicAlveary.java
new file mode 100644
index 000000000..611f3c803
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockLogicAlveary.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+public interface IMultiblockLogicAlveary extends IMultiblockLogic {
+ /**
+ * @return the multiblock controller for this logic
+ */
+ @Override
+ IAlvearyController getController();
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockLogicFactory.java b/src/main/java/forestry/api/multiblock/IMultiblockLogicFactory.java
new file mode 100644
index 000000000..50eb52a13
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockLogicFactory.java
@@ -0,0 +1,16 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+/**
+ * Creates new instances of IMultiblockLogic.
+ * Each IMultiblockComponent needs its own instance of IMultiblockLogic.
+ */
+public interface IMultiblockLogicFactory {
+ IMultiblockLogicAlveary createAlvearyLogic();
+
+ IMultiblockLogicFarm createFarmLogic();
+}
diff --git a/src/main/java/forestry/api/multiblock/IMultiblockLogicFarm.java b/src/main/java/forestry/api/multiblock/IMultiblockLogicFarm.java
new file mode 100644
index 000000000..78f599ce6
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/IMultiblockLogicFarm.java
@@ -0,0 +1,14 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+public interface IMultiblockLogicFarm extends IMultiblockLogic {
+ /**
+ * @return the multiblock controller for this logic
+ */
+ @Override
+ IFarmController getController();
+}
diff --git a/src/main/java/forestry/api/multiblock/MultiblockManager.java b/src/main/java/forestry/api/multiblock/MultiblockManager.java
new file mode 100644
index 000000000..c75b03f1b
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/MultiblockManager.java
@@ -0,0 +1,10 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+public class MultiblockManager {
+ public static IMultiblockLogicFactory logicFactory;
+}
diff --git a/src/main/java/forestry/api/multiblock/MultiblockTileEntityBase.java b/src/main/java/forestry/api/multiblock/MultiblockTileEntityBase.java
new file mode 100644
index 000000000..5ad4d3f53
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/MultiblockTileEntityBase.java
@@ -0,0 +1,111 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.multiblock;
+
+import net.minecraft.block.state.IBlockState;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.network.NetworkManager;
+import net.minecraft.network.Packet;
+import net.minecraft.network.play.server.S35PacketUpdateTileEntity;
+import net.minecraft.tileentity.TileEntity;
+import net.minecraft.util.BlockPos;
+import net.minecraft.world.World;
+
+/**
+ * Base logic class for Multiblock-connected tile entities.
+ * Most multiblock components should derive from this.
+ * Supply it an IMultiblockLogic from MultiblockManager.logicFactory
+ */
+public abstract class MultiblockTileEntityBase extends TileEntity implements IMultiblockComponent {
+ private final T multiblockLogic;
+
+ public MultiblockTileEntityBase(T multiblockLogic) {
+ this.multiblockLogic = multiblockLogic;
+ }
+
+ @Override
+ public BlockPos getCoordinates() {
+ return getPos();
+ }
+
+ @Override
+ public T getMultiblockLogic() {
+ return multiblockLogic;
+ }
+
+ @Override
+ public abstract void onMachineAssembled(IMultiblockController multiblockController, BlockPos minCoord, BlockPos maxCoord);
+
+ @Override
+ public abstract void onMachineBroken();
+
+ @Override
+ public void readFromNBT(NBTTagCompound data) {
+ super.readFromNBT(data);
+ multiblockLogic.readFromNBT(data);
+ }
+
+ @Override
+ public void writeToNBT(NBTTagCompound data) {
+ super.writeToNBT(data);
+ multiblockLogic.writeToNBT(data);
+ }
+
+ @Override
+ public final void invalidate() {
+ super.invalidate();
+ multiblockLogic.invalidate(worldObj, this);
+ }
+
+ @Override
+ public final void onChunkUnload() {
+ super.onChunkUnload();
+ multiblockLogic.onChunkUnload(worldObj, this);
+ }
+
+ @Override
+ public final void validate() {
+ super.validate();
+ multiblockLogic.validate(worldObj, this);
+ }
+
+ @Override
+ public boolean shouldRefresh(World world, BlockPos pos, IBlockState oldState, IBlockState newSate)
+ {
+ return oldState.getBlock() != newSate.getBlock();
+ }
+
+ /* Network Communication */
+
+ @Override
+ public final Packet getDescriptionPacket() {
+ NBTTagCompound packetData = new NBTTagCompound();
+ multiblockLogic.encodeDescriptionPacket(packetData);
+ this.encodeDescriptionPacket(packetData);
+ return new S35PacketUpdateTileEntity(getPos(), 0, packetData);
+ }
+
+ @Override
+ public final void onDataPacket(NetworkManager network, S35PacketUpdateTileEntity packet) {
+ NBTTagCompound nbtData = packet.getNbtCompound();
+ multiblockLogic.decodeDescriptionPacket(nbtData);
+ this.decodeDescriptionPacket(nbtData);
+ }
+
+ /**
+ * Used to write tileEntity-specific data to the descriptionPacket
+ */
+ protected void encodeDescriptionPacket(NBTTagCompound packetData) {
+
+ }
+
+ /**
+ * Used to read tileEntity-specific data from the descriptionPacket (onDataPacket)
+ */
+ protected void decodeDescriptionPacket(NBTTagCompound packetData) {
+
+ }
+}
diff --git a/src/main/java/forestry/api/multiblock/package-info.java b/src/main/java/forestry/api/multiblock/package-info.java
new file mode 100644
index 000000000..d13db8ce3
--- /dev/null
+++ b/src/main/java/forestry/api/multiblock/package-info.java
@@ -0,0 +1,9 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+@API(apiVersion = "3.0.0", owner = "ForestryAPI|core", provides = "ForestryAPI|multiblock")
+package forestry.api.multiblock;
+
+import net.minecraftforge.fml.common.API;
diff --git a/src/main/java/forestry/api/recipes/ICarpenterManager.java b/src/main/java/forestry/api/recipes/ICarpenterManager.java
new file mode 100644
index 000000000..9dc700ac8
--- /dev/null
+++ b/src/main/java/forestry/api/recipes/ICarpenterManager.java
@@ -0,0 +1,67 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.recipes;
+
+import net.minecraft.item.ItemStack;
+import net.minecraft.item.crafting.ShapedRecipes;
+
+import net.minecraftforge.fluids.FluidStack;
+
+/**
+ * Provides an interface to the recipe manager of the carpenter.
+ *
+ * The manager is initialized at the beginning of Forestry's BaseMod.load() cycle. Begin adding recipes in BaseMod.ModsLoaded() and this shouldn't be null even
+ * if your mod loads before Forestry.
+ *
+ * Accessible via {@link RecipeManagers}
+ *
+ * Only shaped recipes can be added currently.
+ *
+ * @author SirSengir
+ */
+public interface ICarpenterManager extends ICraftingProvider {
+ /**
+ * Add a shaped recipe to the carpenter.
+ *
+ * @param box
+ * ItemStack of one item representing the required box (carton, crate) for this recipe. May be null.
+ * @param product
+ * Crafting result.
+ * @param materials
+ * Materials needed in the crafting matrix. This gets passed directly to {@link ShapedRecipes}. Notation is the same.
+ */
+ public void addRecipe(ItemStack box, ItemStack product, Object... materials);
+
+ /**
+ * Add a shaped recipe to the carpenter.
+ *
+ * @param packagingTime
+ * Number of work cycles required to craft the recipe once.
+ * @param box
+ * ItemStack of one item representing the required box (carton, crate) for this recipe. May be null.
+ * @param product
+ * Crafting result.
+ * @param materials
+ * Materials needed in the crafting matrix. This gets passed directly to {@link ShapedRecipes}. Notation is the same.
+ */
+ public void addRecipe(int packagingTime, ItemStack box, ItemStack product, Object... materials);
+
+ /**
+ * Add a shaped recipe to the carpenter.
+ *
+ * @param packagingTime
+ * Number of work cycles required to craft the recipe once.
+ * @param liquid
+ * Liquid required in carpenter's tank.
+ * @param box
+ * ItemStack of one item representing the required box (carton, crate) for this recipe. May be null.
+ * @param product
+ * Crafting result.
+ * @param materials
+ * Materials needed in the crafting matrix. This gets passed directly to {@link ShapedRecipes}. Notation is the same.
+ */
+ public void addRecipe(int packagingTime, FluidStack liquid, ItemStack box, ItemStack product, Object... materials);
+}
diff --git a/src/main/java/forestry/api/recipes/ICarpenterRecipe.java b/src/main/java/forestry/api/recipes/ICarpenterRecipe.java
new file mode 100644
index 000000000..cb3e88b77
--- /dev/null
+++ b/src/main/java/forestry/api/recipes/ICarpenterRecipe.java
@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.recipes;
+
+import javax.annotation.Nullable;
+
+import net.minecraft.item.ItemStack;
+
+import net.minecraftforge.fluids.FluidStack;
+
+public interface ICarpenterRecipe extends IForestryRecipe {
+
+ /**
+ * @return Number of work cycles required to craft the recipe once.
+ */
+ int getPackagingTime();
+
+ /**
+ * @return the crafting grid recipe. The crafting recipe's getRecipeOutput() is used as the ICarpenterRecipe's output.
+ */
+ IDescriptiveRecipe getCraftingGridRecipe();
+
+ /**
+ * @return the box required for this recipe. return null if there is no required box.
+ * Examples of boxes are the Forestry cartons and crates.
+ */
+ @Nullable
+ ItemStack getBox();
+
+ /**
+ * @return the fluid required for this recipe. return null if there is no required fluid.
+ */
+ @Nullable
+ FluidStack getFluidResource();
+
+}
diff --git a/src/main/java/forestry/api/recipes/ICentrifugeManager.java b/src/main/java/forestry/api/recipes/ICentrifugeManager.java
new file mode 100644
index 000000000..1d407f07d
--- /dev/null
+++ b/src/main/java/forestry/api/recipes/ICentrifugeManager.java
@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.recipes;
+
+import java.util.Map;
+
+import net.minecraft.item.ItemStack;
+
+/**
+ * Provides an interface to the recipe manager of the centrifuge.
+ *
+ * The manager is initialized at the beginning of Forestry's BaseMod.load() cycle. Begin adding recipes in BaseMod.ModsLoaded() and this shouldn't be null even
+ * if your mod loads before Forestry.
+ *
+ * Accessible via {@link RecipeManagers}
+ *
+ * @author SirSengir
+ */
+public interface ICentrifugeManager extends ICraftingProvider {
+
+ /**
+ * Add a recipe to the centrifuge
+ *
+ * @param timePerItem Time to centrifugate one item of the given type. Default is 20.
+ * @param input ItemStack containing information on item id and damage. Stack size will be ignored.
+ * @param products Specifies the possible products and the chances of them resulting from centrifuging.
+ * Chances are from (0.0 to 1.0]
+ */
+ void addRecipe(int timePerItem, ItemStack input, Map products);
+
+}
diff --git a/src/main/java/forestry/api/recipes/ICentrifugeRecipe.java b/src/main/java/forestry/api/recipes/ICentrifugeRecipe.java
new file mode 100644
index 000000000..595123f43
--- /dev/null
+++ b/src/main/java/forestry/api/recipes/ICentrifugeRecipe.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.recipes;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Random;
+
+import net.minecraft.item.ItemStack;
+
+public interface ICentrifugeRecipe extends IForestryRecipe {
+
+ /** The item for this recipe to match against. **/
+ ItemStack getInput();
+
+ /** The time it takes to process one item. Default is 20. **/
+ int getProcessingTime();
+
+ /** Returns the randomized products from processing one input item. **/
+ Collection getProducts(Random random);
+
+ /**
+ * Returns a list of all possible products and their estimated probabilities (0.0 to 1.0],
+ * to help mods that display recipes
+ **/
+ Map getAllProducts();
+}
diff --git a/src/main/java/forestry/api/recipes/ICraftingProvider.java b/src/main/java/forestry/api/recipes/ICraftingProvider.java
new file mode 100644
index 000000000..9e6ca8945
--- /dev/null
+++ b/src/main/java/forestry/api/recipes/ICraftingProvider.java
@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright 2011-2014 SirSengir
+ *
+ * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
+ ******************************************************************************/
+package forestry.api.recipes;
+
+import java.util.Collection;
+import java.util.Map;
+
+public interface ICraftingProvider {
+ /**
+ * Add a new recipe to the crafting provider.
+ * @return true if this collection changed as a result of the call
+ * @since Forestry 4.1.0
+ */
+ boolean addRecipe(T recipe);
+
+ /**
+ * Remove a specific recipe from the crafting provider.
+ * @return true if an element was removed as a result of this call
+ * @since Forestry 4.1.0
+ */
+ boolean removeRecipe(T recipe);
+
+ /**
+ * @return an unmodifiable collection of all recipes registered to the crafting provider.
+ * @since Forestry 4.1.0
+ */
+ Collection recipes();
+
+ /**
+ * Access to the full list of recipes contained in the crafting provider.
+ *
+ * @return List of the given format where the first array represents inputs and the second outputs. Objects can be either ItemStack or LiquidStack.
+ * @deprecated since Forestry 4.1.0. Use recipes()
+ */
+ @Deprecated
+ Map