Document pokenav ribbons summary screen

include/graphics.h

@@ -4033,9 +4033,9 @@ extern const u32 gPokenavLeftHeaderBeauty_Gfx[];
 extern const u32 gPokenavLeftHeaderCute_Gfx[];
 extern const u32 gPokenavLeftHeaderSmart_Gfx[];
 extern const u32 gPokenavLeftHeaderTough_Gfx[];
-extern const u16 gUnknown_08DDE010[];
-extern const u32 gUnknown_08DDE030[];
-extern const u32 gUnknown_08DDE12C[];
+extern const u16 gPokenavRibbonsSummaryBg_Pal[];
+extern const u32 gPokenavRibbonsSummaryBg_Gfx[];
+extern const u32 gPokenavRibbonsSummaryBg_Tilemap[];
 
 extern const u32 gPageInfoTilemap[];
 extern const u32 gUnknown_08D98CC8[];

src/data/text/gift_ribbon_descriptions.h

@@ -46,7 +46,7 @@ const u8 gGiftRibbonDescriptionPart2_LovedPokemon[] = _("for a loved POKéMON.")
 const u8 gGiftRibbonDescriptionPart1_LoveForPokemon[] = _("RIBBON that shows");
 const u8 gGiftRibbonDescriptionPart2_LoveForPokemon[] = _("love for POKéMON.");
 
