Home Commands Examples Getting Started With Scripts Global Keywords
ForgeIItemStackExpansions ForgeItemStack MCItemStack MCItemStackMutable
BracketHandlers ForgeBracketDumpers ForgeBracketValidators
Previous
ForgeIItemStackExpansions MCItemStack
Next

ForgeItemStack

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.item.ForgeItemStack;

Implements

ForgeItemStack implements the following interfaces:

IItemStack,IIngredient,IIngredientWithAmount,CommandStringDisplayable

Operators

in
in(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?
script.zs
// ((ingredient as IIngredient) in ForgeItemStack) as bool
myIIngredient in myForgeItemStack

Parameters:

ingredient Type: IIngredient - The ingredient to check

Return Type: bool

*
*(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.
script.zs
// (ForgeItemStack * (amount as int)) as IIngredientWithAmount
myForgeItemStack * myInt

Parameters:

amount Type: int

Return Type: IIngredientWithAmount

|
|(other as IIngredient) as IIngredientList
script.zs
// (ForgeItemStack | (other as IIngredient)) as IIngredientList
myForgeItemStack | myIIngredient

Parameters:

other Type: IIngredient

Return Type: IIngredientList

%
%(percentage as double) as Percentaged<IItemStack>
script.zs
// (ForgeItemStack % (percentage as double)) as Percentaged<IItemStack>
myForgeItemStack % myDouble

Parameters:

percentage Type: double

Return Type: Percentaged<IItemStack>

*
*(amount as int) as IItemStack
Sets the amount of the ItemStack
script.zs
// (ForgeItemStack * (amount as int)) as IItemStack
myForgeItemStack * myInt

Parameters:

amount Type: int - new amount

Return Type: IItemStack

Members

addGlobalAttributeModifier
addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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
script.zs
// ForgeItemStack.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);
myForgeItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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.
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
script.zs
// ForgeItemStack.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);
myForgeItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
uuid Type: string - The unique identifier of the modifier to replace.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
addGlobalAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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.
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
script.zs
// ForgeItemStack.addGlobalAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);
myForgeItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, IItemStack.BASE_ATTACK_DAMAGE_UUID, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
uuid Type: UUID - The unique identifier of the modifier to replace.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
addShiftTooltip
addShiftTooltip(content as Component, showMessage as Component = null)
script.zs
// ForgeItemStack.addShiftTooltip(content as Component, showMessage as Component = null);
myForgeItemStack.addShiftTooltip(myComponent, myComponent);

Parameters:

content Type: Component
showMessage (optional) Type: Component

Default Value: null

addTooltip
addTooltip(content as Component)
script.zs
// ForgeItemStack.addTooltip(content as Component);
myForgeItemStack.addTooltip(myComponent);

Parameters:

content Type: Component
amount
Getter
Gets the amount of Items in the ItemStack
script.zs
// ForgeItemStack.amount as int
myForgeItemStack.amount

Return Type: int

Getter
Gets the amount of Items in the ItemStack
script.zs
// ForgeItemStack.amount as int
myForgeItemStack.amount

Return Type: int

anyDamage
anyDamage() as IIngredientConditioned<IIngredient>
script.zs
// ForgeItemStack.anyDamage() as IngredientConditioned<IIngredient>;
myForgeItemStack.anyDamage();

Return Type: IngredientConditioned<IIngredient>

asIData
asIData() as IData
script.zs
// ForgeItemStack.asIData() as IData;
myForgeItemStack.asIData();

Return Type: IData

implicit as IData
script.zs
// ForgeItemStack as IData
myForgeItemStack as IData

Return Type: IData

implicit as IData
script.zs
// ForgeItemStack as IData
myForgeItemStack as IData

Return Type: IData

asIIngredientWithAmount
asIIngredientWithAmount() as IIngredientWithAmount
script.zs
// ForgeItemStack.asIIngredientWithAmount() as IIngredientWithAmount;
myForgeItemStack.asIIngredientWithAmount();

Return Type: IIngredientWithAmount

asIIngredientWithAmount() as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.
script.zs
// ForgeItemStack.asIIngredientWithAmount() as IIngredientWithAmount;
myForgeItemStack.asIIngredientWithAmount();

Return Type: IIngredientWithAmount

implicit as IIngredientWithAmount
script.zs
// ForgeItemStack as IIngredientWithAmount
myForgeItemStack as IIngredientWithAmount

Return Type: IIngredientWithAmount

implicit as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.
script.zs
// ForgeItemStack as IIngredientWithAmount
myForgeItemStack as IIngredientWithAmount

Return Type: IIngredientWithAmount

asImmutable
asImmutable() as IItemStack
script.zs
// ForgeItemStack.asImmutable() as IItemStack;
myForgeItemStack.asImmutable();

Return Type: IItemStack

asItemLike
asItemLike() as ItemLike
script.zs
// ForgeItemStack.asItemLike() as ItemLike;
myForgeItemStack.asItemLike();

Return Type: ItemLike

implicit as ItemLike
script.zs
// ForgeItemStack as ItemLike
myForgeItemStack as ItemLike

Return Type: ItemLike

asMapData
implicit as MapData
script.zs
// ForgeItemStack as MapData
myForgeItemStack as MapData

Return Type: MapData

asMutable
asMutable() as IItemStack
script.zs
// ForgeItemStack.asMutable() as IItemStack;
myForgeItemStack.asMutable();

Return Type: IItemStack

asVanillaIngredient
asVanillaIngredient() as Ingredient
Create a Vanilla ingredient matching this one.
script.zs
// ForgeItemStack.asVanillaIngredient() as Ingredient;
myForgeItemStack.asVanillaIngredient();

Return Type: Ingredient

implicit as Ingredient
Create a Vanilla ingredient matching this one.
script.zs
// ForgeItemStack as Ingredient
myForgeItemStack as Ingredient

Return Type: Ingredient

asWeightedItemStack
implicit as Percentaged<IItemStack>
script.zs
// ForgeItemStack as Percentaged<IItemStack>
myForgeItemStack as Percentaged<IItemStack>

Return Type: Percentaged<IItemStack>

BASE_ATTACK_DAMAGE_UUID
Field
script.zs
// ForgeItemStack.BASE_ATTACK_DAMAGE_UUID as UUID
ForgeItemStack.BASE_ATTACK_DAMAGE_UUID

Return Type: UUID

BASE_ATTACK_SPEED_UUID
Field
script.zs
// ForgeItemStack.BASE_ATTACK_SPEED_UUID as UUID
ForgeItemStack.BASE_ATTACK_SPEED_UUID

Return Type: UUID

baseRepairCost
Getter
Gets the base repair cost of the ItemStack, or 0 if no repair is defined.
script.zs
// ForgeItemStack.baseRepairCost as int
myForgeItemStack.baseRepairCost

Return Type: int

burnTime
Setter
Sets the burn time of this ingredient, for use in the furnace and other machines
script.zs
// ForgeItemStack.burnTime = (time as int);
myForgeItemStack.burnTime = myInt;

Parameters:

time Type: int - the new burn time
burnTime(time as int)
Sets the burn time of this ingredient, for use in the furnace and other machines
script.zs
// ForgeItemStack.burnTime(time as int);
myForgeItemStack.burnTime(500);

Parameters:

time Type: int - the new burn time
clearTooltip
clearTooltip(leaveName as bool = false)
script.zs
// ForgeItemStack.clearTooltip(leaveName as bool = false);
myForgeItemStack.clearTooltip(myBool);

Parameters:

leaveName (optional) Type: bool

Default Value: false

commandString
Getter
Returns the BEP to get this stack
script.zs
// ForgeItemStack.commandString as string
myForgeItemStack.commandString

Return Type: string

Getter
Returns the BEP to get this thingy
script.zs
// ForgeItemStack.commandString as string
myForgeItemStack.commandString

Return Type: string

commandString() as string
Returns the BEP to get this thingy
script.zs
// ForgeItemStack.commandString() as string;
myForgeItemStack.commandString();

Return Type: string

contains
contains(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?
script.zs
// ForgeItemStack.contains(ingredient as IIngredient) as bool;
myForgeItemStack.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));

Parameters:

ingredient Type: IIngredient - The ingredient to check

Return Type: bool

copy
copy() as IItemStack
Creates a copy
script.zs
// ForgeItemStack.copy() as IItemStack;
myForgeItemStack.copy();

Return Type: IItemStack

CRAFTTWEAKER_DATA_KEY
Field
script.zs
// ForgeItemStack.CRAFTTWEAKER_DATA_KEY as string
ForgeItemStack.CRAFTTWEAKER_DATA_KEY

Return Type: string

damage
Getter
script.zs
// ForgeItemStack.damage as int
myForgeItemStack.damage

Return Type: int

damageableItem
Getter
Returns if the ItemStack is damageable I.E Swords and tools are damageable, sticks are not.
script.zs
// ForgeItemStack.damageableItem as bool
myForgeItemStack.damageableItem

Return Type: bool

damaged
Getter
Returns if the ItemStack is damaged I.E a Swords that is no at full durability is damaged.
script.zs
// ForgeItemStack.damaged as bool
myForgeItemStack.damaged

Return Type: bool

definition
Getter
script.zs
// ForgeItemStack.definition as ItemDefinition
myForgeItemStack.definition

Return Type: ItemDefinition

definition() as Item
script.zs
// ForgeItemStack.definition() as ItemDefinition;
myForgeItemStack.definition();

Return Type: ItemDefinition

implicit as Item
script.zs
// ForgeItemStack as ItemDefinition
myForgeItemStack as Item

Return Type: ItemDefinition

descriptionId
Getter
Returns the unlocalized Name of the Item in the ItemStack
script.zs
// ForgeItemStack.descriptionId as string
myForgeItemStack.descriptionId

Return Type: string

displayName
Getter
Gets the display name of the ItemStack
script.zs
// ForgeItemStack.displayName as Component
myForgeItemStack.displayName

Return Type: Component

empty
Getter
Checks if this ingredient is empty.
script.zs
// ForgeItemStack.empty as bool
myForgeItemStack.empty

Return Type: bool

empty() as bool
Checks if this ingredient is empty.

Returns: true if empty, false otherwise

script.zs
// ForgeItemStack.empty() as bool;
myForgeItemStack.empty();

Return Type: bool

enchantments
Getter
script.zs
// ForgeItemStack.enchantments as Integer[Enchantment]
myForgeItemStack.enchantments

Return Type: Integer[Enchantment]

Setter
Sets the enchantments on this IItemStack.
script.zs
// ForgeItemStack.enchantments = (enchantments as Integer[Enchantment]);
myForgeItemStack.enchantments = myMap;

Parameters:

enchantments Type: Integer[Enchantment] - The new enchantments
enchantments() as Integer[Enchantment]
script.zs
// ForgeItemStack.enchantments() as Integer[Enchantment];
myForgeItemStack.enchantments();

Return Type: Integer[Enchantment]

enchantments(enchantments as Integer[Enchantment]) as IItemStack
Sets the enchantments on this IItemStack.

Returns: This itemStack if it is mutable, a new one with the enchantments otherwise

script.zs
// ForgeItemStack.enchantments(enchantments as Integer[Enchantment]) as IItemStack;
myForgeItemStack.enchantments(myMap);

Parameters:

enchantments Type: Integer[Enchantment] - The new enchantments

Return Type: IItemStack

fireResistant
Getter
Checks if this IItemStack burns when thrown into fire / lava or damaged by fire.
script.zs
// ForgeItemStack.fireResistant as bool
myForgeItemStack.fireResistant

Return Type: bool

Setter
Sets if this IItemStack is immune to fire / lava.
If true, the item will not burn when thrown into fire or lava.
script.zs
// ForgeItemStack.fireResistant = (fireResistant as bool);
myForgeItemStack.fireResistant = myBool;

Parameters:

fireResistant Type: bool - Should the item be immune to fire.
fireResistant() as bool
Checks if this IItemStack burns when thrown into fire / lava or damaged by fire.

Returns: True if this IItemStack is immune to fire. False otherwise.

script.zs
// ForgeItemStack.fireResistant() as bool;
myForgeItemStack.fireResistant();

Return Type: bool

fireResistant(fireResistant as bool)
Sets if this IItemStack is immune to fire / lava.
If true, the item will not burn when thrown into fire or lava.
script.zs
// ForgeItemStack.fireResistant(fireResistant as bool);
myForgeItemStack.fireResistant(myBool);

Parameters:

fireResistant Type: bool - Should the item be immune to fire.
food
Getter
script.zs
// ForgeItemStack.food as FoodProperties
myForgeItemStack.food

Return Type: FoodProperties

Setter
script.zs
// ForgeItemStack.food = (food as FoodProperties);
myForgeItemStack.food = myFoodProperties;

Parameters:

food Type: FoodProperties
food() as FoodProperties
script.zs
// ForgeItemStack.food() as FoodProperties;
myForgeItemStack.food();

Return Type: FoodProperties

food(food as FoodProperties)
script.zs
// ForgeItemStack.food(food as FoodProperties);
myForgeItemStack.food(myFoodProperties);

Parameters:

food Type: FoodProperties
getAttributes
getAttributes(slotType as EquipmentSlot) as List<AttributeModifier>[Attribute]
Gets the Attributes and the AttributeModifiers on this IItemStack for the given EquipmentSlot

Returns: A Map of Attribute to a List of AttributeModifier for the given EquipmentSlot.

script.zs
// ForgeItemStack.getAttributes(slotType as EquipmentSlot) as List<AttributeModifier>[Attribute];
myForgeItemStack.getAttributes(<constant:minecraft:equipmentslot:chest>);

Parameters:

slotType Type: EquipmentSlot - The slot to get the Attributes for.

Return Type: List<AttributeModifier>[Attribute]

getBurnTime
getBurnTime(manager as IRecipeManager<Recipe>) as int
script.zs
// ForgeItemStack.getBurnTime(manager as IRecipeManager<Recipe>) as int;
myForgeItemStack.getBurnTime(myIRecipeManager);

Parameters:

manager Type: IRecipeManager<Recipe>

Return Type: int

getEnchantmentLevel
getEnchantmentLevel(enchantment as Enchantment) as int
Gets the level of the given enchantment on the item. Returns 0 if the item doesn't have the given enchantment.
script.zs
// ForgeItemStack.getEnchantmentLevel(enchantment as Enchantment) as int;
myForgeItemStack.getEnchantmentLevel(myEnchantment);

Parameters:

enchantment Type: Enchantment

Return Type: int

getImmutableInternal
getImmutableInternal() as ItemStack
script.zs
// ForgeItemStack.getImmutableInternal() as ItemStack;
myForgeItemStack.getImmutableInternal();

Return Type: ItemStack

getInternal
getInternal() as ItemStack
Gets the internal ItemStack for this IItemStack.

Returns: internal ItemStack

script.zs
// ForgeItemStack.getInternal() as ItemStack;
myForgeItemStack.getInternal();

Return Type: ItemStack

implicit as ItemStack
Gets the internal ItemStack for this IItemStack.
script.zs
// ForgeItemStack as ItemStack
myForgeItemStack as ItemStack

Return Type: ItemStack

getOrCreateTag
getOrCreateTag() as IData
Returns the NBT tag attached to this ItemStack or makes a new tag.

Returns: MapData of the ItemStack NBT Tag, empty tag if it doesn't exist.

script.zs
// ForgeItemStack.getOrCreateTag() as IData;
myForgeItemStack.getOrCreateTag();

Return Type: IData

getRemainingItem
getRemainingItem(stack as IItemStack) as IItemStack
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.
script.zs
// ForgeItemStack.getRemainingItem(stack as IItemStack) as IItemStack;
myForgeItemStack.getRemainingItem(<item:minecraft:iron_ingot>);

Parameters:

stack Type: IItemStack - The stack to provide for this ingredient.

Return Type: IItemStack

grow
grow(amount as int = 1) as IItemStack
Grows this IItemStack's stack size by the given amount, or 1 if no amount is given.

Returns: This IItemStack if mutable, a new one with the new amount otherwise.

script.zs
// ForgeItemStack.grow(amount as int = 1) as IItemStack;
myForgeItemStack.grow(2);

Parameters:

amount (optional) Type: int - The amount to grow by.

Default Value: 1

Return Type: IItemStack

hasCustomHoverName
Getter
Returns true if the ItemStack has a display name.
script.zs
// ForgeItemStack.hasCustomHoverName as bool
myForgeItemStack.hasCustomHoverName

Return Type: bool

hasFoil
Getter
Returns true if this ItemStack has a foil effect.
Foil is the glint / effect that is added to enchanted ItemStacks (and other items).
script.zs
// ForgeItemStack.hasFoil as bool
myForgeItemStack.hasFoil

Return Type: bool

hasTag
Getter
Returns true if this ItemStack has a Tag
script.zs
// ForgeItemStack.hasTag as bool
myForgeItemStack.hasTag

Return Type: bool

hoverName
Getter
Gets the hover name of the ItemStack.

This will give the raw name without the formatting that 'displayName' applies.

script.zs
// ForgeItemStack.hoverName as Component
myForgeItemStack.hoverName

Return Type: Component

hoverName() as Component
Gets the hover name of the ItemStack.

This will give the raw name without the formatting that 'displayName' applies.

Returns: The hover name of the ItemStack.

script.zs
// ForgeItemStack.hoverName() as Component;
myForgeItemStack.hoverName();

Return Type: Component

ingredient
Getter
The backing ingredient
script.zs
// ForgeItemStack.ingredient as IIngredient
myForgeItemStack.ingredient

Return Type: IIngredient

isEdible
Getter
script.zs
// ForgeItemStack.isEdible as bool
myForgeItemStack.isEdible

Return Type: bool

isEdible() as bool
script.zs
// ForgeItemStack.isEdible() as bool;
myForgeItemStack.isEdible();

Return Type: bool

isEnchantable
Getter
Can this ItemStack be enchanted?
script.zs
// ForgeItemStack.isEnchantable as bool
myForgeItemStack.isEnchantable

Return Type: bool

isEnchanted
Getter
Is this ItemStack enchanted?
script.zs
// ForgeItemStack.isEnchanted as bool
myForgeItemStack.isEnchanted

Return Type: bool

isImmutable
Getter
script.zs
// ForgeItemStack.isImmutable as bool
myForgeItemStack.isImmutable

Return Type: bool

isImmutable() as bool
script.zs
// ForgeItemStack.isImmutable() as bool;
myForgeItemStack.isImmutable();

Return Type: bool

isMutable
Getter
script.zs
// ForgeItemStack.isMutable as bool
myForgeItemStack.isMutable

Return Type: bool

isMutable() as bool
script.zs
// ForgeItemStack.isMutable() as bool;
myForgeItemStack.isMutable();

Return Type: bool

items
Getter
script.zs
// ForgeItemStack.items as IItemStack[]
myForgeItemStack.items

Return Type: IItemStack[]

matches
matches(stack as IItemStack) as bool
Does the given stack match the ingredient?
script.zs
// ForgeItemStack.matches(stack as IItemStack) as bool;
myForgeItemStack.matches(<item:minecraft:iron_ingot>);

Parameters:

stack Type: IItemStack - The stack to check

Return Type: bool

matches(stack as IItemStack, ignoreDamage as bool) as bool
Does the given stack match the ingredient?
script.zs
// ForgeItemStack.matches(stack as IItemStack, ignoreDamage as bool) as bool;
myForgeItemStack.matches(<item:minecraft:iron_ingot>, myBool);

Parameters:

stack Type: IItemStack - The stack to check
ignoreDamage Type: bool - Should damage be checked?

Return Type: bool

maxDamage
Getter
Returns the max damage of the ItemStack This is the max durability of the ItemStack.
script.zs
// ForgeItemStack.maxDamage as int
myForgeItemStack.maxDamage

Return Type: int

Setter
Sets the max damage of the ItemStack.
Setting the damage to 0 will make the item unbreakable.
script.zs
// ForgeItemStack.maxDamage = (newMaxDamage as int);
myForgeItemStack.maxDamage = myInt;

Parameters:

newMaxDamage Type: int - The new max damage of the ItemStack
maxStackSize
Getter
Returns the max stack size of the Item in the ItemStack
script.zs
// ForgeItemStack.maxStackSize as int
myForgeItemStack.maxStackSize

Return Type: int

Setter
Sets the max stacksize of the Item.
script.zs
// ForgeItemStack.maxStackSize = (newMaxStackSize as int);
myForgeItemStack.maxStackSize = myInt;

Parameters:

newMaxStackSize Type: int - The new max stack size of the Item.
maxStackSize() as int
Returns the max stack size of the Item in the ItemStack

Returns: Max stack size of the Item.

script.zs
// ForgeItemStack.maxStackSize() as int;
myForgeItemStack.maxStackSize();

Return Type: int

maxStackSize(newMaxStackSize as int)
Sets the max stacksize of the Item.
script.zs
// ForgeItemStack.maxStackSize(newMaxStackSize as int);
myForgeItemStack.maxStackSize(16);

Parameters:

newMaxStackSize Type: int - The new max stack size of the Item.
modifyShiftTooltip
modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null)
script.zs
// ForgeItemStack.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null);
myForgeItemStack.modifyShiftTooltip(myITooltipFunction, myITooltipFunction);

