Document battle_controller_player.c

include/battle.h

@@ -385,7 +385,7 @@ struct BattleStruct
     u8 chosenMovePositions[MAX_BATTLERS_COUNT];
     u8 stateIdAfterSelScript[MAX_BATTLERS_COUNT];
     u8 unused_3[3];
-    u8 field_8B; // related to player's pokemon switching
+    u8 prevSelectedPartySlot;
     u8 unused_4[2];
     u8 stringMoveType;
     u8 expGetterBattlerId;
@@ -523,7 +523,7 @@ struct BattleAnimationInfo
     u8 field_6;
     u8 field_7;
     u8 ballThrowCaseId;
-    u8 field_9_x1:1;
+    u8 introAnimActive:1;
     u8 wildMonInvisible:1;
     u8 field_9_x1C:3;
     u8 field_9_x20:1;
@@ -548,17 +548,17 @@ struct BattleHealthboxInfo
     u8 triedShinyMonAnim:1;
     u8 finishedShinyMonAnim:1;
     u8 field_1_x1E:4;
-    u8 field_1_x20:1;
-    u8 field_1_x40:1;
-    u8 field_1_x80:1;
+    u8 bgmRestored:1;
+    u8 waitForCry:1;
+    u8 healthboxSlideInStarted:1;
     u8 healthboxBounceSpriteId;
     u8 battlerBounceSpriteId;
     u8 animationState;
-    u8 field_5;
+    u8 partyStatusDelayTimer;
     u8 matrixNum;
     u8 shadowSpriteId;
-    u8 field_8;
-    u8 field_9;
+    u8 soundTimer;
+    u8 introEndDelay;
     u8 field_A;
     u8 field_B;
 };
@@ -714,6 +714,6 @@ extern void (*gBattlerControllerFuncs[MAX_BATTLERS_COUNT])(void);
 extern u8 gHealthboxSpriteIds[MAX_BATTLERS_COUNT];
 extern u8 gMultiUsePlayerCursor;
 extern u8 gNumberOfMovesToChoose;
-extern u8 gUnknown_03005D7C[MAX_BATTLERS_COUNT];
+extern u8 gBattleControllerData[MAX_BATTLERS_COUNT];
 
 #endif // GUARD_BATTLE_H

include/battle_controllers.h

@@ -246,11 +246,11 @@ void BtlController_EmitEndLinkBattle(u8 bufferId, u8 battleOutcome);
 void SetControllerToPlayer(void);
 void BattleControllerDummy(void);
 void PlayerHandleGetRawMonData(void);
-void sub_80587B0(void);
-void sub_805CC00(struct Sprite *sprite);
+void SetBattleEndCallbacks(void);
+void SpriteCB_FreePlayerSpriteLoadMonSprite(struct Sprite *sprite);
 void CB2_SetUpReshowBattleScreenAfterMenu(void);
 void CB2_SetUpReshowBattleScreenAfterMenu2(void);
-void c3_0802FDF4(u8 taskId);
+void Task_PlayerController_RestoreBgmAfterCry(u8 taskId);
 void ActionSelectionCreateCursorAt(u8 cursorPos, u8 unused);
 void ActionSelectionDestroyCursorAt(u8 cursorPos);
 void InitMoveSelectionsVarsAndStrings(void);

include/battle_gfx_sfx_util.h

@@ -4,21 +4,20 @@
 void AllocateBattleSpritesData(void);
 void FreeBattleSpritesData(void);
 u16 ChooseMoveAndTargetInBattlePalace(void);
-void sub_805D714(struct Sprite *sprite);
+void SpriteCB_WaitForBattlerBallReleaseAnim(struct Sprite *sprite);
 void sub_805D770(struct Sprite *sprite, bool8 arg1);
-void sub_805D7AC(struct Sprite *sprite);
+void SpriteCB_TrainerSlideIn(struct Sprite *sprite);
 void InitAndLaunchChosenStatusAnimation(bool8 isStatus2, u32 status);
 bool8 TryHandleLaunchBattleTableAnimation(u8 activeBattlerId, u8 attacker, u8 target, u8 tableId, u16 argument);
 void InitAndLaunchSpecialAnimation(u8 activeBattlerId, u8 attacker, u8 target, u8 tableId);
 bool8 IsMoveWithoutAnimation(u16 moveId, u8 animationTurn);
-bool8 mplay_80342A4(u8 battlerId);
+bool8 IsBattleSEPlaying(u8 battlerId);
 void BattleLoadOpponentMonSpriteGfx(struct Pokemon *mon, u8 battlerId);
 void BattleLoadPlayerMonSpriteGfx(struct Pokemon *mon, u8 battlerId);
