Package org.bukkit.attribute

Class AttributeModifier

java.lang.Object

org.bukkit.attribute.AttributeModifier

All Implemented Interfaces:

net.kyori.adventure.key.Keyed, ConfigurationSerializable, Keyed

public class AttributeModifier
extends Object
implements ConfigurationSerializable, Keyed

Concrete implementation of an attribute modifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AttributeModifier.Operation	Enumerable operation to be applied.

Constructor Summary

Constructors

Constructor	Description
AttributeModifier(@NotNull String name, double amount, @NotNull AttributeModifier.Operation operation)	Deprecated, for removal: This API element is subject to removal in a future version.
AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation)	Deprecated, for removal: This API element is subject to removal in a future version.
AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation, @NotNull EquipmentSlotGroup slot)	Deprecated, for removal: This API element is subject to removal in a future version.
AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation, @Nullable EquipmentSlot slot)	Deprecated, for removal: This API element is subject to removal in a future version.
AttributeModifier(@NotNull NamespacedKey key, double amount, @NotNull AttributeModifier.Operation operation)
AttributeModifier(@NotNull NamespacedKey key, double amount, @NotNull AttributeModifier.Operation operation, @NotNull EquipmentSlotGroup slot)

Method Summary

Modifier and Type	Method	Description
static @NotNull AttributeModifier	deserialize(@NotNull Map<String,Object> args)
boolean	equals(Object other)
double	getAmount()	Get the amount by which this modifier will apply its AttributeModifier.Operation.
@NotNull NamespacedKey	getKey()	Return the namespaced identifier for this object.
@NotNull String	getName()	Get the name of this modifier.
@NotNull AttributeModifier.Operation	getOperation()	Get the operation this modifier will apply.
@Nullable EquipmentSlot	getSlot()	Deprecated. use getSlotGroup()
@NotNull EquipmentSlotGroup	getSlotGroup()	Get the EquipmentSlotGroup this AttributeModifier is active on.
@NotNull UUID	getUniqueId()	Deprecated, for removal: This API element is subject to removal in a future version. attributes are now identified by keys
int	hashCode()
@NotNull Map<String,Object>	serialize()	Creates a Map representation of this class.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.Keyed

key

Constructor Details

AttributeModifier

@Deprecated(since="1.21",
            forRemoval=true)
public AttributeModifier(@NotNull
 @NotNull String name,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation)

Deprecated, for removal: This API element is subject to removal in a future version.

AttributeModifier

@Deprecated(since="1.21",
            forRemoval=true)
public AttributeModifier(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String name,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation)

Deprecated, for removal: This API element is subject to removal in a future version.

AttributeModifier

@Deprecated(since="1.21",
            forRemoval=true)
public AttributeModifier(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String name,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation,
 @Nullable
 @Nullable EquipmentSlot slot)

Deprecated, for removal: This API element is subject to removal in a future version.

AttributeModifier

@Deprecated(since="1.21",
            forRemoval=true)
public AttributeModifier(@NotNull
 @NotNull UUID uuid,
 @NotNull
 @NotNull String name,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation,
 @NotNull
 @NotNull EquipmentSlotGroup slot)

Deprecated, for removal: This API element is subject to removal in a future version.

AttributeModifier

public AttributeModifier(@NotNull
 @NotNull NamespacedKey key,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation)

AttributeModifier

public AttributeModifier(@NotNull
 @NotNull NamespacedKey key,
 double amount,
 @NotNull
 @NotNull AttributeModifier.Operation operation,
 @NotNull
 @NotNull EquipmentSlotGroup slot)

Method Details

getUniqueId

@NotNull
@Deprecated(since="1.21",
            forRemoval=true)
public @NotNull UUID getUniqueId()

Deprecated, for removal: This API element is subject to removal in a future version.

attributes are now identified by keys

Get the unique ID for this modifier.

Returns:

unique id

See Also:

• getKey()

getKey

@NotNull
public @NotNull NamespacedKey getKey()

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

getName

@NotNull
public @NotNull String getName()

Get the name of this modifier.

Returns:

name

getAmount

public double getAmount()

Get the amount by which this modifier will apply its AttributeModifier.Operation.

Returns:

modification amount

getOperation

@NotNull
public @NotNull AttributeModifier.Operation getOperation()

Get the operation this modifier will apply.

Returns:

operation

getSlot

@Nullable
@Deprecated(since="1.20.5")
public @Nullable EquipmentSlot getSlot()

Deprecated.

use getSlotGroup()

Get the EquipmentSlot this AttributeModifier is active on, or null if this modifier is applicable for any slot.

Returns:

the slot

getSlotGroup

@NotNull
public @NotNull EquipmentSlotGroup getSlotGroup()

Get the EquipmentSlotGroup this AttributeModifier is active on.

Returns:

the slot

serialize

@NotNull
public @NotNull Map<String,Object> serialize()

Description copied from interface: ConfigurationSerializable

Creates a Map representation of this class.

This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs. nb: It is not intended for this method to be called directly, this will be called by the ConfigurationSerialization class.

Specified by:

serialize in interface ConfigurationSerializable

Returns:

Map containing the current state of this class

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

deserialize

@NotNull
public static @NotNull AttributeModifier deserialize(@NotNull
 @NotNull Map<String,Object> args)