Misc battle documentation

1 files changed, 20 insertions, 15 deletions

diff --git a/src/battle_anim_mons.c b/src/battle_anim_mons.c
index 3401c315a..06ebf1105 100644
--- a/src/battle_anim_mons.c
+++ b/src/battle_anim_mons.c
@@ -79,11 +79,15 @@ static const u8 sCastformBackSpriteYCoords[] =
     0, // HAIL
 };
 
-static const struct SpriteTemplate sUnknown_08525F90[] =
+// Placeholders for pokemon sprites to be created for a move animation effect (e.g. Role Play / Snatch)
+#define TAG_MOVE_EFFECT_MON_1 55125
+#define TAG_MOVE_EFFECT_MON_2 55126
+
+static const struct SpriteTemplate sSpriteTemplate_MoveEffectMons[] =
 {
     {
-        .tileTag = 55125,
-        .paletteTag = 55125,
+        .tileTag = TAG_MOVE_EFFECT_MON_1,
+        .paletteTag = TAG_MOVE_EFFECT_MON_1,
         .oam = &gOamData_AffineNormal_ObjNormal_64x64,
         .anims = gDummySpriteAnimTable,
         .images = NULL,
@@ -91,8 +95,8 @@ static const struct SpriteTemplate sUnknown_08525F90[] =
         .callback = SpriteCallbackDummy,
     },
     {
-        .tileTag = 55126,
-        .paletteTag = 55126,
+        .tileTag = TAG_MOVE_EFFECT_MON_2,
+        .paletteTag = TAG_MOVE_EFFECT_MON_2,
         .oam = &gOamData_AffineNormal_ObjNormal_64x64,
         .anims = gDummySpriteAnimTable,
         .images = NULL,
@@ -101,10 +105,10 @@ static const struct SpriteTemplate sUnknown_08525F90[] =
     }
 };
 
-static const struct SpriteSheet sUnknown_08525FC0[] =
+static const struct SpriteSheet sSpriteSheet_MoveEffectMons[] =
 {
-    { gMiscBlank_Gfx, 0x800, 55125, },
-    { gMiscBlank_Gfx, 0x800, 55126, },
+    { gMiscBlank_Gfx, 0x800, TAG_MOVE_EFFECT_MON_1, },
+    { gMiscBlank_Gfx, 0x800, TAG_MOVE_EFFECT_MON_2, },
 };
 
 u8 GetBattlerSpriteCoord(u8 battlerId, u8 coordType)
@@ -2021,18 +2025,19 @@ u8 GetBattlerSpriteBGPriorityRank(u8 battlerId)
     return 1;
 }
 
-u8 sub_80A8394(u16 species, bool8 isBackpic, u8 a3, s16 x, s16 y, u8 subpriority, u32 personality, u32 trainerId, u32 battlerId, u32 a10)
+// Create pokemon sprite to be used for a move animation effect (e.g. Role Play / Snatch)
+u8 CreateAdditionalMonSpriteForMoveAnim(u16 species, bool8 isBackpic, u8 id, s16 x, s16 y, u8 subpriority, u32 personality, u32 trainerId, u32 battlerId, bool32 ignoreDeoxysForm)
 {
     u8 spriteId;
-    u16 sheet = LoadSpriteSheet(&sUnknown_08525FC0[a3]);
-    u16 palette = AllocSpritePalette(sUnknown_08525F90[a3].paletteTag);
+    u16 sheet = LoadSpriteSheet(&sSpriteSheet_MoveEffectMons[id]);
+    u16 palette = AllocSpritePalette(sSpriteTemplate_MoveEffectMons[id].paletteTag);
 
     if (gMonSpritesGfxPtr != NULL && gMonSpritesGfxPtr->buffer == NULL)
         gMonSpritesGfxPtr->buffer = AllocZeroed(0x2000);
     if (!isBackpic)
     {
         LoadCompressedPalette(GetMonSpritePalFromSpeciesAndPersonality(species, trainerId, personality), (palette * 0x10) + 0x100, 0x20);
-        if (a10 == 1 || sub_80688F8(5, battlerId) == 1 || gBattleSpritesDataPtr->battlerData[battlerId].transformSpecies != 0)
+        if (ignoreDeoxysForm == TRUE || ShouldIgnoreDeoxysForm(5, battlerId) == TRUE || gBattleSpritesDataPtr->battlerData[battlerId].transformSpecies != 0)
             LoadSpecialPokePic_DontHandleDeoxys(&gMonFrontPicTable[species],
                                                 gMonSpritesGfxPtr->buffer,
                                                 species,
@@ -2048,7 +2053,7 @@ u8 sub_80A8394(u16 species, bool8 isBackpic, u8 a3, s16 x, s16 y, u8 subpriority
     else
     {
         LoadCompressedPalette(GetMonSpritePalFromSpeciesAndPersonality(species, trainerId, personality), (palette * 0x10) + 0x100, 0x20);
-        if (a10 == 1 || sub_80688F8(5, battlerId) == 1 || gBattleSpritesDataPtr->battlerData[battlerId].transformSpecies != 0)
+        if (ignoreDeoxysForm == TRUE || ShouldIgnoreDeoxysForm(5, battlerId) == TRUE || gBattleSpritesDataPtr->battlerData[battlerId].transformSpecies != 0)
             LoadSpecialPokePic_DontHandleDeoxys(&gMonBackPicTable[species],
                                                 gMonSpritesGfxPtr->buffer,
                                                 species,
@@ -2066,9 +2071,9 @@ u8 sub_80A8394(u16 species, bool8 isBackpic, u8 a3, s16 x, s16 y, u8 subpriority
     FREE_AND_SET_NULL(gMonSpritesGfxPtr->buffer);
 
     if (!isBackpic)
-        spriteId = CreateSprite(&sUnknown_08525F90[a3], x, y + gMonFrontPicCoords[species].y_offset, subpriority);
+        spriteId = CreateSprite(&sSpriteTemplate_MoveEffectMons[id], x, y + gMonFrontPicCoords[species].y_offset, subpriority);
     else
-        spriteId = CreateSprite(&sUnknown_08525F90[a3], x, y + gMonBackPicCoords[species].y_offset, subpriority);
+        spriteId = CreateSprite(&sSpriteTemplate_MoveEffectMons[id], x, y + gMonBackPicCoords[species].y_offset, subpriority);
 
     if (IsContest())
     {