Document remaining status/general/special anims

8 files changed, 34 insertions, 32 deletions

diff --git a/src/battle_anim_effects_3.c b/src/battle_anim_effects_3.c
index 6b4947442..96f3f5364 100755
--- a/src/battle_anim_effects_3.c
+++ b/src/battle_anim_effects_3.c
@@ -2367,7 +2367,7 @@ void AnimTask_IsMonInvisible(u8 taskId)
     DestroyAnimVisualTask(taskId);
 }
 
-void AnimTask_CastformGfxChange(u8 taskId)
+void AnimTask_CastformGfxDataChange(u8 taskId)
 {
     HandleSpeciesGfxDataChange(gBattleAnimAttacker, gBattleAnimTarget, TRUE);
     DestroyAnimVisualTask(taskId);
@@ -3683,7 +3683,7 @@ static void sub_815DA20(u8 taskId)
     }
 }
 
-void sub_815DB90(u8 taskId)
+void AnimTask_SlideMonForFocusBand(u8 taskId)
 {
     gTasks[taskId].data[15] = gBattlerSpriteIds[gBattleAnimAttacker];
     gTasks[taskId].data[14] = gBattleAnimArgs[0];
diff --git a/src/battle_anim_mon_movement.c b/src/battle_anim_mon_movement.c
index d5b142abe..e1849064d 100644
--- a/src/battle_anim_mon_movement.c
+++ b/src/battle_anim_mon_movement.c
@@ -915,14 +915,15 @@ void AminTask_DipMonSpriteToSide(u8 taskId)
     gTasks[taskId].func = sub_80D6308;
 }
 
-void sub_80D622C(u8 taskId)
+// Rotates mon to side and back to original position. For Peck and when a held item activates
+void AnimTask_RotateMonToSideAndRestore(u8 taskId)
 {
     u8 spriteId;
     spriteId = GetAnimBattlerSpriteId(gBattleAnimArgs[2]);
     PrepareBattlerSpriteForRotScale(spriteId, ST_OAM_OBJ_NORMAL);
     gTasks[taskId].data[1] = 0;
     gTasks[taskId].data[2] = gBattleAnimArgs[0];
-    if (gBattleAnimArgs[2] == 0)
+    if (gBattleAnimArgs[2] == ANIM_ATTACKER)
     {
         if (GetBattlerSide(gBattleAnimAttacker))
         {
diff --git a/src/battle_anim_special.c b/src/battle_anim_special.c
index 6ff5ee893..f664d221d 100755
--- a/src/battle_anim_special.c
+++ b/src/battle_anim_special.c
@@ -514,7 +514,7 @@ static void sub_8170660(u8 taskId)
     }
 }
 
-static void sub_8170834(u8 *paletteId1, u8 *paletteId2, u8 battler)
+static void LoadHealthboxPalsForLevelUp(u8 *paletteId1, u8 *paletteId2, u8 battler)
 {
     u8 healthBoxSpriteId;
     u8 spriteId1, spriteId2;
@@ -536,14 +536,14 @@ static void sub_8170834(u8 *paletteId1, u8 *paletteId2, u8 battler)
     gSprites[spriteId2].oam.paletteNum = *paletteId2;
 }
 
-void sub_8170920(u8 taskId)
+void AnimTask_LoadHealthboxPalsForLevelUp(u8 taskId)
 {
     u8 paletteId1, paletteId2;
-    sub_8170834(&paletteId1, &paletteId2, gBattleAnimAttacker);
+    LoadHealthboxPalsForLevelUp(&paletteId1, &paletteId2, gBattleAnimAttacker);
     DestroyAnimVisualTask(taskId);
 }
 
-static void sub_817094C(u8 battler)
+static void FreeHealthboxPalsForLevelUp(u8 battler)
 {
     u8 healthBoxSpriteId;
     u8 spriteId1, spriteId2;
@@ -562,13 +562,13 @@ static void sub_817094C(u8 battler)
     gSprites[spriteId2].oam.paletteNum = paletteId2;
 }
 
-void sub_81709EC(u8 taskId)
+void AnimTask_FreeHealthboxPalsForLevelUp(u8 taskId)
 {
-    sub_817094C(gBattleAnimAttacker);
+    FreeHealthboxPalsForLevelUp(gBattleAnimAttacker);
     DestroyAnimVisualTask(taskId);
 }
 
-void sub_8170A0C(u8 taskId)
+void AnimTask_FlashHealthboxOnLevelUp(u8 taskId)
 {
     gTasks[taskId].data[10] = gBattleAnimArgs[0];
     gTasks[taskId].data[11] = gBattleAnimArgs[1];
@@ -612,7 +612,7 @@ static void sub_8170A38(u8 taskId)
     }
 }
 
