codechicken.nei.recipe

Interface IRecipeHandler

All Known Subinterfaces:

ICraftingHandler, IUsageHandler

All Known Implementing Classes:

BrewingRecipeHandler, FireworkRecipeHandler, FuelRecipeHandler, FurnaceRecipeHandler, ProfilerRecipeHandler, ShapedRecipeHandler, ShapelessRecipeHandler, TemplateRecipeHandler

public interface IRecipeHandler

Do not implement this. Implement one of it's subinterfaces, either ICraftingHandler or IUsageHandler

Method Summary

Modifier and Type	Method and Description
void	drawBackground(int recipe) Draw the background of this recipe handler (basically the slot layout image).
void	drawForeground(int recipe) Draw the foreground of this recipe handler (for things like progress bars).
java.util.List<PositionedStack>	getIngredientStacks(int recipe)
java.util.List<PositionedStack>	getOtherStacks(int recipetype)
IOverlayHandler	getOverlayHandler(net.minecraft.client.gui.inventory.GuiContainer gui, int recipe)
IRecipeOverlayRenderer	getOverlayRenderer(net.minecraft.client.gui.inventory.GuiContainer gui, int recipe)
java.lang.String	getRecipeName()
PositionedStack	getResultStack(int recipe)
java.util.List<java.lang.String>	handleItemTooltip(GuiRecipe gui, ItemStack stack, java.util.List<java.lang.String> currenttip, int recipe)
java.util.List<java.lang.String>	handleTooltip(GuiRecipe gui, java.util.List<java.lang.String> currenttip, int recipe)
boolean	hasOverlay(net.minecraft.client.gui.inventory.GuiContainer gui, Container container, int recipe)
boolean	keyTyped(GuiRecipe gui, char keyChar, int keyCode, int recipe)
boolean	mouseClicked(GuiRecipe gui, int button, int recipe)
int	numRecipes()
void	onUpdate() A tick function called for updating progress bars and cycling damage items.
int	recipiesPerPage()

Method Detail

getRecipeName

java.lang.String getRecipeName()

Returns:

The name of this inventory. To be displayed at the top of the viewing container.

numRecipes

int numRecipes()

Returns:

The number of recipes that this handler contains.

drawBackground

void drawBackground(int recipe)

Draw the background of this recipe handler (basically the slot layout image).

Parameters:

gui - A GuiManager for drawing functions.

recipe - The recipe index to draw at this position.

drawForeground

void drawForeground(int recipe)

Draw the foreground of this recipe handler (for things like progress bars).

Parameters:

gui - A GuiManager for drawing functions.

recipe - The recipe index to draw at this position.

getIngredientStacks

java.util.List<PositionedStack> getIngredientStacks(int recipe)

Parameters:

recipe - The recipe index to get items for.

Returns:

A list of the ingredient PositionedStacks in this recipe relative to the top left corner of your recipe drawing space.

getOtherStacks

java.util.List<PositionedStack> getOtherStacks(int recipetype)

Parameters:

recipe - The recipe index to get items for.

Returns:

A list of the other PositionedStacks in this recipe relative to the top left corner of your recipe drawing space. For example fuel in furnaces.

getResultStack

PositionedStack getResultStack(int recipe)

Parameters:

recipe - The recipe index to get the result for.

Returns:

The recipe result PositionedStack relative to the top left corner of your recipe drawing space.

onUpdate

void onUpdate()

A tick function called for updating progress bars and cycling damage items.

hasOverlay

boolean hasOverlay(net.minecraft.client.gui.inventory.GuiContainer gui,
                   Container container,
                   int recipe)

Parameters:

recipe - The recipe index to check for.

gui - The GUI to overlay.

container - The container of the GUI.

Returns:

true if this recipe can render an overlay for the specified type of inventory GUI.

getOverlayRenderer

IRecipeOverlayRenderer getOverlayRenderer(net.minecraft.client.gui.inventory.GuiContainer gui,
                                          int recipe)

Parameters:

recipe - The recipe index to get the overlay renderer for.

Returns:

An instance of IRecipeOverlayRenderer to be used for rendering the overlay of this specific recipe.

getOverlayHandler

IOverlayHandler getOverlayHandler(net.minecraft.client.gui.inventory.GuiContainer gui,
                                  int recipe)

Parameters:

recipe - The recipe index to get the overlay renderer for.

Returns:

An instance of IOverlayHandler to be used for rendering the overlay of this specific recipe.

recipiesPerPage

int recipiesPerPage()

Returns:

The number of recipes that can fit on a page in the viewer (1 or 2)

handleTooltip

java.util.List<java.lang.String> handleTooltip(GuiRecipe gui,
                                               java.util.List<java.lang.String> currenttip,
                                               int recipe)

Parameters:

gui - An instance of the currentscreen

currenttip - The current tooltip, will contain item name and info

recipe - The recipe index being handled

Returns:

The modified tooltip. DO NOT return null

handleItemTooltip

java.util.List<java.lang.String> handleItemTooltip(GuiRecipe gui,
                                                   ItemStack stack,
                                                   java.util.List<java.lang.String> currenttip,
                                                   int recipe)

Parameters:

gui - An instance of the currentscreen

The - itemstack currently under the mouse

The - current tooltip, will contain item name and info

recipe - The recipe index being handled

Returns:

The modified tooltip. DO NOT return null

keyTyped

boolean keyTyped(GuiRecipe gui,
                 char keyChar,
                 int keyCode,
                 int recipe)

Parameters:

gui - An instance of the currentscreen

keyChar - The character representing the keyPress

keyCode - The KeyCode as defined in Keyboard

Returns:

true to terminate further processing of this event.

mouseClicked

boolean mouseClicked(GuiRecipe gui,
                     int button,
                     int recipe)

Parameters:

gui - An instance of the currentscreen

button - The button index being pressed, {0 = Left Click, 1 = Right Click, 2 = Middle Click}

Returns:

true to terminate further processing of this event.