Record Class ConfiguredFeature<C extends FeatureConfig, F extends Feature<C>>

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.gen.feature.ConfiguredFeature<C,F>
Type Parameters:
C - The specific configuration type.
F - The specific feature type.
Record Components:
feature - The base feature logic.
config - The parameters governing the feature's behavior.
public record ConfiguredFeature<C extends FeatureConfig, F extends Feature<C>>(F extends Feature<C> feature, C extends FeatureConfig config) extends Record
Represents a world generation feature strictly bound to its specific configuration.

This wrapper unites the stateless procedural logic of a Feature with the data-driven parameters of a FeatureConfig, creating an executable unit ready for placement in the world.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfiguredFeature(F feature, C config)
    Creates an instance of a ConfiguredFeature record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    C
    config()
    Returns the value of the config record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    F
    feature()
    Returns the value of the feature record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    place(WorldGenAccess level, org.bukkit.Location origin, Random random)
    Executes the feature's placement logic at the specified origin.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ConfiguredFeature

      public ConfiguredFeature(F feature, C config)
      Creates an instance of a ConfiguredFeature record class.
      Parameters:
      feature - the value for the feature record component
      config - the value for the config record component

  • Method Details

    • place

      public boolean place(WorldGenAccess level, org.bukkit.Location origin, Random random)
      Executes the feature's placement logic at the specified origin.
      Parameters:
      level - The world generation accessor.
      origin - The absolute starting location for the feature.
      random - The deterministic random source.
      Returns:
      True if the feature was successfully placed.

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

    • feature

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

    • config

      public C config()
      Returns the value of the config record component.
      Returns:
      the value of the config record component