Document union room chat

include/global.h

@@ -775,7 +775,7 @@ struct SaveBlock1
     /*0x3A4C*/ u8 rivalName[PLAYER_NAME_LENGTH + 1];
     /*0x3A54*/ struct FameCheckerSaveData fameChecker[NUM_FAMECHECKER_PERSONS];
     /*0x3A94*/ u8 filler3A94[0x40];
-    /*0x3AD4*/ u8 unk3AD4[UNION_ROOM_KB_ROW_COUNT][21];
+    /*0x3AD4*/ u8 registeredTexts[UNION_ROOM_KB_ROW_COUNT][21];
     /*0x3BA8*/ struct TrainerNameRecord trainerNameRecords[20];
     /*0x3C98*/ struct DaycareMon route5DayCareMon;
     /*0x3D24*/ u8 filler3D24[0x10];

include/graphics.h

@@ -4865,14 +4865,14 @@ extern const u32 gBagBgPalette[];
 extern const u32 gBagBgPalette_FemaleOverride[];
 
 // union_room_chat_display
-extern const u16 gUnknown_8EAA9F0[];
-extern const u32 gUnknown_8EAAA10[];
-extern const u32 gUnknown_8EAAA6C[];
+extern const u16 gUnionRoomChatPanelBgPal_7[];
+extern const u32 gUnionRoomChatPanelBgTiles[];
+extern const u32 gUnionRoomChatPanelBgMap[];
 extern const u16 gLinkMiscMenu_Pal[];
 extern const u32 gLinkMiscMenu_Gfx[];
 extern const u32 gLinkMiscMenu_Tilemap[];
 
 // union_room_chat_objects
-extern const u32 gUnknown_8EA1A50[];
+extern const u32 gUnionRoomChatIcons[];
 
 #endif //GUARD_GRAPHICS_H

include/link_rfu.h

@@ -216,7 +216,7 @@ struct UnkRfuStruct_2
     /* 0x99d */ u8 unk_ce5;
     /* 0x99e */ u8 unk_ce6;
     /* 0x99f */ u8 unk_ce7;
-    /* 0x9a0 */ u8 unk_ce8;
+    /* 0x9a0 */ bool8 unk_ce8;
     /* 0x9a1 */ u8 unk_ce9;
     /* 0x9a2 */ u8 unk_cea[RFU_CHILD_MAX];
     /* 0x9a6 */ u8 unk_cee[RFU_CHILD_MAX];
@@ -325,7 +325,7 @@ void sub_80FC114(const u8 *name, struct GFtgtGname *structPtr, u8 a2);
 bool32 PlayerHasMetTrainerBefore(u16 id, u8 *name);
 bool8 sub_80FCC3C(struct GFtgtGname *gname, u8 *uname, u8 idx);
 bool8 sub_80FCCF4(struct GFtgtGname *gname, u8 *uname, u8 idx);
-bool32 sub_80FBA1C(void);
+bool32 GetRfuUnkCE8(void);
 void sub_80FA4A8(void);
 void sub_80FB9D0(void);
 void sub_80FB030(u32 a0);

include/union_room_chat.h

@@ -11,20 +11,20 @@ enum
 
 extern const u8 *const gUnionRoomKeyboardText[UNION_ROOM_KB_PAGE_COUNT][UNION_ROOM_KB_ROW_COUNT];
 
-void sub_8128420(void);
-u8 *sub_81294B0(int arg0);
-void sub_8129700(u8 *arg0, u8 *arg1);
-u8 *sub_8129714(void);
-int sub_8129720(void);
-void sub_8129730(u32 *a0, u32 *a1);
-u8 *sub_8129758(void);
-u16 sub_8129788(void);
-u8 *sub_81297C4(void);
-u16 sub_81297D0(void);
-int sub_81297DC(void);
-int sub_81297E8(void);
-u8 *sub_8129814(void);
-void copy_strings_to_sav1(void);
+void EnterUnionRoomChat(void);
+u8 *UnionRoomChat_GetWorkRegisteredText(int arg0);
+void UnionRoomChat_GetCursorColAndRow(u8 *colp, u8 *rowp);
+u8 *UnionRoomChat_GetMessageEntryBuffer(void);
+int UnionRoomChat_LenMessageEntryBuffer(void);
+void UnionRoomChat_GetBufferSelectionRegion(u32 *startp, u32 *diffp);
+u8 *UnionRoomChat_GetEndOfMessageEntryBuffer(void);
+u16 UnionRoomChat_GetNumCharsInMessageEntryBuffer(void);
+u8 *UnionRoomChat_GetLastReceivedMessage(void);
+u16 UnionRoomChat_GetReceivedPlayerIndex(void);
+int UnionRoomChat_GetMessageEntryCursorPosition(void);
+int UnionRoomChat_GetWhetherShouldShowCaseToggleIcon(void);
+u8 *UnionRoomChat_GetNameOfPlayerWhoDisbandedChat(void);
+void UnionRoomChat_InitializeRegisteredTexts(void);
 u8 GetCurrentKeyboardPage(void);
 
 #endif // GUARD_UNION_ROOM_CHAT_H

