Documenting water palette transition tables

Hey, look, and unused one.
sonicretro · Jul 27, 2015 · 772f2f8 · 772f2f8
1 parent 6481e77
commit 772f2f8
Showing 1 changed file with 36 additions and 6 deletions.
diff --git a/sonic3k.asm b/sonic3k.asm
@@ -8724,7 +8724,24 @@ byte_74A2:	dc.b  $F8, $F8,	  8,   8, $F4, $F4, $F4,  $C,  $C,  $C,	 $F, $13, $14
 
 byte_74BD:	dc.b  $F8,   0,	$F8,   0, $FA,	 1, $FA,   2, $F8,   0,	$F8,   0, $F8,	 0,   6,   1,	0,   3,	  6,   2
 		dc.b    8,   0,   8,   0,   8,   0,   8,   0,   8,   0,   0,   3, $F8,   0,   0
-WaterTransition_AIZ1:	dc.w $F
+
+; ---------------------------------------------------------------------------
+; Water palette transition tables
+
+; These are used by HInt3 to load the water palette only a small bit at a time,
+; this is to space out the CRAM writes to push the VDP dots offscreen.
+;
+; Each value is an offset into Water_palette.
+; From there, 6 bytes, meaning 3 palette entries, are transferred to CRAM.
+; ---------------------------------------------------------------------------
+
+watertransheader macro {INTLABEL}
+__LABEL__ label *
+	; Number of entries in list minus one
+	dc.w (((__LABEL___End - __LABEL__ - 2) / 2) - 1)
+	endm
+
+WaterTransition_AIZ1: watertransheader
 		dc.w 2
 		dc.w $68
 		dc.w $62
@@ -8741,7 +8758,9 @@ WaterTransition_AIZ1:	dc.w $F
 		dc.w $3A
 		dc.w $2E
 		dc.w $28
-WaterTransition_AIZ2:	dc.w $12
+WaterTransition_AIZ1_End
+
+WaterTransition_AIZ2: watertransheader
 		dc.w $6E
 		dc.w $68
 		dc.w 2
@@ -8761,7 +8780,9 @@ WaterTransition_AIZ2:	dc.w $12
 		dc.w $3A
 		dc.w $2E
 		dc.w $28
-WaterTransition_CNZ2ICZ2:	dc.w $13
+WaterTransition_AIZ2_End
+
+WaterTransition_CNZ2ICZ2: watertransheader
 		dc.w $6E
 		dc.w $68
 		dc.w $7A
@@ -8782,7 +8803,10 @@ WaterTransition_CNZ2ICZ2:	dc.w $13
 		dc.w $2E
 		dc.w $28
 		dc.w $54
-WaterTransition_HCZLBZ1:	dc.w $13
+WaterTransition_CNZ2ICZ2_End
+
+; Hydrocity Zone doesn't use this?
+WaterTransition_HCZLBZ1: watertransheader
 		dc.w 2
 		dc.w $74
 		dc.w $62
@@ -8803,7 +8827,9 @@ WaterTransition_HCZLBZ1:	dc.w $13
 		dc.w $3A
 		dc.w $22
 		dc.w $4E
-WaterTransition_LBZ2:	dc.w $13
+WaterTransition_HCZLBZ1_End
+
+WaterTransition_LBZ2: watertransheader
 		dc.w 2
 		dc.w $6E
 		dc.w $68
@@ -8824,7 +8850,10 @@ WaterTransition_LBZ2:	dc.w $13
 		dc.w $3A
 		dc.w $22
 		dc.w $4E
-		dc.w $13
+WaterTransition_LBZ2_End
+
+; Unknown and unused
+WaterTransition_Unk: watertransheader
 		dc.w 2
 		dc.w 8
 		dc.w $E
@@ -8845,6 +8874,7 @@ WaterTransition_LBZ2:	dc.w $13
 		dc.w $2E
 		dc.w $34
 		dc.w $3A
+WaterTransition_Unk_End
 
 ; =============== S U B R O U T I N E =======================================