Record Class BlockItemStateProperties

java.lang.Object

java.lang.Record

net.minecraft.world.item.component.BlockItemStateProperties

All Implemented Interfaces:

TooltipProvider

public record BlockItemStateProperties(Map<String,String> properties)
extends Record
implements TooltipProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<BlockItemStateProperties>	CODEC
static final BlockItemStateProperties	EMPTY
private final Map<String,String>	properties	The field for the properties record component.
private static final StreamCodec<io.netty.buffer.ByteBuf, Map<String,String>>	PROPERTIES_STREAM_CODEC
static final StreamCodec<io.netty.buffer.ByteBuf, BlockItemStateProperties>	STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
BlockItemStateProperties(Map<String,String> properties)	Creates an instance of a BlockItemStateProperties record class.

Method Summary

Modifier and Type	Method	Description
void	addToTooltip(Item.TooltipContext context, Consumer<Component> consumer, TooltipFlag flag, DataComponentGetter components)
BlockState	apply(BlockState state)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
<T extends Comparable<T>> @Nullable T	get(Property<T> property)
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
Map<String,String>	properties()	Returns the value of the properties record component.
final String	toString()	Returns a string representation of this record class.
private static <T extends Comparable<T>> BlockState	updateState(BlockState state, Property<T> property, String value)
<T extends Comparable<T>> BlockItemStateProperties	with(Property<T> property, BlockState state)
<T extends Comparable<T>> BlockItemStateProperties	with(Property<T> property, T value)

Methods inherited from class Object

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

Field Details

properties

private final Map<String,String> properties

The field for the properties record component.

EMPTY

public static final BlockItemStateProperties EMPTY

CODEC

public static final com.mojang.serialization.Codec<BlockItemStateProperties> CODEC

PROPERTIES_STREAM_CODEC

private static final StreamCodec<io.netty.buffer.ByteBuf, Map<String,String>> PROPERTIES_STREAM_CODEC

STREAM_CODEC

public static final StreamCodec<io.netty.buffer.ByteBuf, BlockItemStateProperties> STREAM_CODEC

Constructor Details

BlockItemStateProperties

public BlockItemStateProperties(Map<String,String> properties)

Creates an instance of a BlockItemStateProperties record class.

Parameters:

properties - the value for the properties record component

Method Details

with

public <T extends Comparable<T>>
BlockItemStateProperties with(Property<T> property,
 T value)

with

public <T extends Comparable<T>>
BlockItemStateProperties with(Property<T> property,
 BlockState state)

get

public <T extends Comparable<T>> @Nullable T get(Property<T> property)

apply

public BlockState apply(BlockState state)

updateState

private static <T extends Comparable<T>> BlockState updateState(BlockState state,
 Property<T> property,
 String value)

isEmpty

public boolean isEmpty()

addToTooltip

public void addToTooltip(Item.TooltipContext context,
 Consumer<Component> consumer,
 TooltipFlag flag,
 DataComponentGetter components)

Specified by:

addToTooltip in interface TooltipProvider

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.

properties

public Map<String,String> properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component