com.codelanx.codelanxlib.econ

Class CEconomy

java.lang.Object

java.util.Observable

com.codelanx.codelanxlib.econ.CEconomy

public class CEconomy
extends Observable

Represents an observable façade class for Vault's Economy object

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected Lang	format The Lang format to use for output

Constructor Summary

Constructors

Constructor and Description
CEconomy(org.bukkit.plugin.Plugin plugin) Constructor.

Method Summary

Modifier and Type	Method and Description
double	bonusRate() Represents a rate that is multiplied to money given through the pay(Player, double) method.
ChargeStatus	canCharge(org.bukkit.entity.Player p, Config value) Returns whether or not a specific Player can be charged an amount
ChargeStatus	canCharge(org.bukkit.entity.Player p, double cost) Returns whether or not a specific Player can be charged an amount
boolean	charge(org.bukkit.entity.Player p, Config value) Takes money away from the Player
boolean	charge(org.bukkit.entity.Player p, double cost) Takes money away from the Player
double	getBalance(org.bukkit.entity.Player p) Returns the relevant balance for the Player
protected net.milkbowl.vault.economy.Economy	getEconomy() Returns the underlying Economy object that is backed by a VaultProxy InvocationHandler
boolean	isEnabled() Returns whether or not the Economy object could be retrieved from Vault
void	notifyObservers(Object arg) Modified to send a Bukkit event and force notification of the change
boolean	pay(org.bukkit.entity.Player p, Config value) Gives money to the Player
boolean	pay(org.bukkit.entity.Player p, double amount) Gives money to the Player
protected void	setChanged()
double	taxRate() Represents a rate that is multiplied to money taken through the charge(Player, double) method.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers

Methods inherited from class java.lang.Object

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

Field Detail

format

protected final Lang format

The Lang format to use for output

Constructor Detail

CEconomy

public CEconomy(org.bukkit.plugin.Plugin plugin)

Constructor. Will check if the Vault Economy class is proxied and if not, then it will manually call for it to be proxied.

Parameters:

plugin - The Plugin that instantiated this class

Method Detail

canCharge

public ChargeStatus canCharge(org.bukkit.entity.Player p,
                              Config value)

Returns whether or not a specific Player can be charged an amount

Parameters:

p - The Player to charge

value - A Config double value representing how much to take

Returns:

A ChargeStatus representing the total cost and the status of whether or not the Player can be charged. If isEnabled() returns false, this will be a ChargeStatus of true with a returned cost of 0

Since:

0.0.1

canCharge

public ChargeStatus canCharge(org.bukkit.entity.Player p,
                              double cost)

Returns whether or not a specific Player can be charged an amount

Parameters:

p - The Player to charge

cost - The amount to charge

Returns:

A ChargeStatus representing the total cost and the status of whether or not the Player can be charged. If isEnabled() returns false, this will be a ChargeStatus of true with a returned cost of 0

Since:

0.0.1

charge

public boolean charge(org.bukkit.entity.Player p,
                      Config value)

Takes money away from the Player

Parameters:

p - The Player to take from

value - A Config double value representing how much to take

Returns:

true if the money was successfully taken, or if isEnabled() returns false

Since:

0.0.1

charge

public boolean charge(org.bukkit.entity.Player p,
                      double cost)

Takes money away from the Player

Parameters:

p - The Player to take money from

cost - The amount of money to take

Returns:

true if the money was successfully taken, or if isEnabled() returns false

Since:

0.0.1

pay

public boolean pay(org.bukkit.entity.Player p,
                   Config value)

Gives money to the Player

Parameters:

p - The Player to give money to

value - A Config double value representing how much to give

Returns:

true if the money was deposited successfully, or if isEnabled() returns false

Since:

0.1.0

pay

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

Gives money to the Player

Parameters:

p - The Player to give money to

amount - The amount of money to give

Returns:

true if the money was deposited successfully, or if isEnabled() returns false

Since:

0.0.1

notifyObservers

public void notifyObservers(Object arg)

Modified to send a Bukkit event and force notification of the change

Overrides:

notifyObservers in class Observable

Parameters:

arg - An EconomyChangePacket

Since:

0.0.1

setChanged

protected void setChanged()

Overrides:

setChanged in class Observable

getBalance

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

Returns the relevant balance for the Player

Parameters:

p - The Player for which the balanced is checked

Returns:

The player's balance, or -1 if isEnabled() returns false

Since:

0.0.1

isEnabled

public final boolean isEnabled()

Returns whether or not the Economy object could be retrieved from Vault

Returns:

false if the Economy object is null

Since:

0.0.1

getEconomy

protected final net.milkbowl.vault.economy.Economy getEconomy()

Returns the underlying Economy object that is backed by a VaultProxy InvocationHandler

Returns:

The underlying Economy object

Since:

0.0.1

taxRate

public double taxRate()

Represents a rate that is multiplied to money taken through the charge(Player, double) method. This method is purposely overridable to allow for people to specify their own rates. Values that are negative or zero will be automatically converted to 1.

Returns:

The rate at which given money is multiplied

Since:

0.1.0

bonusRate

public double bonusRate()

Represents a rate that is multiplied to money given through the pay(Player, double) method. This method is purposely overridable to allow for people to specify their own rates. Values that are negative or zero will be automatically converted to 1.

Returns:

The rate at which given money is multiplied

Since:

0.1.0