Some henna documentation (#2739)

* henna minor cleanup

* rename light to kankyo

* more cleanup

* pos

* more cleanup

* fix build

* final fix

config/GZ2E01/rels/d_a_npc_henna/symbols.txt

@@ -304,7 +304,7 @@ __global_destructor_chain = .bss:0x00000000; // type:object size:0x4 scope:globa
 @1012 = .bss:0x0000003C; // type:object size:0x1 scope:local
 @1010 = .bss:0x00000040; // type:object size:0x1 scope:local
 @1009 = .bss:0x00000044; // type:object size:0x1 scope:local
-lbl_82_bss_45 = .bss:0x00000045; // type:object size:0x1 data:byte
+l_HIOInit = .bss:0x00000045; // type:object size:0x1 data:byte
 @3900 = .bss:0x00000048; // type:object size:0xC scope:local
 l_HIO = .bss:0x00000054; // type:object size:0x38 scope:global data:byte
 lrl = .bss:0x0000008C; // type:object size:0x4 scope:global data:4byte

config/GZ2E01/symbols.txt

@@ -21726,7 +21726,7 @@ data_80450C9B = .sbss:0x80450C9B; // type:object size:0x1 scope:global align:1
 data_80450C9C = .sbss:0x80450C9C; // type:object size:0x1 scope:global align:1
 data_80450C9D = .sbss:0x80450C9D; // type:object size:0x1
 data_80450C9E = .sbss:0x80450C9E; // type:object size:0x1
-cDmr_FishingWeather = .sbss:0x80450C9F; // type:object size:0x1
+cDmr_FishingWether = .sbss:0x80450C9F; // type:object size:0x1
 data_80450CA0 = .sbss:0x80450CA0; // type:object size:0x4 scope:global align:4
 JPTracePCB4 = .sbss:0x80450CA4; // type:object size:0x4 scope:global align:4 data:4byte
 DMC_initialized = .sbss:0x80450CA8; // type:object size:0x1 scope:local align:1 data:byte

config/GZ2J01/rels/d_a_npc_henna/symbols.txt

@@ -303,7 +303,7 @@ __global_destructor_chain = .bss:0x00000000; // type:object size:0x4 scope:globa
 @1012 = .bss:0x0000003C; // type:object size:0x1 scope:local
 @1010 = .bss:0x00000040; // type:object size:0x1 scope:local
 @1009 = .bss:0x00000044; // type:object size:0x1 scope:local
-lbl_82_bss_45 = .bss:0x00000045; // type:object size:0x1 data:byte
+l_HIOInit = .bss:0x00000045; // type:object size:0x1 data:byte
 @3900 = .bss:0x00000048; // type:object size:0xC scope:local
 l_HIO = .bss:0x00000054; // type:object size:0x38 scope:global data:byte
 lrl = .bss:0x0000008C; // type:object size:0x4 scope:global data:4byte

config/GZ2J01/symbols.txt

@@ -21736,7 +21736,7 @@ data_80450C9B = .sbss:0x8044ADDB; // type:object size:0x1
 data_80450C9C = .sbss:0x8044ADDC; // type:object size:0x1
 data_80450C9D = .sbss:0x8044ADDD; // type:object size:0x1
 data_80450C9E = .sbss:0x8044ADDE; // type:object size:0x1
-cDmr_FishingWeather = .sbss:0x8044ADDF; // type:object size:0x1
+cDmr_FishingWether = .sbss:0x8044ADDF; // type:object size:0x1
 data_80450CA0 = .sbss:0x8044ADE0; // type:object size:0x4
 JPTracePCB4 = .sbss:0x8044ADE4; // type:object size:0x4 scope:global align:4 data:4byte
 DMC_initialized = .sbss:0x8044ADE8; // type:object size:0x1 data:byte

config/GZ2P01/rels/d_a_npc_henna/symbols.txt

@@ -303,7 +303,7 @@ __global_destructor_chain = .bss:0x00000000; // type:object size:0x4 scope:globa
 @1012 = .bss:0x0000003C; // type:object size:0x1 scope:local
 @1010 = .bss:0x00000040; // type:object size:0x1 scope:local
 @1009 = .bss:0x00000044; // type:object size:0x1 scope:local
-lbl_82_bss_45 = .bss:0x00000045; // type:object size:0x1 data:byte
+l_HIOInit = .bss:0x00000045; // type:object size:0x1 data:byte
 @3900 = .bss:0x00000048; // type:object size:0xC scope:local
 l_HIO = .bss:0x00000054; // type:object size:0x38 scope:global data:byte
 lrl = .bss:0x0000008C; // type:object size:0x4 scope:global data:4byte

config/GZ2P01/symbols.txt

@@ -21742,7 +21742,7 @@ data_80450C9B = .sbss:0x80452C5B; // type:object size:0x1
 data_80450C9C = .sbss:0x80452C5C; // type:object size:0x1
 data_80450C9D = .sbss:0x80452C5D; // type:object size:0x1
 data_80450C9E = .sbss:0x80452C5E; // type:object size:0x1
-cDmr_FishingWeather = .sbss:0x80452C5F; // type:object size:0x1
+cDmr_FishingWether = .sbss:0x80452C5F; // type:object size:0x1
 data_80450CA0 = .sbss:0x80452C60; // type:object size:0x4
 JPTracePCB4 = .sbss:0x80452C64; // type:object size:0x4 scope:global align:4 data:4byte
 DMC_initialized = .sbss:0x80452C68; // type:object size:0x1 data:byte

include/c/c_damagereaction.h

@@ -19,7 +19,7 @@ extern u8 data_80450C9B;
 extern u8 data_80450C9C;
 extern u8 data_80450C9D;
 extern u8 data_80450C9E;
-extern u8 cDmr_FishingWeather;
+extern u8 cDmr_FishingWether;
 extern u8 data_80450CA0;
 extern JPTraceParticleCallBack4 JPTracePCB4;
 

include/d/actor/d_a_npc_henna.h

@@ -17,8 +17,8 @@
 class npc_henna_class {
 public:
     /* 0x0   */ fopEn_enemy_c actor;
-    /* 0x5AC */ request_of_phase_process_class field_0x5ac;
+    /* 0x5AC */ request_of_phase_process_class phase;
-    /* 0x5B4 */ u8 field_0x5b4;
+    /* 0x5B4 */ u8 arg0;
     /* 0x5B5 */ s8 field_0x5b5;
     /* 0x5B6 */ s8 field_0x5b6;
     /* 0x5B8 */ s16 mIsTalking;
@@ -47,11 +47,11 @@ public:
     /* 0x692 */ s8 field_0x692;
     /* 0x693 */ s8 field_0x693;
     /* 0x694 */ s8 field_0x694;
-    /* 0x698 */ f32 field_0x698;
+    /* 0x698 */ f32 anm_speed;
     /* 0x69C */ f32 field_0x69c;
     /* 0x6A0 */ s16 field_0x6a0;
-    /* 0x6A2 */ s16 field_0x6a2;
+    /* 0x6A2 */ s16 action;
-    /* 0x6A4 */ s16 field_0x6a4;
+    /* 0x6A4 */ s16 move_mode;
     /* 0x6A6 */ s16 field_0x6a6;
     /* 0x6A8 */ u8 field_0x6a8[0x6ac - 0x6a8];
     /* 0x6AC */ f32 field_0x6ac;
@@ -84,9 +84,9 @@ public:
     /* 0x730 */ f32 field_0x730;
     /* 0x734 */ u8 field_0x734;
     /* 0x738 */ f32 field_0x738;
-    /* 0x73C */ s16 field_0x73c[10];
+    /* 0x73C */ s16 timer[10];
     /* 0x750 */ s16 field_0x750;
-    /* 0x752 */ s16 field_0x752;
+    /* 0x752 */ s16 cam_mode;
     /* 0x754 */ s16 field_0x754;
     /* 0x756 */ u16 field_0x756;
     /* 0x758 */ s16 field_0x758;
@@ -112,15 +112,15 @@ public:
     /* 0x7C8 */ u8 field_0x7c8[0x7cc - 0x7c8];
     /* 0x7CC */ u32 field_0x7cc;
     /* 0x7D0 */ u8 field_0x7d0[0x7d4 - 0x7d0];
-    /* 0x7D4 */ u8 field_0x7d4;
+    /* 0x7D4 */ u8 demo_timer;
     /* 0x7D5 */ u8 field_0x7d5;
     /* 0x7D6 */ u8 field_0x7d6;
     /* 0x7D7 */ u8 field_0x7d7;
     /* 0x7D8 */ u8 field_0x7d8[0x7e1 - 0x7d8];
     /* 0x7E1 */ s8 field_0x7e1;
-    /* 0x7E4 */ fpc_ProcID mBoatId;
+    /* 0x7E4 */ fpc_ProcID boat_id;
     /* 0x7E8 */ u8 field_0x7e8[0x7f8 - 0x7e8];
-    /* 0x7F8 */ u8 field_0x7f8;
+    /* 0x7F8 */ u8 hio_init;
 };
 
 STATIC_ASSERT(sizeof(npc_henna_class) == 0x7fc);

include/d/d_kankyo.h

@@ -460,7 +460,7 @@ public:
     /* 0x12C9 */ u8 dice_wether_mode;
     /* 0x12CA */ u8 dice_wether_state;
     /* 0x12CB */ u8 dice_wether_pat;
-    /* 0x12CC */ u8 field_0x12cc;
+    /* 0x12CC */ u8 wether;
     /* 0x12CD */ u8 mColPatMode;
     /* 0x12CE */ u8 mColPatModeGather;
     /* 0x12CF */ u8 mFogAdjEnable;

src/c/c_damagereaction.cpp

@@ -19,7 +19,7 @@ u8 data_80450C9B;
 u8 data_80450C9C;
 u8 data_80450C9D;
 u8 data_80450C9E;
-u8 cDmr_FishingWeather;
+u8 cDmr_FishingWether;
 
 /* 8001817C-800182A4 012ABC 0128+00 1/0 0/0 0/0 .text
  * execute__24JPTraceParticleCallBack4FP14JPABaseEmitterP15JPABaseParticle */

src/d/actor/d_a_L7op_demo_dr.cpp

@@ -159,7 +159,7 @@ void daL7ODR_c::pl_walk() {
                 field_0x898 = 2.0f;
                 
                 dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-                kankyo->field_0x12cc = 1;
+                kankyo->wether = 1;
                 field_0x888++;
             }
         } else if (field_0x888 == 2) {

src/d/actor/d_a_b_dr.cpp

@@ -3877,7 +3877,7 @@ void daB_DR_c::demo_skip(int) {
         camera_class* camera = dComIfGp_getCamera(dComIfGp_getPlayerCameraID(0));
         dStage_changeScene(1, 0.0f, 0, fopAcM_GetRoomNo(this), 0, -1);
         Z2GetAudioMgr()->subBgmStop();
-        dKy_getEnvlight()->field_0x12cc = 1;
+        dKy_getEnvlight()->wether = 1;
 
         cDmr_SkipInfo = 1;
         dComIfGs_onZoneSwitch(0, fopAcM_GetRoomNo(this));
@@ -4182,7 +4182,7 @@ int daB_DR_c::create() {
                 }
 
                 dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-                kankyo->field_0x12cc = 0;
+                kankyo->wether = 0;
                 return cPhs_ERROR_e;
             }
 
@@ -4307,7 +4307,7 @@ int daB_DR_c::create() {
                 setActionMode(ACTION_FLY_WAIT, 0);
                 
                 dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-                kankyo->field_0x12cc = 2;
+                kankyo->wether = 2;
             }
 
             if (arg0 == 0) {
@@ -4325,7 +4325,7 @@ int daB_DR_c::create() {
                     }
     
                     dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-                    kankyo->field_0x12cc = 0;
+                    kankyo->wether = 0;
                 }
 
                 if (cDmr_SkipInfo != 0 || dComIfGs_isZoneSwitch(0, fopAcM_GetRoomNo(this)) ) {

src/d/actor/d_a_b_dre.cpp

@@ -262,7 +262,7 @@ void daB_DRE_c::CamAction2() {
         if (mTimers[0] == 0) {
             SetAnm(mpModelMorf, 0x38, 0, 5.0f, 1.0f);
             dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-            kankyo->field_0x12cc = 2;
+            kankyo->wether = 2;
             mDrMode++;
             mCameraMode++;
         }
@@ -580,7 +580,7 @@ void daB_DRE_c::DrAction() {
             mAnm = 0x1F;
 
             dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-            kankyo->field_0x12cc = 0;
+            kankyo->wether = 0;
 
             mHideModel = true;
             mDrMode++;

src/d/actor/d_a_b_gnd.cpp

@@ -2561,7 +2561,7 @@ static void action(b_gnd_class* i_this) {
 #ifdef DEBUG
     if (mDoCPd_c::getTrigR(PAD_2)) {
         dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-        kankyo->field_0x12cc = 1;
+        kankyo->wether = 1;
 
         i_this->mActionMode = ACTION_WAIT;
         i_this->mMoveMode = 0;
@@ -3272,7 +3272,7 @@ static void demo_camera(b_gnd_class* i_this) {
             anm_init(i_this, B_GND_BCK_EGND_KAMAE, 3.0f, 0, 1.0f);
             i_this->mGndEyeBtkNo = 5;
             Z2GetAudioMgr()->bgmStart(Z2BGM_VS_GANON_04, 0, 0);
-            kankyo->field_0x12cc = 3;
+            kankyo->wether = 3;
         }
 
         if (i_this->mDemoCamTimer == 320) {
@@ -3294,7 +3294,7 @@ static void demo_camera(b_gnd_class* i_this) {
             dComIfGs_onOneZoneSwitch(15, -1);
             dComIfGs_onSaveDunSwitch(1);
             Z2GetAudioMgr()->setDemoName("force_end");
-            kankyo->field_0x12cc = 1;
+            kankyo->wether = 1;
         }
         break;
     case 50:
@@ -3930,7 +3930,7 @@ static int daB_GND_Execute(b_gnd_class* i_this) {
         i_this->mNoDrawTimer--;
         if (i_this->mNoDrawTimer == 0) {
             dScnKy_env_light_c* kankyo = dKy_getEnvlight();
-            kankyo->field_0x12cc = 1;
+            kankyo->wether = 1;
 
             i_this->mActionMode = ACTION_WAIT;
             i_this->mMoveMode = 0;

src/d/actor/d_a_kytag06.cpp

@@ -521,7 +521,7 @@ static void daKytag06_wether_proc(kytag06_class* i_this, u8 param_1) {
  * daKytag06_type_07_wether_Execute__FP13kytag06_class          */
 static void daKytag06_type_07_wether_Execute(kytag06_class* i_this) {
     dScnKy_env_light_c* env_light = dKy_getEnvlight();
-    daKytag06_wether_proc(i_this, env_light->field_0x12cc);
+    daKytag06_wether_proc(i_this, env_light->wether);
 }
 
 /* 808586F0-808589A4 000F70 02B4+00 1/1 0/0 0/0 .text daKytag06_type_07_Execute__FP13kytag06_class
@@ -617,7 +617,7 @@ static void daKytag06_type_06_Execute(kytag06_class* i_this) {
     dComIfGs_getTime();
     dScnKy_env_light_c* env_light = dKy_getEnvlight();
 
-    daKytag06_wether_proc(i_this, env_light->field_0x12cc);
+    daKytag06_wether_proc(i_this, env_light->wether);
     cXyz spX;
 
     f32 current_time = dComIfGs_getTime();
@@ -682,13 +682,13 @@ static void daKytag06_type_06_Execute(kytag06_class* i_this) {
  */
 static void daKytag06_type_08_Execute(kytag06_class* i_this) {
     dScnKy_env_light_c* env_light = dKy_getEnvlight();
-    daKytag06_lv7_boss_wether_proc(i_this, env_light->field_0x12cc);
+    daKytag06_lv7_boss_wether_proc(i_this, env_light->wether);
 }
 
 /* 80858D00-80858D2C 001580 002C+00 1/1 0/0 0/0 .text            daKytag06_type_09_Execute__FP13kytag06_class */
 static void daKytag06_type_09_Execute(kytag06_class* i_this) {
     dScnKy_env_light_c* env_light = dKy_getEnvlight();
-    daKytag06_Ganon_wether_proc(i_this, env_light->field_0x12cc);
+    daKytag06_Ganon_wether_proc(i_this, env_light->wether);
 }
 
 /* 80858D2C-8085912C 0015AC 0400+00 1/1 0/0 0/0 .text            daKytag06_type_10_Execute__FP13kytag06_class */

src/d/actor/d_a_mg_fshop.cpp

@@ -1755,7 +1755,7 @@ static int daFshop_Execute(fshop_class* param_1) {
                     henna->actor.health = 2;
                 }
                 
-                henna->field_0x752 = 0x49;
+                henna->cam_mode = 0x49;
                 henna->field_0x754 = 0;
                 henna->field_0x7b9 = 0;
                 param_1->field_0x567 = 2;
@@ -1775,9 +1775,9 @@ static int daFshop_Execute(fshop_class* param_1) {
 
                             if (bVar5) {
                                 henna->actor.health = 3;
-                                henna->field_0x752 = 0x49;
+                                henna->cam_mode = 0x49;
                             } else {
-                                henna->field_0x752 = 0x4c;
+                                henna->cam_mode = 0x4c;
                             }
                             henna->field_0x754 = 0;
                             henna->field_0x7b9 = 0;

src/d/actor/d_a_mg_rod.cpp

@@ -2612,7 +2612,7 @@ static void lure_catch(dmg_rod_class* i_this) {
         }
 
         if (henna != NULL && sp8 == 2) {
-            henna->field_0x6a4 = 10;
+            henna->move_mode = 10;
         }
 
         daAlink_getAlinkActorClass()->changeFishGetFace(sp8);
@@ -2849,7 +2849,7 @@ static void lure_heart(dmg_rod_class* i_this) {
 
         dComIfGp_setMesgBgmOn();
         if (henna != NULL) {
-            henna->field_0x6a4 = 10;
+            henna->move_mode = 10;
             henna->field_0x688 = 1;
         }
     }
@@ -3541,7 +3541,7 @@ static void uki_ready(dmg_rod_class* i_this) {
     cLib_addCalc2(&i_this->field_0xf64, -30.0f + ZREG_F(1), 1.0f, 0.5f + BREG_F(14));
     cLib_addCalc2(&i_this->field_0xf68, -(20.0f + AREG_F(10)), 1.0f, 0.02f * (20.0f + AREG_F(10)));
 
-    if (i_this->timers[0] != 0 || dComIfGp_event_runCheck() != 0 || i_this->play_cam_mode >= 1000 || (henna != NULL && henna->field_0x752 != 0) || dComIfGp_checkPlayerStatus0(0, 0x100000)) {
+    if (i_this->timers[0] != 0 || dComIfGp_event_runCheck() != 0 || i_this->play_cam_mode >= 1000 || (henna != NULL && henna->cam_mode != 0) || dComIfGp_checkPlayerStatus0(0, 0x100000)) {
         return;
     }
 
@@ -4015,7 +4015,7 @@ static void uki_catch(dmg_rod_class* i_this) {
                 }
 
                 if (henna != NULL) {
-                    henna->field_0x6a4 = 30;
+                    henna->move_mode = 30;
                 }
             } else if (mgfish->mCaughtType == MG_CATCH_SP) {
                 i_this->msgflow.init(actor, 0x1397, 0, NULL);
@@ -5658,7 +5658,7 @@ static void play_camera_u(dmg_rod_class* i_this) {
             camera->mCamera.SetTrimSize(0);
 
             if (dMsgObject_getSelectCursorPos() != 0) {
-                henna->field_0x752 = 300;
+                henna->cam_mode = 300;
             }
         }
         break;

src/d/d_kankyo.cpp

@@ -1248,19 +1248,19 @@ static void envcolor_init() {
     if (!strcmp(dComIfGp_getStartStageName(), "F_SP127") ||
         !strcmp(dComIfGp_getStartStageName(), "R_SP127"))
     {
-        if (g_env_light.field_0x12cc >= 7) {
+        if (g_env_light.wether >= 7) {
             g_env_light.mColpatWeather = 2;
-        } else if (g_env_light.field_0x12cc != 0) {
+        } else if (g_env_light.wether != 0) {
             g_env_light.mColpatWeather = 1;
         }
     } else if (!strcmp(dComIfGp_getStartStageName(), "D_MN07A")) {
-        if (g_env_light.field_0x12cc == 1) {
+        if (g_env_light.wether == 1) {
             g_env_light.mColpatWeather = 1;
-        } else if (g_env_light.field_0x12cc == 2) {
+        } else if (g_env_light.wether == 2) {
             g_env_light.mColpatWeather = 2;
         }
     } else {
-        g_env_light.field_0x12cc = 0;
+        g_env_light.wether = 0;
     }
 
     g_env_light.base_raincnt = 0;
@@ -1359,7 +1359,7 @@ void dKy_clear_game_init() {
     g_env_light.darktime_week = 0;
     g_env_light.fishing_hole_season = 0;
     g_env_light.field_0x130a = 0;
-    g_env_light.field_0x12cc = 0;
+    g_env_light.wether = 0;
     g_env_light.staffroll_next_timer = 0;
 }
 

src/d/d_kankyo_rain.cpp

@@ -1610,7 +1610,7 @@ void cloud_shadow_move() {
                 cLib_addCalc(&g_env_light.field_0xebc, 0.3f, 0.1f, 0.01f, 0.000001f);
             }
 
-            if (g_env_light.field_0x12cc >= 3) {
+            if (g_env_light.wether >= 3) {
                 cLib_addCalc(&g_env_light.field_0xebc, 1.0f, 0.5f, 0.1f, 0.000001f);
             }
         }