Record Class GoalY

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

public record GoalY(int level) extends Record implements Goal
  • Constructor Summary

    Constructors
    Constructor
    Description
    GoalY(int level)
    Creates an instance of a GoalY record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    static double
    calculate(int goalY, int currentY)
     
    final boolean
    Indicates whether some other object is "equal to" this one.
    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)
     
    int
    Returns the value of the level record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

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

    Methods inherited from interface Goal

    heuristic, heuristic, isInGoal
  • Constructor Details

    • GoalY

      public GoalY(int level)
      Creates an instance of a GoalY record class.
      Parameters:
      level - the value for the level 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(int goalY, int currentY)
    • 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.
    • level

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