Package fr.maxlego08.zauctionhouse.api.economy

Interface AuctionEconomy

public interface AuctionEconomy

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    depositMoney(org.bukkit.OfflinePlayer offlinePlayer, long value)
    Deposits money into a player's account.
    default String
    format(String priceAsString, long amount)
    Formats a price string according to the economy's currency format.
    String
    getCurrency()
    Gets the currency symbol or name used in the economy.
    String
    getDenyMessage()
    Gets the message sent when a player does not have enough money.
    String
    getFormat()
    Gets the format used for displaying prices in the sales command.
    long
    getMoney(org.bukkit.OfflinePlayer offlinePlayer)
    Retrieves the player's balance.
    String
    getName()
    Gets the name of the economy system.
    boolean
    hasMoney(org.bukkit.OfflinePlayer offlinePlayer, long price)
    Checks if a player has enough money.
    void
    withdrawMoney(org.bukkit.OfflinePlayer offlinePlayer, long value)
    Withdraws money from a player's account.

  • Method Details

    • getMoney

      long getMoney(org.bukkit.OfflinePlayer offlinePlayer)
      Retrieves the player's balance.
      Parameters:
      offlinePlayer - the player whose balance is to be retrieved.
      Returns:
      the player's balance as a long.

    • hasMoney

      boolean hasMoney(org.bukkit.OfflinePlayer offlinePlayer, long price)
      Checks if a player has enough money.
      Parameters:
      offlinePlayer - the player whose balance is to be checked.
      price - the amount of money required.
      Returns:
      true if the player has enough money, false otherwise.

    • depositMoney

      void depositMoney(org.bukkit.OfflinePlayer offlinePlayer, long value)
      Deposits money into a player's account.
      Parameters:
      offlinePlayer - the player whose account will receive the money.
      value - the amount of money to deposit.

    • withdrawMoney

      void withdrawMoney(org.bukkit.OfflinePlayer offlinePlayer, long value)
      Withdraws money from a player's account.
      Parameters:
      offlinePlayer - the player whose account will be debited.
      value - the amount of money to withdraw.

    • getCurrency

      String getCurrency()
      Gets the currency symbol or name used in the economy. This is used for display purposes in messages and inventories.
      Returns:
      the currency as a string.

    • getFormat

      String getFormat()
      Gets the format used for displaying prices in the sales command.
      Returns:
      the format string.

    • getDenyMessage

      String getDenyMessage()
      Gets the message sent when a player does not have enough money.
      Returns:
      the deny message as a string.

    • getName

      String getName()
      Gets the name of the economy system.
      Returns:
      the name of the economy as a string.

    • format

      default String format(String priceAsString, long amount)
      Formats a price string according to the economy's currency format.
      Parameters:
      priceAsString - the price as a string.
      amount - the amount of the item being formatted.
      Returns:
      the formatted price string.