Sync Ruby/Sapphire Battle Tower structs

12 files changed, 81 insertions, 38 deletions

diff --git a/asm/battle_tower.s b/asm/battle_tower.s
index b651188a1..d4bad6bd1 100644
--- a/asm/battle_tower.s
+++ b/asm/battle_tower.s
@@ -2111,7 +2111,7 @@ _080E6970:
 	bl CreateTask
 	movs r0, 0
 	bl PlayMapChosenOrBattleBGM
-	bl sub_8080060
+	bl BattleSetup_GetBattleTowerBattleTransition
 	lsls r0, 24
 	lsrs r0, 24
 	bl BT_StartOnField
@@ -2151,7 +2151,7 @@ _080E69A0:
 	bl CreateTask
 	movs r0, 0
 	bl PlayMapChosenOrBattleBGM
-	bl sub_8080060
+	bl BattleSetup_GetBattleTowerBattleTransition
 	lsls r0, 24
 	lsrs r0, 24
 	bl BT_StartOnField
diff --git a/include/battle_message.h b/include/battle_message.h
index 130dc7ce9..2bbfffa43 100644
--- a/include/battle_message.h
+++ b/include/battle_message.h
@@ -246,4 +246,10 @@ extern const u8 gText_Ice[];
 extern const u8 gText_Confusion[];
 extern const u8 gText_Love[];
 
+extern const u8 gUnknown_83FE859[];
+extern const u8 gUnknown_83FE85E[];
+extern const u8 gUnknown_83FE85C[];
+extern const u8 gUnknown_83FE860[];
+extern const u8 gUnknown_83FE864[];
+
 #endif // GUARD_BATTLE_MESSAGE_H
diff --git a/include/battle_setup.h b/include/battle_setup.h
index 809806e9b..4dc2f10f0 100644
--- a/include/battle_setup.h
+++ b/include/battle_setup.h
@@ -13,7 +13,7 @@ void Special_StartLegendaryBattle(void);
 void Special_StartGroudonKyogreBattle(void);
 void Special_StartRegiBattle(void);
 u8 BattleSetup_GetTerrainId(void);
-u8 sub_8080060(void);
+u8 BattleSetup_GetBattleTowerBattleTransition(void);
 const u8 *BattleSetup_ConfigureTrainerBattle(const u8 *data);
 void ConfigureAndSetUpOneTrainerBattle(u8 trainerEventObjId, const u8 *trainerScript);
 bool32 GetTrainerFlagFromScriptPointer(const u8 *data);
diff --git a/include/battle_tower.h b/include/battle_tower.h
index b755e68e9..b7b106107 100644
--- a/include/battle_tower.h
+++ b/include/battle_tower.h
@@ -4,6 +4,27 @@
 #include "global.h"
 #include "constants/battle_tower.h"
 
+#define BATTLE_TOWER_EREADER_TRAINER_ID 200
+#define BATTLE_TOWER_RECORD_MIXING_TRAINER_BASE_ID 100
+
+struct BattleTowerTrainer
+{
+    u8 trainerClass;
+    u8 name[3];
+    u8 teamFlags;
+    u16 speech[6];
+};
+
+struct BattleTowerPokemonTemplate
+{
+    u16 species;
+    u8 heldItem;
+    u8 teamFlags;
+    u16 moves[4];
+    u8 evSpread;
+    u8 nature;
+};
+
 u16 sub_8164FCC(u8, u8);
 void sub_80E7524(struct BattleTowerEReaderTrainer *);
 void ValidateEReaderTrainer(void);
diff --git a/include/global.h b/include/global.h
index 874717784..2f34de1a0 100644
--- a/include/global.h
+++ b/include/global.h
@@ -226,10 +226,22 @@ struct UnknownSaveBlock2Struct
     u8 field_EB;
 }; // sizeof = 0xEC
 
