Record Class MovementMiningCost

java.lang.Object
java.lang.Record
com.soulfiremc.server.pathfinding.graph.actions.movement.MovementMiningCost
public record MovementMiningCost(@NonNull SFVec3i block, double miningCost, boolean willDropUsableBlockItem, @NonNull BlockFace blockBreakSideHint) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    MovementMiningCost(@NonNull SFVec3i block, double miningCost, boolean willDropUsableBlockItem, @NonNull BlockFace blockBreakSideHint)
    Creates an instance of a MovementMiningCost record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull SFVec3i
    block()
    Returns the value of the block record component.
    @NonNull BlockFace
    blockBreakSideHint()
    Returns the value of the blockBreakSideHint record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    miningCost()
    Returns the value of the miningCost record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    willDropUsableBlockItem()
    Returns the value of the willDropUsableBlockItem record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MovementMiningCost

      public MovementMiningCost(@NonNull @NonNull SFVec3i block, double miningCost, boolean willDropUsableBlockItem, @NonNull @NonNull BlockFace blockBreakSideHint)
      Creates an instance of a MovementMiningCost record class.
      Parameters:
      block - the value for the block record component
      miningCost - the value for the miningCost record component
      willDropUsableBlockItem - the value for the willDropUsableBlockItem record component
      blockBreakSideHint - the value for the blockBreakSideHint record component

  • Method Details

    • 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.

    • block

      @NonNull public @NonNull SFVec3i block()
      Returns the value of the block record component.
      Returns:
      the value of the block record component

    • miningCost

      public double miningCost()
      Returns the value of the miningCost record component.
      Returns:
      the value of the miningCost record component

    • willDropUsableBlockItem

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

    • blockBreakSideHint

      @NonNull public @NonNull BlockFace blockBreakSideHint()
      Returns the value of the blockBreakSideHint record component.
      Returns:
      the value of the blockBreakSideHint record component