Record Class Tool

java.lang.Object

java.lang.Record

net.minestom.server.item.component.Tool

public record Tool(List<Tool.Rule> rules, float defaultMiningSpeed, int damagePerBlock, boolean canDestroyBlocksInCreative)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Tool.Rule

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<Tool>	CODEC
static final int	DEFAULT_DAMAGE_PER_BLOCK
static final float	DEFAULT_MINING_SPEED
static final NetworkBuffer.Type<Tool>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
Tool(List<Tool.Rule> rules, float defaultMiningSpeed, int damagePerBlock, boolean canDestroyBlocksInCreative)	Creates an instance of a Tool record class.

Method Summary

Modifier and Type	Method	Description
boolean	canDestroyBlocksInCreative()	Returns the value of the canDestroyBlocksInCreative record component.
int	damagePerBlock()	Returns the value of the damagePerBlock record component.
float	defaultMiningSpeed()	Returns the value of the defaultMiningSpeed record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
float	getSpeed(Block block)
final int	hashCode()	Returns a hash code value for this object.
boolean	isCorrectForDrops(Block block)
List<Tool.Rule>	rules()	Returns the value of the rules 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

DEFAULT_MINING_SPEED

public static final float DEFAULT_MINING_SPEED

See Also:

• Constant Field Values

DEFAULT_DAMAGE_PER_BLOCK

public static final int DEFAULT_DAMAGE_PER_BLOCK

See Also:

• Constant Field Values

NETWORK_TYPE

public static final NetworkBuffer.Type<Tool> NETWORK_TYPE

CODEC

public static final Codec<Tool> CODEC

Constructor Details

Tool

public Tool(List<Tool.Rule> rules,
 float defaultMiningSpeed,
 int damagePerBlock,
 boolean canDestroyBlocksInCreative)

Creates an instance of a Tool record class.

Parameters:

rules - the value for the rules record component

defaultMiningSpeed - the value for the defaultMiningSpeed record component

damagePerBlock - the value for the damagePerBlock record component

canDestroyBlocksInCreative - the value for the canDestroyBlocksInCreative record component

Method Details

isCorrectForDrops

public boolean isCorrectForDrops(Block block)

getSpeed

public float getSpeed(Block block)

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.

rules

public List<Tool.Rule> rules()

Returns the value of the rules record component.

Returns:

the value of the rules record component

defaultMiningSpeed

public float defaultMiningSpeed()

Returns the value of the defaultMiningSpeed record component.

Returns:

the value of the defaultMiningSpeed record component

damagePerBlock

public int damagePerBlock()

Returns the value of the damagePerBlock record component.

Returns:

the value of the damagePerBlock record component

canDestroyBlocksInCreative

public boolean canDestroyBlocksInCreative()

Returns the value of the canDestroyBlocksInCreative record component.

Returns:

the value of the canDestroyBlocksInCreative record component