New Groups code, supports groups.yml file, gm and vault, new economy api.

1 files changed, 231 insertions, 0 deletions

diff --git a/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java b/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java
new file mode 100644
index 000000000..0aeb7bdc9
--- /dev/null
+++ b/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java
@@ -0,0 +1,231 @@
+package com.earth2me.essentials.api;
+
+import com.earth2me.essentials.Util;
+
+
+/**
+ * Instead of using this api directly, we recommend to use the register plugin:
+ * http://bit.ly/RegisterMethod
+ */
+public final class Economy
+{
+	private Economy()
+	{
+	}
+	private static IEssentials ess;
+	private static final String noCallBeforeLoad = "Essentials API is called before Essentials is loaded.";
+
+	/**
+	 * Returns the balance of a user
+	 * @param name Name of the user
+	 * @return balance
+	 * @throws UserDoesNotExistException 
+	 */
+	public static double getMoney(String name) throws UserDoesNotExistException
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		return ess.getEconomy().getMoney(name);
+	}
+
+	/**
+	 * Sets the balance of a user
+	 * @param name Name of the user
+	 * @param balance The balance you want to set
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void setMoney(String name, double balance) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		ess.getEconomy().setMoney(name, balance);
+	}
+
+	/**
+	 * Adds money to the balance of a user
+	 * @param name Name of the user
+	 * @param amount The money you want to add
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void add(String name, double amount) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		double result = getMoney(name) + amount;
+		setMoney(name, result);
+	}
+
+	/**
+	 * Substracts money from the balance of a user
+	 * @param name Name of the user
+	 * @param amount The money you want to substract
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void subtract(String name, double amount) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		double result = getMoney(name) - amount;
+		setMoney(name, result);
+	}
+
+	/**
+	 * Divides the balance of a user by a value
+	 * @param name Name of the user
+	 * @param value The balance is divided by this value
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void divide(String name, double value) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		double result = getMoney(name) / value;
+		setMoney(name, result);
+	}
+
+	/**
+	 * Multiplies the balance of a user by a value
+	 * @param name Name of the user
+	 * @param value The balance is multiplied by this value
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void multiply(String name, double value) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		double result = getMoney(name) * value;
+		setMoney(name, result);
+	}
+
+	/**
+	 * Resets the balance of a user to the starting balance
+	 * @param name Name of the user
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 * @throws NoLoanPermittedException If the user is not allowed to have a negative balance
+	 */
+	public static void resetBalance(String name) throws UserDoesNotExistException, NoLoanPermittedException
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		ess.getEconomy().resetBalance(name);
+	}
+
+	/**
+	 * @param name Name of the user
+	 * @param amount The amount of money the user should have
+	 * @return true, if the user has more or an equal amount of money
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 */
+	public static boolean hasEnough(String name, double amount) throws UserDoesNotExistException
+	{
+		return amount <= getMoney(name);
+	}
+
+	/**
+	 * @param name Name of the user
+	 * @param amount The amount of money the user should have
+	 * @return true, if the user has more money
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 */
+	public static boolean hasMore(String name, double amount) throws UserDoesNotExistException
+	{
+		return amount < getMoney(name);
+	}
+
+	/**
+	 * @param name Name of the user
+	 * @param amount The amount of money the user should not have
+	 * @return true, if the user has less money
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 */
+	public static boolean hasLess(String name, double amount) throws UserDoesNotExistException
+	{
+		return amount > getMoney(name);
+	}
+
+	/**
+	 * Test if the user has a negative balance
+	 * @param name Name of the user
+	 * @return true, if the user has a negative balance
+	 * @throws UserDoesNotExistException If a user by that name does not exists
+	 */
+	public static boolean isNegative(String name) throws UserDoesNotExistException
+	{
+		return getMoney(name) < 0.0;
+	}
+
+	/**
+	 * Formats the amount of money like all other Essentials functions.
+	 * Example: $100000 or $12345.67
+	 * @param amount The amount of money
+	 * @return Formatted money
+	 */
+	public static String format(double amount)
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		return Util.formatCurrency(amount, ess);
+	}
+
+	/**
+	 * Test if a player exists to avoid the UserDoesNotExistException
+	 * @param name Name of the user
+	 * @return true, if the user exists
+	 */
+	public static boolean playerExists(String name)
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		return ess.getEconomy().playerExists(name);
+	}
+
+	/**
+	 * Test if a player is a npc
+	 * @param name Name of the player
+	 * @return true, if it's a npc
+	 * @throws UserDoesNotExistException 
+	 */
+	public static boolean isNPC(String name) throws UserDoesNotExistException
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		return ess.getEconomy().isNPC(name);
+	}
+
+	/**
+	 * Creates dummy files for a npc, if there is no player yet with that name.
+	 * @param name Name of the player
+	 * @return true, if a new npc was created
+	 */
+	public static boolean createNPC(String name)
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		return ess.getEconomy().createNPC(name);
+	}
+
+	/**
+	 * Deletes a user, if it is marked as npc. 
+	 * @param name Name of the player
+	 * @throws UserDoesNotExistException 
+	 */
+	public static void removeNPC(String name) throws UserDoesNotExistException
+	{
+		if (ess == null)
+		{
+			throw new RuntimeException(noCallBeforeLoad);
+		}
+		ess.getEconomy().removeNPC(name);
+	}
+}