Version:

Language:

IIngredient

The CraftTweaker Ingredient class which is used to power our recipes and ItemStack matching.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.ingredient.IIngredient;

Implemented Interfaces

IIngredient implements the following interfaces. That means all methods defined in these interfaces are also available in IIngredient

CommandStringDisplayable

Casters

Result type	Is Implicit
Result type IData	Is Implicit true
Result type IIngredientWithAmount	Is Implicit true
Result type Ingredient	Is Implicit true
Result type MapData	Is Implicit true

Methods

addGlobalAttributeModifier

Name: addGlobalAttributeModifier

Adds an AttributeModifier to this IIngredient.

Attributes added with this method appear on all ItemStacks that match this IIngredient, regardless of how or when the ItemStack was made, if you want to have the attribute on a single specific ItemStack (such as a specific Diamond Sword made in a recipe), then you should use IItemStack#withAttributeModifier

Return Type: void

ZenScript
 Copy
// IIngredient.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]) as void

<tag:items:forge:ingots>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>]);

Parameter	Type	Description
Parameter attribute	Type Attribute	Description The Attribute of the modifier.
Parameter name	Type string	Description The name of the modifier.
Parameter value	Type double	Description The value of the modifier.
Parameter operation	Type AttributeOperation	Description The operation of the modifier.
Parameter slotTypes	Type EquipmentSlot[]	Description What slots the modifier is valid for.

addGlobalAttributeModifier

Name: addGlobalAttributeModifier

Adds an AttributeModifier to this IIngredient using a specific UUID.

The UUID can be used to override an existing attribute on an ItemStack with this new modifier. You can use /ct hand attributes to get the UUID of the attributes on an ItemStack.

Return Type: void

ZenScript
 Copy
// IIngredient.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]) as void

<tag:items:forge:ingots>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>]);

Parameter	Type	Description
Parameter attribute	Type Attribute	Description The Attribute of the modifier.
Parameter uuid	Type string	Description The unique identifier of the modifier to replace.
Parameter name	Type string	Description The name of the modifier.
Parameter value	Type double	Description The value of the modifier.
Parameter operation	Type AttributeOperation	Description The operation of the modifier.
Parameter slotTypes	Type EquipmentSlot[]	Description What slots the modifier is valid for.

addShiftTooltip

Name: addShiftTooltip

Return Type: void

ZenScript
 Copy
IIngredient.addShiftTooltip(content as Component, showMessage as Component) as void

Parameter	Type	Description	Optional	DefaultValue
Parameter contenu	Type Component	Description No Description Provided	Optional false	DefaultValue
Parameter showMessage	Type Component	Description No Description Provided	Optional true	DefaultValue

addTooltip

Name: addTooltip

Return Type: void

ZenScript
 Copy
IIngredient.addTooltip(content as Component) as void

Parameter	Type	Description
Parameter contenu	Type Component	Description No Description Provided

anyDamage

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
// IIngredient.anyDamage() as IngredientConditioned<IIngredient>

<tag:items:forge:ingots>.anyDamage();

asIIngredientWithAmount

Name: asIIngredientWithAmount

Used implicitly when a machine can accept more than one item but you only provide one.

Return Type: IIngredientWithAmount

ZenScript
 Copy
// IIngredient.asIIngredientWithAmount() as IIngredientWithAmount

<tag:items:forge:ingots>.asIIngredientWithAmount();

asVanillaIngredient

Name: asVanillaIngredient

Create a Vanilla ingredient matching this one.

Return Type: Ingredient

ZenScript
 Copy
// IIngredient.asVanillaIngredient() as Ingredient

<tag:items:forge:ingots>.asVanillaIngredient();

clearTooltip

Name: clearTooltip

Return Type: void

ZenScript
 Copy
// IIngredient.clearTooltip() as void

<tag:items:forge:ingots>.clearTooltip();

contains

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

ZenScript
 Copy
// IIngredient.contains(ingredient as IIngredient) as boolean

<tag:items:forge:ingots>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));

Parameter	Type	Description
Parameter ingredient	Type IIngredient	Description The ingredient to check

getRemainingItem

Name: getRemainingItem

When this ingredient stack is crafted, what will remain in the grid? Does not check if the stack matches though! Used e.g. in Crafting Table recipes.

Return Type: IItemStack

ZenScript
 Copy
// IIngredient.getRemainingItem(stack as IItemStack) as IItemStack

<tag:items:forge:ingots>.getRemainingItem(<item:minecraft:iron_ingot>);

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack to provide for this ingredient.

matches

Name: matches

Does the given stack match the ingredient?

Return Type: boolean

ZenScript
 Copy
// IIngredient.matches(stack as IItemStack) as boolean

<tag:items:forge:ingots>.matches(<item:minecraft:iron_ingot>);

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack to check

matches

Name: matches

Does the given stack match the ingredient?

Return Type: boolean

ZenScript
 Copy
IIngredient.matches(stack as IItemStack, ignoreDamage as boolean) as boolean

Parameter	Type	Description
Parameter stack	Type IItemStack	Description The stack to check
Parameter Ignorer les dégâts	Type boolean	Description Should damage be checked?

