me.mrCookieSlime.CSCoreLibPlugin.currency

Class Currency

java.lang.Object

me.mrCookieSlime.CSCoreLibPlugin.currency.Currency

public class Currency
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Currency.TransactionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,Currency>	currencies

Constructor Summary

Constructors

Constructor and Description
Currency(org.bukkit.plugin.Plugin plugin, java.lang.String name, int digits, int startBalance) Creates a new Currency

Method Summary

Modifier and Type	Method and Description
void	addBalance(org.bukkit.entity.Player p, double amount) Adds to the Players Balance
void	addBalance(java.util.UUID uuid, double amount) Adds to the Players Balance
double	getBalance(org.bukkit.entity.Player p) Returns the Balance of a Player
double	getBalance(java.util.UUID uuid) Returns the Balance of a Player
static Currency	getByName(java.lang.String name) Returns a registered Currency with that Name
java.lang.String	getPriceTag(org.bukkit.entity.Player p, double cost) Automatically colors the specified Cost in green or red depending on whether the Player has enough Money or not
static java.util.Collection<Currency>	list() Returns all registered Currencies
boolean	purchase(org.bukkit.entity.Player p, double amount) Returns whether someone has enough Money to buy something If he does, the Balance will be removed automatically
void	registerTransactionHandler(Currency.TransactionHandler handler) Registers a Handler to be listening to an Event
void	removeBalance(org.bukkit.entity.Player p, double amount) Removes from the Players Balance
void	removeBalance(java.util.UUID uuid, double amount) Removes from the Players Balance
void	resetBalance(org.bukkit.entity.Player p) Resets the Players Balance
void	resetBalance(java.util.UUID uuid) Resets the Players Balance
void	setBalance(org.bukkit.entity.Player p, double balance) Sets the Balance of a Player to the specified Amount
void	setBalance(java.util.UUID uuid, double balance) Sets the Balance of a Player to the specified Amount

Methods inherited from class java.lang.Object

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

Field Detail

currencies

public static java.util.Map<java.lang.String,Currency> currencies

Constructor Detail

Currency

public Currency(org.bukkit.plugin.Plugin plugin,
                java.lang.String name,
                int digits,
                int startBalance)

Creates a new Currency

Parameters:

plugin - The Instance of the Plugin which this Currency is made for

name - The Name of this Currency

digits - How many digits an amount might have

startBalance - The Balance which every Player will start with

Method Detail

registerTransactionHandler

public void registerTransactionHandler(Currency.TransactionHandler handler)

Registers a Handler to be listening to an Event

Parameters:

handler - The Handler used upon a Players Balance changing

setBalance

public void setBalance(org.bukkit.entity.Player p,
                       double balance)

Sets the Balance of a Player to the specified Amount

Parameters:

p - The Player whose Balance will be set

balance - The new Balance for this Player

setBalance

public void setBalance(java.util.UUID uuid,
                       double balance)

Sets the Balance of a Player to the specified Amount

Parameters:

p - The Player whose Balance will be set

balance - The new Balance for this Player

getBalance

public double getBalance(org.bukkit.entity.Player p)

Returns the Balance of a Player

Parameters:

p - The Player whose Balance you want to get

Returns:

The Balance of that Player

getBalance

public double getBalance(java.util.UUID uuid)

Returns the Balance of a Player

Parameters:

p - The Player whose Balance you want to get

Returns:

The Balance of that Player

addBalance

public void addBalance(org.bukkit.entity.Player p,
                       double amount)

Adds to the Players Balance

Parameters:

p - The Player whose Balance will be modified

amount - The Amount which will be deposited

addBalance

public void addBalance(java.util.UUID uuid,
                       double amount)

Adds to the Players Balance

Parameters:

p - The Player whose Balance will be modified

amount - The Amount which will be deposited

removeBalance

public void removeBalance(org.bukkit.entity.Player p,
                          double amount)

Removes from the Players Balance

Parameters:

p - The Player whose Balance will be modified

amount - The Amount which will be withdrawn

removeBalance

public void removeBalance(java.util.UUID uuid,
                          double amount)

Removes from the Players Balance

Parameters:

p - The Player whose Balance will be modified

amount - The Amount which will be withdrawn

resetBalance

public void resetBalance(org.bukkit.entity.Player p)

Resets the Players Balance

Parameters:

p - The Player whose Balance will be reset

resetBalance

public void resetBalance(java.util.UUID uuid)

Resets the Players Balance

Parameters:

p - The Player whose Balance will be reset

purchase

public boolean purchase(org.bukkit.entity.Player p,
                        double amount)

Returns whether someone has enough Money to buy something If he does, the Balance will be removed automatically

Parameters:

p - The Player whose Balance you want to check

amount - The Amount the Player should at least have

Returns:

Whether he does have enough Money or not

getPriceTag

public java.lang.String getPriceTag(org.bukkit.entity.Player p,
                                    double cost)

Automatically colors the specified Cost in green or red depending on whether the Player has enough Money or not

Parameters:

p - The Player whose Balance you want to check

cost - The Amount the Player should at least have

Returns:

A colored String indicating sufficient funds

getByName

public static Currency getByName(java.lang.String name)

Returns a registered Currency with that Name

Parameters:

name - The Name of the Currency you are looking for

Returns:

The Currency registered with that Name

list

public static java.util.Collection<Currency> list()

Returns all registered Currencies

Returns:

All registered Currencies