Package dev.twilite.game.simulation.model.combat

Record Class SimulationTimeline

java.lang.Object
java.lang.Record
dev.twilite.game.simulation.model.combat.SimulationTimeline
public record SimulationTimeline(List<SimulationHit> hits) extends Record
Timeline of predicted combat events for one simulated candidate path.

  • Constructor Details

    • SimulationTimeline

      public SimulationTimeline()
      Creates an empty timeline.

    • SimulationTimeline

      public SimulationTimeline(List<SimulationHit> hits)
      Creates an instance of a SimulationTimeline record class.
      Parameters:
      hits - the value for the hits record component

  • Method Details

    • addHit

      public SimulationTimeline addHit(SimulationHit hit)
      Appends a predicted hit.
      Parameters:
      hit - predicted hit to append

    • addAll

      public SimulationTimeline addAll(SimulationTimeline timeline)
      Appends all events from another timeline.
      Parameters:
      timeline - timeline to append

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

    • hits

      public List<SimulationHit> hits()
      Returns the value of the hits record component.
      Returns:
      the value of the hits record component