Document `EnTest3` (#1881)

* Document `EnTest3`

* Add comments for enum-type fields

* Add scheduled action index comments

Co-authored-by: Copilot <copilot@github.com>

* Use enums in comparisons

* Rename `sp3C`

* Rewrite comments on speak data

Co-authored-by: Copilot <copilot@github.com>

* Reformat

* Missed a text comment

* Missed another text comment

---------

Co-authored-by: Copilot <copilot@github.com>

3 files changed, 50 insertions, 46 deletions

diff --git a/src/code/z_kankyo.c b/src/code/z_kankyo.c
index 5be8576f6..b04139ba8 100644
--- a/src/code/z_kankyo.c
+++ b/src/code/z_kankyo.c
@@ -1657,47 +1657,51 @@ void Environment_UpdateSun(PlayState* play) {
     }
 }
 
-void func_800F88C4(u16 weekEventFlag) {
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_28_08) && !CHECK_WEEKEVENTREG(WEEKEVENTREG_28_10) &&
-        CHECK_WEEKEVENTREG(weekEventFlag)) {
-        if (CHECK_WEEKEVENTREG(WEEKEVENTREG_91_04)) {
-            SET_WEEKEVENTREG(WEEKEVENTREG_28_08);
-            SET_WEEKEVENTREG(WEEKEVENTREG_90_08);
-            SET_WEEKEVENTREG(WEEKEVENTREG_51_02);
+void Environment_SetLetterToKafeiScheduledIf(u16 weekEventFlag) {
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_DAY_2) &&
+        !CHECK_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_DAY_3) && CHECK_WEEKEVENTREG(weekEventFlag)) {
+        if (CHECK_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SENT_IN_TIME)) {
+            SET_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_DAY_2);
+            SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_RECEIVED_LETTER_TO_KAFEI);
+            SET_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_TODAY);
         }
 
-        if (CHECK_WEEKEVENTREG(WEEKEVENTREG_91_08)) {
-            SET_WEEKEVENTREG(WEEKEVENTREG_28_10);
-            SET_WEEKEVENTREG(WEEKEVENTREG_90_08);
-            SET_WEEKEVENTREG(WEEKEVENTREG_51_02);
+        if (CHECK_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SENT_LATE)) {
+            SET_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_DAY_3);
+            SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_RECEIVED_LETTER_TO_KAFEI);
+            SET_WEEKEVENTREG(WEEKEVENTREG_LETTER_TO_KAFEI_SCHEDULED_TODAY);
         }
     }
 }
 
-void func_800F8970(void) {
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_27_40) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(9, 31))) {
-        SET_WEEKEVENTREG(WEEKEVENTREG_27_40);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_UPPER_CLOCKTOWN);
+void Environment_UpdateCheckedPostboxes(void) {
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_UPPER_CLOCKTOWN) &&
+        (SCRIPT_TIME_NOW >= SCRIPT_TIME(9, 31))) {
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_UPPER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_UPPER_CLOCKTOWN);
     }
 
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_27_80) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 3))) {
-        SET_WEEKEVENTREG(WEEKEVENTREG_27_80);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_NORTH_CLOCKTOWN);
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_NORTH_CLOCKTOWN) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 3))) {
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_NORTH_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_NORTH_CLOCKTOWN);
     }
 
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_28_01) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 35))) {
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_01);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_UPPER_CLOCKTOWN);
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_UPPER_CLOCKTOWN) &&
+        (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 35))) {
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_UPPER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_UPPER_CLOCKTOWN);
     }
 
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_28_02) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 53))) {
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_02);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_LOWER_CLOCKTOWN);
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_LOWER_CLOCKTOWN) &&
+        (SCRIPT_TIME_NOW >= SCRIPT_TIME(10, 53))) {
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_LOWER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_LOWER_CLOCKTOWN);
     }
 
-    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_28_04) && (SCRIPT_TIME_NOW >= SCRIPT_TIME(11, 25))) {
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_04);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_LOWER_CLOCKTOWN);
+    if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_LOWER_CLOCKTOWN) &&
+        (SCRIPT_TIME_NOW >= SCRIPT_TIME(11, 25))) {
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_LOWER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_LOWER_CLOCKTOWN);
     }
 }
 
