Done documenting link code in overworld.c

4 files changed, 26 insertions, 14 deletions

diff --git a/include/global.h b/include/global.h
index 64d039c6f..6843b4216 100644
--- a/include/global.h
+++ b/include/global.h
@@ -907,13 +907,13 @@ struct MapPosition
     s8 height;
 };
 
-struct TradeRoomTrainer
+struct TradeRoomPlayer
 {
-    u8 a;
-    u8 b;
+    u8 playerId;
+    u8 isSelf;
     u8 c;
     u8 facing;
-    struct MapPosition sub;
+    struct MapPosition pos;
     u16 field_C;
 };
 
diff --git a/include/link.h b/include/link.h
index 52a631570..b29d9b4e1 100644
--- a/include/link.h
+++ b/include/link.h
@@ -312,7 +312,7 @@ void sub_800AB18(void);
 void sub_8009F18(void);
 bool8 sub_800AA60(void);
 void sub_800ABF4(u16 a0);
-bool32 sub_8009F3C(void);
-u32 sub_800B4DC(void);
+bool32 IsSendingKeysToLink(void);
+u32 GetLinkRecvQueueLength(void);
 
 #endif // GUARD_LINK_H
diff --git a/include/link_rfu.h b/include/link_rfu.h
index d468d6c49..435880e20 100644
--- a/include/link_rfu.h
+++ b/include/link_rfu.h
@@ -218,7 +218,7 @@ void sub_800E700(void);
 void sub_800EDD4(void);
 void sub_800F6FC(u8 who);
 void sub_800F728(u8 who);
-bool32 sub_800F7E4(void);
+bool32 IsSendingKeysToRfu(void);
 void sub_800F804(void);
 void sub_800F850(void);
 u8 sub_800FCD8(void);
@@ -237,8 +237,8 @@ void sub_800E6D0(void);
 bool32 sub_8010EC0(void);
 bool32 sub_8010F1C(void);
 bool32 sub_8011A80(void);
-bool32 sub_800F0B8(void);
-u32 sub_80124D4(void);
+bool32 IsRfuRecvQueueEmpty(void);
+u32 GetRfuRecvQueueLength(void);
 void RfuVSync(void);
 void sub_80111B0(bool32 a0);
 u8 sub_8011A74(void);
diff --git a/include/overworld.h b/include/overworld.h
index 1a8702d71..b5c41b1e6 100644
--- a/include/overworld.h
+++ b/include/overworld.h
@@ -1,6 +1,18 @@
 #ifndef GUARD_OVERWORLD_H
 #define GUARD_OVERWORLD_H
 
+#define LINK_KEY_CODE_NULL 0x00
+#define LINK_KEY_CODE_EMPTY 0x11
+#define LINK_KEY_CODE_DPAD_DOWN 0x12
+#define LINK_KEY_CODE_DPAD_UP 0x13
+#define LINK_KEY_CODE_DPAD_LEFT 0x14
+#define LINK_KEY_CODE_DPAD_RIGHT 0x15
+#define LINK_KEY_CODE_UNK_2 0x16
+#define LINK_KEY_CODE_UNK_3 0x17
+#define LINK_KEY_CODE_START_BUTTON 0x18
+#define LINK_KEY_CODE_A_BUTTON 0x19
+#define LINK_KEY_CODE_UNK_4 0x1A // I'd guess this is the B button?
+
 struct InitialPlayerAvatarState
 {
     u8 transitionFlags;
@@ -22,10 +34,10 @@ extern struct LinkPlayerEventObject gLinkPlayerEventObjects[4];
 extern u16 *gBGTilemapBuffers1;
 extern u16 *gBGTilemapBuffers2;
 extern u16 *gBGTilemapBuffers3;
-extern u16 gUnknown_03005DA8;
+extern u16 gHeldKeyCodeToSend;
 extern void (*gFieldCallback)(void);
 extern bool8 (*gFieldCallback2)(void);
-extern u8 gLinkGuestPlayerId;
+extern u8 gLinkSelfPlayerId;
 extern u8 gFieldLinkPlayerCount;
 
 // Exported ROM declarations
@@ -103,7 +115,7 @@ u8 GetSavedWarpRegionMapSectionId(void);
 u8 GetCurrentRegionMapSectionId(void);
 u8 GetCurrentMapBattleScene(void);
 void CleanupOverworldWindowsAndTilemaps(void);
-bool32 is_c1_link_related_active(void);
+bool32 IsUpdateLinkStateCBActive(void);
 void CB1_Overworld(void);
 void CB2_OverworldBasic(void);
 void CB2_Overworld(void);
@@ -117,13 +129,13 @@ void sub_8086074(void);
 void CB2_ReturnToField(void);
 void CB2_ReturnToFieldLocal(void);
 void CB2_ReturnToFieldLink(void);
-void c2_8056854(void);
+void CB2_ReturnToFieldFromMultiplayer(void);
 void CB2_ReturnToFieldWithOpenMenu(void);
 void CB2_ReturnToFieldContinueScript(void);
 void CB2_ReturnToFieldContinueScriptPlayMapMusic(void);
 void sub_80861E8(void);
 void CB2_ContinueSavedGame(void);
-void sub_8086C2C(void);
+void ResetAllMultiplayerState(void);
 u32 sub_8087214(void);
 bool32 sub_808727C(void);
 u16 sub_8087288(void);