-const u8 *const gGiftRibbonDescriptionPointers[][2] = 
+const u8 *const gGiftRibbonDescriptionPointers[MAX_GIFT_RIBBON][2] = 
 {
     {gGiftRibbonDescriptionPart1_2003RegionalTourney,   gGiftRibbonDescriptionPart2_Champion},
     {gGiftRibbonDescriptionPart1_2003NationalTourney,   gGiftRibbonDescriptionPart2_Champion},

src/data/text/ribbon_descriptions.h

@@ -20,29 +20,29 @@ const u8 gRibbonDescriptionPart2_Effort[] = _("being a hard worker.");
 
 const u8 *const gRibbonDescriptionPointers[][2] = 
 {
-    {gRibbonDescriptionPart1_Champion,      gRibbonDescriptionPart2_Champion},
-    {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_NormalRank},
-    {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_SuperRank},
-    {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_HyperRank},
-    {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_MasterRank},
-    {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_NormalRank},
-    {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_SuperRank},
-    {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_HyperRank},
-    {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_MasterRank},
-    {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_NormalRank},
-    {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_SuperRank},
-    {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_HyperRank},
-    {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_MasterRank},
-    {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_NormalRank},
-    {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_SuperRank},
-    {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_HyperRank},
-    {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_MasterRank},
-    {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_NormalRank},
-    {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_SuperRank},
-    {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_HyperRank},
-    {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_MasterRank},
-    {gRibbonDescriptionPart1_Winning,       gRibbonDescriptionPart2_Winning},
-    {gRibbonDescriptionPart1_Victory,       gRibbonDescriptionPart2_Victory},
-    {gRibbonDescriptionPart1_Artist,        gRibbonDescriptionPart2_Artist},
-    {gRibbonDescriptionPart1_Effort,        gRibbonDescriptionPart2_Effort},
+    [CHAMPION_RIBBON]      = {gRibbonDescriptionPart1_Champion,      gRibbonDescriptionPart2_Champion},
+    [COOL_RIBBON_NORMAL]   = {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_NormalRank},
+    [COOL_RIBBON_SUPER]    = {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_SuperRank},
+    [COOL_RIBBON_HYPER]    = {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_HyperRank},
+    [COOL_RIBBON_MASTER]   = {gRibbonDescriptionPart1_CoolContest,   gRibbonDescriptionPart2_MasterRank},
+    [BEAUTY_RIBBON_NORMAL] = {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_NormalRank},
+    [BEAUTY_RIBBON_SUPER]  = {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_SuperRank},
+    [BEAUTY_RIBBON_HYPER]  = {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_HyperRank},
+    [BEAUTY_RIBBON_MASTER] = {gRibbonDescriptionPart1_BeautyContest, gRibbonDescriptionPart2_MasterRank},
+    [CUTE_RIBBON_NORMAL]   = {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_NormalRank},
+    [CUTE_RIBBON_SUPER]    = {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_SuperRank},
+    [CUTE_RIBBON_HYPER]    = {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_HyperRank},
+    [CUTE_RIBBON_MASTER]   = {gRibbonDescriptionPart1_CuteContest,   gRibbonDescriptionPart2_MasterRank},
+    [SMART_RIBBON_NORMAL]  = {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_NormalRank},
+    [SMART_RIBBON_SUPER]   = {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_SuperRank},
+    [SMART_RIBBON_HYPER]   = {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_HyperRank},
+    [SMART_RIBBON_MASTER]  = {gRibbonDescriptionPart1_SmartContest,  gRibbonDescriptionPart2_MasterRank},
+    [TOUGH_RIBBON_NORMAL]  = {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_NormalRank},
+    [TOUGH_RIBBON_SUPER]   = {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_SuperRank},
+    [TOUGH_RIBBON_HYPER]   = {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_HyperRank},
+    [TOUGH_RIBBON_MASTER]  = {gRibbonDescriptionPart1_ToughContest,  gRibbonDescriptionPart2_MasterRank},
+    [WINNING_RIBBON]       = {gRibbonDescriptionPart1_Winning,       gRibbonDescriptionPart2_Winning},
+    [VICTORY_RIBBON]       = {gRibbonDescriptionPart1_Victory,       gRibbonDescriptionPart2_Victory},
+    [ARTIST_RIBBON]        = {gRibbonDescriptionPart1_Artist,        gRibbonDescriptionPart2_Artist},
+    [EFFORT_RIBBON]        = {gRibbonDescriptionPart1_Effort,        gRibbonDescriptionPart2_Effort},
 };

src/graphics.c

@@ -1506,11 +1506,9 @@ const u16 gWallpaperPalettes_Ribbon[][16] =
 const u32 gWallpaperTiles_Ribbon[] = INCBIN_U32("graphics/pokemon_storage/ribbon.4bpp.lz");
 const u32 gWallpaperTilemap_Ribbon[] = INCBIN_U32("graphics/pokemon_storage/ribbon.bin.lz");
 
-// pokenav
-
-const u16 gUnknown_08DDE010[] = INCBIN_U16("graphics/pokenav/ribbons.gbapal");
-const u32 gUnknown_08DDE030[] = INCBIN_U32("graphics/pokenav/ribbons.4bpp.lz");
-const u32 gUnknown_08DDE12C[] = INCBIN_U32("graphics/pokenav/ribbons.bin.lz");
+const u16 gPokenavRibbonsSummaryBg_Pal[] = INCBIN_U16("graphics/pokenav/ribbons/summary_bg.gbapal");
+const u32 gPokenavRibbonsSummaryBg_Gfx[] = INCBIN_U32("graphics/pokenav/ribbons/summary_bg.4bpp.lz");
+const u32 gPokenavRibbonsSummaryBg_Tilemap[] = INCBIN_U32("graphics/pokenav/ribbons/summary_bg.bin.lz");
 
 const u16 gMonIconPalettes[][16] =
 {

src/pokenav_ribbons_1.c

@@ -44,7 +44,7 @@ struct PokenavSub10
 static u32 HandleRibbonsMonListInput_WaitListInit(struct PokenavSub9 *structPtr);
 static u32 HandleRibbonsMonListInput(struct PokenavSub9 *structPtr);
 static u32 RibbonsMonMenu_ReturnToMainMenu(struct PokenavSub9 *structPtr);
-static u32 sub_81CFB10(struct PokenavSub9 *structPtr);
+static u32 RibbonsMonMenu_ToSummaryScreen(struct PokenavSub9 *structPtr);
 static u32 BuildPartyMonRibbonList(s32 state);
 static u32 InitBoxMonRibbonList(s32 state);
 static u32 BuildBoxMonRibbonList(s32 state);
@@ -71,10 +71,10 @@ static const LoopedTask sMonRibbonListLoopTaskFuncs[] =
     BuildBoxMonRibbonList
 };
 
-static const u16 sMonRibbonListFramePal[] = INCBIN_U16("graphics/pokenav/ui_ribbons.gbapal");
-static const u32 sMonRibbonListFrameTiles[] = INCBIN_U32("graphics/pokenav/ui_ribbons.4bpp.lz");
-static const u32 sMonRibbonListFrameTilemap[] = INCBIN_U32("graphics/pokenav/ui_ribbons.bin.lz");
-static const u16 gUnknown_08623790[] = INCBIN_U16("graphics/pokenav/8623790.gbapal");
+static const u16 sMonRibbonListFramePal[] = INCBIN_U16("graphics/pokenav/ribbons/list_bg.gbapal");
+static const u32 sMonRibbonListFrameTiles[] = INCBIN_U32("graphics/pokenav/ribbons/list_bg.4bpp.lz");
+static const u32 sMonRibbonListFrameTilemap[] = INCBIN_U32("graphics/pokenav/ribbons/list_bg.bin.lz");
+static const u16 sMonRibbonListUi_Pal[] = INCBIN_U16("graphics/pokenav/ribbons/list_ui.gbapal");
 
 static const struct BgTemplate sMonRibbonListBgTemplates[] =
 {
@@ -192,7 +192,7 @@ static u32 HandleRibbonsMonListInput(struct PokenavSub9 *structPtr)
     {
         structPtr->monList->currIndex = GetSelectedPokenavListIndex();
         structPtr->saveMonList = 1;
-        structPtr->callback = sub_81CFB10;
+        structPtr->callback = RibbonsMonMenu_ToSummaryScreen;
         return RIBBONS_MON_LIST_FUNC_OPEN_RIBBONS_SUMMARY;
     }
     return RIBBONS_MON_LIST_FUNC_NONE;
@@ -203,7 +203,7 @@ static u32 RibbonsMonMenu_ReturnToMainMenu(struct PokenavSub9 *structPtr)
     return POKENAV_MAIN_MENU_CURSOR_ON_RIBBONS;
 }
 
-static u32 sub_81CFB10(struct PokenavSub9 *structPtr)
+static u32 RibbonsMonMenu_ToSummaryScreen(struct PokenavSub9 *structPtr)
 {
     return POKENAV_RIBBONS_SUMMARY_SCREEN;
 }
@@ -342,8 +342,8 @@ static void sub_81CFCEC(struct PokenavSub9 *structPtr, struct PokenavMonList *it
     structPtr->monList->listCount++;
 }
 
-//unused
-static bool32 Unused_PlayerHasRibbonsMon(void)
+// Unused
+static bool32 PlayerHasRibbonsMon(void)
 {
     s32 i, j;
 
@@ -446,7 +446,7 @@ static u32 LoopedTask_OpenRibbonsMonList(s32 state)
     case 2:
         if (FreeTempTileDataBuffersIfPossible())
             return LT_PAUSE;
-        CopyPaletteIntoBufferUnfaded(gUnknown_08623790, 0x20, 0x20);
+        CopyPaletteIntoBufferUnfaded(sMonRibbonListUi_Pal, 0x20, 0x20);
         InitMonRibbonPokenavListMenuTemplate();
         return LT_INC_AND_PAUSE;
     case 3: