HomeCommandsExamplesGetting Started With ScriptsGlobal Keywords1.21 Migration Guide
IIngredientIIngredientWithAmountIngredient
BracketDumpersBracketHandlersBracketValidatorsResourceLocationBracketHandler
Previous
WrappingIIngredient IIngredientWithAmount
Next

IIngredient

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.ingredient.IIngredient;

Description

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

Implements

IIngredient implements the following interfaces:

CommandStringDisplayable

Operators

in
in(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?
script.zs
// ((ingredient as IIngredient) in IIngredient) as bool
myIIngredient in <tag:item:minecraft:wool>

Parameters:

ingredient Type: IIngredient - The ingredient to check

Return Type: bool

*
*(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.
script.zs
// (IIngredient * (amount as int)) as IIngredientWithAmount
<tag:item:minecraft:wool> * myInt

Parameters:

amount Type: int

Return Type: IIngredientWithAmount

|
|(other as IIngredient) as IIngredientList
script.zs
// (IIngredient | (other as IIngredient)) as IIngredientList
<tag:item:minecraft:wool> | myIIngredient

Parameters:

other Type: IIngredient

Return Type: IIngredientList

Members

addGlobalAttributeModifier
addGlobalAttributeModifier(attribute as Attribute, id as ResourceLocation, value as double, operation as Operation, slotTypes as EquipmentSlot[])
This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.
Please use Item Components instead.
script.zs
// IIngredient.addGlobalAttributeModifier(attribute as Attribute, id as ResourceLocation, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);
<tag:item:minecraft:wool>.addGlobalAttributeModifier(myAttribute, myResourceLocation, myDouble, myOperation, myEquipmentSlot[]);

Parameters:

attribute Type: Attribute
id Type: ResourceLocation
value Type: double
operation Type: AttributeOperation
slotTypes Type: EquipmentSlot[]
addShiftTooltip
addShiftTooltip(content as Component, showMessage as Component = null)
script.zs
// IIngredient.addShiftTooltip(content as Component, showMessage as Component = null);
<tag:item:minecraft:wool>.addShiftTooltip(myComponent, myComponent);

Parameters:

content Type: Component
showMessage (optional) Type: Component

Default Value: null

addTooltip
addTooltip(content as Component)
script.zs
// IIngredient.addTooltip(content as Component);
<tag:item:minecraft:wool>.addTooltip(myComponent);

Parameters:

content Type: Component
anyDamage
anyDamage() as IIngredient
script.zs
// IIngredient.anyDamage() as IIngredient;
<tag:item:minecraft:wool>.anyDamage();

Return Type: IIngredient

asIData
implicit as IData
script.zs
// IIngredient as IData
<tag:item:minecraft:wool> as IData

Return Type: IData

asIIngredientWithAmount
asIIngredientWithAmount() as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.
script.zs
// IIngredient.asIIngredientWithAmount() as IIngredientWithAmount;
<tag:item:minecraft:wool>.asIIngredientWithAmount();

Return Type: IIngredientWithAmount

implicit as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.
script.zs
// IIngredient as IIngredientWithAmount
<tag:item:minecraft:wool> as IIngredientWithAmount

Return Type: IIngredientWithAmount

asMapData
implicit as MapData
script.zs
// IIngredient as MapData
<tag:item:minecraft:wool> as MapData

Return Type: MapData

asVanillaIngredient
asVanillaIngredient() as Ingredient
Create a Vanilla ingredient matching this one.
script.zs
// IIngredient.asVanillaIngredient() as Ingredient;
<tag:item:minecraft:wool>.asVanillaIngredient();

Return Type: Ingredient

implicit as Ingredient
Create a Vanilla ingredient matching this one.
script.zs
// IIngredient as Ingredient
<tag:item:minecraft:wool> as Ingredient

Return Type: Ingredient

burnTime
Setter
Sets the burn time of this ingredient, for use in the furnace and other machines
script.zs
// IIngredient.burnTime = (time as int);
<tag:item:minecraft:wool>.burnTime = myInt;

Parameters:

time Type: int - the new burn time
burnTime(time as int)
Sets the burn time of this ingredient, for use in the furnace and other machines
script.zs
// IIngredient.burnTime(time as int);
<tag:item:minecraft:wool>.burnTime(500);

Parameters:

time Type: int - the new burn time
clearTooltip
clearTooltip(leaveName as bool = false)
script.zs
// IIngredient.clearTooltip(leaveName as bool = false);
<tag:item:minecraft:wool>.clearTooltip(myBool);

Parameters:

leaveName (optional) Type: bool

Default Value: false

commandString
Getter
Returns the BEP to get this stack
script.zs
// IIngredient.commandString as string
<tag:item:minecraft:wool>.commandString

Return Type: string

condition
condition(condition as IIngredientCondition) as IIngredient
Use this if you already have the condition from another ingredient
script.zs
// IIngredient.condition(condition as IIngredientCondition) as IIngredient;
<tag:item:minecraft:wool>.condition(myIIngredientCondition);

Parameters:

condition Type: IIngredientCondition

Return Type: IIngredient

contains
contains(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?
script.zs
// IIngredient.contains(ingredient as IIngredient) as bool;
<tag:item:minecraft:wool>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));

Parameters:

ingredient Type: IIngredient - The ingredient to check

Return Type: bool

empty
Getter
Checks if this ingredient is empty.
script.zs
// IIngredient.empty as bool
<tag:item:minecraft:wool>.empty

Return Type: bool

empty() as bool
Checks if this ingredient is empty.

Returns: true if empty, false otherwise

script.zs
// IIngredient.empty() as bool;
<tag:item:minecraft:wool>.empty();

Return Type: bool

getRemainingItem
getRemainingItem(stack as IItemStack) as IItemStack
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.
script.zs
// IIngredient.getRemainingItem(stack as IItemStack) as IItemStack;
<tag:item:minecraft:wool>.getRemainingItem(<item:minecraft:iron_ingot>);

Parameters:

stack Type: IItemStack - The stack to provide for this ingredient.

Return Type: IItemStack

items
Getter
script.zs
// IIngredient.items as IItemStack[]
<tag:item:minecraft:wool>.items

Return Type: IItemStack[]

matches
matches(stack as IItemStack) as bool
Does the given stack match the ingredient?
script.zs
// IIngredient.matches(stack as IItemStack) as bool;
<tag:item:minecraft:wool>.matches(<item:minecraft:iron_ingot>);

Parameters:

stack Type: IItemStack - The stack to check

Return Type: bool

modifyShiftTooltip
modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null)
script.zs
// IIngredient.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null);
<tag:item:minecraft:wool>.modifyShiftTooltip(myITooltipFunction, myITooltipFunction);

