Currency (Magic API 10.2 API)

All Superinterfaces:

MagicProvider
```
public interface Currency
extends MagicProvider
```
Register via MageController.register()

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`deduct(Mage mage, CasterProperties caster, double amount)` Deduct some currency from the specified Mage
`default void`	`deduct(Mage mage, double amount)`
`String`	`formatAmount(double amount, Messages messages)` Get a human-readable description of an amount of this currency.
`default double`	`getBalance(Mage mage)`
`double`	`getBalance(Mage mage, CasterProperties caster)` Get the amount of this currency type a Mage has.
`double`	`getDefaultValue()` Get the default value for this currency.
`MaterialAndData`	`getIcon()` Get an icon to use to represent this currency as a physical item.
`String`	`getKey()` Each currency must have a unique key name, used to register.
`double`	`getMaxValue()` Get the maximum value for this currency.
`default double`	`getMinValue()` Get the minimum value for this currency.
`String`	`getName(Messages messages)` Get a human-readable description of this currency.
`default String`	`getShortName(Messages messages)`
`default String`	`getSingularName(Messages messages)`
`double`	`getWorth()` Get the relative worth of this currency.
`boolean`	`give(Mage mage, CasterProperties caster, double amount)` Give some currency to the specified Mage
`default boolean`	`give(Mage mage, double amount)`
`boolean`	`has(Mage mage, CasterProperties caster, double amount)` Whether or not a mage has at least a certain amount of this currency.
`default boolean`	`has(Mage mage, double amount)`
`boolean`	`hasMaxValue()` Check to see if this currency has an upper limit for player balances.
`default boolean`	`hasMinValue()` Check to see if this currency has a lower limit for player balances.
`boolean`	`isValid()` Check to see if this currency is valid.

- Method Detail
  - getKey
```
@Nonnull
String getKey()
```
    Each currency must have a unique key name, used to register. This will be the key used in all configs and /mgive commands.
    
    Returns:
    
    the key name of this currency.
  - getBalance
```
double getBalance(Mage mage,
                  CasterProperties caster)
```
    Get the amount of this currency type a Mage has.
    
    Parameters:
    
    mage - The mage to check
    
    caster - A optional caster, to be used for wand or class-specific costs (such as mana)
    
    Returns:
    
    the amount of this cost type the Mage has.
  - getBalance
```
default double getBalance(Mage mage)
```
  - has
```
boolean has(Mage mage,
            CasterProperties caster,
            double amount)
```
    Whether or not a mage has at least a certain amount of this currency.
    
    Parameters:
    
    mage - The mage to check for costs
    
    caster - A optional wand or mage class, to be used for mana or other specific currencies
    
    amount - The amount of currency required.
    
    Returns:
    
    True if the mage has these costs.
  - has
```
default boolean has(Mage mage,
                    double amount)
```
  - deduct
```
void deduct(Mage mage,
            CasterProperties caster,
            double amount)
```
    Deduct some currency from the specified Mage
    
    Parameters:
    
    mage - The mage to check for costs
    
    caster - A optional caster, to be used for mana costs
    
    amount - The amount of currency to deduct.
  - deduct
```
default void deduct(Mage mage,
                    double amount)
```
  - give
```
boolean give(Mage mage,
             CasterProperties caster,
             double amount)
```
    Give some currency to the specified Mage
    
    Parameters:
    
    mage - The mage to give these costs to
    
    caster - A optional caster, to be used for mana costs
    
    amount - The amount of currency to give.
    
    Returns:
    
    false if the costs could not be given (e.g. mage is at max already)
  - give
```
default boolean give(Mage mage,
                     double amount)
```
  - getDefaultValue
```
double getDefaultValue()
```
    Get the default value for this currency. This will be used to initialize a player's balance.
    
    Returns:
    
    the default value of this currency.
  - hasMaxValue
```
boolean hasMaxValue()
```
    Check to see if this currency has an upper limit for player balances.
    
    Returns:
    
    true if this currency should be limited
  - getMaxValue
```
double getMaxValue()
```
    Get the maximum value for this currency. Player balances will be capped to this value. Only has an effect if @hasMaxValue returns true.
    
    Returns:
    
    The maximum limit for player balances of this currency
  - hasMinValue
```
default boolean hasMinValue()
```
    Check to see if this currency has a lower limit for player balances.
    
    Returns:
    
    true if this currency should be limited, typically to prevent negative balances.
  - getMinValue
```
default double getMinValue()
```
    Get the minimum value for this currency. Player balances will be capped to this value. Only has an effect if @hasMinValue returns true.
    
    Returns:
    
    The minimum for player balances of this currency, typically 0 if set
  - getIcon
```
@Nullable
MaterialAndData getIcon()
```
    Get an icon to use to represent this currency as a physical item. This is used in commands such as /mgive sp:100
    
    Returns:
    
    The icon to use representing this currency as an item
  - getWorth
```
double getWorth()
```
    Get the relative worth of this currency. This is used for automatic currency conversions. Most currencies weight their worth in terms of virtual currency (e.g. Vault), so if a currency returns 10 it is worth 10x standard virtual currency.
    
    Returns:
    
    The value of this currency relative to vault currency
  - getName
```
@Nonnull
String getName(Messages messages)
```
    Get a human-readable description of this currency.
    This does not include the amount, and only the label - e.g. "Bread" or "Mana" or "XP".
    
    Parameters:
    
    messages - The Messages class for looking up localizations
    
    Returns:
    
    A printable String to display this currency name to a Player.
  - getSingularName
```
@Nonnull
default String getSingularName(Messages messages)
```
  - getShortName
```
@Nonnull
default String getShortName(Messages messages)
```
  - formatAmount
```
@Nonnull
String formatAmount(double amount,
                             Messages messages)
```
    Get a human-readable description of an amount of this currency.
    This includes the amount as well as the label - e.g. "2 Bread" or "30 Mana" or "50 XP".
    
    Parameters:
    
    amount - The amount
    
    messages - The Messages class for looking up localizations
    
    Returns:
    
    A printable String to display this currency amount to a Player.
  - isValid
```
boolean isValid()
```
    Check to see if this currency is valid.
    This can be used if disabling currency, or providing a currency that may rely on some other dependency.
    
    Returns:
    
    true if this currency is valid

Interface Currency

Method Summary

Method Detail

getKey

getBalance

getBalance

has

has

deduct

deduct

give

give

getDefaultValue

hasMaxValue

getMaxValue

hasMinValue

getMinValue

getIcon

getWorth

getName

getSingularName

getShortName

formatAmount

isValid