Parameters:

shiftedFunction Type: ITooltipFunction
unshiftedFunction (optional) Type: ITooltipFunction

Default Value: null

modifyTooltip
modifyTooltip(function as ITooltipFunction)
script.zs
// ForgeItemStack.modifyTooltip(function as ITooltipFunction);
myForgeItemStack.modifyTooltip(myITooltipFunction);

Parameters:

function Type: ITooltipFunction
mul
mul(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.
script.zs
// ForgeItemStack.mul(amount as int) as IIngredientWithAmount;
myForgeItemStack.mul(myInt);

Parameters:

amount Type: int

Return Type: IIngredientWithAmount

only
only(condition as IIngredientCondition<IIngredient>) as IIngredientConditioned<IIngredient>
Use this if you already have the condition from another ingredient
script.zs
// ForgeItemStack.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>;
myForgeItemStack.only(myIIngredientCondition);

Parameters:

condition Type: IIngredientCondition<IIngredient>

Return Type: IngredientConditioned<IIngredient>

onlyDamaged
onlyDamaged() as IIngredientConditioned<IIngredient>
script.zs
// ForgeItemStack.onlyDamaged() as IngredientConditioned<IIngredient>;
myForgeItemStack.onlyDamaged();

Return Type: IngredientConditioned<IIngredient>

onlyDamagedAtLeast
onlyDamagedAtLeast(minDamage as int) as IIngredientConditioned<IIngredient>
script.zs
// ForgeItemStack.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>;
myForgeItemStack.onlyDamagedAtLeast(myInt);

Parameters:

minDamage Type: int

Return Type: IngredientConditioned<IIngredient>

onlyDamagedAtMost
onlyDamagedAtMost(maxDamage as int) as IIngredientConditioned<IIngredient>
script.zs
// ForgeItemStack.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>;
myForgeItemStack.onlyDamagedAtMost(myInt);

Parameters:

maxDamage Type: int

Return Type: IngredientConditioned<IIngredient>

onlyIf
onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IIngredientConditioned<IIngredient>
script.zs
// ForgeItemStack.onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IngredientConditioned<IIngredient>;
myForgeItemStack.onlyIf(myString, myPredicate);

Parameters:

uid Type: string
function (optional) Type: function(t as IItemStack) as bool

Default Value: null

Return Type: IngredientConditioned<IIngredient>

owner
Getter
Gets owning mod for the Item in this IItemStack
script.zs
// ForgeItemStack.owner as string
myForgeItemStack.owner

Return Type: string

percent
percent(percentage as double) as Percentaged<IItemStack>
script.zs
// ForgeItemStack.percent(percentage as double) as Percentaged<IItemStack>;
myForgeItemStack.percent(myDouble);

Parameters:

percentage Type: double

Return Type: Percentaged<IItemStack>

rarity
Getter
Returns the rarity of the Item in the ItemStack
script.zs
// ForgeItemStack.rarity as Rarity
myForgeItemStack.rarity

Return Type: Rarity

Setter
Sets the rarity of the Item.
script.zs
// ForgeItemStack.rarity = (newRarity as Rarity);
myForgeItemStack.rarity = myRarity;

Parameters:

newRarity Type: Rarity - The new rarity of the Item.
rarity() as Rarity
Returns the rarity of the Item in the ItemStack

Returns: Rarity of the Item.

script.zs
// ForgeItemStack.rarity() as Rarity;
myForgeItemStack.rarity();

Return Type: Rarity

rarity(newRarity as Rarity)
Sets the rarity of the Item.
script.zs
// ForgeItemStack.rarity(newRarity as Rarity);
myForgeItemStack.rarity(Rarity.UNCOMMON);

Parameters:

newRarity Type: Rarity - The new rarity of the Item.
registryName
Getter
Gets the registry name for the Item in this IItemStack
script.zs
// ForgeItemStack.registryName as ResourceLocation
myForgeItemStack.registryName

Return Type: ResourceLocation

removeEnchantment
removeEnchantment(enchantment as Enchantment) as IItemStack
Removes the given enchantment from this IItemStack.

Returns: This itemStack if it is mutable, a new one with the enchantment removed otherwise

script.zs
// ForgeItemStack.removeEnchantment(enchantment as Enchantment) as IItemStack;
myForgeItemStack.removeEnchantment(<enchantment:minecraft:riptide>);

Parameters:

enchantment Type: Enchantment - The enchantment to remove.

Return Type: IItemStack

removeGlobalAttribute
removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])
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.
script.zs
// ForgeItemStack.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]);
myForgeItemStack.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<constant:minecraft:equipmentslot:chest>]);

