Misc contest cleanup

7 files changed, 76 insertions, 65 deletions

diff --git a/src/contest.c b/src/contest.c
index 59f50fcfc..7dd420c20 100644
--- a/src/contest.c
+++ b/src/contest.c
@@ -1034,7 +1034,7 @@ void LoadContestBgAfterMoveAnim(void)
     {
         u32 contestantWindowId = 5 + i;
 
-        LoadPalette(eUnknownHeap1A004.cachedWindowPalettes[contestantWindowId], 16 * (5 + gContestantTurnOrder[i]), sizeof((eUnknownHeap1A004.cachedWindowPalettes[contestantWindowId])));
+        LoadPalette(eContestTempSave.cachedWindowPalettes[contestantWindowId], 16 * (5 + gContestantTurnOrder[i]), sizeof((eContestTempSave.cachedWindowPalettes[contestantWindowId])));
     }
 }
 
@@ -1320,7 +1320,7 @@ static bool8 SetupContestGraphics(u8 *stateVar)
         CopyToBgTilemapBuffer(2, gUnknown_08C17170, 0, 0);
         CopyBgTilemapBufferToVram(2);
         // This is a bug, and copies random junk. savedJunk is never read.
-        DmaCopy32Defvars(3, gContestResources->contestBgTilemaps[2], eUnknownHeap1A004.savedJunk, sizeof(eUnknownHeap1A004.savedJunk));
+        DmaCopy32Defvars(3, gContestResources->contestBgTilemaps[2], eContestTempSave.savedJunk, sizeof(eContestTempSave.savedJunk));
         break;
     case 5:
         LoadCompressedPalette(gOldContestPalette, 0, 0x200);
@@ -1328,7 +1328,7 @@ static bool8 SetupContestGraphics(u8 *stateVar)
         CpuCopy32(gPlttBufferUnfaded + (5 + gContestPlayerMonIndex) * 16, tempPalette2, 16 * sizeof(u16));
         CpuCopy32(tempPalette2, gPlttBufferUnfaded + 128, 16 * sizeof(u16));
         CpuCopy32(tempPalette1, gPlttBufferUnfaded + (5 + gContestPlayerMonIndex) * 16, 16 * sizeof(u16));
-        DmaCopy32Defvars(3, gPlttBufferUnfaded, eUnknownHeap1A004.cachedWindowPalettes, sizeof(eUnknownHeap1A004.cachedWindowPalettes));
+        DmaCopy32Defvars(3, gPlttBufferUnfaded, eContestTempSave.cachedWindowPalettes, sizeof(eContestTempSave.cachedWindowPalettes));
         LoadContestPalettes();
         break;
     case 6:
@@ -1468,7 +1468,7 @@ static void Task_DisplayAppealNumberText(u8 taskId)
         gBattle_BG0_Y = 0;
         gBattle_BG2_Y = 0;
         ContestDebugDoPrint();
-        DmaCopy32Defvars(3, gPlttBufferUnfaded, eUnknownHeap1A004.unk18204, PLTT_BUFFER_SIZE * 2);
+        DmaCopy32Defvars(3, gPlttBufferUnfaded, eContestTempSave.cachedPlttBufferUnfaded, PLTT_BUFFER_SIZE * 2);
         ConvertIntToDecimalStringN(gStringVar1, eContest.appealNumber + 1, STR_CONV_MODE_LEFT_ALIGN, 1);
         if (!Contest_IsMonsTurnDisabled(gContestPlayerMonIndex))
             StringCopy(gDisplayedStringBattle, gText_AppealNumWhichMoveWillBePlayed);
@@ -1667,8 +1667,8 @@ static void Task_HideMoveSelectScreen(u8 taskId)
     }
     Contest_SetBgCopyFlags(0);
     // This seems to be a bug; it should have just copied PLTT_BUFFER_SIZE.
