Package megamek.common.compute.damage

Record Class PreExistingDamageResult

java.lang.Object
java.lang.Record
megamek.common.compute.damage.PreExistingDamageResult
Record Components:
armor - remaining front armor by location
rearArmor - remaining rear armor by location (only meaningful where the unit has rear armor)
internal - remaining internal structure by location (unused for fighters)
structuralIntegrity - remaining structural integrity (fighters only; 0 for other units)
critAssignments - the critical hits rolled, one entry per hit
public record PreExistingDamageResult(int[] armor, int[] rearArmor, int[] internal, int structuralIntegrity, List<CritAssignment> critAssignments) extends Record
The outcome of one pre-existing damage simulation (First Succession War, p.144). All values are absolute remaining values (not deltas), indexed by unit location, ready to be written into the unit editor dialog's controls.

Locations the unit does not use keep the value they had when the simulation started. For fighters, per-location internal structure is unused and structuralIntegrity carries the remaining SI instead.

This record is transient dialog data and is never serialized or stored in game state, so it needs no SerializationHelper converter.

  • Constructor Details

    • PreExistingDamageResult

      public PreExistingDamageResult(int[] armor, int[] rearArmor, int[] internal, int structuralIntegrity, List<CritAssignment> critAssignments)
      Creates an instance of a PreExistingDamageResult record class.
      Parameters:
      armor - the value for the armor record component
      rearArmor - the value for the rearArmor record component
      internal - the value for the internal record component
      structuralIntegrity - the value for the structuralIntegrity record component
      critAssignments - the value for the critAssignments record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • armor

      public int[] armor()
      Returns the value of the armor record component.
      Returns:
      the value of the armor record component

    • rearArmor

      public int[] rearArmor()
      Returns the value of the rearArmor record component.
      Returns:
      the value of the rearArmor record component

    • internal

      public int[] internal()
      Returns the value of the internal record component.
      Returns:
      the value of the internal record component

    • structuralIntegrity

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

    • critAssignments

      public List<CritAssignment> critAssignments()
      Returns the value of the critAssignments record component.
      Returns:
      the value of the critAssignments record component