Parameters:

attribute Type: Attribute - The attribute to remove.
slotTypes Type: EquipmentSlot[] - The slot types to remove it from.
removeGlobalAttributeModifier
removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[])
Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.
script.zs
// ForgeItemStack.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[]);
myForgeItemStack.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<constant:minecraft:equipmentslot:chest>]);

Parameters:

uuid Type: string - The unique id of the AttributeModifier to remove.
slotTypes Type: EquipmentSlot[] - The slot types to remove it from.
removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[])
Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.
script.zs
// ForgeItemStack.removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[]);
myForgeItemStack.removeGlobalAttributeModifier(IItemStack.BASE_ATTACK_DAMAGE_UUID, [<constant:minecraft:equipmentslot:chest>]);

Parameters:

uuid Type: UUID - The unique id of the AttributeModifier to remove.
slotTypes Type: EquipmentSlot[] - The slot types to remove it from.
removeTooltip
removeTooltip(regex as string)
script.zs
// ForgeItemStack.removeTooltip(regex as string);
myForgeItemStack.removeTooltip(myString);

Parameters:

regex Type: string
resetHoverName
resetHoverName()
Clears any custom name set for this ItemStack
script.zs
// ForgeItemStack.resetHoverName();
myForgeItemStack.resetHoverName();
reuse
reuse() as IIngredientTransformed<IIngredient>
script.zs
// ForgeItemStack.reuse() as IIngredientTransformed<IIngredient>;
myForgeItemStack.reuse();

