me.desht.pneumaticcraft.api.crafting.recipe

Class PressureChamberRecipe

java.lang.Object

me.desht.pneumaticcraft.api.crafting.recipe.PneumaticCraftRecipe

me.desht.pneumaticcraft.api.crafting.recipe.PressureChamberRecipe

All Implemented Interfaces:

net.minecraft.item.crafting.IRecipe<PneumaticCraftRecipe.DummyIInventory>

Direct Known Subclasses:

PressureChamberRecipeImpl

public abstract class PressureChamberRecipe
extends PneumaticCraftRecipe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PressureChamberRecipe.RecipeSlot Data object for type of slot and the index of the slot.
static class	PressureChamberRecipe.SlotCycle Data object for storing a PressureChamberRecipe.RecipeSlot and a cycle represented as a list indices for the slot.

Nested classes/interfaces inherited from class me.desht.pneumaticcraft.api.crafting.recipe.PneumaticCraftRecipe

PneumaticCraftRecipe.DummyIInventory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PressureChamberRecipe(net.minecraft.util.ResourceLocation id)

Method Summary

Modifier and Type	Method and Description
abstract net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	craftRecipe(net.minecraftforge.items.IItemHandler chamberHandler, java.util.List<java.lang.Integer> ingredientSlots, boolean simulate) This method is called when the Pressure Chamber is ready to craft with this recipe, and will only be called when findIngredients(IItemHandler) returns a non-empty list of slot numbers, i.e.
abstract java.util.Collection<java.lang.Integer>	findIngredients(net.minecraftforge.items.IItemHandler chamberHandler) When called (by the pressure chamber TE when it detects a change in the chamber contents), try to find the ingredients for this recipe in the given item handler, which represents all of the items currently in the pressure chamber.
float	getCraftingPressure() Deprecated. don't override this; override getCraftingPressure(IItemHandler, List) instead
float	getCraftingPressure(net.minecraftforge.items.IItemHandler chamberHandler, java.util.List<java.lang.Integer> ingredientSlots) Returns the minimum pressure required to craft the recipe.
abstract float	getCraftingPressureForDisplay() Get the required crafting pressure for the items specified by getInputsForDisplay(), for display purposes only (e.g.
abstract java.util.List<net.minecraft.item.crafting.Ingredient>	getInputsForDisplay() Get the input items for this recipe.
java.util.List<java.util.List<net.minecraft.item.ItemStack>>	getResultsForDisplay() Get the output of this recipe, without crafting it.
protected java.util.List<net.minecraft.item.ItemStack>	getSingleResultsForDisplay() Implement if no output slots display more than one stack.
java.util.Map<PressureChamberRecipe.RecipeSlot,java.util.List<java.lang.Integer>>	getSyncForDisplay(PressureChamberRecipe.SlotCycle focusedSlotCycle) Get the slots and associated cycles that are synchronized with the given focused slot and matched cycle indices.
protected java.util.List<java.util.Set<PressureChamberRecipe.RecipeSlot>>	getSyncGroupsForDisplay() Get the slots that are synchronized with each other.
java.lang.String	getTooltipKey(boolean input, int slot) Return a translation key for a supplementary tooltip to be displayed on the ingredient or resulting item.
abstract boolean	isValidInputItem(net.minecraft.item.ItemStack stack) Check if the given item is a valid input item for this recipe.

Methods inherited from class me.desht.pneumaticcraft.api.crafting.recipe.PneumaticCraftRecipe

assemble, canCraftInDimensions, getId, getResultItem, isSpecial, matches, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.item.crafting.IRecipe

getGroup, getIngredients, getRemainingItems, getSerializer, getToastSymbol, getType

Constructor Detail

PressureChamberRecipe

protected PressureChamberRecipe(net.minecraft.util.ResourceLocation id)

Method Detail

getCraftingPressure

@Deprecated
public float getCraftingPressure()

Deprecated. don't override this; override getCraftingPressure(IItemHandler, List) instead

Returns the minimum pressure required to craft the recipe. Negative pressures are also acceptable; in this case the pressure chamber's pressure must be lower than the required pressure.

Returns:

threshold pressure

getCraftingPressure

public float getCraftingPressure(net.minecraftforge.items.IItemHandler chamberHandler,
                                 java.util.List<java.lang.Integer> ingredientSlots)

Returns the minimum pressure required to craft the recipe. Negative pressures are also acceptable; in this case the pressure chamber's pressure must be lower than the required pressure.

Parameters:

chamberHandler - what's currently in the pressure chamber

ingredientSlots - a list of slots in chamberHandler (as returned by findIngredients(IItemHandler)) where the ingredients can be found

Returns:

threshold pressure

getCraftingPressureForDisplay

public abstract float getCraftingPressureForDisplay()

Get the required crafting pressure for the items specified by getInputsForDisplay(), for display purposes only (e.g. for JEI)

findIngredients

public abstract java.util.Collection<java.lang.Integer> findIngredients(@Nonnull
                                                                        net.minecraftforge.items.IItemHandler chamberHandler)

When called (by the pressure chamber TE when it detects a change in the chamber contents), try to find the ingredients for this recipe in the given item handler, which represents all of the items currently in the pressure chamber. You must return a collection of slot indices into the item handler which contain the matching ingredients; those indices will be passed promptly to getCraftingPressure(IItemHandler, List) and craftRecipe(IItemHandler, List, boolean) by the pressure chamber.

Do not cache this list across ticks, since the chamber contents are quite likely to change in the meantime.

Parameters:

chamberHandler - what's currently in the pressure chamber

Returns:

if this recipe is valid, a list of slots in the item handler where the ingredients can be found; otherwise, an empty list

getInputsForDisplay

public abstract java.util.List<net.minecraft.item.crafting.Ingredient> getInputsForDisplay()

Get the input items for this recipe. This is primarily intended for recipe display purposes by JEI or any other recipe display mod.

getSingleResultsForDisplay

protected java.util.List<net.minecraft.item.ItemStack> getSingleResultsForDisplay()

Implement if no output slots display more than one stack.

See Also:

getResultsForDisplay()

getResultsForDisplay

public java.util.List<java.util.List<net.minecraft.item.ItemStack>> getResultsForDisplay()

Get the output of this recipe, without crafting it. This is intended for recipe display purposes by JEI, Patchouli, or any other recipe display mod.

If overriding and no output slots display more than one stack then can override getSingleResultsForDisplay() instead.

getSyncGroupsForDisplay

protected java.util.List<java.util.Set<PressureChamberRecipe.RecipeSlot>> getSyncGroupsForDisplay()

Get the slots that are synchronized with each other. They must have the same cycle length and not intersect.

A sync group (represented by a set of PressureChamberRecipe.RecipeSlots) will have all its member's cycles synchronized should one of the members be the focus for a recipe lookup.

If you need more functionality, see getSyncForDisplay(SlotCycle).

Returns:

List of sync groups represented by a set of PressureChamberRecipe.RecipeSlots

getSyncForDisplay

public java.util.Map<PressureChamberRecipe.RecipeSlot,java.util.List<java.lang.Integer>> getSyncForDisplay(PressureChamberRecipe.SlotCycle focusedSlotCycle)

Get the slots and associated cycles that are synchronized with the given focused slot and matched cycle indices. Prefer overriding getSyncGroupsForDisplay() unless you need special handling.

This method is called when a recipe lookup is done through JEI that has a focus.

Parameters:

focusedSlotCycle - Slot and indices of the slot's cycle that matches with the focus

Returns:

Synchronizations for the given slot cycle

isValidInputItem

public abstract boolean isValidInputItem(net.minecraft.item.ItemStack stack)

Check if the given item is a valid input item for this recipe. This should also be true even if the number of items in the passed item stack is smaller than the number required by the recipe; this is testing for item type, not item count.

Parameters:

stack - item stack to check

Returns:

true if this is a valid item, false otherwise

craftRecipe

@Nonnull
public abstract net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> craftRecipe(@Nonnull
                                                                                                  net.minecraftforge.items.IItemHandler chamberHandler,
                                                                                                  java.util.List<java.lang.Integer> ingredientSlots,
                                                                                                  boolean simulate)

This method is called when the Pressure Chamber is ready to craft with this recipe, and will only be called when findIngredients(IItemHandler) returns a non-empty list of slot numbers, i.e. the necessary items are definitely in the chamber. The implementation is responsible for removing the items that have been used from the chamberHandler. The implementation must also return the list of crafted items, for the Pressure Chamber to insert into its output item handler.

Parameters:

chamberHandler - items in the pressure chamber; should be modified to remove recipe input items.

ingredientSlots - slots in the chamber handler where the ingredients can be found, as returned from findIngredients(IItemHandler)

simulate - pass on to uses of chamberHandler

Returns:

the resulting items; these do not have to be copies, since the Pressure Chamber itself will insert copies of these items

getTooltipKey

public java.lang.String getTooltipKey(boolean input,
                                      int slot)

Return a translation key for a supplementary tooltip to be displayed on the ingredient or resulting item. For use in recipe display systems such as JEI.

Parameters:

input - true if this is an input item, false if an output item

slot - the slot number

Returns:

a tooltip translation key, or "" for no tooltip