Document some pokenav menu handlers

This commit is contained in:
GriffinR
2020-02-01 00:25:50 -05:00
committed by huderlem
parent 0cf84d13ef
commit be5d417236
13 changed files with 504 additions and 375 deletions

View File

@@ -85,6 +85,39 @@ enum
POKENAV_MENU_E,
};
enum
{
POKENAV_MENU_TYPE_DEFAULT,
POKENAV_MENU_TYPE_UNLOCK_MC,
POKENAV_MENU_TYPE_UNLOCK_MC_RIBBONS,
POKENAV_MENU_TYPE_CONDITION,
POKENAV_MENU_TYPE_CONDITION_SEARCH,
POKENAV_MENU_TYPE_COUNT
};
// Global IDs for menu selections
// As opposed to the cursor position, which is only relative to the number of options for the current menu
enum
{
POKENAV_MENUITEM_MAP,
POKENAV_MENUITEM_CONDITION,
POKENAV_MENUITEM_MATCH_CALL,
POKENAV_MENUITEM_RIBBONS,
POKENAV_MENUITEM_SWITCH_OFF,
POKENAV_MENUITEM_CONDITION_PARTY,
POKENAV_MENUITEM_CONDITION_SEARCH,
POKENAV_MENUITEM_CONDITION_CANCEL,
POKENAV_MENUITEM_CONDITION_SEARCH_COOL,
POKENAV_MENUITEM_CONDITION_SEARCH_BEAUTY,
POKENAV_MENUITEM_CONDITION_SEARCH_CUTE,
POKENAV_MENUITEM_CONDITION_SEARCH_SMART,
POKENAV_MENUITEM_CONDITION_SEARCH_TOUGH,
POKENAV_MENUITEM_CONDITION_SEARCH_CANCEL,
};
// Max menu options (condition search uses 6)
#define MAX_POKENAV_MENUITEMS 6
enum
{
HELPBAR_NONE,
@@ -150,6 +183,23 @@ enum
[CHECK_PAGE_INTRO_1] = gText_MatchCall##name##_Intro1, \
[CHECK_PAGE_INTRO_2] = gText_MatchCall##name##_Intro2}
// Pokenav Function IDs
// Indices into the LoopedTask tables for each of the main Pokenav features
enum
{
POKENAV_MENU_FUNC_NONE,
POKENAV_MENU_FUNC_MOVE_CURSOR,
POKENAV_MENU_FUNC_OPEN_CONDITION,
POKENAV_MENU_FUNC_RETURN_TO_MAIN,
POKENAV_MENU_FUNC_OPEN_CONDITION_SEARCH,
POKENAV_MENU_FUNC_RETURN_TO_CONDITION,
POKENAV_MENU_FUNC_NO_RIBBON_WINNERS,
POKENAV_MENU_FUNC_RESHOW_DESCRIPTION,
POKENAV_MENU_FUNC_OPEN_FEATURE,
};
enum
{
POKENAV_MC_FUNC_NONE,
@@ -171,8 +221,8 @@ enum
};
// pokenav.c
void sub_81C7694(u32);
u32 sub_81C76AC(void);
void SetSelectedConditionSearch(u32);
u32 GetSelectedConditionSearch(void);
void CB2_InitPokeNav(void);
u32 CreateLoopedTask(LoopedTask loopedTask, u32 priority);
@@ -255,15 +305,15 @@ bool32 PokenavCallback_Init_2(void);
bool32 PokenavCallback_Init_3(void);
u32 sub_81C941C(void);
void sub_81C9430(void);
int sub_81C9894(void);
int sub_81C98A4(void);
int sub_81C98B4(void);
int GetPokenavMenuType(void);
int GetPokenavCursorPos(void);
int GetCurrentMenuItemId(void);
u16 GetHelpBarTextId(void);
// pokenav_unk_2.c
bool32 sub_81C9924(void);
bool32 sub_81C9940(void);
void sub_81C9990(s32 ltIdx);
void CreateMenuHandlerLoopedTask(s32 ltIdx);
bool32 sub_81C99C0(void);
void sub_81C99D4(void);
void sub_81CAADC(void);
@@ -292,7 +342,7 @@ bool32 IsRematchEntryRegistered(int index);
// pokenav_unk_4.c
bool32 sub_81CB260(void);
void sub_81CB29C(s32 index);
void CreateMatchCallLoopedTask(s32 index);
u32 sub_81CB2CC(void);
void sub_81CB2E0(void);