-void sub_8170B04(u8 taskId)
+void AnimTask_SwitchOutShrinkMon(u8 taskId)
 {
     u8 spriteId;
 
@@ -639,7 +639,7 @@ void sub_8170B04(u8 taskId)
     }
 }
 
-void sub_8170BB0(u8 taskId)
+void AnimTask_SwitchOutBallEffect(u8 taskId)
 {
     u8 spriteId;
     u16 ball;
@@ -674,14 +674,14 @@ void sub_8170BB0(u8 taskId)
     }
 }
 
-void sub_8170CFC(u8 taskId)
+void AnimTask_LoadBallGfx(u8 taskId)
 {
     u8 ballId = ItemIdToBallId(gLastUsedItem);
     LoadBallGfx(ballId);
     DestroyAnimVisualTask(taskId);
 }
 
-void sub_8170D24(u8 taskId)
+void AnimTask_FreeBallGfx(u8 taskId)
 {
     u8 ballId = ItemIdToBallId(gLastUsedItem);
     FreeBallGfx(ballId);
@@ -730,7 +730,7 @@ u8 ItemIdToBallId(u16 ballItem)
     }
 }
 
-void sub_8170E04(u8 taskId)
+void AnimTask_ThrowBall(u8 taskId)
 {
     u8 ballId;
     u8 spriteId;
@@ -753,7 +753,8 @@ static void sub_8170EF0(u8 taskId)
         DestroyAnimVisualTask(taskId);
 }
 
-void sub_8170F2C(u8 taskId)
+// Safari Ball / Wally's ball throw
+void AnimTask_ThrowBallSpecial(u8 taskId)
 {
     int x, y;
     u8 ballId;
@@ -1910,7 +1911,8 @@ static void sub_8172B90(u8 taskId)
     }
 }
 
-void sub_8172BF0(u8 taskId)
+// arg0: TRUE to swap to mon, FALSE to swap to substitute
+void AnimTask_SwapMonSpriteToFromSubstitute(u8 taskId)
 {
     u8 spriteId;
     u32 x;
@@ -1968,7 +1970,7 @@ void sub_8172BF0(u8 taskId)
     }
 }
 
-void sub_8172D98(u8 taskId)
+void AnimTask_SubstituteFadeToInvisible(u8 taskId)
 {
     u8 spriteId;
 
@@ -2230,7 +2232,7 @@ static void sub_8173400(struct Sprite *sprite)
     }
 }
 
-void sub_817345C(u8 taskId)
+void AnimTask_SetAttackerTargetLeftPos(u8 taskId)
 {
     switch (gBattleAnimArgs[0])
     {
diff --git a/src/battle_script_commands.c b/src/battle_script_commands.c
index 685626a85..17f76f1a1 100644
--- a/src/battle_script_commands.c
+++ b/src/battle_script_commands.c
@@ -2064,7 +2064,7 @@ static void Cmd_resultmessage(void)
             gPotentialItemEffectBattler = gBattlerTarget;
             gMoveResultFlags &= ~(MOVE_RESULT_FOE_ENDURED | MOVE_RESULT_FOE_HUNG_ON);
             BattleScriptPushCursor();
-            gBattlescriptCurrInstr = BattleScript_HangedOnMsg;
+            gBattlescriptCurrInstr = BattleScript_FocusBandActivates;
             return;
         default:
             if (gMoveResultFlags & MOVE_RESULT_DOESNT_AFFECT_FOE)
@@ -2093,7 +2093,7 @@ static void Cmd_resultmessage(void)
                 gPotentialItemEffectBattler = gBattlerTarget;
                 gMoveResultFlags &= ~(MOVE_RESULT_FOE_ENDURED | MOVE_RESULT_FOE_HUNG_ON);
                 BattleScriptPushCursor();
-                gBattlescriptCurrInstr = BattleScript_HangedOnMsg;
+                gBattlescriptCurrInstr = BattleScript_FocusBandActivates;
                 return;
             }
             else if (gMoveResultFlags & MOVE_RESULT_FAILED)
diff --git a/src/electric.c b/src/electric.c
index 010654940..5a89892ca 100644
--- a/src/electric.c
+++ b/src/electric.c
@@ -922,7 +922,7 @@ static void AnimElectricPuff(struct Sprite *sprite)
     sprite->callback = RunStoredCallbackWhenAnimEnds;
 }
 
