IRecipeWrapper.java

package mezz.jei.api.recipe;

import mezz.jei.api.IGuiHelper;
import mezz.jei.api.gui.IDrawable;
import mezz.jei.api.gui.IDrawableAnimated;
import net.minecraft.client.Minecraft;
import net.minecraftforge.fluids.FluidStack;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;

/**
 * A wrapper around a normal recipe with methods that allow JEI can make sense of it.
 * Plugins implement these to wrap each type of recipe they have.
 *
 * Normal recipes are converted to wrapped recipes by {@link IRecipeHandler#getRecipeWrapper(Object)}.
 *
 * @see BlankRecipeWrapper
 */
public interface IRecipeWrapper {

	/**
	 * Return a list of recipe inputs.
	 * Each element can be an ItemStack, null, or a List of ItemStacks.
	 */
	List getInputs();

	/**
	 * Return a list of recipe inputs.
	 * Each element can be an ItemStack, null, or a List of ItemStacks.
	 */
	List getOutputs();

	/**
	 * Return a list of recipe fluid inputs.
	 */
	List<FluidStack> getFluidInputs();

	/**
	 * Return a list of recipe fluid outputs.
	 */
	List<FluidStack> getFluidOutputs();

	/**
	 * Draw additional info about the recipe.
	 * Use the mouse position for things like button highlights.
	 * Tooltips are handled by IRecipeWrapper.getTooltipStrings()
	 *
	 * @param mouseX the X position of the mouse, relative to the recipe.
	 * @param mouseY the Y position of the mouse, relative to the recipe.
	 * @since JEI 2.19.0
	 * @see IDrawable for a simple class for drawing things.
	 * @see IGuiHelper for useful functions.
	 */
	void drawInfo(@Nonnull Minecraft minecraft, int recipeWidth, int recipeHeight, int mouseX, int mouseY);

	/**
	 * Draw animations involving the recipe. Can be disabled in the config.
	 * @see IDrawableAnimated for a simple class for drawing animated things.
	 * @see IGuiHelper for useful functions.
	 */
	void drawAnimations(@Nonnull Minecraft minecraft, int recipeWidth, int recipeHeight);

	/**
	 * Get the tooltip for whatever's under the mouse.
	 * ItemStack and fluid tooltips are already handled by JEI, this is for anything else.
	 *
	 * @param mouseX the X position of the mouse, relative to the recipe.
	 * @param mouseY the Y position of the mouse, relative to the recipe.
	 * @return tooltip strings. If there is no tooltip at this position, return null or an empty list.
	 */
	@Nullable
	List<String> getTooltipStrings(int mouseX, int mouseY);

	/**
	 * Called when a player clicks the recipe.
	 * Useful for implementing buttons, hyperlinks, and other interactions to your recipe.
	 *
	 * @param mouseX      the X position of the mouse, relative to the recipe.
	 * @param mouseY      the Y position of the mouse, relative to the recipe.
	 * @param mouseButton the current mouse event button.
	 * @return true if the click was handled, false otherwise
	 * @since JEI 2.19.0
	 */
	boolean handleClick(@Nonnull Minecraft minecraft, int mouseX, int mouseY, int mouseButton);
}