crafttweaker.api.item

Class IngredientTransform

java.lang.Object

crafttweaker.api.item.IngredientTransform

public class IngredientTransform
extends java.lang.Object

Transformations can be used to modify an ingredient after it is used in a crafting recipe. It could reuse the item, damage it or consume multiple items.

Constructor Summary

Constructors

Constructor and Description
IngredientTransform()

Method Summary

Modifier and Type	Method and Description
static IIngredient	giveBack(IIngredient ingredient, IItemStack givenItem) Gives an item back to the player.
static IIngredient	noReturn(IIngredient ingredient) Makes sure there is no return value.
static IIngredient	reuse(IIngredient ingredient) Leaves the item in the crafting grid.
static IIngredient	transformConsume(IIngredient ingredient, int amount) Causes multiple items to be consumed.
static IIngredient	transformDamage(IIngredient ingredient) Damages the item.
static IIngredient	transformDamage(IIngredient ingredient, int damage) Damages the item for a specific amount.
static IIngredient	transformReplace(IIngredient ingredient, IItemStack withItem) Causes the item to be replaced upon crafting.

Methods inherited from class java.lang.Object

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

Constructor Detail

IngredientTransform

public IngredientTransform()

Method Detail

transformDamage

public static IIngredient transformDamage(IIngredient ingredient)

Damages the item. Also makes the item reusable. Will damage the item for 1 point upon crafting and consume it when broken.

Parameters:

ingredient - target value

Returns:

damage transformer

transformDamage

public static IIngredient transformDamage(IIngredient ingredient,
                                          int damage)

Damages the item for a specific amount. Also makes the item reusable. Upon reaching maximum damage, the item will be consumed. Take care to set the proper condition such that an almost-broken item becomes invalid for crafting.

Parameters:

ingredient - target value

damage - damage to be applied

Returns:

damage transformer

transformReplace

public static IIngredient transformReplace(IIngredient ingredient,
                                           IItemStack withItem)

Causes the item to be replaced upon crafting. Can be used, for instance, to return empty bottles or buckets.

Parameters:

ingredient - target value

withItem - replacement item

Returns:

replacement transformer

transformConsume

public static IIngredient transformConsume(IIngredient ingredient,
                                           int amount)

Causes multiple items to be consumed. Take care to set a condition for a minimum stack size too, as otherwise smaller stacks would still be accepted for input.

Parameters:

ingredient - target value

amount - consumption amount

Returns:

consuming transformer

noReturn

public static IIngredient noReturn(IIngredient ingredient)

Makes sure there is no return value.

Parameters:

ingredient -

Returns:

no return transformer

giveBack

public static IIngredient giveBack(IIngredient ingredient,
                                   IItemStack givenItem)

Gives an item back to the player. Also clears the inventory slot at that position.

Parameters:

ingredient -

givenItem -

Returns:

give back transformer

reuse

public static IIngredient reuse(IIngredient ingredient)

Leaves the item in the crafting grid.

Parameters:

ingredient -

Returns:

reuse transformer