include/union_room_chat_display.h

@@ -1,12 +1,34 @@
 #ifndef GUARD_UNION_ROOM_CHAT_DISPLAY_H
 #define GUARD_UNION_ROOM_CHAT_DISPLAY_H
 
-bool8 sub_8129B14(void);
-bool32 sub_8129B78(void);
-void sub_8129B88(void);
-void sub_8129BFC(void);
-void sub_8129C34(u16 a0, u8 a1);
-u8 sub_8129C8C(u8 a0);
-s8 sub_812A568(void);
+#define CHATDISPLAYROUTINE_LOADGFX  0
+#define CHATDISPLAYROUTINE_MOVEKBCURSOR  1
+#define CHATDISPLAYROUTINE_CURSORBLINK  2
+#define CHATDISPLAYROUTINE_SHOWKBSWAPMENU  3
+#define CHATDISPLAYROUTINE_HIDEKBSWAPMENU  4
+#define CHATDISPLAYROUTINE_SWITCHPAGES  5
+#define CHATDISPLAYROUTINE_SHOWQUITCHATTINGDIALOG  6
+#define CHATDISPLAYROUTINE_DESTROYSTDMSGANDYESNO  7
+#define CHATDISPLAYROUTINE_PRINTMSG  8
+#define CHATDISPLAYROUTINE_PRINTREGISTERWHERE  9
+#define CHATDISPLAYROUTINE_CANCELREGISTER 10
+#define CHATDISPLAYROUTINE_RETURNTOKB 11
+#define CHATDISPLAYROUTINE_SCROLLCHAT 12
+#define CHATDISPLAYROUTINE_PRINTINPUTTEXT 13
+#define CHATDISPLAYROUTINE_ASKSAVE 14
+#define CHATDISPLAYROUTINE_ASKOVERWRITESAVE 15
+#define CHATDISPLAYROUTINE_PRINTSAVING 16
+#define CHATDISPLAYROUTINE_PRINTSAVEDTHEGAME 17
+#define CHATDISPLAYROUTINE_PRINTEXITINGCHAT 18
+#define CHATDISPLAYROUTINE_PRINTLEADERLEFT 19
+#define CHATDISPLAYROUTINE_SHOWCONFIRMLEADERLEAVEDIALOG 20
+
+bool8 UnionRoomChat_TryAllocGraphicsWork(void);
+bool32 UnionRoomChat_RunDisplaySubtask0(void);
+void UnionRoomChat_FreeGraphicsWork(void);
+void UnionRoomChat_RunDisplaySubtasks(void);
+void UnionRoomChat_StartDisplaySubtask(u16 a0, u8 a1);
+u8 RunDisplaySubtask(u8 a0);
+s8 UnionRoomChat_ProcessInput(void);
 
 #endif //GUARD_UNION_ROOM_CHAT_DISPLAY_H

include/union_room_chat_objects.h

@@ -1,16 +1,16 @@
 #ifndef GUARD_UNION_ROOM_CHAT_OBJECTS_H
 #define GUARD_UNION_ROOM_CHAT_OBJECTS_H
 
-bool32 sub_812AE70(void);
-void sub_812AEB0(void);
-void sub_812AEC8(void);
-void sub_812AEFC(bool32 invisible);
-void sub_812AF1C(void);
-void sub_812AF8C(u32 idx);
-void sub_812AFC0(void);
-bool32 sub_812AFFC(void);
-void sub_812B048(void);
-void sub_812B100(void);
-void sub_812B160(void);
+bool32 UnionRoomChat_TryAllocSpriteWork(void);
+void UnionRoomChat_FreeSpriteWork(void);
+void UnionRoomChat_CreateSelectorCursorObj(void);
+void UnionRoomChat_ToggleSelectorCursorObjVisibility(bool32 invisible);
+void UnionRoomChat_MoveSelectorCursorObj(void);
+void UnionRoomChat_UpdateObjPalCycle(u32 idx);
+void UnionRoomChat_SetSelectorCursorClosedImage(void);
+bool32 UnionRoomChat_AnimateSelectorCursorReopen(void);
+void UnionRoomChat_SpawnTextEntryPointerSprites(void);
+void CreatePageSwitchUISprites(void);
+void UpdateVisibleUnionRoomChatIcon(void);
 
 #endif //GUARD_UNION_ROOM_CHAT_OBJECTS_H