Diese Klasse importieren

Link to diese-klasse-importieren

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.item.ForgeItemStack;

Implemented Interfaces

Link to implemented-interfaces

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

Static Properties

Link to static-properties

NameTypeHas GetterHas SetterBeschreibung
Name
CRAFTTWEAKER_DATA_KEY
Type
string
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Result typeIs Implicit
Result type
IData
Is Implicit
true
Result type
IIngredientWithAmount
Is Implicit
true
Result type
ItemDefinition
Is Implicit
true
Result type
Artikel-Stack
Is Implicit
true
Result type
MapData
Is Implicit
true
Result type
Percentaged<IItemStack>
Is Implicit
true

Link to g-

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

Return Type: void

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

myForgeItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>]);
ParameterTypeBeschreibung
Parameter
attribute
Type
Attribute
Beschreibung
The Attribute of the modifier.
Parameter
name
Type
string
Beschreibung
The name of the modifier.
Parameter
value
Type
double
Beschreibung
The value of the modifier.
Parameter
operation
Type
AttributeOperation
Beschreibung
The operation of the modifier.
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
What slots the modifier is valid for.

Link to g--1

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.

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

Return Type: void

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

myForgeItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>]);
ParameterTypeBeschreibung
Parameter
attribute
Type
Attribute
Beschreibung
The Attribute of the modifier.
Parameter
uuid
Type
string
Beschreibung
The unique identifier of the modifier to replace.
Parameter
name
Type
string
Beschreibung
The name of the modifier.
Parameter
value
Type
double
Beschreibung
The value of the modifier.
Parameter
operation
Type
AttributeOperation
Beschreibung
The operation of the modifier.
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
What slots the modifier is valid for.

Link to g--2

Name: addShiftTooltip

Return Type: void

ZenScript
Copy
ForgeItemStack.addShiftTooltip(content as Component, showMessage as Component) as void
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
inhalt
Type
Component
Beschreibung
No Description Provided
Optional
false
DefaultValue
Parameter
showMessage
Type
Component
Beschreibung
No Description Provided
Optional
true
DefaultValue

Link to g--3

Name: addTooltip

Return Type: void

ZenScript
Copy
ForgeItemStack.addTooltip(content as Component) as void
ParameterTypeBeschreibung
Parameter
inhalt
Type
Component
Beschreibung
No Description Provided

Link to g--4

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

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

myForgeItemStack.anyDamage();

Link to g--5

Name: asIIngredientWithAmount

Return Type: IIngredientWithAmount

ZenScript
Copy
// ForgeItemStack.asIIngredientWithAmount() as IIngredientWithAmount

myForgeItemStack.asIIngredientWithAmount();

Link to g--6

Name: asImmutable

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.asImmutable() as IItemStack

myForgeItemStack.asImmutable();

Link to g--7

Name: asMutable

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.asMutable() as IItemStack

myForgeItemStack.asMutable();

Link to g--8

Name: clearTooltip

Return Type: void

ZenScript
Copy
// ForgeItemStack.clearTooltip() as void

myForgeItemStack.clearTooltip();

Link to g--9

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

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

myForgeItemStack.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
ParameterTypeBeschreibung
Parameter
ingredient
Type
IIngredient
Beschreibung
The ingredient to check

Name: copy

Creates a copy

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.copy() as IItemStack

myForgeItemStack.copy();

Link to g--11

Name: getAttributes

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.
Return Type: stdlib.List<AttributeModifier>[Attribute]

ZenScript
Copy
// ForgeItemStack.getAttributes(slotType as EquipmentSlot) as stdlib.List<AttributeModifier>[Attribute]

myForgeItemStack.getAttributes(<equipmentslot:chest>);
ParameterTypeBeschreibung
Parameter
slotType
Type
EquipmentSlot
Beschreibung
The slot to get the Attributes for.

Link to g--12

Name: getDefinition

Return Type: ItemDefinition

ZenScript
Copy
// ForgeItemStack.getDefinition() as ItemDefinition

myForgeItemStack.getDefinition();

Link to g--13

Name: getEnchantmentLevel

Gets the level of the given enchantment on the item. Returns 0 if the item doesn't have the given enchantment.

Return Type: int

