Interface EconomyData

All Superinterfaces:
EconomyDataGetter

public interface EconomyData extends EconomyDataGetter
Contains all economy data of a Claim.
  • Method Details

    • setRentSignPosition

      void setRentSignPosition(@Nullable com.flowpowered.math.vector.Vector3i pos)
      Sets the sign position of claim being rented.
      Parameters:
      pos - The rent sign pos
    • setRentSignPosition

      void setRentSignPosition(int x, int y, int z)
      Sets the sign position of claim being rented.
      Parameters:
      x - The x pos
      y - The y pos
      z - The z pos
    • setSaleSignPosition

      void setSaleSignPosition(@Nullable com.flowpowered.math.vector.Vector3i pos)
      Sets the sign position of claim being sold.
      Parameters:
      pos - The sell sign pos
    • setSaleSignPosition

      void setSaleSignPosition(int x, int y, int z)
      Sets the sign position of claim being sold.
      Parameters:
      x - The x pos
      y - The y pos
      z - The z pos
    • setRentBalance

      void setRentBalance(UUID uuid, double balance)
      Sets the rent balance of User.
      Parameters:
      uuid - The user uuid
      balance - The new rent balance
    • setRentBreakAbility

      void setRentBreakAbility(boolean breakAbility)
      Sets whether renters or rental trusted users have the ability to break owner blocks in Claim.
      Parameters:
      breakAbility -
    • clearPaymentTransactions

      void clearPaymentTransactions(TransactionType type)
      Clears the payment transactions.
      Parameters:
      type - The payment transaction type
    • setPaymentType

      void setPaymentType(PaymentType type)
      Sets the {link PaymentType}.
      Parameters:
      type - The payment type
    • setRentMinTime

      void setRentMinTime(int min)
      Sets the minimum time to rent. Note: The time is based on EconomyDataGetter.getPaymentType().
      Parameters:
      min - The min rent time
    • setRentMaxTime

      void setRentMaxTime(int max)
      Sets the maximum time to rent. Note: The time is based on EconomyDataGetter.getPaymentType().
      Parameters:
      max - The max rent time
    • setRentPastDueDate

      void setRentPastDueDate(@Nullable Instant date)
      Sets the new rent past due date.
      Parameters:
      date - The new date
    • setRentStartDate

      void setRentStartDate(@Nullable Instant date)
      Sets the rent start date.
      Parameters:
      date - The start date
    • setRentEndDate

      void setRentEndDate(@Nullable Instant date)
      Sets the rent end date. Note: If set, renters may rent until end date. Once end date is reached, the claim will no longer be rentable.
      Parameters:
      date - The end date
    • setRentRate

      void setRentRate(double rate)
      Sets a rent rate for Claim.
      Parameters:
      rate -
    • setRentStripNbt

      void setRentStripNbt(boolean stripNbt)
      Sets whether a rented claim will strip all block NBT data on restore. Note: This is only used when a rented claim is restored on rental end.
      Parameters:
      stripNbt -
    • setSaleEndDate

      void setSaleEndDate(@Nullable Instant date)
      Sets the sale end date. Note: The claim will no longer be for sale when end date is reached.
      Parameters:
      date - The end date
    • setSalePrice

      void setSalePrice(double price)
      Sets a sale price for Claim.
      Parameters:
      price - The sale price
    • setForRent

      void setForRent(boolean forRent)
      Enables or disables the rental of Claim.
      Parameters:
      forRent - true to enable, false to disable
    • setForSale

      void setForSale(boolean forSale)
      Enables or disables the sale of Claim.
      Parameters:
      forSale - true to enable, false to disable
    • setTaxBalance

      void setTaxBalance(double balance)
      Sets the tax balance of Claim.
      Parameters:
      balance - The new tax balance
    • setTaxPastDueDate

      void setTaxPastDueDate(@Nullable Instant date)
      Sets the new tax past due date.
      Parameters:
      date - The new date
    • addPaymentTransaction

      void addPaymentTransaction(PaymentTransaction transaction)
      Adds a payment transaction to the Claim log.
      Parameters:
      transaction - The payment transaction
    • builder

      static EconomyData.Builder builder()
      Gets a new economy data builder instance for EconomyData.Builder.
      Returns:
      A new economy data builder instance