ChkBit comments and enum work (#2571)

* Jagar cleanup

* saru work

* e_fm work

* gob enum added

* gob cleanup

* gob anm enums

* dComIfGs_isEventBit comments added

* More bit work and besu enum work

* Maybe fixed the issue?

1 files changed, 30 insertions, 5 deletions

diff --git a/src/d/d_menu_fmap.cpp b/src/d/d_menu_fmap.cpp
index c0cefe1887..72d80bcdef 100644
--- a/src/d/d_menu_fmap.cpp
+++ b/src/d/d_menu_fmap.cpp
@@ -720,7 +720,9 @@ void dMenu_Fmap_c::all_map_proc() {
             mErrorSound = false;
         }
     } else if (dMw_Z_TRIGGER() && mpDraw2DTop->isWarpAccept()) {
+            /* dSv_event_flag_c::F_0265 - Arbiter's Grounds - Arbiter's Grounds clear */
         if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x109])
+                /* dSv_event_flag_c::F_0361 - Arbiter's Grounds - Spun the spinning pillars */
             && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x169]))
         {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
@@ -741,12 +743,15 @@ void dMenu_Fmap_c::all_map_proc() {
             }
         } else {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
+                /* dSv_event_flag_c::M_071 - Cutscene - [cutscene: 20] Zant appears (during Midna's desperate hour) */
             if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x68])
-                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xfa]))
+                    /* dSv_event_flag_c::F_0250 - Cutscene - [cutscene: 21] reunion with Zelda / Midna revived (Hyrule Castle barrier appears) */
+                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xFA]))
             {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x85d, 0, 0, 0xff, true);
             } else if (!mpDraw2DTop->checkWarpAcceptCannon()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7de, 0, 0, 0xff, true);
+                /* dSv_event_flag_c::F_0787 - Kakariko Village - Stopped by Midna when trying to warp the sky cannon */
                 dComIfGs_onEventBit(dSv_event_flag_c::saveBitLabels[0x313]);
             } else if (!mpDraw2DTop->checkWarpAcceptRegion4()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7dd, 0, 0, 0xff, true);
@@ -885,7 +890,9 @@ void dMenu_Fmap_c::region_map_proc() {
             mErrorSound = true;
         }
     } else if (dMw_Z_TRIGGER() && mpDraw2DTop->isWarpAccept()) {
+            /* dSv_event_flag_c::F_0265 - Arbiter's Grounds - Arbiter's Grounds clear */
         if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x109])
+                /* dSv_event_flag_c::F_0361 - Arbiter's Grounds - Spun the spinning pillars */
             && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x169]))
         {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
@@ -901,12 +908,15 @@ void dMenu_Fmap_c::region_map_proc() {
             Z2GetAudioMgr()->seStart(Z2SE_WARP_MAP_ON, NULL, 0, 0, 1.0f, 1.0f, -1.0f, -1.0f, 0);
         } else {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
+                /* dSv_event_flag_c::M_071 - Cutscene - [cutscene: 20] Zant appears (during Midna's desperate hour) */
             if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x68])
-                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xfa]))
+                    /* dSv_event_flag_c::F_0250 - Cutscene - [cutscene: 21] reunion with Zelda / Midna revived (Hyrule Castle barrier appears) */
+                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xFA]))
             {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x85d, 0, 0, 0xff, true);
             } else if (!mpDraw2DTop->checkWarpAcceptCannon()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7de, 0, 0, 0xff, true);
+                /* dSv_event_flag_c::F_0787 - Kakariko Village - Stopped by Midna when trying to warp the sky cannon */
                 dComIfGs_onEventBit(dSv_event_flag_c::saveBitLabels[0x313]);
             } else if (!mpDraw2DTop->checkWarpAcceptRegion4()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7dd, 0, 0, 0xff, true);
@@ -1005,19 +1015,25 @@ void dMenu_Fmap_c::portal_warp_map_proc() {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
             dMsgObject_setPortalMessageID(portals[mPortalNo].mMessageID);
 
+                /* dSv_event_flag_c::M_071 - Cutscene - [cutscene: 20] Zant appears (during Midna's desperate hour) */
             if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x68])
-                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xfa]))
+                    /* dSv_event_flag_c::F_0250 - Cutscene - [cutscene: 21] reunion with Zelda / Midna revived (Hyrule Castle barrier appears) */
+                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xFA]))
             {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x85d, 0, 0, 0xff, true);
+                       /* dSv_event_flag_c::F_0786 - Kakariko Village - Forced conversation with Shad when he sees the sky cannon */
             } else if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x312])
