Record Class YGoal

java.lang.Object
java.lang.Record
com.soulfiremc.server.pathfinding.goals.YGoal
All Implemented Interfaces:
GoalScorer
public record YGoal(int y) extends Record implements GoalScorer

  • Constructor Summary

    Constructors
    Constructor
    Description
    YGoal(int y)
    Creates an instance of a YGoal record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    computeScore(MinecraftGraph graph, SFVec3i blockPosition, List<WorldAction> actions)
    Calculates the estimated score for a given block position to the goal.
    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.
    boolean
    isFinished(MinecraftRouteNode current)
    Checks if the given world state indicates that the goal is reached.
    final String
    toString()
    Returns a string representation of this record class.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • YGoal

      public YGoal(int y)
      Creates an instance of a YGoal record class.
      Parameters:
      y - the value for the y record component

  • Method Details

    • computeScore

      public double computeScore(MinecraftGraph graph, SFVec3i blockPosition, List<WorldAction> actions)
      Description copied from interface: GoalScorer
      Calculates the estimated score for a given block position to the goal. Usually this means the distance from achieving the goal.
      Specified by:
      computeScore in interface GoalScorer
      Parameters:
      graph - the graph to calculate the score for
      blockPosition - the block position to calculate the score for
      actions - the actions that have been executed to reach the current state
      Returns:
      the score for the given world state

    • isFinished

      public boolean isFinished(MinecraftRouteNode current)
      Description copied from interface: GoalScorer
      Checks if the given world state indicates that the goal is reached.
      Specified by:
      isFinished in interface GoalScorer
      Parameters:
      current - the node to check
      Returns:
      true if the goal is reached, false otherwise

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

    • y

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