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

Implemented Interfaces

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

Casters

Result type	Is Implicit
IData	true
IIngredientWithAmount	true
Ingredient	true
ItemStack	true
MapData	true
MCItemDefinition	true
MCWeightedItemStack	true

Methods

addShiftTooltip

Return Type: void

IItemStack.addShiftTooltip(content as MCTextComponent, showMessage as MCTextComponent) as void

Parameter	Type	Description	Optional	DefaultValue
content	MCTextComponent	No Description Provided	false
showMessage	MCTextComponent	No Description Provided	true

addTooltip

Return Type: void

IItemStack.addTooltip(content as MCTextComponent) as void

Parameter	Type	Description
content	MCTextComponent	No Description Provided

anyDamage

Return Type: MCIngredientConditioned<IIngredient>

IItemStack.anyDamage() as MCIngredientConditioned<IIngredient>
<item:minecraft:dirt>.anyDamage();

asIIngredientWithAmount

Return Type: IIngredientWithAmount

IItemStack.asIIngredientWithAmount() as IIngredientWithAmount
<item:minecraft:dirt>.asIIngredientWithAmount();

asImmutable

Return Type: IItemStack

IItemStack.asImmutable() as IItemStack
<item:minecraft:dirt>.asImmutable();

asVanillaIngredient

Create a Vanilla ingredient matching this one.

Return Type: Ingredient

IItemStack.asVanillaIngredient() as Ingredient
<item:minecraft:dirt>.asVanillaIngredient();

clearCustomName

Clears any custom name set for this ItemStack

Return Type: void

IItemStack.clearCustomName() as void
<item:minecraft:dirt>.clearCustomName();

clearTooltip

Return Type: void

IItemStack.clearTooltip() as void
<item:minecraft:dirt>.clearTooltip();

contains

Does the ingredient contain the given ingredient?

Return Type: boolean

IItemStack.contains(ingredient as IIngredient) as boolean
<item:minecraft:dirt>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));

Parameter	Type	Description
ingredient	IIngredient	The ingredient to check

copy

Creates a copy

Return Type: IItemStack

IItemStack.copy() as IItemStack
<item:minecraft:dirt>.copy();

getDefinition

Return Type: MCItemDefinition

IItemStack.getDefinition() as MCItemDefinition
<item:minecraft:dirt>.getDefinition();

getImmutableInternal

Return Type: ItemStack

IItemStack.getImmutableInternal() as ItemStack
<item:minecraft:dirt>.getImmutableInternal();

getInternal

Gets the internal ItemStack for this IItemStack.

Return Type: ItemStack

IItemStack.getInternal() as ItemStack
<item:minecraft:dirt>.getInternal();

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

IItemStack.getRemainingItem(stack as IItemStack) as IItemStack
<item:minecraft:dirt>.getRemainingItem(<item:minecraft:iron_ingot>);

Parameter	Type	Description
stack	IItemStack	The stack to provide for this ingredient.

isFood

Return Type: boolean

IItemStack.isFood() as boolean
<item:minecraft:dirt>.isFood();

isImmutable

Return Type: boolean

IItemStack.isImmutable() as boolean
<item:minecraft:dirt>.isImmutable();

matches

Does the given stack match the ingredient?

Return Type: boolean

IItemStack.matches(stack as IItemStack) as boolean
<item:minecraft:dirt>.matches(<item:minecraft:iron_ingot>);

Parameter	Type	Description
stack	IItemStack	The stack to check

modifyTooltip

Return Type: void

IItemStack.modifyTooltip(function as ITooltipFunction) as void

Parameter	Type	Description
function	ITooltipFunction	No Description Provided

mutable

Return Type: IItemStack

IItemStack.mutable() as IItemStack
<item:minecraft:dirt>.mutable();

only

Use this if you already have the condition from another ingredient

Return Type: MCIngredientConditioned<IIngredient>

IItemStack.only(condition as IIngredientCondition<IIngredient>) as MCIngredientConditioned<IIngredient>

Parameter	Type	Description
condition	IIngredientCondition<IIngredient>	No Description Provided

onlyDamaged

Return Type: MCIngredientConditioned<IIngredient>

IItemStack.onlyDamaged() as MCIngredientConditioned<IIngredient>
<item:minecraft:dirt>.onlyDamaged();

onlyIf

Return Type: MCIngredientConditioned<IIngredient>

IItemStack.onlyIf(uid as string, function as Predicate<IItemStack>) as MCIngredientConditioned<IIngredient>

Parameter	Type	Description	Optional	DefaultValue
uid	string	No Description Provided	false
function	Predicate<IItemStack>	No Description Provided	true

removeTooltip

Return Type: void

IItemStack.removeTooltip(regex as string) as void

Parameter	Type	Description
regex	string	No Description Provided

setDisplayName

Sets the display name of the ItemStack

Return Type: IItemStack

IItemStack.setDisplayName(name as string) as IItemStack
<item:minecraft:dirt>.setDisplayName("totally not dirt");

Parameter	Type	Description
name	string	New name of the stack.

weight

Return Type: MCWeightedItemStack

IItemStack.weight(weight as double) as MCWeightedItemStack

Parameter	Type	Description
weight	double	No Description Provided

withDamage

Sets the damage of the ItemStack

Return Type: IItemStack

IItemStack.withDamage(damage as int) as IItemStack
<item:minecraft:dirt>.withDamage(10);

Parameter	Type	Description
damage	int	the new damage value

withTag

Sets the tag for the ItemStack.

Return Type: IItemStack

IItemStack.withTag(tag as IData) as IItemStack
<item:minecraft:dirt>.withTag({Display: {lore: ["Hello"]}});

Parameter	Type	Description
tag	IData	The tag to set.

Operators

CONTAINS

Does the ingredient contain the given ingredient?

ingredient as IIngredient in myIItemStack
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <item:minecraft:dirt>

MOD

myIItemStack % percentage as int

MUL

Sets the amount of the ItemStack

myIItemStack * amount as int
<item:minecraft:dirt> * 3

myIItemStack | other as IIngredient

Properties

Name	Type	Has Getter	Has Setter
amount	int	true	false
burnTime	int	true	true
commandString	string	true	false
damage	int	true	false
damageable	boolean	true	false
damaged	boolean	true	false
definition	MCItemDefinition	true	false
displayName	string	true	false
empty	boolean	true	false
food	MCFood?	true	true
getOrCreate	IData	true	false
getRepairCost	int	true	false
hasDisplayName	boolean	true	false
hasEffect	boolean	true	false
hasTag	boolean	true	false
isCrossbow	boolean	true	false
isEnchantable	boolean	true	false
isEnchanted	boolean	true	false
isImmutable	boolean	true	false
items	IItemStack[]	true	false
maxDamage	int	true	false
maxStackSize	int	true	false
owner	string	true	false
registryName	MCResourceLocation	true	false
stackable	boolean	true	false
tag	IData	true	false
translationKey	string	true	false
useDuration	int	true	false