Economy (Vault)

```
public interface Economy
```
The main economy API

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EconomyResponse`	`bankBalance(String name)` Returns the amount the bank has
`EconomyResponse`	`bankDeposit(String name, double amount)` Deposit an amount into a bank account - DO NOT USE NEGATIVE AMOUNTS
`EconomyResponse`	`bankHas(String name, double amount)` Returns true or false whether the bank has the amount specified - DO NOT USE NEGATIVE AMOUNTS
`EconomyResponse`	`bankWithdraw(String name, double amount)` Withdraw an amount from a bank account - DO NOT USE NEGATIVE AMOUNTS
`EconomyResponse`	`createBank(String name, String player)` Creates a bank account with the specified name and the player as the owner
`boolean`	`createPlayerAccount(String playerName)` Attempts to create a player account for the given player
`boolean`	`createPlayerAccount(String playerName, String worldName)` Attempts to create a player account for the given player on the specified world IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
`String`	`currencyNamePlural()` Returns the name of the currency in plural form.
`String`	`currencyNameSingular()` Returns the name of the currency in singular form.
`EconomyResponse`	`deleteBank(String name)` Deletes a bank account with the specified name.
`EconomyResponse`	`depositPlayer(String playerName, double amount)` Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS
`EconomyResponse`	`depositPlayer(String playerName, String worldName, double amount)` Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
`String`	`format(double amount)` Format amount into a human readable String This provides translation into economy specific formatting to improve consistency between plugins.
`int`	`fractionalDigits()` Some economy plugins round off after a certain number of digits.
`double`	`getBalance(String playerName)` Gets balance of a player
`double`	`getBalance(String playerName, String world)` Gets balance of a player on the specified world.
`List<String>`	`getBanks()` Gets the list of banks
`String`	`getName()` Gets name of economy method
`boolean`	`has(String playerName, double amount)` Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS
`boolean`	`has(String playerName, String worldName, double amount)` Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
`boolean`	`hasAccount(String playerName)` Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
`boolean`	`hasAccount(String playerName, String worldName)` Checks if this player has an account on the server yet on the given world This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
`boolean`	`hasBankSupport()` Returns true if the given implementation supports banks.
`EconomyResponse`	`isBankMember(String name, String playerName)` Check if the player is a member of the bank account
`EconomyResponse`	`isBankOwner(String name, String playerName)` Check if a player is the owner of a bank account
`boolean`	`isEnabled()` Checks if economy method is enabled.
`EconomyResponse`	`withdrawPlayer(String playerName, double amount)` Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS
`EconomyResponse`	`withdrawPlayer(String playerName, String worldName, double amount)` Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.

- Method Detail
  - isEnabled
```
boolean isEnabled()
```
    Checks if economy method is enabled.
    
    Returns:
    
    Success or Failure
  - getName
```
String getName()
```
    Gets name of economy method
    
    Returns:
    
    Name of Ecoomy Method
  - hasBankSupport
```
boolean hasBankSupport()
```
    Returns true if the given implementation supports banks.
    
    Returns:
    
    true if the implementation supports banks
  - fractionalDigits
```
int fractionalDigits()
```
    Some economy plugins round off after a certain number of digits. This function returns the number of digits the plugin keeps or -1 if no rounding occurs.
    
    Returns:
    
    number of digits after the decimal point kept
  - format
```
String format(double amount)
```
    Format amount into a human readable String This provides translation into economy specific formatting to improve consistency between plugins.
    
    Parameters:
    
    amount - to format
    
    Returns:
    
    Human readable string describing amount
  - currencyNamePlural
```
String currencyNamePlural()
```
    Returns the name of the currency in plural form. If the economy being used does not support currency names then an empty string will be returned.
    
    Returns:
    
    name of the currency (plural)
  - currencyNameSingular
```
String currencyNameSingular()
```
    Returns the name of the currency in singular form. If the economy being used does not support currency names then an empty string will be returned.
    
    Returns:
    
    name of the currency (singular)
  - hasAccount
```
boolean hasAccount(String playerName)
```
    Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
    
    Parameters:
    
    playerName - to check
    
    Returns:
    
    if the player has an account
  - hasAccount
```
boolean hasAccount(String playerName,
                   String worldName)
```
    Checks if this player has an account on the server yet on the given world This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
    
    Parameters:
    
    playerName - to check in the world
    
    worldName - world-specific account
    
    Returns:
    
    if the player has an account
  - getBalance
```
double getBalance(String playerName)
```
    Gets balance of a player
    
    Parameters:
    
    playerName - of the player
    
    Returns:
    
    Amount currently held in players account
  - getBalance
```
double getBalance(String playerName,
                  String world)
