Upstream
/
PlayerStats
mirror of https://github.com/itHotL/PlayerStats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

This commit is contained in:
Artemis-the-gr8 2023-02-26 12:40:48 +01:00
parent 18bf8a56a7
commit fa0667f26a
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/com/artemis/the/gr8/playerstats/api/enums/Unit.java
View File

@ -185,10 +185,12 @@ public enum Unit {
}
/**
* Gets the most suitable Unit for this number.
* Gets the largest Unit this number can be expressed in as a whole number.
* For example, for Type TIME a value of 80.000 would return Unit.HOUR
* (80.000 ticks equals 4.000 seconds, 67 minutes, or 1 hour)
*
* @param type the Unit.Type of the statistic this number belongs to
* @param number the statistic number as returned by Player.getStatistic()
* @param type the Unit.Type of this statistic
* @param number the statistic value in ticks as returned by Player.getStatistic()
* @return the Unit
*/
public static Unit getMostSuitableUnit(Unit.Type type, long number) {