-    DmaCopy32Defvars(3, gPlttBufferFaded, eUnknownHeap1A004.unk18604, PLTT_BUFFER_SIZE * 2);
-    LoadPalette(eUnknownHeap1A004.unk18204, 0, PLTT_BUFFER_SIZE * 2);
+    DmaCopy32Defvars(3, gPlttBufferFaded, eContestTempSave.cachedPlttBufferFaded, PLTT_BUFFER_SIZE * 2);
+    LoadPalette(eContestTempSave.cachedPlttBufferUnfaded, 0, PLTT_BUFFER_SIZE * 2);
     gTasks[taskId].data[0] = 0;
     gTasks[taskId].data[1] = 0;
     gTasks[taskId].func = Task_HideApplauseMeterForAppealStart;
@@ -2554,7 +2554,7 @@ static void Task_WaitForHeartSliders(u8 taskId)
 
 static void sub_80DA348(u8 taskId)
 {
-    DmaCopy32Defvars(3, eUnknownHeap1A004.unk18204, gPlttBufferUnfaded, PLTT_BUFFER_SIZE * 2);
+    DmaCopy32Defvars(3, eContestTempSave.cachedPlttBufferUnfaded, gPlttBufferUnfaded, PLTT_BUFFER_SIZE * 2);
     gTasks[taskId].data[0] = 0;
     gTasks[taskId].data[1] = 2;
     gTasks[taskId].func = Task_WaitPrintRoundResult;
@@ -4412,7 +4412,7 @@ static void DrawContestantWindows(void)
     for (i = 0; i < CONTESTANT_COUNT; i++)
     {
         s32 windowId = i + 5;
-        LoadPalette(eUnknownHeap1A004.cachedWindowPalettes[windowId], (gContestantTurnOrder[i] + 5) * 16, sizeof(eUnknownHeap1A004.cachedWindowPalettes[0]));
+        LoadPalette(eContestTempSave.cachedWindowPalettes[windowId], (gContestantTurnOrder[i] + 5) * 16, sizeof(eContestTempSave.cachedWindowPalettes[0]));
     }
     DrawContestantWindowText();
 }
@@ -5530,7 +5530,6 @@ bool8 SaveContestWinner(u8 rank)
     if (rank == CONTEST_SAVE_FOR_MUSEUM && i != gContestPlayerMonIndex)
         return FALSE;
 
-
     // Adjust the random painting caption depending on the category
     switch (gSpecialVar_ContestCategory)
     {
diff --git a/src/contest_painting.c b/src/contest_painting.c
index ca5d8c0a9..d4bc8ca04 100644
--- a/src/contest_painting.c
+++ b/src/contest_painting.c
@@ -159,7 +159,7 @@ static const struct OamData sContestPaintingMonOamData =
     .paletteNum = 0,
 };
 
-static const u16 sBg_Palette[] = {RGB_BLACK, RGB_BLACK};
+static const u16 sBgPalette[] = {RGB_BLACK, RGB_BLACK};
 
 void SetContestWinnerForPainting(int contestWinnerId)
 {
@@ -223,7 +223,7 @@ static void ShowContestPainting(void)
         break;
     case 4:
         PrintContestPaintingCaption(gCurContestWinnerSaveIdx, gCurContestWinnerIsForArtist);
-        LoadPalette(sBg_Palette, 0, 1 * 2);
+        LoadPalette(sBgPalette, 0, 1 * 2);
         DmaClear32(3, PLTT, PLTT_SIZE);
         BeginFastPaletteFade(2);
         SetVBlankCallback(VBlankCB_ContestPainting);
@@ -278,12 +278,13 @@ static void InitContestPaintingWindow(void)
     ShowBg(1);
 }
 
-static void PrintContestPaintingCaption(u8 contestType, bool8 noCaption)
+static void PrintContestPaintingCaption(u8 contestType, bool8 isForArtist)
 {
     int x;
     u8 category;
 
-    if (noCaption == TRUE)
+    // Artist's painting has no caption
+    if (isForArtist == TRUE)
         return;
 
     category = gContestPaintingWinner->contestCategory;
@@ -294,7 +295,7 @@ static void PrintContestPaintingCaption(u8 contestType, bool8 noCaption)
         StringAppend(gStringVar1, gText_Space);
         StringAppend(gStringVar1, sContestRankNames[gContestPaintingWinner->contestRank]);
         StringCopy(gStringVar2, gContestPaintingWinner->trainerName);
-        sub_81DB5AC(gStringVar2);
+        ConvertInternationalContestantName(gStringVar2);
         StringCopy(gStringVar3, gContestPaintingWinner->monName);
         StringExpandPlaceholders(gStringVar4, gContestHallPaintingCaption);
     }