modifyShiftTooltip

Name: modifyShiftTooltip

Return Type: void

ZenScript
 Copy
IIngredient.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction) as void

Parameter	Type	Description	Optional	DefaultValue
Parameter shiftedFunction	Type ITooltipFunction	Description No Description Provided	Optional false	DefaultValue
Parameter unshiftedFunction	Type ITooltipFunction	Description No Description Provided	Optional true	DefaultValue

modifyTooltip

Name: modifyTooltip

Return Type: void

ZenScript
 Copy
IIngredient.modifyTooltip(function as ITooltipFunction) as void

Parameter	Type	Description
Parameter function	Type ITooltipFunction	Description No Description Provided

mul

Name: mul

Use this in contexts where machines accept more than one item to state that fact.

Return Type: IIngredientWithAmount

ZenScript
 Copy
IIngredient.mul(amount as int) as IIngredientWithAmount

Parameter	Type	Description
Parameter amount	Type int	Description No Description Provided

only

Name: only

Use this if you already have the condition from another ingredient

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
IIngredient.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>

Parameter	Type	Description
Parameter condition	Type IIngredientCondition<IIngredient>	Description No Description Provided

onlyDamaged

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
// IIngredient.onlyDamaged() as IngredientConditioned<IIngredient>

<tag:items:forge:ingots>.onlyDamaged();

onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
IIngredient.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>

Parameter	Type	Description
Parameter minDamage	Type int	Description No Description Provided

onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
IIngredient.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>

Parameter	Type	Description
Parameter maxDamage	Type int	Description No Description Provided

onlyIf

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
IIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<IIngredient>

Parameter	Type	Description	Optional	DefaultValue
Parameter uid	Type string	Description No Description Provided	Optional false	DefaultValue
Parameter function	Type Predicate<IItemStack>	Description No Description Provided	Optional true	DefaultValue

removeGlobalAttribute

Name: removeGlobalAttribute

Removes all AttributeModifiers that use the given Attribute from this IIngredient.

Attributes removed with this method are removed from ItemStacks that match this IIngredient, regardless of how or when the ItemStack was made, if you want to remove the attribute on a single specific ItemStack (such as a specific Diamond Sword made in a recipe), then you should use IItemStack#withoutAttribute.

This method can only remove default Attributes from an ItemStack, it is still possible that an ItemStack can override it.

Return Type: void

ZenScript
 Copy
// IIngredient.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]) as void

<tag:items:forge:ingots>.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<equipmentslot:chest>]);

Parameter	Type	Description
Parameter attribute	Type Attribute	Description The attribute to remove.
Parameter slotTypes	Type EquipmentSlot[]	Description The slot types to remove it from.

removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.

Return Type: void

ZenScript
 Copy
// IIngredient.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[]) as void

<tag:items:forge:ingots>.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<equipmentslot:chest>]);

Parameter	Type	Description
Parameter uuid	Type string	Description The unique id of the AttributeModifier to remove.
Parameter slotTypes	Type EquipmentSlot[]	Description The slot types to remove it from.

removeTooltip

Name: removeTooltip

Return Type: void

ZenScript
 Copy
IIngredient.removeTooltip(regex as string) as void

Parameter	Type	Description
Parameter regex	Type string	Description No Description Provided

reuse

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
// IIngredient.reuse() as IIngredientTransformed<IIngredient>

<tag:items:forge:ingots>.reuse();

transform

Name: transform

Use this if you already have the transformer from another ingredient

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>

Parameter	Type	Description
Parameter transformateur	Type IIngredientTransformer<IIngredient>	Description No Description Provided

transformCustom

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>

Parameter	Type	Description	Optional	DefaultValue
Parameter uid	Type string	Description No Description Provided	Optional false	DefaultValue
Parameter function	Type Function<IItemStack,IItemStack>	Description No Description Provided	Optional true	DefaultValue

transformDamage

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transformDamage(amount as int) as IIngredientTransformed<IIngredient>

Parameter	Type	Description	Optional	DefaultValue
Parameter amount	Type int	Description No Description Provided	Optional true	DefaultValue 1

transformReplace

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>

Parameter	Type	Description
Parameter replaceWith	Type IItemStack	Description No Description Provided

Operators

CONTAINS

Name: CONTAINS

Does the ingredient contain the given ingredient?

ZenScript
 Copy
ingredient as IIngredient in myIIngredient
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <tag:items:forge:ingots>

MUL

Name: MUL

Use this in contexts where machines accept more than one item to state that fact.

ZenScript
 Copy
myIIngredient * amount as int

Name: OR

ZenScript
 Copy
myIIngredient | other as IIngredient

Properties

Name	Type	Has Getter	Has Setter	Description
Name burnTime	Type void	Has Getter false	Has Setter true	Description Sets the burn time of this ingredient, for use in the furnace and other machines
Name commandString	Type string	Has Getter true	Has Setter false	Description Returns the BEP to get this stack
Name items	Type IItemStack[]	Has Getter true	Has Setter false	Description No Description Provided