Package net.minestom.server.attribute

Record Class Attribute

java.lang.Object

java.lang.Record

net.minestom.server.attribute.Attribute

public record Attribute(String key, float defaultValue, float maxValue)
extends Record

Represents a living entity attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static final Attribute	ARMOR
static final Attribute	ARMOR_TOUGHNESS
static final Attribute	ATTACK_DAMAGE
static final Attribute	ATTACK_KNOCKBACK
static final Attribute	ATTACK_SPEED
static final Attribute	FLYING_SPEED
static final Attribute	FOLLOW_RANGE
static final Attribute	HORSE_JUMP_STRENGTH
static final Attribute	KNOCKBACK_RESISTANCE
static final Attribute	LUCK
static final Attribute	MAX_HEALTH
static final Attribute	MOVEMENT_SPEED
static final Attribute	ZOMBIE_SPAWN_REINFORCEMENTS

Constructor Summary

Constructors

Constructor	Description
Attribute(String key, float defaultValue, float maxValue)	Creates an instance of a Attribute record class.

Method Summary

Modifier and Type	Method	Description
float	defaultValue()	Returns the value of the defaultValue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static @Nullable Attribute	fromKey(@NotNull String key)	Retrieves an attribute by its key.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
float	maxValue()	Returns the value of the maxValue record component.
@NotNull Attribute	register()	Register this attribute.
final String	toString()	Returns a string representation of this record class.
static @NotNull Collection<@NotNull Attribute>	values()	Retrieves all registered attributes.

Methods inherited from class java.lang.Object

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

Field Details

MAX_HEALTH

public static final Attribute MAX_HEALTH

FOLLOW_RANGE

public static final Attribute FOLLOW_RANGE

KNOCKBACK_RESISTANCE

public static final Attribute KNOCKBACK_RESISTANCE

MOVEMENT_SPEED

public static final Attribute MOVEMENT_SPEED

ATTACK_DAMAGE

public static final Attribute ATTACK_DAMAGE

ATTACK_SPEED

public static final Attribute ATTACK_SPEED

FLYING_SPEED

public static final Attribute FLYING_SPEED

ARMOR

public static final Attribute ARMOR

ARMOR_TOUGHNESS

public static final Attribute ARMOR_TOUGHNESS

ATTACK_KNOCKBACK

public static final Attribute ATTACK_KNOCKBACK

LUCK

public static final Attribute LUCK

HORSE_JUMP_STRENGTH

public static final Attribute HORSE_JUMP_STRENGTH

ZOMBIE_SPAWN_REINFORCEMENTS

public static final Attribute ZOMBIE_SPAWN_REINFORCEMENTS

Constructor Details

Attribute

public Attribute(String key,
 float defaultValue,
 float maxValue)

Creates an instance of a Attribute record class.

Parameters:

key - the value for the key record component

defaultValue - the value for the defaultValue record component

maxValue - the value for the maxValue record component

Method Details

register

@NotNull
public @NotNull Attribute register()

Register this attribute.

Returns:

this attribute

See Also:

• fromKey(String)
• values()

fromKey

@Nullable
public static @Nullable Attribute fromKey(@NotNull
 @NotNull String key)

Retrieves an attribute by its key.

Parameters:

key - the key of the attribute

Returns:

the attribute for the key or null if not any

values

@NotNull
public static @NotNull Collection<@NotNull Attribute> values()

Retrieves all registered attributes.

Returns:

an array containing all registered attributes

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 '=='.

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.

key

public String key()

Returns the value of the key record component.

Returns:

the value of the key record component

defaultValue

public float defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component

maxValue

public float maxValue()

Returns the value of the maxValue record component.

Returns:

the value of the maxValue record component