More pokenav match call documentation

3 files changed, 61 insertions, 41 deletions

diff --git a/include/gym_leader_rematch.h b/include/gym_leader_rematch.h
index ac365a41a..81ce3da23 100644
--- a/include/gym_leader_rematch.h
+++ b/include/gym_leader_rematch.h
@@ -66,7 +66,7 @@ enum {
     REMATCH_TRENT,
     REMATCH_SAWYER,
     REMATCH_KIRA_AND_DAN,
-    REMATCH_WALLY_3,  // Entries above WALLY are considered normal NPCs
+    REMATCH_WALLY_3,  // Entries above WALLY are considered normal NPCs, from Wally below are special trainers
     REMATCH_ROXANNE,
     REMATCH_BRAWLY,
     REMATCH_WATTSON,
@@ -83,8 +83,8 @@ enum {
     REMATCH_TABLE_ENTRIES // The total number of rematch entries. Must be last in enum
 };
 
-#define REMATCH_NORMAL_NPC_END     REMATCH_WALLY_3
-#define REMATCH_ELITE_FOUR_ENTRIES REMATCH_SIDNEY
+#define REMATCH_SPECIAL_TRAINER_START   REMATCH_WALLY_3
+#define REMATCH_ELITE_FOUR_ENTRIES      REMATCH_SIDNEY
 
 void UpdateGymLeaderRematch(void);
 
diff --git a/include/match_call.h b/include/match_call.h
index 52eab63ec..8214e03b7 100644
--- a/include/match_call.h
+++ b/include/match_call.h
@@ -15,7 +15,7 @@ void InitMatchCallCounters(void);
 bool32 TryStartMatchCall(void);
 bool32 IsMatchCallTaskActive(void);
 void StartMatchCallFromScript(u8 *message);
-void sub_8197080(u8 *destStr);
+void BufferPokedexRatingForMatchCall(u8 *destStr);
 bool32 SelectMatchCallMessage(int, u8 *);
 void sub_8197184(u32 windowId, u32 destOffset, u32 paletteId);
 void sub_81971C4(u32 windowId, u32 tileOffset, u32 paletteId);
diff --git a/include/pokenav.h b/include/pokenav.h
index c497c4b85..e2c2a4d08 100644
--- a/include/pokenav.h
+++ b/include/pokenav.h
@@ -32,9 +32,9 @@ struct PokenavSub18
 
 enum
 {
-    POKENAV_MODE_NORMAL, // Chosen from Start menu.
-    POKENAV_MODE_FORCE_CALL_READY, // When player is forced to call Mr. Stone for pokenav tutorial
-    POKENAV_MODE_FORCE_CALL_EXIT,     // Forced to exit fter being calling Mr. Stone for pokenav tutorial
+    POKENAV_MODE_NORMAL,           // Chosen from Start menu.
+    POKENAV_MODE_FORCE_CALL_READY, // Pokenav tutorial before calling Mr. Stone
+    POKENAV_MODE_FORCE_CALL_EXIT,  // Pokenav tutorial after calling Mr. Stone
 };
 
 #define POKENAV_MENU_IDS_START 100000
@@ -59,6 +59,23 @@ enum
 
 enum
 {
+    HELPBAR_NONE,
+    HELPBAR_MAP_ZOOMED_OUT,
+    HELPBAR_MAP_ZOOMED_IN,
+    HELPBAR_CONDITION_MON_LIST,
+    HELPBAR_CONDITION_MON_STATUS,
+    HELPBAR_CONDITION_MARKINGS,
+    HELPBAR_MC_TRAINER_LIST,
+    HELPBAR_MC_CALL_MENU,
+    HELPBAR_MC_CHECK_PAGE,
+    HELPBAR_RIBBONS_MON_LIST,
+    HELPBAR_RIBBONS_LIST,
+    HELPBAR_RIBBONS_CHECK,
+    HELPBAR_COUNT
+};
+
+enum
+{
 	MC_HEADER_MR_STONE,
 	MC_HEADER_PROF_BIRCH,
 	MC_HEADER_BRENDAN,
@@ -105,22 +122,25 @@ enum
                         [CHECK_PAGE_INTRO_1]  = gText_MatchCall##name##_Intro1,   \
                         [CHECK_PAGE_INTRO_2]  = gText_MatchCall##name##_Intro2}
 
-#define POKENAV_MC_FUNC_NONE   0
-#define POKENAV_MC_FUNC_DOWN   1
-#define POKENAV_MC_FUNC_UP   2
-#define POKENAV_MC_FUNC_PG_DOWN   3
-#define POKENAV_MC_FUNC_PG_UP   4
-#define POKENAV_MC_FUNC_SELECT   5
-#define POKENAV_MC_FUNC_6   6
-#define POKENAV_MC_FUNC_7   7
-#define POKENAV_MC_FUNC_CALL_MSG   8
-#define POKENAV_MC_FUNC_NEARBY_MSG   9
-#define POKENAV_MC_FUNC_10  10
-#define POKENAV_MC_FUNC_11  11
-#define POKENAV_MC_FUNC_12  12
-#define POKENAV_MC_FUNC_13  13
-#define POKENAV_MC_FUNC_14  14
-#define POKENAV_MC_FUNC_EXIT  15
+enum
+{
+    POKENAV_MC_FUNC_NONE,
+    POKENAV_MC_FUNC_DOWN,
+    POKENAV_MC_FUNC_UP,
+    POKENAV_MC_FUNC_PG_DOWN,
+    POKENAV_MC_FUNC_PG_UP,
+    POKENAV_MC_FUNC_SELECT,
+    POKENAV_MC_FUNC_MOVE_OPTIONS_CURSOR,
+    POKENAV_MC_FUNC_CANCEL,
+    POKENAV_MC_FUNC_CALL_MSG,
+    POKENAV_MC_FUNC_NEARBY_MSG,
+    POKENAV_MC_FUNC_10,
+    POKENAV_MC_FUNC_SHOW_CHECK_PAGE,
+    POKENAV_MC_FUNC_CHECK_PAGE_UP,
+    POKENAV_MC_FUNC_CHECK_PAGE_DOWN,
+    POKENAV_MC_FUNC_EXIT_CHECK_PAGE,
+    POKENAV_MC_FUNC_EXIT
+};
 
 // pokenav.c
 void sub_81C7694(u32);
@@ -168,7 +188,7 @@ void ToggleMatchCallVerticalArrows(bool32 shouldHide);
 void sub_81C8838(void);
 void sub_81C877C(void);
 bool32 sub_81C8820(void);
-void sub_81C87AC(s16 a0);
+void PrintCheckPageInfo(s16 a0);
 u32 GetMatchCallListTopIndex(void);
 void sub_81C87F0(void);
 bool32 sub_81C81D4(const struct BgTemplate *arg0, struct MatchCallListTemplate *arg1, s32 arg2);
@@ -176,15 +196,15 @@ void sub_81C8234(void);
 
 // pokenav_match_call_data.c
 bool32 MatchCall_HasCheckPage(u32 idx);
-u8 MatchCallMapSecGetByIndex(u32 idx);
-bool32 sub_81D1BF8(u32 idx);
-bool32 MatchCallFlagGetByIndex(u32 idx);
+u8 MatchCall_GetMapSec(u32 idx);
+bool32 MatchCall_HasRematchId(u32 idx);
+bool32 MatchCall_GetEnabled(u32 idx);
 u32 MatchCall_GetRematchTableIdx(u32 idx);
 u32 GetTrainerIdxByRematchIdx(u32 rematchIdx);
 int MatchCall_GetOverrideFacilityClass(u32 idx);
 void MatchCall_GetMessage(u32 idx, u8 *dest);
 const u8 *MatchCall_GetOverrideFlavorText(u32 idx, u32 offset);
-void sub_81D1A78(u32 idx, const u8 **desc, const u8 **name);
+void MatchCall_GetNameAndDesc(u32 idx, const u8 **desc, const u8 **name);
 
 // pokenav_main_menu.c
 bool32 InitPokenavMainMenu(void);
@@ -197,8 +217,8 @@ void sub_81C7AC0(s32 a0);
 bool32 sub_81C8010(void);
 void InitBgTemplates(const struct BgTemplate *templates, int count);
 bool32 IsPaletteFadeActive(void);
-void sub_81C7BA4(u32 helpBarIndex);
-bool32 IsDma3ManagerBusyWithBgCopy_(void);
+void PrintHelpBarText(u32 textId);
+bool32 WaitForHelpBar(void);
 void sub_81C78A0(void);
 bool32 MainMenuLoopedTaskIsBusy(void);
 void sub_81C7FDC(void);
@@ -226,7 +246,7 @@ void sub_81C9430(void);
 int sub_81C9894(void);
 int sub_81C98A4(void);
 int sub_81C98B4(void);
-u16 sub_81C98C4(void);
+u16 GetHelpBarTextId(void);
 
 // pokenav_unk_2.c
 bool32 sub_81C9924(void);
@@ -241,28 +261,28 @@ bool32 PokenavCallback_Init_11(void);
 u32 sub_81CAB24(void);
 void sub_81CAB38(void);
 int sub_81CAE28(void);
-int sub_81CAE38(void);
+int GetNumberRegistered(void);
 int sub_81CAE48(void);
 struct PokenavMonList *sub_81CAE94(void);
-u16 sub_81CAEA4(int);
-bool32 sub_81CAEBC(int index);
+u16 GetMatchCallMapSec(int);
+bool32 ShouldDrawRematchPokeballIcon(int index);
+void ClearRematchPokeballIcon(u16 windowId, u32 a1);
 int GetMatchCallTrainerPic(int index);
 const u8 *GetMatchCallFlavorText(int index, int textType);
 const u8 *GetMatchCallMessageText(int index, u8 *arg1);
-u16 sub_81CB01C(void);
-u16 sub_81CB02C(int arg0);
-void sub_81CB050(struct PokenavMonList * arg0, u8 *str);
+u16 GetMatchCallOptionCursorPos(void);
+u16 GetMatchCallOptionId(int arg0);
+void BufferMatchCallNameAndDesc(struct PokenavMonList * arg0, u8 *str);
 u8 sub_81CB0C8(int rematchIndex);
-int sub_81CB0E4(int index);
+int GetIndexDeltaOfNextCheckPageDown(int index);
+int GetIndexDeltaOfNextCheckPageUp(int index);
 bool32 IsRematchEntryRegistered(int index);
-int sub_81CB128(int index);
 
-// POKENAV_MC.c
+// pokenav_unk_4.c
 bool32 sub_81CB260(void);
 void sub_81CB29C(s32 index);
 u32 sub_81CB2CC(void);
 void sub_81CB2E0(void);
-void sub_81CBD48(u16 windowId, u32 a1);
 
 // pokenav_unk_5.c
 u32 PokenavCallback_Init_6(void);