Return Type: IIngredientTransformed<IIngredient>

setBurnTime
setBurnTime(time as int, manager as IRecipeManager<Recipe>)
Sets the burn time of this ingredient, for use in the furnace and other machines
script.zs
// ForgeItemStack.setBurnTime(time as int, manager as IRecipeManager<Recipe>);
myForgeItemStack.setBurnTime(500, myIRecipeManager);

Parameters:

time Type: int - the new burn time
manager Type: IRecipeManager<Recipe>
shrink
shrink(amount as int = 1) as IItemStack
Shrinks this IItemStack's stack size by the given amount, or 1 if no amount is given.

Returns: This IItemStack if mutable, a new one with the new amount otherwise.

script.zs
// ForgeItemStack.shrink(amount as int = 1) as IItemStack;
myForgeItemStack.shrink(2);

Parameters:

amount (optional) Type: int - The amount to shrink by.

Default Value: 1

Return Type: IItemStack

stackable
Getter
Returns if the ItemStack can have an amount greater than 1 I.E Swords and tools are not stackable, sticks are.
script.zs
// ForgeItemStack.stackable as bool
myForgeItemStack.stackable

Return Type: bool

tag
Getter
Returns the NBT tag attached to this ItemStack.
script.zs
// ForgeItemStack.tag as IData
myForgeItemStack.tag

