Document kaleido debug menu (#2506)

* Document kaleido debug menu

* Fix BSS

* bss

* Address reviews

* bss

* add #pragma increment_block_number to z_parameter and let CI do its thing

* bss

* buffer -> digitBuf

* reformat comments on sSectionPositions. trick clang-format into not ruining the array by adding // comments on their own line

* rename to KaleidoScope_DrawInventoryEditor

---------

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

src/code/flg_set.c

@@ -184,7 +184,7 @@ void FlagSet_Update(PlayState* play) {
     }
 
     if (CHECK_BTN_ALL(input->press.button, BTN_L)) {
-        play->pauseCtx.debugState = 0;
+        play->pauseCtx.debugState = PAUSE_DEBUG_STATE_CLOSED;
     }
 
     CLOSE_DISPS(gfxCtx, "../flg_set.c", 241);

src/code/main.c

@@ -44,7 +44,7 @@ extern struct IrqMgr gIrqMgr;
 #include "z64thread.h"
 
 #pragma increment_block_number "gc-eu:128 gc-eu-mq:128 gc-jp:128 gc-jp-ce:128 gc-jp-mq:128 gc-us:128 gc-us-mq:128" \
-                               "ique-cn:0 ntsc-1.0:54 ntsc-1.1:54 ntsc-1.2:54 pal-1.0:52 pal-1.1:52"
+                               "ique-cn:0 ntsc-1.0:51 ntsc-1.1:51 ntsc-1.2:51 pal-1.0:49 pal-1.1:49"
 
 extern u8 _buffersSegmentEnd[];
 

src/code/z_bgcheck.c

@@ -14,7 +14,7 @@
 #include "z64player.h"
 #include "z64skin_matrix.h"
 
-#pragma increment_block_number "ntsc-1.0:152 ntsc-1.1:152 ntsc-1.2:152"
+#pragma increment_block_number "ntsc-1.0:144 ntsc-1.1:144 ntsc-1.2:144"
 
 u16 DynaSSNodeList_GetNextNodeIdx(DynaSSNodeList* nodeList);
 void BgCheck_GetStaticLookupIndicesFromPos(CollisionContext* colCtx, Vec3f* pos, Vec3i* sector);

src/code/z_camera.c

@@ -3661,7 +3661,7 @@ s32 Camera_KeepOn3(Camera* camera) {
 }
 
 #pragma increment_block_number "gc-eu:128 gc-eu-mq:128 gc-jp:128 gc-jp-ce:128 gc-jp-mq:128 gc-us:128 gc-us-mq:128" \
-                               "ique-cn:128 ntsc-1.0:86 ntsc-1.1:86 ntsc-1.2:86 pal-1.0:86 pal-1.1:86"
+                               "ique-cn:128 ntsc-1.0:83 ntsc-1.1:83 ntsc-1.2:83 pal-1.0:83 pal-1.1:83"
 
 s32 Camera_KeepOn4(Camera* camera) {
     static Vec3f D_8015BD50;

src/code/z_kaleido_scope_call.c

@@ -1,4 +1,4 @@
-#pragma increment_block_number "gc-eu:80 gc-eu-mq:80 gc-jp:80 gc-jp-ce:80 gc-jp-mq:80 gc-us:80 gc-us-mq:80 ique-cn:80" \
+#pragma increment_block_number "gc-eu:80 gc-eu-mq:80 gc-jp:80 gc-jp-ce:80 gc-jp-mq:80 gc-us:80 gc-us-mq:80 ique-cn:64" \
                                "ntsc-1.0:96 ntsc-1.1:96 ntsc-1.2:96 pal-1.0:96 pal-1.1:96"
 
 #include "libu64/debug.h"

src/code/z_kaleido_setup.c

@@ -79,7 +79,7 @@ void KaleidoSetup_Update(PlayState* play) {
 
         if (CHECK_BTN_ALL(input->cur.button, BTN_L) && CHECK_BTN_ALL(input->press.button, BTN_CUP)) {
             if (DEBUG_FEATURES && BREG(0)) {
-                pauseCtx->debugState = 3;
+                pauseCtx->debugState = PAUSE_DEBUG_STATE_FLAG_SET_OPEN;
             }
         } else if (CHECK_BTN_ALL(input->press.button, BTN_START)) {
             // The start button was pressed, pause
@@ -134,7 +134,7 @@ void KaleidoSetup_Init(PlayState* play) {
     PauseContext* pauseCtx = &play->pauseCtx;
 
     pauseCtx->state = PAUSE_STATE_OFF;
-    pauseCtx->debugState = 0;
+    pauseCtx->debugState = PAUSE_DEBUG_STATE_CLOSED;
 
     pauseCtx->eye.x = pauseCtx->eye.y = 0.0f;
     pauseCtx->eye.z = 64.0f;

src/code/z_parameter.c

@@ -29,6 +29,8 @@
 #include "assets/textures/do_action_static/do_action_static.h"
 #include "assets/textures/icon_item_static/icon_item_static.h"
 
+#pragma increment_block_number "gc-jp:128 gc-jp-ce:128 gc-jp-mq:128 gc-us:128 gc-us-mq:128"
+
 typedef struct RestrictionFlags {
     /* 0x00 */ u8 sceneId;
     /* 0x01 */ u8 flags1;
@@ -3221,7 +3223,7 @@ void Interface_Draw(PlayState* play) {
     gSPSegment(OVERLAY_DISP++, 0x08, interfaceCtx->iconItemSegment);
     gSPSegment(OVERLAY_DISP++, 0x0B, interfaceCtx->mapSegment);
 
-    if (pauseCtx->debugState == 0) {
+    if (pauseCtx->debugState == PAUSE_DEBUG_STATE_CLOSED) {
         Interface_InitVertices(play);
         func_8008A994(interfaceCtx);
         Health_DrawMeter(play);
@@ -4026,7 +4028,7 @@ void Interface_Draw(PlayState* play) {
     }
 
 #if DEBUG_FEATURES
-    if (pauseCtx->debugState == 3) {
+    if (pauseCtx->debugState == PAUSE_DEBUG_STATE_FLAG_SET_OPEN) {
         FlagSet_Update(play);
     }
 #endif

src/code/z_player_lib.c

@@ -17,8 +17,8 @@
 #include "assets/objects/object_link_boy/object_link_boy.h"
 #include "assets/objects/object_link_child/object_link_child.h"
 
-#pragma increment_block_number "gc-eu:0 gc-eu-mq:0 gc-jp:128 gc-jp-ce:128 gc-jp-mq:128 gc-us:128 gc-us-mq:128" \
-                               "pal-1.0:0 pal-1.1:0"
+#pragma increment_block_number "gc-eu:0 gc-eu-mq:0 gc-jp:0 gc-jp-ce:0 gc-jp-mq:0 gc-us:0 gc-us-mq:0 pal-1.0:0" \
+                               "pal-1.1:0"
 
 typedef struct BowSlingshotStringData {
     /* 0x00 */ Gfx* dList;