Package megamek.client.bot.princess

Record Class Princess.HeatMapMarker

java.lang.Object
java.lang.Record
megamek.client.bot.princess.Princess.HeatMapMarker
Record Components:
turn - The value to show on the hex: the prediction round, or a shot's turns-til-impact countdown
heatUnits - The number of enemies contributing to this hex's heat
Enclosing class:
Princess
public static record Princess.HeatMapMarker(int turn, int heatUnits) extends Record
A bot artillery heat-map marker. For a predicted enemy position the value is the round of the prediction; for a shot it is the countdown of turns until the round lands (0 = lands this turn). The heat is the number of enemies feeding the hex, which drives a predicted hex's cold-to-hot color.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HeatMapMarker(int turn, int heatUnits)
    Creates an instance of a HeatMapMarker record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    int
    heatUnits()
    Returns the value of the heatUnits record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    turn()
    Returns the value of the turn record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HeatMapMarker

      public HeatMapMarker(int turn, int heatUnits)
      Creates an instance of a HeatMapMarker record class.
      Parameters:
      turn - the value for the turn record component
      heatUnits - the value for the heatUnits 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. All components in this record class 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.

    • turn

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

    • heatUnits

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