Package io.papermc.paper.datacomponent.item

Interface Tool.Rule

Enclosing interface:
Tool
@Experimental @NonExtendable public static interface Tool.Rule

  • Method Summary

    Modifier and Type
    Method
    Description
    RegistryKeySet<BlockType>
    blocks()
    Blocks to match.
    net.kyori.adventure.util.TriState
    correctForDrops()
    Overrides whether this tool is considered 'correct' if present and matched.
    @Nullable Float
    speed()
    Overrides the mining speed if present and matched.

  • Method Details

    • blocks

      RegistryKeySet<BlockType> blocks()
      Blocks to match.
      Returns:
      blocks

    • speed

      @Nullable Float speed()
      Overrides the mining speed if present and matched.
      Returns:
      speed override

    • correctForDrops

      net.kyori.adventure.util.TriState correctForDrops()
      Overrides whether this tool is considered 'correct' if present and matched.

      true will cause the block to mine at its most efficient speed, and drop items if the targeted block requires that.

      Returns:
      a tri-state