Document Frontier Util

1 files changed, 18 insertions, 16 deletions

diff --git a/src/battle_palace.c b/src/battle_palace.c
index 61ccfedfd..ed3fb751e 100644
--- a/src/battle_palace.c
+++ b/src/battle_palace.c
@@ -8,6 +8,8 @@
 #include "item.h"
 #include "string_util.h"
 #include "constants/items.h"
+#include "constants/battle_frontier.h"
+#include "constants/frontier_util.h"
 
 // This file's functions.
 static void sub_8195980(void);
@@ -39,16 +41,16 @@ static void (* const sBattlePalaceFunctions[])(void) =
 static const u16 gUnknown_0860DE78[] = {ITEM_HP_UP, ITEM_PROTEIN, ITEM_IRON, ITEM_CALCIUM, ITEM_CARBOS, ITEM_ZINC};
 static const u16 gUnknown_0860DE84[] = {ITEM_BRIGHT_POWDER, ITEM_WHITE_HERB, ITEM_QUICK_CLAW, ITEM_LEFTOVERS, ITEM_MENTAL_HERB, ITEM_KINGS_ROCK, ITEM_FOCUS_BAND, ITEM_SCOPE_LENS, ITEM_CHOICE_BAND};
 
-static const u32 gUnknown_0860DE98[][2] =
+static const u32 sWinStreakFlags[][2] =
 {
-    {0x10, 0x20},
-    {0x400000, 0x800000},
+    {STREAK_PALACE_SINGLES_50, STREAK_PALACE_SINGLES_OPEN},
+    {STREAK_PALACE_DOUBLES_50, STREAK_PALACE_DOUBLES_OPEN},
 };
 
-static const u32 gUnknown_0860DEA8[][2] =
+static const u32 sWinStreakMasks[][2] =
 {
-    {~0x10, ~0x20},
-    {~0x400000, ~0x800000},
+    {~(STREAK_PALACE_SINGLES_50), ~(STREAK_PALACE_SINGLES_OPEN)},
+    {~(STREAK_PALACE_DOUBLES_50), ~(STREAK_PALACE_DOUBLES_OPEN)},
 };
 
 // code
@@ -62,11 +64,11 @@ static void sub_8195980(void)
     u32 lvlMode = gSaveBlock2Ptr->frontier.lvlMode;
     u32 battleMode = VarGet(VAR_FRONTIER_BATTLE_MODE);
 
-    gSaveBlock2Ptr->frontier.challengeOutcome = 0;
+    gSaveBlock2Ptr->frontier.challengeStatus = 0;
     gSaveBlock2Ptr->frontier.curChallengeBattleNum = 0;
-    gSaveBlock2Ptr->frontier.field_CA9_a = 0;
+    gSaveBlock2Ptr->frontier.challengePaused = FALSE;
     gSaveBlock2Ptr->frontier.field_CA9_b = 0;
-    if (!(gSaveBlock2Ptr->frontier.field_CDC & gUnknown_0860DE98[battleMode][lvlMode]))
+    if (!(gSaveBlock2Ptr->frontier.winStreakActiveFlags & sWinStreakFlags[battleMode][lvlMode]))
         gSaveBlock2Ptr->frontier.palaceWinStreaks[battleMode][lvlMode] = 0;
 
     SetDynamicWarp(0, gSaveBlock1Ptr->location.mapGroup, gSaveBlock1Ptr->location.mapNum, -1);
@@ -87,7 +89,7 @@ static void sub_8195A38(void)
         gSpecialVar_Result = gSaveBlock2Ptr->frontier.palaceWinStreaks[battleMode][lvlMode];
         break;
     case 2:
-        gSpecialVar_Result = ((gSaveBlock2Ptr->frontier.field_CDC & gUnknown_0860DE98[battleMode][lvlMode]) != 0);
+        gSpecialVar_Result = ((gSaveBlock2Ptr->frontier.winStreakActiveFlags & sWinStreakFlags[battleMode][lvlMode]) != 0);
         break;
     }
 }
@@ -107,9 +109,9 @@ static void sub_8195AE4(void)
         break;
     case 2:
         if (gSpecialVar_0x8006)
-            gSaveBlock2Ptr->frontier.field_CDC |= gUnknown_0860DE98[battleMode][lvlMode];
+            gSaveBlock2Ptr->frontier.winStreakActiveFlags |= sWinStreakFlags[battleMode][lvlMode];
         else
-            gSaveBlock2Ptr->frontier.field_CDC &= gUnknown_0860DEA8[battleMode][lvlMode];
+            gSaveBlock2Ptr->frontier.winStreakActiveFlags &= sWinStreakMasks[battleMode][lvlMode];
         break;
     }
 }
@@ -144,7 +146,7 @@ static void sub_8195C7C(void)
     u8 lvlMode = gSaveBlock2Ptr->frontier.lvlMode;
     u8 battleMode = VarGet(VAR_FRONTIER_BATTLE_MODE);
 
-    if (gSaveBlock2Ptr->frontier.palaceWinStreaks[battleMode][lvlMode] < 9999)
+    if (gSaveBlock2Ptr->frontier.palaceWinStreaks[battleMode][lvlMode] < MAX_STREAK)
     {
         gSaveBlock2Ptr->frontier.palaceWinStreaks[battleMode][lvlMode]++;
 
@@ -156,10 +158,10 @@ static void sub_8195C7C(void)
 
 static void sub_8195CE4(void)
 {
-    gSaveBlock2Ptr->frontier.challengeOutcome = gSpecialVar_0x8005;
+    gSaveBlock2Ptr->frontier.challengeStatus = gSpecialVar_0x8005;
     VarSet(VAR_TEMP_0, 0);
-    gSaveBlock2Ptr->frontier.field_CA9_a = 1;
-    sub_81A4C30();
+    gSaveBlock2Ptr->frontier.challengePaused = TRUE;
+    SaveGameFrontier();
 }
 
 static void sub_8195D28(void)