Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AdventureModePredicate BlockItemStateProperties BookContent BundleContents ChargedProjectiles CustomData CustomModelData DebugStickState DyeColor DyedItemColor FireworkExplosion FireworkExplosionShape Fireworks Instrument ItemAttributeModifiers ItemAttributeModifiersBuilder ItemAttributeModifiersEntry ItemContainerContents ItemEnchantments ItemEnchantmentsMutable ItemLore LockCode LodestoneTracker MapDecorations MapDecorationsEntry MapId MapItemColor MapPostProcessing MutableBundleContents PotDecorations PotionContents ResolvableProfile SeededContainerLoot SuspiciousStewEffects SuspiciousStewEffectsEntry Tool ToolRule Unbreakable WritableBookContent WrittenBookContent
Equipable IItemStack ItemCooldowns ItemDefinition ItemStack UseOnContext
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
SuspiciousStewEffectsEntry ToolRule
Next

Tool

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.

script.zs
import crafttweaker.api.item.component.Tool;

Members

damagePerBlock
Getter
script.zs
// Tool.damagePerBlock as int
myTool.damagePerBlock

Return Type: int

defaultMiningSpeed
Getter
script.zs
// Tool.defaultMiningSpeed as float
myTool.defaultMiningSpeed

Return Type: float

getMiningSpeed
getMiningSpeed(state as BlockState) as float
script.zs
// Tool.getMiningSpeed(state as BlockState) as float;
myTool.getMiningSpeed(myBlockState);

Parameters:

state Type: BlockState

Return Type: float

isCorrectForDrops
isCorrectForDrops(state as BlockState) as bool
script.zs
// Tool.isCorrectForDrops(state as BlockState) as bool;
myTool.isCorrectForDrops(myBlockState);

Parameters:

state Type: BlockState

Return Type: bool

of
static of(rules as List<Rule>, defaultMiningSpeed as float, damagePerBlock as int) as Tool
script.zs
// Tool.of(rules as List<ToolRule>, defaultMiningSpeed as float, damagePerBlock as int) as Tool;
Tool.of(myList, myFloat, myInt);

Parameters:

rules Type: List<ToolRule>
defaultMiningSpeed Type: float
damagePerBlock Type: int

Return Type: Tool

rules
Getter
script.zs
// Tool.rules as List<ToolRule>
myTool.rules

Return Type: List<ToolRule>

Previous
SuspiciousStewEffectsEntry ToolRule
Next