Record Class AreaPreference.Builder<I>

java.lang.Object
java.lang.Record
dev.twilite.game.simulation.rules.preference.AreaPreference.Builder<I>
Type Parameters:
I - plugin-defined input for each run
Record Components:
areas - function that supplies preferred areas for the current input
Enclosing class:
AreaPreference

public static record AreaPreference.Builder<I>(Function<I,? extends Collection<Rect>> areas) extends Record
Builder for area preference scoring.
  • Constructor Details

    • Builder

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

    • score

      public AreaPreference.ScoreBuilder<I> score(int score)
      Sets the score added for nodes inside the preferred area.
      Parameters:
      score - score added at distance zero
    • 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.
    • areas

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