Begin documenting Battle Pike and Frontier Util

8 files changed, 90 insertions, 55 deletions

diff --git a/include/constants/battle_frontier.h b/include/constants/battle_frontier.h
index 54d50c18a..7fcebb452 100644
--- a/include/constants/battle_frontier.h
+++ b/include/constants/battle_frontier.h
@@ -12,7 +12,8 @@
 #define FRONTIER_FACILITY_PIKE     5
 #define FRONTIER_FACILITY_PYRAMID  6
 #define NUM_FRONTIER_FACILITIES    7
-// The multiplayer battle colosseum rooms re-use VAR_FRONTIER_FACILITY.
+// VAR_FRONTIER_FACILITY is re-used for the below facilities as well
+#define FACILITY_LINK_CONTEST      7
 #define FACILITY_UNION_ROOM        8
 #define FACILITY_MULTI_OR_EREADER  9  // Direct Corner multi battles, multi battle with Steven, and e-Reader battles
 
@@ -21,15 +22,23 @@
 #define TENT_SLATEPORT 4
 
 // Battle Frontier lvl modes.
-#define FRONTIER_LVL_50 0
+#define FRONTIER_LVL_50   0
 #define FRONTIER_LVL_OPEN 1
 #define FRONTIER_LVL_TENT 2
 
 // Battle Frontier battle modes.
-#define FRONTIER_MODE_SINGLES 0
-#define FRONTIER_MODE_DOUBLES 1
-#define FRONTIER_MODE_MULTIS 2
-#define FRONTIER_MODE_LINK_MULTIS 3
+#define FRONTIER_MODE_SINGLES      0
+#define FRONTIER_MODE_DOUBLES      1
+#define FRONTIER_MODE_MULTIS       2
+#define FRONTIER_MODE_LINK_MULTIS  3
+#define FRONTIER_MODE_COUNT        4
+
+// TODO
+#define CHALLENGE_STATUS_INACTIVE 0
+#define CHALLENGE_STATUS_CANCEL   1
+#define CHALLENGE_STATUS_ONGOING  2
+#define CHALLENGE_STATUS_WON      3
+#define CHALLENGE_STATUS_LOST     4
 
 // Special trainer battles.
 #define SPECIAL_BATTLE_TOWER 0
@@ -86,9 +95,6 @@
 
 #define FRONTIER_GAMBLER_CHALLENGE_COUNT 12
 
-// For 'ShowFacilityResultsWindow' function which is a part of the 'CallFrontierUtilFunc' special.
-#define RESULTS_LINK_CONTEST 7
-
 #define EXCHANGE_CORNER_DECOR1_CLERK     0
 #define EXCHANGE_CORNER_DECOR2_CLERK     1
 #define EXCHANGE_CORNER_VITAMIN_CLERK    2
diff --git a/include/constants/battle_pike.h b/include/constants/battle_pike.h
index e92c4a006..4fb20550e 100644
--- a/include/constants/battle_pike.h
+++ b/include/constants/battle_pike.h
@@ -10,6 +10,17 @@
 #define PIKE_ROOM_HARD_BATTLE 6
 #define PIKE_ROOM_DOUBLE_BATTLE 7
 #define PIKE_ROOM_BRAIN 8
+#define NUM_PIKE_ROOM_TYPES 9
+
+#define PIKE_ROOM_LEFT    0
+#define PIKE_ROOM_CENTER  1
+#define PIKE_ROOM_RIGHT   2
+
+#define PIKE_HINT_NOSTALGIA  0
+#define PIKE_HINT_WHISPERING 1
+#define PIKE_HINT_POKEMON    2
+#define PIKE_HINT_PEOPLE     3
+#define PIKE_HINT_BRAIN      4
 
 // For the room with a status effect.
 #define PIKE_STATUS_KIRLIA 0
@@ -19,8 +30,8 @@
 #define BATTLE_PIKE_FUNC_SET_ROOM_TYPE                0
 #define BATTLE_PIKE_FUNC_GET_DATA                     1
 #define BATTLE_PIKE_FUNC_SET_DATA                     2
-#define BATTLE_PIKE_FUNC_IN_FINAL_ROOM                3
-#define BATTLE_PIKE_FUNC_SET_UP_ROOM_OBJECTS          4
+#define BATTLE_PIKE_FUNC_IS_FINAL_ROOM                3
+#define BATTLE_PIKE_FUNC_SET_ROOM_OBJECTS             4
 #define BATTLE_PIKE_FUNC_GET_ROOM_TYPE                5
 #define BATTLE_PIKE_FUNC_6                            6
 #define BATTLE_PIKE_FUNC_7                            7
@@ -34,14 +45,14 @@
 #define BATTLE_PIKE_FUNC_STATUS_SCREEN_FADE           15
 #define BATTLE_PIKE_FUNC_IS_IN                        16
 #define BATTLE_PIKE_FUNC_SET_HINT_ROOM                17
-#define BATTLE_PIKE_FUNC_SET_HINT_ROOM_ID             18
+#define BATTLE_PIKE_FUNC_GET_HINT_ROOM_ID             18
 #define BATTLE_PIKE_FUNC_GET_ROOM_TYPE_HINT           19
 #define BATTLE_PIKE_FUNC_CLEAR_TRAINER_IDS            20
 #define BATTLE_PIKE_FUNC_BUFFER_RECORD_MIX_MSG        21
 #define BATTLE_PIKE_FUNC_GET_QUEEN_FIGHT_TYPE         22
 #define BATTLE_PIKE_FUNC_HEAL_MONS_BEFORE_QUEEN       23
 #define BATTLE_PIKE_FUNC_SET_HEALING_ROOMS_DISABLED   24
-#define BATTLE_PIKE_FUNC_CAN_PARTY_BE_HEALED          25
+#define BATTLE_PIKE_FUNC_IS_PARTY_FULL_HEALTH         25
 #define BATTLE_PIKE_FUNC_SAVE_MON_HELD_ITEMS          26
 #define BATTLE_PIKE_FUNC_LOAD_MON_HELD_ITEMS          27
 #define BATTLE_PIKE_FUNC_INIT_CHALLENGE               28
diff --git a/include/constants/frontier_util.h b/include/constants/frontier_util.h
index 52bde509f..4a4804995 100644
--- a/include/constants/frontier_util.h
+++ b/include/constants/frontier_util.h
@@ -5,16 +5,24 @@
 #define FRONTIER_PLAYER_LOST_TEXT 1
 #define FRONTIER_PLAYER_WON_TEXT  2
 
-#define FRONTIER_UTIL_FUNC_0                      0
-#define FRONTIER_UTIL_FUNC_1                      1
-#define FRONTIER_UTIL_FUNC_2                      2
+// return values for GetFrontierBrainStatus
+#define FRONTIER_BRAIN_NOT_READY   0
+#define FRONTIER_BRAIN_SILVER      1
+#define FRONTIER_BRAIN_GOLD        2
+#define FRONTIER_BRAIN_STREAK      3  // for encountering the brain after getting both symbols
+#define FRONTIER_BRAIN_STREAK_LONG 4  //
+
+
+#define FRONTIER_UTIL_FUNC_GET_STATUS             0
+#define FRONTIER_UTIL_FUNC_GET_DATA               1
+#define FRONTIER_UTIL_FUNC_SET_DATA               2
 #define FRONTIER_UTIL_FUNC_LOAD_SELECTED_PARTY    3
 #define FRONTIER_UTIL_FUNC_SOFT_RESET             4
 #define FRONTIER_UTIL_FUNC_SET_FRONTIER_TRAINERS  5
 #define FRONTIER_UTIL_FUNC_6                      6
 #define FRONTIER_UTIL_FUNC_RESULTS_WINDOW         7
 #define FRONTIER_UTIL_FUNC_8                      8
-#define FRONTIER_UTIL_FUNC_9                      9
+#define FRONTIER_UTIL_FUNC_GET_BRAIN_STATUS       9
 #define FRONTIER_UTIL_FUNC_IS_FRONTIER_BRAIN      10
 #define FRONTIER_UTIL_FUNC_11                     11
 #define FRONTIER_UTIL_FUNC_GET_FACILITY_SYMBOLS   12
@@ -26,7 +34,16 @@
 #define FRONTIER_UTIL_FUNC_18                     18
 #define FRONTIER_UTIL_FUNC_19                     19
 #define FRONTIER_UTIL_FUNC_BUFFER_TRAINER_NAME    20
-#define FRONTIER_UTIL_FUNC_21                     21
+#define FRONTIER_UTIL_FUNC_RESET_SKETCH_MOVES     21
 #define FRONTIER_UTIL_FUNC_SET_BRAIN_OBJECT       22
 
+#define FRONTIER_DATA_CHALLENGE_STATUS   0
+#define FRONTIER_DATA_LVL_MODE           1
+#define FRONTIER_DATA_BATTLE_NUM         2
+#define FRONTIER_DATA_3                  3
+#define FRONTIER_DATA_4                  4
+#define FRONTIER_DATA_BATTLE_OUTCOME     5
+#define FRONTIER_DATA_6                  6
+#define FRONTIER_DATA_SYMBOL             7
+
 #endif // GUARD_CONSTANTS_FRONTIER_UTIL_H
diff --git a/include/constants/layouts.h b/include/constants/layouts.h
index fe905a2c6..ba20cb3a5 100755
--- a/include/constants/layouts.h
+++ b/include/constants/layouts.h
@@ -352,13 +352,13 @@
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_LOBBY 349
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_CORRIDOR 350
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_THREE_PATH_ROOM 351
-#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM1 352
-#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM2 353
+#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_NORMAL 352
+#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_FINAL 353
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_ARENA_LOBBY 354
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_ARENA_CORRIDOR 355
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_ARENA_BATTLE_ROOM 356
 #define LAYOUT_SOOTOPOLIS_CITY_LEGENDS_BATTLE 357
-#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM3 358
+#define LAYOUT_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_WILD_MONS 358
 #define LAYOUT_UNKNOWN_084693AC 359
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_PYRAMID_LOBBY 360
 #define LAYOUT_BATTLE_FRONTIER_BATTLE_PYRAMID_EMPTY_SQUARE 361
diff --git a/include/constants/map_groups.h b/include/constants/map_groups.h
index bedaaca2a..14b3f1d56 100755
--- a/include/constants/map_groups.h
+++ b/include/constants/map_groups.h
@@ -498,9 +498,9 @@
 #define MAP_BATTLE_FRONTIER_BATTLE_PIKE_LOBBY              (34 | (26 << 8))
 #define MAP_BATTLE_FRONTIER_BATTLE_PIKE_CORRIDOR           (35 | (26 << 8))
 #define MAP_BATTLE_FRONTIER_BATTLE_PIKE_THREE_PATH_ROOM    (36 | (26 << 8))
-#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM1       (37 | (26 << 8))
-#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM2       (38 | (26 << 8))
-#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_RANDOM_ROOM3       (39 | (26 << 8))
+#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_NORMAL        (37 | (26 << 8))
+#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_FINAL         (38 | (26 << 8))
+#define MAP_BATTLE_FRONTIER_BATTLE_PIKE_ROOM_WILD_MONS     (39 | (26 << 8))
 #define MAP_BATTLE_FRONTIER_RANKING_HALL                   (40 | (26 << 8))
 #define MAP_BATTLE_FRONTIER_LOUNGE1                        (41 | (26 << 8))
 #define MAP_BATTLE_FRONTIER_EXCHANGE_SERVICE_CORNER        (42 | (26 << 8))
diff --git a/include/frontier_util.h b/include/frontier_util.h
index 627b5bef5..adea712e0 100644
--- a/include/frontier_util.h
+++ b/include/frontier_util.h
@@ -2,7 +2,7 @@
 #define GUARD_FRONTIER_UTIL_H
 
 void CallFrontierUtilFunc(void);
-u8 sub_81A3610(void);
+u8 GetFrontierBrainStatus(void);
 void CopyFrontierTrainerText(u8 whichText, u16 trainerId);
 void sub_81A3908(void);
 u32 GetCurrentFacilityWinStreak(void);
diff --git a/include/global.h b/include/global.h
index d33be5d82..bcb77aaaf 100644
--- a/include/global.h
+++ b/include/global.h
@@ -323,7 +323,7 @@ struct BattleFrontier
     /*0xBE3*/ u8 field_BE0[POKEMON_NAME_LENGTH + 1];
     /*0xBEB*/ u8 field_BEB;
     /*0xBEC*/ struct BattleTowerEReaderTrainer ereaderTrainer;
