ChromaGaming/ChromaCore
1
0
Fork 0
Code Issues 23 Pull requests 1 Projects Releases 11 Packages Wiki Activity

Added some comments, documentation

Browse source
This commit is contained in:
Norbi Peti 2016-10-29 14:10:27 +02:00
parent 4ebb526d87
commit 12a42f8aba
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/main/java/buttondevteam/lib/TBMCPlayer.java
View file

@ -24,7 +24,7 @@ import com.palmergames.bukkit.towny.object.TownyUniverse;
* @author Norbi
*
*/
public class TBMCPlayer implements AutoCloseable {
public class TBMCPlayer implements AutoCloseable { //TODO: Load player data in Core
private static final String TBMC_PLAYERS_DIR = "TBMC/players";
private HashMap<String, Object> data = new HashMap<>();
@ -127,11 +127,22 @@ public class TBMCPlayer implements AutoCloseable {
private static HashMap<UUID, TBMCPlayer> LoadedPlayers = new HashMap<>();
/**
* This method returns a TBMC player from their name. Calling this method may return an offline player which will load it, therefore it's highly recommended to use {@link #close()} to unload the player data. Using
* try-with-resources may be the easiest way to achieve this. Example:
*
* <pre>
* {@code
* try(TBMCPlayer player = getFromName(p))
* {
* ...
* }
* </pre>
*
* @param name
* The player's name
* @return The {@link TBMCPlayer} object for the player
*/
public static TBMCPlayer GetFromName(String name) {
public static TBMCPlayer getFromName(String name) {
@SuppressWarnings("deprecation")
OfflinePlayer p = Bukkit.getOfflinePlayer(name);
if (p != null)
@ -146,7 +157,7 @@ public class TBMCPlayer implements AutoCloseable {
*
* <pre>
* {@code
* try(TBMCPlayer player = GetPlayer(p))
* try(TBMCPlayer player = getPlayer(p))
* {
* ...
* }