ZenScript
Copy
ForgeItemStack.getEnchantmentLevel(enchantment as Enchantment) as int
ParameterTypeBeschreibung
Parameter
enchantment
Type
Enchantment
Beschreibung
No Description Provided

Link to g--14

Name: getEnchantments

Return Type: int?[Enchantment]

ZenScript
Copy
// ForgeItemStack.getEnchantments() as int?[Enchantment]

myForgeItemStack.getEnchantments();

Link to g--15

Name: getImmutableInternal

Return Type: ItemStack

ZenScript
Copy
// ForgeItemStack.getImmutableInternal() as ItemStack

myForgeItemStack.getImmutableInternal();

Link to g--16

Name: getInternal

Gets the internal ItemStack for this IItemStack.

Returns: internal ItemStack
Return Type: ItemStack

ZenScript
Copy
// ForgeItemStack.getInternal() as ItemStack

myForgeItemStack.getInternal();

Link to g--17

Name: getMaxStackSize

Returns the max stack size of the Item in the ItemStack

Returns: Max stack size of the Item.
Return Type: int

ZenScript
Copy
// ForgeItemStack.getMaxStackSize() as int

myForgeItemStack.getMaxStackSize();

Link to g--18

Name: getRarity

Returns the rarity of the Item in the ItemStack

Returns: Rarity of the Item.
Return Type: Rarity

ZenScript
Copy
// ForgeItemStack.getRarity() as Rarity

myForgeItemStack.getRarity();

Link to g--19

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

myForgeItemStack.getRemainingItem(<item:minecraft:iron_ingot>);
ParameterTypeBeschreibung
Parameter
stack
Type
IItemStack
Beschreibung
The stack to provide for this ingredient.

Name: grow

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.
Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.grow(amount as int) as IItemStack

myForgeItemStack.grow(2);
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
amount
Type
int
Beschreibung
The amount to grow by.
Optional
true
DefaultValue
1

Name: isEdible

Return Type: boolean

ZenScript
Copy
// ForgeItemStack.isEdible() as boolean

myForgeItemStack.isEdible();

Link to g--22

Name: isFireResistant

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.
Return Type: boolean

ZenScript
Copy
// ForgeItemStack.isFireResistant() as boolean

myForgeItemStack.isFireResistant();

Link to g--23

Name: isImmutable

Return Type: boolean

ZenScript
Copy
// ForgeItemStack.isImmutable() as boolean

myForgeItemStack.isImmutable();

Link to g--24

Name: isMutable

Return Type: boolean

ZenScript
Copy
// ForgeItemStack.isMutable() as boolean

myForgeItemStack.isMutable();

Name: matches

Does the given stack match the ingredient?

Return Type: boolean

ZenScript
Copy
// ForgeItemStack.matches(stack as IItemStack) as boolean

myForgeItemStack.matches(<item:minecraft:iron_ingot>);
ParameterTypeBeschreibung
Parameter
stack
Type
IItemStack
Beschreibung
The stack to check

Link to g--26

Name: modifyShiftTooltip

Return Type: void

ZenScript
Copy
ForgeItemStack.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction) as void
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
shiftedFunction
Type
ITooltipFunction
Beschreibung
No Description Provided
Optional
false
DefaultValue
Parameter
unshiftedFunction
Type
ITooltipFunction
Beschreibung
No Description Provided
Optional
true
DefaultValue

Link to g--27

Name: modifyTooltip

Return Type: void

ZenScript
Copy
ForgeItemStack.modifyTooltip(function as ITooltipFunction) as void
ParameterTypeBeschreibung
Parameter
function
Type
ITooltipFunction
Beschreibung
No Description Provided

Name: mul

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

Return Type: IIngredientWithAmount

ZenScript
Copy
ForgeItemStack.mul(amount as int) as IIngredientWithAmount
ParameterTypeBeschreibung
Parameter
amount
Type
int
Beschreibung
No Description Provided

Name: only

Use this if you already have the condition from another ingredient

Return Type: IngredientConditioned<IIngredient>

ZenScript
Copy
ForgeItemStack.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>
ParameterTypeBeschreibung
Parameter
condition
Type
IIngredientCondition<IIngredient>
Beschreibung
No Description Provided

Link to g--30

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

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

myForgeItemStack.onlyDamaged();

Link to g--31

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

ZenScript
Copy
ForgeItemStack.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>
ParameterTypeBeschreibung
Parameter
minDamage
Type
int
Beschreibung
No Description Provided