+struct BattleTowerRecord // record mixing
+{
+    /*0x00*/ u8 battleTowerLevelType; // 0 = level 50, 1 = level 100
+    /*0x01*/ u8 trainerClass;
+    /*0x02*/ u16 winStreak;
+    /*0x04*/ u8 name[8];
+    /*0x0C*/ u8 trainerId[4];
+    /*0x10*/ u16 greeting[6];
+    /*0x1C*/ struct BattleTowerPokemon party[3];
+    /*0xA0*/ u32 checksum;
+};
+
 struct BattleTowerEReaderTrainer
 {
     /*0x4A0 0x3F0 0x00*/ u8 unk0;
-    /*0x4A1 0x3F1 0x01*/ u8 facilityClass;
+    /*0x4A1 0x3F1 0x01*/ u8 trainerClass;
     /*0x4A2 0x3F2 0x02*/ u16 winStreak;
     /*0x4A4 0x3F4 0x04*/ u8 name[8];
     /*0x4AC 0x3FC 0x0C*/ u8 trainerId[4];
@@ -240,28 +252,32 @@ struct BattleTowerEReaderTrainer
     /*0x558 0x4A8 0xB8*/ u32 checksum;
 };
 
-struct UnkSaveBlock2Substruct_55C
-{
-    /* 0x000:0x55C */ u8 unk_00_0:1;
-    u8 unk_00_1:1;
-    /* 0x001:0x55D */ u8 unk_01;
-    /* 0x002:0x55E */ u8 unk_02[2];
-    /* 0x004:0x560 */ u16 unk_04[2];
-    /* 0x008:0x564 */ u16 unk_08[2];
-    /* 0x00C:0x568 */ u16 unk_0C[2];
-    /* 0x010:0x56C */ u8 unk_10;
-    /* 0x011:0x56D */ u8 unk_11[3];
-    /* 0x014:0x570 */ u16 unk_14;
-    /* 0x016:0x572 */ u8 unk_16;
-}; // size: 0x018
-
-struct UnkSaveBlock2Substruct_B0
-{
-    /* 0x000:0x0B0 */ u8 field_0[0x3F0];
-    /* 0x3F0:0x4A0 */ struct BattleTowerEReaderTrainer field_3F0;
-    /* 0x4AC:0x55C */ struct UnkSaveBlock2Substruct_55C field_4AC;
-    /* 0x4C4:0x574 */ u8 field_4C4[0x324];
-}; // size: 0x7E8
+struct BattleTowerData // Leftover from R/S
+{
+    /*0x0000, 0x00B0*/ struct BattleTowerRecord playerRecord;
+    /*0x00A4, 0x0154*/ struct BattleTowerRecord records[5]; // from record mixing
+    /*0x03D8, 0x0488*/ u16 firstMonSpecies; // species of the first pokemon in the player's battle tower party
+    /*0x03DA, 0x048A*/ u16 defeatedBySpecies; // species of the pokemon that defated the player
+    /*0x03DC, 0x048C*/ u8 defeatedByTrainerName[8];
+    /*0x03E4, 0x0494*/ u8 firstMonNickname[POKEMON_NAME_LENGTH]; // nickname of the first pokemon in the player's battle tower party
+    /*0x03F0, 0x04A0*/ struct BattleTowerEReaderTrainer ereaderTrainer;
+    /*0x04AC, 0x055C*/ u8 battleTowerLevelType:1; // 0 = level 50; 1 = level 100
+    /*0x04AC, 0x055C*/ u8 unk_554:1;
+    /*0x04AD, 0x055D*/ u8 battleOutcome;
+    /*0x04AE, 0x055E*/ u8 var_4AE[2];
+    /*0x04B0, 0x0560*/ u16 curChallengeBattleNum[2]; // 1-based index of battle in the current challenge. (challenges consist of 7 battles)
+    /*0x04B4, 0x0564*/ u16 curStreakChallengesNum[2]; // 1-based index of the current challenge in the current streak.
+    /*0x04B8, 0x0568*/ u16 recordWinStreaks[2];
+    /*0x04BC, 0x056C*/ u8 battleTowerTrainerId; // index for gBattleTowerTrainers table
+    /*0x04BD, 0x056D*/ u8 selectedPartyMons[0x3]; // indices of the 3 selected player party mons.
+    /*0x04C0, 0x0570*/ u16 prizeItem;
+    /*0x04C2, 0x0572*/ u8 battledTrainerIds[6];
+    /*0x04C8, 0x0578*/ u16 totalBattleTowerWins;
+    /*0x04CA, 0x057A*/ u16 bestBattleTowerWinStreak;
+    /*0x04CC, 0x057C*/ u16 currentWinStreaks[2];
+    /*0x04D0, 0x0580*/ u8 lastStreakLevelType; // 0 = level 50, 1 = level 100.  level type of the last streak. Used by tv to report the level mode.
+    /*0x04D1, 0x0581*/ u8 filler_4D1[0x317];
+};
 
 struct SaveBlock2
 {
@@ -287,7 +303,7 @@ struct SaveBlock2
     /*0x0A8*/ u32 field_A8;
     /*0x0AC*/ u8 field_AC;
     /*0x0AD*/ u8 field_AD;
-    /*0x0B0*/ struct UnkSaveBlock2Substruct_B0 unk_B0;
+    /*0x0B0*/ struct BattleTowerData battleTower;
     /*0x898*/ u16 mapView[0x100];
     /*0xA98*/ struct LinkBattleRecords linkBattleRecords;
     /*0xAF0*/ struct BerryCrush berryCrush;
diff --git a/src/battle_setup.c b/src/battle_setup.c
index 98437e279..b9da39ddb 100644
--- a/src/battle_setup.c
+++ b/src/battle_setup.c
@@ -645,7 +645,7 @@ static u8 GetTrainerBattleTransition(void)
         return sBattleTransitionTable_Trainer[transitionType][1];
 }
 
