Use constants for rBGPI+rOBPI auto-increment

Fix some documentation

constants/hardware_constants.asm

@@ -145,8 +145,10 @@ rHDMA4      EQU $ff54 ; CGB Mode Only - New DMA Destination, Low
 rHDMA5      EQU $ff55 ; CGB Mode Only - New DMA Length/Mode/Start
 rRP         EQU $ff56 ; CGB Mode Only - Infrared Communications Port
 rBGPI       EQU $ff68 ; CGB Mode Only - Background Palette Index
+rBGPI_AUTO_INCREMENT EQU 7 ; increment rBGPI after write to rBGPD
 rBGPD       EQU $ff69 ; CGB Mode Only - Background Palette Data
 rOBPI       EQU $ff6a ; CGB Mode Only - Sprite Palette Index
+rOBPI_AUTO_INCREMENT EQU 7 ; increment rOBPI after write to rOBPD
 rOBPD       EQU $ff6b ; CGB Mode Only - Sprite Palette Data
 rUNKNOWN1   EQU $ff6c ; (FEh) Bit 0 (Read/Write) - CGB Mode Only
 rSVBK       EQU $ff70 ; CGB Mode Only - WRAM Bank

docs/map_scripts.md

@@ -65,7 +65,7 @@ Callback types:
 
 ## `.CoordEvents: db` *N*
 
-- **`coord_event` *x*, *y*, *scene id*, *script***
+- **`coord_event` *x*, *y*, *scene_id*, *script***
 
 
 ## `.BGEvents: db` *N*
@@ -90,7 +90,7 @@ BG event types:
 
 ## `.ObjectEvents: db` *N*
 
-- **`object_event` *x*, *y*, *sprite*, *movement*, *ry*, *rx*, *h1*, *h2*, *palette*, *type*, *range*, *script*, *event_flag***
+- **`object_event` *x*, *y*, *sprite*, *movement*, *rx*, *ry*, *h1*, *h2*, *palette*, *type*, *range*, *script*, *event_flag***
 
 Movement types:
 

engine/battle/anim_hp_bar.asm

@@ -45,7 +45,7 @@ _AnimateHPBar: ; d627
 	and a
 	jr nz, .player
 	ld a, [wCurHPAnimMaxHP]
-	cp 6 * 8
+	cp HP_BAR_LENGTH_PX
 	jr nc, .player
 	and a
 	ret
@@ -203,7 +203,7 @@ LongAnim_UpdateVariables: ; d6f5
 
 ShortHPBarAnim_UpdateTiles: ; d730
 	call HPBarAnim_UpdateHPRemaining
-	ld d, $6
+	ld d, HP_BAR_LENGTH
 	ld a, [wWhichHPBar]
 	and $1
 	ld b, a
@@ -229,7 +229,7 @@ LongHPBarAnim_UpdateTiles: ; d749
 	ld d, a
 	call ComputeHPBarPixels
 	ld c, e
-	ld d, $6
+	ld d, HP_BAR_LENGTH
 	ld a, [wWhichHPBar]
 	and $1
 	ld b, a
@@ -377,7 +377,7 @@ ShortHPBar_CalcPixelFrame: ; d839
 	ld b, 0
 	ld hl, 0
 	ld a, [wCurHPBarPixels]
-	cp 6 * 8
+	cp HP_BAR_LENGTH_PX
 	jr nc, .return_max
 	and a
 	jr z, .return_zero
@@ -388,7 +388,7 @@ ShortHPBar_CalcPixelFrame: ; d839
 ; by 48, the loop runs one extra time. To fix, uncomment the line below.
 .loop
 	ld a, l
-	sub 6 * 8
+	sub HP_BAR_LENGTH_PX
 	ld l, a
 	ld a, h
 	sbc $0
@@ -404,7 +404,7 @@ ShortHPBar_CalcPixelFrame: ; d839
 	add hl, bc
 	pop bc
 	ld a, l
-	sub 6 * 8
+	sub HP_BAR_LENGTH_PX
 	ld l, a
 	ld a, h
 	sbc $0

engine/color.asm

@@ -908,7 +908,7 @@ InitCGBPals::
 	call ByteFill
 	ld a, $0
 	ld [rVBK], a
-	ld a, $80
+	ld a, 1 << rBGPI_AUTO_INCREMENT
 	ld [rBGPI], a
 	ld c, 4 * 8
 .bgpals_loop
@@ -918,7 +918,7 @@ InitCGBPals::
 	ld [rBGPD], a
 	dec c
 	jr nz, .bgpals_loop
