IStationRecipe.java

package net.mcft.copy.betterstorage.api.crafting;

import java.util.Random;

import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;

public interface IStationRecipe {
	
	/** Returns if this input matches the items needed for this recipe. */
	boolean matches(ItemStack[] input);
	
	/** Fills the input array with sample items (used for NEI). */
	void getSampleInput(ItemStack[] input, Random rnd);
	
	/** Fills the requirements for crafting this recipe again.
	 *  Called after {@link #canCraft(ItemStack[], EntityPlayer) canCraft()} and
	 *  before {@link #craft(ItemStack[], ItemStack[], EntityPlayer) craft()}. <br>
	 *  If the recipe can't be crafted again, a machine will not be able to craft
	 *  this, so it doesn't empty the crafting grid. Players don't have this
	 *  limitation. After the recipe is crafted, the crafting grid is filled
	 *  with items from the internal storage that match the requirements.
	 * @param currentInput The current input items.
	 * @param requiredInput
	 *     The items needed to craft this recipe again. <br>
	 *     Can be either null, an ItemStack, a String (ore dictionary entry)
	 *     or a {@code List<ItemStack>}. */
	void getRequirements(ItemStack[] currentInput, Object[] requiredInput);
	
	/** Returns the amount of experience required to craft this. <br>
	 *  Only used for displaying, needs to be manually checked in
	 *  {@link #canCraft(ItemStack[], EntityPlayer) canCraft()} and decreased
	 *  in {@link #craft(ItemStack[], ItemStack[], EntityPlayer) craft()}. */
	int getRequiredExperience(ItemStack[] input);
	
	/** Returns the output for this recipe. */
	ItemStack[] getOutput(ItemStack[] input);
	
	/** Returns if the recipe can be crafted.
	 * @param player may be null if a machine is trying to craft this. */
	boolean canCraft(ItemStack[] input, EntityPlayer player);
	
	/** Called when the recipe is crafted.
	 * @param input has to be modified to decrease/damage items used in the recipe.
	 * @param output is already filled with what {@link #getOutput(ItemStack[]) getOutput()} returns.
	 * @param player may be null if a machine crafted this. */
	void craft(ItemStack[] input, ItemStack[] output, EntityPlayer player);
	
}