Previous
ForgeItemStack
MCItemStackMutable
Next

MCItemStack

Link to mcitemstack

导入类

Link to 导入类

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

已实现的接口

Link to 已实现的接口

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

Static Properties

Link to static-properties

名称类型可获得可设置
名称
BASE_ATTACK_DAMAGE_UUID
类型
invalid
可获得
true
可设置
false
名称
BASE_ATTACK_SPEED_UUID
类型
invalid
可获得
true
可设置
false
名称
CRAFTTWEAKER_DATA_KEY
类型
string
可获得
true
可设置
false

Casters

Link to casters

Result Type是否隐藏
Result Type
IIngredientWithAmount
是否隐藏
true
Result Type
ItemDefinition
是否隐藏
true
Result Type
ItemLike
是否隐藏
true
Result Type
MapData #地图数据
是否隐藏
true
Result Type
Percentaged<IItemStack>
是否隐藏
true

使用方式

Link to 使用方式

Link to 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
// MCItemStack.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

myMCItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
参数
name（名称）
类型
string
描述
The name of the modifier.
参数
value
类型
double
描述
The value of the modifier.
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.

Link to 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.

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
// MCItemStack.addGlobalAttributeModifier(attribute as Attribute, uuid as invalid, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

myMCItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, IItemStack.BASE_ATTACK_DAMAGE_UUID, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
参数
uuid
类型
invalid
描述
The unique identifier of the modifier to replace.
参数
name（名称）
类型
string
描述
The name of the modifier.
参数
value
类型
double
描述
The value of the modifier.
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.

Link to 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.

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
// MCItemStack.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

myMCItemStack.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
参数
uuid
类型
string
描述
The unique identifier of the modifier to replace.
参数
name（名称）
类型
string
描述
The name of the modifier.
参数
value
类型
double
描述
The value of the modifier.
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.

Link to addShiftTooltip

Name: addShiftTooltip

ZenScript
 Copy
MCItemStack.addShiftTooltip(content as Component, showMessage as Component)
参数类型可选
参数
内容
类型
Component
可选
false
参数
showMessage
类型
Component
可选
true

Link to addTooltip

Name: addTooltip

ZenScript
 Copy
MCItemStack.addTooltip(content as Component)
参数类型
参数
内容
类型
Component

Link to anyDamage

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

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

myMCItemStack.anyDamage();

Link to asIIngredientWithAmount

Name: asIIngredientWithAmount

Return Type: IIngredientWithAmount

ZenScript
 Copy
// MCItemStack.asIIngredientWithAmount() as IIngredientWithAmount

myMCItemStack.asIIngredientWithAmount();

Link to asItemLike

Name: asItemLike

Return Type: ItemLike

ZenScript
 Copy
// MCItemStack.asItemLike() as ItemLike

myMCItemStack.asItemLike();

Link to clearTooltip

Name: clearTooltip

ZenScript
 Copy
MCItemStack.clearTooltip(leaveName as boolean)
参数类型可选默认值
参数
leaveName
类型
布尔值
可选
true
默认值
false

Link to contains

Name: contains

Does the ingredient contain the given ingredient?

Return Type: boolean

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

myMCItemStack.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
参数类型描述
参数
ingredient
类型
材料（IIngredient）
描述
The ingredient to check

Link to getAttributes

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
// MCItemStack.getAttributes(slotType as EquipmentSlot) as stdlib.List<AttributeModifier>[Attribute]

myMCItemStack.getAttributes(<constant:minecraft:equipmentslot:chest>);
参数类型描述
参数
slotType
类型
EquipmentSlot
描述
The slot to get the Attributes for.

Link to getBurnTime

Name: getBurnTime

Return Type: int

ZenScript
 Copy
MCItemStack.getBurnTime(manager as IRecipeManager) as int
参数类型
参数
manager
类型
IRecipeManager

Link to getDefinition

Name: getDefinition

Return Type: ItemDefinition

ZenScript
 Copy
// MCItemStack.getDefinition() as ItemDefinition

myMCItemStack.getDefinition();

Link to getEnchantmentLevel

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
MCItemStack.getEnchantmentLevel(enchantment as Enchantment) as int
参数类型
参数
enchantment
类型
Enchantment