Link to g--32

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

ZenScript
Copy
ForgeItemStack.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>
ParameterTypeBeschreibung
Parameter
maxDamage
Type
int
Beschreibung
No Description Provided

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

ZenScript
Copy
ForgeItemStack.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<IIngredient>
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
uid
Type
string
Beschreibung
No Description Provided
Optional
false
DefaultValue
Parameter
function
Type
Predicate<IItemStack>
Beschreibung
No Description Provided
Optional
true
DefaultValue

Name: percent

Return Type: Percentaged<IItemStack>

ZenScript
Copy
ForgeItemStack.percent(percentage as double) as Percentaged<IItemStack>
ParameterTypeBeschreibung
Parameter
percentage
Type
double
Beschreibung
No Description Provided

Link to g--35

Name: removeEnchantment

Removes the given enchantment from this IItemStack.

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

ZenScript
Copy
// ForgeItemStack.removeEnchantment(enchantment as Enchantment) as IItemStack

myForgeItemStack.removeEnchantment(<enchantment:minecraft:riptide>);
ParameterTypeBeschreibung
Parameter
enchantment
Type
Enchantment
Beschreibung
The enchantment to remove.

Link to g--36

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.

Return Type: void

ZenScript
Copy
// ForgeItemStack.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]) as void

myForgeItemStack.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<equipmentslot:chest>]);
ParameterTypeBeschreibung
Parameter
attribute
Type
Attribute
Beschreibung
The attribute to remove.
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
The slot types to remove it from.

Link to g--37

Name: removeGlobalAttributeModifier

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

Return Type: void

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

myForgeItemStack.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<equipmentslot:chest>]);
ParameterTypeBeschreibung
Parameter
uuid
Type
string
Beschreibung
The unique id of the AttributeModifier to remove.
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
The slot types to remove it from.

Link to g--38

Name: removeTooltip

Return Type: void

ZenScript
Copy
ForgeItemStack.removeTooltip(regex as string) as void
ParameterTypeBeschreibung
Parameter
regex
Type
string
Beschreibung
No Description Provided

Link to g--39

Name: resetHoverName

Clears any custom name set for this ItemStack

Return Type: void

ZenScript
Copy
// ForgeItemStack.resetHoverName() as void

myForgeItemStack.resetHoverName();

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

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

myForgeItemStack.reuse();

Link to g--41

Name: setEnchantments

Sets the enchantments on this IItemStack.

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

ZenScript
Copy
ForgeItemStack.setEnchantments(enchantments as int?[Enchantment]) as IItemStack
ParameterTypeBeschreibung
Parameter
enchantments
Type
int?[Enchantment]
Beschreibung
The new enchantments

Link to g--42

Name: setFireResistant

Sets if this IItemStack is immune to fire / lava.

If true, the item will not burn when thrown into fire or lava.

Return Type: void

ZenScript
Copy
ForgeItemStack.setFireResistant(fireResistant as boolean) as void
ParameterTypeBeschreibung
Parameter
fireResistant
Type
boolean
Beschreibung
Should the item be immune to fire.

Link to g--43

Name: setMaxStackSize

Sets the max stacksize of the Item.

Return Type: void

ZenScript
Copy
// ForgeItemStack.setMaxStackSize(newMaxStackSize as int) as void

myForgeItemStack.setMaxStackSize(16);
ParameterTypeBeschreibung
Parameter
newMaxStackSize
Type
int
Beschreibung
The new max stack size of the Item.

Link to g--44

Name: setRarity

Sets the rarity of the Item.

Return Type: void

ZenScript
Copy
// ForgeItemStack.setRarity(newRarity as Rarity) as void

myForgeItemStack.setRarity(Rarity.UNCOMMON);
ParameterTypeBeschreibung
Parameter
newRarity
Type
Rarity
Beschreibung
The new rarity of the Item.

Name: shrink

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.
Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.shrink(amount as int) as IItemStack

myForgeItemStack.shrink(2);
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
amount
Type
int
Beschreibung
The amount to shrink by.
Optional
true
DefaultValue
1

Link to g--46

Name: transform

Use this if you already have the transformer from another ingredient

Return Type: IIngredientTransformed<IIngredient>