```
    Gets balance of a player on the specified world. IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
    
    Parameters:
    
    playerName -
    
    world - name of the world
    
    Returns:
    
    Amount currently held in players account
  - has
```
boolean has(String playerName,
            double amount)
```
    Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    playerName - to check
    
    amount - to check for
    
    Returns:
    
    True if playerName has amount, False else wise
  - has
```
boolean has(String playerName,
            String worldName,
            double amount)
```
    Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
    
    Parameters:
    
    playerName - to check
    
    worldName - to check with
    
    amount - to check for
    
    Returns:
    
    True if playerName has amount, False else wise
  - withdrawPlayer
```
EconomyResponse withdrawPlayer(String playerName,
                               double amount)
```
    Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    playerName - Name of player
    
    amount - Amount to withdraw
    
    Returns:
    
    Detailed response of transaction
  - withdrawPlayer
```
EconomyResponse withdrawPlayer(String playerName,
                               String worldName,
                               double amount)
```
    Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
    
    Parameters:
    
    playerName - Name of player
    
    worldName - - name of the world
    
    amount - Amount to withdraw
    
    Returns:
    
    Detailed response of transaction
  - depositPlayer
```
EconomyResponse depositPlayer(String playerName,
                              double amount)
```
    Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    playerName - Name of player
    
    amount - Amount to deposit
    
    Returns:
    
    Detailed response of transaction
  - depositPlayer
```
EconomyResponse depositPlayer(String playerName,
                              String worldName,
                              double amount)
```
    Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
    
    Parameters:
    
    playerName - Name of player
    
    amount - Amount to deposit
    
    Returns:
    
    Detailed response of transaction
  - createBank
```
EconomyResponse createBank(String name,
                           String player)
```
    Creates a bank account with the specified name and the player as the owner
    
    Parameters:
    
    name - of account
    
    player - the account should be linked to
    
    Returns:
    
    EconomyResponse Object
  - deleteBank
```
EconomyResponse deleteBank(String name)
```
    Deletes a bank account with the specified name.
    
    Parameters:
    
    name - of the back to delete
    
    Returns:
    
    if the operation completed successfully
  - bankBalance
```
EconomyResponse bankBalance(String name)
```
    Returns the amount the bank has
    
    Parameters:
    
    name - of the account
    
    Returns:
    
    EconomyResponse Object
  - bankHas
```
EconomyResponse bankHas(String name,
                        double amount)
```
    Returns true or false whether the bank has the amount specified - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    name - of the account
    
    amount - to check for
    
    Returns:
    
    EconomyResponse Object
  - bankWithdraw
```
EconomyResponse bankWithdraw(String name,
                             double amount)
```
    Withdraw an amount from a bank account - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    name - of the account
    
    amount - to withdraw
    
    Returns:
    
    EconomyResponse Object
  - bankDeposit
```
EconomyResponse bankDeposit(String name,
                            double amount)
```
    Deposit an amount into a bank account - DO NOT USE NEGATIVE AMOUNTS
    
    Parameters:
    
    name - of the account
    
    amount - to deposit
    
    Returns:
    
    EconomyResponse Object
  - isBankOwner
```
EconomyResponse isBankOwner(String name,
                            String playerName)
```
    Check if a player is the owner of a bank account
    
    Parameters:
    
    name - of the account
    
    playerName - to check for ownership
    
    Returns:
    
    EconomyResponse Object
  - isBankMember
```
EconomyResponse isBankMember(String name,
                             String playerName)
```
    Check if the player is a member of the bank account
    
    Parameters:
    
    name - of the account
    
    playerName - to check membership
    
    Returns:
    
    EconomyResponse Object
  - getBanks
```
List<String> getBanks()
```
    Gets the list of banks
    
    Returns:
    
    the List of Banks
  - createPlayerAccount
```
boolean createPlayerAccount(String playerName)
```
    Attempts to create a player account for the given player
    
    Returns:
    
    if the account creation was successful
  - createPlayerAccount
```
boolean createPlayerAccount(String playerName,
                            String worldName)
```
    Attempts to create a player account for the given player on the specified world IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
    
    Returns:
    
    if the account creation was successful

Interface Economy

Method Summary

Method Detail

isEnabled

getName

hasBankSupport

fractionalDigits

format

currencyNamePlural

currencyNameSingular

hasAccount

hasAccount

getBalance

getBalance

has

has

withdrawPlayer

withdrawPlayer

depositPlayer

depositPlayer

createBank

deleteBank

bankBalance

bankHas

bankWithdraw

bankDeposit

isBankOwner

isBankMember

getBanks

createPlayerAccount

createPlayerAccount