Record Class AttributeModifier

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.data.attribute.AttributeModifier
Record Components:
key - The unique identifier for this specific modifier.
amount - The numeric value to apply as a modifier.
operation - The arithmetic operation logic to apply to the base value.
public record AttributeModifier(net.kyori.adventure.key.Key key, double amount, org.bukkit.attribute.AttributeModifier.Operation operation) extends Record
Represents a modifier applied to an attribute's base value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributeModifier(net.kyori.adventure.key.Key key, double amount, org.bukkit.attribute.AttributeModifier.Operation operation)
    Constructs a new attribute modifier.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    amount()
    Retrieves the raw numeric value associated with this modifier.
    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.
    net.kyori.adventure.key.Key
    key()
    Retrieves the unique identifier of this modifier.
    org.bukkit.attribute.AttributeModifier.Operation
    operation()
    Retrieves the specific arithmetic operation performed by this modifier.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AttributeModifier

      public AttributeModifier(net.kyori.adventure.key.Key key, double amount, org.bukkit.attribute.AttributeModifier.Operation operation)
      Constructs a new attribute modifier.
      Parameters:
      key - The unique key identifying this modifier.
      amount - The numeric value to apply.
      operation - The AttributeModifier.Operation defining how the value interacts with the base.

  • Method Details

    • key

      public net.kyori.adventure.key.Key key()
      Retrieves the unique identifier of this modifier.
      Returns:
      The modifier key.

    • amount

      public double amount()
      Retrieves the raw numeric value associated with this modifier.
      Returns:
      The modifier amount.

    • operation

      public org.bukkit.attribute.AttributeModifier.Operation operation()
      Retrieves the specific arithmetic operation performed by this modifier.
      Returns:
      The AttributeModifier.Operation representing the calculation type.

    • 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.