Link to getEnchantments

Name: getEnchantments

Return Type: int?[Enchantment]

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

myMCItemStack.getEnchantments();

Link to getFood

Name: getFood

Return Type: FoodProperties?

ZenScript
 Copy
// MCItemStack.getFood() as FoodProperties?

myMCItemStack.getFood();

Link to getHoverName

Name: getHoverName

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

ZenScript
 Copy
// MCItemStack.getHoverName() as Component

myMCItemStack.getHoverName();

Link to getImmutableInternal

Name: getImmutableInternal

Return Type: ItemStack

ZenScript
 Copy
// MCItemStack.getImmutableInternal() as ItemStack

myMCItemStack.getImmutableInternal();

Link to getMaxStackSize

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
// MCItemStack.getMaxStackSize() as int

myMCItemStack.getMaxStackSize();

Link to getOrCreateTag

Name: getOrCreateTag

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

ZenScript
 Copy
// MCItemStack.getOrCreateTag() as MapData

myMCItemStack.getOrCreateTag();

Link to getRarity

Name: getRarity

Returns the rarity of the Item in the ItemStack

Returns: Rarity of the Item.
Return Type: Rarity

ZenScript
 Copy
// MCItemStack.getRarity() as Rarity

myMCItemStack.getRarity();

Link to grow

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
// MCItemStack.grow(amount as int) as IItemStack

myMCItemStack.grow(2);
参数类型描述可选默认值
参数
amount
类型
int
描述
The amount to grow by.
可选
true
默认值
1

Link to isEdible

Name: isEdible

Return Type: boolean

ZenScript
 Copy
// MCItemStack.isEdible() as boolean

myMCItemStack.isEdible();

Link to isFireResistant

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
// MCItemStack.isFireResistant() as boolean

myMCItemStack.isFireResistant();

Link to isMutable

Name: isMutable

Return Type: boolean

ZenScript
 Copy
// MCItemStack.isMutable() as boolean

myMCItemStack.isMutable();

Link to matches

Name: matches

Does the given stack match the ingredient?

Return Type: boolean

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

myMCItemStack.matches(<item:minecraft:iron_ingot>);
参数类型描述
参数
堆叠
类型
IItemstack
描述
The stack to check

Link to modifyShiftTooltip

Name: modifyShiftTooltip

ZenScript
 Copy
MCItemStack.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction)
参数类型可选
参数
shiftedFunction
类型
ITooltipFunction
可选
false
参数
unshiftedFunction
类型
ITooltipFunction
可选
true

Link to modifyTooltip

Name: modifyTooltip

ZenScript
 Copy
MCItemStack.modifyTooltip(function as ITooltipFunction)
参数类型
参数
function
类型
ITooltipFunction

Link to mul

Name: mul

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

Return Type: IIngredientWithAmount

ZenScript
 Copy
MCItemStack.mul(amount as int) as IIngredientWithAmount
参数类型
参数
amount
类型
int

Link to only

Name: only

Use this if you already have the condition from another ingredient

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
MCItemStack.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>
参数类型
参数
condition
类型
IIngredientCondition<IIngredient>

Link to onlyDamaged

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

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

myMCItemStack.onlyDamaged();

Link to onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
MCItemStack.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>
参数类型
参数
minDamage
类型
int

Link to onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
MCItemStack.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>
参数类型
参数
maxDamage
类型
int

Link to onlyIf

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
MCItemStack.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<IIngredient>
参数类型可选
参数
uid
类型
string
可选
false
参数
function
类型
Predicate<IItemStack>
可选
true

Link to percent

Name: percent

Return Type: Percentaged<IItemStack>

ZenScript
 Copy
MCItemStack.percent(percentage as double) as Percentaged<IItemStack>
参数类型
参数
percentage
类型
double

Link to removeEnchantment

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
// MCItemStack.removeEnchantment(enchantment as Enchantment) as IItemStack

myMCItemStack.removeEnchantment(<enchantment:minecraft:riptide>);
参数类型描述
参数
enchantment
类型
Enchantment
描述
The enchantment to remove.

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

