Document elf_message scripting system (#1398)

* `cUpElfMsgs` -> `cUpMsgs`

Motivation:
ElfMessage is the name of the system that handles c-up messages from navi, but also messages from child/adult saria
so it would make sense to name this after the system name like "ElfMsg"
but "cUpElf" primarily reads like (to me) "c up navi" since the actor implementing navi is EnElf

I think it'd be better to clear that confusion between "navi" and "elfmsg system" by just not using "elf" in the name

* Standardize c-up navi messages ElfMessage data to be named after "CUp"

* -> "Navi"

* Make symbols in `elf_message_` segments static

* new docs

* change commands, format

* introduce navi file id

* use enum

* remove concat

* add clarifying comment for skip

* concat cmd type

* Hints -> QuestHint

* rename command header

* s -> g

* missed enum name

* singular

* missed one

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

2 files changed, 33 insertions, 33 deletions

diff --git a/src/elf_message/elf_message_field.c b/src/elf_message/elf_message_field.c
index cd48f53ff..406a975c9 100644
--- a/src/elf_message/elf_message_field.c
+++ b/src/elf_message/elf_message_field.c
@@ -1,33 +1,33 @@
 #include "global.h"
-#include "z64elf_message.h"
+#include "z64quest_hint_commands.h"
 
-ElfMessage gOverworldNaviMsgs[] = {
-    ELF_MSG_FLAG(CHECK, 0x40, false, EVENTCHKINF_05),
-    ELF_MSG_FLAG(CHECK, 0x41, false, EVENTCHKINF_09),
-    ELF_MSG_FLAG(CHECK, 0x42, false, EVENTCHKINF_12),
-    ELF_MSG_FLAG(CHECK, 0x43, false, EVENTCHKINF_TALON_RETURNED_FROM_CASTLE),
-    ELF_MSG_FLAG(CHECK, 0x44, false, EVENTCHKINF_40),
-    ELF_MSG_SONG(CHECK, 0x45, false, ITEM_SONG_SARIA),
-    ELF_MSG_STRENGTH_UPG(CHECK, 0x46, true, 0),
-    ELF_MSG_FLAG(CHECK, 0x47, false, EVENTCHKINF_25),
-    ELF_MSG_MAGIC(CHECK, 0x48, false),
-    ELF_MSG_FLAG(CHECK, 0x49, false, EVENTCHKINF_33),
-    ELF_MSG_FLAG(CHECK, 0x4A, false, EVENTCHKINF_37),
-    ELF_MSG_FLAG(CHECK, 0x4B, false, EVENTCHKINF_80),
-    ELF_MSG_FLAG(CHECK, 0x4C, false, EVENTCHKINF_43),
-    ELF_MSG_FLAG(CHECK, 0x4D, false, EVENTCHKINF_45),
-    ELF_MSG_ITEM(CHECK, 0x4E, true, ITEM_HOOKSHOT, ITEM_NONE),
-    ELF_MSG_MEDALLION(CHECK, 0x50, false, ITEM_MEDALLION_FOREST),
-    ELF_MSG_MEDALLION(CHECK, 0x51, false, ITEM_MEDALLION_FIRE),
-    ELF_MSG_BOOTS(CHECK, 0x52, false, ITEM_BOOTS_IRON),
-    ELF_MSG_MEDALLION(CHECK, 0x53, false, ITEM_MEDALLION_WATER),
-    ELF_MSG_FLAG(CHECK, 0x54, false, EVENTCHKINF_AA),
-    ELF_MSG_ITEM(CHECK, 0x55, true, ITEM_LENS, ITEM_NONE),
-    ELF_MSG_MEDALLION(CHECK, 0x57, false, ITEM_MEDALLION_SHADOW),
-    ELF_MSG_SONG(CHECK, 0x58, false, ITEM_SONG_REQUIEM),
-    ELF_MSG_STRENGTH_UPG(CHECK, 0x56, true, 1),
-    ELF_MSG_MEDALLION(CHECK, 0x5A, false, ITEM_MEDALLION_SPIRIT),
-    ELF_MSG_ITEM(CHECK, 0x5B, true, ITEM_ARROW_LIGHT, ITEM_NONE),
-    ELF_MSG_FLAG(CHECK, 0x5C, false, EVENTCHKINF_C3),
-    ELF_MSG_END(0x5F),
+QuestHintCmd gOverworldNaviQuestHints[] = {
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_05, false, 0x40),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_09, false, 0x41),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_12, false, 0x42),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_TALON_RETURNED_FROM_CASTLE, false, 0x43),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_40, false, 0x44),
+    QUEST_HINT_SONG(CHECK, ITEM_SONG_SARIA, false, 0x45),
+    QUEST_HINT_STRENGTH_UPG(CHECK, 0, true, 0x46),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_25, false, 0x47),
+    QUEST_HINT_MAGIC(CHECK, false, 0x48),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_33, false, 0x49),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_37, false, 0x4A),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_80, false, 0x4B),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_43, false, 0x4C),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_45, false, 0x4D),
+    QUEST_HINT_ITEM(CHECK, ITEM_HOOKSHOT, ITEM_NONE, true, 0x4E),
+    QUEST_HINT_MEDALLION(CHECK, ITEM_MEDALLION_FOREST, false, 0x50),
+    QUEST_HINT_MEDALLION(CHECK, ITEM_MEDALLION_FIRE, false, 0x51),
+    QUEST_HINT_BOOTS(CHECK, ITEM_BOOTS_IRON, false, 0x52),
+    QUEST_HINT_MEDALLION(CHECK, ITEM_MEDALLION_WATER, false, 0x53),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_AA, false, 0x54),
+    QUEST_HINT_ITEM(CHECK, ITEM_LENS, ITEM_NONE, true, 0x55),
+    QUEST_HINT_MEDALLION(CHECK, ITEM_MEDALLION_SHADOW, false, 0x57),
+    QUEST_HINT_SONG(CHECK, ITEM_SONG_REQUIEM, false, 0x58),
+    QUEST_HINT_STRENGTH_UPG(CHECK, 1, true, 0x56),
+    QUEST_HINT_MEDALLION(CHECK, ITEM_MEDALLION_SPIRIT, false, 0x5A),
+    QUEST_HINT_ITEM(CHECK, ITEM_ARROW_LIGHT, ITEM_NONE, true, 0x5B),
+    QUEST_HINT_FLAG(CHECK, EVENTCHKINF_C3, false, 0x5C),
+    QUEST_HINT_END(0x5F),
 };
diff --git a/src/elf_message/elf_message_ydan.c b/src/elf_message/elf_message_ydan.c
index 54050e372..21b5fe89f 100644
--- a/src/elf_message/elf_message_ydan.c
+++ b/src/elf_message/elf_message_ydan.c
@@ -1,6 +1,6 @@
 #include "global.h"
-#include "z64elf_message.h"
+#include "z64quest_hint_commands.h"
 
-ElfMessage gDungeonNaviMsgs[] = {
-    ELF_MSG_END(0x5F),
+QuestHintCmd gDungeonNaviQuestHints[] = {
+    QUEST_HINT_END(0x5F),
 };