Merge pull request #173 from adrienntindall/main

Partially document field_comm_manager

include/communication_system.h

@@ -31,8 +31,8 @@ BOOL sub_02035AC4(int param0, const void * param1, int param2);
 BOOL sub_02035B48(int param0, const void * param1);
 int sub_02035B54(void);
 BOOL CommSys_IsPlayerConnected(u16 param0);
-int sub_02035E18(void);
-BOOL sub_02035E38(void);
+int CommSys_ConnectedCount(void);
+BOOL CommSys_IsInitialized(void);
 void sub_02035E5C(u8 param0);
 u8 sub_02035E70(int param0);
 u16 sub_02035E84(int param0);

include/struct_defs/struct_0203CDB0.h → include/field/field_system.h

@@ -1,15 +1,15 @@
-#ifndef POKEPLATINUM_STRUCT_0203CDB0_H
-#define POKEPLATINUM_STRUCT_0203CDB0_H
+#ifndef POKEPLATINUM_FIELD_SYSTEM_H
+#define POKEPLATINUM_FIELD_SYSTEM_H
 
 #include "struct_decls/struct_02018340_decl.h"
 #include "struct_decls/struct_020203AC_decl.h"
 #include "struct_defs/struct_0202610C.h"
 #include "struct_decls/struct_0202B628_decl.h"
 #include "struct_decls/struct_02039E30_decl.h"
 #include "struct_decls/struct_0203A3E8_decl.h"
-#include "struct_decls/struct_0203CDB0_sub1_decl.h"
-#include "struct_decls/struct_0203CDB0_sub2_decl.h"
-#include "struct_defs/struct_0203CDB0_sub3.h"
+#include "field/field_system_sub1_decl.h"
+#include "field/field_system_sub2_decl.h"
+#include "field/field_system_sub3.h"
 #include "struct_defs/struct_02049FA8.h"
 #include "struct_defs/struct_0204AFC4.h"
 #include "struct_decls/struct_020508D4_decl.h"
@@ -44,9 +44,9 @@
 #include "overlay056/struct_ov56_02256468_decl.h"
 #include "overlay066/struct_ov66_0222DCE0_sub1.h"
 