ZenScript
Copy
ForgeItemStack.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>
ParameterTypeBeschreibung
Parameter
transformator
Type
IIngredientTransformer<IIngredient>
Beschreibung
No Description Provided

Link to g--47

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

ZenScript
Copy
ForgeItemStack.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
uid
Type
string
Beschreibung
No Description Provided
Optional
false
DefaultValue
Parameter
function
Type
Function<IItemStack,IItemStack>
Beschreibung
No Description Provided
Optional
true
DefaultValue

Link to g--48

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

ZenScript
Copy
ForgeItemStack.transformDamage(amount as int) as IIngredientTransformed<IIngredient>
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
amount
Type
int
Beschreibung
No Description Provided
Optional
true
DefaultValue
1

Link to g--49

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

ZenScript
Copy
ForgeItemStack.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>
ParameterTypeBeschreibung
Parameter
replaceWith
Type
IItemStack
Beschreibung
No Description Provided

Link to g--50

Name: withAttributeModifier

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).

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.withAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as boolean) as IItemStack

myForgeItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>], true);
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
attribute
Type
Attribute
Beschreibung
The Attribute of the modifier.
Optional
false
DefaultValue
Parameter
name
Type
string
Beschreibung
The name of the modifier.
Optional
false
DefaultValue
Parameter
value
Type
double
Beschreibung
The value of the modifier.
Optional
false
DefaultValue
Parameter
operation
Type
AttributeOperation
Beschreibung
The operation of the modifier.
Optional
false
DefaultValue
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
What slots the modifier is valid for.
Optional
false
DefaultValue
Parameter
preserveDefaults
Type
boolean
Beschreibung
Should the default Item Attribute Modifiers be preserved when adding this modifier.
Optional
true
DefaultValue
false

Link to g--51

Name: withAttributeModifier

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).

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.withAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as boolean) as IItemStack

myForgeItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot:chest>], true);
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
attribute
Type
Attribute
Beschreibung
The Attribute of the modifier.
Optional
false
DefaultValue
Parameter
uuid
Type
string
Beschreibung
The unique identifier of the modifier to replace.
Optional
false
DefaultValue
Parameter
name
Type
string
Beschreibung
The name of the modifier.
Optional
false
DefaultValue
Parameter
value
Type
double
Beschreibung
The value of the modifier.
Optional
false
DefaultValue
Parameter
operation
Type
AttributeOperation
Beschreibung
The operation of the modifier.
Optional
false
DefaultValue
Parameter
slotTypes
Type
EquipmentSlot[]
Beschreibung
What slots the modifier is valid for.
Optional
false
DefaultValue
Parameter
preserveDefaults
Type
boolean
Beschreibung
Should the default Item Attribute Modifiers be preserved when adding this modifier.
Optional
true
DefaultValue
false

Link to g--52

Name: withDamage

Sets the damage of the ItemStack

Return Type: IItemStack

ZenScript
Copy
// ForgeItemStack.withDamage(damage as int) as IItemStack

myForgeItemStack.withDamage(10);
ParameterTypeBeschreibung
Parameter
damage
Type
int
Beschreibung
the new damage value

Link to g--53

Name: withDisplayName

Sets the display name of the ItemStack

Return Type: IItemStack

ZenScript
Copy
ForgeItemStack.withDisplayName(text as Component) as IItemStack
ParameterTypeBeschreibung
Parameter
text
Type
Component
Beschreibung
New name of the stack.

Link to g--54

Name: withEnchantment

Enchants this IItemStack with the given Enchantment.

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

ZenScript
Copy
// ForgeItemStack.withEnchantment(enchantment as Enchantment, level as int) as IItemStack

myForgeItemStack.withEnchantment(<enchantment:minecraft:riptide>, 2);
ParameterTypeBeschreibungOptionalDefaultValue
Parameter
enchantment
Type
Enchantment
Beschreibung
The enchantment to add.
Optional
false
DefaultValue
Parameter
level
Type
int
Beschreibung
The level of the enchantment
Optional
true
DefaultValue
1

Name: withTag

Sets the tag for the ItemStack.

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

ZenScript
Copy
// ForgeItemStack.withTag(tag as MapData) as IItemStack

myForgeItemStack.withTag({Display: {lore: ["Hello"]}});
ParameterTypeBeschreibung
Parameter
tag
Type
MapData
Beschreibung
The tag to set.

Link to g--56

Name: withoutTag

Removes the tag from this ItemStack.

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

ZenScript
Copy
// ForgeItemStack.withoutTag() as IItemStack

myForgeItemStack.withoutTag();

Name: CONTAINS

Does the ingredient contain the given ingredient?

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

Name: MOD

ZenScript
Copy
myForgeItemStack % percentage as double

Name: MUL

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

ZenScript
Copy
myForgeItemStack * amount as int

Name: OR

ZenScript
Copy
myForgeItemStack | other as IIngredient
NameTypeHas GetterHas SetterBeschreibung
Name
amount
Type
int
Has Getter
true
Has Setter
false
Beschreibung
Gets the amount of Items in the ItemStack
Name
burnTime
Type
void
Has Getter
false
Has Setter
true
Beschreibung
Sets the burn time of this ingredient, for use in the furnace and other machines
Name
commandString
Type
string
Has Getter
true
Has Setter
false
Beschreibung
Returns the BEP to get this stack
Name
damage
Type
int
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Name
damageableItem
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns if the ItemStack is damageable
I.E Swords and tools are damageable, sticks are not.
Name
damaged
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns if the ItemStack is damaged
I.E a Swords that is no at full durability is damaged.
Name
definition
Type
ItemDefinition
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Name
descriptionId
Type
string
Has Getter
true
Has Setter
false
Beschreibung
Returns the unlocalized Name of the Item in the ItemStack
Name
displayName
Type
Component
Has Getter
true
Has Setter
false
Beschreibung
Gets the display name of the ItemStack
Name
empty
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns if the ItemStack is empty
Name
enchantments
Type
int?[Enchantment]
Has Getter
true
Has Setter
true
Beschreibung
No Description Provided
Name
fireResistant
Type
void
Has Getter
true
Has Setter
true
Beschreibung
Sets if this IItemStack is immune to fire / lava.

If true, the item will not burn when thrown into fire or lava.
Name
food
Type
FoodProperties
Has Getter
true
Has Setter
true
Beschreibung
No Description Provided
Name
getBaseRepairCost
Type
int
Has Getter
true
Has Setter
false
Beschreibung
Gets the base repair cost of the ItemStack, or 0 if no repair is defined.
Name
getOrCreate
Type
MapData
Has Getter
true
Has Setter
false
Beschreibung
Returns the NBT tag attached to this ItemStack or makes a new tag.
Name
hasCustomHoverName
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns true if the ItemStack has a display name.
Name
hasFoil
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns true if this ItemStack has a foil effect.

Foil is the glint / effect that is added to enchanted ItemStacks (and other items).
Name
hasTag
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns true if this ItemStack has a Tag
Name
isEnchantable
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Can this ItemStack be enchanted?
Name
isEnchanted
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Is this ItemStack enchanted?
Name
isImmutable
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Name
isMutable
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Name
items
Type
IItemStack[]
Has Getter
true
Has Setter
false
Beschreibung
No Description Provided
Name
maxDamage
Type
int
Has Getter
true
Has Setter
true
Beschreibung
Returns the max damage of the ItemStack
This is the max durability of the ItemStack.
Name
maxStackSize
Type
int
Has Getter
true
Has Setter
true
Beschreibung
Returns the max stack size of the Item in the ItemStack
Name
owner
Type
string
Has Getter
true
Has Setter
false
Beschreibung
Gets owning mod for the Item in this IItemStack
Name
rarity
Type
Rarity
Has Getter
true
Has Setter
true
Beschreibung
Returns the rarity of the Item in the ItemStack
Name
registryName
Type
ResourceLocation
Has Getter
true
Has Setter
false
Beschreibung
Gets the registry name for the Item in this IItemStack
Name
stackable
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns if the ItemStack can have an amount greater than 1
I.E Swords and tools are not stackable, sticks are.
Name
tag
Type
MapData
Has Getter
true
Has Setter
false
Beschreibung
Returns the NBT tag attached to this ItemStack.
Name
useDuration
Type
int
Has Getter
true
Has Setter
false
Beschreibung
Gets the use duration of the ItemStack
Name
useOnRelease
Type
boolean
Has Getter
true
Has Setter
false
Beschreibung
Returns true if this stack is considered a crossbow item