Record Class GoalXZ

java.lang.Object
java.lang.Record
com.zenith.feature.pathfinder.goals.GoalXZ
All Implemented Interfaces:
Goal

public record GoalXZ(int x, int z) extends Record implements Goal
  • Constructor Summary

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

    Modifier and Type
    Method
    Description
    static double
    calculate(double xDiff, double zDiff)
     
    final boolean
    Indicates whether some other object is "equal to" this one.
    static GoalXZ
    fromDirection(org.cloudburstmc.math.vector.Vector3d origin, float yaw, double distance)
     
    final 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)
     
    final String
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

    Methods inherited from interface Goal

    heuristic, heuristic, isInGoal
  • Constructor Details

    • GoalXZ

      public GoalXZ(int x, int z)
      Creates an instance of a GoalXZ record class.
      Parameters:
      x - the value for the x 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
    • calculate

      public static double calculate(double xDiff, double zDiff)
    • fromDirection

      public static GoalXZ fromDirection(org.cloudburstmc.math.vector.Vector3d origin, float yaw, double distance)
    • 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. 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
    • z

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