Package com.github.darksoulq.abyssallib.world.gen.feature.impl

Record Class RandomFeature.WeightedFeature

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.gen.feature.impl.RandomFeature.WeightedFeature
Record Components:
feature - The sub-feature to attempt to place.
chance - The float probability of execution.
Enclosing class:
RandomFeature
public static record RandomFeature.WeightedFeature(PlacedFeature feature, float chance) extends Record
A record defining a PlacedFeature paired with an execution probability.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Codec<RandomFeature.WeightedFeature>
    CODEC
    The codec for serializing and deserializing a weighted feature.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WeightedFeature(PlacedFeature feature, float chance)
    Creates an instance of a WeightedFeature record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    chance()
    Returns the value of the chance record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    PlacedFeature
    feature()
    Returns the value of the feature record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • WeightedFeature

      public WeightedFeature(PlacedFeature feature, float chance)
      Creates an instance of a WeightedFeature record class.
      Parameters:
      feature - the value for the feature record component
      chance - the value for the chance 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.

    • feature

      public PlacedFeature feature()
      Returns the value of the feature record component.
      Returns:
      the value of the feature record component

    • chance

      public float chance()
      Returns the value of the chance record component.
      Returns:
      the value of the chance record component