codechicken.nei.recipe

Class TemplateRecipeHandler

java.lang.Object

codechicken.nei.recipe.TemplateRecipeHandler

All Implemented Interfaces:

ICraftingHandler, IRecipeHandler, IUsageHandler

Direct Known Subclasses:

BrewingRecipeHandler, FurnaceRecipeHandler, ShapedRecipeHandler

public abstract class TemplateRecipeHandler
extends java.lang.Object
implements ICraftingHandler, IUsageHandler

A Template Recipe Handler! How about that. Because it was sooo hard, and more seriously required lots of copied code to make a handler in the past. you can now extend this class to make your custom recipe handlers much easier to create. Just look at the 5 handlers included by default to work out how to do stuff if you are still stuck.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TemplateRecipeHandler.CachedRecipe This Recipe Handler runs on this internal class Fill the recipe array with subclasses of this to make transforming the different types of recipes out there into a nice format for NEI a much easier job.
static class	TemplateRecipeHandler.RecipeTransferRect The Rectangle is an region of the gui relative to the corner of the recipe that will activate the recipe with the corresponding outputId apon being clicked.
static class	TemplateRecipeHandler.RecipeTransferRectHandler

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<TemplateRecipeHandler.CachedRecipe>	arecipes The list of matching recipes
int	cycleticks Internal tick counter, initialised to random value and incremented every tick.
java.util.LinkedList<TemplateRecipeHandler.RecipeTransferRect>	transferRects A list of transferRects that apon when clicked or R is pressed will open a new recipe.

Constructor Summary

Constructors

Constructor and Description
TemplateRecipeHandler()

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	drawExtras(int recipe) Extension point for drawing progress bars and other overlays
void	drawForeground(int recipe) Draw the foreground of this recipe handler (for things like progress bars).
void	drawProgressBar(int x, int y, int tx, int ty, int w, int h, float completion, int direction) Draws a texture rectangle that changes size with time.
void	drawProgressBar(int x, int y, int tx, int ty, int w, int h, int ticks, int direction) Draws a texture rectangle that changes size with time.
java.lang.Class<? extends net.minecraft.client.gui.inventory.GuiContainer>	getGuiClass()
abstract java.lang.String	getGuiTexture()
java.util.List<PositionedStack>	getIngredientStacks(int recipe)
java.util.List<PositionedStack>	getOtherStacks(int recipe)
IOverlayHandler	getOverlayHandler(net.minecraft.client.gui.inventory.GuiContainer gui, int recipe)
java.lang.String	getOverlayIdentifier() Simply works with the DefaultOverlayRenderer If the current container has been registered with this identifier, the question mark appears and an overlay guide can be drawn.
IRecipeOverlayRenderer	getOverlayRenderer(net.minecraft.client.gui.inventory.GuiContainer gui, int recipe)
ICraftingHandler	getRecipeHandler(java.lang.String outputId, java.lang.Object... results)
java.util.List<java.lang.Class<? extends net.minecraft.client.gui.inventory.GuiContainer>>	getRecipeTransferRectGuis()
PositionedStack	getResultStack(int recipe)
IUsageHandler	getUsageHandler(java.lang.String inputId, java.lang.Object... ingredients)
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, java.awt.Container container, int recipe)
boolean	keyTyped(GuiRecipe gui, char keyChar, int keyCode, int recipe)
void	loadCraftingRecipes(ItemStack result) Simplified wrapper, implement this and fill the empty recipe array with recipes
void	loadCraftingRecipes(java.lang.String outputId, java.lang.Object... results) In this function you need to fill up the empty recipe array with recipes.
void	loadTransferRects() Add all RecipeTransferRects to the transferRects list during this call.
void	loadUsageRecipes(ItemStack ingredient) Simplified wrapper, implement this and fill the empty recipe array with recipes
void	loadUsageRecipes(java.lang.String inputId, java.lang.Object... ingredients) In this function you need to fill up the empty recipe array with recipes The default passes it to a cleaner handler if inputId is an item
boolean	mouseClicked(GuiRecipe gui, int button, int recipe)
TemplateRecipeHandler	newInstance()
int	numRecipes()
void	onUpdate() A tick function called for updating progress bars and cycling damage items.
int	recipiesPerPage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface codechicken.nei.recipe.IRecipeHandler

getRecipeName

Field Detail

cycleticks

public int cycleticks

Internal tick counter, initialised to random value and incremented every tick. Used for cycling similar ingredients and progress bars.

arecipes

public java.util.ArrayList<TemplateRecipeHandler.CachedRecipe> arecipes

The list of matching recipes

transferRects

public java.util.LinkedList<TemplateRecipeHandler.RecipeTransferRect> transferRects

A list of transferRects that apon when clicked or R is pressed will open a new recipe.

Constructor Detail

TemplateRecipeHandler

public TemplateRecipeHandler()

Method Detail

loadTransferRects

public void loadTransferRects()

Add all RecipeTransferRects to the transferRects list during this call. Afterward they may be added to the input handler for the corresponding guis from getRecipeTransferRectGuis

loadCraftingRecipes

public void loadCraftingRecipes(java.lang.String outputId,
                                java.lang.Object... results)

In this function you need to fill up the empty recipe array with recipes. The default passes it to a cleaner handler if outputId is an item

Parameters:

outputId - A String identifier representing the type of output produced. Eg. {"item", "fuel"}

results - Objects representing the results that matching recipes must produce.

loadCraftingRecipes

public void loadCraftingRecipes(ItemStack result)

Simplified wrapper, implement this and fill the empty recipe array with recipes

Parameters:

result - The result the recipes must output.

loadUsageRecipes

