From fa0f386bf05713eb871f25c0350f13cf9fc6c193 Mon Sep 17 00:00:00 2001
From: Inirdin <36412360+Inirdin@users.noreply.github.com>
Date: Fri, 13 Jan 2023 20:02:47 +0100
Subject: [PATCH] Font colors comments (#2122)

---
 goal_src/jak1/engine/gfx/font-h.gc | 95 ++++++++++++++++++++----------
 1 file changed, 65 insertions(+), 30 deletions(-)

diff --git a/goal_src/jak1/engine/gfx/font-h.gc b/goal_src/jak1/engine/gfx/font-h.gc
index fe9333159e..cdb019320a 100644
--- a/goal_src/jak1/engine/gfx/font-h.gc
+++ b/goal_src/jak1/engine/gfx/font-h.gc
@@ -10,41 +10,41 @@
 
 (defenum font-color
   :type uint64
-  (default 0)
-  (white 1)
-  (gray 2)
-  (orange-red 3)
-  (bright-orange-red 4)
-  (dark-yellow 5)
-  (bright-green 6)
-  (dark-blue 7)
-  (light-blue 8)
-  (dark-pink 9)
-  (lighter-blue 10)
-  (dark-light-blue 11)
-  (dim-white 12)
-  (dim-gray 13)
-  (orange-red-2 14)
-  (yellow-green 15)
-  (dark-green 16)
-  (another-gray 17)
-  (dark-dark-green 18)
-  (flat-dark-purple 19)
-  (flat-yellow 20)
-  (blue-white 21)
+  (default 0) ;; menu and HUD
+  (white 1) ;; debug, camera settings, actor marks
+  (gray 2) ;; unused?
+  (orange-red 3) ;; debug values, subtitles - character names
+  (bright-orange-red 4) ;; debug, path marks numbers
+  (dark-yellow 5) ;; HUD, other numbers
+  (bright-green 6) ;; HUD, health numbers
+  (dark-blue 7) ;; unused?
+  (light-blue 8) ;; unused?
+  (dark-pink 9) ;; unused?
+  (lighter-blue 10) ;; debug, selected using joypad
+  (dark-light-blue 11) ;; debug, parent of active menu
+  (dim-white 12) ;; debug, active menu, regular
+  (dim-gray 13) ;; debug, parent menu, regular
+  (orange-red-2 14) ;; debug, anim-tester
+  (yellow-green 15) ;; debug, active menu, enabled
+  (dark-green 16) ;; debug, parent menu, enabled
+  (another-gray 17) ;; debug, active menu, disabled
+  (dark-dark-green 18) ;; debug, parent menu, disabled
+  (flat-dark-purple 19) ;; menu and debug, grayed out option
+  (flat-yellow 20) ;; debug, rev.
+  (blue-white 21) ;; menu, under percentage, save slot stats
   (pad-back 22)
   (pad-shine 23)
   (pad-square 24)
   (pad-circle 25)
   (pad-triangle 26)
   (pad-x 27)
-  (lighter-lighter-blue 28)
-  (yellow-orange 29)
-  (yellow-green-2 30)
-  (another-light-blue 31)
-  (light-yellow 32)
-  (red-orange 33)
-  (another-orange-red 34)
+  (lighter-lighter-blue 28) ;; menu, location name, task status
+  (yellow-orange 29) ;; menu, power cell description
+  (yellow-green-2 30) ;; menu, selected
+  (another-light-blue 31) ;; menu, completion percentage
+  (light-yellow 32) ;; unused?
+  (red-orange 33) ;; pc-pad-utils?
+  (another-orange-red 34) ;; unused?
 
   (red 3)
   (red2 4)
@@ -400,6 +400,7 @@
    :color-shadow (new 'static 'vector4w :x #x00 :y #x00 :z #x00 :w #x80)
    ;; TODO - make enum for this
    :color-table (new 'static 'inline-array char-color 64
+    ;; 00 - default (menu and HUD)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -409,6 +410,7 @@
       (static-rgba #x30 #x38 #x30 #x80)
       )
      )
+    ;; 01 - white (debug, camera settings, actor marks)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -418,6 +420,7 @@
       (static-rgba #x60 #x60 #x60 #x80)
       )
      )
+    ;; 02 - gray
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -427,6 +430,7 @@
       (static-rgba #x60 #x60 #x60 #x40)
       )
      )
+    ;; 03 - orange-red (debug values, subtitles - character names)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -436,6 +440,7 @@
       (static-rgba #x60 #x00 #x00 #x80)
       )
      )
+    ;; 04 - bright-orange-red (debug, path marks numbers)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -445,6 +450,7 @@
       (static-rgba #x80 #x00 #x00 #x80)
       )
      )
+    ;; 05 - dark-yellow (HUD, other numbers)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -454,6 +460,7 @@
       (static-rgba #x28 #x28 #x00 #x80)
       )
      )
