JarvisBigBalls/Mineplex2018-withcommit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update JavaDocs to fit Mineplex standard

Browse Source
This commit is contained in:
AlexTheCoder 2016-04-30 14:41:28 -04:00
parent 2e4bae6915
commit 37a815d52a
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Plugins/Mineplex.Core/src/mineplex/core/elo/EloManager.java
View File

@ -141,7 +141,9 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method for quickly checking if a player is banned from ranked games async * Checks if a player is banned from ranked games async
* @param accountId The player's account ID
* @param afterCheck Code to be executed with the fetched ban status
*/ */
public void checkRankBannedAsync(int accountId, Callback<Long> afterCheck) public void checkRankBannedAsync(int accountId, Callback<Long> afterCheck)
{ {
@ -163,7 +165,9 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method for quickly checking if a player is banned from ranked games (Should not be run on main thread) * Checks if a player is banned from ranked games (Should not be run on main thread)
* @param accountId The player's account ID
* @return The ban status of the player
*/ */
public boolean checkRankBanned(int accountId) public boolean checkRankBanned(int accountId)
{ {
@ -183,7 +187,9 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method for getting a player's remaining ranked game ban duration (Should not be run on main thread) * Gets a player's remaining ranked game ban duration (Should not be run on main thread)
* @param accountId The player's account ID
* @return The ban expiry of the player (0 if not found)
*/ */
public long getRankBanExpiry(int accountId) public long getRankBanExpiry(int accountId)
{ {
@ -191,7 +197,9 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method for getting a player's remaining ranked game ban duration if applicable async * Gets a player's remaining ranked game ban duration if applicable async
* @param accountId The player's account ID
* @param afterFetch Code to be executed with the fetched ban expiration
*/ */
public void getRankBanExpiryAsync(int accountId, Callback<Long> afterFetch) public void getRankBanExpiryAsync(int accountId, Callback<Long> afterFetch)
{ {
@ -199,7 +207,8 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method for banning a player from joining ranked games temporarily * Bans a player from joining ranked games temporarily
* @param accountId The player's account ID
*/ */
public void banFromRanked(int accountId) public void banFromRanked(int accountId)
{ {
@ -207,7 +216,8 @@ public class EloManager extends MiniDbClientPlugin<EloClientData>
} }
/** /**
* Method called when game ends to calculate new Elo and award it * Called when game ends to calculate new Elo and award it
* @param gameId The game's ID
*/ */
public void endMatch(int gameId) public void endMatch(int gameId)
{ {