WrappingIIngredient

Link to wrappingiingredient

An IIngredient that wraps a vanilla Ingredient.

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.type.WrappingIIngredient;

Implemented Interfaces

Link to implemented-interfaces

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

Result TypeIs Implicit
Result Type
IData
Is Implicit
true
Result Type
IIngredientWithAmount
Is Implicit
true
Result Type
MapData
Is Implicit
true

Link to addGlobalAttributeModifier

Name: addGlobalAttributeModifier

This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.

Please use Item Components instead.

ZenScript
Copy
WrappingIIngredient.addGlobalAttributeModifier(attribute as Attribute, id as ResourceLocation, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])
ParameterType
Parameter
attribute
Type
Attribute
Parameter
id
Type
ResourceLocation
Parameter
value
Type
double
Parameter
operation
Type
AttributeOperation
Parameter
slotTypes
Type
EquipmentSlot[]

Name: addShiftTooltip

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

Name: addTooltip

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

Name: anyDamage

Return Type: IIngredient

ZenScript
Copy
// WrappingIIngredient.anyDamage() as IIngredient

<tag:item:minecraft:wool>.asIIngredient();.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
// WrappingIIngredient.asIIngredientWithAmount() as IIngredientWithAmount

<tag:item:minecraft:wool>.asIIngredient();.asIIngredientWithAmount();

Name: clearTooltip

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

Name: condition

Use this if you already have the condition from another ingredient

Return Type: IIngredient

ZenScript
Copy
WrappingIIngredient.condition(condition as IIngredientCondition) as IIngredient
ParameterType
Parameter
condition
Type
IIngredientCondition

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

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

<tag:item:minecraft:wool>.asIIngredient();.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
// WrappingIIngredient.getRemainingItem(stack as IItemStack) as IItemStack

<tag:item:minecraft:wool>.asIIngredient();.getRemainingItem(<item:minecraft:iron_ingot>);
ParameterTypeDescription
Parameter
stack
Type
IItemStack
Description
The stack to provide for this ingredient.

Link to modifyShiftTooltip

Name: modifyShiftTooltip

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

Name: modifyTooltip

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

Name: mul

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

Return Type: IIngredientWithAmount

ZenScript
Copy
WrappingIIngredient.mul(amount as int) as IIngredientWithAmount
ParameterType
Parameter
amount
Type
int

Name: onlyDamaged

Return Type: IIngredient

ZenScript
Copy
// WrappingIIngredient.onlyDamaged() as IIngredient

<tag:item:minecraft:wool>.asIIngredient();.onlyDamaged();

Link to onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IIngredient

ZenScript
Copy
WrappingIIngredient.onlyDamagedAtLeast(minDamage as int) as IIngredient
ParameterType
Parameter
minDamage
Type
int

Link to onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IIngredient

ZenScript
Copy
WrappingIIngredient.onlyDamagedAtMost(maxDamage as int) as IIngredient
ParameterType
Parameter
maxDamage
Type
int

Name: onlyIf

Return Type: IIngredient

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

Link to removeGlobalAttribute

Name: removeGlobalAttribute

This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.

Please use Item Components instead.

ZenScript
Copy
WrappingIIngredient.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])
ParameterType
Parameter
attribute
Type
Attribute
Parameter
slotTypes
Type
EquipmentSlot[]

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.

Please use Item Components instead.

ZenScript
Copy
WrappingIIngredient.removeGlobalAttributeModifier(uuid as stdlib.UUID, slotTypes as EquipmentSlot[])
ParameterType
Parameter
uuid
Type
stdlib.UUID
Parameter
slotTypes
Type
EquipmentSlot[]

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

This method no longer works and is deprecated, it is left in so it doesn't cause breaking changes.

Please use Item Components instead.

ZenScript
Copy
WrappingIIngredient.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[])
ParameterType
Parameter
uuid
Type
string
Parameter
slotTypes
Type
EquipmentSlot[]

Name: removeTooltip

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

Name: reuse

Return Type: IIngredient

ZenScript
Copy
// WrappingIIngredient.reuse() as IIngredient

<tag:item:minecraft:wool>.asIIngredient();.reuse();

Name: setBurnTime

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

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

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

Name: transformCustom

Return Type: IIngredient

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

Name: transformDamage

Return Type: IIngredient

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

Link to transformReplace

Name: transformReplace

Return Type: IIngredient

ZenScript
Copy
WrappingIIngredient.transformReplace(replaceWith as IItemStack) as IIngredient
ParameterType
Parameter
replaceWith
Type
IItemStack

Name: CONTAINS

Does the ingredient contain the given ingredient?

ZenScript
Copy
ingredient as IIngredient in myWrappingIIngredient
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <tag:item:minecraft:wool>.asIIngredient();

Name: MUL

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

ZenScript
Copy
myWrappingIIngredient * amount as int

Name: OR

ZenScript
Copy
myWrappingIIngredient | other as IIngredient
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