Return Type: IData

transform
transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>
Use this if you already have the transformer from another ingredient
script.zs
// ForgeItemStack.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>;
myForgeItemStack.transform(myIIngredientTransformer);

Parameters:

transformer Type: IIngredientTransformer<IIngredient>

Return Type: IIngredientTransformed<IIngredient>

transformCustom
transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredientTransformed<IIngredient>
script.zs
// ForgeItemStack.transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredientTransformed<IIngredient>;
myForgeItemStack.transformCustom(myString, myFunction);

Parameters:

uid Type: string
function (optional) Type: function(r as IItemStack) as IItemStack

Default Value: null

Return Type: IIngredientTransformed<IIngredient>

transformDamage
transformDamage(amount as int = 1) as IIngredientTransformed<IIngredient>
script.zs
// ForgeItemStack.transformDamage(amount as int = 1) as IIngredientTransformed<IIngredient>;
myForgeItemStack.transformDamage(myInt);

Parameters:

amount (optional) Type: int

Default Value: 1

Return Type: IIngredientTransformed<IIngredient>

transformReplace
transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>
script.zs
// ForgeItemStack.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>;
myForgeItemStack.transformReplace(myIItemStack);

Parameters:

replaceWith Type: IItemStack

Return Type: IIngredientTransformed<IIngredient>

