Record Class Tool.Rule

java.lang.Object

java.lang.Record

net.minecraft.world.item.component.Tool.Rule

Enclosing class:

Tool

public static record Tool.Rule(HolderSet<Block> blocks, Optional<Float> speed, Optional<Boolean> correctForDrops)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
private final HolderSet<Block>	blocks	The field for the blocks record component.
static final com.mojang.serialization.Codec<Tool.Rule>	CODEC
private final Optional<Boolean>	correctForDrops	The field for the correctForDrops record component.
private final Optional<Float>	speed	The field for the speed record component.
static final StreamCodec<RegistryFriendlyByteBuf, Tool.Rule>	STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
Rule(HolderSet<Block> blocks, Optional<Float> speed, Optional<Boolean> correctForDrops)	Creates an instance of a Rule record class.

Method Summary

Modifier and Type	Method	Description
HolderSet<Block>	blocks()	Returns the value of the blocks record component.
Optional<Boolean>	correctForDrops()	Returns the value of the correctForDrops record component.
static Tool.Rule	deniesDrops(HolderSet<Block> blocks)
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.
static Tool.Rule	minesAndDrops(HolderSet<Block> blocks, float speed)
static Tool.Rule	overrideSpeed(HolderSet<Block> blocks, float speed)
Optional<Float>	speed()	Returns the value of the speed 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

Field Details

blocks

private final HolderSet<Block> blocks

The field for the blocks record component.

speed

private final Optional<Float> speed

The field for the speed record component.

correctForDrops

private final Optional<Boolean> correctForDrops

The field for the correctForDrops record component.

CODEC

public static final com.mojang.serialization.Codec<Tool.Rule> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, Tool.Rule> STREAM_CODEC

Constructor Details

Rule

public Rule(HolderSet<Block> blocks,
 Optional<Float> speed,
 Optional<Boolean> correctForDrops)

Creates an instance of a Rule record class.

Parameters:

blocks - the value for the blocks record component

speed - the value for the speed record component

correctForDrops - the value for the correctForDrops record component

Method Details

minesAndDrops

public static Tool.Rule minesAndDrops(HolderSet<Block> blocks,
 float speed)

deniesDrops

public static Tool.Rule deniesDrops(HolderSet<Block> blocks)

overrideSpeed

public static Tool.Rule overrideSpeed(HolderSet<Block> blocks,
 float speed)

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.

blocks

public HolderSet<Block> blocks()

Returns the value of the blocks record component.

Returns:

the value of the blocks record component

speed

public Optional<Float> speed()

Returns the value of the speed record component.

Returns:

the value of the speed record component

correctForDrops

public Optional<Boolean> correctForDrops()

Returns the value of the correctForDrops record component.

Returns:

the value of the correctForDrops record component