IIngredient

This is IIngredient!!!

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.

import crafttweaker.api.item.IIngredient;

Implemented Interfaces

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

Casters

Result typeIs Implicit
IDatatrue
Ingredienttrue
MapDatatrue

Methods

addShiftTooltip

Return Type: void

IIngredient.addShiftTooltip(content as MCTextComponent, showMessage as MCTextComponent) as void
ParameterTypeDescriptionOptionalDefaultValue
contentMCTextComponentNo Description Providedfalse
showMessageMCTextComponentNo Description Providedtrue
addTooltip

Return Type: void

IIngredient.addTooltip(content as MCTextComponent) as void
ParameterTypeDescription
contentMCTextComponentNo Description Provided
anyDamage

Return Type: MCIngredientConditioned<IIngredient>

IIngredient.anyDamage() as MCIngredientConditioned<IIngredient>
<tag:items:forge:ingots>.anyDamage();
asVanillaIngredient

Create a Vanilla ingredient matching this one.

Return Type: Ingredient

IIngredient.asVanillaIngredient() as Ingredient
<tag:items:forge:ingots>.asVanillaIngredient();
clearTooltip

Return Type: void

IIngredient.clearTooltip() as void
<tag:items:forge:ingots>.clearTooltip();
contains

Does the ingredient contain the given ingredient?

Return Type: boolean

IIngredient.contains(ingredient as IIngredient) as boolean
<tag:items:forge:ingots>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
ParameterTypeDescription
ingredientIIngredientThe ingredient to check
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

IIngredient.getRemainingItem(stack as IItemStack) as IItemStack
<tag:items:forge:ingots>.getRemainingItem(<item:minecraft:iron_ingot>);
ParameterTypeDescription
stackIItemStackThe stack to provide for this ingredient.
matches

Does the given stack match the ingredient?

Return Type: boolean

IIngredient.matches(stack as IItemStack) as boolean
<tag:items:forge:ingots>.matches(<item:minecraft:iron_ingot>);
ParameterTypeDescription
stackIItemStackThe stack to check
matches

Does the given stack match the ingredient?

Return Type: boolean

IIngredient.matches(stack as IItemStack, ignoreDamage as boolean) as boolean
ParameterTypeDescription
stackIItemStackThe stack to check
ignoreDamagebooleanShould damage be checked?
modifyTooltip

Return Type: void

IIngredient.modifyTooltip(function as ITooltipFunction) as void
ParameterTypeDescription
functionITooltipFunctionNo Description Provided
only

Use this if you already have the condition from another ingredient

Return Type: MCIngredientConditioned<IIngredient>

IIngredient.only(condition as IIngredientCondition<IIngredient>) as MCIngredientConditioned<IIngredient>
ParameterTypeDescription
conditionIIngredientCondition<IIngredient>No Description Provided
onlyDamaged

Return Type: MCIngredientConditioned<IIngredient>

IIngredient.onlyDamaged() as MCIngredientConditioned<IIngredient>
<tag:items:forge:ingots>.onlyDamaged();
onlyIf

Return Type: MCIngredientConditioned<IIngredient>

IIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as MCIngredientConditioned<IIngredient>
ParameterTypeDescriptionOptionalDefaultValue
uidstringNo Description Providedfalse
functionPredicate<IItemStack>No Description Providedtrue
removeTooltip

Return Type: void

IIngredient.removeTooltip(regex as string) as void
ParameterTypeDescription
regexstringNo Description Provided

Operators

CONTAINS

Does the ingredient contain the given ingredient?

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

Properties

NameTypeHas GetterHas Setter
burnTimevoidfalsetrue
commandStringstringtruefalse
itemsIItemStack[]truefalse