package powercrystals.minefactoryreloaded.api;

import net.minecraft.block.Block;
import net.minecraft.world.World;

import java.util.Random;

/**
 * Defines a fertilizable block, and the process to fertilize it. You can assume
 * that you will never have to check that block matches the one returned by
 * getPlant().
 *
 * @author PowerCrystals
 */
public interface IFactoryFertilizable {

	/**
	 * @return The block this instance is managing.
	 */
	public Block getPlant();

	/**
	 * @param world
	 *            The world this block belongs to.
	 * @param x
	 *            The X coordinate of this block.
	 * @param y
	 *            The Y coordinate of this block.
	 * @param z
	 *            The Z coordinate of this block.
	 * @param fertilizerType
	 *            The kind of fertilizer being used.
	 *
	 * @return True if the block at (x,y,z) can be fertilized with the given
	 *         type of fertilizer.
	 */
	public boolean canFertilize(World world, int x, int y, int z, FertilizerType fertilizerType);

	/**
	 * @param world
	 *            The world this block belongs to.
	 * @param rand
	 *            A Random instance to use when fertilizing, if necessary.
	 * @param x
	 *            The X coordinate of this block.
	 * @param y
	 *            The Y coordinate of this block.
	 * @param z
	 *            The Z coordinate of this block.
	 * @param fertilizerType
	 *            The kind of fertilizer being used.
	 *
	 * @return True if fertilization was successful. If false, the Fertilizer
	 *         will not consume a fertilizer item and will not drain power.
	 */
	public boolean fertilize(World world, Random rand, int x, int y, int z, FertilizerType fertilizerType);

}