From a71fd1dde67b82d0a151ea1abeed4abf7b154cf4 Mon Sep 17 00:00:00 2001
From: vulcandth <vulcandth@gmail.com>
Date: Mon, 1 Jan 2024 21:18:10 -0600
Subject: [PATCH] Document `BattleAnim_Tackle` reaches horizontal sprite limit

Co-Authored-By: SoupPotato <22991349+SoupPotato@users.noreply.github.com>
---
 data/moves/animations.asm            |   1 +
 docs/bugs_and_glitches.md            |  19 +++++++++++++++++++
 docs/images/tackle_animation_bug.png | Bin 0 -> 2504 bytes
 3 files changed, 20 insertions(+)
 create mode 100644 docs/images/tackle_animation_bug.png

diff --git a/data/moves/animations.asm b/data/moves/animations.asm
index 5c2499016e4..ffc123e648d 100644
--- 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
index 44ea96dd07f..c120ebf64da 100644
--- 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
new file mode 100644
index 0000000000000000000000000000000000000000..5b81428c726fb6b3596b574d4bacfc3f71d2b0ee
GIT binary patch
literal 2504
zcmV;(2{-nMP)<h;3K|Lk000e1NJLTq005u>0058(0ssI20N3}|000SfNkl<Zc%1E>
zF?-rP5XVn_-l1&CM#g4qxAGC-8@y~~bT+d!Tjy@=1{)s9miHTwkC1NdmX2jhHoEy8
zj$VZ%%eE}bwz%KW2W%lIf8XhJcP1jwb1)%<P>#?@<rE$_9yHEo98af&5c+G2J|t7h
zKbCVvUo<JC43MA7XO)r4Jo=kjUdz<wRZH`tPEd9o)O{^e7n=p!y>4Afy|g^P(N{AL
z)Ns)a(U)-6F92=1XnCPE##2lfY!+Mu35E}h(Y5Yx^;4EWo$&>)bCJ`Qi|!9+zCaAg
zf*qoI4(R%8!9oaGQCja2s9>5L=s`aPF3MtBqBG+pmO$@(=&y@bLUdpk?S#uVscnoo
zEC;DLrw#oSShw0DJ3dd%Y7zN$%`Vy|FxyJoESF0FSgls=y+v&oT{jl(+m&%{SFPhV
z>G1v2;rl0iKu_r)9cL^om&+tck|aSpHlid09Pk-rjoy7GT}SUe;{)*!|L#+d1i^><
z6+&#L7vJ74mdmB{JdF|^ikY6L)uIfW>4k1;Xq`p_Me~)1>0{C~{q}Z&!<_B7c94Y!
zQA;#gGF-A+9Dq;zw$6E9gK>wQ%`R^qUUVZyd9o}6$(m(#i7d<H0RTX+U9DEm`*=qe
zO<LjuSz2YlnIs64-80NCi)28l$V_#0;na?m0Zp<rwFT~*MRrRzyF~L%cFzE?nO@K-
zy0T?gY@e;jtl$6GI&0j=V#9#Ad3d46s4?|}9-dM!Zy|(8cF)em5*FAq7;PP%($V#L
zGrf5KV~Y#016h`>*XxEZlLhubvU|>Em+;4kWn>d~p!tGWRp4l1rRJ#v8F|q~lHK!W
zdV%J9^YG%)QM-v<b(@4l5Mi~nO#%Q6wdDB^PwDN~^4Q8k!#xs|R+Hk>*!%xTuR8z!
zdED(ZR2RXO*!gpoY?JihEgD}<7!!@vUn}2bLtj^#rchyDR0W#E&5k3l2e%ESu_(Nf
zlTdz9(qR?hD7q17vJ^%45Vl|sD0VD_@aUq!)pn1cjRkHF7L>?KQyR--kkwWc&6Hy4
z0nPK=SU9Q<m6$je-5IzHD>q?KoBnFGYLcpK-mb+0djRG1n<GQA*(FZv>}XkFZ;;G-
z{?ZvtWgnhW=S!!Ljqig-j<%qnd7~ou!Y>~I{%FjJj_#3jTiNUqo2njfr;{%a05F+M
z?DkF7C#6a;x^@htSzyn|0t+D?A0Gi=GMPL+K4w|=<s*!)*N3Ncd$TQ?fof2r>opzZ
zHMlRx+50q2CzA<1ppf|XD=an(%Os=gHK{A#H|qdfa4S%*V|2Yv(-cd7cnZJp<#LIO
zt8U6l71`N2A3q5T+!DwB;-?gC5jA`L=4iyfe=cvo9s?*im6?jlho=<Bw^$Em8iKnf
zbjYvYtbYGo%K!d&N#0)kO@nN2wisk7zfr*!+-oRpsi=$p(l9i1Z1nLc3JV+vl$orV
zAgiS{+pi*==m-Qw*Yf5EkKg!fqSoPUQXnv{UThY4ry5A9O;p#iGj2rA1OWh0T9i{c
zj#_M{7x|ywE?@8(90<y7;l_!+b|v$b`~IQqz6h*TOU7IH^`RFZ%p*nmwfb{U9S2#Y
z>sVWW@Kj7nllwIu*B^VKGYcmDO4%=>k~uIPSg>rGS9fY1d#@$o@gfjHu*?pGwqSXU
zxw;diG3r`s(EG*U@0|%uP=WObg4C_(s}a_?I^hx>sIKgjg%GG&Ey2cH5JKp_oiP$f
zU{aTSGWC|?k<!H#FNOPE0s!MJ>=&Nz^o^BpK^E#Nt4q3~#_RF1IW66*jl}!KQCc`v
z8aVhWBg7gkgt*@&BpU`wWX-a=inNNB7Ur{z7iJ@YT(qq2cni9^=|0odrEF~}RbsUB
zq_b)gd2CcyKDA$*Y={1xZc1lcj}s2NjI=H=u91jwJ0z=%(vG)P<7(ON^$ZCE{iz3&
z)#iC#QL1#G{rZsa7lxpWA%dnVjVq<H6~4Mt<G%kMZtT<U7XUjiA233~S+H)GvejCK
zF-_>KTv(J<R;;|#d>K2f3ydXhSvE_05_imQZ-gmK-VG~+bJ3`A>F&15rpP!mCBhh)
zpiy+)VxQeV<KB0?Wod1MSc7#h?F(62&Q=-;6l6Ix3vzhng>Wvqin`8L&gNT0Uou%r
zahJ{47rnSQNpALFY5md{3zlm^dg+jHrWXQZ3(kH4>v1xlW!Rn}YphGo7ePh37Z_Xb
z?sp00u$0Q~e3mKw9{Le%A_(`PheMYFU)>36y`u!y{VpMErjfd_D)x;=&l>A=mb^7~
zQWiy6^H~O`%~|ph6q|eEjdUZhu5Ody8O3IGjdXKwk}QUoeG#i$MCdhGY1rUhZ`%YF
zSn<rh)a9O83!%$}2*%Iz8SiCVr-Qo-X$|)1pJ}JWD1@`%R##tc)hnWduFCse^7jXK
z*+sWZH<_&aU4jd6^KKiyMC^py2P?6zbN8eIcfH#QXTiTdIQ|uS3-ej#>q3c@4qP<V
z71Di%Sw;uuvy9cPLeNyD(t5WZC$KXV6719+f97<Pi<afV$BHQz>4#RU4CanI3w*Cf
z<aFQB!L$ks962XzF#qgS1So6nUxE4F%Q#SUJU*eLY{Y{`Q4^FknAIIRx`Kv%Fgxmj
zVzf^+ie`0(i%~n?CPfYl962m-<gmbz!vaSR3miEtaO9K}{N=r~o(7{a#x$pKy#7=k
ztWRP&Wy!5t-tpY932fI!r|1f(GNJsq=mIj%Z~wE7ZTvmYVNvL!^)IF2cVxd@^4x#V
zB?E3fSq@6ndWq2$J0P3>*&4Bnz`6^ykCzweD&MllKc>rGq0mL^KGXTjk{4Gws*)!(
zYT3kZ)6csQ=P9<$f|W0&)R<^6J}{1#y``eJ<ufP&vt@op;lz2K?Lrj|x{jRah#VF;
za#-NVVSyuu1&$mRIC5Cv$YFsar~4lx)z9h&ORJWpb?ef6c$N2s0jAG-@kcpi9O}EJ
zb?drC4jnm5IxLN=7W|7kF~D@0>&M%pv~E2(N&Mni4=(a@mWB<t&u5&!dfMDq9h&MQ
zgS%E7>%mnlSUy-frXqC(bE`wggyR}qWU1|aM@1{EWl2`*&<#J^K;^Gd4<?FSnLb{x
z`?f)qy0x*cth~h1&`D<pCo|WBqk`+fX9o)$IV^DGoCH~C+j<xcdI+WdP8J7QLq~0P
z_M2>C`haYuuZ%~T;i9I4Sl77uAA|Mq=_bDQl>h($4rN$LW=%~1DgXcg2mk;800000
S(o>TF0000<MNUMnLSTZ%KfCDw

literal 0
HcmV?d00001