Identify wSpriteAnimDict key constants

9 files changed, 27 insertions, 28 deletions

diff --git a/engine/battle_anims/core.asm b/engine/battle_anims/core.asm
index d756a447..ef5aee3f 100644
--- a/engine/battle_anims/core.asm
+++ b/engine/battle_anims/core.asm
@@ -288,7 +288,7 @@ GetBattleAnimTileOffset:
 	push bc
 	ld hl, wBattleAnimTileDict
 	ld b, a
-	ld c, 10 / 2
+	ld c, NUM_BATTLEANIMTILEDICT_ENTRIES
 .loop
 	ld a, [hli]
 	cp b
diff --git a/engine/games/dummy_game.asm b/engine/games/dummy_game.asm
index 648346fc..c84e36fc 100644
--- a/engine/games/dummy_game.asm
+++ b/engine/games/dummy_game.asm
@@ -19,10 +19,10 @@ _DummyGame:
 	ld bc, 4 tiles
 	ld a, BANK(DummyGameGFX)
 	call FarCopyBytes
-	ld a, $8
+	ld a, SPRITE_ANIM_DICT_ARROW_CURSOR
 	ld hl, wSpriteAnimDict
 	ld [hli], a
-	ld [hl], $0
+	ld [hl], $00
 	hlcoord 0, 0
 	ld bc, SCREEN_HEIGHT * SCREEN_WIDTH
 	xor a
diff --git a/engine/games/slot_machine.asm b/engine/games/slot_machine.asm
index 47f1cc42..c7198f13 100644
--- a/engine/games/slot_machine.asm
+++ b/engine/games/slot_machine.asm
@@ -143,7 +143,7 @@ _SlotMachine:
 	call ByteFill
 	call Slots_InitReelTiles
 	call Slots_GetPals
-	ld a, $7
+	ld a, SPRITE_ANIM_DICT_SLOTS
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], $40
@@ -158,7 +158,7 @@ _SlotMachine:
 	call Random
 	and %00101010
 	ret nz
-	ld a, 1
+	ld a, TRUE
 	ld [wKeepSevenBiasChance], a ; 12.5% chance
 	ret
 
diff --git a/engine/gfx/sprites.asm b/engine/gfx/sprites.asm
index 57b0187e..ded71d93 100644
--- a/engine/gfx/sprites.asm
+++ b/engine/gfx/sprites.asm
@@ -1,6 +1,6 @@
 ClearSpriteAnims:
-	ld hl, wSpriteAnimDict
-	ld bc, wSpriteAnimsEnd - wSpriteAnimDict
+	ld hl, wSpriteAnimData
+	ld bc, wSpriteAnimDataEnd - wSpriteAnimData
 .loop
 	ld [hl], 0
 	inc hl
@@ -168,8 +168,8 @@ _InitSpriteAnimStruct::
 	ld a, [de]
 	ld [hli], a ; SPRITEANIMSTRUCT_ANIM_SEQ_ID
 	inc de
-; Look up the third field from the table in the wSpriteAnimDict array (10x2).
-; Take the value and load it in
+; Look up the third field in the wSpriteAnimDict mapping.
+; Take the mapped value and load it in.
 	ld a, [de]
 	call GetSpriteAnimVTile
 	ld [hli], a ; SPRITEANIMSTRUCT_TILE_ID
@@ -360,13 +360,12 @@ InitSpriteAnimBuffer:
 	ret
 
 GetSpriteAnimVTile:
-; a = wSpriteAnimDict[a] if a in wSpriteAnimDict else 0
-; vTiles offset
+; a = wSpriteAnimDict[a] if a in wSpriteAnimDict else vtile offset $00
 	push hl
 	push bc
 	ld hl, wSpriteAnimDict
 	ld b, a
-	ld c, NUM_SPRITE_ANIM_STRUCTS
+	ld c, NUM_SPRITEANIMDICT_ENTRIES
 .loop
 	ld a, [hli]
 	cp b
@@ -621,8 +620,8 @@ ClearSpriteAnims2:
 	push de
 	push bc
 	push af
-	ld hl, wSpriteAnimDict
-	ld bc, wSpriteAnimsEnd - wSpriteAnimDict
+	ld hl, wSpriteAnimData
+	ld bc, wSpriteAnimDataEnd - wSpriteAnimData
 .loop
 	ld [hl], 0
 	inc hl
diff --git a/engine/menus/naming_screen.asm b/engine/menus/naming_screen.asm
index 39d930ab..28fc98bd 100644
--- a/engine/menus/naming_screen.asm
+++ b/engine/menus/naming_screen.asm
@@ -159,7 +159,7 @@ NamingScreen:
 	ld hl, vTiles0 tile $00
 	lb bc, BANK(PokeBallSpriteGFX), 4
 	call Request2bpp
