Document `EnToto` (#1887)

* Start documenting Toto

* Document EnToto_IsFacingPlayer and Unk2B6/isPlayerCancelingSoundCheck

* Rename EnTotoText to EnTotoSpeakData to align with EnTest3 (Kafei)

* Update gitignore

* Document some HandleTalk and SetupTalk functions similar to EnTest3

* Rename D_80BA502C to sEnTotoSpeakData1

* Document TalkState setup funcs

* Update gitignore, document talk state update functions (from En_Test3)

* Toto talk loop animations

* Update gitignore for functions.txt

* Document ActionFuncs

* Clean up remaining undocumented variables

* Clean up comments

* Run format.py and clean up result, and revert makefile changes

* Add missing newline at end of z_en_toto.h

* Clean up gitignore and other local stuff

* gitignore again

* Gitignore again again

* Gitignore again again again

* Restore old graphovl.py

* Update include/z64save.h

Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>

* Update src/overlays/actors/ovl_En_Toto/z_en_toto.c

Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>

* Rename SetupAction and Action functions; fix block comments; create enum for TalkData

* move enum up so it's declared before it's used lol

* Change shouldCancelSoundCheck and ShouldPlaySoundCheckCompleteCutscene to bool

* Run format.py even though it makes the SpeakData array less readable yay

* Remove accidentally pushed files

* Enum for SpeakDataIndex

* SpeakDataIndex

* Index into SpeakData with enums

* Apply requested changes

* Apply clang-format

* Apply requested changes (rename SetPlayedFlags, add formsPlayed enum, fix a few missing enum replacements)

* Change enum to macros

* Apply more suggested changes

---------

Co-authored-by: AlexisACooper1 <alexis@lingualogica.net>
Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>

4 files changed, 86 insertions, 86 deletions

diff --git a/tools/disasm/n64-jp-1.1/functions.txt b/tools/disasm/n64-jp-1.1/functions.txt
index fa5981595..c4ae42ba4 100644
--- a/tools/disasm/n64-jp-1.1/functions.txt
+++ b/tools/disasm/n64-jp-1.1/functions.txt
@@ -15066,45 +15066,45 @@ func_80BA3230 = 0x80BA6550; // type:func size:0x114
 func_80BA3344 = 0x80BA6664; // type:func size:0xCC
 ObjNozoki_Update = 0x80BA6730; // type:func size:0x24
 ObjNozoki_Draw = 0x80BA6754; // type:func size:0x5C
-func_80BA36C0 = 0x80BA69E0; // type:func size:0x3C
+EnToto_SetMainAction = 0x80BA69E0; // type:func size:0x3C
 EnToto_Init = 0x80BA6A1C; // type:func size:0x114
 EnToto_Destroy = 0x80BA6B30; // type:func size:0x2C
-func_80BA383C = 0x80BA6B5C; // type:func size:0xF4
-func_80BA3930 = 0x80BA6C50; // type:func size:0x4C
-func_80BA397C = 0x80BA6C9C; // type:func size:0x4C
-func_80BA39C8 = 0x80BA6CE8; // type:func size:0x218
-func_80BA3BFC = 0x80BA6F00; // type:func size:0x8C
-func_80BA3C88 = 0x80BA6F8C; // type:func size:0x3C
-func_80BA3CC4 = 0x80BA6FC8; // type:func size:0x74
-func_80BA3D38 = 0x80BA703C; // type:func size:0x84
-func_80BA3DBC = 0x80BA70C0; // type:func size:0x104
-func_80BA3EC0 = 0x80BA71C4; // type:func size:0x14
-func_80BA3ED4 = 0x80BA71D8; // type:func size:0x14
-func_80BA3EE8 = 0x80BA71EC; // type:func size:0x44
-func_80BA3F2C = 0x80BA7230; // type:func size:0x84
-func_80BA3FB0 = 0x80BA72B4; // type:func size:0x1C
-func_80BA3FCC = 0x80BA72D0; // type:func size:0x60
-func_80BA402C = 0x80BA7330; // type:func size:0x50
-func_80BA407C = 0x80BA7380; // type:func size:0x58
-func_80BA40D4 = 0x80BA73D8; // type:func size:0x54
-func_80BA4128 = 0x80BA742C; // type:func size:0x34
-func_80BA415C = 0x80BA7460; // type:func size:0xA8
-func_80BA4204 = 0x80BA7508; // type:func size:0xB8
-func_80BA42BC = 0x80BA75C0; // type:func size:0x138
-func_80BA43F4 = 0x80BA76F8; // type:func size:0x68
-func_80BA445C = 0x80BA7760; // type:func size:0x44
-func_80BA44A0 = 0x80BA77A4; // type:func size:0x34
-func_80BA44D4 = 0x80BA77D8; // type:func size:0x5C
-func_80BA4530 = 0x80BA7834; // type:func size:0x1A8
-func_80BA46D8 = 0x80BA79DC; // type:func size:0x68
-func_80BA4740 = 0x80BA7A44; // type:func size:0xA0
-func_80BA47E0 = 0x80BA7AE4; // type:func size:0x1C4
-func_80BA49A4 = 0x80BA7CA8; // type:func size:0x5C
-func_80BA4A00 = 0x80BA7D04; // type:func size:0x124
-func_80BA4B24 = 0x80BA7E28; // type:func size:0xE8
-func_80BA4C0C = 0x80BA7F10; // type:func size:0x38
-func_80BA4C44 = 0x80BA7F48; // type:func size:0x70
-func_80BA4CB4 = 0x80BA7FB8; // type:func size:0x178
+EnToto_UpdateAnimation = 0x80BA6B5C; // type:func size:0xF4
+EnToto_SetupIdle = 0x80BA6C50; // type:func size:0x4C
+EnToto_IsFacingPlayer = 0x80BA6C9C; // type:func size:0x4C
+EnToto_Idle = 0x80BA6CE8; // type:func size:0x218
+EnToto_SetupTalk = 0x80BA6F00; // type:func size:0x8C
+EnToto_TurnTowardsPlayer = 0x80BA6F8C; // type:func size:0x3C
+EnToto_Talk = 0x80BA6FC8; // type:func size:0x74
+EnToto_SetupSoundCheck = 0x80BA703C; // type:func size:0x84
+EnToto_SoundCheck = 0x80BA70C0; // type:func size:0x104
+EnToto_SetupTalk_ReturnTrue = 0x80BA71C4; // type:func size:0x14
+EnToto_SetupTalk_ReturnFalse = 0x80BA71D8; // type:func size:0x14
+EnToto_HandleTalk_AfterChoice = 0x80BA71EC; // type:func size:0x44
+EnToto_SetupTalk_NextMessage = 0x80BA7230; // type:func size:0x84
+EnToto_SetupTalk_SetNextMessageTimer = 0x80BA72B4; // type:func size:0x1C
+EnToto_HandleTalk_Wait = 0x80BA72D0; // type:func size:0x60
+EnToto_SetupTalk_StartAdditionalCutscene = 0x80BA7330; // type:func size:0x50
+EnToto_HandleTalk_StartCutscene = 0x80BA7380; // type:func size:0x58
+EnToto_HandleTalk_Event = 0x80BA73D8; // type:func size:0x54
+EnToto_HandleTalk_Closing = 0x80BA742C; // type:func size:0x34
+EnToto_HandleTalk_Choice = 0x80BA7460; // type:func size:0xA8
+EnToto_HandleTalk_SoundCheck_WaitAdvanceText = 0x80BA7508; // type:func size:0xB8
+EnToto_SetupTalk_InitSoundCheck = 0x80BA75C0; // type:func size:0x138
+EnToto_HandleTalk_SoundCheck_MovePlayerToStage = 0x80BA76F8; // type:func size:0x68
+EnToto_HandleTalk_SoundCheck_WaitForPromptTextbox = 0x80BA7760; // type:func size:0x44
+EnToto_SetupTalk_StopCutsceneAndResetTimer = 0x80BA77A4; // type:func size:0x34
+EnToto_CheckIfPlayerInSpotlight = 0x80BA77D8; // type:func size:0x5C
+EnToto_HandleTalk_SoundCheck_WaitForPlayerToEnterSpotlight = 0x80BA7834; // type:func size:0x1A8
+EnToto_SetupTalk_InitWindFishOcarinaStaff = 0x80BA79DC; // type:func size:0x68
+EnToto_HandleTalk_SoundCheck_UpdatePlayedFlags = 0x80BA7A44; // type:func size:0xA0
+EnToto_SetupTalk_InitWindFishPlayback = 0x80BA7AE4; // type:func size:0x1C4
+EnToto_SetupTalk_StartWindFishPlayback = 0x80BA7CA8; // type:func size:0x5C
+EnToto_HandleTalk_SoundCheck_EndWindFishCutscene = 0x80BA7D04; // type:func size:0x124
+EnToto_HandleTalk_SetupMayorsResidence = 0x80BA7E28; // type:func size:0xE8
+EnToto_RunTalkStateSetupFunc = 0x80BA7F10; // type:func size:0x38
+EnToto_RunTalkStateHandlerFunc = 0x80BA7F48; // type:func size:0x70
+EnToto_HandleGormanCutscene = 0x80BA7FB8; // type:func size:0x178
 EnToto_Update = 0x80BA8130; // type:func size:0xD0
 EnToto_Draw = 0x80BA8200; // type:func size:0xD0
 EnRailgibud_SpawnOtherGibdosAndSetPositionAndRotation = 0x80BA8700; // type:func size:0x220
diff --git a/tools/disasm/n64-us/functions.txt b/tools/disasm/n64-us/functions.txt
index c1e5622ef..73ce68a59 100644
--- a/tools/disasm/n64-us/functions.txt
+++ b/tools/disasm/n64-us/functions.txt
@@ -15074,45 +15074,45 @@ func_80BA3230 = 0x80BA3230; // type:func
 func_80BA3344 = 0x80BA3344; // type:func
 ObjNozoki_Update = 0x80BA3410; // type:func
 ObjNozoki_Draw = 0x80BA3434; // type:func
-func_80BA36C0 = 0x80BA36C0; // type:func
+EnToto_SetMainAction = 0x80BA36C0; // type:func
 EnToto_Init = 0x80BA36FC; // type:func
 EnToto_Destroy = 0x80BA3810; // type:func
-func_80BA383C = 0x80BA383C; // type:func
-func_80BA3930 = 0x80BA3930; // type:func
-func_80BA397C = 0x80BA397C; // type:func
-func_80BA39C8 = 0x80BA39C8; // type:func
-func_80BA3BFC = 0x80BA3BFC; // type:func
-func_80BA3C88 = 0x80BA3C88; // type:func
-func_80BA3CC4 = 0x80BA3CC4; // type:func
-func_80BA3D38 = 0x80BA3D38; // type:func
-func_80BA3DBC = 0x80BA3DBC; // type:func
-func_80BA3EC0 = 0x80BA3EC0; // type:func
-func_80BA3ED4 = 0x80BA3ED4; // type:func
-func_80BA3EE8 = 0x80BA3EE8; // type:func
-func_80BA3F2C = 0x80BA3F2C; // type:func
-func_80BA3FB0 = 0x80BA3FB0; // type:func
-func_80BA3FCC = 0x80BA3FCC; // type:func
-func_80BA402C = 0x80BA402C; // type:func
-func_80BA407C = 0x80BA407C; // type:func
-func_80BA40D4 = 0x80BA40D4; // type:func
-func_80BA4128 = 0x80BA4128; // type:func
-func_80BA415C = 0x80BA415C; // type:func
-func_80BA4204 = 0x80BA4204; // type:func
-func_80BA42BC = 0x80BA42BC; // type:func
-func_80BA43F4 = 0x80BA43F4; // type:func
-func_80BA445C = 0x80BA445C; // type:func
-func_80BA44A0 = 0x80BA44A0; // type:func
-func_80BA44D4 = 0x80BA44D4; // type:func
-func_80BA4530 = 0x80BA4530; // type:func
-func_80BA46D8 = 0x80BA46D8; // type:func
-func_80BA4740 = 0x80BA4740; // type:func
-func_80BA47E0 = 0x80BA47E0; // type:func
-func_80BA49A4 = 0x80BA49A4; // type:func
-func_80BA4A00 = 0x80BA4A00; // type:func
-func_80BA4B24 = 0x80BA4B24; // type:func
-func_80BA4C0C = 0x80BA4C0C; // type:func
-func_80BA4C44 = 0x80BA4C44; // type:func
-func_80BA4CB4 = 0x80BA4CB4; // type:func
+EnToto_UpdateAnimation = 0x80BA383C; // type:func
+EnToto_SetupIdle = 0x80BA3930; // type:func
+EnToto_IsFacingPlayer = 0x80BA397C; // type:func
+EnToto_Idle = 0x80BA39C8; // type:func
+EnToto_SetupTalk = 0x80BA3BFC; // type:func
+EnToto_TurnTowardsPlayer = 0x80BA3C88; // type:func
+EnToto_Talk = 0x80BA3CC4; // type:func
+EnToto_SetupSoundCheck = 0x80BA3D38; // type:func
+EnToto_SoundCheck = 0x80BA3DBC; // type:func
+EnToto_SetupTalk_ReturnTrue = 0x80BA3EC0; // type:func
+EnToto_SetupTalk_ReturnFalse = 0x80BA3ED4; // type:func
+EnToto_HandleTalk_AfterChoice = 0x80BA3EE8; // type:func
+EnToto_SetupTalk_NextMessage = 0x80BA3F2C; // type:func
+EnToto_SetupTalk_SetNextMessageTimer = 0x80BA3FB0; // type:func
+EnToto_HandleTalk_Wait = 0x80BA3FCC; // type:func
+EnToto_SetupTalk_StartAdditionalCutscene = 0x80BA402C; // type:func
+EnToto_HandleTalk_StartCutscene = 0x80BA407C; // type:func
+EnToto_HandleTalk_Event = 0x80BA40D4; // type:func
+EnToto_HandleTalk_Closing = 0x80BA4128; // type:func
+EnToto_HandleTalk_Choice = 0x80BA415C; // type:func
+EnToto_HandleTalk_SoundCheck_WaitAdvanceText = 0x80BA4204; // type:func
+EnToto_SetupTalk_InitSoundCheck = 0x80BA42BC; // type:func
+EnToto_HandleTalk_SoundCheck_MovePlayerToStage = 0x80BA43F4; // type:func
+EnToto_HandleTalk_SoundCheck_WaitForPromptTextbox = 0x80BA445C; // type:func
+EnToto_SetupTalk_StopCutsceneAndResetTimer = 0x80BA44A0; // type:func
+EnToto_CheckIfPlayerInSpotlight = 0x80BA44D4; // type:func
+EnToto_HandleTalk_SoundCheck_WaitForPlayerToEnterSpotlight = 0x80BA4530; // type:func
+EnToto_SetupTalk_InitWindFishOcarinaStaff = 0x80BA46D8; // type:func
+EnToto_HandleTalk_SoundCheck_UpdatePlayedFlags = 0x80BA4740; // type:func
+EnToto_SetupTalk_InitWindFishPlayback = 0x80BA47E0; // type:func
+EnToto_SetupTalk_StartWindFishPlayback = 0x80BA49A4; // type:func
+EnToto_HandleTalk_SoundCheck_EndWindFishCutscene = 0x80BA4A00; // type:func
+EnToto_HandleTalk_SetupMayorsResidence = 0x80BA4B24; // type:func
+EnToto_RunTalkStateSetupFunc = 0x80BA4C0C; // type:func
+EnToto_RunTalkStateHandlerFunc = 0x80BA4C44; // type:func
+EnToto_HandleGormanCutscene = 0x80BA4CB4; // type:func
 EnToto_Update = 0x80BA4E2C; // type:func
 EnToto_Draw = 0x80BA4EFC; // type:func
 EnRailgibud_SpawnOtherGibdosAndSetPositionAndRotation = 0x80BA5400; // type:func
diff --git a/tools/overlayhelpers/mscriptdis.py b/tools/overlayhelpers/mscriptdis.py
index 755fd7f60..1ad9f3736 100644
--- a/tools/overlayhelpers/mscriptdis.py
+++ b/tools/overlayhelpers/mscriptdis.py
@@ -461,7 +461,7 @@ week_event_reg = {
     (49 << 8) | 0x20: "WEEKEVENTREG_49_20",
     (49 << 8) | 0x40: "WEEKEVENTREG_49_40",
     (49 << 8) | 0x80: "WEEKEVENTREG_49_80",
-    (50 << 8) | 0x01: "WEEKEVENTREG_50_01",
+    (50 << 8) | 0x01: "WEEKEVENTREG_HELPED_GORMAN_DAY_1",
     (50 << 8) | 0x02: "WEEKEVENTREG_50_02",
     (50 << 8) | 0x04: "WEEKEVENTREG_50_04",
     (50 << 8) | 0x08: "WEEKEVENTREG_PROMISED_MIDNIGHT_MEETING",
@@ -476,7 +476,7 @@ week_event_reg = {
     (51 << 8) | 0x10: "WEEKEVENTREG_51_10",
     (51 << 8) | 0x20: "WEEKEVENTREG_ESCAPED_SAKONS_HIDEOUT",
     (51 << 8) | 0x40: "WEEKEVENTREG_COUPLES_MASK_CUTSCENE_FINISHED",
-    (51 << 8) | 0x80: "WEEKEVENTREG_51_80",
+    (51 << 8) | 0x80: "WEEKEVENTREG_HELPED_GORMAN_DAY_2",
     (52 << 8) | 0x01: "WEEKEVENTREG_ESCORTED_CREMIA",
     (52 << 8) | 0x02: "WEEKEVENTREG_52_02",
     (52 << 8) | 0x04: "WEEKEVENTREG_52_04",
@@ -513,10 +513,10 @@ week_event_reg = {
     (56 << 8) | 0x02: "WEEKEVENTREG_RECEIVED_MARINE_RESEARCH_LAB_FISH_HEART_PIECE",
     (56 << 8) | 0x04: "WEEKEVENTREG_56_04",
     (56 << 8) | 0x08: "WEEKEVENTREG_56_08",
-    (56 << 8) | 0x10: "WEEKEVENTREG_56_10",
-    (56 << 8) | 0x20: "WEEKEVENTREG_56_20",
-    (56 << 8) | 0x40: "WEEKEVENTREG_56_40",
-    (56 << 8) | 0x80: "WEEKEVENTREG_56_80",
+    (56 << 8) | 0x10: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_HUMAN",
+    (56 << 8) | 0x20: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_DEKU",
+    (56 << 8) | 0x40: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_ZORA",
+    (56 << 8) | 0x80: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_GORON",
     (57 << 8) | 0x01: "WEEKEVENTREG_57_01",
     (57 << 8) | 0x02: "WEEKEVENTREG_57_02",
     (57 << 8) | 0x04: "WEEKEVENTREG_57_04",
diff --git a/tools/weekeventregconvert.py b/tools/weekeventregconvert.py
index 756c2c5a2..50c87a9d9 100755
--- a/tools/weekeventregconvert.py
+++ b/tools/weekeventregconvert.py
@@ -404,7 +404,7 @@ weekEventReg = {
     (49 << 8) | 0x20: "WEEKEVENTREG_49_20",
     (49 << 8) | 0x40: "WEEKEVENTREG_49_40",
     (49 << 8) | 0x80: "WEEKEVENTREG_49_80",
-    (50 << 8) | 0x01: "WEEKEVENTREG_50_01",
+    (50 << 8) | 0x01: "WEEKEVENTREG_HELPED_GORMAN_DAY_1",
     (50 << 8) | 0x02: "WEEKEVENTREG_50_02",
     (50 << 8) | 0x04: "WEEKEVENTREG_50_04",
     (50 << 8) | 0x08: "WEEKEVENTREG_PROMISED_MIDNIGHT_MEETING",
@@ -419,7 +419,7 @@ weekEventReg = {
     (51 << 8) | 0x10: "WEEKEVENTREG_51_10",
     (51 << 8) | 0x20: "WEEKEVENTREG_ESCAPED_SAKONS_HIDEOUT",
     (51 << 8) | 0x40: "WEEKEVENTREG_COUPLES_MASK_CUTSCENE_FINISHED",
-    (51 << 8) | 0x80: "WEEKEVENTREG_51_80",
+    (51 << 8) | 0x80: "WEEKEVENTREG_HELPED_GORMAN_DAY_2",
     (52 << 8) | 0x01: "WEEKEVENTREG_ESCORTED_CREMIA",
     (52 << 8) | 0x02: "WEEKEVENTREG_52_02",
     (52 << 8) | 0x04: "WEEKEVENTREG_52_04",
@@ -456,10 +456,10 @@ weekEventReg = {
     (56 << 8) | 0x02: "WEEKEVENTREG_RECEIVED_MARINE_RESEARCH_LAB_FISH_HEART_PIECE",
     (56 << 8) | 0x04: "WEEKEVENTREG_56_04",
     (56 << 8) | 0x08: "WEEKEVENTREG_56_08",
-    (56 << 8) | 0x10: "WEEKEVENTREG_56_10",
-    (56 << 8) | 0x20: "WEEKEVENTREG_56_20",
-    (56 << 8) | 0x40: "WEEKEVENTREG_56_40",
-    (56 << 8) | 0x80: "WEEKEVENTREG_56_80",
+    (56 << 8) | 0x10: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_HUMAN",
+    (56 << 8) | 0x20: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_DEKU",
+    (56 << 8) | 0x40: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_ZORA",
+    (56 << 8) | 0x80: "WEEKEVENTREG_PLAYED_WIND_FISH_AS_GORON",
     (57 << 8) | 0x01: "WEEKEVENTREG_57_01",
     (57 << 8) | 0x02: "WEEKEVENTREG_57_02",
     (57 << 8) | 0x04: "WEEKEVENTREG_57_04",