Document berry yield

fix wording

1 files changed, 13 insertions, 3 deletions

diff --git a/src/berry.c b/src/berry.c
index 7a8ab37fa..3f59639ad 100644
--- a/src/berry.c
+++ b/src/berry.c
@@ -1200,6 +1200,15 @@ static u8 GetNumStagesWateredByBerryTreeId(u8 id)
     return BerryTreeGetNumStagesWatered(GetBerryTreeInfo(id));
 }
 
+// Berries can be watered at 4 stages of growth. This function is likely meant
+// to divide the berry yield range equally into quartiles. If you watered the
+// tree n times, your yield is a random number in the nth quartile.
+//
+// However, this function actually skews towards higher berry yields, because
+// it rounds `extraYield` to the nearest whole number.
+//
+// See resulting yields: https://pastebin.com/RLGnP9Ng, and 
+// bug fix: https://pastebin.com/cDjnUWL0.
 static u8 CalcBerryYieldInternal(u16 max, u16 min, u8 water)
 {
     u32 randMin;
@@ -1215,10 +1224,11 @@ static u8 CalcBerryYieldInternal(u16 max, u16 min, u8 water)
         randMax = (max - min) * (water);
         rand = randMin + Random() % (randMax - randMin + 1);
 
-        if ((rand & 3) > 1)
-            extraYield = rand / 4 + 1;
+        // Round upwards
+        if ((rand % NUM_BERRY_STAGES) >= NUM_BERRY_STAGES / 2)
+            extraYield = rand / NUM_BERRY_STAGES + 1;
         else
-            extraYield = rand / 4;
+            extraYield = rand / NUM_BERRY_STAGES;
         return extraYield + min;
     }
 }