crafttweaker.api.item

Class IngredientStack

java.lang.Object

crafttweaker.api.item.IngredientStack

All Implemented Interfaces:

IIngredient

public class IngredientStack
extends java.lang.Object
implements IIngredient

Contains an ingredient stack. Is an ingredient with a specific stack size assigned to it.

Constructor Summary

Constructors

Constructor and Description
IngredientStack(IIngredient ingredient, int amount)

Method Summary

Modifier and Type	Method and Description
IIngredient	amount(int amount) Returns a new ingredient with the given stack size.
IItemStack	applyNewTransform(IItemStack item)
IItemStack	applyTransform(IItemStack item, IPlayer byPlayer) Applies transformations after crafting, if any, to the given item.
boolean	contains(IIngredient ingredient) Check if this ingredient contains all possible values for the given ingredient.
int	getAmount() Gets the amount.
java.lang.Object	getInternal() Gets the internal item backing this ingredient.
IItemStack[]	getItemArray() Gets all possible items for this ingredient as Array.
java.util.List<IItemStack>	getItems() Gets all possible items for this ingredient.
java.util.List<ILiquidStack>	getLiquids() Gets all possible liquids for this ingredient.
java.lang.String	getMark() Gets the mark of the ingredient.
boolean	hasNewTransformers() Checks if this ingredient has (or could have) any transformatiosns.
boolean	hasTransformers()
IIngredient	marked(java.lang.String mark) Returns a new ingredient marked with the given name.
boolean	matches(IItemStack item) Checks if this ingredient matches the given item.
boolean	matches(ILiquidStack liquid) Checks if this ingredient matches the given liquid.
boolean	matchesExact(IItemStack item) Checks if this ingredient matches the given item.
IIngredient	only(IItemCondition condition) Returns a new ingredient with the given condition added to it.
IIngredient	or(IIngredient ingredient) Combines multiple ingredients into a single one.
java.lang.String	toCommandString()
java.lang.String	toString()
IIngredient	transform(IItemTransformer transformer)
IIngredient	transformNew(IItemTransformerNew transformer) Returns a new ingredient with the given transform added to it.

Methods inherited from class java.lang.Object

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

Constructor Detail

IngredientStack

public IngredientStack(IIngredient ingredient,
                       int amount)

Method Detail

getMark

public java.lang.String getMark()

Description copied from interface: IIngredient

Gets the mark of the ingredient. Ingredients can be marked so they can be used in crafting functions.

Specified by:

getMark in interface IIngredient

Returns:

ingredient mark

getAmount

public int getAmount()

Description copied from interface: IIngredient

Gets the amount.

Should return -1 if no amount is available and 1 for a single item. Stacks return the stack size.

Specified by:

getAmount in interface IIngredient

Returns:

stack size

getItems

public java.util.List<IItemStack> getItems()

Description copied from interface: IIngredient

Gets all possible items for this ingredient.

If there is no item list (for example, it is the <*> wildcard item) null should be returned.

Specified by:

getItems in interface IIngredient

Returns:

the items for this ingredient, or null

getItemArray

public IItemStack[] getItemArray()

Description copied from interface: IIngredient

Gets all possible items for this ingredient as Array.

If there is no item list (for example, it is the <*> wildcard item) an empty Array should be returned

Specified by:

getItemArray in interface IIngredient

Returns:

the items for this ingredient as array, or null

getLiquids

public java.util.List<ILiquidStack> getLiquids()

Description copied from interface: IIngredient

Gets all possible liquids for this ingredient.

If there is no liquid list (for example, it is the <*&ft; wildcard item) null should be returned.

Specified by:

getLiquids in interface IIngredient

Returns:

the liquids for this ingredient, or null

amount

public IIngredient amount(int amount)

Description copied from interface: IIngredient

Returns a new ingredient with the given stack size.

Specified by:

amount in interface IIngredient

Parameters:

amount - new stack size

Returns:

modified ingredient

transformNew

public IIngredient transformNew(IItemTransformerNew transformer)

Description copied from interface: IIngredient

Returns a new ingredient with the given transform added to it.

Specified by:

transformNew in interface IIngredient

Parameters:

transformer - transformer to add

Returns:

modified ingredient

only

public IIngredient only(IItemCondition condition)

Description copied from interface: IIngredient

Returns a new ingredient with the given condition added to it.

Specified by:

only in interface IIngredient

Parameters:

condition - condition to add

Returns:

modified ingredient

marked

public IIngredient marked(java.lang.String mark)

Description copied from interface: IIngredient

Returns a new ingredient marked with the given name.

Specified by:

marked in interface IIngredient

Parameters:

mark - mark to apply

Returns:

modified ingredient

or

public IIngredient or(IIngredient ingredient)

Description copied from interface: IIngredient

Combines multiple ingredients into a single one. Note that ore dictionary entries are preferred to or statements.

Specified by:

or in interface IIngredient

Parameters:

ingredient - ingredient to combine with

Returns:

or-ed ingredient

matches

public boolean matches(IItemStack item)

Description copied from interface: IIngredient

Checks if this ingredient matches the given item. For liquids, will match the item if it is a valid container.

Specified by:

matches in interface IIngredient

Parameters:

item - item to check

Returns:

true if the item matches

matchesExact

public boolean matchesExact(IItemStack item)

Description copied from interface: IIngredient

Checks if this ingredient matches the given item. For liquids, will match the item if it is a valid container.

Specified by:

matchesExact in interface IIngredient

Parameters:

item - item to check

Returns:

true if the item matches

matches

public boolean matches(ILiquidStack liquid)

Description copied from interface: IIngredient

Checks if this ingredient matches the given liquid.

Specified by:

matches in interface IIngredient

Parameters:

liquid - liquid to check

Returns:

true if the liquid matches

contains

public boolean contains(IIngredient ingredient)

Description copied from interface: IIngredient

Check if this ingredient contains all possible values for the given ingredient.

Specified by:

contains in interface IIngredient

Parameters:

ingredient - ingredient to check

Returns:

true if the ingredient contains the given one

applyTransform

public IItemStack applyTransform(IItemStack item,
                                 IPlayer byPlayer)

Description copied from interface: IIngredient

Applies transformations after crafting, if any, to the given item.

Specified by:

applyTransform in interface IIngredient

Parameters:

item - item to transformNew

byPlayer - player performing the crafting operation

Returns:

transformed item

applyNewTransform

public IItemStack applyNewTransform(IItemStack item)

Specified by:

applyNewTransform in interface IIngredient

getInternal

public java.lang.Object getInternal()

Description copied from interface: IIngredient

Gets the internal item backing this ingredient.

The value is implementation-dependent and should only be handled by the internal code. Don't use this value - instead, use the version-specific helper methods.

Specified by:

getInternal in interface IIngredient

Returns:

internal item

toCommandString

public java.lang.String toCommandString()

Specified by:

toCommandString in interface IIngredient

hasNewTransformers

public boolean hasNewTransformers()

Description copied from interface: IIngredient

Checks if this ingredient has (or could have) any transformatiosns.

Specified by:

hasNewTransformers in interface IIngredient

Returns:

true if there are (or could be) any transformations false otherwise.

hasTransformers

public boolean hasTransformers()

Specified by:

hasTransformers in interface IIngredient

transform

public IIngredient transform(IItemTransformer transformer)

Specified by:

transform in interface IIngredient

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object