Record Class UpgradeIntegerModifier

java.lang.Object
java.lang.Record
de.Keyle.MyPet.api.skill.modifier.UpgradeIntegerModifier
Record Components:
value - the integer amount to add or subtract
type - the operation to perform (UpgradeNumberModifier.Type.Add or UpgradeNumberModifier.Type.Subtract)
All Implemented Interfaces:
UpgradeModifier<Integer>

public record UpgradeIntegerModifier(Integer value, UpgradeNumberModifier.Type type) extends Record implements UpgradeModifier<Integer>
An UpgradeModifier for integer-typed skill parameters.

Supports addition and subtraction. This is the integer-specific counterpart of UpgradeNumberModifier and is preferred when the skill parameter is known to be a whole number (e.g., beacon range in blocks, backpack row count).

  • Constructor Details

    • UpgradeIntegerModifier

      public UpgradeIntegerModifier(Integer value, UpgradeNumberModifier.Type type)
      Creates an instance of a UpgradeIntegerModifier record class.
      Parameters:
      value - the value for the value record component
      type - the value for the type record component
  • Method Details

    • modify

      public Integer modify(Integer n)
      Applies this modifier to the given current value, producing an updated result.

      Adds or subtracts this modifier's value from the given current integer, depending on the configured UpgradeNumberModifier.Type.

      Specified by:
      modify in interface UpgradeModifier<Integer>
      Parameters:
      n - the current parameter value before modification
      Returns:
      the modified parameter value
    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • value

      public Integer value()
      Returns the value of the value record component.
      Specified by:
      value in interface UpgradeModifier<Integer>
      Returns:
      the value of the value record component
    • type

      Returns the value of the type record component.
      Returns:
      the value of the type record component