Package net.minestom.server.entity.attribute

Record Class AttributeModifier

java.lang.Object

java.lang.Record

net.minestom.server.entity.attribute.AttributeModifier

public record AttributeModifier(@NotNull net.kyori.adventure.key.Key id, double amount, @NotNull AttributeOperation operation)
extends Record

Represent an attribute modifier.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
AttributeModifier(@NotNull String id, double amount, @NotNull AttributeOperation operation)	Creates a new modifier with a random id.
AttributeModifier(@NotNull net.kyori.adventure.key.Key id, double amount, @NotNull AttributeOperation operation)	Creates an instance of a AttributeModifier record class.

Method Summary

Modifier and Type	Method	Description
double	amount()	Returns the value of the amount 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.
@NotNull net.kyori.adventure.key.Key	id()	Returns the value of the id record component.
@NotNull AttributeOperation	operation()	Returns the value of the operation 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<AttributeModifier> NETWORK_TYPE

CODEC

public static final Codec<AttributeModifier> CODEC

Constructor Details

AttributeModifier

public AttributeModifier(@NotNull @KeyPattern
 @NotNull String id,
 double amount,
 @NotNull
 @NotNull AttributeOperation operation)

Creates a new modifier with a random id.

Parameters:

id - the (namespace) id of this modifier

amount - the value of this modifier

operation - the operation to apply this modifier with

AttributeModifier

public AttributeModifier(@NotNull
 @NotNull net.kyori.adventure.key.Key id,
 double amount,
 @NotNull
 @NotNull AttributeOperation operation)

Creates an instance of a AttributeModifier record class.

Parameters:

id - the value for the id record component

amount - the value for the amount record component

operation - the value for the operation 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. 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.

id

@NotNull
public @NotNull net.kyori.adventure.key.Key id()

Returns the value of the id record component.

Returns:

the value of the id record component

amount

public double amount()

Returns the value of the amount record component.

Returns:

the value of the amount record component

operation

@NotNull
public @NotNull AttributeOperation operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component