document underground pc (#843)

Author: scbroede

generated/text_banks.txt

@@ -637,7 +637,7 @@ TEXT_BANK_UNION_ROOM
 TEXT_BANK_UNDERGROUND_NPCS
 TEXT_BANK_UNDERGROUND_DECORATE_BASE
 TEXT_BANK_UNDERGROUND_CAPTURE_FLAG
-TEXT_BANK_UNDERGROUND_BASE_PC
+TEXT_BANK_UNDERGROUND_PC
 TEXT_BANK_UNDERGROUND_RECORDS
 TEXT_BANK_DUMMY_0641
 TEXT_BANK_ROUTE_226

include/comm_player_manager.h

@@ -21,7 +21,7 @@ enum PauseBit {
     PAUSE_BIT_3 = 1 << 3,
     PAUSE_BIT_TRAPS = 1 << 4,
     PAUSE_BIT_5 = 1 << 5,
-    PAUSE_BIT_6 = 1 << 6,
+    PAUSE_BIT_LINK_PC = 1 << 6,
     PAUSE_BIT_RADAR = 1 << 7,
 };
 
@@ -59,7 +59,7 @@ typedef struct CommPlayerManager {
     u8 moveTimer[MAX_CONNECTED_PLAYERS];
     UnkStruct_ov23_0224ABC4 unk_14A[8 + 1];
     TrainerInfo *unk_27C[5];
-    TrainerInfo *unk_290[MAX_CONNECTED_PLAYERS];
+    TrainerInfo *heldFlagOwnerInfo[MAX_CONNECTED_PLAYERS];
     u16 unk_2B0;
     u16 unk_2B2;
     u8 unk_2B4[4];

include/overlay023/funcptr_ov23_022431EC.h

@@ -4,7 +4,6 @@
 #include "struct_decls/struct_02029894_decl.h"
 
 #include "field/field_system_decl.h"
-#include "overlay023/funcptr_ov23_022431EC.h"
 #include "overlay023/underground_defs.h"
 #include "overlay023/underground_text_printer.h"
 
@@ -13,16 +12,18 @@
 #include "sys_task_manager.h"
 #include "trainer_info.h"
 
+typedef void (*EndSysTaskFunc)(SysTask *sysTask, void *ctx);
+
 enum UndergroundStoredPosKeys {
     UNDERGROUND_STORED_POS_NONE = 0,
-    UNDERGROUND_STORED_POS_KEY_1,
+    UNDERGROUND_STORED_POS_KEY_PC,
     UNDERGROUND_STORED_POS_KEY_START_MENU,
     UNDERGROUND_STORED_POS_KEY_3,
 };
 
 enum UndergroundMenuKeys {
-    UNDERGROUND_MENU_KEY_2 = 2,
-    UNDERGROUND_MENU_KEY_6 = 6,
+    UNDERGROUND_MENU_KEY_STORE_GOODS = 2,
+    UNDERGROUND_MENU_KEY_WITHDRAW_GOODS = 6,
     UNDERGROUND_MENU_KEY_TRAPS = 8,
     UNDERGROUND_MENU_KEY_SPHERES,
     UNDERGROUND_MENU_KEY_GOODS,
@@ -35,8 +36,8 @@ enum UndergroundMenuKeys {
     UNDERGROUND_MENU_KEY_17,
     UNDERGROUND_MENU_KEY_18,
     UNDERGROUND_MENU_KEY_19,
-    UNDERGROUND_MENU_KEY_22 = 22,
-    UNDERGROUND_MENU_KEY_23
+    UNDERGROUND_MENU_KEY_PC_RADAR = 22,
+    UNDERGROUND_MENU_KEY_PC
 };
 
 #define BIT_TRAPS_FULL             1 << 4
@@ -81,9 +82,9 @@ int ov23_02242EE0(int param0);
 int ov23_02242F48(int param0);
 void ov23_02242FA8(void);
 void ov23_02242FBC(void);
-void ov23_02242FD0(void);
-void ov23_02242FE4(void);
-void ov23_02242FF8(void);
+void CommManUnderground_SetSphereRadarActive(void);
+void CommManUnderground_SetTrapRadarActive(void);
+void CommManUnderground_SetTreasureRadarActive(void);
 void ov23_0224300C(int param0, int param1);
 void ov23_02243020(int param0);
 void UndergroundMan_SetReturnLog(int param0);
@@ -93,8 +94,8 @@ void CommManUnderground_StoreCursorAndListPos(u16 menuKey, u16 cursorPos, u16 li
 u16 CommManUnderground_GetStoredListPos(u16 menuKey);
 u16 CommManUnderground_GetStoredCursorPos(u16 menuKey);
 void ov23_022431C4(int param0, int param1, void *param2, void *param3);
-void ov23_022431EC(void *param0, SysTask *param1, UnkFuncPtr_ov23_022431EC param2);
-void ov23_02243204(void);
+void CommManUnderground_SetCurrentSysTask(void *ctx, SysTask *sysTask, EndSysTaskFunc endFunc);
+void CommManUnderground_ClearCurrentSysTaskInfo(void);
 BOOL ov23_0224321C(void);
 BOOL ov23_02243298(int param0);
 void ov23_02243360(void);

include/overlay023/ov23_02241F74.h

@@ -38,8 +38,8 @@ void ov23_RevertPlayerStatusToNormal(int netID);
 void ov23_0224ADB0(int param0, int param1, int param2, int param3);
 void ov23_0224ADE8(int param0, int param1, int param2, int param3);
 BOOL ov23_0224AE60(int param0);
-BOOL ov23_0224AEA4(int param0);
-BOOL ov23_0224AEC4(int param0, int param1);
+BOOL ov23_IsPlayerHoldingFlag(int param0);
+BOOL ov23_TryTakeFlag(int param0, int param1);
 void ov23_0224AF4C(int param0);
 void ov23_0224AF7C(int param0);
 void ov23_ShowExclamationEmote(int netID);

include/overlay023/ov23_0224A1D0.h

@@ -11,9 +11,9 @@ void ov23_02252CD4(void);
 void ov23_02252CE0(int param0, int param1);
 void ov23_02252CF4(int param0, int param1);
 void ov23_02252D08(int param0, int param1);
-void ov23_02252D74(UndergroundMenu *param0, int param1);
-void ov23_02252DF4(UndergroundMenu *param0);
-void ov23_02252E18(UndergroundMenu *param0);
+void UndergroundMenu_PrintMenuDescription(UndergroundMenu *param0, int param1);
+void UndergroundMenu_RemoveDescriptionWindow(UndergroundMenu *param0);
+void UndergroundMenu_RemoveDescriptionWindowInstant(UndergroundMenu *param0);
 void ov23_022534A0(FieldSystem *fieldSystem);
 
 #endif // POKEPLATINUM_OV23_022521F0_H

include/overlay023/ov23_0225128C.h

@@ -40,7 +40,7 @@ typedef struct UndergroundMenu {
     FieldSystem *fieldSystem;
     Window primaryWindow;
     Window secondaryWindow;
-    Window unk_30;
+    Window menuDescriptionWindow;
     StringList *menuOptions;
     StringList *itemSelectedOptions;
     ListMenu *unk_48;
@@ -113,11 +113,12 @@ void UndergroundMenu_StartHoldingFlag(ExitCallback exitCallback, FieldSystem *fi
 void UndergroundMenu_PrintGoodDescription(ListMenu *listMenu, u32 index, u8 onInit);
 void ov23_02250CB0(UndergroundMenu *menu);
 void UndergroundMenu_OpenGoodsMenu(UndergroundMenu *menu);
-void ov23_02250D2C(UndergroundMenu *menu);
-void ov23_02250D5C(UndergroundMenu *menu);
-void UndergroundMenu_ExitGiftMenu(void *data, u32 input);
+void UndergroundMenu_OpenStoreGoodsMenu(UndergroundMenu *menu);
+void UndergroundMenu_OpenWithdrawGoodsMenu(UndergroundMenu *menu);
+void UndergroundMenu_Exit(void *data, u32 input);
 void *UndergroundMenu_StartGiftMenu(ExitCallback exitCallback, FieldSystem *fieldSystem);
 void UndergroundMenu_MoveListCursorPosInBounds(UndergroundMenu *menu, int maxDisplay, int count);
-void ov23_02251270(SysTask *sysTask, void *param1);
+void UndergroundMenu_ResetBrightnessAndExit(SysTask *sysTask, void *data);
+void UndergroundMenu_UpdateScrollPrompts(UndergroundMenu *menu, int listPos, int count, int maxDisplay);
 
 #endif // POKEPLATINUM_OV23_0224F294_H

include/overlay023/ov23_022521F0.h

@@ -0,0 +1,16 @@
+#ifndef POKEPLATINUM_UNDERGROUND_PC_H
+#define POKEPLATINUM_UNDERGROUND_PC_H
+
+#include "overlay023/underground_defs.h"
+#include "overlay023/underground_menu.h"
+
+#define PC_NONE 0xFF
+
+int UndergroundPC_GetPCAtCoordinates(Coordinates *coordinates, int dir);
+BOOL UndergroundPC_TryUsePC(int netID, Coordinates *coordinates);
+void UndergroundPC_ProcessPCInteraction(int unused0, int unused1, void *data, void *data2);
+int CommPacketSizeOf_PCInteraction(void);
+void UndergroundPC_ProcessTakeFlagAttempt(int unused0, int unused1, void *data, void *unused3);
+void UndergroundPC_ProcessTakenFlag(int unused0, int unused1, void *data, void *unused3);
+
+#endif // POKEPLATINUM_UNDERGROUND_PC_H

include/overlay023/underground_menu.h

@@ -57,7 +57,7 @@ void sub_0205EB08(PlayerAvatar *playerAvatar, int param1);
 int PlayerAvatar_MoveState(const PlayerAvatar *playerAvatar);
 void sub_0205EB10(PlayerAvatar *playerAvatar, int param1);
 int Player_MoveState(const PlayerAvatar *playerAvatar);
-void PlayerAvatar_SetHidden(PlayerAvatar *playerAvatar, int param1);
+void PlayerAvatar_SetVisible(PlayerAvatar *playerAvatar, BOOL hidden);
 void PlayerAvatar_SetMapObject(PlayerAvatar *playerAvatar, MapObject *param1);
 MapObject *Player_MapObject(PlayerAvatar *playerAvatar);
 const MapObject *PlayerAvatar_ConstMapObject(const PlayerAvatar *playerAvatar);