myMCItemStack.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
attribute
类型
Attribute
描述
The attribute to remove.
参数
slotTypes
类型
EquipmentSlot[]
描述
The slot types to remove it from.

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

ZenScript
 Copy
// MCItemStack.removeGlobalAttributeModifier(uuid as invalid, slotTypes as EquipmentSlot[])

myMCItemStack.removeGlobalAttributeModifier(IItemStack.BASE_ATTACK_DAMAGE_UUID, [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
uuid
类型
invalid
描述
The unique id of the AttributeModifier to remove.
参数
slotTypes
类型
EquipmentSlot[]
描述
The slot types to remove it from.

Link to removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

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

myMCItemStack.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<constant:minecraft:equipmentslot:chest>]);
参数类型描述
参数
uuid
类型
string
描述
The unique id of the AttributeModifier to remove.
参数
slotTypes
类型
EquipmentSlot[]
描述
The slot types to remove it from.

Link to removeTooltip

Name: removeTooltip

ZenScript
 Copy
MCItemStack.removeTooltip(regex as string)
参数类型
参数
regex
类型
string

Link to resetHoverName

Name: resetHoverName

Clears any custom name set for this ItemStack

ZenScript
 Copy
// MCItemStack.resetHoverName()

myMCItemStack.resetHoverName();

Link to reuse

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

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

myMCItemStack.reuse();

Link to setBurnTime

Name: setBurnTime

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

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

myMCItemStack.setBurnTime(500);
参数类型描述
参数
time
类型
int
描述
the new burn time

Link to setBurnTime

Name: setBurnTime

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

ZenScript
 Copy
MCItemStack.setBurnTime(time as int, manager as IRecipeManager)
参数类型描述
参数
time
类型
int
描述
the new burn time
参数
manager
类型
IRecipeManager
描述
​

Link to setEnchantments

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
MCItemStack.setEnchantments(enchantments as int?[Enchantment]) as IItemStack
参数类型描述
参数
enchantments
类型
int?[Enchantment]
描述
The new enchantments

Link to setFireResistant

Name: setFireResistant

Sets if this IItemStack is immune to fire / lava.

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

ZenScript
 Copy
MCItemStack.setFireResistant(fireResistant as boolean)
参数类型描述
参数
fireResistant
类型
布尔值
描述
Should the item be immune to fire.

Link to setFood

Name: setFood

ZenScript
 Copy
MCItemStack.setFood(food as FoodProperties?)
参数类型
参数
food
类型
FoodProperties?

Link to setMaxStackSize

Name: setMaxStackSize

Sets the max stacksize of the Item.

ZenScript
 Copy
// MCItemStack.setMaxStackSize(newMaxStackSize as int)

myMCItemStack.setMaxStackSize(16);
参数类型描述
参数
newMaxStackSize
类型
int
描述
The new max stack size of the Item.

Link to setRarity

Name: setRarity

Sets the rarity of the Item.

ZenScript
 Copy
// MCItemStack.setRarity(newRarity as Rarity)

myMCItemStack.setRarity(Rarity.UNCOMMON);
参数类型描述
参数
newRarity
类型
Rarity
描述
The new rarity of the Item.

Link to shrink

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
// MCItemStack.shrink(amount as int) as IItemStack

myMCItemStack.shrink(2);
参数类型描述可选默认值
参数
amount
类型
int
描述
The amount to shrink by.
可选
true
默认值
1

Link to transform

Name: transform

Use this if you already have the transformer from another ingredient

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
MCItemStack.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>
参数类型
参数
变压器
类型
IIngredientTransformer<IIngredient>

Link to transformCustom

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
MCItemStack.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>
参数类型可选
参数
uid
类型
string
可选
false
参数
function
类型
Function<IItemStack,IItemStack>
可选
true

Link to transformDamage

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
MCItemStack.transformDamage(amount as int) as IIngredientTransformed<IIngredient>
参数类型可选默认值
参数
amount
类型
int
可选
true
默认值
1

Link to transformReplace

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
MCItemStack.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>
参数类型
参数
replaceWith
类型
IItemstack

Link to withAttributeModifier

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
// MCItemStack.withAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as boolean) as IItemStack

myMCItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);
参数类型描述可选默认值
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
可选
false
默认值
​
参数
name（名称）
类型
string
描述
The name of the modifier.
可选
false
默认值
​
参数
value
类型
double
描述
The value of the modifier.
可选
false
默认值
​
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
可选
false
默认值
​
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.
可选
false
默认值
​
参数
preserveDefaults
类型
布尔值
描述
Should the default Item Attribute Modifiers be preserved when adding this modifier.
可选
true
默认值
false

Link to withAttributeModifier

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
// MCItemStack.withAttributeModifier(attribute as Attribute, uuid as invalid, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as boolean) as IItemStack

myMCItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);
参数类型描述可选默认值
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
可选
false
默认值
​
参数
uuid
类型
invalid
描述
The unique identifier of the modifier to replace.
可选
false
默认值
​
参数
name（名称）
类型
string
描述
The name of the modifier.
可选
false
默认值
​
参数
value
类型
double
描述
The value of the modifier.
可选
false
默认值
​
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
可选
false
默认值
​
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.
可选
false
默认值
​
参数
preserveDefaults
类型
布尔值
描述
Should the default Item Attribute Modifiers be preserved when adding this modifier.
可选
true
默认值
false

Link to withAttributeModifier

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
// MCItemStack.withAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[], preserveDefaults as boolean) as IItemStack

myMCItemStack.withAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>], true);
参数类型描述可选默认值
参数
attribute
类型
Attribute
描述
The Attribute of the modifier.
可选
false
默认值
​
参数
uuid
类型
string
描述
The unique identifier of the modifier to replace.
可选
false
默认值
​
参数
name（名称）
类型
string
描述
The name of the modifier.
可选
false
默认值
​
参数
value
类型
double
描述
The value of the modifier.
可选
false
默认值
​
参数
operation
类型
AttributeOperation
描述
The operation of the modifier.
可选
false
默认值
​
参数
slotTypes
类型
EquipmentSlot[]
描述
What slots the modifier is valid for.
可选
false
默认值
​
参数
preserveDefaults
类型
布尔值
描述
Should the default Item Attribute Modifiers be preserved when adding this modifier.
可选
true
默认值
false

Link to withDamage

Name: withDamage

Sets the damage of the ItemStack

Return Type: IItemStack

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

myMCItemStack.withDamage(10);
参数类型描述
参数
damage
类型
int
描述
the new damage value

Link to withDisplayName

Name: withDisplayName

Sets the display name of the ItemStack

Return Type: IItemStack

ZenScript
 Copy
// MCItemStack.withDisplayName(name as Component) as IItemStack

myMCItemStack.withDisplayName("totally not dirt");
参数类型描述
参数
name（名称）
类型
Component
描述
New name of the stack.

Link to withEnchantment

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
// MCItemStack.withEnchantment(enchantment as Enchantment, level as int) as IItemStack

myMCItemStack.withEnchantment(<enchantment:minecraft:riptide>, 2);
参数类型描述可选默认值
参数
enchantment
类型
Enchantment
描述
The enchantment to add.
可选
false
默认值
​
参数
level
类型
int
描述
The level of the enchantment
可选
true
默认值
1

Link to withLore

Name: withLore

Sets the lore of the ItemStack

Return Type: IItemStack

ZenScript
 Copy
// MCItemStack.withLore(lore as Component?[]) as IItemStack

myMCItemStack.withLore(new crafttweaker.api.text.TextComponent("I am the lore I speak for the trees"););
参数类型描述
参数
lore
类型
Component?[]
描述
the new Lore of the ItemStack.

Link to withTag

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
// MCItemStack.withTag(tag as MapData) as IItemStack

myMCItemStack.withTag({Display: {lore: ["Hello"]}});
参数类型描述
参数
tag #标签
类型
MapData #地图数据
描述
The tag to set.

Link to withoutTag

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
// MCItemStack.withoutTag() as IItemStack

myMCItemStack.withoutTag();

运算符

Link to 运算符

Link to CONTAINS

Name: CONTAINS

Does the ingredient contain the given ingredient?

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

Link to EQUALS

Name: EQUALS

