IIngredientEmpty - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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.IIngredientEmpty;

Implemented Interfaces

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

IIngredient

Static Methods

getInstance

Name: getInstance

Return Type: IIngredientEmpty

ZenScript
 Copy
// IIngredientEmpty.getInstance() as IIngredientEmpty

IIngredientEmpty.getInstance();

Casters

Result Type	Is Implicit
Result Type IData	Is Implicit true
Result Type IIngredientWithAmount	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

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

myIIngredientEmpty.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft: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.

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

myIIngredientEmpty.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, IItemStack.BASE_ATTACK_DAMAGE_UUID, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);

Parameter	Type	Description
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.

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.

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

myIIngredientEmpty.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft: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

ZenScript
 Copy
IIngredientEmpty.addShiftTooltip(content as Component, showMessage as Component)

Parameter	Type	Optional
Parameter content	Type Component	Optional false
Parameter showMessage	Type Component	Optional true

addTooltip

Name: addTooltip

ZenScript
 Copy
IIngredientEmpty.addTooltip(content as Component)

Parameter	Type
Parameter content	Type Component

anyDamage

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

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

myIIngredientEmpty.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
// IIngredientEmpty.asIIngredientWithAmount() as IIngredientWithAmount

myIIngredientEmpty.asIIngredientWithAmount();

clearTooltip

Name: clearTooltip

ZenScript
 Copy
IIngredientEmpty.clearTooltip(leaveName as boolean)

Parameter	Type	Optional	Default Value
Parameter leaveName	Type boolean	Optional true	Default Value false

contains

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

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

myIIngredientEmpty.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
// IIngredientEmpty.getRemainingItem(stack as IItemStack) as IItemStack

myIIngredientEmpty.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
// IIngredientEmpty.matches(stack as IItemStack) as boolean

myIIngredientEmpty.matches(<item:minecraft:iron_ingot>);

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

modifyShiftTooltip

Name: modifyShiftTooltip

ZenScript
 Copy
IIngredientEmpty.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction)

Parameter	Type	Optional
Parameter shiftedFunction	Type ITooltipFunction	Optional false
Parameter unshiftedFunction	Type ITooltipFunction	Optional true

modifyTooltip

Name: modifyTooltip

ZenScript
 Copy
IIngredientEmpty.modifyTooltip(function as ITooltipFunction)

Parameter	Type
Parameter function	Type ITooltipFunction

mul

Name: mul

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

Return Type: IIngredientWithAmount

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

Parameter	Type
Parameter amount	Type int

only

Name: only

Use this if you already have the condition from another ingredient

Return Type: IngredientConditioned<IIngredient>

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

Parameter	Type
Parameter condition	Type IIngredientCondition<IIngredient>

onlyDamaged

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

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

myIIngredientEmpty.onlyDamaged();

onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

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

Parameter	Type
Parameter minDamage	Type int

onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

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

Parameter	Type
Parameter maxDamage	Type int

onlyIf

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

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

Parameter	Type	Optional
Parameter uid	Type string	Optional false
Parameter function	Type Predicate<IItemStack>	Optional true

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
// IIngredientEmpty.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])

myIIngredientEmpty.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<constant:minecraft: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.

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

myIIngredientEmpty.removeGlobalAttributeModifier(IItemStack.BASE_ATTACK_DAMAGE_UUID, [<constant:minecraft:equipmentslot:chest>]);

Parameter	Type	Description
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.

removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

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

myIIngredientEmpty.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<constant:minecraft: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

ZenScript
 Copy
IIngredientEmpty.removeTooltip(regex as string)

Parameter	Type
Parameter regex	Type string

reuse

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

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

myIIngredientEmpty.reuse();

setBurnTime

Name: setBurnTime

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

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

myIIngredientEmpty.setBurnTime(500);

Parameter	Type	Description
Parameter time	Type int	Description the new burn time

transform

Name: transform

Use this if you already have the transformer from another ingredient

Return Type: IIngredientTransformed<IIngredient>

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

Parameter	Type
Parameter transformer	Type IIngredientTransformer<IIngredient>

transformCustom

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

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

Parameter	Type	Optional
Parameter uid	Type string	Optional false
Parameter function	Type Function<IItemStack,IItemStack>	Optional true

transformDamage

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

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

Parameter	Type	Optional	Default Value
Parameter amount	Type int	Optional true	Default Value 1

transformReplace

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

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

Parameter	Type
Parameter replaceWith	Type IItemStack

Operators

CONTAINS

Name: CONTAINS

Does the ingredient contain the given ingredient?

ZenScript
 Copy
ingredient as IIngredient in myIIngredientEmpty
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in myIIngredientEmpty

MUL

Name: MUL

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

ZenScript
 Copy
myIIngredientEmpty * amount as int

Name: OR

ZenScript
 Copy
myIIngredientEmpty | 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