-	ld a, $80
+	ld a, 1 << rOBPI_AUTO_INCREMENT
 	ld [rOBPI], a
 	ld c, 4 * 8
 .obpals_loop

engine/debug.asm

@@ -161,19 +161,19 @@ Function819a7: ; 819a7
 	ld de, BGPals
 	ld bc, 16 palettes
 	call CopyBytes
-	ld a, $80
+	ld a, 1 << rBGPI_AUTO_INCREMENT
 	ld [rBGPI], a
 	ld hl, Palette_819f4
-	ld c, $40
+	ld c, 8 palettes
 	xor a
 .asm_819c8
 	ld [rBGPD], a
 	dec c
 	jr nz, .asm_819c8
-	ld a, $80
+	ld a, 1 << rOBPI_AUTO_INCREMENT
 	ld [rOBPI], a
 	ld hl, Palette_81a34
-	ld c, $40
+	ld c, 8 palettes
 .asm_819d6
 	ld a, [hli]
 	ld [rOBPD], a

home/palettes.asm

@@ -30,7 +30,7 @@ ForceUpdateCGBPals:: ; c37
 	ld hl, BGPals
 
 ; copy 8 pals to bgpd
-	ld a, %10000000 ; auto increment, index 0
+	ld a, 1 << rBGPI_AUTO_INCREMENT
 	ld [rBGPI], a
 	ld c, LOW(rBGPD)
 	ld b, 8 / 2
@@ -46,7 +46,7 @@ endr
 ; hl is now OBPals
 
 ; copy 8 pals to obpd
-	ld a, %10000000 ; auto increment, index 0
+	ld a, 1 << rOBPI_AUTO_INCREMENT
 	ld [rOBPI], a
 	ld c, LOW(rOBPD)
 	ld b, 8 / 2

tilesets/animations.asm

@@ -935,26 +935,24 @@ TileAnimationPalette: ; fc6d7
 	ret nz
 
 ; Ready for BGPD input...
-	ld a, %10011000 ; auto increment, index $18 (pal 3 color 0)
+
+	ld a, (1 << rBGPI_AUTO_INCREMENT) palette PAL_BG_WATER
 	ld [rBGPI], a
 
 	ld a, [rSVBK]
 	push af
-	ld a, 5 ; wra5: gfx
+	ld a, BANK(UnknBGPals)
 	ld [rSVBK], a
 
 ; Update color 0 in order 0 1 2 1
-
 	ld a, l
 	and %110 ; frames 0 2 4 6
-
 	jr z, .color0
-
 	cp 4
 	jr z, .color2
 
 .color1
-	ld hl, UnknBGPals + $1a ; pal 3 color 1
+	ld hl, UnknBGPals palette PAL_BG_WATER + 2
 	ld a, [hli]
 	ld [rBGPD], a
 	ld a, [hli]
@@ -962,7 +960,7 @@ TileAnimationPalette: ; fc6d7
 	jr .end
 
 .color0
-	ld hl, UnknBGPals + $18 ; pal 3 color 0
+	ld hl, UnknBGPals palette PAL_BG_WATER
 	ld a, [hli]
 	ld [rBGPD], a
 	ld a, [hli]
@@ -970,7 +968,7 @@ TileAnimationPalette: ; fc6d7
 	jr .end
 
 .color2
-	ld hl, UnknBGPals + $1c ; pal 3 color 2
+	ld hl, UnknBGPals palette PAL_BG_WATER + 4
 	ld a, [hli]
 	ld [rBGPD], a
 	ld a, [hli]
@@ -999,19 +997,19 @@ FlickeringCaveEntrancePalette: ; fc71e
 
 	ld a, [rSVBK]
 	push af
-	ld a, 5 ; wra5: gfx
+	ld a, BANK(UnknBGPals)
 	ld [rSVBK], a
 ; Ready for BGPD input...
-	ld a, %10100000 ; auto-increment, index $20 (pal 4 color 0)
+	ld a, (1 << rBGPI_AUTO_INCREMENT) palette PAL_BG_YELLOW
 	ld [rBGPI], a
 	ld a, [hVBlankCounter]
-	and %00000010
+	and 1 << 1
 	jr nz, .bit1set
-	ld hl, UnknBGPals + $20 ; pal 4 color 0
+	ld hl, UnknBGPals palette PAL_BG_YELLOW
 	jr .okay
 
 .bit1set
-	ld hl, UnknBGPals + $22 ; pal 4 color 2
+	ld hl, UnknBGPals palette PAL_BG_YELLOW + 2
 
 .okay
 	ld a, [hli]