@@ -1711,30 +1715,30 @@ void Environment_UpdatePostmanEvents(PlayState* play) {
 
         EVENTINF_SET_7_E0(day, eventInfBits);
 
-        SET_WEEKEVENTREG(WEEKEVENTREG_27_40);
-        SET_WEEKEVENTREG(WEEKEVENTREG_27_80);
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_01);
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_02);
-        SET_WEEKEVENTREG(WEEKEVENTREG_28_04);
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_UPPER_CLOCKTOWN);
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_NORTH_CLOCKTOWN);
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_UPPER_CLOCKTOWN);
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_LOWER_CLOCKTOWN);
+        SET_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_LOWER_CLOCKTOWN);
 
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_UPPER_CLOCKTOWN);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_NORTH_CLOCKTOWN);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_UPPER_CLOCKTOWN);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_LOWER_CLOCKTOWN);
-        func_800F88C4(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_LOWER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_UPPER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_NORTH_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_UPPER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_EAST_LOWER_CLOCKTOWN);
+        Environment_SetLetterToKafeiScheduledIf(WEEKEVENTREG_DEPOSITED_LETTER_TO_KAFEI_SOUTH_LOWER_CLOCKTOWN);
 
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_27_40);
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_27_80);
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_28_01);
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_28_02);
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_28_04);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_UPPER_CLOCKTOWN);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_NORTH_CLOCKTOWN);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_UPPER_CLOCKTOWN);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_EAST_LOWER_CLOCKTOWN);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_CHECKED_SOUTH_LOWER_CLOCKTOWN);
     }
 
     if ((SCRIPT_TIME_NOW < SCRIPT_TIME(9, 0)) || (SCRIPT_TIME_NOW > SCRIPT_TIME(12, 0))) {
-        CLEAR_WEEKEVENTREG(WEEKEVENTREG_90_08);
+        CLEAR_WEEKEVENTREG(WEEKEVENTREG_POSTMAN_RECEIVED_LETTER_TO_KAFEI);
     }
 
-    func_800F8970();
+    Environment_UpdateCheckedPostboxes();
 
     if (!CHECK_WEEKEVENTREG(WEEKEVENTREG_RECEIVED_ROOM_KEY) && !CHECK_WEEKEVENTREG(WEEKEVENTREG_55_02)) {
         if (((void)0, gSaveContext.save.day) >= 2) {
diff --git a/src/code/z_sram_JPN.c b/src/code/z_sram_JPN.c
index c6790a1a5..b8e0f76f7 100644
--- a/src/code/z_sram_JPN.c
+++ b/src/code/z_sram_JPN.c
@@ -144,7 +144,7 @@ u16 sPersistentCycleWeekEventRegs[ARRAY_COUNT(gSaveContext.save.saveInfo.weekEve
     /* 48 */ 0,
     /* 49 */ 0,
     /* 50 */ PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_50_02) | PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_50_04),
-    /* 51 */ PERSISTENT_WEEKEVENTREG_ALT(WEEKEVENTREG_51_04),
+    /* 51 */ PERSISTENT_WEEKEVENTREG_ALT(WEEKEVENTREG_HIT_LAUNDRY_POOL_BELL),
     /* 52 */ 0,
     /* 53 */ PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_RECEIVED_BUSINESS_SCRUB_HEART_PIECE) |
         PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_53_40),
diff --git a/src/code/z_sram_NES.c b/src/code/z_sram_NES.c
index c6790a1a5..b8e0f76f7 100644
--- a/src/code/z_sram_NES.c
+++ b/src/code/z_sram_NES.c
@@ -144,7 +144,7 @@ u16 sPersistentCycleWeekEventRegs[ARRAY_COUNT(gSaveContext.save.saveInfo.weekEve
     /* 48 */ 0,
     /* 49 */ 0,
     /* 50 */ PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_50_02) | PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_50_04),
-    /* 51 */ PERSISTENT_WEEKEVENTREG_ALT(WEEKEVENTREG_51_04),
+    /* 51 */ PERSISTENT_WEEKEVENTREG_ALT(WEEKEVENTREG_HIT_LAUNDRY_POOL_BELL),
     /* 52 */ 0,
     /* 53 */ PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_RECEIVED_BUSINESS_SCRUB_HEART_PIECE) |
         PERSISTENT_WEEKEVENTREG(WEEKEVENTREG_53_40),