Interface Tool
Controls the behavior of the item as a tool.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether this tool can destroy blocks in creative mode.@org.checkerframework.checker.index.qual.NonNegative intAmount of durability to remove each time a block is mined with this tool.floatMining speed to use if no rules match and don't override mining speed.static Tool.RuleCreates a mining rule that specifies how an item interacts with certain block types.rules()List of rule entries.static Tool.Buildertool()
-
Method Details
-
tool
-
rule
static Tool.Rule rule(RegistryKeySet<BlockType> blocks, @Nullable Float speed, TriState correctForDrops) Creates a mining rule that specifies how an item interacts with certain block types.This method allows you to define a rule for a set of block types, optionally setting a custom mining speed and determining whether the item should correct for drops when mining these blocks.
- Parameters:
blocks- The set of block types this rule applies to.speed- The custom mining speed multiplier for these blocks. Ifnull, the default speed is used.correctForDrops- ATriStateindicating how to handle item drops:TriState.TRUE- Items will be dropped.TriState.FALSE- Items will not be dropped.TriState.NOT_SET- The default drop behavior is used.
- Returns:
- A new
Tool.Ruleinstance representing the mining rule.
-
defaultMiningSpeed
Mining speed to use if no rules match and don't override mining speed.- Returns:
- default mining speed
-
damagePerBlock
Amount of durability to remove each time a block is mined with this tool.- Returns:
- durability
-
rules
List of rule entries.- Returns:
- rules
-
canDestroyBlocksInCreative
Whether this tool can destroy blocks in creative mode.- Returns:
- whether this tool can destroy blocks in creative mode
-