+                    /* dSv_event_flag_c::F_0785 - Kakariko Village - Shad leaves after attempting to warp sky cannon */
                 && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x311]))
             {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7de, 0, 0, 0xff, true);
+                /* dSv_event_flag_c::F_0787 - Kakariko Village - Stopped by Midna when trying to warp the sky cannon */
                 dComIfGs_onEventBit(dSv_event_flag_c::saveBitLabels[0x313]);
             } else if (mPortalNo == 6) {
                 if ((!strcmp(dComIfGp_getStartStageName(), "F_SP124")
                                 && ((daMidna_c*)daPy_py_c::getMidnaActor())->checkPortalObjRide())
-                    || dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x7d]))
+                       /* dSv_event_flag_c::M_092 - Hyrule Field - Warped Eldin Bridge */
+                    || dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x7D]))
                 {
                     mpDraw2DTop->getScrnExplainPtr()->openExplain(0x51e, 2, 0, 0xff, true);
                 } else {
@@ -1027,6 +1043,7 @@ void dMenu_Fmap_c::portal_warp_map_proc() {
                 if ((dMeter2Info_getMapStatus() == 3
                                 && dStage_stagInfo_GetSaveTbl(dComIfGp_getStageStagInfo()) == 2
                                 && dComIfGs_isOneZoneSwitch(0xf, -1))
+                       /* dSv_event_flag_c::M_018 - Main Event - Brought Kakariko bridge back to original location */
                     || dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x33]))
                 {
                     mpDraw2DTop->getScrnExplainPtr()->openExplain(0x51e, 2, 0, 0xff, true);
@@ -1229,12 +1246,15 @@ void dMenu_Fmap_c::spot_map_proc() {
         } else {
             mpDraw2DTop->createExplain(mpTalkHeap, mpStick);
 
+                /* dSv_event_flag_c::M_071 - Cutscene - [cutscene: 20] Zant appears (during Midna's desperate hour) */
             if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x68])
-                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xfa]))
+                    /* dSv_event_flag_c::F_0250 - Cutscene - [cutscene: 21] reunion with Zelda / Midna revived (Hyrule Castle barrier appears) */
+                && !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0xFA]))
             {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x85d, 0, 0, 0xff, true);
             } else if (!mpDraw2DTop->checkWarpAcceptCannon()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7de, 0, 0, 0xff, true);
+                /* dSv_event_flag_c::F_0787 - Kakariko Village - Stopped by Midna when trying to warp the sky cannon */
                 dComIfGs_onEventBit(dSv_event_flag_c::saveBitLabels[0x313]);
             } else if (!mpDraw2DTop->checkWarpAcceptRegion4()) {
                 mpDraw2DTop->getScrnExplainPtr()->openExplain(0x7dd, 0, 0, 0xff, true);
@@ -1503,6 +1523,7 @@ void dMenu_Fmap_c::yamiboss_demo2_init() {
 void dMenu_Fmap_c::yamiboss_demo2_move() {
     if (dMsgObject_getMsgObjectClass()->getStatus() == 0xe) {
         mZoomLevel++;
+            /* dSv_event_flag_c::M_086 - Twilight Hyrule Field - Show Boss Bug's Tear of Light on the map */
         if (dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x77])) {
             if (mZoomLevel > 90) {
                 setProcess(PROC_YAMIBOSS_DEMO3);
@@ -1510,6 +1531,7 @@ void dMenu_Fmap_c::yamiboss_demo2_move() {
         } else {
             if (mZoomLevel > 30) {
                 field_0x30b = true;
+                /* dSv_event_flag_c::M_086 - Twilight Hyrule Field - Show Boss Bug's Tear of Light on the map */
                 dComIfGs_onEventBit(dSv_event_flag_c::saveBitLabels[0x77]);
             }
         }
@@ -2918,10 +2940,13 @@ void dMenu_Fmap_c::tableArrowPosInit(bool param_0) {
     int swbit;
     switch (dMeter2Info_getTableMapRegionNo()) {
     case dMeter_fmapHIO_c::REGION_LANAYRU:
+             /* dSv_event_flag_c::F_0361 - Arbiter's Grounds - Spun the spinning pillars */
         if (!dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x169])
+                /* dSv_event_flag_c::M_070 - Cutscene - [cutscene: 18] Lanayru spirit restored */
             || !dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x67]))
         {
             iVar5 = 0;
+                 /* dSv_event_flag_c::F_0264 - Cutscene - Get master sword */
             if (!dComIfGs_isEventBit(dSv_event_flag_c::saveBitLabels[0x108])) {
                 swbit = 0x4f;
             } else {