Document BattleAnim_Tackle reaches horizontal sprite limit

Co-Authored-By: SoupPotato <[email protected]>
pret · Jan 2, 2024 · a71fd1d · a71fd1d
1 parent 804fa84
commit a71fd1d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/data/moves/animations.asm b/data/moves/animations.asm
@@ -2082,6 +2082,7 @@ BattleAnim_Headbutt:
 	anim_ret
 
 BattleAnim_Tackle:
+; BUG: BattleAnim_Tackle reaches horizontal sprite limit (see docs/bugs_and_glitches.md)
 	anim_1gfx BATTLE_ANIM_GFX_HIT
 	anim_call BattleAnim_TargetObj_2Row
 	anim_bgeffect BATTLE_BG_EFFECT_TACKLE, $0, BG_EFFECT_USER, $0

diff --git a/docs/bugs_and_glitches.md b/docs/bugs_and_glitches.md
@@ -78,6 +78,7 @@ Fixes in the [multi-player battle engine](#multi-player-battle-engine) category
   - [Using a Park Ball in non-Contest battles has a corrupt animation](#using-a-park-ball-in-non-contest-battles-has-a-corrupt-animation)
   - [Battle transitions fail to account for the enemy's level](#battle-transitions-fail-to-account-for-the-enemys-level)
   - [Some trainer NPCs have inconsistent overworld sprites](#some-trainer-npcs-have-inconsistent-overworld-sprites)
+  - [`BattleAnim_Tackle` reaches horizontal sprite limit](#battleanim_tackle-reaches-horizontal-sprite-limit)
 - [Audio](#audio)
   - [Slot machine payout sound effects cut each other off](#slot-machine-payout-sound-effects-cut-each-other-off)
   - [Team Rocket battle music is not used for Executives or Scientists](#team-rocket-battle-music-is-not-used-for-executives-or-scientists)
@@ -2065,6 +2066,24 @@ Most of the NPCs in [maps/NationalParkBugContest.asm](https://github.com/pret/po
 (The use of `SPRITE_ROCKER` instead of `SPRITE_COOLTRAINER_M` for `COOLTRAINERM NICK` may also be an intentional reference to the player's brother from the [Space World '97 beta](https://github.com/pret/pokegold-spaceworld).)
 
 
+### `BattleAnim_Tackle` reaches horizontal sprite limit
+
+`BattleAnim_Tackle` in Pokémon Crystal reaches the horiztonal sprite limit due to two rows of the enemy's feet being copied from background tiles to sprites. This fix restores the animation to only copy one row like in Pokémon Gold and Silver.
+
+![image](https://raw.githubusercontent.com/pret/pokecrystal/master/docs/images/tackle_animation_bug.png)
+
+**Fix:** Edit `BattleAnim_Tackle` in [data/moves/animations.asm](https://github.com/pret/pokecrystal/blob/master/data/moves/animations.asm):
+
+```diff
+ BattleAnim_Tackle:
+-; BUG: BattleAnim_Tackle reaches horizontal sprite limit (see docs/bugs_and_glitches.md)
+ 	anim_1gfx BATTLE_ANIM_GFX_HIT
+-	anim_call BattleAnim_TargetObj_2Row
++	anim_call BattleAnim_TargetObj_1Row
+ 	anim_bgeffect BATTLE_BG_EFFECT_TACKLE, $0, BG_EFFECT_USER, $0
+```
+
+
 ## Audio
 
 

diff --git a/docs/images/tackle_animation_bug.png b/docs/images/tackle_animation_bug.png