java.lang.Object

org.bukkit.attribute.AttributeModifier

All Implemented Interfaces:: 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(String name, double amount, AttributeModifier.Operation operation)

Deprecated.

AttributeModifier(UUID uuid, String name, double amount, AttributeModifier.Operation operation)

Deprecated.

AttributeModifier(UUID uuid, String name, double amount, AttributeModifier.Operation operation, EquipmentSlot slot)

Deprecated.

AttributeModifier(UUID uuid, String name, double amount, AttributeModifier.Operation operation, EquipmentSlotGroup slot)

Deprecated.

AttributeModifier(NamespacedKey key, double amount, AttributeModifier.Operation operation, EquipmentSlotGroup slot)
Method Summary

Modifier and Type

Method

Description

static AttributeModifier

deserialize(Map<String,Object> args)

boolean

equals(Object other)

double

getAmount()

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

NamespacedKey

getKey()

Return the namespaced identifier for this object.

String

getName()

Get the name of this modifier.

AttributeModifier.Operation

getOperation()

Get the operation this modifier will apply.

EquipmentSlot

getSlot()

Deprecated.
use getSlotGroup()

EquipmentSlotGroup

getSlotGroup()

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

UUID

getUniqueId()

Deprecated.
attributes are now identified by keys

int

hashCode()

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

Constructor Details
- AttributeModifier
  
  @Deprecated public AttributeModifier(@NotNull String name, double amount, @NotNull AttributeModifier.Operation operation)
  
  Deprecated.
- AttributeModifier
  
  @Deprecated public AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation)
  
  Deprecated.
- AttributeModifier
  
  @Deprecated public AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation, @Nullable EquipmentSlot slot)
  
  Deprecated.
- AttributeModifier
  
  @Deprecated public AttributeModifier(@NotNull UUID uuid, @NotNull String name, double amount, @NotNull AttributeModifier.Operation operation, @NotNull EquipmentSlotGroup slot)
  
  Deprecated.
- AttributeModifier
  
  public AttributeModifier(@NotNull NamespacedKey key, double amount, @NotNull AttributeModifier.Operation operation, @NotNull EquipmentSlotGroup slot)
Method Details
- getUniqueId
  
  @NotNull @Deprecated public UUID getUniqueId()
  
  Deprecated.
  attributes are now identified by keys
  
  Get the unique ID for this modifier.
  Returns:
  
  unique id
  
  See Also:
  
  getKey()
- getKey
  
  @NotNull public 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 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 AttributeModifier.Operation getOperation()
  
  Get the operation this modifier will apply.
  
  Returns:
  
  operation
- getSlot
  
  @Nullable @Deprecated public 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 EquipmentSlotGroup getSlotGroup()
  
  Get the EquipmentSlot this AttributeModifier is active on, or null if this modifier is applicable for any slot.
  
  Returns:
  
  the slot
- serialize
  
  @NotNull public 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.
  
  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 AttributeModifier deserialize(@NotNull Map<String,Object> args)

Class AttributeModifier

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

AttributeModifier

AttributeModifier

AttributeModifier

AttributeModifier

AttributeModifier

Method Details

getUniqueId

getKey

getName

getAmount

getOperation

getSlot

getSlotGroup

serialize

equals

hashCode

toString

deserialize