public void loadUsageRecipes(java.lang.String inputId,
                             java.lang.Object... ingredients)

In this function you need to fill up the empty recipe array with recipes The default passes it to a cleaner handler if inputId is an item

Parameters:

inputId - A String identifier representing the type of ingredients used. Eg. {"item", "fuel"}

ingredients - Objects representing the ingredients that matching recipes must contain.

loadUsageRecipes

public void loadUsageRecipes(ItemStack ingredient)

Simplified wrapper, implement this and fill the empty recipe array with recipes

Parameters:

ingredient - The ingredient the recipes must contain.

getGuiTexture

public abstract java.lang.String getGuiTexture()

Returns:

The filepath to the texture to use when drawing this recipe

getOverlayIdentifier

public java.lang.String getOverlayIdentifier()

Simply works with the DefaultOverlayRenderer If the current container has been registered with this identifier, the question mark appears and an overlay guide can be drawn.

Returns:

The overlay identifier of this recipe type.

drawExtras

public void drawExtras(int recipe)

Extension point for drawing progress bars and other overlays

Parameters:

recipe - The recipeIndex being drawn

drawProgressBar

public void drawProgressBar(int x,
                            int y,
                            int tx,
                            int ty,
                            int w,
                            int h,
                            int ticks,
                            int direction)

Draws a texture rectangle that changes size with time. Commonly used for progress bars.

Parameters:

x - X position on screen

y - Y position on screen

tx - Texture X position

ty - Texture Y position

w - Texture width

h - Texture height

ticks - The amount of ticks for the bar to complete

direction - 0 right, 1 down, 2 left, 3 up. If bit 3 is set the bar will shrink rather extend

drawProgressBar

public void drawProgressBar(int x,
                            int y,
                            int tx,
                            int ty,
                            int w,
                            int h,
                            float completion,
                            int direction)

Draws a texture rectangle that changes size with time. Commonly used for progress bars. If for some reason you don't like the default counter use this and specify the progress percentage.

Parameters:

x - X position on screen

y - Y position on screen

tx - Texture X position

ty - Texture Y position

w - Texture width

h - Texture height

completion - the percentage of progress bar completion, 0-1

direction - 0 right, 1 down, 2 left, 3 up. If bit 3 is set the bar will shrink rather extend

getRecipeTransferRectGuis

public java.util.List<java.lang.Class<? extends net.minecraft.client.gui.inventory.GuiContainer>> getRecipeTransferRectGuis()

Returns:

The gui classes to which the transfer rects added in the constructor are to be located over. null if none.

getGuiClass

public java.lang.Class<? extends net.minecraft.client.gui.inventory.GuiContainer> getGuiClass()

Returns:

The class of the GuiContainer that this recipe would be crafted in.

newInstance

public TemplateRecipeHandler newInstance()

getRecipeHandler

public ICraftingHandler getRecipeHandler(java.lang.String outputId,
                                         java.lang.Object... results)

Specified by:

getRecipeHandler in interface ICraftingHandler

Parameters:

outputId - A String identifier representing the type of output produced. Eg. {"item", "fuel"}

results - Objects representing the results that matching recipes must produce.

Returns:

An instance of ICraftingHandler configured with a list of recipes that produce matching output.

getUsageHandler

public IUsageHandler getUsageHandler(java.lang.String inputId,
                                     java.lang.Object... ingredients)

Specified by:

getUsageHandler in interface IUsageHandler

Parameters:

inputId - A String identifier representing the type of ingredients used. Eg. {"item", "fuel"}

ingredients - Objects representing the ingredients that matching recipes must contain.

Returns:

An instance of IUsageHandler configured with a list of recipes that contain matching input

numRecipes

public int numRecipes()

Specified by:

numRecipes in interface IRecipeHandler

Returns:

The number of recipes that this handler contains.

drawBackground

public void drawBackground(int recipe)

Description copied from interface: IRecipeHandler

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

Specified by:

drawBackground in interface IRecipeHandler

Parameters:

recipe - The recipe index to draw at this position.

drawForeground

public void drawForeground(int recipe)

Description copied from interface: IRecipeHandler

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

Specified by:

drawForeground in interface IRecipeHandler

Parameters:

recipe - The recipe index to draw at this position.

getIngredientStacks

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

Specified by:

getIngredientStacks in interface IRecipeHandler

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.

getResultStack

public PositionedStack getResultStack(int recipe)

Specified by:

getResultStack in interface IRecipeHandler

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.

getOtherStacks

public java.util.List<PositionedStack> getOtherStacks(int recipe)

Specified by:

getOtherStacks in interface IRecipeHandler

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.

onUpdate

public void onUpdate()

Description copied from interface: IRecipeHandler

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

Specified by:

onUpdate in interface IRecipeHandler

hasOverlay

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

Specified by:

hasOverlay in interface IRecipeHandler

Parameters:

gui - The GUI to overlay.

container - The container of the GUI.

recipe - The recipe index to check for.

Returns:

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

getOverlayRenderer

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

Specified by:

getOverlayRenderer in interface IRecipeHandler

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

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

Specified by:

getOverlayHandler in interface IRecipeHandler

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

public int recipiesPerPage()

Specified by:

recipiesPerPage in interface IRecipeHandler

Returns:

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

handleTooltip

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

Specified by:

handleTooltip in interface IRecipeHandler

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

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

Specified by:

handleItemTooltip in interface IRecipeHandler

Parameters:

gui - An instance of the currentscreen

recipe - The recipe index being handled

Returns:

The modified tooltip. DO NOT return null

keyTyped

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

Specified by:

keyTyped in interface IRecipeHandler

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

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

Specified by:

mouseClicked in interface IRecipeHandler

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.