Document easy_chat

wildfirebill · Nov 1, 2019 · 2100eb9 · 2100eb9
1 parent 115fd2a
commit 2100eb9
Show file tree

Hide file tree

Showing 8 changed files with 134 additions and 131 deletions.
diff --git a/asm/battle_tower.s b/asm/battle_tower.s
@@ -1863,7 +1863,7 @@ sub_80E678C: @ 80E678C
 	movs r1, 0x3
 	movs r2, 0x2
 	movs r3, 0x12
-	bl sub_80BD974
+	bl EC_DoesEasyChatStringFitOnLine
 	lsls r0, 24
 	cmp r0, 0
 	beq _080E67E4

diff --git a/asm/link_rfu.s b/asm/link_rfu.s
@@ -3443,7 +3443,7 @@ _080FEDC0:
 	bl ResetPaletteFade
 	b _080FEE16
 _080FEDD4:
-	bl sub_80BDE44
+	bl InitEasyChatSelection
 	b _080FEDF2
 _080FEDDA:
 	ldrb r4, [r6, 0x2]
@@ -3490,7 +3490,7 @@ _080FEE1E:
 sub_80FEE24: @ 80FEE24
 	push {r4,lr}
 	adds r4, r0, 0
-	bl sub_80BDE70
+	bl DestroyEasyChatSelectionData
 	bl sub_80FF010
 	bl sub_810011C
 	bl FreeAllWindowBuffers
@@ -3701,7 +3701,7 @@ _080FEFE0:
 	ldrb r2, [r0, 0x7]
 	adds r0, r6, 0
 	bl CpuSet
-	bl sub_80BDF38
+	bl GetNumDisplayableGroups
 	ldr r2, [r4]
 	lsls r0, 24
 	lsrs r0, 24
@@ -4565,12 +4565,12 @@ sub_80FF5FC: @ 80FF5FC
 	bl sub_80FFB8C
 	lsls r0, 24
 	lsrs r0, 24
-	bl sub_80BDF44
+	bl GetSelectedGroupByIndex
 	adds r1, r0, 0
 	lsls r1, 24
 	lsrs r1, 24
 	movs r0, 0
-	bl sub_80BE16C
+	bl GetUnlockedECWords
 	b _080FF638
 	.align 2, 0
 _080FF624: .4byte gUnknown_203ACE8
@@ -4580,9 +4580,9 @@ _080FF628:
 	lsls r1, 16
 	lsrs r1, 16
 	movs r0, 0x1
-	bl sub_80BE16C
+	bl GetUnlockedECWords
 _080FF638:
-	bl sub_80BE1D4
+	bl GetNumDisplayedWords
 	lsls r0, 16
 	lsrs r0, 16
 	cmp r0, 0
@@ -4673,7 +4673,7 @@ sub_80FF6C8: @ 80FF6C8
 	bl sub_80FFBE4
 	lsls r0, 16
 	lsrs r0, 16
-	bl sub_80BE19C
+	bl GetDisplayedWordByIndex
 	lsls r0, 16
 	lsrs r0, 16
 	bl sub_80FF768
@@ -5506,7 +5506,7 @@ sub_80FFC6C: @ 80FFC6C
 	bne _080FFC9C
 	bl sub_80FFB8C
 	adds r4, r0, 0
-	bl sub_80BDF38
+	bl GetNumDisplayableGroups
 	movs r1, 0
 	lsls r0, 24
 	lsls r4, 16
@@ -5546,7 +5546,7 @@ sub_80FFCC0: @ 80FFCC0
 	push {r4,lr}
 	bl sub_80FFBE4
 	adds r4, r0, 0
-	bl sub_80BE1D4
+	bl GetNumDisplayedWords
 	movs r1, 0
 	lsls r4, 16
 	lsls r0, 16
@@ -8492,7 +8492,7 @@ _0810134A:
 	lsls r0, r5, 24
 	lsrs r0, 24
 	adds r5, 0x1
-	bl sub_80BDF44
+	bl GetSelectedGroupByIndex
 	lsls r0, 24
 	lsrs r0, 24
 	cmp r0, 0x16
@@ -8708,7 +8708,7 @@ _081014E6:
 	lsls r0, r4, 16
 	lsrs r0, 16
 	adds r4, 0x1
-	bl sub_80BE19C
+	bl GetDisplayedWordByIndex
 	lsls r0, 16
 	lsrs r1, r0, 16
 	ldr r0, _08101554 @ =0x0000ffff

diff --git a/data/event_scripts.s b/data/event_scripts.s
@@ -11329,7 +11329,7 @@ EventScript_1BEE9E:: @ 81BEE9E
 EventScript_1BEEA8:: @ 81BEEA8
 	setvar VAR_0x4001, 1
 	setvar VAR_0x8004, 0
-	special sub_80BDA7C
+	special Special_BufferEasyChatMessage
 	waitmessage
 	delay 80
 	msgbox gUnknown_81BF28E
@@ -11376,7 +11376,7 @@ EventScript_1BEF35:: @ 81BEF35
 EventScript_1BEF3F:: @ 81BEF3F
 	setvar VAR_0x4001, 1
 	setvar VAR_0x8004, 0
-	special sub_80BDA7C
+	special Special_BufferEasyChatMessage
 	waitmessage
 	delay 80
 	msgbox gUnknown_81BF30D

diff --git a/data/specials.inc b/data/specials.inc
@@ -104,7 +104,7 @@ gSpecials:: @ 815FD60
 	def_special Field_AskSaveTheGame
 	def_special nullsub_56
 	def_special sub_80FEE44
-	def_special sub_80BDA7C
+	def_special Special_BufferEasyChatMessage
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special nullsub_75

diff --git a/include/constants/easy_chat.h b/include/constants/easy_chat.h
@@ -1076,4 +1076,6 @@
 #define EC_INDEX(word) ((word) & 0x1FF)
 #define EC_WORD(groupId, index) ((((groupId) & 0x7F) << 9) | ((index) & 0x1FF))
 
+#define EC_WORD_UNDEFINED (0xFFFF)
+
 #endif  // GUARD_CONSTANTS_EASY_CHAT_H
diff --git a/include/easy_chat.h b/include/easy_chat.h
@@ -33,15 +33,16 @@ struct EasyChatWordsByLetter
 void InitEasyChatPhrases(void);
 u8 *CopyEasyChatWord(u8 *dest, u16 word);
 u8 *ConvertEasyChatWordsToString(u8 *dest, const u16 *src, u16 length1, u16 length2);
-void sub_80BDE28(void);
+bool8 EC_DoesEasyChatStringFitOnLine(const u16 *easyChatWords, u8 columns, u8 rows, u16 maxLength);
+void ResetSomeMEventECBuffer_3120_338(void);
 void InitEasyChatPhrases(void);
 void EnableRareWord(u8);
-bool8 sub_80BDE44(void);
-void sub_80BDE70(void);
-u8 sub_80BDF44(u8);
-void sub_80BE16C(int, u16);
-u16 sub_80BE1D4(void);
-u16 sub_80BE19C(u16);
+bool8 InitEasyChatSelection(void);
+void DestroyEasyChatSelectionData(void);
+u8 GetSelectedGroupByIndex(u8);
+void GetUnlockedECWords(bool32 isAlphabetical, u16 groupId);
+u16 GetDisplayedWordByIndex(u16 index);
+u16 GetNumDisplayedWords(void);
 const u8 *GetEasyChatWordGroupName(u8);
 u8 *CopyEasyChatWordPadded(u8 *, u16, u16);