eu.wauz.wauzcore.system.economy

Class WauzCurrency

java.lang.Object

eu.wauz.wauzcore.system.economy.WauzCurrency

public class WauzCurrency
extends java.lang.Object

A currency or reputation type, generated from a currency config file.

Author:

Wauzmons

See Also:

WauzCurrencyCategory

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<WauzCurrencyCategory>	currencyCategories A list of all currency categories.
private WauzCurrencyCategory	currencyCategory The category of the currency.
private java.lang.String	currencyConfigName The player config key of the faction's curreny.
private java.lang.String	currencyDisplayName The display name of the faction's curreny.
private static java.util.Map<java.lang.String,WauzCurrency>	currencyMap A map of currencies, indexed by name.
private java.lang.String	currencyName The name of the currency.

Constructor Summary

Constructors

Constructor and Description
WauzCurrency(java.lang.String currencyName) Constructs a global currency, without a category, with the given name.
WauzCurrency(WauzCurrencyCategory currencyCategory, java.lang.String currencyName) Constructs a currency, based on the currency file in the /WauzCore folder.

Method Summary

Modifier and Type	Method and Description
static WauzCurrency	getCurrency(java.lang.String currencyName)
long	getCurrencyAmount(org.bukkit.entity.Player player) Gets how much of the currency a specific player owns.
static java.util.List<WauzCurrencyCategory>	getCurrencyCategories()
WauzCurrencyCategory	getCurrencyCategory()
java.lang.String	getCurrencyConfigName()
java.lang.String	getCurrencyDisplayName()
java.lang.String	getCurrencyName()
static void	init() Initializes all currencies from the configs and fills the internal currency maps.
void	setCurrencyAmount(org.bukkit.entity.Player player, long amount) Sets how much of the currency a specific player owns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currencyMap

private static java.util.Map<java.lang.String,WauzCurrency> currencyMap

A map of currencies, indexed by name.

currencyCategories

private static java.util.List<WauzCurrencyCategory> currencyCategories

A list of all currency categories.

currencyCategory

private WauzCurrencyCategory currencyCategory

The category of the currency.

currencyName

private java.lang.String currencyName

The name of the currency.

currencyDisplayName

private java.lang.String currencyDisplayName

The display name of the faction's curreny.

currencyConfigName

private java.lang.String currencyConfigName

The player config key of the faction's curreny.

Constructor Detail

WauzCurrency

public WauzCurrency(WauzCurrencyCategory currencyCategory,
                    java.lang.String currencyName)

Constructs a currency, based on the currency file in the /WauzCore folder.

Parameters:

currencyCategory - The category of the currency.

currencyName - The name of the currency.

WauzCurrency

public WauzCurrency(java.lang.String currencyName)

Constructs a global currency, without a category, with the given name.

Parameters:

currencyName - The name of the currency.

Method Detail

init

public static void init()

Initializes all currencies from the configs and fills the internal currency maps.

See Also:

CurrencyConfigurator.getAllCurrencyCategoryKeys(), CurrencyConfigurator.getCurrencyFactionKeys(String)

getCurrency

public static WauzCurrency getCurrency(java.lang.String currencyName)

Parameters:

currencyName - A currency name.

Returns:

The currency with that name.

getCurrencyCategories

public static java.util.List<WauzCurrencyCategory> getCurrencyCategories()

Returns:

A list of all currency categories.

getCurrencyCategory

public WauzCurrencyCategory getCurrencyCategory()

Returns:

The category of the currency.

getCurrencyName

public java.lang.String getCurrencyName()

Returns:

The name of the currency.

getCurrencyDisplayName

public java.lang.String getCurrencyDisplayName()

Returns:

The display name of the faction's curreny.

getCurrencyConfigName

public java.lang.String getCurrencyConfigName()

Returns:

The player config key of the faction's curreny.

getCurrencyAmount

public long getCurrencyAmount(org.bukkit.entity.Player player)

Gets how much of the currency a specific player owns.

Parameters:

player - The player who owns the currency.

Returns:

The owned currency amount.

setCurrencyAmount

public void setCurrencyAmount(org.bukkit.entity.Player player,
                              long amount)

Sets how much of the currency a specific player owns.

Parameters:

player - The player who owns the currency.

amount - The new owned currency amount.