Package dev.drawethree.xprison.api.multipliers.model

Interface Multiplier

All Known Subinterfaces:
PlayerMultiplier
public interface Multiplier
Represents a multiplier that can affect various aspects such as sell price or tokens.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMultiplier(double addition)
    Adds a value to the current multiplier.
    Date
    getEndDate()
    Gets the date when the multiplier ends.
    double
    getMultiplier()
    Gets the current multiplier value.
    boolean
    isActive()
    Checks if the multiplier is currently active.
    void
    reset()
    Resets the multiplier to its default state.
    void
    setMultiplier(double newValue)
    Sets the multiplier to a new value.

  • Method Details

    • getMultiplier

      double getMultiplier()
      Gets the current multiplier value.
      Returns:
      the multiplier value

    • setMultiplier

      void setMultiplier(double newValue)
      Sets the multiplier to a new value.
      Parameters:
      newValue - the new multiplier value to set

    • addMultiplier

      void addMultiplier(double addition)
      Adds a value to the current multiplier.
      Parameters:
      addition - the value to add to the multiplier

    • isActive

      boolean isActive()
      Checks if the multiplier is currently active.
      Returns:
      true if active, false otherwise

    • reset

      void reset()
      Resets the multiplier to its default state.

    • getEndDate

      Date getEndDate()
      Gets the date when the multiplier ends.
      Returns:
      the end date of the multiplier