diff --git a/src/contest_util.c b/src/contest_util.c
index c490a2f0e..167f49876 100644
--- a/src/contest_util.c
+++ b/src/contest_util.c
@@ -856,7 +856,7 @@ static void Task_AnnounceWinner(u8 taskId)
             gTasks[taskId].tTimer = 0;
             GET_CONTEST_WINNER_ID(i);
             StringCopy(gStringVar1, gContestMons[i].trainerName);
-            sub_81DB5AC(gStringVar1);
+            ConvertInternationalContestantName(gStringVar1);
             StringCopy(gStringVar2, gContestMons[i].nickname);
             StringExpandPlaceholders(winnerTextBuffer, gText_ContestantsMonWon);
             x = DrawResultsTextWindow(winnerTextBuffer, sContestResults->data->slidingTextBoxSpriteId);
@@ -2057,7 +2057,7 @@ void GiveMonContestRibbon(void)
 void BufferContestantTrainerName(void)
 {
     StringCopy(gStringVar1, gContestMons[gSpecialVar_0x8006].trainerName);
-    sub_81DB5AC(gStringVar1);
+    ConvertInternationalContestantName(gStringVar1);
 }
 
 void BufferContestantMonNickname(void)
@@ -2096,7 +2096,7 @@ void BufferContestWinnerTrainerName(void)
     u8 i;
     GET_CONTEST_WINNER_ID(i);
     StringCopy(gStringVar3, gContestMons[i].trainerName);
-    sub_81DB5AC(gStringVar3);
+    ConvertInternationalContestantName(gStringVar3);
 }
 
 void BufferContestWinnerMonName(void)
@@ -2279,6 +2279,10 @@ static void Task_LinkContest_WaitDisconnect(u8 taskId)
     }
 }
 
+/*
+    A section of contest script functions starts here
+*/
+
 void SetContestTrainerGfxIds(void)
 {
     gSaveBlock1Ptr->vars[VAR_OBJ_GFX_ID_0 - VARS_START] = gContestMons[0].trainerGfxId;
@@ -2287,27 +2291,27 @@ void SetContestTrainerGfxIds(void)
 }
 
 // Unused
-void sub_80F8814(void)
+void GetNpcContestantLocalId(void)
 {
-    u16 var1;
-    u8 var0 = gSpecialVar_0x8005;
-    switch (var0)
+    u16 localId;
+    u8 contestant = gSpecialVar_0x8005;
+    switch (contestant)
     {
     case 0:
-        var1 = 3;
+        localId = 3;
         break;
     case 1:
-        var1 = 4;
+        localId = 4;
         break;
     case 2:
-        var1 = 5;
+        localId = 5;
         break;
-    default:
-        var1 = 100;
+    default: // Invalid
+        localId = 100;
         break;
     }
 
-    gSpecialVar_0x8004 = var1;
+    gSpecialVar_0x8004 = localId;
 }
 
 void BufferContestTrainerAndMonNames(void)
@@ -2318,26 +2322,26 @@ void BufferContestTrainerAndMonNames(void)
 }
 
 // Unused
-void DoesContestCategoryHaveWinner(void)
+void DoesContestCategoryHaveMuseumPainting(void)
 {
     int contestWinner;
     switch (gSpecialVar_ContestCategory)
     {
     case CONTEST_CATEGORY_COOL:
-        contestWinner = 8;
+        contestWinner = CONTEST_WINNER_MUSEUM_COOL - 1;
         break;
     case CONTEST_CATEGORY_BEAUTY:
-        contestWinner = 9;
+        contestWinner = CONTEST_WINNER_MUSEUM_BEAUTY - 1;
         break;
     case CONTEST_CATEGORY_CUTE:
-        contestWinner = 10;
+        contestWinner = CONTEST_WINNER_MUSEUM_CUTE - 1;
         break;
     case CONTEST_CATEGORY_SMART:
-        contestWinner = 11;
+        contestWinner = CONTEST_WINNER_MUSEUM_SMART - 1;
         break;
     case CONTEST_CATEGORY_TOUGH:
     default:
-        contestWinner = 12;
+        contestWinner = CONTEST_WINNER_MUSEUM_TOUGH - 1;
         break;
     }
 
@@ -2366,14 +2370,14 @@ void ShouldReadyContestArtist(void)
     }
 }
 
