Record Class SpringFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.feature.SpringFeature

All Implemented Interfaces:

Feature

public record SpringFeature(FluidState state, boolean requiresBlockBelow, int rockCount, int holeCount, HolderSet<Block> validBlocks)
extends Record
implements Feature

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<SpringFeature>	CODEC
private final int	holeCount	The field for the holeCount record component.
private final boolean	requiresBlockBelow	The field for the requiresBlockBelow record component.
private final int	rockCount	The field for the rockCount record component.
private final FluidState	state	The field for the state record component.
private final HolderSet<Block>	validBlocks	The field for the validBlocks record component.

Fields inherited from interface Feature

DIRECT_CODEC, LIST_CODEC

Constructor Summary

Constructors

Constructor	Description
SpringFeature(FluidState state, boolean requiresBlockBelow, int rockCount, int holeCount, HolderSet<Block> validBlocks)	Creates an instance of a SpringFeature record class.

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.MapCodec<SpringFeature>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	holeCount()	Returns the value of the holeCount record component.
boolean	place(WorldGenLevel level, ChunkGenerator chunkGenerator, RandomSource random, BlockPos origin)
boolean	requiresBlockBelow()	Returns the value of the requiresBlockBelow record component.
int	rockCount()	Returns the value of the rockCount record component.
FluidState	state()	Returns the value of the state record component.
final String	toString()	Returns a string representation of this record class.
HolderSet<Block>	validBlocks()	Returns the value of the validBlocks record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Feature

getSubFeatures, markAboveForPostProcessing, safeSetBlock, setBlock

Field Details

state

private final FluidState state

The field for the state record component.

requiresBlockBelow

private final boolean requiresBlockBelow

The field for the requiresBlockBelow record component.

rockCount

private final int rockCount

The field for the rockCount record component.

holeCount

private final int holeCount

The field for the holeCount record component.

validBlocks

private final HolderSet<Block> validBlocks

The field for the validBlocks record component.

CODEC

public static final com.mojang.serialization.MapCodec<SpringFeature> CODEC

Constructor Details

SpringFeature

public SpringFeature(FluidState state,
 boolean requiresBlockBelow,
 int rockCount,
 int holeCount,
 HolderSet<Block> validBlocks)

Creates an instance of a SpringFeature record class.

Parameters:

state - the value for the state record component

requiresBlockBelow - the value for the requiresBlockBelow record component

rockCount - the value for the rockCount record component

holeCount - the value for the holeCount record component

validBlocks - the value for the validBlocks record component

Method Details

codec

public com.mojang.serialization.MapCodec<SpringFeature> codec()

Specified by:

codec in interface Feature

place

public boolean place(WorldGenLevel level,
 ChunkGenerator chunkGenerator,
 RandomSource random,
 BlockPos origin)

Specified by:

place in interface Feature

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.

state

public FluidState state()

Returns the value of the state record component.

Returns:

the value of the state record component

requiresBlockBelow

public boolean requiresBlockBelow()

Returns the value of the requiresBlockBelow record component.

Returns:

the value of the requiresBlockBelow record component

rockCount

public int rockCount()

Returns the value of the rockCount record component.

Returns:

the value of the rockCount record component

holeCount

public int holeCount()

Returns the value of the holeCount record component.

Returns:

the value of the holeCount record component

validBlocks

public HolderSet<Block> validBlocks()

Returns the value of the validBlocks record component.

Returns:

the value of the validBlocks record component