+    ;; 06 - bright-green (HUD, health numbers)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -463,6 +470,7 @@
       (static-rgba #x00 #x30 #x00 #x80)
       )
      )
+    ;; 07 - dark-blue
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -472,6 +480,7 @@
       (static-rgba #x00 #x00 #x60 #x80)
       )
      )
+    ;; 08 - light-blue
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -481,6 +490,7 @@
       (static-rgba #x00 #x20 #x50 #x80)
       )
      )
+    ;; 09 - dark-pink
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -490,6 +500,7 @@
       (static-rgba #x30 #x00 #x30 #x80)
       )
      )
+    ;; 10 - lighter-blue (debug, selected using joypad)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -499,6 +510,7 @@
       (static-rgba #x00 #x40 #x60 #x80)
       )
      )
+    ;; 11 - dark-light-blue (debug, parent of active menu)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -508,6 +520,7 @@
       (static-rgba #x00 #x20 #x40 #x80)
       )
      )
+    ;; 12 - dim-white (debug, active menu, regular)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -517,6 +530,7 @@
       (static-rgba #x50 #x50 #x50 #x80)
       )
      )
+    ;; 13 - dim-gray (debug, parent menu, regular)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -526,6 +540,7 @@
       (static-rgba #x28 #x28 #x28 #x80)
       )
      )
+    ;; 14 - orange-red-2 (debug, anim-tester)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -535,6 +550,7 @@
       (static-rgba #x60 #x00 #x00 #x80)
       )
      )
+    ;; 15 - yellow-green (debug, active menu, enabled)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -544,6 +560,7 @@
       (static-rgba #x00 #x60 #x00 #x80)
       )
      )
+    ;; 16 - dark-green (debug, parent menu, enabled)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -553,6 +570,7 @@
       (static-rgba #x00 #x38 #x00 #x80)
       )
      )
+    ;; 17 - another-gray (debug, active menu, disabled)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -562,6 +580,7 @@
       (static-rgba #x30 #x40 #x30 #x80)
       )
      )
+    ;; 18 - dark-dark-green (debug, parent menu, disabled)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -571,6 +590,7 @@
       (static-rgba #x18 #x28 #x18 #x80)
       )
      )
+    ;; 19 - flat-dark-purple (menu and debug, grayed out option)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -580,6 +600,7 @@
       (static-rgba #x30 #x20 #x30 #x80)
       )
      )
+    ;; 20 - flat-yellow (debug, rev.)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -589,6 +610,7 @@
       (static-rgba #x80 #x79 #x48 #x80)
       )
      )
+    ;; 21 - blue-white (menu, under percentage, save slot stats)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -598,6 +620,7 @@
       (static-rgba #x80 #x7d #x4f #x80)
       )
      )
+    ;; 22 - pad-back
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -607,6 +630,7 @@
       (static-rgba #x1d #x1d #x1d #x80)
       )
      )
+    ;; 23 - pad-shine
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -616,6 +640,7 @@
       (static-rgba #x40 #x40 #x40 #x80)
       )
      )
+    ;; 24 - pad-square
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -625,6 +650,7 @@
       (static-rgba #x7a #x4d #x65 #x80)
       )
      )
+    ;; 25 - pad-circle
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -634,6 +660,7 @@
       (static-rgba #x7a #x34 #x34 #x80)
       )
      )
+    ;; 26 - pad-triangle
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -643,6 +670,7 @@
       (static-rgba #x10 #x65 #x4c #x80)
       )
      )
+    ;; 27 - pad-x
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -652,6 +680,7 @@
       (static-rgba #x46 #x4a #x78 #x80)
       )
      )
+    ;; 28 - lighter-lighter-blue (menu, location name, task status)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -661,6 +690,7 @@
       (static-rgba #x29 #x63 #x70 #x80)
       )
      )
+    ;; 29 - yellow-orange (menu, power cell description)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -670,6 +700,7 @@
       (static-rgba #x76 #x40 #x14 #x80)
       )
      )
+    ;; 30 - yellow-green-2 (menu, selected)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -679,6 +710,7 @@
       (static-rgba #x1b #x51 #x20 #x80)
       )
      )
+    ;; 31 - another-light-blue (menu, completion percentage)
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -688,6 +720,7 @@
       (static-rgba #x00 #x3c #x4f #x80)
       )
      )
+    ;; 32 - light-yellow
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -697,6 +730,7 @@
       (static-rgba #x30 #x38 #x30 #x80)
       )
      )
+    ;; 33 - red-orange
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -706,6 +740,7 @@
       (static-rgba #x80 #x60 #x20 #x80)
       )
      )
+    ;; 34 - another-orange-red
     (new 'static 'char-color
      :color
      (new 'static 'array rgba 4
@@ -766,4 +801,4 @@
 
 
 (define-extern draw-string (function string dma-buffer font-context float))
-(define-extern draw-string-xy (function string dma-buffer int int font-color font-flags float))
\ No newline at end of file
+(define-extern draw-string-xy (function string dma-buffer int int font-color font-flags float))