-    /*0xCA8*/ u8 field_CA8;
+    /*0xCA8*/ u8 challengeOutcome;
     /*0xCA9*/ u8 lvlMode:2; // 0x1, 0x2 -> 0x3
     /*0xCA9*/ u8 field_CA9_a:1;   // 0x4
     /*0xCA9*/ u8 field_CA9_b:1;   // 0x8
@@ -338,7 +338,7 @@ struct BattleFrontier
     /*0xCDC*/ u32 field_CDC;
     /*0xCE0*/ u16 towerWinStreaks[4][2];
     /*0xCF0*/ u16 towerRecordWinStreaks[4][2];
-    /*0xD00*/ u16 field_D00;
+    /*0xD00*/ u16 symbolFlags;
     /*0xD02*/ u16 field_D02;
     /*0xD04*/ u16 field_D04;
     /*0xD06*/ u8 field_D06;
diff --git a/include/strings.h b/include/strings.h
index 43b87e888..9eddf1a0e 100644
--- a/include/strings.h
+++ b/include/strings.h
@@ -1326,34 +1326,35 @@ extern const u8 gText_FrontierFacilityRoomsCleared[];
 extern const u8 gText_FrontierFacilityKOsStreak[];
 extern const u8 gText_FrontierFacilityFloorsCleared[];
 
-extern const u8 gText_082C843F[];
-extern const u8 gText_082C848B[];
-extern const u8 gText_082C8628[];
-extern const u8 gText_082C85B4[];
-extern const u8 gText_082C8512[];
-extern const u8 gText_082C859D[];
-extern const u8 gText_082C86C3[];
-extern const u8 gText_082C8458[];
-extern const u8 gText_082C84C1[];
-extern const u8 gText_082C8662[];
-extern const u8 gText_082C85E3[];
-extern const u8 gText_082C853B[];
-extern const u8 gText_082C85A4[];
-extern const u8 gText_082C86FE[];
-extern const u8 gText_082C846C[];
-extern const u8 gText_082C84D0[];
-extern const u8 gText_082C8682[];
-extern const u8 gText_082C85F5[];
-extern const u8 gText_082C8561[];
-extern const u8 gText_082C85A9[];
-extern const u8 gText_082C8739[];
-extern const u8 gText_082C8480[];
-extern const u8 gText_082C84F7[];
-extern const u8 gText_082C86B3[];
-extern const u8 gText_082C8611[];
-extern const u8 gText_082C8589[];
-extern const u8 gText_082C85AE[];
-extern const u8 gText_082C877B[];
+// Frontier Brain
+extern const u8 gText_AnabelWonSilver[];
+extern const u8 gText_TuckerWonSilver[];
+extern const u8 gText_SpenserWonSilver[];
+extern const u8 gText_GretaWonSilver[];
+extern const u8 gText_NolandWonSilver[];
+extern const u8 gText_LucyWonSilver[];
+extern const u8 gText_BrandonWonSilver[];
+extern const u8 gText_AnabelDefeatSilver[];
+extern const u8 gText_TuckerDefeatSilver[];
+extern const u8 gText_SpenserDefeatSilver[];
+extern const u8 gText_GretaDefeatSilver[];
+extern const u8 gText_NolandDefeatSilver[];
+extern const u8 gText_LucyDefeatSilver[];
+extern const u8 gText_BrandonDefeatSilver[];
+extern const u8 gText_AnabelWonGold[];
+extern const u8 gText_TuckerWonGold[];
+extern const u8 gText_SpenserWonGold[];
+extern const u8 gText_GretaWonGold[];
+extern const u8 gText_NolandWonGold[];
+extern const u8 gText_LucyWonGold[];
+extern const u8 gText_BrandonWonGold[];
+extern const u8 gText_AnabelDefeatGold[];
+extern const u8 gText_TuckerDefeatGold[];
+extern const u8 gText_SpenserDefeatGold[];
+extern const u8 gText_GretaDefeatGold[];
+extern const u8 gText_NolandDefeatGold[];
+extern const u8 gText_LucyDefeatGold[];
+extern const u8 gText_BrandonDefeatGold[];
 
 // Battle Tower.
 extern const u8 BattleFrontier_BattleTowerMultiBattleRoom_Text_2479CE[];