IngredientConditioned<T : IIngredient>
Link to ingredientconditionedt--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.ingredient.type.IngredientConditioned;
Implemented Interfaces
Link to implemented-interfaces
IngredientConditioned implements the following interfaces. That means all methods defined in these interfaces are also available in IngredientConditioned
Casters
Link to casters
Result type | Is Implicit |
---|---|
Result type IData | Is Implicit true |
Result type IIngredientWithAmount | Is Implicit true |
Result type MapData | Is Implicit 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// IngredientConditioned.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]) as void
myIngredientConditioned.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot: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 EquipmentSlot[] | 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// IngredientConditioned.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]) as void
myIngredientConditioned.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<equipmentslot: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 EquipmentSlot[] | Description What slots the modifier is valid for. |
Name: addShiftTooltip
Return Type: void
ZenScript CopyIngredientConditioned.addShiftTooltip(content as Component, showMessage as Component) as void
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter content | Type Component | Description No Description Provided | Optional false | DefaultValue |
Parameter showMessage | Type Component | Description No Description Provided | Optional true | DefaultValue |
Name: addTooltip
Return Type: void
ZenScript CopyIngredientConditioned.addTooltip(content as Component) as void
Parameter | Type | Description |
---|---|---|
Parameter content | Type Component | Description No Description Provided |
Name: anyDamage
Return Type: IngredientConditioned<IIngredient>
ZenScript Copy// IngredientConditioned.anyDamage() as IngredientConditioned<IIngredient>
myIngredientConditioned.anyDamage();
Name: asIIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.
Return Type: IIngredientWithAmount
ZenScript Copy// IngredientConditioned.asIIngredientWithAmount() as IIngredientWithAmount
myIngredientConditioned.asIIngredientWithAmount();
Name: clearTooltip
Return Type: void
ZenScript Copy// IngredientConditioned.clearTooltip() as void
myIngredientConditioned.clearTooltip();
Name: contains
Does the ingredient contain the given ingredient?
Return Type: boolean
ZenScript Copy// IngredientConditioned.contains(ingredient as IIngredient) as boolean
myIngredientConditioned.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// IngredientConditioned.getRemainingItem(stack as IItemStack) as IItemStack
myIngredientConditioned.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// IngredientConditioned.matches(stack as IItemStack) as boolean
myIngredientConditioned.matches(<item:minecraft:iron_ingot>);
Parameter | Type | Description |
---|---|---|
Parameter stack | Type IItemStack | Description The stack to check |
Name: matches
Return Type: boolean
ZenScript CopyIngredientConditioned.matches(stack as IItemStack, ignoreDamage as boolean) as boolean
Parameter | Type | Description |
---|---|---|
Parameter stack | Type IItemStack | Description No Description Provided |
Parameter ignoreDamage | Type boolean | Description No Description Provided |
Name: modifyShiftTooltip
Return Type: void
ZenScript CopyIngredientConditioned.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 CopyIngredientConditioned.modifyTooltip(function as ITooltipFunction) as void
Parameter | Type | Description |
---|---|---|
Parameter function | Type ITooltipFunction | Description No Description Provided |
Name: mul
Use this in contexts where machines accept more than one item to state that fact.
Return Type: IIngredientWithAmount
ZenScript CopyIngredientConditioned.mul(amount as int) as IIngredientWithAmount
Parameter | Type | Description |
---|---|---|
Parameter amount | Type int | Description No Description Provided |
Name: only
Use this if you already have the condition from another ingredient
Return Type: IngredientConditioned<IIngredient>
ZenScript CopyIngredientConditioned.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter condition | Type IIngredientCondition<IIngredient> | Description No Description Provided |
Name: onlyDamaged
Return Type: IngredientConditioned<IIngredient>
ZenScript Copy// IngredientConditioned.onlyDamaged() as IngredientConditioned<IIngredient>
myIngredientConditioned.onlyDamaged();
Name: onlyDamagedAtLeast
Return Type: IngredientConditioned<IIngredient>
ZenScript CopyIngredientConditioned.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter minDamage | Type int | Description No Description Provided |
Name: onlyDamagedAtMost
Return Type: IngredientConditioned<IIngredient>
ZenScript CopyIngredientConditioned.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter maxDamage | Type int | Description No Description Provided |
Name: onlyIf
Return Type: IngredientConditioned<IIngredient>
ZenScript CopyIngredientConditioned.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<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// IngredientConditioned.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]) as void
myIngredientConditioned.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<equipmentslot:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter attribute | Type Attribute | Description The attribute to remove. |
Parameter slotTypes | Type EquipmentSlot[] | 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// IngredientConditioned.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[]) as void
myIngredientConditioned.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<equipmentslot:chest>]);
Parameter | Type | Description |
---|---|---|
Parameter uuid | Type string | Description The unique id of the AttributeModifier to remove. |
Parameter slotTypes | Type EquipmentSlot[] | Description The slot types to remove it from. |
Name: removeTooltip
Return Type: void
ZenScript CopyIngredientConditioned.removeTooltip(regex as string) as void
Parameter | Type | Description |
---|---|---|
Parameter regex | Type string | Description No Description Provided |
Name: reuse
Return Type: IIngredientTransformed<IIngredient>
ZenScript Copy// IngredientConditioned.reuse() as IIngredientTransformed<IIngredient>
myIngredientConditioned.reuse();
Name: transform
Use this if you already have the transformer from another ingredient
Return Type: IIngredientTransformed<IIngredient>
ZenScript CopyIngredientConditioned.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter transformer | Type IIngredientTransformer<IIngredient> | Description No Description Provided |
Name: transformCustom
Return Type: IIngredientTransformed<IIngredient>
ZenScript CopyIngredientConditioned.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter uid | Type string | Description No Description Provided | Optional false | DefaultValue |
Parameter function | Type Function<IItemStack,IItemStack> | Description No Description Provided | Optional true | DefaultValue |
Name: transformDamage
Return Type: IIngredientTransformed<IIngredient>
ZenScript CopyIngredientConditioned.transformDamage(amount as int) as IIngredientTransformed<IIngredient>
Parameter | Type | Description | Optional | DefaultValue |
---|---|---|---|---|
Parameter amount | Type int | Description No Description Provided | Optional true | DefaultValue 1 |
Name: transformReplace
Return Type: IIngredientTransformed<IIngredient>
ZenScript CopyIngredientConditioned.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>
Parameter | Type | Description |
---|---|---|
Parameter replaceWith | Type IItemStack | Description No Description Provided |
Operators
Link to operators
Name: CONTAINS
Does the ingredient contain the given ingredient?
ZenScript Copyingredient as IIngredient in myIngredientConditioned
(<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>) in myIngredientConditioned
Name: MUL
Use this in contexts where machines accept more than one item to state that fact.
ZenScript CopymyIngredientConditioned * amount as int
Name: OR
ZenScript CopymyIngredientConditioned | other as IIngredient
Properties
Link to properties
Name | Type | Has Getter | Has Setter | Description |
---|---|---|---|---|
Name baseIngredient | Type T | Has Getter true | Has Setter false | Description No Description Provided |
Name 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 |
Name condition | Type IIngredientCondition<T> | Has Getter true | Has Setter false | Description No Description Provided |
Name items | Type IItemStack[] | Has Getter true | Has Setter false | Description No Description Provided |