ZenScript
 Copy
myMCItemStack == o as Object

Link to MOD

Name: MOD

ZenScript
 Copy
myMCItemStack % percentage as double

Link to MUL

Name: MUL

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

ZenScript
 Copy
myMCItemStack * amount as int

Link to OR

Name: OR

ZenScript
 Copy
myMCItemStack | other as IIngredient

参数

Link to 参数

名称类型可获得可设置描述
名称
amount
类型
int
可获得
true
可设置
false
描述
Gets the amount of Items in the ItemStack
名称
baseRepairCost
类型
int
可获得
true
可设置
false
描述
Gets the base repair cost of the ItemStack, or 0 if no repair is defined.
名称
burnTime
类型
void
可获得
false
可设置
true
描述
Sets the burn time of this ingredient, for use in the furnace and other machines
名称
damage
类型
int
可获得
true
可设置
false
描述
​
名称
damageableItem
类型
布尔值
可获得
true
可设置
false
描述
Returns if the ItemStack is damageable
I.E Swords and tools are damageable, sticks are not.
名称
damaged
类型
布尔值
可获得
true
可设置
false
描述
Returns if the ItemStack is damaged
I.E a Swords that is no at full durability is damaged.
名称
definition
类型
ItemDefinition
可获得
true
可设置
false
描述
​
名称
descriptionId
类型
string
可获得
true
可设置
false
描述
Returns the unlocalized Name of the Item in the ItemStack
名称
displayName
类型
Component
可获得
true
可设置
false
描述
Gets the display name of the ItemStack
名称
enchantments
类型
int?[Enchantment]
可获得
true
可设置
true
描述
​
名称
fireResistant
类型
布尔值
可获得
true
可设置
true
描述
Checks if this IItemStack burns when thrown into fire / lava or damaged by fire.
名称
food
类型
FoodProperties?
可获得
true
可设置
true
描述
​
名称
hasCustomHoverName
类型
布尔值
可获得
true
可设置
false
描述
Returns true if the ItemStack has a display name.
名称
hasFoil
类型
布尔值
可获得
true
可设置
false
描述
Returns true if this ItemStack has a foil effect.

Foil is the glint / effect that is added to enchanted ItemStacks (and other items).
名称
hasTag
类型
布尔值
可获得
true
可设置
false
描述
Returns true if this ItemStack has a Tag
名称
hoverName
类型
Component
可获得
true
可设置
false
描述
Gets the hover name of the ItemStack.

This will give the raw name without the formatting that 'displayName' applies.
名称
isEdible
类型
布尔值
可获得
true
可设置
false
描述
​
名称
isEnchantable
类型
布尔值
可获得
true
可设置
false
描述
Can this ItemStack be enchanted?
名称
isEnchanted
类型
布尔值
可获得
true
可设置
false
描述
Is this ItemStack enchanted?
名称
isMutable
类型
布尔值
可获得
true
可设置
false
描述
​
名称
maxDamage
类型
int
可获得
true
可设置
true
描述
Returns the max damage of the ItemStack
This is the max durability of the ItemStack.
名称
maxStackSize
类型
int
可获得
true
可设置
true
描述
Returns the max stack size of the Item in the ItemStack
名称
owner
类型
string
可获得
true
可设置
false
描述
Gets owning mod for the Item in this IItemStack
名称
rarity
类型
Rarity
可获得
true
可设置
true
描述
Returns the rarity of the Item in the ItemStack
名称
registryName
类型
资源位置
可获得
true
可设置
false
描述
Gets the registry name for the Item in this IItemStack
名称
stackable
类型
布尔值
可获得
true
可设置
false
描述
Returns if the ItemStack can have an amount greater than 1
I.E Swords and tools are not stackable, sticks are.
名称
tag #标签
类型
MapData?
可获得
true
可设置
false
描述
Returns the NBT tag attached to this ItemStack.
名称
useDuration
类型
int
可获得
true
可设置
false
描述
Gets the use duration of the ItemStack
名称
useOnRelease
类型
布尔值
可获得
true
可设置
false
描述
Returns true if this stack is considered a crossbow item
Previous
ForgeItemStack
MCItemStackMutable
Next