IItemStack

This represents an item. It can be retrieved using an Item BEP. Is an crafttweaker.api.item.IIngredient

This class was added by a mod with mod-id crafttweaker. So you need to have this mod installed if you want to use this feature.

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.

crafttweaker.api.item.IItemStack

Implemented Interfaces

IItemStack implements the following interfaces. That means any method available to them can also be used on this class.

Methods

clearCustomName

Clears any custom name set for this ItemStack

<item:minecraft:dirt>.clearCustomName();

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 CrT's net.minecraft.item.crafting.ICraftingRecipe

Returns crafttweaker.api.item.IItemStack

<item:minecraft:dirt>.getRemainingItem(stack as crafttweaker.api.item.IItemStack);
<item:minecraft:dirt>.getRemainingItem(<item:minecraft:iron_ingot>);
ParameterTypeDescription
stackcrafttweaker.api.item.IItemStackThe stack to provide for this ingredient.

matches

Does the given stack match the ingredient?

Returns boolean

<item:minecraft:dirt>.matches(stack as crafttweaker.api.item.IItemStack);
<item:minecraft:dirt>.matches(<item:minecraft:iron_ingot>);
ParameterTypeDescription
stackcrafttweaker.api.item.IItemStackThe stack to check

setDisplayName

Sets the display name of the ItemStack

Returns crafttweaker.api.item.IItemStack

<item:minecraft:dirt>.setDisplayName(name as String);
<item:minecraft:dirt>.setDisplayName("totally not dirt");
ParameterTypeDescription
nameStringNew name of the stack.

withDamage

Sets the damage of the ItemStack

Returns crafttweaker.api.item.IItemStack

<item:minecraft:dirt>.withDamage(damage as int);
<item:minecraft:dirt>.withDamage(10);
ParameterTypeDescription
damageintthe new damage value

withTag

Sets the tag for the ItemStack.

Returns crafttweaker.api.item.IItemStack

<item:minecraft:dirt>.withTag(tag as crafttweaker.api.data.IData);
<item:minecraft:dirt>.withTag({Display: {lore: ["Hello"]}});
ParameterTypeDescription
tagcrafttweaker.api.data.IDataThe tag to set.

Properties

NameTypeHas GetterHas Setter
amountinttruefalse
burnTimeinttruetrue
commandStringStringtruefalse
damageablebooleantruefalse
damagedbooleantruefalse
displayNameStringtruefalse
emptybooleantruefalse
foodcrafttweaker.api.food.MCFoodtruetrue
getOrCreatecrafttweaker.api.data.IDatatruefalse
getRepairCostinttruefalse
hasDisplayNamebooleantruefalse
hasEffectbooleantruefalse
hasTagbooleantruefalse
isCrossbowbooleantruefalse
isEnchantablebooleantruefalse
isEnchantedbooleantruefalse
itemscrafttweaker.api.item.IItemStack[]truefalse
maxDamageinttruefalse
maxStackSizeinttruefalse
registryNameStringtruefalse
stackablebooleantruefalse
tagcrafttweaker.api.data.IDatatruefalse
translationKeyStringtruefalse
useDurationinttruefalse

Operators

MUL

Sets the amount of the ItemStack

<item:minecraft:dirt> * amount as int
<item:minecraft:dirt> * 3
ParameterTypeDescription
amountintnew amount

Casters