Record Class PillarFeature.Config

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.gen.feature.impl.PillarFeature.Config
Record Components:
minHeight - The minimum guaranteed block length of the pillar.
maxHeight - The maximum possible block length of the pillar.
upward - True to generate upwards from the origin, false to generate downwards.
stopOnInvalid - True to abort the rest of the pillar if an invalid target is hit.
stateProvider - The dynamic provider supplying the blocks to build the pillar.
targets - The list of allowed target block identifiers that can be overwritten.
All Implemented Interfaces:
FeatureConfig
Enclosing class:
PillarFeature
public static record PillarFeature.Config(int minHeight, int maxHeight, boolean upward, boolean stopOnInvalid, BlockStateProvider stateProvider, List<BlockInfo> targets) extends Record implements FeatureConfig
Configuration record for the pillar feature.

  • Field Details

    • CODEC

      public static final Codec<PillarFeature.Config> CODEC
      The codec for serializing and deserializing the configuration.

  • Constructor Details

    • Config

      public Config(int minHeight, int maxHeight, boolean upward, boolean stopOnInvalid, BlockStateProvider stateProvider, List<BlockInfo> targets)
      Creates an instance of a Config record class.
      Parameters:
      minHeight - the value for the minHeight record component
      maxHeight - the value for the maxHeight record component
      upward - the value for the upward record component
      stopOnInvalid - the value for the stopOnInvalid record component
      stateProvider - the value for the stateProvider record component
      targets - the value for the targets 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 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.

    • minHeight

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

    • maxHeight

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

    • upward

      public boolean upward()
      Returns the value of the upward record component.
      Returns:
      the value of the upward record component

    • stopOnInvalid

      public boolean stopOnInvalid()
      Returns the value of the stopOnInvalid record component.
      Returns:
      the value of the stopOnInvalid record component

    • stateProvider

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

    • targets

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