Record Class Tool.Rule

java.lang.Object

java.lang.Record

net.minestom.server.item.component.Tool.Rule

Enclosing class:

Tool

public static record Tool.Rule(@NotNull RegistryTag<Block> blocks, @Nullable Float speed, @Nullable Boolean correctForDrops)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<Tool.Rule>	CODEC
static final NetworkBuffer.Type<Tool.Rule>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
Rule(@NotNull RegistryTag<Block> blocks, @Nullable Float speed, @Nullable Boolean correctForDrops)	Creates an instance of a Rule record class.

Method Summary

Modifier and Type	Method	Description
@NotNull RegistryTag<Block>	blocks()	Returns the value of the blocks record component.
@Nullable Boolean	correctForDrops()	Returns the value of the correctForDrops record component.
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.
@Nullable 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 java.lang.Object

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

Field Details

NETWORK_TYPE

public static final NetworkBuffer.Type<Tool.Rule> NETWORK_TYPE

CODEC

public static final Codec<Tool.Rule> CODEC

Constructor Details

Rule

public Rule(@NotNull
 @NotNull RegistryTag<Block> blocks,
 @Nullable
 @Nullable Float speed,
 @Nullable
 @Nullable 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

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

@NotNull
public @NotNull RegistryTag<Block> blocks()

Returns the value of the blocks record component.

Returns:

the value of the blocks record component

speed

@Nullable
public @Nullable Float speed()

Returns the value of the speed record component.

Returns:

the value of the speed record component

correctForDrops

@Nullable
public @Nullable Boolean correctForDrops()

Returns the value of the correctForDrops record component.

Returns:

the value of the correctForDrops record component