ToolActionIngredient - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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
 Copy
import mods.farmersdelight.ToolActionIngredient;

Implemented Interfaces

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

IIngredient

Casters

Result Type	Is Implicit
Result Type IData	Is Implicit true
Result Type IIngredientWithAmount	Is Implicit true
Result Type MapData	Is Implicit true

Methods

addGlobalAttributeModifier

Name: addGlobalAttributeModifier

ZenScript
 Copy
ToolActionIngredient.addGlobalAttributeModifier(attribute as Attribute, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

Parameter	Type
Parameter attribute	Type Attribute
Parameter name	Type string
Parameter value	Type double
Parameter operation	Type AttributeOperation
Parameter slotTypes	Type EquipmentSlot[]

addGlobalAttributeModifier

Name: addGlobalAttributeModifier

ZenScript
 Copy
ToolActionIngredient.addGlobalAttributeModifier(attribute as Attribute, uuid as invalid, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

Parameter	Type
Parameter attribute	Type Attribute
Parameter uuid	Type invalid
Parameter name	Type string
Parameter value	Type double
Parameter operation	Type AttributeOperation
Parameter slotTypes	Type EquipmentSlot[]

addGlobalAttributeModifier

Name: addGlobalAttributeModifier

ZenScript
 Copy
ToolActionIngredient.addGlobalAttributeModifier(attribute as Attribute, uuid as string, name as string, value as double, operation as AttributeOperation, slotTypes as EquipmentSlot[])

Parameter	Type
Parameter attribute	Type Attribute
Parameter uuid	Type string
Parameter name	Type string
Parameter value	Type double
Parameter operation	Type AttributeOperation
Parameter slotTypes	Type EquipmentSlot[]

addShiftTooltip

Name: addShiftTooltip

ZenScript
 Copy
ToolActionIngredient.addShiftTooltip(content as Component, showMessage as Component)

Parameter	Type	Optional
Parameter content	Type Component	Optional false
Parameter showMessage	Type Component	Optional true

addTooltip

Name: addTooltip

ZenScript
 Copy
ToolActionIngredient.addTooltip(content as Component)

Parameter	Type
Parameter content	Type Component

anyDamage

Name: anyDamage

Return Type: IngredientConditioned<IIngredient>

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

myToolActionIngredient.anyDamage();

asIIngredientWithAmount

Name: asIIngredientWithAmount

Return Type: IIngredientWithAmount

ZenScript
 Copy
// ToolActionIngredient.asIIngredientWithAmount() as IIngredientWithAmount

myToolActionIngredient.asIIngredientWithAmount();

clearTooltip

Name: clearTooltip

ZenScript
 Copy
ToolActionIngredient.clearTooltip(leaveName as boolean)

Parameter	Type	Optional	Default Value
Parameter leaveName	Type boolean	Optional true	Default Value false

contains

Name: contains

Return Type: boolean

ZenScript
 Copy
ToolActionIngredient.contains(ingredient as IIngredient) as boolean

Parameter	Type
Parameter ingredient	Type IIngredient

getRemainingItem

Name: getRemainingItem

Return Type: IItemStack

ZenScript
 Copy
ToolActionIngredient.getRemainingItem(stack as IItemStack) as IItemStack

Parameter	Type
Parameter stack	Type IItemStack

isEmpty

Name: isEmpty

Return Type: boolean

ZenScript
 Copy
// ToolActionIngredient.isEmpty() as boolean

myToolActionIngredient.isEmpty();

matches

Name: matches

Return Type: boolean

ZenScript
 Copy
ToolActionIngredient.matches(stack as IItemStack) as boolean

Parameter	Type
Parameter stack	Type IItemStack

modifyShiftTooltip

Name: modifyShiftTooltip

ZenScript
 Copy
ToolActionIngredient.modifyShiftTooltip(shiftedFunction as ITooltipFunction, unshiftedFunction as ITooltipFunction)

Parameter	Type	Optional
Parameter shiftedFunction	Type ITooltipFunction	Optional false
Parameter unshiftedFunction	Type ITooltipFunction	Optional true

modifyTooltip

Name: modifyTooltip

ZenScript
 Copy
ToolActionIngredient.modifyTooltip(function as ITooltipFunction)

Parameter	Type
Parameter function	Type ITooltipFunction

mul

Name: mul

Return Type: IIngredientWithAmount

ZenScript
 Copy
ToolActionIngredient.mul(amount as int) as IIngredientWithAmount

Parameter	Type
Parameter amount	Type int

only

Name: only

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
ToolActionIngredient.only(condition as IIngredientCondition<IIngredient>) as IngredientConditioned<IIngredient>

Parameter	Type
Parameter condition	Type IIngredientCondition<IIngredient>

onlyDamaged

Name: onlyDamaged

Return Type: IngredientConditioned<IIngredient>

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

myToolActionIngredient.onlyDamaged();

onlyDamagedAtLeast

Name: onlyDamagedAtLeast

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
ToolActionIngredient.onlyDamagedAtLeast(minDamage as int) as IngredientConditioned<IIngredient>

Parameter	Type
Parameter minDamage	Type int

onlyDamagedAtMost

Name: onlyDamagedAtMost

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
ToolActionIngredient.onlyDamagedAtMost(maxDamage as int) as IngredientConditioned<IIngredient>

Parameter	Type
Parameter maxDamage	Type int

onlyIf

Name: onlyIf

Return Type: IngredientConditioned<IIngredient>

ZenScript
 Copy
ToolActionIngredient.onlyIf(uid as string, function as Predicate<IItemStack>) as IngredientConditioned<IIngredient>

Parameter	Type	Optional
Parameter uid	Type string	Optional false
Parameter function	Type Predicate<IItemStack>	Optional true

removeGlobalAttribute

Name: removeGlobalAttribute

ZenScript
 Copy
ToolActionIngredient.removeGlobalAttribute(attribute as Attribute, slotTypes as EquipmentSlot[])

Parameter	Type
Parameter attribute	Type Attribute
Parameter slotTypes	Type EquipmentSlot[]

removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

Parameter	Type
Parameter uuid	Type invalid
Parameter slotTypes	Type EquipmentSlot[]

removeGlobalAttributeModifier

Name: removeGlobalAttributeModifier

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

Parameter	Type
Parameter uuid	Type string
Parameter slotTypes	Type EquipmentSlot[]

removeTooltip

Name: removeTooltip

ZenScript
 Copy
ToolActionIngredient.removeTooltip(regex as string)

Parameter	Type
Parameter regex	Type string

reuse

Name: reuse

Return Type: IIngredientTransformed<IIngredient>

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

myToolActionIngredient.reuse();

setBurnTime

Name: setBurnTime

ZenScript
 Copy
ToolActionIngredient.setBurnTime(time as int)

Parameter	Type
Parameter time	Type int

transform

Name: transform

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
ToolActionIngredient.transform(transformer as IIngredientTransformer<IIngredient>) as IIngredientTransformed<IIngredient>

Parameter	Type
Parameter transformer	Type IIngredientTransformer<IIngredient>

transformCustom

Name: transformCustom

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
ToolActionIngredient.transformCustom(uid as string, function as Function<IItemStack,IItemStack>) as IIngredientTransformed<IIngredient>

Parameter	Type	Optional
Parameter uid	Type string	Optional false
Parameter function	Type Function<IItemStack,IItemStack>	Optional true

transformDamage

Name: transformDamage

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
ToolActionIngredient.transformDamage(amount as int) as IIngredientTransformed<IIngredient>

Parameter	Type	Optional	Default Value
Parameter amount	Type int	Optional true	Default Value 1

transformReplace

Name: transformReplace

Return Type: IIngredientTransformed<IIngredient>

ZenScript
 Copy
ToolActionIngredient.transformReplace(replaceWith as IItemStack) as IIngredientTransformed<IIngredient>

Parameter	Type
Parameter replaceWith	Type IItemStack

Operators

CONTAINS

Name: CONTAINS

ZenScript
 Copy
ingredient as IIngredient in myToolActionIngredient

MUL

Name: MUL

ZenScript
 Copy
myToolActionIngredient * amount as int

Name: OR

ZenScript
 Copy
myToolActionIngredient | other as IIngredient

Properties

Name	Type	Has Getter	Has Setter
Name burnTime	Type void	Has Getter false	Has Setter true
Name empty	Type boolean	Has Getter true	Has Setter false