Record Class OverlayFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.feature.OverlayFeature

All Implemented Interfaces:

Feature

public record OverlayFeature(HolderSet<PlacedFeature> features)
extends Record
implements Feature

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<OverlayFeature>	CODEC
private final HolderSet<PlacedFeature>	features	The field for the features record component.

Fields inherited from interface Feature

DIRECT_CODEC, LIST_CODEC

Constructor Summary

Constructors

Constructor	Description
OverlayFeature(HolderSet<PlacedFeature> features)	Creates an instance of a OverlayFeature record class.

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.MapCodec<OverlayFeature>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
HolderSet<PlacedFeature>	features()	Returns the value of the features record component.
Stream<Holder<Feature>>	getSubFeatures()
final int	hashCode()	Returns a hash code value for this object.
boolean	place(WorldGenLevel level, ChunkGenerator chunkGenerator, RandomSource random, BlockPos origin)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface Feature

markAboveForPostProcessing, safeSetBlock, setBlock

Field Details

features

private final HolderSet<PlacedFeature> features

The field for the features record component.

CODEC

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

Constructor Details

OverlayFeature

public OverlayFeature(HolderSet<PlacedFeature> features)

Creates an instance of a OverlayFeature record class.

Parameters:

features - the value for the features record component

Method Details

codec

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

Specified by:

codec in interface Feature

getSubFeatures

public Stream<Holder<Feature>> getSubFeatures()

Specified by:

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

features

public HolderSet<PlacedFeature> features()

Returns the value of the features record component.

Returns:

the value of the features record component