Package megamek.client.bot.princess

Record Class CoverageValidator

java.lang.Object
java.lang.Record
megamek.client.bot.princess.CoverageValidator
public record CoverageValidator(Princess owner) extends Record
Validates the coverage of a unit in the battlefield.

  • Constructor Details

    • CoverageValidator

      public CoverageValidator(Princess owner)
      Creates an instance of a CoverageValidator record class.
      Parameters:
      owner - the value for the owner record component

  • Method Details

    • validateUnitCoverage

      public boolean validateUnitCoverage(Entity unit, Coords newPosition)
      Validates if the unit has coverage from at least one ally.
      Parameters:
      unit - The unit to be validated.
      newPosition - The new position to be validated.
      Returns:
      TRUE if the unit has coverage from at least one ally.

    • isPositionExposed

      public boolean isPositionExposed(Entity unit)
      Indicates if the unit is exposed to enemy fire.
      Parameters:
      unit - The unit to be checked.
      Returns:
      TRUE if the unit is exposed to enemy fire.

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

    • owner

      public Princess owner()
      Returns the value of the owner record component.
      Returns:
      the value of the owner record component