Package megamek.common.strategicBattleSystems

Record Class GroundMovementAdjacency

java.lang.Object
java.lang.Record
megamek.common.strategicBattleSystems.GroundMovementAdjacency
All Implemented Interfaces:
AdjacencyMap<SBFMovePath>
public record GroundMovementAdjacency(SBFGame game) extends Record implements AdjacencyMap<SBFMovePath>

  • Constructor Details

    • GroundMovementAdjacency

      public GroundMovementAdjacency(SBFGame game)
      Creates an instance of a GroundMovementAdjacency record class.
      Parameters:
      game - the value for the game record component

  • Method Details

    • getAdjacent

      public Collection<SBFMovePath> getAdjacent(SBFMovePath mp)
      Produces set of MovePaths by extending MovePath mp with MoveSteps. The set of extending steps include {F, L, R, UP, ShL, ShR} if applicable. If stepType is equal to MoveStepType.BACKWARDS then extending steps include also {B, ShBL, ShBR}. If stepType is equal to MoveStep.DFA or MoveStep.CHARGE then it is added to the resulting set.
      Specified by:
      getAdjacent in interface AdjacencyMap<SBFMovePath>
      Parameters:
      mp - the MovePath to be extended
      Returns:
      all the edges that lead from destination node of e
      See Also:

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

    • game

      public SBFGame game()
      Returns the value of the game record component.
      Returns:
      the value of the game record component