Previous
WrappingIIngredient
IIngredientWithAmount
Next

IIngredient

Link to iingredient

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

Importing the class

Link to 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

Link to implemented-interfaces

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

Casters

Link to casters

Result TypeIs 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

Link to methods

Link to 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

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

<tag:items:minecraft:wool>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
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.

Link to 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.

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

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

<tag:items:minecraft:wool>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, IItemStack.BASE_ATTACK_DAMAGE_UUID, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
Parameter
attribute
Type
Attribute
Description
The Attribute of the modifier.
Parameter
uuid
Type
stdlib.UUID
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.

Link to 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.

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

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

<tag:items:minecraft:wool>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
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.

Link to addShiftTooltip

Name: addShiftTooltip

ZenScript
 Copy
IIngredient.addShiftTooltip(content as Component, showMessage as Component)
ParameterTypeOptional
Parameter
content
Type
Component
Optional
false
Parameter
showMessage
Type
Component
Optional
true

Link to addTooltip

Name: addTooltip

ZenScript
 Copy
IIngredient.addTooltip(content as Component)
ParameterType
Parameter
content
Type
Component

Link to anyDamage

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

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

<tag:items:minecraft:wool>.anyDamage();

Link to 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:minecraft:wool>.asIIngredientWithAmount();

Link to asVanillaIngredient

Name: asVanillaIngredient

Create a Vanilla ingredient matching this one.

Return Type: Ingredient

ZenScript
 Copy
// IIngredient.asVanillaIngredient() as Ingredient

<tag:items:minecraft:wool>.asVanillaIngredient();

Link to clearTooltip

Name: clearTooltip

ZenScript
 Copy
IIngredient.clearTooltip(leaveName as boolean)
ParameterTypeOptionalDefault Value
Parameter
leaveName
Type
boolean
Optional
true
Default Value
false

Link to contains

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

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

<tag:items:minecraft:wool>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
ParameterTypeDescription
Parameter
ingredient
Type
IIngredient
Description
The ingredient to check

Link to 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:minecraft:wool>.getRemainingItem(<item:minecraft:iron_ingot>);
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to provide for this ingredient.

Link to isEmpty

Name: isEmpty

Checks if this ingredient is empty.

Returns: true if empty, false otherwise
Return Type: boolean

ZenScript
 Copy
// IIngredient.isEmpty() as boolean

<tag:items:minecraft:wool>.isEmpty();

Link to matches

Name: matches

Does the given stack match the ingredient?

Return Type: boolean

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

<tag:items:minecraft:wool>.matches(<item:minecraft:iron_ingot>);
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to check

Link to 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
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to check
Parameter
ignoreDamage
Type
boolean
Description
Should damage be checked?

Link to modifyShiftTooltip

Name: modifyShiftTooltip

ZenScript
 Copy
IIngredient.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction)
ParameterTypeOptional
Parameter
shiftedFunction
Type
ITooltipFunction
Optional
false
Parameter
unshiftedFunction
Type
ITooltipFunction
Optional
true

Link to modifyTooltip

Name: modifyTooltip

ZenScript
 Copy
IIngredient.modifyTooltip(function as ITooltipFunction)
ParameterType
Parameter
function
Type
ITooltipFunction

Link to 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
ParameterType
Parameter
amount
Type
int

Link to 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>
ParameterType
Parameter
condition
Type
IIngredientCondition<IIngredient>

Link to onlyDamaged

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

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

<tag:items:minecraft:wool>.onlyDamaged();

Link to onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

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

Link to onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

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

Link to onlyIf

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
IIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<IIngredient>
ParameterTypeOptional
Parameter
uid
Type
string
Optional
false
Parameter
function
Type
Predicate<IItemStack>
Optional
true

Link to 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.

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

<tag:items:minecraft:wool>.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
Parameter
attribute
Type
Attribute
Description
The attribute to remove.
Parameter
slotTypes
Type
EquipmentSlot[]
Description
The slot types to remove it from.

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

ZenScript
 Copy
// IIngredient.removeGlobalAttributeModifier(uuid as stdlib.UUID, slotTypes as EquipmentSlot[])

<tag:items:minecraft:wool>.removeGlobalAttributeModifier(IItemStack.BASE_ATTACK_DAMAGE_UUID, [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
Parameter
uuid
Type
stdlib.UUID
Description
The unique id of the AttributeModifier to remove.
Parameter
slotTypes
Type
EquipmentSlot[]
Description
The slot types to remove it from.

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

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

<tag:items:minecraft:wool>.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<constant:minecraft:equipmentslot:chest>]);
ParameterTypeDescription
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.

Link to removeTooltip

Name: removeTooltip

ZenScript
 Copy
IIngredient.removeTooltip(regex as string)
ParameterType
Parameter
regex
Type
string

Link to reuse

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

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

<tag:items:minecraft:wool>.reuse();

Link to setBurnTime

Name: setBurnTime

Sets the burn time of this ingredient, for use in the furnace and other machines

ZenScript
 Copy
// IIngredient.setBurnTime(time as int)

<tag:items:minecraft:wool>.setBurnTime(500);
ParameterTypeDescription
Parameter
time
Type
int
Description
the new burn time

Link to 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>
ParameterType
Parameter
transformer
Type
IIngredientTransformer<IIngredient>

Link to transformCustom

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>
ParameterTypeOptional
Parameter
uid
Type
string
Optional
false
Parameter
function
Type
Function<IItemStack,IItemStack>
Optional
true

Link to transformDamage

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
IIngredient.transformDamage(amount as int) as IIngredientTransformed<IIngredient>
ParameterTypeOptionalDefault Value
Parameter
amount
Type
int
Optional
true
Default Value
1

Link to transformReplace

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

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

Operators

Link to operators

Link to 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:minecraft:wool>

Link to MUL

Name: MUL

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

ZenScript
 Copy
myIIngredient * amount as int

Link to OR

Name: OR

ZenScript
 Copy
myIIngredient | other as IIngredient

Properties

Link to properties

NameTypeHas GetterHas SetterDescription
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
empty
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if this ingredient is empty.
Name
items
Type
IItemStack[]
Has Getter
true
Has Setter
false
Description
​
Previous
WrappingIIngredient
IIngredientWithAmount
Next