Record Class Tool

java.lang.Object
java.lang.Record
net.minestom.server.item.component.Tool
public record Tool(List<Tool.Rule> rules, float defaultMiningSpeed, int damagePerBlock, boolean canDestroyBlocksInCreative) extends Record

  • Field Details

  • Constructor Details

    • Tool

      public Tool(List<Tool.Rule> rules, float defaultMiningSpeed, int damagePerBlock, boolean canDestroyBlocksInCreative)
      Creates an instance of a Tool record class.
      Parameters:
      rules - the value for the rules record component
      defaultMiningSpeed - the value for the defaultMiningSpeed record component
      damagePerBlock - the value for the damagePerBlock record component
      canDestroyBlocksInCreative - the value for the canDestroyBlocksInCreative record component

  • Method Details

    • isCorrectForDrops

      @Deprecated(forRemoval=true) public boolean isCorrectForDrops(Block block)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use isCorrectForDrops(RegistryKey)
      Returns whether this tool is correct for drops from the given block.
      Parameters:
      block - the block to test
      Returns:
      whether the first matching rule marks this tool as correct for drops

    • isCorrectForDrops

      public boolean isCorrectForDrops(RegistryKey<Block> block)
      Returns whether this tool is correct for drops from the given block key.
      Parameters:
      block - the block key to test
      Returns:
      whether the first matching rule marks this tool as correct for drops

    • getSpeed

      @Deprecated(forRemoval=true) public float getSpeed(Block block)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getSpeed(RegistryKey)
      Returns this tool's mining speed for the given block.
      Parameters:
      block - the block to test
      Returns:
      the first matching rule's speed, or defaultMiningSpeed() when none match

    • getSpeed

      public float getSpeed(RegistryKey<Block> block)
      Returns this tool's mining speed for the given block key.
      Parameters:
      block - the block key to test
      Returns:
      the first matching rule's speed, or defaultMiningSpeed() when none match

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • rules

      public List<Tool.Rule> rules()
      Returns the value of the rules record component.
      Returns:
      the value of the rules record component

    • defaultMiningSpeed

      public float defaultMiningSpeed()
      Returns the value of the defaultMiningSpeed record component.
      Returns:
      the value of the defaultMiningSpeed record component

    • damagePerBlock

      public int damagePerBlock()
      Returns the value of the damagePerBlock record component.
      Returns:
      the value of the damagePerBlock record component

    • canDestroyBlocksInCreative

      public boolean canDestroyBlocksInCreative()
      Returns the value of the canDestroyBlocksInCreative record component.
      Returns:
      the value of the canDestroyBlocksInCreative record component