-	xor a
+	xor a ; SPRITE_ANIM_DICT_DEFAULT and tile offset $00
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], a
@@ -191,7 +191,7 @@ NamingScreen:
 	ld hl, vTiles0 tile $04
 	lb bc, BANK(ChrisSpriteGFX), 4
 	call Request2bpp
-	xor a
+	xor a ; SPRITE_ANIM_DICT_DEFAULT and tile offset $00
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], a
@@ -841,8 +841,8 @@ LoadNamingScreenGFX:
 	ld a, BANK(NamingScreenGFX_Cursor)
 	call FarCopyBytes
 
-	ld a, $5
-	ld hl, wSpriteAnimDict + 9 * 2
+	ld a, SPRITE_ANIM_DICT_TEXT_CURSOR
+	ld hl, wSpriteAnimDict + (NUM_SPRITEANIMDICT_ENTRIES - 1) * 2
 	ld [hli], a
 	ld [hl], NAMINGSCREEN_CURSOR
 	xor a
@@ -910,7 +910,7 @@ _ComposeMailMessage:
 	ld bc, 8 tiles
 	ld a, BANK(.MailIcon)
 	call FarCopyBytes
-	xor a
+	xor a ; SPRITE_ANIM_DICT_DEFAULT and tile offset $00
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], a
diff --git a/engine/movie/intro.asm b/engine/movie/intro.asm
index 7ff23fce..03a1c1a8 100644
--- a/engine/movie/intro.asm
+++ b/engine/movie/intro.asm
@@ -112,9 +112,9 @@ IntroScene1:
 	ld hl, Intro_WaterGFX2
 	call Decompress
 	ld hl, wSpriteAnimDict
-	ld a, 0
+	ld a, SPRITE_ANIM_DICT_DEFAULT
 	ld [hli], a
-	ld a, 0
+	ld a, $00
 	ld [hli], a
 	xor a
 	ldh [hSCY], a
@@ -609,9 +609,9 @@ IntroScene6:
 	ld hl, Intro_GrassGFX2
 	call Decompress
 	ld hl, wSpriteAnimDict
-	ld a, 1
+	ld a, SPRITE_ANIM_DICT_GS_INTRO
 	ld [hli], a
-	ld a, 0
+	ld a, $00
 	ld [hli], a
 	xor a
 	ldh [hSCY], a
@@ -790,9 +790,9 @@ IntroScene10:
 	farcall Intro_GetMonFrontpic
 
 	ld hl, wSpriteAnimDict
-	ld a, 1
+	ld a, SPRITE_ANIM_DICT_GS_INTRO
 	ld [hli], a
-	ld a, 0
+	ld a, $00
 	ld [hli], a
 	call EnableLCD
 	ld a, 0
diff --git a/engine/movie/splash.asm b/engine/movie/splash.asm
index 1e74d9b8..b22b8930 100644
--- a/engine/movie/splash.asm
+++ b/engine/movie/splash.asm
@@ -62,7 +62,7 @@ GameFreakPresentsInit:
 	farcall ClearSpriteAnims
 
 	ld hl, wSpriteAnimDict
-	ld a, 6
+	ld a, SPRITE_ANIM_DICT_GS_SPLASH
 	ld [hli], a
 	ld a, $8d
 	ld [hl], a
diff --git a/engine/movie/title.asm b/engine/movie/title.asm
index af095f3a..a2af9c2a 100644
--- a/engine/movie/title.asm
+++ b/engine/movie/title.asm
@@ -53,7 +53,7 @@ TitleScreen:
 	call FillTitleScreenPals
 	call LoadTitleScreenTilemap
 	ld hl, wSpriteAnimDict
-	xor a
+	xor a ; SPRITE_ANIM_DICT_DEFAULT and tile offset $00
 	ld [hli], a
 	ld [hl], a
 	ld hl, rLCDC
diff --git a/engine/movie/trade_animation.asm b/engine/movie/trade_animation.asm
index f99e9e0c..97c2e9d6 100644
--- a/engine/movie/trade_animation.asm
+++ b/engine/movie/trade_animation.asm
@@ -1291,7 +1291,7 @@ LoadTradeBallAndCableGFX:
 	ld hl, vTiles0 tile $74
 	lb bc, BANK(TradeCableGFX), 4
 	call Request2bpp
-	xor a
+	xor a ; SPRITE_ANIM_DICT_DEFAULT
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], $62