Record Class GoalTwoBlocks

java.lang.Object
java.lang.Record
com.zenith.feature.pathfinder.goals.GoalTwoBlocks
Record Components:
x - The X block position of this goal
y - The Y block position of this goal
z - The Z block position of this goal
All Implemented Interfaces:
Goal, PosGoal

public record GoalTwoBlocks(int x, int y, int z) extends Record implements Goal, PosGoal
Useful if the goal is just to mine a block. This goal will be satisfied if the specified BlockPos is at to or above the specified position for this goal.
  • Constructor Summary

    Constructors
    Constructor
    Description
    GoalTwoBlocks(int x, int y, int z)
    Creates an instance of a GoalTwoBlocks record class.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
     
    int
    Returns a hash code value for this object.
    double
    heuristic(int x, int y, int z)
     
    boolean
    isInGoal(int x, int y, int z)
     
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.zenith.feature.pathfinder.goals.Goal

    heuristic, heuristic, isInGoal
  • Constructor Details

    • GoalTwoBlocks

      public GoalTwoBlocks(BlockPos pos)
    • GoalTwoBlocks

      public GoalTwoBlocks(int x, int y, int z)
      Creates an instance of a GoalTwoBlocks record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
  • Method Details

    • isInGoal

      public boolean isInGoal(int x, int y, int z)
      Specified by:
      isInGoal in interface Goal
    • heuristic

      public double heuristic(int x, int y, int z)
      Specified by:
      heuristic in interface Goal
    • hashCode

      public 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
    • toString

      public 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
    • getGoalPos

      public BlockPos getGoalPos()
      Specified by:
      getGoalPos in interface PosGoal
    • 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. All components in this record class 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.
    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component
    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component
    • z

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