Record Class PlacedFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.placement.PlacedFeature

public record PlacedFeature(Holder<Feature> feature, List<PlacementModifier> placement)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<Holder<PlacedFeature>>	CODEC
static final com.mojang.serialization.Codec<PlacedFeature>	DIRECT_CODEC
private final Holder<Feature>	feature	The field for the feature record component.
static final com.mojang.serialization.Codec<HolderSet<PlacedFeature>>	LIST_CODEC
static final com.mojang.serialization.Codec<List<HolderSet<PlacedFeature>>>	LIST_OF_LISTS_CODEC
private final List<PlacementModifier>	placement	The field for the placement record component.

Constructor Summary

Constructors

Constructor	Description
PlacedFeature(Holder<Feature> feature, List<PlacementModifier> placement)	Creates an instance of a PlacedFeature record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Holder<Feature>	feature()	Returns the value of the feature record component.
Stream<Holder<Feature>>	getFeatures()
final int	hashCode()	Returns a hash code value for this object.
boolean	place(WorldGenLevel level, ChunkGenerator generator, RandomSource random, BlockPos origin)
List<PlacementModifier>	placement()	Returns the value of the placement record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

feature

private final Holder<Feature> feature

The field for the feature record component.

placement

private final List<PlacementModifier> placement

The field for the placement record component.

DIRECT_CODEC

public static final com.mojang.serialization.Codec<PlacedFeature> DIRECT_CODEC

CODEC

public static final com.mojang.serialization.Codec<Holder<PlacedFeature>> CODEC

LIST_CODEC

public static final com.mojang.serialization.Codec<HolderSet<PlacedFeature>> LIST_CODEC

LIST_OF_LISTS_CODEC

public static final com.mojang.serialization.Codec<List<HolderSet<PlacedFeature>>> LIST_OF_LISTS_CODEC

Constructor Details

PlacedFeature

public PlacedFeature(Holder<Feature> feature,
 List<PlacementModifier> placement)

Creates an instance of a PlacedFeature record class.

Parameters:

feature - the value for the feature record component

placement - the value for the placement record component

Method Details

place

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

getFeatures

public Stream<Holder<Feature>> getFeatures()

toString

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

feature

public Holder<Feature> feature()

Returns the value of the feature record component.

Returns:

the value of the feature record component

placement

public List<PlacementModifier> placement()

Returns the value of the placement record component.

Returns:

the value of the placement record component