Record Class SimpleBlockFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.feature.SimpleBlockFeature

All Implemented Interfaces:

Feature

public record SimpleBlockFeature(Holder<BlockStateProvider> toPlace, boolean scheduleTick)
extends Record
implements Feature

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<SimpleBlockFeature>	CODEC
private final boolean	scheduleTick	The field for the scheduleTick record component.
private final Holder<BlockStateProvider>	toPlace	The field for the toPlace record component.

Fields inherited from interface Feature

DIRECT_CODEC, LIST_CODEC

Constructor Summary

Constructors

Constructor	Description
SimpleBlockFeature(Holder<BlockStateProvider> toPlace)
SimpleBlockFeature(Holder<BlockStateProvider> toPlace, boolean scheduleTick)	Creates an instance of a SimpleBlockFeature record class.
SimpleBlockFeature(BlockStateProvider toPlace)

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.MapCodec<SimpleBlockFeature>	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.
boolean	place(WorldGenLevel level, ChunkGenerator chunkGenerator, RandomSource random, BlockPos origin)
boolean	scheduleTick()	Returns the value of the scheduleTick record component.
Holder<BlockStateProvider>	toPlace()	Returns the value of the toPlace record component.
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

getSubFeatures, markAboveForPostProcessing, safeSetBlock, setBlock

Field Details

toPlace

private final Holder<BlockStateProvider> toPlace

The field for the toPlace record component.

scheduleTick

private final boolean scheduleTick

The field for the scheduleTick record component.

CODEC

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

Constructor Details

SimpleBlockFeature

public SimpleBlockFeature(Holder<BlockStateProvider> toPlace)

SimpleBlockFeature

public SimpleBlockFeature(BlockStateProvider toPlace)

SimpleBlockFeature

public SimpleBlockFeature(Holder<BlockStateProvider> toPlace,
 boolean scheduleTick)

Creates an instance of a SimpleBlockFeature record class.

Parameters:

toPlace - the value for the toPlace record component

scheduleTick - the value for the scheduleTick record component

Method Details

codec

public com.mojang.serialization.MapCodec<SimpleBlockFeature> 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.

toPlace

public Holder<BlockStateProvider> toPlace()

Returns the value of the toPlace record component.

Returns:

the value of the toPlace record component

scheduleTick

public boolean scheduleTick()

Returns the value of the scheduleTick record component.

Returns:

the value of the scheduleTick record component