Package megamek.common.strategicBattleSystems

Record Class DestinationReachedStopCondition

java.lang.Object
java.lang.Record
megamek.common.strategicBattleSystems.DestinationReachedStopCondition
All Implemented Interfaces:
StopCondition<SBFMovePath>
public record DestinationReachedStopCondition(BoardLocation destination) extends Record implements StopCondition<SBFMovePath>
Returns true if last processed move path had final position equal to destination.

  • Constructor Details

    • DestinationReachedStopCondition

      public DestinationReachedStopCondition(BoardLocation destination)
      Creates an instance of a DestinationReachedStopCondition record class.
      Parameters:
      destination - the value for the destination record component

  • Method Details

    • shouldStop

      public boolean shouldStop(SBFMovePath e)
      Specified by:
      shouldStop in interface StopCondition<SBFMovePath>
      Parameters:
      e - the last edge that was successfully relaxed
      Returns:
      true iff algorithm should stop searching for new paths

    • 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 Objects::equals(Object,Object).
      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.

    • destination

      public BoardLocation destination()
      Returns the value of the destination record component.
      Returns:
      the value of the destination record component