Finish documenting the Battle Castle Apps (Overlay 107)

include/overlay104/ov104_0222DCE0.h

@@ -21,10 +21,10 @@ u32 ov104_0222DD6C(FrontierPokemonDataDTO *param0, u16 param1, u32 param2, u32 p
 void ov104_0222DF40(const FrontierPokemonDataDTO *param0, Pokemon *param1, u8 param2);
 u16 BattleTower_GetObjectIDFromTrainerClass(u8 trainerClass);
 void ov104_0222E134(SaveData *saveData, Pokemon *param1);
-void ov104_0222E1C0(SaveData *saveData, Party *param1, Pokemon *param2);
-void ov104_0222E1D8(Sprite *param0, u8 param1);
-void ov104_0222E204(Sprite *param0, s16 param1, s16 param2, u8 param3);
-u8 ov104_0222E240(u16 param0, u16 param1);
+void ov104_0222E1C0(SaveData *saveData, Party *party, Pokemon *param2);
+void BattleCastle_UpdateMonSpriteAnimID(Sprite *sprite, u8 animID);
+void BattleCastle_UpdateMonSpritePosition(Sprite *sprite, s16 x, s16 y, u8 isSelected);
+u8 BattleCastle_GetPokeIconAnimID(u16 hp, u16 maxHp);
 void ov104_0222E278(FrontierDataDTO *param0, u16 param1, enum HeapID heapID, int param3);
 void ov104_0222E284(FieldBattleDTO *param0, FrontierTrainerDataDTO *param1, int param2, int battlerId, enum HeapID heapID);
 u32 ov104_0222E2F0(FrontierPokemonDataDTO *param0, u16 param1, int param2, u8 param3, u32 param4, int param5, int param6);

include/overlay104/ov104_0223B6F4.h

@@ -24,6 +24,6 @@ void ov104_0223BAB8(UnkStruct_ov104_0223BA10 *param0);
 u16 ov104_0223BB60(UnkStruct_ov104_0223BA10 *param0);
 void ov104_0223BB84(BgConfig *param0, UnkStruct_ov104_0223BA10 *param1, u32 param2);
 u16 ov104_0223BC24(u16 param0);
-void ov104_0223BC2C(BattleFrontier *frontier, u8 param1, int param2);
+void ov104_0223BC2C(BattleFrontier *frontier, u8 challengeType, int castlePoints);
 
 #endif // POKEPLATINUM_OV104_0223B6F4_H

include/overlay107/battle_castle_app_sprite.h

@@ -7,6 +7,25 @@
 
 #include "sprite.h"
 
+#define ANIM_ID_EXIT_CURSOR           0
+#define ANIM_ID_MON_CURSOR            1
+#define ANIM_ID_PARTNER_MON_CURSOR    2
+#define ANIM_ID_ITEM_SELECT_CURSOR    3
+#define ANIM_ID_MENU_UP_ARROW         4
+#define ANIM_ID_MENU_DOWN_ARROW       5
+#define ANIM_ID_POKE_BALL             6
+#define ANIM_ID_SHAKING_POKE_BALL     7
+#define ANIM_ID_HEAL_SPARKLES         8
+#define ANIM_ID_LEVEL_UP_ARROW        9
+#define ANIM_ID_LEVEL_DOWN_ARROW      10
+#define ANIM_ID_OPEN_SUMMARY_SPARKLES 11
+#define ANIM_ID_FLAG                  12
+#define ANIM_ID_RED_BAR               13
+#define ANIM_ID_YELLOW_BAR            14
+#define ANIM_ID_GREEN_BAR             15
+#define ANIM_ID_RENTAL_SPARKLES       16
+#define ANIM_ID_PARTNER_EXIT_CURSOR   17
+
 typedef struct BattleCastleAppSprite {
     s16 x;
     s16 y;
@@ -19,11 +38,11 @@ void BattleCastleAppSprite_SetDrawFlag(BattleCastleAppSprite *sprite, BOOL draw)
 void BattleCastleAppSprite_SetPosition(BattleCastleAppSprite *sprite, u16 x, u16 y);
 void BattleCastleAppSprite_SetAnim(BattleCastleAppSprite *sprite, u32 animID);
 void BattleCastleAppSprite_UpdatePalette(BattleCastleAppSprite *sprite, Pokemon *mon);
-void ov107_02249C1C(BattleCastleAppSprite *sprite, u8 param1);
-void ov107_02249C28(BattleCastleAppSprite *sprite, u8 param1);
+void BattleCastleAppSprite_UpdateMonSpriteAnim(BattleCastleAppSprite *sprite, u8 animID);
+void BattleCastleAppSprite_UpdateMonPosition(BattleCastleAppSprite *sprite, u8 isSelected);
 BOOL BattleCastleAppSprite_IsAnimated(BattleCastleAppSprite *sprite);
 void BattleCastleAppSprite_SetPriority(BattleCastleAppSprite *sprite, u8 priority);
-void ov107_02249C58(BattleCastleAppSprite *sprite, s16 x, s16 y);
-void ov107_02249C60(BattleCastleAppSprite *sprite, u16 x, u16 y);
+void BattleCastleAppSprite_UpdateCoords(BattleCastleAppSprite *sprite, s16 x, s16 y);
+void BattleCastleAppSprite_PlaySparkleAnim(BattleCastleAppSprite *sprite, u16 x, u16 y);
 
 #endif // POKEPLATINUM_APPLICATIONS_BATTLE_CASTLE_SPRITES_H

include/overlay107/battle_castle_opponent_app.h

@@ -6,9 +6,9 @@
 BOOL BattleCastleOpponentApp_Init(ApplicationManager *appMan, int *state);
 BOOL BattleCastleOpponentApp_Main(ApplicationManager *appMan, int *state);
 BOOL BattleCastleOpponentApp_Exit(ApplicationManager *appMan, int *state);
-void ov107_02248910(int param0, int param1, void *param2, void *param3);
-void ov107_02248978(int param0, int param1, void *param2, void *param3);
-void ov107_022489E0(int param0, int param1, void *param2, void *param3);
-void ov107_02248A10(int param0, int param1, void *param2, void *param3);
+void BattleCastleOpponentApp_HandlePlayerInfoCmd(int netID, int unused, void *data, void *context);
+void BattleCastleOpponentApp_HandlePurchaseInfoCmd(int netID, int unused, void *data, void *context);
+void BattleCastleOpponentApp_HandleUpdateCursorCmd(int netID, int unused, void *data, void *context);
+void BattleCastleOpponentApp_HandleExitAppCmd(int netID, int unused, void *data, void *context);
 
 #endif // POKEPLATINUM_APPLICATIONS_BATTLE_CASTLE_OPPONENT_MAIN_H

include/overlay107/battle_castle_self_app.h

@@ -6,9 +6,9 @@
 BOOL BattleCastleSelfApp_Init(ApplicationManager *appMan, int *state);
 BOOL BattleCastleSelfApp_Main(ApplicationManager *appMan, int *state);
 BOOL BattleCastleSelfApp_Exit(ApplicationManager *appMan, int *state);
-void ov107_02245338(int param0, int param1, void *param2, void *param3);
-void ov107_022453A0(int param0, int param1, void *param2, void *param3);
-void ov107_02245408(int param0, int param1, void *param2, void *param3);
-void ov107_02245438(int param0, int param1, void *param2, void *param3);
+void BattleCastleSelfApp_HandlePlayerInfoCmd(int netID, int unused, void *data, void *context);
+void BattleCastleSelfApp_HandlePurchaseInfoCmd(int netID, int unused, void *data, void *context);
+void BattleCastleSelfApp_HandleUpdateCursorCmd(int netID, int unused, void *data, void *context);
+void BattleCastleSelfApp_HandleExitAppCmd(int netID, int unused, void *data, void *context);
 
 #endif // POKEPLATINUM_APPLICATIONS_BATTLE_CASTLE_SELF_MAIN_H

include/overlay107/ov107_02249C98.h

@@ -4,10 +4,14 @@
 #include "savedata.h"
 #include "string_template.h"
 
-u8 ov107_02249C98(u8 param0, u8 param1);
-u8 ov107_02249C9C(u8 param0, u8 param1);
-u8 ov107_02249CAC(SaveData *saveData, u8 param1, u8 param2);
-void ov107_02249CE0(u32 param0, u16 param1);
-void ov107_02249CF4(StringTemplate *template, u32 idx);
+#define BATTLE_CASTLE_RANK_HEALING          0
+#define BATTLE_CASTLE_RANK_RENTALS          1
+#define BATTLE_CASTLE_RANK_OPPONENT_SUMMARY 2
+
+u8 BattleCastleApp_GetSelectedSlot(u8 numSlots, u8 slot);
+u8 BattleCastleApp_GetSlotFromSlotID(u8 exitSlot, u8 slotID);
+u8 BattleCastleApp_GetRank(SaveData *saveData, u8 challengeType, u8 rankType);
+void BattleCastleApp_PlaySound(u32 input, u16 seqID);
+void BattleCastleApp_SetPartnerName(StringTemplate *template, u32 idx);
 
 #endif // POKEPLATINUM_OV107_02249C98_H

res/text/battle_castle_self_app.json

@@ -6,19 +6,19 @@
       "en_US": "{STRVAR_1 3, 0, 0}"
     },
     {
-      "id": "pl_msg_00000199_00001",
+      "id": "BattleCastleSelfApp_Text_PartnerName",
       "en_US": "{STRVAR_1 3, 0, 0}"
     },
     {
-      "id": "pl_msg_00000199_00002",
+      "id": "BattleCastleSelfApp_Text_CastlePoints",
       "en_US": "{STRVAR_1 53, 0, 0} CP"
     },
     {
-      "id": "pl_msg_00000199_00003",
+      "id": "BattleCastleSelfApp_Text_PartnersCastlePoints",
       "en_US": "{STRVAR_1 53, 0, 0} CP"
     },
     {
-      "id": "BattleCastleSelfApp_Text_CastlePoints",
+      "id": "BattleCastleSelfApp_Text_CastlePointsItemSelect",
       "en_US": "{STRVAR_1 53, 0, 0} CP"
     },
     {

src/overlay104/ov104_0222DCE0.c

@@ -24,6 +24,7 @@
 #include "narc.h"
 #include "party.h"
 #include "pokemon.h"
+#include "pokemon_icon.h"
 #include "save_player.h"
 #include "savedata.h"
 #include "sprite.h"
@@ -358,52 +359,50 @@ void ov104_0222E1C0(SaveData *saveData, Party *party, Pokemon *param2)
     return;
 }
 
-void ov104_0222E1D8(Sprite *param0, u8 param1)
+void BattleCastle_UpdateMonSpriteAnimID(Sprite *sprite, u8 animID)
 {
-    if (Sprite_GetActiveAnim(param0) == param1) {
+    if (Sprite_GetActiveAnim(sprite) == animID) {
         return;
     }
 
-    Sprite_SetAnimFrame(param0, 0);
-    Sprite_SetAnim(param0, param1);
-    Sprite_UpdateAnim(param0, FX32_ONE);
-    return;
+    Sprite_SetAnimFrame(sprite, 0);
+    Sprite_SetAnim(sprite, animID);
+    Sprite_UpdateAnim(sprite, FX32_ONE);
 }
 
-void ov104_0222E204(Sprite *param0, s16 param1, s16 param2, u8 param3)
+void BattleCastle_UpdateMonSpritePosition(Sprite *sprite, s16 x, s16 y, u8 isSelected)
 {
-    VecFx32 v0;
+    VecFx32 position;
 
-    v0.x = param1 * FX32_ONE;
-    v0.y = param2 * FX32_ONE;
-    v0.z = 0;
+    position.x = x * FX32_ONE;
+    position.y = y * FX32_ONE;
+    position.z = 0;
 
-    if (param3 == 1) {
-        if (Sprite_GetAnimFrame(param0) == 0) {
-            v0.y = (param2 - 3) * FX32_ONE;
+    if (isSelected == 1) {
+        if (Sprite_GetAnimFrame(sprite) == 0) {
+            position.y = (y - 3) * FX32_ONE;
         } else {
-            v0.y = (param2 + 1) * FX32_ONE;
+            position.y = (y + 1) * FX32_ONE;
         }
     }
 
-    Sprite_SetPosition(param0, &v0);
-    return;
+    Sprite_SetPosition(sprite, &position);
 }
 
-u8 ov104_0222E240(u16 param0, u16 param1)
+u8 BattleCastle_GetPokeIconAnimID(u16 hp, u16 maxHp)
 {
-    switch (HealthBar_Color(param0, param1, 48)) {
-    case 4:
-        return 1;
-    case 3:
-        return 2;
-    case 2:
-        return 3;
-    case 1:
-        return 4;
+    switch (HealthBar_Color(hp, maxHp, 48)) {
+    case BARCOLOR_MAX:
+        return POKEICON_ANIM_HP_MAX;
+    case BARCOLOR_GREEN:
+        return POKEICON_ANIM_HP_GREEN;
+    case BARCOLOR_YELLOW:
+        return POKEICON_ANIM_HP_YELLOW;
+    case BARCOLOR_RED:
+        return POKEICON_ANIM_HP_RED;
     }
 
-    return 1;
+    return POKEICON_ANIM_HP_MAX;
 }
 
 void ov104_0222E278(FrontierDataDTO *param0, u16 param1, enum HeapID heapID, int param3)

src/overlay104/ov104_0223B6F4.c

@@ -407,17 +407,17 @@ u16 ov104_0223BC24(u16 param0)
     return param0;
 }
 
-void ov104_0223BC2C(BattleFrontier *frontier, u8 param1, int param2)
+void ov104_0223BC2C(BattleFrontier *frontier, u8 challengeType, int castlePoints)
 {
     u16 v0;
 
-    sub_02030824(frontier, sub_0205E630(param1), sub_0205E6A8(sub_0205E630(param1)), param2);
-    v0 = sub_02030698(frontier, sub_0205E658(param1), sub_0205E6A8(sub_0205E658(param1)));
+    sub_02030824(frontier, sub_0205E630(challengeType), sub_0205E6A8(sub_0205E630(challengeType)), castlePoints);
+    v0 = sub_02030698(frontier, sub_0205E658(challengeType), sub_0205E6A8(sub_0205E658(challengeType)));
 
-    if (v0 + param2 > 9999) {
-        sub_020306E4(frontier, sub_0205E658(param1), sub_0205E6A8(sub_0205E658(param1)), 9999);
+    if (v0 + castlePoints > 9999) {
+        sub_020306E4(frontier, sub_0205E658(challengeType), sub_0205E6A8(sub_0205E658(challengeType)), 9999);
     } else {
-        sub_02030804(frontier, sub_0205E658(param1), sub_0205E6A8(sub_0205E658(param1)), param2);
+        sub_02030804(frontier, sub_0205E658(challengeType), sub_0205E6A8(sub_0205E658(challengeType)), castlePoints);
     }
 
     return;

src/overlay107/battle_castle_app_sprite.c

@@ -66,14 +66,14 @@ void BattleCastleAppSprite_UpdatePalette(BattleCastleAppSprite *sprite, Pokemon
     Sprite_SetExplicitPaletteOffsetAutoAdjust(sprite->sprite, Pokemon_IconPaletteIndex(mon));
 }
 
-void ov107_02249C1C(BattleCastleAppSprite *sprite, u8 param1)
+void BattleCastleAppSprite_UpdateMonSpriteAnim(BattleCastleAppSprite *sprite, u8 animID)
 {
-    ov104_0222E1D8(sprite->sprite, param1);
+    BattleCastle_UpdateMonSpriteAnimID(sprite->sprite, animID);
 }
 
-void ov107_02249C28(BattleCastleAppSprite *sprite, u8 param1)
+void BattleCastleAppSprite_UpdateMonPosition(BattleCastleAppSprite *sprite, u8 isSelected)
 {
-    ov104_0222E204(sprite->sprite, sprite->x, sprite->y, param1);
+    BattleCastle_UpdateMonSpritePosition(sprite->sprite, sprite->x, sprite->y, isSelected);
 }
 
 BOOL BattleCastleAppSprite_IsAnimated(BattleCastleAppSprite *sprite)
@@ -86,15 +86,15 @@ void BattleCastleAppSprite_SetPriority(BattleCastleAppSprite *sprite, u8 priorit
     Sprite_SetExplicitPriority(sprite->sprite, priority);
 }
 
-void ov107_02249C58(BattleCastleAppSprite *sprite, s16 x, s16 y)
+void BattleCastleAppSprite_UpdateCoords(BattleCastleAppSprite *sprite, s16 x, s16 y)
 {
     sprite->x = x;
     sprite->y = y;
 }
 
-void ov107_02249C60(BattleCastleAppSprite *sprite, u16 x, u16 y)
+void BattleCastleAppSprite_PlaySparkleAnim(BattleCastleAppSprite *sprite, u16 x, u16 y)
 {
-    BattleCastleAppSprite_SetAnim(sprite, 11);
+    BattleCastleAppSprite_SetAnim(sprite, ANIM_ID_OPEN_SUMMARY_SPARKLES);
     BattleCastleAppSprite_SetPosition(sprite, x, y);
     BattleCastleAppSprite_SetDrawFlag(sprite, TRUE);