mirror of
https://github.com/MilkBowl/Vault.git
synced 2024-12-27 11:27:47 +01:00
Update javadocs in Interfaces
This commit is contained in:
parent
36b3843144
commit
cd7793b0ac
@ -20,10 +20,49 @@
|
||||
package net.milkbowl.vault.economy;
|
||||
|
||||
public interface Economy {
|
||||
|
||||
/**
|
||||
* Checks if economy method is enabled.
|
||||
* @return Success or Failure
|
||||
*/
|
||||
public boolean isEnabled();
|
||||
|
||||
/**
|
||||
* Gets name of permission method
|
||||
* @return Name of Permission Method
|
||||
*/
|
||||
public String getName();
|
||||
|
||||
/**
|
||||
* Format amount into a human readable String
|
||||
* This provides translation into economy specific formatting
|
||||
* to improve consistency between plugins. Should be used when
|
||||
* possible.
|
||||
* @param amount
|
||||
* @return Human readable string describing amount
|
||||
*/
|
||||
public String format(double amount);
|
||||
|
||||
/**
|
||||
* Gets balance of a player
|
||||
* @param playerName
|
||||
* @return Amount currently held in players account
|
||||
*/
|
||||
public double getBalance(String playerName);
|
||||
|
||||
/**
|
||||
* Withdraw an amount from a player
|
||||
* @param playerName Name of player
|
||||
* @param amount Amount to withdraw
|
||||
* @return Detailed response of transaction
|
||||
*/
|
||||
public EconomyResponse withdrawPlayer(String playerName, double amount);
|
||||
|
||||
/**
|
||||
* Deposit an amount to a player
|
||||
* @param playerName Name of player
|
||||
* @param amount Amount to deposit
|
||||
* @return Detailed response of transaction
|
||||
*/
|
||||
public EconomyResponse depositPlayer(String playerName, double amount);
|
||||
}
|
@ -278,11 +278,17 @@ public interface Permission {
|
||||
|
||||
/**
|
||||
* Gets the list of groups that this player has
|
||||
*
|
||||
* @param world Name of World
|
||||
* @param playerName Name of Player
|
||||
* @param playerName Name of Player
|
||||
* @return Array of groups
|
||||
*/
|
||||
public String[] getPlayerGroups(String world, String playerName);
|
||||
|
||||
/**
|
||||
* Gets users primary group
|
||||
* @param world
|
||||
* @param playerName
|
||||
* @return Players primary group
|
||||
*/
|
||||
public String getPrimaryGroup(String world, String playerName);
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user