-u8 sub_8080060(void)
+u8 BattleSetup_GetBattleTowerBattleTransition(void)
 {
     u8 enemyLevel = GetMonData(&gEnemyParty[0], MON_DATA_LEVEL);
     u8 playerLevel = GetSumOfPlayerPartyLevel(1);
diff --git a/src/mevent.c b/src/mevent.c
index 846ccbaa8..671e30ee0 100644
--- a/src/mevent.c
+++ b/src/mevent.c
@@ -588,7 +588,7 @@ void DestroyWonderCard(void)
     ClearRamScript();
     sub_806E2D0();
     sub_806E370();
-    sub_80E7524(&gSaveBlock2Ptr->unk_B0.field_3F0);
+    sub_80E7524(&gSaveBlock2Ptr->battleTower.ereaderTrainer);
 }
 
 bool32 sub_8143F68(const struct MEWonderCardData * data)
diff --git a/src/mevent_client.c b/src/mevent_client.c
index f4432cc11..c2a86afdd 100644
--- a/src/mevent_client.c
+++ b/src/mevent_client.c
@@ -217,7 +217,7 @@ static u32 client_mainseq_4(struct mevent_client * svr)
         MEventSetRamScript(svr->recvBuffer, 1000);
         break;
     case 18:
-        memcpy(&gSaveBlock2Ptr->unk_B0.field_3F0, svr->recvBuffer, sizeof(struct BattleTowerEReaderTrainer));
+        memcpy(&gSaveBlock2Ptr->battleTower.ereaderTrainer, svr->recvBuffer, sizeof(struct BattleTowerEReaderTrainer));
         ValidateEReaderTrainer();
         break;
     case 21:
diff --git a/src/mystery_event_script.c b/src/mystery_event_script.c
index 68a045f2c..c73d7445b 100644
--- a/src/mystery_event_script.c
+++ b/src/mystery_event_script.c
@@ -281,7 +281,7 @@ bool8 MEScrCmd_givepokemon(struct ScriptContext *ctx)
 bool8 MEScrCmd_addtrainer(struct ScriptContext *ctx)
 {
     u32 data = ScriptReadWord(ctx) - ctx->data[1] + ctx->data[0];
-    memcpy(&gSaveBlock2Ptr->unk_B0.field_3F0, (void *)data, sizeof(struct BattleTowerEReaderTrainer));
+    memcpy(&gSaveBlock2Ptr->battleTower.ereaderTrainer, (void *)data, sizeof(struct BattleTowerEReaderTrainer));
     ValidateEReaderTrainer();
     StringExpandPlaceholders(gStringVar4, gText_MysteryGiftNewTrainer);
     ctx->data[2] = 2;
diff --git a/src/new_game.c b/src/new_game.c
index 4b5432a95..0d71a5652 100644
--- a/src/new_game.c
+++ b/src/new_game.c
@@ -78,7 +78,7 @@ static void ClearPokedexFlags(void)
 
 static void sub_80549D4(void)
 {
-    CpuFill32(0, &gSaveBlock2Ptr->unk_B0, sizeof(gSaveBlock2Ptr->unk_B0));
+    CpuFill32(0, &gSaveBlock2Ptr->battleTower, sizeof(gSaveBlock2Ptr->battleTower));
 }
 
 static void WarpToPlayersRoom(void)
diff --git a/src/quest_log_8150454.c b/src/quest_log_8150454.c
index 0e603bf63..09cf47f93 100644
--- a/src/quest_log_8150454.c
+++ b/src/quest_log_8150454.c
@@ -60,7 +60,7 @@ static void sub_81504A8(void)
     struct MapObject *mapObject = &gMapObjects[gPlayerAvatar.mapObjectId];
     sub_81507BC(mapObject, sub_805C808(0));
     FieldObjectTurn(mapObject, mapObject->placeholder18);
-    SetPlayerAvatarStateMask(0x01);
+    SetPlayerAvatarStateMask(PLAYER_AVATAR_FLAG_ON_FOOT);
 }
 
 static void sub_81504E8(void)
@@ -68,7 +68,7 @@ static void sub_81504E8(void)
     struct MapObject *mapObject = &gMapObjects[gPlayerAvatar.mapObjectId];
     sub_81507BC(mapObject, sub_805C808(1));
     FieldObjectTurn(mapObject, mapObject->placeholder18);
-    SetPlayerAvatarStateMask(0x02);
+    SetPlayerAvatarStateMask(PLAYER_AVATAR_FLAG_MACH_BIKE);
     sub_80BD620(0, 0);
 }
 
@@ -122,7 +122,7 @@ static void sub_81505C4(u8 taskId)
             sub_805D9C4(sprite);
             if (sprite->animEnded)
             {
-                if (!(gPlayerAvatar.flags & 8))
+                if (!(gPlayerAvatar.flags & PLAYER_AVATAR_FLAG_SURFING))
                     sub_81507BC(mapObject, sub_805C808(0));
                 else
                     sub_81507BC(mapObject, sub_805C808(2));
@@ -141,11 +141,11 @@ static void sub_8150708(void)
     struct MapObject *mapObject = &gMapObjects[gPlayerAvatar.mapObjectId];
     u8 fieldEffectId;
 
-    if (!(gPlayerAvatar.flags & 0x08))
+    if (!(gPlayerAvatar.flags & PLAYER_AVATAR_FLAG_SURFING))
     {
         sub_81507BC(mapObject, sub_805C808(2));
         FieldObjectTurn(mapObject, mapObject->placeholder18);
-        SetPlayerAvatarStateMask(0x08);
+        SetPlayerAvatarStateMask(PLAYER_AVATAR_FLAG_SURFING);
         gFieldEffectArguments[0] = mapObject->coords2.x;
         gFieldEffectArguments[1] = mapObject->coords2.y;
         gFieldEffectArguments[2] = gPlayerAvatar.mapObjectId;
diff --git a/src/trainer_tower.c b/src/trainer_tower.c
index cd796bf3a..a4b511725 100644
--- a/src/trainer_tower.c
+++ b/src/trainer_tower.c
@@ -954,7 +954,7 @@ static void sub_815E160(void)
     BuildEnemyParty();
     CreateTask(sub_815E124, 1);
     PlayMapChosenOrBattleBGM(0);
-    BT_StartOnField(sub_8080060());
+    BT_StartOnField(BattleSetup_GetBattleTowerBattleTransition());
 }
 
 static void sub_815E1C0(void)