IIngredient
Link to iingredient
This is IIngredient!!!
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport crafttweaker.api.item.IIngredient;
Implemented Interfaces
Link to implemented-interfaces
IIngredient implements the following interfaces. That means all methods defined in these interfaces are also available in IIngredient
Casters
Link to casters
반환 자료형 | 암묵적 |
---|---|
반환 자료형 IData | 암묵적 true |
반환 자료형 Ingredient | 암묵적 true |
반환 자료형 MapData | 암묵적 true |
Methods
Link to methods
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// IIngredient.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as MCEquipmentSlotType[]) as void
<tag:items:forge:ingots>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslottype:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter attribute | Type Attribute | Description The Attribute of the modifier. |
Parameter name | Type string | Description The name of the modifier. |
Parameter value | Type double | Description The value of the modifier. |
Parameter operation | Type AttributeOperation | Description The operation of the modifier. |
Parameter slotTypes | Type MCEquipmentSlotType[] | Description 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// IIngredient.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as MCEquipmentSlotType[]) as void
<tag:items:forge:ingots>.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslottype:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter attribute | Type Attribute | Description The Attribute of the modifier. |
Parameter uuid | Type string | Description The unique identifier of the modifier to replace. |
Parameter name | Type string | Description The name of the modifier. |
Parameter value | Type double | Description The value of the modifier. |
Parameter operation | Type AttributeOperation | Description The operation of the modifier. |
Parameter slotTypes | Type MCEquipmentSlotType[] | Description What slots the modifier is valid for. |
Name: addShiftTooltip
Return Type: void
ZenScript CopyIIngredient.addShiftTooltip(content as MCTextComponent, showMessage as MCTextComponent) as void
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter content | Type MCTextComponent | Description No Description Provided | Optional false | DefaultValue |
Parameter showMessage | Type MCTextComponent | Description No Description Provided | Optional true | DefaultValue |
Name: addTooltip
Return Type: void
ZenScript CopyIIngredient.addTooltip(content as MCTextComponent) as void
Parameter | Type | Description |
---|---|---|
Parameter content | Type MCTextComponent | Description No Description Provided |
Name: anyDamage
Return Type: MCIngredientConditioned<IIngredient>
ZenScript Copy// IIngredient.anyDamage() as MCIngredientConditioned<IIngredient>
<tag:items:forge:ingots>.anyDamage();
Name: asVanillaIngredient
Create a Vanilla ingredient matching this one.
Return Type: Ingredient
ZenScript Copy// IIngredient.asVanillaIngredient() as Ingredient
<tag:items:forge:ingots>.asVanillaIngredient();
Name: clearTooltip
Return Type: void
ZenScript Copy// IIngredient.clearTooltip() as void
<tag:items:forge:ingots>.clearTooltip();
Name: contains
Does the ingredient contain the given ingredient?
Return Type: boolean
ZenScript Copy// IIngredient.contains(ingredient as IIngredient) as boolean
<tag:items:forge:ingots>.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));
Parameter | Type | Description |
---|---|---|
Parameter ingredient | Type IIngredient | Description The ingredient to check |
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// IIngredient.getRemainingItem(stack as IItemStack) as IItemStack
<tag:items:forge:ingots>.getRemainingItem(<item:minecraft:iron_ingot>);
Parameter | Type | Description |
---|---|---|
Parameter stack | Type IItemStack | Description The stack to provide for this ingredient. |
Name: matches
Does the given stack match the ingredient?
Return Type: boolean
ZenScript Copy// IIngredient.matches(stack as IItemStack) as boolean
<tag:items:forge:ingots>.matches(<item:minecraft:iron_ingot>);
Parameter | Type | Description |
---|---|---|
Parameter stack | Type IItemStack | Description The stack to check |
Name: matches
Does the given stack match the ingredient?
Return Type: boolean
ZenScript CopyIIngredient.matches(stack as IItemStack, ignoreDamage as boolean) as boolean
Parameter | Type | Description |
---|---|---|
Parameter stack | Type IItemStack | Description The stack to check |
Parameter ignoreDamage | Type boolean | Description Should damage be checked? |
Name: modifyShiftTooltip
Return Type: void
ZenScript CopyIIngredient.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction) as void
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter shiftedFunction | Type ITooltipFunction | Description No Description Provided | Optional false | DefaultValue |
Parameter unshiftedFunction | Type ITooltipFunction | Description No Description Provided | Optional true | DefaultValue |
Name: modifyTooltip
Return Type: void
ZenScript CopyIIngredient.modifyTooltip(function as ITooltipFunction) as void
Parameter | Type | Description |
---|---|---|
Parameter function | Type ITooltipFunction | Description No Description Provided |
Name: only
Use this if you already have the condition from another ingredient
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyIIngredient.only(condition as IIngredientCondition<IIngredient>) as MCIngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter condition | Type IIngredientCondition<IIngredient> | Description No Description Provided |
Name: onlyDamaged
Return Type: MCIngredientConditioned<IIngredient>
ZenScript Copy// IIngredient.onlyDamaged() as MCIngredientConditioned<IIngredient>
<tag:items:forge:ingots>.onlyDamaged();
Name: onlyDamagedAtLeast
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyIIngredient.onlyDamagedAtLeast(minDamage as int) as MCIngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter minDamage | Type int | Description No Description Provided |
Name: onlyDamagedAtMost
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyIIngredient.onlyDamagedAtMost(maxDamage as int) as MCIngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter maxDamage | Type int | Description No Description Provided |
Name: onlyIf
Return Type: MCIngredientConditioned<IIngredient>
ZenScript CopyIIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as MCIngredientConditioned<IIngredient>
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter uid | Type string | Description No Description Provided | Optional false | DefaultValue |
Parameter function | Type Predicate<IItemStack> | Description No Description Provided | Optional true | 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// IIngredient.removeGlobalAttribute(attribute as Attribute, slotTypes as MCEquipmentSlotType[]) as void
<tag:items:forge:ingots>.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<equipmentslottype:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter attribute | Type Attribute | Description The attribute to remove. |
Parameter slotTypes | Type MCEquipmentSlotType[] | Description 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// IIngredient.removeGlobalAttributeModifier(uuid as string, slotTypes as MCEquipmentSlotType[]) as void
<tag:items:forge:ingots>.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<equipmentslottype:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter uuid | Type string | Description The unique id of the AttributeModifier to remove. |
Parameter slotTypes | Type MCEquipmentSlotType[] | Description The slot types to remove it from. |
Name: removeTooltip
Return Type: void
ZenScript CopyIIngredient.removeTooltip(regex as string) as void
Parameter | Type | Description |
---|---|---|
Parameter regex | Type string | Description No Description Provided |
연산자
Link to 연산자
Name: CONTAINS
Does the ingredient contain the given ingredient?
ZenScript Copyingredient as IIngredient in myIIngredient
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in <tag:items:forge:ingots>
Name: OR
ZenScript CopymyIIngredient | other as IIngredient
Properties
Link to properties
이름 | Type | Has Getter | Has Setter | Description |
---|---|---|---|---|
이름 burnTime | Type void | Has Getter false | Has Setter true | Description Sets the burn time of this ingredient, for use in the furnace and other machines |
이름 commandString | Type string | Has Getter true | Has Setter false | Description Returns the BEP to get this stack |
이름 items | Type IItemStack[] | Has Getter true | Has Setter false | Description No Description Provided |