mezz.jei.api.recipe

Interface IRecipeCategory<T extends IRecipeWrapper>

All Known Implementing Classes:

BlankRecipeCategory, BrewingRecipeCategory, CraftingRecipeCategory, DebugRecipeCategory, FurnaceFuelCategory, FurnaceRecipeCategory, FurnaceSmeltingCategory, ItemDescriptionRecipeCategory

public interface IRecipeCategory<T extends IRecipeWrapper>

Defines a category of recipe, (i.e. Crafting Table Recipe, Furnace Recipe). Handles setting up the GUI for its recipe category in setRecipe(IRecipeLayout, IRecipeWrapper). Also draws elements that are common to all recipes in the category like the background.

See Also:

BlankRecipeCategory

Method Summary

Modifier and Type	Method and Description
void	drawAnimations(net.minecraft.client.Minecraft minecraft) Deprecated. since 3.13.1. Move animations into drawExtras(Minecraft), these are being combined because nobody uses the config option to disable animations.
void	drawExtras(net.minecraft.client.Minecraft minecraft) Draw any extra elements that might be necessary, icons or extra slots.
IDrawable	getBackground() Returns the drawable background for a single recipe in this category.
IDrawable	getIcon() Optional icon for the category tab.
java.lang.String	getTitle() Returns the localized name for this recipe type.
java.util.List<java.lang.String>	getTooltipStrings(int mouseX, int mouseY) Get the tooltip for whatever's under the mouse.
java.lang.String	getUid() Returns a unique ID for this recipe category.
void	setRecipe(IRecipeLayout recipeLayout, T recipeWrapper) Deprecated. since JEI 3.11.0. use setRecipe(IRecipeLayout, IRecipeWrapper, IIngredients)
void	setRecipe(IRecipeLayout recipeLayout, T recipeWrapper, IIngredients ingredients) Set the IRecipeLayout properties from the IRecipeWrapper and IIngredients.

Method Detail

getUid

java.lang.String getUid()

Returns a unique ID for this recipe category. Referenced from recipes to identify which recipe category they belong to.

See Also:

IRecipeHandler.getRecipeCategoryUid(Object), VanillaRecipeCategoryUid

getTitle

java.lang.String getTitle()

Returns the localized name for this recipe type. Drawn at the top of the recipe GUI pages for this category.

getBackground

IDrawable getBackground()

Returns the drawable background for a single recipe in this category.

getIcon

@Nullable
IDrawable getIcon()

Optional icon for the category tab. If no icon is defined here, JEI will use first item registered with IModRegistry.addRecipeCategoryCraftingItem(ItemStack, String...)

Returns:

icon to draw on the category tab, max size is 16x16 pixels.

Since:

3.13.1

drawExtras

void drawExtras(net.minecraft.client.Minecraft minecraft)

Draw any extra elements that might be necessary, icons or extra slots.

See Also:

for a simple class for drawing things., for useful functions.

drawAnimations

@Deprecated
void drawAnimations(net.minecraft.client.Minecraft minecraft)

Deprecated. since 3.13.1. Move animations into drawExtras(Minecraft), these are being combined because nobody uses the config option to disable animations.

Draw any animations like progress bars or flashy effects. Essentially the same as drawExtras(Minecraft) but these can be disabled in the config.

See Also:

for a simple class for drawing animated things., for useful functions.

setRecipe

@Deprecated
void setRecipe(IRecipeLayout recipeLayout,
                           T recipeWrapper)

Deprecated. since JEI 3.11.0. use setRecipe(IRecipeLayout, IRecipeWrapper, IIngredients)

Set the IRecipeLayout properties from the IRecipeWrapper.

setRecipe

void setRecipe(IRecipeLayout recipeLayout,
               T recipeWrapper,
               IIngredients ingredients)

Set the IRecipeLayout properties from the IRecipeWrapper and IIngredients.

Parameters:

recipeLayout - the layout that needs its properties set.

recipeWrapper - the recipeWrapper, for extra information.

ingredients - the ingredients, already set by the recipeWrapper

Since:

JEI 3.11.0

getTooltipStrings

java.util.List<java.lang.String> getTooltipStrings(int mouseX,
                                                   int mouseY)

Get the tooltip for whatever's under the mouse. ItemStack and fluid tooltips are already handled by JEI, this is for anything else. To add to ingredient tooltips, see IGuiIngredientGroup.addTooltipCallback(ITooltipCallback) To add tooltips for a recipe wrapper, see IRecipeWrapper.getTooltipStrings(int, int)

Parameters:

mouseX - the X position of the mouse, relative to the recipe.

mouseY - the Y position of the mouse, relative to the recipe.

Returns:

tooltip strings. If there is no tooltip at this position, return an empty list.

Since:

JEI 4.2.5, backported to JEI 3.14.6