From fa0667f26a54f2946c4f148330883e8368273710 Mon Sep 17 00:00:00 2001 From: Artemis-the-gr8 Date: Sun, 26 Feb 2023 12:40:48 +0100 Subject: [PATCH] Updated documentation --- .../com/artemis/the/gr8/playerstats/api/enums/Unit.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/artemis/the/gr8/playerstats/api/enums/Unit.java b/src/main/java/com/artemis/the/gr8/playerstats/api/enums/Unit.java index 7e29621..0a63e10 100644 --- a/src/main/java/com/artemis/the/gr8/playerstats/api/enums/Unit.java +++ b/src/main/java/com/artemis/the/gr8/playerstats/api/enums/Unit.java @@ -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) {