documentation, 4

pret · Jul 6, 2024 · eb42b30 · eb42b30
1 parent e9ce298
commit eb42b30
Show file tree

Hide file tree

Showing 22 changed files with 419 additions and 418 deletions.
diff --git a/include/field_system.h b/include/field_system.h
@@ -160,7 +160,7 @@ struct FieldSystem {
     FollowMon followMon; // E4
     u8 unk104[4];
     FieldSystemUnk108 *unk108;
-    BOOL unk_10C;
+    BOOL menuInputState;  // Tracks whether the last menu input was touch or keypad
     u8 unk_110;
     u8 unk_111[3];
     GearPhoneRingManager *unk114;

diff --git a/include/launch_application.h b/include/launch_application.h
@@ -100,7 +100,7 @@ static inline PCBoxArgs *PCBoxAppData_New(ScriptContext *ctx) {
     PCBoxArgs *ret = AllocFromHeap(HEAP_ID_FIELD, sizeof(PCBoxArgs));
     ret->saveData = ctx->fieldSystem->saveData;
     ret->unk8 = ScriptReadByte(ctx);
-    ret->fieldSystemUnk10C = &ctx->fieldSystem->unk_10C;
+    ret->fieldSystemUnk10C = &ctx->fieldSystem->menuInputState;
     return ret;
 }
 

diff --git a/include/mail_misc.h b/include/mail_misc.h
@@ -74,7 +74,7 @@ UseMailArgs *sub_02090F38(SaveData *saveData, u8 mailType, HeapID heapId);
 u32 sub_02090F6C(UseMailArgs *args);
 BOOL sub_02090F70(UseMailArgs *args, Pokemon *mon);
 void sub_02090F90(UseMailArgs *args);
-int sub_02090FA8(MAILBOX *mailbox, Pokemon *mon, HeapID heapId);
+int Mailbox_MoveMessageFromMon(MAILBOX *mailbox, Pokemon *mon, HeapID heapId);
 int sub_02091004(Mail *msgs, int i, Pokemon *mon, HeapID heapId);
 
 #endif //POKEHEARTGOLD_MAIL_MISC_H
diff --git a/include/party_context_menu.h b/include/party_context_menu.h
@@ -28,6 +28,8 @@ void PartyMenu_DrawPartyMonsList_SuperContestEntry(PartyMenuStruct *partyMenu, u
 void PartyMenu_DrawPartyMonsList_FrontierFacilityEntry(PartyMenuStruct *partyMenu, u8 partySlot);
 void sub_0207D8EC(PartyMenuStruct *partyMenu, u8 partySlot);
 void sub_0207D998(PartyMenuStruct *partyMenu, u8 a1);
+
+// For these next three funcs, if msgId is -1, uses partyMenu->formattedStrBuf
 void PartyMenu_PrintMessageOnWindow32(PartyMenuStruct *partyMenu, int msgId, BOOL drawFrame);
 void PartyMenu_PrintMessageOnWindow33(PartyMenuStruct *partyMenu, int msgId, BOOL drawFrame);
 void PartyMenu_PrintMessageOnWindow34(PartyMenuStruct *partyMenu, int msgId, BOOL drawFrame);

diff --git a/include/party_menu.h b/include/party_menu.h
@@ -40,28 +40,28 @@ typedef enum PartyMenuState {
     PARTY_MENU_STATE_1,
     PARTY_MENU_STATE_HANDLE_CONTEXT_MENU_INPUT,
     PARTY_MENU_STATE_3,
-    PARTY_MENU_STATE_4,
+    PARTY_MENU_STATE_USE_ITEM_SELECT_MON,
     PARTY_MENU_STATE_ITEM_USE_CB,
     PARTY_MENU_STATE_SELECT_MOVE,
     PARTY_MENU_STATE_SACRED_ASH,
-    PARTY_MENU_STATE_8,
+    PARTY_MENU_STATE_GIVE_ITEM_SELECT_MON,
     PARTY_MENU_STATE_PRINT_ASK_SWITCH_ITEMS,
     PARTY_MENU_STATE_YESNO_ASK_SWITCH_ITEMS,
     PARTY_MENU_STATE_PRINT_ITEM_SWAP_MESSAGE,
     PARTY_MENU_STATE_PRINT_GIVE_GRISEOUS_ORB_MESSAGE,
     PARTY_MENU_STATE_WAIT_GIVE_GRISEOUS_ORB_ANIM,
     PARTY_MENU_STATE_14,
     PARTY_MENU_STATE_HANDLE_SUBCONTEXT_MENU_INPUT,
-    PARTY_MENU_STATE_16,
+    PARTY_MENU_STATE_GIVE_ITEM_TO_MON,
     PARTY_MENU_STATE_PRINT_TAKE_ITEM_MESSAGE,
     PARTY_MENU_STATE_PRINT_TAKE_GRISEOUS_ORB_MESSAGE,
     PARTY_MENU_STATE_WAIT_TAKE_GRISEOUS_ORB_ANIM,
-    PARTY_MENU_STATE_20,
+    PARTY_MENU_STATE_AFTER_TAKE_MAIL,
     PARTY_MENU_STATE_USE_TMHM,
-    PARTY_MENU_STATE_22,
+    PARTY_MENU_STATE_TMHM_LEARN_MOVE,
     PARTY_MENU_STATE_SELECT_MONS_ERROR_MSG_CLOSE,
     PARTY_MENU_STATE_WAIT_TEXT_PRINTER,
-    PARTY_MENU_STATE_25,
+    PARTY_MENU_STATE_AFTER_MESSAGE_BEGIN_EXIT,
     PARTY_MENU_STATE_YES_NO_INIT,
     PARTY_MENU_STATE_YES_NO_HANDLE_INPUT,
     PARTY_MENU_STATE_SELECT_SWITCH_MON,
@@ -87,15 +87,15 @@ typedef enum PartyMenuContext {
     PARTY_MENU_CONTEXT_11,
     PARTY_MENU_CONTEXT_12,
     PARTY_MENU_CONTEXT_SUPER_CONTEST,
-    PARTY_MENU_CONTEXT_14,
-    PARTY_MENU_CONTEXT_15,
+    PARTY_MENU_CONTEXT_GIVE_MAIL_FROM_MAILBOX,
+    PARTY_MENU_CONTEXT_ATTACH_CAPSULE,
     PARTY_MENU_CONTEXT_EVO_STONE,
     PARTY_MENU_CONTEXT_17,
     PARTY_MENU_CONTEXT_18,
     PARTY_MENU_CONTEXT_19,
     PARTY_MENU_CONTEXT_20,
-    PARTY_MENU_CONTEXT_21,
-    PARTY_MENU_CONTEXT_22,
+    PARTY_MENU_CONTEXT_SPIN_TRADE,
+    PARTY_MENU_CONTEXT_BATTLE_HALL,
     PARTY_MENU_CONTEXT_23,
 } PartyMenuContext;
 
@@ -241,24 +241,24 @@ typedef enum PartyMenuSpriteId {
     PARTY_MENU_SPRITE_ID_SWITCH_MON_CURSOR,
     PARTY_MENU_SPRITE_ID_8,
     PARTY_MENU_SPRITE_ID_9,
-    PARTY_MENU_SPRITE_ID_10,
-    PARTY_MENU_SPRITE_ID_11,
-    PARTY_MENU_SPRITE_ID_12,
-    PARTY_MENU_SPRITE_ID_13,
-    PARTY_MENU_SPRITE_ID_14,
-    PARTY_MENU_SPRITE_ID_15,
-    PARTY_MENU_SPRITE_ID_HELD_ITEM_ICON,
-    PARTY_MENU_SPRITE_ID_17,
-    PARTY_MENU_SPRITE_ID_18,
-    PARTY_MENU_SPRITE_ID_19,
-    PARTY_MENU_SPRITE_ID_20,
-    PARTY_MENU_SPRITE_ID_21,
-    PARTY_MENU_SPRITE_ID_CAPSULE_ICON,
-    PARTY_MENU_SPRITE_ID_23,
-    PARTY_MENU_SPRITE_ID_24,
-    PARTY_MENU_SPRITE_ID_25,
-    PARTY_MENU_SPRITE_ID_26,
-    PARTY_MENU_SPRITE_ID_27,
+    PARTY_MENU_SPRITE_ID_MON1_STATUS,
+    PARTY_MENU_SPRITE_ID_MON2_STATUS,
+    PARTY_MENU_SPRITE_ID_MON3_STATUS,
+    PARTY_MENU_SPRITE_ID_MON4_STATUS,
+    PARTY_MENU_SPRITE_ID_MON5_STATUS,
+    PARTY_MENU_SPRITE_ID_MON6_STATUS,
+    PARTY_MENU_SPRITE_ID_MON1_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON2_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON3_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON4_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON5_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON6_HELD_ITEM,
+    PARTY_MENU_SPRITE_ID_MON1_CAPSULE,
+    PARTY_MENU_SPRITE_ID_MON2_CAPSULE,
+    PARTY_MENU_SPRITE_ID_MON3_CAPSULE,
+    PARTY_MENU_SPRITE_ID_MON4_CAPSULE,
+    PARTY_MENU_SPRITE_ID_MON5_CAPSULE,
+    PARTY_MENU_SPRITE_ID_MON6_CAPSULE,
     PARTY_MENU_SPRITE_ID_28,
     PARTY_MENU_SPRITE_ID_MAX,
 } PartyMenuSpriteId;
@@ -304,7 +304,7 @@ typedef struct PartyMenuArgs {
     UnkStruct_02074944 *unk_14;
     FieldMoveCheckData *fieldMoveCheckData;
     FieldSystem *fieldSystem;
-    BOOL *unk_20;
+    BOOL *menuInputStatePtr;
     u8 context;
     u8 unk_25;
     u8 partySlot;
@@ -316,9 +316,9 @@ typedef struct PartyMenuArgs {
     u8 contestStat;
     u8 contestLevel;
     u8 selectedOrder[6];
-    u8 unk_36_0:4;
+    u8 minMonsToSelect:4;
     u8 maxMonsToSelect:4;
-    u8 unk_37;
+    u8 maxLevel;
     int levelUpMoveSearchState;
     u16 species;
     int evoMethod;
@@ -336,7 +336,7 @@ typedef struct IconFormChangeData  {
 
 typedef struct PartyMenuStruct PartyMenuStruct;
 
-typedef void (*PartyMenuStruct_SubC90_UnkFunc)(PartyMenuStruct *partyMenu, int *pState);
+typedef void (*PartyMonContextMenuActionFunc)(PartyMenuStruct *partyMenu, int *pState);
 
 typedef struct PartyMenuContextButtonAnimData {
     PartyMenuContextMenu *template;
@@ -365,12 +365,12 @@ typedef struct PartyMenuMonsDrawState {
     u16 capsule;      // 83A
     s8 unk_14;        // 83C
     s8 unk_15;        // 83D
-    s16 unk_16;       // 83E
-    s16 unk_18;       // 840
-    s16 unk_1A;       // 842
-    s16 unk_1C;       // 844
-    s16 unk_1E;       // 846
-    s16 unk_20;       // 848
+    s16 iconX;       // 83E
+    s16 iconY;       // 840
+    s16 statusIconX;       // 842
+    s16 statusIconY;       // 844
+    s16 heldItemX;       // 846
+    s16 heldItemY;       // 848
     u8 filler_22[2];  // alignment padding
     Sprite *iconSprite;   // 84C
     Sprite *mainScreenIconSprite;   // 850

diff --git a/include/party_menu_list_items.h b/include/party_menu_list_items.h
@@ -7,7 +7,7 @@ u32 GetPartyMenuContextMenuActionFunc(int index);
 int PartyMenu_Subtask_PrintTakeItemMessage(PartyMenuStruct *partyMenu);
 int PartyMenu_Subtask_PrintTakeGriseousOrbMessage(PartyMenuStruct *partyMenu);
 int PartyMenu_Subtask_WaitTakeGriseousOrbAnim(PartyMenuStruct *partyMenu);
-int sub_0207FA08(PartyMenuStruct *partyMenu);
+int PartyMenu_Subtask_AfterTakeMail(PartyMenuStruct *partyMenu);
 int sub_0207FAA8(PartyMenuStruct *partyMenu);
 int sub_0207FAD4(PartyMenuStruct *partyMenu);
 void sub_0207FBC8(PartyMenuStruct *partyMenu);

diff --git a/src/application/view_photo.c b/src/application/view_photo.c
@@ -134,15 +134,15 @@ SysTask *FieldSystem_CreateViewPhotoTask(FieldSystem *fieldSystem) {
     viewPhoto->bgConfig = fieldSystem->bgConfig;
     viewPhoto->saveData = fieldSystem->saveData;
     viewPhoto->parent = fieldSystem->viewPhotoTask;
-    viewPhoto->lastInputWasTouch = sub_020183F0(&fieldSystem->unk_10C);
+    viewPhoto->lastInputWasTouch = sub_020183F0(&fieldSystem->menuInputState);
     FieldViewPhoto_GetAlbumScrollParam(viewPhoto->parent, &viewPhoto->scrollData);
     return SysTask_CreateOnMainQueue(SysTask_ViewPhoto, viewPhoto, 1);
 }
 
 void FieldSystem_DestroyViewPhotoTask(FieldSystem *fieldSystem) {
     ViewPhotoSysTaskData *viewPhoto = (ViewPhotoSysTaskData *)SysTask_GetData(fieldSystem->unk_D8);
 
-    sub_02018410(&fieldSystem->unk_10C, viewPhoto->lastInputWasTouch);
+    sub_02018410(&fieldSystem->menuInputState, viewPhoto->lastInputWasTouch);
     ViewPhotoSysTask_Teardown(viewPhoto);
     FreeToHeap(viewPhoto);
     SysTask_Destroy(fieldSystem->unk_D8);

diff --git a/src/field_use_item.c b/src/field_use_item.c
@@ -233,7 +233,7 @@ static void ItemMenuUseFunc_HealingItem(struct ItemMenuUseData *data, const stru
     usedat->fieldSystem = fieldSystem;
     usedat->itemId = data->itemId;
     usedat->partySlot = data->unk6;
-    usedat->unk_20 = &fieldSystem->unk_10C;
+    usedat->menuInputStatePtr = &fieldSystem->menuInputState;
     FieldSystem_LaunchApplication(fieldSystem, &gOverlayTemplate_PartyMenu, usedat);
     env->atexit_TaskEnv = usedat;
     StartMenu_SetChildProcReturnTaskFunc(env, Task_StartMenu_HandleReturn_Pokemon);
@@ -356,7 +356,7 @@ static void ItemMenuUseFunc_TMHM(struct ItemMenuUseData *data, const struct Item
     usedat->itemId = data->itemId;
     usedat->partySlot = data->unk6;
     usedat->moveId = TMHMGetMove(data->itemId);
-    usedat->unk_20 = &fieldSystem->unk_10C;
+    usedat->menuInputStatePtr = &fieldSystem->menuInputState;
     FieldSystem_LaunchApplication(fieldSystem, &gOverlayTemplate_PartyMenu, usedat);
     env->atexit_TaskEnv = usedat;
     StartMenu_SetChildProcReturnTaskFunc(env, Task_StartMenu_HandleReturn_Pokemon);
@@ -546,7 +546,7 @@ static void ItemMenuUseFunc_EvoStone(struct ItemMenuUseData *data, const struct
     usedat->itemId = data->itemId;
     usedat->partySlot = data->unk6;
     usedat->fieldSystem = fieldSystem;
-    usedat->unk_20 = &fieldSystem->unk_10C;
+    usedat->menuInputStatePtr = &fieldSystem->menuInputState;
     FieldSystem_LaunchApplication(fieldSystem, &gOverlayTemplate_PartyMenu, usedat);
     env->atexit_TaskEnv = usedat;
     StartMenu_SetChildProcReturnTaskFunc(env, Task_StartMenu_HandleReturn_Pokemon);