Record Class TreeFeature.Config

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.gen.feature.impl.TreeFeature.Config
Record Components:
trunkProvider - The provider determining log materials.
foliageProvider - The provider determining leaf materials.
dirtProvider - The provider enforcing root structural substrates.
trunkPlacer - The algorithmic framework charting trunk ascension.
foliagePlacer - The algorithmic framework charting foliage aggregation.
rootPlacer - The algorithmic framework mapping subterranean roots.
decorators - The sequential post-assembly aesthetic mutators.
baseHeight - The minimum guaranteed vertical limit of the base trunk array.
heightRandA - The primary integer scalar randomizing vertical magnitude.
heightRandB - The secondary integer scalar randomizing vertical magnitude.
foliageRadius - The minimum guaranteed horizontal limit spanning the base foliage array.
foliageRadiusRand - The integer scalar randomizing horizontal magnitude encompassing the foliage canopy.
dirtTargets - The categorical whitelist determining valid surfaces permitting organic origin points.
All Implemented Interfaces:
FeatureConfig
Enclosing class:
TreeFeature
public static record TreeFeature.Config(BlockStateProvider trunkProvider, BlockStateProvider foliageProvider, BlockStateProvider dirtProvider, TrunkPlacer trunkPlacer, FoliagePlacer foliagePlacer, RootPlacer rootPlacer, List<TreeDecorator> decorators, int baseHeight, int heightRandA, int heightRandB, int foliageRadius, int foliageRadiusRand, List<BlockInfo> dirtTargets) extends Record implements FeatureConfig
Structure detailing the placement algorithms utilized by the tree feature.

  • Field Details

    • CODEC

      public static final Codec<TreeFeature.Config> CODEC
      Codec responsible for serializing and deserializing the config parameters.

  • Constructor Details

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • trunkProvider

      public BlockStateProvider trunkProvider()
      Returns the value of the trunkProvider record component.
      Returns:
      the value of the trunkProvider record component

    • foliageProvider

      public BlockStateProvider foliageProvider()
      Returns the value of the foliageProvider record component.
      Returns:
      the value of the foliageProvider record component

    • dirtProvider

      public BlockStateProvider dirtProvider()
      Returns the value of the dirtProvider record component.
      Returns:
      the value of the dirtProvider record component

    • trunkPlacer

      public TrunkPlacer trunkPlacer()
      Returns the value of the trunkPlacer record component.
      Returns:
      the value of the trunkPlacer record component

    • foliagePlacer

      public FoliagePlacer foliagePlacer()
      Returns the value of the foliagePlacer record component.
      Returns:
      the value of the foliagePlacer record component

    • rootPlacer

      public RootPlacer rootPlacer()
      Returns the value of the rootPlacer record component.
      Returns:
      the value of the rootPlacer record component

    • decorators

      public List<TreeDecorator> decorators()
      Returns the value of the decorators record component.
      Returns:
      the value of the decorators record component

    • baseHeight

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

    • heightRandA

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

    • heightRandB

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

    • foliageRadius

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

    • foliageRadiusRand

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

    • dirtTargets

      public List<BlockInfo> dirtTargets()
      Returns the value of the dirtTargets record component.
      Returns:
      the value of the dirtTargets record component