-u8 CountPlayerContestPaintings(void)
+u8 CountPlayerMuseumPaintings(void)
 {
     int i;
     u8 count = 0;
 
-    for (i = 0; i < 5; i++)
+    for (i = 0; i < NUM_CONTEST_WINNERS - MUSEUM_CONTEST_WINNERS_START; i++)
     {
-        if (gSaveBlock1Ptr->contestWinners[8 + i].species)
+        if (gSaveBlock1Ptr->contestWinners[MUSEUM_CONTEST_WINNERS_START + i].species)
             count++;
     }
 
@@ -2381,19 +2385,21 @@ u8 CountPlayerContestPaintings(void)
 }
 
 // Unused
-void sub_80F8970(void)
+void GetContestantNamesAtRank(void)
 {
     s16 conditions[CONTESTANT_COUNT];
     int i, j;
     s16 condition;
-    s8 var0;
-    u8 var2;
-    u8 r8;
-    u8 r7;
+    s8 numAtCondition;
+    u8 contestantOffset;
+    u8 tieRank;
+    u8 rank;
 
+    // Get round 1 points
     for (i = 0; i < CONTESTANT_COUNT; i++)
         conditions[i] = gContestMonRound1Points[i];
 
+    // Sort round 1 points
     for (i = 0; i < CONTESTANT_COUNT - 1; i++)
     {
         for (j = CONTESTANT_COUNT - 1; j > i; j--)
@@ -2406,47 +2412,54 @@ void sub_80F8970(void)
         }
     }
 
+    // Get round 1 points at specified rank
     condition = conditions[gSpecialVar_0x8006];
-    var0 = 0;
-    r8 = 0;
+
+    // Count number of contestants with the same number of points
+    numAtCondition = 0;
+    tieRank = 0;
     for (i = 0; i < CONTESTANT_COUNT; i++)
     {
         if (conditions[i] == condition)
         {
-            var0++;
+            numAtCondition++;
             if (i == gSpecialVar_0x8006)
-                r8 = var0;
+                tieRank = numAtCondition;
         }
     }
 
+    // Get rank of first contestant with the same number of points
     for (i = 0; i < CONTESTANT_COUNT; i++)
     {
         if (conditions[i] == condition)
             break;
     }
+    rank = i;
 
-    r7 = i;
-    var2 = r8;
+    // Get contestant id of player at rank (taking ties into account)
+    contestantOffset = tieRank;
     for (i = 0; i < CONTESTANT_COUNT; i++)
     {
         if (condition == gContestMonRound1Points[i])
         {
-            if (var2 == 1)
+            if (contestantOffset == 1)
                 break;
-            var2--;
+            contestantOffset--;
         }
     }
 
+    // Use contestant id to get names
     StringCopy(gStringVar1, gContestMons[i].nickname);
     StringCopy(gStringVar2, gContestMons[i].trainerName);
-    sub_81DB5AC(gStringVar2);
+    ConvertInternationalContestantName(gStringVar2);
 
-    if (var0 == 1)
-        gSpecialVar_0x8006 = r7;
-    else if (r8 == var0)
-        gSpecialVar_0x8006 = r7;
+    // Return adjusted rank
+    if (numAtCondition == 1)
+        gSpecialVar_0x8006 = rank;
+    else if (tieRank == numAtCondition)
+        gSpecialVar_0x8006 = rank;
     else
-        gSpecialVar_0x8006 = r7 + 4;
+        gSpecialVar_0x8006 = rank + CONTESTANT_COUNT;
 }
 
 static void ExitContestPainting(void)
diff --git a/src/data/contest_opponents.h b/src/data/contest_opponents.h
index a3d19c36c..b5466904b 100644
--- a/src/data/contest_opponents.h
+++ b/src/data/contest_opponents.h
@@ -192,7 +192,7 @@ const struct ContestWinner gDefaultContestWinners[] =
         .trainerName = _("HANA"),
         .contestRank = CONTEST_RANK_HYPER
     },