Parameters:

shiftedFunction Type: ITooltipFunction
unshiftedFunction (optional) Type: ITooltipFunction

Default Value: null

modifyTooltip
modifyTooltip(function as ITooltipFunction)
script.zs
// IIngredient.modifyTooltip(function as ITooltipFunction);
<tag:item:minecraft:wool>.modifyTooltip(myITooltipFunction);

Parameters:

function Type: ITooltipFunction
mul
mul(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.
script.zs
// IIngredient.mul(amount as int) as IIngredientWithAmount;
<tag:item:minecraft:wool>.mul(myInt);

Parameters:

amount Type: int

Return Type: IIngredientWithAmount

onlyDamaged
onlyDamaged() as IIngredient
script.zs
// IIngredient.onlyDamaged() as IIngredient;
<tag:item:minecraft:wool>.onlyDamaged();

Return Type: IIngredient

onlyDamagedAtLeast
onlyDamagedAtLeast(minDamage as int) as IIngredient
script.zs
// IIngredient.onlyDamagedAtLeast(minDamage as int) as IIngredient;
<tag:item:minecraft:wool>.onlyDamagedAtLeast(myInt);

Parameters:

minDamage Type: int

Return Type: IIngredient

onlyDamagedAtMost
onlyDamagedAtMost(maxDamage as int) as IIngredient
script.zs
// IIngredient.onlyDamagedAtMost(maxDamage as int) as IIngredient;
<tag:item:minecraft:wool>.onlyDamagedAtMost(myInt);

Parameters:

maxDamage Type: int

Return Type: IIngredient

onlyIf
onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IIngredient
script.zs
// IIngredient.onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IIngredient;
<tag:item:minecraft:wool>.onlyIf(myString, myPredicate);

Parameters:

uid Type: string
function (optional) Type: function(t as IItemStack) as bool

Default Value: null

Return Type: IIngredient

removeGlobalAttribute
removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])
This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.
Please use Item Components instead.
script.zs
// IIngredient.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]);
<tag:item:minecraft:wool>.removeGlobalAttribute(myAttribute, myEquipmentSlot[]);

Parameters:

attribute Type: Attribute
slotTypes Type: EquipmentSlot[]
removeGlobalAttributeModifier
removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[])
This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.
Please use Item Components instead.
script.zs
// IIngredient.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[]);
<tag:item:minecraft:wool>.removeGlobalAttributeModifier(myString, myEquipmentSlot[]);

Parameters:

uuid Type: string
slotTypes Type: EquipmentSlot[]
removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[])
This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.
Please use Item Components instead.
script.zs
// IIngredient.removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[]);
<tag:item:minecraft:wool>.removeGlobalAttributeModifier(myUUID, myEquipmentSlot[]);

Parameters:

uuid Type: UUID
slotTypes Type: EquipmentSlot[]
removeTooltip
removeTooltip(regex as string)
script.zs
// IIngredient.removeTooltip(regex as string);
<tag:item:minecraft:wool>.removeTooltip(myString);

Parameters:

regex Type: string
reuse
reuse() as IIngredient
script.zs
// IIngredient.reuse() as IIngredient;
<tag:item:minecraft:wool>.reuse();

Return Type: IIngredient

transformCustom
transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredient
script.zs
// IIngredient.transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredient;
<tag:item:minecraft:wool>.transformCustom(myString, myFunction);

Parameters:

uid Type: string
function (optional) Type: function(r as IItemStack) as IItemStack

Default Value: null

Return Type: IIngredient

transformDamage
transformDamage(amount as int = 1) as IIngredient
script.zs
// IIngredient.transformDamage(amount as int = 1) as IIngredient;
<tag:item:minecraft:wool>.transformDamage(myInt);

Parameters:

amount (optional) Type: int

Default Value: 1

Return Type: IIngredient

transformReplace
transformReplace(replaceWith as IItemStack) as IIngredient
script.zs
// IIngredient.transformReplace(replaceWith as IItemStack) as IIngredient;
<tag:item:minecraft:wool>.transformReplace(myIItemStack);

Parameters:

replaceWith Type: IItemStack

Return Type: IIngredient

Previous
WrappingIIngredient IIngredientWithAmount
Next