useDuration
Getter
Gets the use duration of the ItemStack
script.zs
// ForgeItemStack.useDuration as int
myForgeItemStack.useDuration

Return Type: int

useOnRelease
Getter
Returns true if this stack is considered a crossbow item
script.zs
// ForgeItemStack.useOnRelease as bool
myForgeItemStack.useOnRelease

Return Type: bool

withAttributeModifier
withAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack
Adds an AttributeModifier to this IItemStack 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.
Attributes added with this method will only appear on this specific IItemStack.
By defaults, adding a modifier will remove the default Attribute Modifiers on the Item, like the Diamond Chestplate's Armor and Toughness values. When preserveDefaults is set to true (by default it is false.), the default Attribute Modifiers will be preserved when adding this modifier. This means that if you were adding the forge:nametag_distance attribute to an Item, it would keep its default attributes (like Armor and Toughness values).
script.zs
// ForgeItemStack.withAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack;
myForgeItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
uuid Type: string - The unique identifier of the modifier to replace.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
preserveDefaults (optional) Type: bool - Should the default Item Attribute Modifiers be preserved when adding this modifier.

Default Value: false

Return Type: IItemStack

withAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack
Adds an AttributeModifier to this IItemStack 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.
Attributes added with this method will only appear on this specific IItemStack.
By defaults, adding a modifier will remove the default Attribute Modifiers on the Item, like the Diamond Chestplate's Armor and Toughness values. When preserveDefaults is set to true (by default it is false.), the default Attribute Modifiers will be preserved when adding this modifier. This means that if you were adding the forge:nametag_distance attribute to an Item, it would keep its default attributes (like Armor and Toughness values).
script.zs
// ForgeItemStack.withAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack;
myForgeItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
uuid Type: UUID - The unique identifier of the modifier to replace.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
preserveDefaults (optional) Type: bool - Should the default Item Attribute Modifiers be preserved when adding this modifier.