-    [CONTEST_WINNER_HALL_UNUSED - 1] = {
+    [CONTEST_WINNER_HALL_UNUSED_1 - 1] = {
         .personality = 0,
         .trainerId = 0xFFFF,
         .species = SPECIES_LOUDRED,
@@ -201,7 +201,7 @@ const struct ContestWinner gDefaultContestWinners[] =
         .trainerName = _("BRYANT"),
         .contestRank = CONTEST_RANK_HYPER
     },
-    [CONTEST_WINNER_MUSEUM_UNUSED - 1] = {
+    [CONTEST_WINNER_HALL_UNUSED_2 - 1] = {
         .personality = 0,
         .trainerId = 0xFFFF,
         .species = SPECIES_DELCATTY,
diff --git a/src/international_string_util.c b/src/international_string_util.c
index ed1e17816..ab812de89 100644
--- a/src/international_string_util.c
+++ b/src/international_string_util.c
@@ -185,7 +185,7 @@ void ConvertInternationalPlayerNameStripChar(u8 *str, u8 removeChar)
     }
 }
 
-void sub_81DB5AC(u8 *str)
+void ConvertInternationalContestantName(u8 *str)
 {
     if (*str++ == EXT_CTRL_CODE_BEGIN && *str++ == EXT_CTRL_CODE_JPN)
     {
diff --git a/src/new_game.c b/src/new_game.c
index 05d86aa8c..2a950efbc 100644
--- a/src/new_game.c
+++ b/src/new_game.c
@@ -48,23 +48,19 @@
 
 extern const u8 EventScript_ResetAllMapFlags[];
 
-// this file's functions
 static void ClearFrontierRecord(void);
 static void WarpToTruck(void);
 static void ResetMiniGamesRecords(void);
 
-// EWRAM vars
 EWRAM_DATA bool8 gDifferentSaveFile = FALSE;
 EWRAM_DATA bool8 gEnableContestDebugging = FALSE;
 
-// const rom data
 static const struct ContestWinner sContestWinnerPicDummy =
 {
     .monName = _(""),
     .trainerName = _("")
 };
 
-// code
 void SetTrainerId(u32 trainerId, u8 *dst)
 {
     dst[0] = trainerId;
@@ -114,7 +110,9 @@ void ClearAllContestWinnerPics(void)
     s32 i;
 
     ClearContestWinnerPicsInContestHall();
-    for (i = 8; i < 13; i++)
+
+    // Clear Museum paintings
+    for (i = MUSEUM_CONTEST_WINNERS_START; i < NUM_CONTEST_WINNERS; i++)
         gSaveBlock1Ptr->contestWinners[i] = sContestWinnerPicDummy;
 }
 
diff --git a/src/trainer_card.c b/src/trainer_card.c
index 03a7b9219..1ec519c90 100755
--- a/src/trainer_card.c
+++ b/src/trainer_card.c
@@ -661,7 +661,7 @@ u32 CountPlayerTrainerStars(void)
         stars++;
     if (HasAllHoennMons())
         stars++;
-    if (CountPlayerContestPaintings() > 4)
+    if (CountPlayerMuseumPaintings() >= CONTEST_CATEGORIES_COUNT)
         stars++;
     if (HasAllFrontierSymbols())
         stars++;
@@ -735,7 +735,7 @@ static void SetPlayerCardData(struct TrainerCard *trainerCard, u8 cardType)
     case CARD_TYPE_FRLG:
         trainerCard->contestsWithFriends = GetCappedGameStat(GAME_STAT_WON_LINK_CONTEST, 999);
         trainerCard->pokeblocksWithFriends = GetCappedGameStat(GAME_STAT_POKEBLOCKS_WITH_FRIENDS, 0xFFFF);
-        if (CountPlayerContestPaintings() > 4)
+        if (CountPlayerMuseumPaintings() >= CONTEST_CATEGORIES_COUNT)
             trainerCard->hasAllPaintings = TRUE;
         trainerCard->stars = GetRubyTrainerStars(trainerCard);
         break;