-typedef struct UnkStruct_0203CDB0_t {
-    UnkStruct_0203CDB0_sub1 * unk_00;
-    UnkStruct_0203CDB0_sub2 * unk_04;
+typedef struct FieldSystem_t {
+    FieldSystem_sub1 * unk_00;
+    FieldSystem_sub2 * unk_04;
     BGL * unk_08;
     SaveData * unk_0C;
     UnkStruct_020508D4 * unk_10;
@@ -75,7 +75,7 @@ typedef struct UnkStruct_0203CDB0_t {
     UnkStruct_ov23_0224942C * unk_6C;
     int unk_70;
     const UnkStruct_020EC3A8 * unk_74;
-    UnkStruct_0203CDB0_sub3 unk_78;
+    FieldSystem_sub3 unk_78;
     UnkStruct_0205B43C * unk_7C;
     UnkStruct_0205C22C * unk_80;
     UnkStruct_ov56_02256468 * unk_84;
@@ -95,6 +95,6 @@ typedef struct UnkStruct_0203CDB0_t {
     UnkStruct_0209C370 * unk_BC;
     u32 unk_C0;
     UnkStruct_ov66_0222DCE0_sub1 unk_C4;
-} UnkStruct_0203CDB0;
+} FieldSystem;
 
-#endif // POKEPLATINUM_STRUCT_0203CDB0_H
+#endif // POKEPLATINUM_FIELD_SYSTEM_H

include/field/field_system_decl.h

@@ -0,0 +1,6 @@
+#ifndef POKEPLATINUM_FIELD_SYSTEM_DECL_H
+#define POKEPLATINUM_FIELD_SYSTEM_DECL_H
+
+typedef struct FieldSystem_t FieldSystem;
+
+#endif // POKEPLATINUM_FIELD_SYSTEM_DECL_H

include/field/field_system_sub1_decl.h

@@ -0,0 +1,6 @@
+#ifndef POKEPLATINUM_FIELD_SYSTEM_SUB1_DECL_H
+#define POKEPLATINUM_FIELD_SYSTEM_SUB1_DECL_H
+
+typedef struct FieldSystem_sub1_t FieldSystem_sub1;
+
+#endif // POKEPLATINUM_FIELD_SYSTEM_SUB1_DECL_H

include/field/field_system_sub2_decl.h

@@ -0,0 +1,6 @@
+#ifndef POKEPLATINUM_FIELD_SYSTEM_SUB2_DECL_H
+#define POKEPLATINUM_FIELD_SYSTEM_SUB2_DECL_H
+
+typedef struct FieldSystem_sub2_t FieldSystem_sub2;
+
+#endif // POKEPLATINUM_FIELD_SYSTEM_SUB2_DECL_H

include/struct_defs/struct_0203CDB0_sub2_t.h → include/field/field_system_sub2_t.h

@@ -1,5 +1,5 @@
-#ifndef POKEPLATINUM_STRUCT_0203CDB0_SUB2_T_H
-#define POKEPLATINUM_STRUCT_0203CDB0_SUB2_T_H
+#ifndef POKEPLATINUM_FIELD_SYSTEM_SUB2_T_H
+#define POKEPLATINUM_FIELD_SYSTEM_SUB2_T_H
 
 #include "struct_decls/struct_02055CBC_decl.h"
 #include "overlay005/struct_ov5_021D1A94_decl.h"
@@ -10,7 +10,7 @@
 #include "overlay005/struct_ov5_021EF4F8_decl.h"
 #include "overlay025/struct_ov25_02253CE0_decl.h"
 
-struct UnkStruct_0203CDB0_sub2_t {
+struct FieldSystem_sub2_t {
     BOOL unk_00;
     UnkStruct_ov5_021D1A94 * unk_04;
     UnkStruct_ov5_021DD9C8 * unk_08;
@@ -23,4 +23,4 @@ struct UnkStruct_0203CDB0_sub2_t {
     void * unk_24;
 };
 
-#endif // POKEPLATINUM_STRUCT_0203CDB0_SUB2_T_H
+#endif // POKEPLATINUM_FIELD_SYSTEM_SUB2_T_H

include/field/field_system_sub3.h

@@ -0,0 +1,9 @@
+#ifndef POKEPLATINUM_FIELD_SYSTEM_SUB3_H
+#define POKEPLATINUM_FIELD_SYSTEM_SUB3_H
+
+typedef struct {
+    u16 unk_00;
+    u16 unk_02;
+} FieldSystem_sub3;
+
+#endif // POKEPLATINUM_FIELD_SYSTEM_SUB3_H

include/unk_0205964C.h → include/field_comm_manager.h

@@ -2,19 +2,19 @@
 #define POKEPLATINUM_UNK_0205964C_H
 
 #include "struct_decls/struct_02029894_decl.h"
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "struct_defs/struct_0205964C.h"
 #include "savedata.h"
 
-UnkStruct_0205964C * sub_0205964C(void);
-void sub_0205965C(UnkStruct_0203CDB0 * param0);
-void sub_020596BC(void);
-void sub_02059708(UnkStruct_0203CDB0 * param0, int param1, int param2);
-void sub_02059748(UnkStruct_0203CDB0 * param0, int param1, int param2);
-void sub_02059788(int param0);
-void sub_020597A4(void);
-void sub_020597B4(UnkStruct_0203CDB0 * param0);
-void sub_0205987C(void);
+FieldCommunicationManager * FieldCommMan_Get(void);
+void FieldCommMan_Init(FieldSystem * param0);
+void FieldCommMan_Delete(void);
+void FieldCommMan_StartBattleServer(FieldSystem * param0, int param1, int param2);
+void FieldCommMan_StartBattleClient(FieldSystem * param0, int param1, int param2);
+void FieldCommMan_ConnectBattleClient(int param0);
+void FieldCommMan_ReconnectBattleClient(void);
+void FieldCommMan_EnterBattleRoom(FieldSystem * param0);
+void FieldCommMan_EndBattle(void);
 void sub_020598A0(void);
 void sub_02059D0C(int param0, int param1, void * param2, void * param3);
 BOOL sub_02059D2C(void);

include/functypes/funcptr_020598EC.h

@@ -1,6 +1,6 @@
 #ifndef POKEPLATINUM_FUNCPTR_020598EC_H
 #define POKEPLATINUM_FUNCPTR_020598EC_H
 
-typedef void (* UnkFuncPtr_020598EC)(void);
+typedef void (* FieldCommTask)(void);
 
 #endif // POKEPLATINUM_FUNCPTR_020598EC_H

include/functypes/funcptr_020EC57C.h

@@ -1,8 +1,8 @@
 #ifndef POKEPLATINUM_FUNCPTR_020EC57C_H
 #define POKEPLATINUM_FUNCPTR_020EC57C_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-typedef void (* UnkFuncPtr_020EC57C)(UnkStruct_0203CDB0 *);
+typedef void (* UnkFuncPtr_020EC57C)(FieldSystem *);
 
 #endif // POKEPLATINUM_FUNCPTR_020EC57C_H

include/functypes/funcptr_020EF718.h

@@ -1,8 +1,8 @@
 #ifndef POKEPLATINUM_FUNCPTR_020EF718_H
 #define POKEPLATINUM_FUNCPTR_020EF718_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-typedef void (* UnkFuncPtr_020EF718)(UnkStruct_0203CDB0 *);
+typedef void (* UnkFuncPtr_020EF718)(FieldSystem *);
 
 #endif // POKEPLATINUM_FUNCPTR_020EF718_H

include/functypes/funcptr_020EF744.h

@@ -1,8 +1,8 @@
 #ifndef POKEPLATINUM_FUNCPTR_020EF744_H
 #define POKEPLATINUM_FUNCPTR_020EF744_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-typedef void (* UnkFuncPtr_020EF744)(UnkStruct_0203CDB0 *);
+typedef void (* UnkFuncPtr_020EF744)(FieldSystem *);
 
 #endif // POKEPLATINUM_FUNCPTR_020EF744_H

include/functypes/funcptr_020EF770.h

@@ -1,8 +1,8 @@
 #ifndef POKEPLATINUM_FUNCPTR_020EF770_H
 #define POKEPLATINUM_FUNCPTR_020EF770_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-typedef BOOL (* UnkFuncPtr_020EF770)(UnkStruct_0203CDB0 *, const int, const int, const fx32, BOOL *);
+typedef BOOL (* UnkFuncPtr_020EF770)(FieldSystem *, const int, const int, const fx32, BOOL *);
 
 #endif // POKEPLATINUM_FUNCPTR_020EF770_H

include/inlines.h

@@ -9,7 +9,7 @@
 #include "struct_decls/struct_020507E4_decl.h"
 #include "struct_decls/struct_0203E724_decl.h"
 
-#include "struct_defs/struct_0203CDB0.h"
+#include "field/field_system.h"
 #include "struct_defs/struct_0203E724_t.h"
 #include "struct_defs/struct_02049FA8.h"
 #include "overlay061/struct_ov61_0222C3B0.h"
@@ -131,7 +131,7 @@ static inline void inline_ov61_0222C3B0_sub (SysTask * param0, void * param1)
     }
 }
 
-static inline void inline_ov47_0225621C_sub (UnkStruct_0203CDB0 * param0, int * param1, int * param2)
+static inline void inline_ov47_0225621C_sub (FieldSystem * param0, int * param1, int * param2)
 {
     UnkStruct_0203A790 * v0 = sub_0203A790(param0->unk_0C);
     UnkStruct_02049FA8 * v1 = sub_0203A72C(v0);
@@ -145,7 +145,7 @@ static inline void inline_ov47_0225621C_sub (UnkStruct_0203CDB0 * param0, int *
     }
 }
 
-static inline void inline_ov47_0225621C (UnkStruct_0203CDB0 * param0, int * param1, int * param2)
+static inline void inline_ov47_0225621C (FieldSystem * param0, int * param1, int * param2)
 {
     inline_ov47_0225621C_sub(param0, param1, param2);
     *param1 /= 32;

include/overlay005/ov5_021D0D80.h

@@ -2,13 +2,13 @@
 #define POKEPLATINUM_OV5_021D0D80_H
 
 #include "struct_decls/struct_02018340_decl.h"
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-void ov5_021D12D0(UnkStruct_0203CDB0 * param0, u32 param1);
+void ov5_021D12D0(FieldSystem * param0, u32 param1);
 void ov5_021D1434(BGL * param0);
 void ov5_021D143C(BGL * param0);
-void ov5_021D16F4(UnkStruct_0203CDB0 * param0, BOOL param1);
-void ov5_021D1718(UnkStruct_0203CDB0 * param0, BOOL param1);
+void ov5_021D16F4(FieldSystem * param0, BOOL param1);
+void ov5_021D1718(FieldSystem * param0, BOOL param1);
 void ov5_021D1744(const u8 param0);
 
 #endif // POKEPLATINUM_OV5_021D0D80_H

include/overlay005/ov5_021D1A94.h

@@ -1,12 +1,12 @@
 #ifndef POKEPLATINUM_OV5_021D1A94_H
 #define POKEPLATINUM_OV5_021D1A94_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "overlay005/struct_ov5_021D1A94_decl.h"
 #include "overlay005/struct_ov5_021D1BEC_decl.h"
 #include "overlay006/struct_ov6_0223E6EC.h"
 
-UnkStruct_ov5_021D1A94 * ov5_021D1A94(UnkStruct_0203CDB0 * param0, int param1, int param2);
+UnkStruct_ov5_021D1A94 * ov5_021D1A94(FieldSystem * param0, int param1, int param2);
 void ov5_021D1AE4(UnkStruct_ov5_021D1A94 * param0);
 void ov5_021D1B18(UnkStruct_ov5_021D1A94 * param0);
 UnkStruct_ov5_021D1BEC * ov5_021D1B6C(UnkStruct_ov5_021D1A94 * param0, const UnkStruct_ov6_0223E6EC * param1);

include/overlay005/ov5_021D1C30.h

@@ -1,14 +1,14 @@
 #ifndef POKEPLATINUM_OV5_021D1C30_H
 #define POKEPLATINUM_OV5_021D1C30_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "overlay005/struct_ov5_021D1CAC.h"
 
-void ov5_021D1CAC(UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1, u16 param2, u16 param3);
-int ov5_021D1DA4(const UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1);
-BOOL ov5_021D213C(UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1);
-BOOL ov5_021D219C(UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1);
-BOOL ov5_021D2298(const UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1);
-int ov5_021D2368(const UnkStruct_ov5_021D1CAC * param0, UnkStruct_0203CDB0 * param1);
+void ov5_021D1CAC(UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1, u16 param2, u16 param3);
+int ov5_021D1DA4(const UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1);
+BOOL ov5_021D213C(UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1);
+BOOL ov5_021D219C(UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1);
+BOOL ov5_021D2298(const UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1);
+int ov5_021D2368(const UnkStruct_ov5_021D1CAC * param0, FieldSystem * param1);
 
 #endif // POKEPLATINUM_OV5_021D1C30_H

include/overlay005/ov5_021D431C.h

@@ -1,24 +1,24 @@
 #ifndef POKEPLATINUM_OV5_021D431C_H
 #define POKEPLATINUM_OV5_021D431C_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "struct_decls/struct_020508D4_decl.h"
 #include "overlay005/struct_ov5_021D432C_decl.h"
 #include "overlay005/struct_ov5_021D4E00_decl.h"
 
 UnkStruct_ov5_021D432C * ov5_021D431C(void);
 void ov5_021D432C(UnkStruct_ov5_021D432C * param0);
 void ov5_021D4334(const int param0, const int param1, UnkStruct_ov5_021D432C * param2);
-BOOL ov5_021D433C(UnkStruct_0203CDB0 * param0, UnkStruct_ov5_021D432C * param1);
-BOOL ov5_021D453C(UnkStruct_0203CDB0 * param0, UnkStruct_ov5_021D432C * param1);
-BOOL ov5_021D4858(UnkStruct_0203CDB0 * param0, UnkStruct_ov5_021D432C * param1, const u8 param2);
-BOOL ov5_021D4A24(UnkStruct_0203CDB0 * param0, UnkStruct_ov5_021D432C * param1, const u8 param2);
-void ov5_021D4BF4(UnkStruct_0203CDB0 * param0, const int param1, const int param2, const u8 param3);
-void ov5_021D4C88(UnkStruct_0203CDB0 * param0, const u8 param1);
-void ov5_021D4CEC(UnkStruct_0203CDB0 * param0, const u8 param1);
-void ov5_021D4D48(UnkStruct_0203CDB0 * param0, const u8 param1);
-void ov5_021D4D68(UnkStruct_0203CDB0 * param0, const u8 param1);
-void ov5_021D4D78(const int param0, const int param1, const int param2, UnkStruct_0203CDB0 * param3);
+BOOL ov5_021D433C(FieldSystem * param0, UnkStruct_ov5_021D432C * param1);
+BOOL ov5_021D453C(FieldSystem * param0, UnkStruct_ov5_021D432C * param1);
+BOOL ov5_021D4858(FieldSystem * param0, UnkStruct_ov5_021D432C * param1, const u8 param2);
+BOOL ov5_021D4A24(FieldSystem * param0, UnkStruct_ov5_021D432C * param1, const u8 param2);
+void ov5_021D4BF4(FieldSystem * param0, const int param1, const int param2, const u8 param3);
+void ov5_021D4C88(FieldSystem * param0, const u8 param1);
+void ov5_021D4CEC(FieldSystem * param0, const u8 param1);
+void ov5_021D4D48(FieldSystem * param0, const u8 param1);
+void ov5_021D4D68(FieldSystem * param0, const u8 param1);
+void ov5_021D4D78(const int param0, const int param1, const int param2, FieldSystem * param3);
 UnkStruct_ov5_021D4E00 * ov5_021D4E00(void);
 BOOL ov5_021D4E10(UnkStruct_020508D4 * param0);
 BOOL ov5_021D4F14(UnkStruct_020508D4 * param0);

include/overlay005/ov5_021D5B40.h

@@ -1,11 +1,11 @@
 #ifndef POKEPLATINUM_OV5_021D5B40_H
 #define POKEPLATINUM_OV5_021D5B40_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
 #include <nitro/fx/fx.h>
 
-void ov5_021D5B40(const VecFx32 * param0, UnkStruct_0203CDB0 * param1, const int param2, const BOOL param3);
-void ov5_021D5BA8(UnkStruct_0203CDB0 * param0);
+void ov5_021D5B40(const VecFx32 * param0, FieldSystem * param1, const int param2, const BOOL param3);
+void ov5_021D5BA8(FieldSystem * param0);
 
 #endif // POKEPLATINUM_OV5_021D5B40_H

include/overlay005/ov5_021D5BC0.h

@@ -1,11 +1,11 @@
 #ifndef POKEPLATINUM_OV5_021D5BC0_H
 #define POKEPLATINUM_OV5_021D5BC0_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 
-void ov5_021D5BD8(UnkStruct_0203CDB0 * param0);
-BOOL ov5_021D5BF4(UnkStruct_0203CDB0 * param0);
-void ov5_021D5C14(UnkStruct_0203CDB0 * param0);
-BOOL ov5_021D5C30(UnkStruct_0203CDB0 * param0);
+void ov5_021D5BD8(FieldSystem * param0);
+BOOL ov5_021D5BF4(FieldSystem * param0);
+void ov5_021D5C14(FieldSystem * param0);
+BOOL ov5_021D5C30(FieldSystem * param0);
 
 #endif // POKEPLATINUM_OV5_021D5BC0_H

include/overlay005/ov5_021D5EB8.h

@@ -1,16 +1,16 @@
 #ifndef POKEPLATINUM_OV5_021D5EB8_H
 #define POKEPLATINUM_OV5_021D5EB8_H
 
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "overlay005/struct_ov5_021D5EF8_decl.h"
 #include "overlay005/struct_ov5_021D6594_decl.h"
 
-UnkStruct_ov5_021D5EF8 * ov5_021D5EB8(UnkStruct_0203CDB0 * param0);
+UnkStruct_ov5_021D5EF8 * ov5_021D5EB8(FieldSystem * param0);
 void ov5_021D5EF8(UnkStruct_ov5_021D5EF8 * param0);
 void ov5_021D5F24(UnkStruct_ov5_021D5EF8 * param0, int param1);
 BOOL ov5_021D5F7C(UnkStruct_ov5_021D5EF8 * param0, int param1);
 u32 ov5_021D5FE0(UnkStruct_ov5_021D5EF8 * param0);
-UnkStruct_ov5_021D6594 * ov5_021D6364(UnkStruct_0203CDB0 * param0);
+UnkStruct_ov5_021D6594 * ov5_021D6364(FieldSystem * param0);
 void ov5_021D63A4(UnkStruct_ov5_021D6594 ** param0);
 BOOL ov5_021D6418(UnkStruct_ov5_021D6594 * param0, int param1, int param2);
 int ov5_021D64D0(UnkStruct_ov5_021D6594 * param0, int param1);

include/overlay005/ov5_021DB888.h

@@ -2,13 +2,13 @@
 #define POKEPLATINUM_OV5_021DB888_H
 
 #include "struct_decls/struct_0200B358_decl.h"
-#include "struct_decls/struct_0203CDB0_decl.h"
+#include "field/field_system_decl.h"
 #include "struct_decls/struct_020508D4_decl.h"
 #include "struct_decls/struct_02061AB4_decl.h"
 
 void ov5_021DB888(UnkStruct_020508D4 * param0, StringFormatter * param1, u16 * param2);
-BOOL ov5_021DBB94(UnkStruct_0203CDB0 * param0);
-u16 ov5_021DBD98(UnkStruct_0203CDB0 * param0, UnkStruct_02061AB4 * param1, u16 param2);
-void ov5_021DBED4(UnkStruct_0203CDB0 * param0, UnkStruct_02061AB4 * param1);
+BOOL ov5_021DBB94(FieldSystem * param0);
+u16 ov5_021DBD98(FieldSystem * param0, UnkStruct_02061AB4 * param1, u16 param2);
+void ov5_021DBED4(FieldSystem * param0, UnkStruct_02061AB4 * param1);
 
 #endif // POKEPLATINUM_OV5_021DB888_H