diff options
Diffstat (limited to 'Essentials2Compat/src/com/earth2me/essentials/api/Economy.java')
| -rw-r--r-- | Essentials2Compat/src/com/earth2me/essentials/api/Economy.java | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java b/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java index cf8cb640c..663c451c6 100644 --- a/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java +++ b/Essentials2Compat/src/com/earth2me/essentials/api/Economy.java @@ -4,8 +4,7 @@ import com.earth2me.essentials.utils.Util; /** - * Instead of using this api directly, we recommend to use the register plugin: - * http://bit.ly/RegisterMethod + * Instead of using this api directly, we recommend to use the register plugin: http://bit.ly/RegisterMethod */ public final class Economy { @@ -17,9 +16,10 @@ public final class Economy /** * Returns the balance of a user + * * @param name Name of the user * @return balance - * @throws UserDoesNotExistException + * @throws UserDoesNotExistException */ public static double getMoney(String name) throws UserDoesNotExistException { @@ -32,6 +32,7 @@ public final class Economy /** * 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 @@ -48,6 +49,7 @@ public final class Economy /** * 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 @@ -61,6 +63,7 @@ public final class Economy /** * 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 @@ -74,6 +77,7 @@ public final class Economy /** * 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 @@ -87,6 +91,7 @@ public final class Economy /** * 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 @@ -100,6 +105,7 @@ public final class Economy /** * 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 @@ -148,6 +154,7 @@ public final class Economy /** * 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 @@ -158,8 +165,8 @@ public final class Economy } /** - * Formats the amount of money like all other Essentials functions. - * Example: $100000 or $12345.67 + * Formats the amount of money like all other Essentials functions. Example: $100000 or $12345.67 + * * @param amount The amount of money * @return Formatted money */ @@ -174,6 +181,7 @@ public final class Economy /** * Test if a player exists to avoid the UserDoesNotExistException + * * @param name Name of the user * @return true, if the user exists */ @@ -188,9 +196,10 @@ public final class Economy /** * Test if a player is a npc + * * @param name Name of the player * @return true, if it's a npc - * @throws UserDoesNotExistException + * @throws UserDoesNotExistException */ public static boolean isNPC(String name) throws UserDoesNotExistException { @@ -203,6 +212,7 @@ public final class Economy /** * 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 */ @@ -216,9 +226,10 @@ public final class Economy } /** - * Deletes a user, if it is marked as npc. + * Deletes a user, if it is marked as npc. + * * @param name Name of the player - * @throws UserDoesNotExistException + * @throws UserDoesNotExistException */ public static void removeNPC(String name) throws UserDoesNotExistException { |