Default Value: false

Return Type: IItemStack

withAttributeModifier(attribute as Attribute, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack
Adds an AttributeModifier to this IItemStack.
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.
Attributes added with this method will only appear on this specific IItemStack.
By defaults, adding a modifier will remove the default Attribute Modifiers on the Item, like the Diamond Chestplate's Armor and Toughness values. When preserveDefaults is set to true (by default it is false.), the default Attribute Modifiers will be preserved when adding this modifier. This means that if you were adding the forge:nametag_distance attribute to an Item, it would keep its default attributes (like Armor and Toughness values).
script.zs
// ForgeItemStack.withAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as bool = false) as IItemStack;
myForgeItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);

Parameters:

attribute Type: Attribute - The Attribute of the modifier.
name Type: string - The name of the modifier.
value Type: double - The value of the modifier.
operation Type: AttributeOperation - The operation of the modifier.
slotTypes Type: EquipmentSlot[] - What slots the modifier is valid for.
preserveDefaults (optional) Type: bool - Should the default Item Attribute Modifiers be preserved when adding this modifier.

Default Value: false

Return Type: IItemStack

withDamage
withDamage(damage as int) as IItemStack
Sets the damage of the ItemStack
script.zs
// ForgeItemStack.withDamage(damage as int) as IItemStack;
myForgeItemStack.withDamage(10);

