Record Class VegetationPatchFeature.Config

java.lang.Object

java.lang.Record

com.github.darksoulq.abyssallib.world.gen.feature.impl.VegetationPatchFeature.Config

Record Components:

groundProvider - The block state provider defining the new ground terrain.

vegetationProvider - The block state provider defining the plants scattered on top.

radius - The horizontal radius of the terrain alteration patch.

depth - The vertical depth to which the ground will be replaced.

vegetationChance - The 1-in-X probability of placing a plant on an altered surface column.

replaceableGround - The list of blocks that are allowed to be converted into the new ground.

All Implemented Interfaces:

FeatureConfig

Enclosing class:

VegetationPatchFeature

public static record VegetationPatchFeature.Config(BlockStateProvider groundProvider, BlockStateProvider vegetationProvider, int radius, int depth, int vegetationChance, List<BlockInfo> replaceableGround)
extends Record
implements FeatureConfig

Configuration record for the vegetation patch feature.

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<VegetationPatchFeature.Config>	CODEC	The codec for serializing and deserializing the configuration.

Fields inherited from interface FeatureConfig

NONE

Constructor Summary

Constructors

Constructor	Description
Config(BlockStateProvider groundProvider, BlockStateProvider vegetationProvider, int radius, int depth, int vegetationChance, List<BlockInfo> replaceableGround)	Creates an instance of a Config record class.

Method Summary

Modifier and Type	Method	Description
int	depth()	Returns the value of the depth record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
BlockStateProvider	groundProvider()	Returns the value of the groundProvider record component.
final int	hashCode()	Returns a hash code value for this object.
int	radius()	Returns the value of the radius record component.
List<BlockInfo>	replaceableGround()	Returns the value of the replaceableGround record component.
final String	toString()	Returns a string representation of this record class.
int	vegetationChance()	Returns the value of the vegetationChance record component.
BlockStateProvider	vegetationProvider()	Returns the value of the vegetationProvider record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

CODEC

public static final Codec<VegetationPatchFeature.Config> CODEC

The codec for serializing and deserializing the configuration.

Constructor Details

Config

public Config(BlockStateProvider groundProvider,
 BlockStateProvider vegetationProvider,
 int radius,
 int depth,
 int vegetationChance,
 List<BlockInfo> replaceableGround)

Creates an instance of a Config record class.

Parameters:

groundProvider - the value for the groundProvider record component

vegetationProvider - the value for the vegetationProvider record component

radius - the value for the radius record component

depth - the value for the depth record component

vegetationChance - the value for the vegetationChance record component

replaceableGround - the value for the replaceableGround 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.

groundProvider

public BlockStateProvider groundProvider()

Returns the value of the groundProvider record component.

Returns:

the value of the groundProvider record component

vegetationProvider

public BlockStateProvider vegetationProvider()

Returns the value of the vegetationProvider record component.

Returns:

the value of the vegetationProvider record component

radius

public int radius()

Returns the value of the radius record component.

Returns:

the value of the radius record component

depth

public int depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component

vegetationChance

public int vegetationChance()

Returns the value of the vegetationChance record component.

Returns:

the value of the vegetationChance record component

replaceableGround

public List<BlockInfo> replaceableGround()

Returns the value of the replaceableGround record component.

Returns:

the value of the replaceableGround record component