IngredientConditioned
Importing the class
If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.
import crafttweaker.api.ingredient.type.IngredientConditioned;Implements
IngredientConditioned<IIngredient>
implements the following interfaces:
IIngredient,CommandStringDisplayable
Operators
in(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?script.zs
myIIngredient in myIIngredientConditionedParameters:
Return Type:
bool
*(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.script.zs
myIIngredientConditioned * myIntParameters:
amount: int Type: int
Return Type:
IIngredientWithAmount
|(other as IIngredient) as IIngredientList
myIIngredientConditioned | myIIngredientParameters:
other: IIngredient Type: IIngredient
Return Type:
IIngredientList
Members
addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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#withAttributeModifierscript.zs
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
// IIngredientConditioned<T : IIngredient>.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);myIIngredientConditioned.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);Parameters:
name: string Type: string
- The name of the modifier. value: double Type: double
- The value of the modifier. addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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
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#withAttributeModifierscript.zs
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
// IIngredientConditioned<T : IIngredient>.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);myIIngredientConditioned.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, "8c1b5535-9f79-448b-87ae-52d81480aaa3", "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);Parameters:
uuid: string Type: string
- The unique identifier of the modifier to replace. name: string Type: string
- The name of the modifier. value: double Type: double
- The value of the modifier. addGlobalAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as Operation, slotTypes as EquipmentSlot[])
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
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#withAttributeModifierscript.zs
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
// IIngredientConditioned<T : IIngredient>.addGlobalAttributeModifier(attribute as Attribute, uuid as UUID, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[]);myIIngredientConditioned.addGlobalAttributeModifier(<attribute:minecraft:generic.attack_damage>, IItemStack.BASE_ATTACK_DAMAGE_UUID, "Extra Power", 10, AttributeOperation.ADDITION, [<constant:minecraft:equipmentslot:chest>]);Parameters:
uuid: UUID Type: UUID
- The unique identifier of the modifier to replace. name: string Type: string
- The name of the modifier. value: double Type: double
- The value of the modifier. addShiftTooltip(content as Component, showMessage as Component = null)
// IIngredientConditioned<T : IIngredient>.addShiftTooltip(content as Component, showMessage as Component = null);myIIngredientConditioned.addShiftTooltip(myComponent, myComponent);addTooltip(content as Component)
myIIngredientConditioned.addTooltip(myComponent);anyDamage() as IIngredientConditioned<IIngredient>
implicit as IData
myIIngredientConditioned as IData
Return Type:
IData
asIIngredientWithAmount() as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.script.zs
myIIngredientConditioned.asIIngredientWithAmount();
Return Type:
IIngredientWithAmount
implicit as IIngredientWithAmount
Used implicitly when a machine can accept more than one item but you only provide one.script.zs
myIIngredientConditioned as IIngredientWithAmount
Return Type:
IIngredientWithAmount
implicit as MapData
myIIngredientConditioned as MapData
Return Type:
MapData
Getter
myIIngredientConditioned.baseIngredient
Return Type:
IIngredient
Setter
Sets the burn time of this ingredient, for use in the furnace and other machinesscript.zs
myIIngredientConditioned.burnTime = myInt;Parameters:
time: int Type: int
- the new burn time burnTime(time as int)
Sets the burn time of this ingredient, for use in the furnace and other machinesscript.zs
myIIngredientConditioned.burnTime(500);Parameters:
time: int Type: int
- the new burn time clearTooltip(leaveName as bool = false)
myIIngredientConditioned.clearTooltip(myBool);Parameters:
leaveName: bool (optional) Type: bool
Default Value: false
Getter
myIIngredientConditioned.condition
Return Type:
IIngredientCondition<IIngredient>
contains(ingredient as IIngredient) as bool
Does the ingredient contain the given ingredient?script.zs
myIIngredientConditioned.contains((<item:minecraft:iron_ingot> | <item:minecraft:gold_ingot>));Parameters:
Return Type:
bool
Getter
Checks if this ingredient is empty.script.zs
myIIngredientConditioned.empty
Return Type:
bool
empty() as bool
Checks if this ingredient is empty.script.zs
Returns: true if empty, false otherwise
myIIngredientConditioned.empty();
Return Type:
bool
getRemainingItem(stack as IItemStack) as IItemStack
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.script.zs
myIIngredientConditioned.getRemainingItem(<item:minecraft:iron_ingot>);Parameters:
Return Type:
IItemStack
Getter
myIIngredientConditioned.items
Return Type:
IItemStack[]
matches(stack as IItemStack, ignoreDamage as bool) as bool
// IIngredientConditioned<T : IIngredient>.matches(stack as IItemStack, ignoreDamage as bool) as bool;myIIngredientConditioned.matches(myIItemStack, myBool);Parameters:
stack: IItemStack Type: IItemStack ignoreDamage: bool Type: bool
Return Type:
bool
matches(stack as IItemStack) as bool
Does the given stack match the ingredient?script.zs
myIIngredientConditioned.matches(<item:minecraft:iron_ingot>);Parameters:
Return Type:
bool
modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null)
// IIngredientConditioned<T : IIngredient>.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction = null);myIIngredientConditioned.modifyShiftTooltip(myITooltipFunction, myITooltipFunction);Parameters:
shiftedFunction: ITooltipFunction Type: ITooltipFunction modifyTooltip(function as ITooltipFunction)
myIIngredientConditioned.modifyTooltip(myITooltipFunction);Parameters:
function: ITooltipFunction Type: ITooltipFunction mul(amount as int) as IIngredientWithAmount
Use this in contexts where machines accept more than one item to state that fact.script.zs
myIIngredientConditioned.mul(myInt);Parameters:
amount: int Type: int
Return Type:
IIngredientWithAmount
only(condition as IIngredientCondition<IIngredient>) as IIngredientConditioned<IIngredient>
Use this if you already have the condition from another ingredientscript.zs
// IIngredientConditioned<T : IIngredient>.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>;myIIngredientConditioned.only(myIIngredientCondition);Parameters:
condition: IIngredientCondition<IIngredient> Type: IIngredientCondition<IIngredient>
Return Type:
IngredientConditioned<IIngredient>
onlyDamaged() as IIngredientConditioned<IIngredient>
onlyDamagedAtLeast(minDamage as int) as IIngredientConditioned<IIngredient>
// IIngredientConditioned<T : IIngredient>.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>;myIIngredientConditioned.onlyDamagedAtLeast(myInt);Parameters:
minDamage: int Type: int
Return Type:
IngredientConditioned<IIngredient>
onlyDamagedAtMost(maxDamage as int) as IIngredientConditioned<IIngredient>
// IIngredientConditioned<T : IIngredient>.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>;myIIngredientConditioned.onlyDamagedAtMost(myInt);Parameters:
maxDamage: int Type: int
Return Type:
IngredientConditioned<IIngredient>
onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IIngredientConditioned<IIngredient>
// IIngredientConditioned<T : IIngredient>.onlyIf(uid as string, function as function(t as IItemStack) as bool = null) as IngredientConditioned<IIngredient>;myIIngredientConditioned.onlyIf(myString, myPredicate);Parameters:
uid: string Type: string function: function(t as IItemStack) as bool (optional) Type: function(t as IItemStack) as bool
Default Value: null
Return Type:
IngredientConditioned<IIngredient>
removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])
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.script.zs
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.
// IIngredientConditioned<T : IIngredient>.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[]);myIIngredientConditioned.removeGlobalAttribute(<attribute:minecraft:generic.attack_damage>, [<constant:minecraft:equipmentslot:chest>]);Parameters:
removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[])
Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.script.zs
// IIngredientConditioned<T : IIngredient>.removeGlobalAttributeModifier(uuid as string, slotTypes as EquipmentSlot[]);myIIngredientConditioned.removeGlobalAttributeModifier("8c1b5535-9f79-448b-87ae-52d81480aaa3", [<constant:minecraft:equipmentslot:chest>]);Parameters:
uuid: string Type: string
- The unique id of the AttributeModifier to remove. removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[])
Removes all AttributeModifiers who's ID is the same as the given uuid from this IIngredient.script.zs
// IIngredientConditioned<T : IIngredient>.removeGlobalAttributeModifier(uuid as UUID, slotTypes as EquipmentSlot[]);myIIngredientConditioned.removeGlobalAttributeModifier(IItemStack.BASE_ATTACK_DAMAGE_UUID, [<constant:minecraft:equipmentslot:chest>]);Parameters:
uuid: UUID Type: UUID
- The unique id of the AttributeModifier to remove. removeTooltip(regex as string)
myIIngredientConditioned.removeTooltip(myString);Parameters:
regex: string Type: string reuse() as IIngredientTransformed<IIngredient>
transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>
Use this if you already have the transformer from another ingredientscript.zs
// IIngredientConditioned<T : IIngredient>.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>;myIIngredientConditioned.transform(myIIngredientTransformer);Parameters:
transformer: IIngredientTransformer<IIngredient> Type: IIngredientTransformer<IIngredient>
Return Type:
IIngredientTransformed<IIngredient>
transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredientTransformed<IIngredient>
// IIngredientConditioned<T : IIngredient>.transformCustom(uid as string, function as function(r as IItemStack) as IItemStack = null) as IIngredientTransformed<IIngredient>;myIIngredientConditioned.transformCustom(myString, myFunction);Parameters:
uid: string Type: string function: function(r as IItemStack) as IItemStack (optional) Type: function(r as IItemStack) as IItemStack
Default Value: null
Return Type:
IIngredientTransformed<IIngredient>
transformDamage(amount as int = 1) as IIngredientTransformed<IIngredient>
// IIngredientConditioned<T : IIngredient>.transformDamage(amount as int = 1) as IIngredientTransformed<IIngredient>;myIIngredientConditioned.transformDamage(myInt);Parameters:
amount: int (optional) Type: int
Default Value: 1
Return Type:
IIngredientTransformed<IIngredient>
transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>
// IIngredientConditioned<T : IIngredient>.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>;myIIngredientConditioned.transformReplace(myIItemStack);Parameters:
replaceWith: IItemStack Type: IItemStack
Return Type:
IIngredientTransformed<IIngredient>