Parameters:

damage Type: int - the new damage value

Return Type: IItemStack

withDisplayName
withDisplayName(name as Component) as IItemStack
Sets the display name of the ItemStack
script.zs
// ForgeItemStack.withDisplayName(name as Component) as IItemStack;
myForgeItemStack.withDisplayName("totally not dirt");

Parameters:

name Type: Component - New name of the stack.

Return Type: IItemStack

withEnchantment
withEnchantment(enchantment as Enchantment, level as int = 1) as IItemStack
Enchants this IItemStack with the given Enchantment.

Returns: This itemStack if it is mutable, a new one with the enchantment added otherwise

script.zs
// ForgeItemStack.withEnchantment(enchantment as Enchantment, level as int = 1) as IItemStack;
myForgeItemStack.withEnchantment(<enchantment:minecraft:riptide>, 2);

Parameters:

enchantment Type: Enchantment - The enchantment to add.
level (optional) Type: int - The level of the enchantment

Default Value: 1

Return Type: IItemStack

withLore
withLore(lore as Component[]) as IItemStack
Sets the lore of the ItemStack
script.zs
// ForgeItemStack.withLore(lore as Component[]) as IItemStack;
myForgeItemStack.withLore(new crafttweaker.api.text.TextComponent("I am the lore I speak for the trees"););

Parameters:

lore Type: Component[] - the new Lore of the ItemStack.

Return Type: IItemStack

withoutTag
withoutTag() as IItemStack
Removes the tag from this ItemStack.

Returns: This itemStack if it is mutable, a new one with the changed property otherwise

script.zs
// ForgeItemStack.withoutTag() as IItemStack;
myForgeItemStack.withoutTag();

Return Type: IItemStack

withTag
withTag(tag as MapData) as IItemStack
Sets the tag for the ItemStack.

Returns: This itemStack if it is mutable, a new one with the changed property otherwise

script.zs
// ForgeItemStack.withTag(tag as MapData) as IItemStack;
myForgeItemStack.withTag({Display: {lore: ["Hello"]}});

Parameters:

tag Type: MapData - The tag to set.

Return Type: IItemStack

Previous
ForgeIItemStackExpansions MCItemStack
Next