Document Song of Time Cutscenes (Test6) (#1269)

* import docs

* cleanup

* more eventinf docs

* more cleanup

* more docs

* more docs

* more docs

* sZoraBarrierEnvLighting

* comments

* PR Suggestion

* fix bss

include/functions.h

@@ -860,10 +860,10 @@ void Environment_FillScreen(GraphicsContext* gfxCtx, u8 red, u8 green, u8 blue,
 void Environment_DrawSandstorm(PlayState* play, u8 sandstormState);
 s32 func_800FD2B4(PlayState* play, f32 arg1, f32 arg2, f32 arg3, f32 arg4);
 void func_800FD538(Color_RGB8* param_1, Color_RGB8* param_2, f32 param_3, Vec3s* param_4);
-void func_800FD59C(PlayState* play, Color_RGB8* pzParm2, f32 fParm3);
-void func_800FD5E0(PlayState* play, Color_RGB8* pzParm2, f32 fParm3);
-void func_800FD654(PlayState* play, Color_RGB8* pzParm2, f32 fParm3);
-void func_800FD698(PlayState* play, s16 arg1, s16 arg2, f32 arg3);
+void Environment_LerpAmbientColor(PlayState* play, Color_RGB8* to, f32 lerp);
+void Environment_LerpDiffuseColor(PlayState* play, Color_RGB8* to, f32 lerp);
+void Environment_LerpFogColor(PlayState* play, Color_RGB8* to, f32 lerp);
+void Environment_LerpFog(PlayState* play, s16 fogNearTarget, s16 zFarTarget, f32 lerp);
 // u32 get_days_elapsed(void);
 // void reset_days_elapsed(void);
 // u32 get_current_day(void);

include/z64cutscene.h

@@ -430,7 +430,7 @@ typedef enum {
     /* 0x1F6 */ CS_CMD_ACTOR_CUE_502,
     /* 0x1F7 */ CS_CMD_ACTOR_CUE_503,
     /* 0x1F8 */ CS_CMD_ACTOR_CUE_504,
-    /* 0x1F9 */ CS_CMD_ACTOR_CUE_505,
+    /* 0x1F9 */ CS_CMD_ACTOR_CUE_SOTCS, // Song of Time Cutscenes (Double SoT, Three-Day Reset SoT)
     /* 0x1FA */ CS_CMD_ACTOR_CUE_506,
     /* 0x1FB */ CS_CMD_ACTOR_CUE_507,
     /* 0x1FC */ CS_CMD_ACTOR_CUE_508,

include/z64ocarina.h

@@ -32,6 +32,12 @@ typedef enum {
     /* 24 */ OCARINA_SONG_SCARECROW_LONG = OCARINA_SONG_MAX // anything larger than 24 is considered the long scarecrow's song
 } OcarinaSongId;
 
+typedef enum OcarinaMode {
+    /* 0x18 */ OCARINA_MODE_APPLY_INV_SOT_FAST = 24,
+    /* 0x19 */ OCARINA_MODE_APPLY_INV_SOT_SLOW,
+    /* 0x1A */ OCARINA_MODE_APPLY_DOUBLE_SOT
+} OcarinaMode;
+
 typedef enum {
     /*  0 */ OCARINA_BTN_A,
     /*  1 */ OCARINA_BTN_C_DOWN,

include/z64player.h

@@ -656,7 +656,7 @@ typedef enum PlayerCsMode {
     /* 0x3F */ PLAYER_CSMODE_63,
     /* 0x40 */ PLAYER_CSMODE_64,
     /* 0x41 */ PLAYER_CSMODE_65,
-    /* 0x42 */ PLAYER_CSMODE_66,
+    /* 0x42 */ PLAYER_CSMODE_66, // Look side-to-side with chin down
     /* 0x43 */ PLAYER_CSMODE_67,
     /* 0x44 */ PLAYER_CSMODE_68,
     /* 0x45 */ PLAYER_CSMODE_69,
@@ -664,15 +664,15 @@ typedef enum PlayerCsMode {
     /* 0x47 */ PLAYER_CSMODE_71,
     /* 0x48 */ PLAYER_CSMODE_72,
     /* 0x49 */ PLAYER_CSMODE_73,
-    /* 0x4A */ PLAYER_CSMODE_74,
+    /* 0x4A */ PLAYER_CSMODE_74, // Give a big nod of approval
     /* 0x4B */ PLAYER_CSMODE_75,
     /* 0x4C */ PLAYER_CSMODE_76,
     /* 0x4D */ PLAYER_CSMODE_77,
     /* 0x4E */ PLAYER_CSMODE_78,
     /* 0x4F */ PLAYER_CSMODE_79,
     /* 0x50 */ PLAYER_CSMODE_80,
-    /* 0x51 */ PLAYER_CSMODE_81,
-    /* 0x52 */ PLAYER_CSMODE_82,
+    /* 0x51 */ PLAYER_CSMODE_81, // Look side-to-side with chin up
+    /* 0x52 */ PLAYER_CSMODE_82, // Close eyes and sway body in circles
     /* 0x53 */ PLAYER_CSMODE_83,
     /* 0x54 */ PLAYER_CSMODE_84, // Sucked by the moon
     /* 0x55 */ PLAYER_CSMODE_85,

include/z64save.h

@@ -1466,15 +1466,8 @@ typedef enum {
  * gSaveContext.eventInf
  */
 
-// gSaveContext.eventInf[0] is used to dog race information
-// #define EVENTINF_00 0x00
-// #define EVENTINF_01 0x01
-// #define EVENTINF_02 0x02
-// #define EVENTINF_03 0x03
-// #define EVENTINF_04 0x04
-// #define EVENTINF_05 0x05
-// #define EVENTINF_06 0x06
-// #define EVENTINF_07 0x07
+// gSaveContext.eventInf[0] is used for dog race information (8 entries)
+// EVENTINF_00 to EVENTINF_07
 
 #define EVENTINF_10 0x10
 #define EVENTINF_11 0x11
@@ -1491,7 +1484,8 @@ typedef enum {
 #define EVENTINF_24 0x24
 #define EVENTINF_25 0x25
 #define EVENTINF_26 0x26
-#define EVENTINF_27 0x27
+// "Dawn of ... day". Must be triggered with respawnFlag -4 or -99
+#define EVENTINF_TRIGGER_DAYTELOP 0x27
 #define EVENTINF_30 0x30
 
 // EVENTINF_31 is used to track if Player is within range of EnGakufu (2D Song Buttons Appearing on Wall)
@@ -1535,11 +1529,14 @@ typedef enum {
 #define EVENTINF_65 0x65
 #define EVENTINF_66 0x66
 #define EVENTINF_67 0x67
-#define EVENTINF_70 0x70
-#define EVENTINF_71 0x71
-#define EVENTINF_72 0x72
-#define EVENTINF_73 0x73
-#define EVENTINF_74 0x74
+
+// Tracks which ammo is lost during the three day reset
+#define EVENTINF_THREEDAYRESET_LOST_RUPEES 0x70
+#define EVENTINF_THREEDAYRESET_LOST_BOMB_AMMO 0x71
+#define EVENTINF_THREEDAYRESET_LOST_NUT_AMMO 0x72
+#define EVENTINF_THREEDAYRESET_LOST_STICK_AMMO 0x73
+#define EVENTINF_THREEDAYRESET_LOST_ARROW_AMMO 0x74
+
 #define EVENTINF_75 0x75
 #define EVENTINF_76 0x76
 #define EVENTINF_77 0x77