From c859678d5fc79b315cff3b5de10078c50e4b0bc8 Mon Sep 17 00:00:00 2001
From: fig02 <fig02srl@gmail.com>
Date: Fri, 14 Feb 2025 13:55:11 -0500
Subject: [PATCH] Document `sSceneInitLetterboxTimer` (#2469)

* document scene init letterbox timer

* reword
---
 src/code/z_camera.c          | 6 +++---
 src/code/z_camera_data.inc.c | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/code/z_camera.c b/src/code/z_camera.c
index dce9b5b089..6b0f4c24f4 100644
--- a/src/code/z_camera.c
+++ b/src/code/z_camera.c
@@ -7533,7 +7533,7 @@ void Camera_Init(Camera* camera, View* view, CollisionContext* colCtx, PlayState
 #if DEBUG_FEATURES
     sDbgModeIdx = -1;
 #endif
-    D_8011D3F0 = 3;
+    sSceneInitLetterboxTimer = 3; // show letterbox for 3 frames at the start of a new scene
     PRINTF(VT_FGCOL(BLUE) "camera: initialize --- " VT_RST " UID %d\n", camera->uid);
 }
 
@@ -8142,8 +8142,8 @@ Vec3s Camera_Update(Camera* camera) {
         if ((gSaveContext.gameMode != GAMEMODE_NORMAL) && (gSaveContext.gameMode != GAMEMODE_END_CREDITS)) {
             sCameraInterfaceField = CAM_INTERFACE_FIELD(CAM_LETTERBOX_NONE, CAM_HUD_VISIBILITY_ALL, 0);
             Camera_UpdateInterface(sCameraInterfaceField);
-        } else if ((D_8011D3F0 != 0) && (camera->camId == CAM_ID_MAIN)) {
-            D_8011D3F0--;
+        } else if ((sSceneInitLetterboxTimer != 0) && (camera->camId == CAM_ID_MAIN)) {
+            sSceneInitLetterboxTimer--;
             sCameraInterfaceField = CAM_INTERFACE_FIELD(CAM_LETTERBOX_LARGE, CAM_HUD_VISIBILITY_NOTHING_ALT, 0);
             Camera_UpdateInterface(sCameraInterfaceField);
         } else if (camera->play->transitionMode != TRANS_MODE_OFF) {
diff --git a/src/code/z_camera_data.inc.c b/src/code/z_camera_data.inc.c
index fece55ea3d..07a527afe8 100644
--- a/src/code/z_camera_data.inc.c
+++ b/src/code/z_camera_data.inc.c
@@ -2584,7 +2584,7 @@ s16 D_8011D3CC[] = {
 
 s32 sUpdateCameraDirection = 0;
 s32 D_8011D3EC = 0;
-s32 D_8011D3F0 = 0;
+s32 sSceneInitLetterboxTimer = 0;
 
 s32 sDemo5PrevAction12Frame = -16;