-// Creates an orb of electricity that grwos then slides off-screen. The attacker slides with it
+// Creates an orb of electricity that grows then slides off-screen. The attacker slides with it
 static void AnimVoltTackleOrbSlide(struct Sprite *sprite)
 {
     StartSpriteAffineAnim(sprite, 1);
diff --git a/src/fire.c b/src/fire.c
index 93eabe8ea..8f58894e0 100644
--- a/src/fire.c
+++ b/src/fire.c
@@ -16,7 +16,7 @@ static void sub_8109064(struct Sprite *);
 static void sub_81090D8(struct Sprite *);
 static void AnimSunlight(struct Sprite *);
 static void AnimEmberFlare(struct Sprite *);
-static void sub_8109200(struct Sprite *);
+static void AnimBurnFlame(struct Sprite *);
 static void AnimFireRing(struct Sprite *);
 static void AnimFireRingStep1(struct Sprite *);
 static void AnimFireRingStep2(struct Sprite *);
@@ -208,7 +208,7 @@ const union AffineAnimCmd *const gUnknown_0859549C[] =
     gUnknown_08595484,
 };
 
-const struct SpriteTemplate gSunnyDayLightRaySpriteTemplate =
+const struct SpriteTemplate gSunlightRaySpriteTemplate =
 {
     .tileTag = ANIM_TAG_SUNLIGHT,
     .paletteTag = ANIM_TAG_SUNLIGHT,
@@ -256,7 +256,7 @@ const struct SpriteTemplate gEmberFlareSpriteTemplate =
     .callback = AnimEmberFlare,
 };
 
-const struct SpriteTemplate gUnknown_08595504 =
+const struct SpriteTemplate gBurnFlameSpriteTemplate =
 {
     .tileTag = ANIM_TAG_SMALL_EMBER,
     .paletteTag = ANIM_TAG_SMALL_EMBER,
@@ -264,7 +264,7 @@ const struct SpriteTemplate gUnknown_08595504 =
     .anims = gUnknown_085954D0,
     .images = NULL,
     .affineAnims = gDummySpriteAffineAnimTable,
-    .callback = sub_8109200,
+    .callback = AnimBurnFlame,
 };
 
 const struct SpriteTemplate gFireBlastRingSpriteTemplate =
@@ -594,7 +594,7 @@ static void sub_81090D8(struct Sprite *sprite)
     }
 }
 
-// Sunlight from Sunny Day
+// Sunlight from Sunny Day / sunny weather
 static void AnimSunlight(struct Sprite *sprite)
 {
     sprite->pos1.x = 0;
@@ -628,7 +628,7 @@ static void AnimEmberFlare(struct Sprite *sprite)
     sprite->callback(sprite);
 }
 
-static void sub_8109200(struct Sprite *sprite)
+static void AnimBurnFlame(struct Sprite *sprite)
 {
     gBattleAnimArgs[0] = -gBattleAnimArgs[0];
     gBattleAnimArgs[2] = -gBattleAnimArgs[2];
diff --git a/src/ice.c b/src/ice.c
index c110dc946..fa72ee2ff 100644
--- a/src/ice.c
+++ b/src/ice.c
@@ -1329,8 +1329,7 @@ void MovePoisonGasCloud(struct Sprite *sprite)
     }
 }
 
-// Creates Hail.
-void AnimTask_HailStart(u8 taskId)
+void AnimTask_Hail(u8 taskId)
 {
     struct Task *task = &gTasks[taskId];
 
diff --git a/src/normal.c b/src/normal.c
index 1bc0287d9..c2c5fbcc6 100644
--- a/src/normal.c
+++ b/src/normal.c
@@ -626,7 +626,7 @@ static void sub_8115D2C(u8 taskId)
     }
 }
 
-// Flashes the specified anim tag with given color. Used e.g. to flash the particles in Hyper Beam red
+// Flashes the specified anim tag with given color. Used e.g. to flash the particles red in Hyper Beam
 void AnimTask_FlashAnimTagWithColor(u8 taskId)
 {
     u8 paletteIndex;