-void nullsub_23(void);
-void nullsub_24(u16 species);
+void BattleGfxSfxDummy2(u16 species);
 void DecompressTrainerFrontPic(u16 frontPicId, u8 battlerId);
 void DecompressTrainerBackPic(u16 backPicId, u8 battlerId);
-void nullsub_25(u8 arg0);
+void BattleGfxSfxDummy3(u8 gender);
 void FreeTrainerFrontPicPalette(u16 frontPicId);
 void sub_805DFFC(void);
 bool8 BattleLoadAllHealthBoxesGfx(u8 state);
@@ -36,7 +35,7 @@ void HandleLowHpMusicChange(struct Pokemon *mon, u8 battlerId);
 void BattleStopLowHpSound(void);
 u8 GetMonHPBarLevel(struct Pokemon *mon);
 void HandleBattleLowHpMusicChange(void);
-void sub_805EB9C(u8 affineMode);
+void SetBattlerSpriteAffineMode(u8 affineMode);
 void LoadAndCreateEnemyShadowSprites(void);
 void SpriteCB_SetInvisible(struct Sprite *sprite);
 void SetBattlerShadowSpriteCallback(u8 battlerId, u16 species);

include/battle_main.h

@@ -51,7 +51,7 @@ void sub_8038A04(void); // unused
 void VBlankCB_Battle(void);
 void nullsub_17(struct Sprite *sprite);
 void sub_8038B74(struct Sprite *sprite);
-void sub_8038D64(void);
+void CB2_InitEndLinkBattle(void);
 u32 sub_80391E0(u8 arrayId, u8 caseId);
 u32 sub_80397C4(u32 setId, u32 tableId);
 void SpriteCb_WildMon(struct Sprite *sprite);
@@ -62,7 +62,7 @@ void SpriteCb_HideAsMoveTarget(struct Sprite *sprite);
 void SpriteCb_OpponentMonFromBall(struct Sprite *sprite);
 void sub_8039BB4(struct Sprite *sprite);
 void sub_80105DC(struct Sprite *sprite);
-void sub_8039C00(struct Sprite *sprite);
+void SpriteCB_FaintSlideAnim(struct Sprite *sprite);
 void DoBounceEffect(u8 battlerId, u8 b, s8 c, s8 d);
 void EndBounceEffect(u8 battlerId, bool8 b);
 void SpriteCb_PlayerMonFromBall(struct Sprite *sprite);

include/pokeball.h

@@ -34,7 +34,7 @@ extern const struct SpriteTemplate gBallSpriteTemplates[];
 u8 DoPokeballSendOutAnimation(s16 pan, u8 kindOfThrow);
 void CreatePokeballSpriteToReleaseMon(u8 monSpriteId, u8 battler, u8 x, u8 y, u8 oamPriority, u8 subpriortiy, u8 g, u32 h, u16 species);
 u8 CreateTradePokeballSprite(u8 a, u8 b, u8 x, u8 y, u8 oamPriority, u8 subPriority, u8 g, u32 h);
-void sub_8076918(u8 battler);
+void StartHealthboxSlideIn(u8 battler);
 void DoHitAnimHealthboxEffect(u8 battler);
 void LoadBallGfx(u8 ballId);
 void FreeBallGfx(u8 ballId);

include/recorded_battle.h

@@ -13,8 +13,8 @@ void sub_8184E58(void);
 void RecordedBattle_SetBattlerAction(u8 battlerId, u8 action);
 void RecordedBattle_ClearBattlerAction(u8 battlerId, u8 bytesToClear);
 u8 RecordedBattle_GetBattlerAction(u8 battlerId);
-u8 RecordedBattle_GetAllNewBattlerData(u8 *dst);
-void sub_81851A8(u8 *arg0);
+u8 RecordedBattle_BufferNewBattlerData(u8 *dst);
+void RecordedBattle_RecordAllBattlerData(u8 *data);
 bool32 CanCopyRecordedBattleSaveData(void);
 bool32 MoveRecordedBattleToSaveData(void);
 void PlayRecordedBattle(void (*CB2_After)(void));

include/reshow_battle_screen.h

@@ -1,7 +1,7 @@
 #ifndef GUARD_RESHOW_BATTLE_SCREEN_H
 #define GUARD_RESHOW_BATTLE_SCREEN_H
 
-void nullsub_35(void);
+void ReshowBattleScreenDummy(void);
 void ReshowBattleScreenAfterMenu(void);
 
 #endif // GUARD_RESHOW_BATTLE_SCREEN_H