Document Perish Song turn range (#265)

Also documents DungeonRandRange's special behavior when the upper and lower range is the same (such as when Perish Song is used).
UsernameFodder · Aug 14, 2024 · 0c552de · 0c552de
1 parent 4db258e
commit 0c552de
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/headers/data/overlay10.h b/headers/data/overlay10.h
@@ -125,6 +125,7 @@ extern int16_t SURE_SHOT_TURN_RANGE[2];
 extern int DETECT_BAND_MOVE_ACCURACY_DROP;
 extern fx32_8 TINTED_LENS_MULTIPLIER;
 extern int16_t SMOKESCREEN_TURN_RANGE[2];
+extern int16_t PERISH_SONG_TURN_RANGE[2];
 extern fx32_8 SHADOW_FORCE_DAMAGE_MULTIPLIER;
 extern fx32_8 DIG_DAMAGE_MULTIPLIER;
 extern fx32_8 DIVE_DAMAGE_MULTIPLIER;

diff --git a/symbols/overlay10.yml b/symbols/overlay10.yml
@@ -1497,6 +1497,19 @@ overlay10:
       description: |-
         The turn range for the Whiffer status inflicted by Smokescreen, [1, 4).
         
+        type: int16_t[2]
+    - name: PERISH_SONG_TURN_RANGE
+      address:
+        EU: 0x22C5128
+        NA: 0x22C47D0
+        JP: 0x22C5EB8
+      length:
+        EU: 0x4
+        NA: 0x4
+        JP: 0x4
+      description: |-
+        The turn range for the status inflicted by Perish Song, [3, 3).
+        
         type: int16_t[2]
     - name: SHADOW_FORCE_DAMAGE_MULTIPLIER
       address:

diff --git a/symbols/overlay29.yml b/symbols/overlay29.yml
@@ -1140,9 +1140,11 @@ overlay29:
       description: |-
         Compute a pseudorandom value between two integers using the dungeon PRNG.
         
+        If both input integers are the same, the first is returned.
+        
         r0: x
         r1: y
-        return: pseudorandom integer on the interval [min(x, y), max(x, y) - 1]
+        return: pseudorandom integer on the interval [min(x, y), max(x, y) - 1], or x if x == y.
     - name: DungeonRandOutcome
       address:
         EU: