MCItemStackMutable
Link to mcitemstackmutable
An MCItemStackMutable object is the same as any other IItemStack. The only difference is that changes made to it will not create a new ItemStack, but instead modify the stack given.
This is useful for example when you are dealing with Event Handlers and need to shrink the stack the player is using without assigning a new stack.
Importare la Classe
Link to importare-la-classe
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 Copyimport crafttweaker.api.item.MCItemStackMutable;
Interfacce Implementate
Link to interfacce-implementate
MCItemStackMutable implements the following interfaces. That means all methods defined in these interfaces are also available in MCItemStackMutable
Static Properties
Link to static-properties
| Nome | Tipo | Ha Getter | Ha Setter | Descrizione |
|---|---|---|---|---|
Nome CRAFTTWEAKER_DATA_KEY | Tipo string | Ha Getter sì | Ha Setter no | Descrizione No Description Provided |
Caster
Link to caster
| Tipo Risultato | Implicito |
|---|---|
Tipo Risultato IData | Implicito sì |
Tipo Risultato IIngredientWithAmount | Implicito sì |
Tipo Risultato MapData | Implicito sì |
Tipo Risultato MCItemDefinition | Implicito sì |
Tipo Risultato MCWeightedItemStack | Implicito sì |
Metodi
Link to metodi
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// MCItemStackMutable.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as MCEquipmentSlotType[]) as void
<item:minecraft:dirt>.mutable().addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslottype:chest>]);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro attribute | Tipo Attribute | Descrizione The Attribute of the modifier. |
Parametro nome | Tipo string | Descrizione The name of the modifier. |
Parametro valore | Tipo double | Descrizione The value of the modifier. |
Parametro operation | Tipo AttributeOperation | Descrizione The operation of the modifier. |
Parametro slotTypes | Tipo MCEquipmentSlotType[] | Descrizione What slots the modifier is valid for. |
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// MCItemStackMutable.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as MCEquipmentSlotType[]) as void
<item:minecraft:dirt>.mutable().addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslottype:chest>]);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro attribute | Tipo Attribute | Descrizione The Attribute of the modifier. |
Parametro uuid | Tipo string | Descrizione The unique identifier of the modifier to replace. |
Parametro nome | Tipo string | Descrizione The name of the modifier. |
Parametro valore | Tipo double | Descrizione The value of the modifier. |
Parametro operation | Tipo AttributeOperation | Descrizione The operation of the modifier. |
Parametro slotTypes | Tipo MCEquipmentSlotType[] | Descrizione What slots the modifier is valid for. |
Name: addShiftTooltip
Return Type: void
ZenScript CopyMCItemStackMutable.addShiftTooltip(content as MCTextComponent, showMessage as MCTextComponent) as void
| Parametro | Tipo | Descrizione | Optional | DefaultValue |
|---|---|---|---|---|
Parametro contenuto | Tipo MCTextComponent | Descrizione No Description Provided | Optional no | DefaultValue |
Parametro showMessage | Tipo MCTextComponent | Descrizione No Description Provided | Optional sì | DefaultValue |
Name: addTooltip
Return Type: void
ZenScript CopyMCItemStackMutable.addTooltip(content as MCTextComponent) as void
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro contenuto | Tipo MCTextComponent | Descrizione No Description Provided |
Name: anyDamage
Return Type: MCIngredientConditioned<IIngredient>
ZenScript Copy// MCItemStackMutable.anyDamage() as MCIngredientConditioned<IIngredient>
<item:minecraft:dirt>.mutable().anyDamage();
Name: asIIngredientWithAmount
Return Type: IIngredientWithAmount
ZenScript Copy// MCItemStackMutable.asIIngredientWithAmount() as IIngredientWithAmount
<item:minecraft:dirt>.mutable().asIIngredientWithAmount();
Name: clearCustomName
Clears any custom name set for this ItemStack
Return Type: void
ZenScript Copy// MCItemStackMutable.clearCustomName() as void
<item:minecraft:dirt>.mutable().clearCustomName();
Name: clearTooltip
Return Type: void
ZenScript Copy// MCItemStackMutable.clearTooltip() as void
<item:minecraft:dirt>.mutable().clearTooltip();
Name: contains
Does the ingredient contain the given ingredient?
Return Type: boolean
ZenScript Copy// MCItemStackMutable.contains(ingredient as IIngredient) as boolean
<item:minecraft:dirt>.mutable().contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro ingredient | Tipo IIngredient | Descrizione The ingredient to check |
Name: getAttributes
Gets the Attributes and the AttributeModifiers on this IItemStack for the given EquipmentSlotType
Returns: A Map of Attribute to a List of AttributeModifier for the given EquipmentSlotType.
Return Type: stdlib.List<AttributeModifier>[Attribute]
ZenScript Copy// MCItemStackMutable.getAttributes(slotType as MCEquipmentSlotType) as stdlib.List<AttributeModifier>[Attribute]
<item:minecraft:dirt>.mutable().getAttributes(<equipmentslottype:chest>);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro slotType | Tipo MCEquipmentSlotType | Descrizione The slot to get the Attributes for. |
Name: getDefinition
Return Type: MCItemDefinition
ZenScript Copy// MCItemStackMutable.getDefinition() as MCItemDefinition
<item:minecraft:dirt>.mutable().getDefinition();
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 CopyMCItemStackMutable.getEnchantmentLevel(enchantment as MCEnchantment) as int
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro enchantment | Tipo MCEnchantment | Descrizione No Description Provided |
Name: getEnchantments
Return Type: int?[MCEnchantment]
ZenScript Copy// MCItemStackMutable.getEnchantments() as int?[MCEnchantment]
<item:minecraft:dirt>.mutable().getEnchantments();
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// MCItemStackMutable.getMaxStackSize() as int
<item:minecraft:dirt>.mutable().getMaxStackSize();
Name: getRarity
Returns the rarity of the Item in the ItemStack
Returns: Rarity of the Item.
Return Type: Rarity
ZenScript Copy// MCItemStackMutable.getRarity() as Rarity
<item:minecraft:dirt>.mutable().getRarity();
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// MCItemStackMutable.getRemainingItem(stack as IItemStack) as IItemStack
<item:minecraft:dirt>.mutable().getRemainingItem(<item:minecraft:iron_ingot>);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro stack | Tipo IItemStack | Descrizione The stack to provide for this ingredient. |
Name: isFood
Return Type: boolean
ZenScript Copy// MCItemStackMutable.isFood() as boolean
<item:minecraft:dirt>.mutable().isFood();
Name: isImmuneToFire
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// MCItemStackMutable.isImmuneToFire() as boolean
<item:minecraft:dirt>.mutable().isImmuneToFire();
Name: matches
Does the given stack match the ingredient?
Return Type: boolean
ZenScript Copy// MCItemStackMutable.matches(stack as IItemStack) as boolean
<item:minecraft:dirt>.mutable().matches(<item:minecraft:iron_ingot>);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro stack | Tipo IItemStack | Descrizione The stack to check |
Name: modifyShiftTooltip
Return Type: void
ZenScript CopyMCItemStackMutable.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction) as void
| Parametro | Tipo | Descrizione | Optional | DefaultValue |
|---|---|---|---|---|
Parametro shiftedFunction | Tipo ITooltipFunction | Descrizione No Description Provided | Optional no | DefaultValue |
Parametro unshiftedFunction | Tipo ITooltipFunction | Descrizione No Description Provided | Optional sì | DefaultValue |
Name: modifyTooltip
Return Type: void
ZenScript CopyMCItemStackMutable.modifyTooltip(function as ITooltipFunction) as void
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro function | Tipo ITooltipFunction | Descrizione No Description Provided |
Name: only
Use this if you already have the condition from another ingredient
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyMCItemStackMutable.only(condition as IIngredientCondition<IIngredient>) as MCIngredientConditioned<IIngredient>
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro condition | Tipo IIngredientCondition<IIngredient> | Descrizione No Description Provided |
Name: onlyDamaged
Return Type: MCIngredientConditioned<IIngredient>
ZenScript Copy// MCItemStackMutable.onlyDamaged() as MCIngredientConditioned<IIngredient>
<item:minecraft:dirt>.mutable().onlyDamaged();
Name: onlyDamagedAtLeast
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyMCItemStackMutable.onlyDamagedAtLeast(minDamage as int) as MCIngredientConditioned<IIngredient>
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro minDamage | Tipo int | Descrizione No Description Provided |
Name: onlyDamagedAtMost
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyMCItemStackMutable.onlyDamagedAtMost(maxDamage as int) as MCIngredientConditioned<IIngredient>
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro maxDamage | Tipo int | Descrizione No Description Provided |
Name: onlyIf
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyMCItemStackMutable.onlyIf(uid as string, function as Predicate<IItemStack>) as MCIngredientConditioned<IIngredient>
| Parametro | Tipo | Descrizione | Optional | DefaultValue |
|---|---|---|---|---|
Parametro uid | Tipo string | Descrizione No Description Provided | Optional no | DefaultValue |
Parametro function | Tipo Predicate<IItemStack> | Descrizione No Description Provided | Optional sì | DefaultValue |
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// MCItemStackMutable.removeGlobalAttribute(attribute as Attribute, slotTypes as MCEquipmentSlotType[]) as void
<item:minecraft:dirt>.mutable().removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<equipmentslottype:chest>]);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro attribute | Tipo Attribute | Descrizione The attribute to remove. |
Parametro slotTypes | Tipo MCEquipmentSlotType[] | Descrizione The slot types to remove it from. |
Name: removeGlobalAttributeModifier
Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.
Return Type: void
ZenScript Copy// MCItemStackMutable.removeGlobalAttributeModifier(uuid as string, slotTypes as MCEquipmentSlotType[]) as void
<item:minecraft:dirt>.mutable().removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<equipmentslottype:chest>]);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro uuid | Tipo string | Descrizione The unique id of the AttributeModifier to remove. |
Parametro slotTypes | Tipo MCEquipmentSlotType[] | Descrizione The slot types to remove it from. |
Name: removeTooltip
Return Type: void
ZenScript CopyMCItemStackMutable.removeTooltip(regex as string) as void
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro regex | Tipo string | Descrizione No Description Provided |
Name: setImmuneToFire
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// MCItemStackMutable.setImmuneToFire(immuneToFire as boolean) as void
<item:minecraft:dirt>.mutable().setImmuneToFire(true);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro immuneToFire | Tipo boolean | Descrizione Should the item be immune to fire. |
Name: setMaxStackSize
Sets the max stacksize of the Item.
Return Type: void
ZenScript Copy// MCItemStackMutable.setMaxStackSize(newMaxStackSize as int) as void
<item:minecraft:dirt>.mutable().setMaxStackSize(16);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro newMaxStackSize | Tipo int | Descrizione The new max stack size of the Item. |
Name: setRarity
Sets the rarity of the Item.
Return Type: void
ZenScript Copy// MCItemStackMutable.setRarity(newRarity as Rarity) as void
<item:minecraft:dirt>.mutable().setRarity(Rarity.UNCOMMON);
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro newRarity | Tipo Rarity | Descrizione The new rarity of the Item. |
Name: weight
Return Type: MCWeightedItemStack
ZenScript CopyMCItemStackMutable.weight(weight as double) as MCWeightedItemStack
| Parametro | Tipo | Descrizione |
|---|---|---|
Parametro weight | Tipo double | Descrizione No Description Provided |
Operators
Link to operators
Name: CONTAINS
Does the ingredient contain the given ingredient?
ZenScript Copyingredient as IIngredient in myMCItemStackMutable
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <item:minecraft:dirt>.mutable()
Name: EQUALS
ZenScript CopymyMCItemStackMutable == o as Object
Name: MOD
ZenScript CopymyMCItemStackMutable % percentage as int
Name: OR
ZenScript CopymyMCItemStackMutable | other as IIngredient
Proprietà
Link to proprietà
| Nome | Tipo | Ha Getter | Ha Setter | Descrizione |
|---|---|---|---|---|
Nome amount | Tipo int | Ha Getter sì | Ha Setter no | Descrizione Gets the amount of Items in the ItemStack |
Nome burnTime | Tipo int | Ha Getter sì | Ha Setter sì | Descrizione No Description Provided |
Nome damageable | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns if the ItemStack is damageable I.E Swords and tools are damageable, sticks are not. |
Nome damaged | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns if the ItemStack is damaged I.E a Swords that is no at full durability is damaged. |
Nome definition | Tipo MCItemDefinition | Ha Getter sì | Ha Setter no | Descrizione No Description Provided |
Nome displayName | Tipo string | Ha Getter sì | Ha Setter no | Descrizione Gets the display name of the ItemStack |
Nome empty | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns if the ItemStack is empty |
Nome enchantments | Tipo int?[MCEnchantment] | Ha Getter sì | Ha Setter no | Descrizione No Description Provided |
Nome food | Tipo MCFood? | Ha Getter sì | Ha Setter sì | Descrizione No Description Provided |
Nome getOrCreate | Tipo IData | Ha Getter sì | Ha Setter no | Descrizione Returns the NBT tag attached to this ItemStack or makes a new tag. |
Nome getRepairCost | Tipo int | Ha Getter sì | Ha Setter no | Descrizione Gets the repair cost of the ItemStack, or 0 if no repair is defined. |
Nome hasDisplayName | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns true if the ItemStack has a display name. |
Nome hasEffect | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns true if this ItemStack has an effect. |
Nome hasTag | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns true if this ItemStack has a Tag |
Nome immuneToFire | Tipo void | Ha Getter sì | Ha Setter sì | Descrizione Sets if this IItemStack is immune to fire / lava. If true, the item will not burn when thrown into fire or lava. |
Nome isCrossbow | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns true if this stack is considered a crossbow item |
Nome isEnchantable | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Can this ItemStack be enchanted? |
Nome isEnchanted | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Is this ItemStack enchanted? |
Nome maxDamage | Tipo int | Ha Getter sì | Ha Setter sì | Descrizione Returns the max damage of the ItemStack This is the max durability of the ItemStack. |
Nome maxStackSize | Tipo int | Ha Getter sì | Ha Setter sì | Descrizione Returns the max stack size of the Item in the ItemStack |
Nome owner | Tipo string | Ha Getter sì | Ha Setter no | Descrizione Gets owning mod for the Item in this IItemStack |
Nome rarity | Tipo Rarity | Ha Getter sì | Ha Setter sì | Descrizione Returns the rarity of the Item in the ItemStack |
Nome registryName | Tipo MCResourceLocation | Ha Getter sì | Ha Setter no | Descrizione Gets the registry name for the Item in this IItemStack |
Nome stackable | Tipo boolean | Ha Getter sì | Ha Setter no | Descrizione Returns if the ItemStack can have an amount greater than 1 I.E Swords and tools are not stackable, sticks are. |
Nome tag | Tipo IData | Ha Getter sì | Ha Setter no | Descrizione Returns the NBT tag attached to this ItemStack. |
Nome toolTypes | Tipo ToolType[] | Ha Getter sì | Ha Setter no | Descrizione No Description Provided |
Nome translationKey | Tipo string | Ha Getter sì | Ha Setter no | Descrizione Returns the unlocalized Name of the Item in the ItemStack |
Nome useDuration | Tipo int | Ha Getter sì | Ha Setter no | Descrizione Gets the use duration of the ItemStack |