Record Class SpikeFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.feature.SpikeFeature

All Implemented Interfaces:

Feature

public record SpikeFeature(BlockState state, BlockPredicate canPlaceOn, BlockPredicate canReplace)
extends Record
implements Feature

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockPredicate	canPlaceOn	The field for the canPlaceOn record component.
private final BlockPredicate	canReplace	The field for the canReplace record component.
static final com.mojang.serialization.MapCodec<SpikeFeature>	CODEC
private final BlockState	state	The field for the state record component.

Fields inherited from interface Feature

DIRECT_CODEC, LIST_CODEC

Constructor Summary

Constructors

Constructor	Description
SpikeFeature(BlockState state, BlockPredicate canPlaceOn, BlockPredicate canReplace)	Creates an instance of a SpikeFeature record class.

Method Summary

Modifier and Type	Method	Description
BlockPredicate	canPlaceOn()	Returns the value of the canPlaceOn record component.
BlockPredicate	canReplace()	Returns the value of the canReplace record component.
com.mojang.serialization.MapCodec<SpikeFeature>	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)
BlockState	state()	Returns the value of the state 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

state

private final BlockState state

The field for the state record component.

canPlaceOn

private final BlockPredicate canPlaceOn

The field for the canPlaceOn record component.

canReplace

private final BlockPredicate canReplace

The field for the canReplace record component.

CODEC

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

Constructor Details

SpikeFeature

public SpikeFeature(BlockState state,
 BlockPredicate canPlaceOn,
 BlockPredicate canReplace)

Creates an instance of a SpikeFeature record class.

Parameters:

state - the value for the state record component

canPlaceOn - the value for the canPlaceOn record component

canReplace - the value for the canReplace record component

Method Details

codec

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

state

public BlockState state()

Returns the value of the state record component.

Returns:

the value of the state record component

canPlaceOn

public BlockPredicate canPlaceOn()

Returns the value of the canPlaceOn record component.

Returns:

the value of the canPlaceOn record component

canReplace

public BlockPredicate canReplace()

Returns the value of the canReplace record component.

Returns:

the value of the canReplace record component