Package dev.twilite.game.simulation.rules.preference

Record Class AreaPreference.ScoreBuilder<I>

java.lang.Object
java.lang.Record
dev.twilite.game.simulation.rules.preference.AreaPreference.ScoreBuilder<I>
Type Parameters:
I - plugin-defined input for each run
Record Components:
areas - function that supplies preferred areas for the current input
score - score added at distance zero
Enclosing class:
AreaPreference
public static record AreaPreference.ScoreBuilder<I>(Function<I,? extends Collection<Rect>> areas, int score) extends Record
Builder for area preference scoring after a base score has been set.

  • Constructor Details

    • ScoreBuilder

      public ScoreBuilder(Function<I,? extends Collection<Rect>> areas, int score)
      Creates an instance of a ScoreBuilder record class.
      Parameters:
      areas - the value for the areas record component
      score - the value for the score record component

  • Method Details

    • distancePenalty

      public SimulationTask<I> distancePenalty(int distancePenalty)
      Builds an area preference task.
      Parameters:
      distancePenalty - score subtracted per tile away from the nearest area

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

    • areas

      public Function<I,? extends Collection<Rect>> areas()
      Returns the value of the areas record component.
      Returns:
      the value of the areas record component

    • score

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