Decomp `Message_GetState`, add `TextState` enum and some header reorganization (#919)

* Message_GetState

* Rename msgCtx->msgLength

* Replace some enums

* TEXT_STATE_CLOSING

* use enum on switches

* use enum when assigning to a variable

* some minor cleanups

* minor cleanup

* TEXT_STATE_CHOICE

* remove unused temp

* z64message.h and z64view.h

* steal some stuff from OoT

* add some stuff to namefixer

* fix shift

* minor doc comment

* Update MessageContext struct from andzura's branch

Co-authored-by: Andzura <11079691+Andzura@users.noreply.github.com>

* some other TextState uses I missed

* format

* statetimer in dec

* review

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* review

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* review

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

* format

* Batch () commit

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

* review

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

* format

* bss

* use text state defines on new actors

* fix matching

* bss

Co-authored-by: Andzura <11079691+Andzura@users.noreply.github.com>
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

3 files changed, 85 insertions, 18 deletions

diff --git a/src/code/z_actor.c b/src/code/z_actor.c
index f97d8ea1d..ff3bb411f 100644
--- a/src/code/z_actor.c
+++ b/src/code/z_actor.c
@@ -1886,7 +1886,7 @@ s32 func_800B863C(Actor* actor, PlayState* play) {
 }
 
 s32 Actor_TextboxIsClosing(Actor* actor, PlayState* play) {
-    if (Message_GetState(&play->msgCtx) == 2) {
+    if (Message_GetState(&play->msgCtx) == TEXT_STATE_CLOSING) {
         actor->flags &= ~ACTOR_FLAG_100;
         return true;
     }
diff --git a/src/code/z_demo.c b/src/code/z_demo.c
index 1c003abfb..1827acc85 100644
--- a/src/code/z_demo.c
+++ b/src/code/z_demo.c
@@ -998,7 +998,7 @@ s32 Cutscene_CountNormalMasks(void) {
 // Command 0xA: Textbox
 void Cutscene_Command_Textbox(PlayState* play, CutsceneContext* csCtx, CsCmdTextbox* cmd) {
     static s32 D_801BB160 = CS_TEXTBOX_TYPE_DEFAULT;
-    u8 dialogState;
+    u8 talkState;
     s32 pad;
     u16 originalCsFrames;
     s32 pad2;
@@ -1048,10 +1048,11 @@ void Cutscene_Command_Textbox(PlayState* play, CutsceneContext* csCtx, CsCmdText
             // a textbox that is expected to be closed by the user is still open.
 
             originalCsFrames = csCtx->frames;
-            dialogState = Message_GetState(&play->msgCtx);
-            if ((dialogState != 2) && (dialogState != 0) && (dialogState != 7) && (dialogState != 8)) {
+            talkState = Message_GetState(&play->msgCtx);
+            if ((talkState != TEXT_STATE_CLOSING) && (talkState != TEXT_STATE_NONE) && (talkState != TEXT_STATE_7) &&
+                (talkState != TEXT_STATE_8)) {
                 csCtx->frames--;
-                if ((dialogState == 4) && Message_ShouldAdvance(play)) {
+                if ((talkState == TEXT_STATE_CHOICE) && Message_ShouldAdvance(play)) {
                     if (play->msgCtx.choiceIndex == 0) {
                         if (cmd->base == 0x33BD) {
                             func_8019F230();
@@ -1089,12 +1090,12 @@ void Cutscene_Command_Textbox(PlayState* play, CutsceneContext* csCtx, CsCmdText
                     }
                 }
 
-                if (dialogState == 5 && Message_ShouldAdvance(play)) {
+                if ((talkState == TEXT_STATE_5) && Message_ShouldAdvance(play)) {
                     func_80152434(play, cmd->base);
                 }
             }
 
-            if ((dialogState == 2) && (D_801BB160 == CS_TEXTBOX_TYPE_3)) {
+            if ((talkState == TEXT_STATE_CLOSING) && (D_801BB160 == CS_TEXTBOX_TYPE_3)) {
                 csCtx->frames--;
                 D_801BB124++;
             }
diff --git a/src/code/z_message.c b/src/code/z_message.c
index 8081f9c87..1e76578bb 100644
--- a/src/code/z_message.c
+++ b/src/code/z_message.c
@@ -99,8 +99,8 @@ s32 Message_ShouldAdvanceSilent(PlayState* play) {
 void func_801477B4(PlayState* play) {
     MessageContext* msgCtx = &play->msgCtx;
 
-    if (play->msgCtx.unk11F10 != 0) {
-        msgCtx->unk12023 = 2;
+    if (play->msgCtx.msgLength != 0) {
+        msgCtx->stateTimer = 2;
         msgCtx->msgMode = 0x43;
         msgCtx->unk12020 = 0;
         play_sound(NA_SE_PL_WALK_GROUND - SFX_FLAG);
@@ -325,7 +325,7 @@ void Message_StartTextbox(PlayState* play, u16 textId, Actor* Actor) {
     func_80150D08(play, textId);
     msgCtx->unkActor = Actor;
     msgCtx->msgMode = 1;
-    msgCtx->unk12023 = 0;
+    msgCtx->stateTimer = 0;
     msgCtx->unk12024 = 0;
     play->msgCtx.ocarinaMode = 0;
 }
@@ -334,11 +334,11 @@ void func_80151938(PlayState* play, u16 textId) {
     MessageContext* msgCtx = &play->msgCtx;
     InterfaceContext* interfaceCtx = &play->interfaceCtx;
 
-    msgCtx->unk11F10 = 0;
+    msgCtx->msgLength = 0;
     func_80150D08(play, textId);
     func_80150A84(play);
     msgCtx->msgMode = 5;
-    msgCtx->unk12023 = 8;
+    msgCtx->stateTimer = 8;
     msgCtx->unk12024 = 0;
 
     if (interfaceCtx->unk_222 == 0) {
@@ -354,24 +354,24 @@ void func_80151938(PlayState* play, u16 textId) {
         msgCtx->unk12004 = 0x22;
         msgCtx->unk12006 = 0x15E;
         func_80149C18(play);
-        msgCtx->unk12023 = 1;
+        msgCtx->stateTimer = 1;
     }
 }
 
 void func_80151A68(PlayState* play, u16 textId) {
     MessageContext* msgCtx = &play->msgCtx;
 
-    msgCtx->unk11F10 = 0;
+    msgCtx->msgLength = 0;
     func_80150D08(play, textId);
     func_80150A84(play);
     func_8015B198(play);
     msgCtx->msgMode = 0x45;
     msgCtx->unk12024 = 0;
     msgCtx->unk1203C = msgCtx->unk1203A = msgCtx->unk1201E = 0;
-    msgCtx->unk12023 = 0x1E;
+    msgCtx->stateTimer = 30;
 
     // Day/Dawn/Night.. Messages
-    if ((msgCtx->currentTextId >= 0x1BB2) && (msgCtx->currentTextId < 0x1BB7)) {
+    if ((msgCtx->currentTextId >= 0x1BB2) && (msgCtx->currentTextId <= 0x1BB6)) {
         XREG(74) = 0x6A;
         XREG(75) = 0;
         XREG(77) = 0x58;
@@ -439,7 +439,73 @@ void func_80152464(PlayState* play, u16 arg1) {
     func_80151DA4(play, arg1);
 }
 
-#pragma GLOBAL_ASM("asm/non_matchings/code/z_message/Message_GetState.s")
+/**
+ * @return u8 A value of the TextState enum representing the current state of the on-screen message
+ */
+u8 Message_GetState(MessageContext* msgCtx) {
+    if (msgCtx->msgLength == 0) {
+        return TEXT_STATE_NONE;
+    }
+
+    if (msgCtx->msgMode == 0x42) {
+        if (msgCtx->unk11F14 != 0xFFFF) {
+            return TEXT_STATE_1;
+        }
+
+        if ((msgCtx->unk12020 == 0x10) || (msgCtx->unk12020 == 0x11)) {
+            return TEXT_STATE_CHOICE;
+        }
+        if ((msgCtx->unk12020 == 0x40) || (msgCtx->unk12020 == 0x42) || (msgCtx->unk12020 == 0x30)) {
+            return TEXT_STATE_5;
+        }
+        if (msgCtx->unk12020 == 0x41) {
+            return TEXT_STATE_16;
+        }
+        if ((msgCtx->unk12020 >= 0x50) && (msgCtx->unk12020 < 0x58)) {
+            return TEXT_STATE_3;
+        }
+        if ((msgCtx->unk12020 == 0x60) || (msgCtx->unk12020 == 0x61)) {
+            return TEXT_STATE_14;
+        }
+        if (msgCtx->unk12020 == 0x62) {
+            return TEXT_STATE_15;
+        }
+        if (msgCtx->unk12020 == 0x63) {
+            return TEXT_STATE_17;
+        }
+        if (msgCtx->unk12020 == 0x12) {
+            return TEXT_STATE_18;
+        }
+        return TEXT_STATE_DONE;
+    }
+
+    if (msgCtx->msgMode == 0x41) {
+        return TEXT_STATE_10;
+    }
+    if (msgCtx->msgMode == 0x1B) {
+        return TEXT_STATE_7;
+    }
+    if ((msgCtx->ocarinaMode == 3) || (msgCtx->msgMode == 0x37)) {
+        return TEXT_STATE_8;
+    }
+    if (msgCtx->msgMode == 0x20) {
+        return TEXT_STATE_9;
+    }
+    if ((msgCtx->msgMode == 0x21) || (msgCtx->msgMode == 0x3A)) {
+        return TEXT_STATE_11;
+    }
+    if (msgCtx->msgMode == 0x3D) {
+        return TEXT_STATE_12;
+    }
+    if (msgCtx->msgMode == 0x40) {
+        return TEXT_STATE_13;
+    }
+    if ((msgCtx->msgMode == 0x43) && (msgCtx->stateTimer == 1) && (msgCtx->unk120B1 == 0)) {
+        return TEXT_STATE_CLOSING;
+    }
+
+    return TEXT_STATE_3;
+}
 
 #pragma GLOBAL_ASM("asm/non_matchings/code/z_message/func_8015268C.s")
 
@@ -523,7 +589,7 @@ void Message_Init(PlayState* play) {
     func_801586A4(play);
     play->msgCtx.ocarinaMode = 0;
     messageCtx->msgMode = 0;
-    messageCtx->unk11F10 = 0;
+    messageCtx->msgLength = 0;
     messageCtx->currentTextId = 0;
     messageCtx->unk12020 = 0;
     messageCtx->choiceIndex = 0;