Create sprite_anim_constants.asm

7 files changed, 76 insertions, 35 deletions

diff --git a/constants.asm b/constants.asm
index 5c29a51..19c002d 100644
--- a/constants.asm
+++ b/constants.asm
@@ -31,6 +31,7 @@ INCLUDE "constants/item_data_constants.asm"
 INCLUDE "constants/trainer_constants.asm"
 INCLUDE "constants/trainer_data_constants.asm"
 INCLUDE "constants/sprite_constants.asm"
+INCLUDE "constants/sprite_anim_constants.asm"
 INCLUDE "constants/battle_constants.asm"
 INCLUDE "constants/palette_constants.asm"
 INCLUDE "constants/music_constants.asm"
diff --git a/constants/sprite_anim_constants.asm b/constants/sprite_anim_constants.asm
new file mode 100755
index 0000000..b9ade3a
--- /dev/null
+++ b/constants/sprite_anim_constants.asm
@@ -0,0 +1,40 @@
+; wSpriteAnimDict keys
+	const_def
+	const SPRITE_ANIM_DICT_DEFAULT      ; 0
+	const SPRITE_ANIM_DICT_GS_INTRO     ; 1
+	const SPRITE_ANIM_DICT_GS_INTRO_2   ; 2
+	const_skip 2                        ; unused
+	const SPRITE_ANIM_DICT_TEXT_CURSOR  ; 5
+	const SPRITE_ANIM_DICT_GS_SPLASH    ; 6
+	const SPRITE_ANIM_DICT_SLOTS        ; 7
+	const SPRITE_ANIM_DICT_ARROW_CURSOR ; 8
+; wSpriteAnimDict size (see ram/wram.asm)
+NUM_SPRITEANIMDICT_ENTRIES EQU 10
+
+; SpriteAnimSeqData indexes
+SPRITE_ANIM_INDEX_08                            EQU $08
+
+SPRITE_ANIM_INDEX_GS_INTRO_BUBBLE               EQU $21
+SPRITE_ANIM_INDEX_GS_INTRO_OMANYTE              EQU $22
+SPRITE_ANIM_INDEX_GS_INTRO_MAGIKARP             EQU $23
+SPRITE_ANIM_INDEX_UNUSED_INTRO_AERODACTYL       EQU $24
+SPRITE_ANIM_INDEX_GS_INTRO_LAPRAS               EQU $25
+SPRITE_ANIM_INDEX_GS_INTRO_NOTE                 EQU $26
+SPRITE_ANIM_INDEX_GS_INTRO_SMALLER_NOTE         EQU $27
+SPRITE_ANIM_INDEX_GS_INTRO_JIGGLYPUFF           EQU $28
+SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU              EQU $29
+SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU_TAIL         EQU $2a
+SPRITE_ANIM_INDEX_GS_INTRO_FIREBALL             EQU $2b
+SPRITE_ANIM_INDEX_GS_INTRO_BLASTOISE            EQU $2c
+SPRITE_ANIM_INDEX_GS_INTRO_VENUSAUR             EQU $2d
+
+SPRITE_ANIM_INDEX_GS_TITLE_FLAME_NOTE           EQU $2e
+
+SPRITE_ANIM_INDEX_39                            EQU $39
+SPRITE_ANIM_INDEX_GAMEFREAK_LOGO                EQU $3a
+SPRITE_ANIM_INDEX_GS_INTRO_STAR                 EQU $3b
+SPRITE_ANIM_INDEX_GS_INTRO_SPARKLE              EQU $3c
+SPRITE_ANIM_INDEX_40                            EQU $40
+SPRITE_ANIM_INDEX_41                            EQU $41
+SPRITE_ANIM_INDEX_44                            EQU $44
+SPRITE_ANIM_INDEX_4B                            EQU $4b
diff --git a/engine/dumps/bank02.asm b/engine/dumps/bank02.asm
index 86f11e6..aa9ec80 100755
--- a/engine/dumps/bank02.asm
+++ b/engine/dumps/bank02.asm
@@ -1151,7 +1151,7 @@ Function886a:
 	lb bc, BANK(GoldSpriteGFX), $04
 	call Request2bpp
 	depixel 0, 0
-	ld a, $41
+	ld a, SPRITE_ANIM_INDEX_41
 	call InitSpriteAnimStruct
 	ld hl, $0003
 	add hl, bc
@@ -1189,7 +1189,7 @@ Function88b3:
 	lb bc, BANK(PidgeySpriteGFX), $04
 	call Request2bpp
 	depixel 0, 0
-	ld a, $41
+	ld a, SPRITE_ANIM_INDEX_41
 	call InitSpriteAnimStruct
 	ld hl, $0003
 	add hl, bc
@@ -1444,7 +1444,7 @@ Function8c21:
 	ld [hli], a
 	ld [hl], $7c
 	depixel 4, 3, 4, 4
-	ld a, $44
+	ld a, SPRITE_ANIM_INDEX_44
 	call InitSpriteAnimStruct
 	call Function8c1c
 	ret
@@ -1569,7 +1569,7 @@ Function8cb7:
 	call PrintText
 	call WaitBGMap
 	depixel 9, 4, 4, 3
-	ld a, $44
+	ld a, SPRITE_ANIM_INDEX_44
 	call InitSpriteAnimStruct
 	ld hl, $0002
 	add hl, bc
@@ -1578,7 +1578,7 @@ Function8cb7:
 	add hl, bc
 	ld [hl], $7c
 	depixel 8, 6
-	ld a, $4b
+	ld a, SPRITE_ANIM_INDEX_4B
 	call InitSpriteAnimStruct
 	ld hl, $0003
 	add hl, bc
diff --git a/engine/menu/text_entry.asm b/engine/menu/text_entry.asm
index 0c9bf75..f6700f2 100644
--- a/engine/menu/text_entry.asm
+++ b/engine/menu/text_entry.asm
@@ -148,7 +148,7 @@ GetNamingScreenSetup:
 	ld [hl+], a
 	ld [hl], $00
 	depixel 4, 4, 4, 0
-	ld a, $41
+	ld a, SPRITE_ANIM_INDEX_41
 	call InitSpriteAnimStruct
 	ld hl, $0001
 	add hl, bc
@@ -181,7 +181,7 @@ GetNamingScreenSetup:
 	ld [hli], a
 	ld [hl], $00
 	depixel 4, 4, 4, 0
-	ld a, $41
+	ld a, SPRITE_ANIM_INDEX_41
 	call InitSpriteAnimStruct
 	ret
 
@@ -302,7 +302,7 @@ NamingScreenJoypadLoop:
 
 .InitCursor:
 	depixel 11, 3, 0, 0
-	ld a, $39
+	ld a, SPRITE_ANIM_INDEX_39
 	call InitSpriteAnimStruct
 	ld a, c
 	ld [wNamingScreenCursorObjectPointer], a
@@ -729,13 +729,13 @@ ComposeMailMessage:
 	ld [hli], a
 	ld [hl], 0
 	depixel 4, 4, 4, 0
-	ld a, 8
+	ld a, SPRITE_ANIM_INDEX_08
 	call InitSpriteAnimStruct
 	ld hl, $0002
 	add hl, bc
 	ld [hl], 0
 	depixel 11, 3, 0, 0
-	ld a, $39
+	ld a, SPRITE_ANIM_INDEX_39
 	call InitSpriteAnimStruct
 	ld a, c
 	ld [wNamingScreenCursorObjectPointer], a
@@ -946,13 +946,13 @@ SetupMail:
 	ld [hli], a
 	ld [hl], 0
 	depixel 4, 4, 4, 0
-	ld a, 8
+	ld a, SPRITE_ANIM_INDEX_08
 	call InitSpriteAnimStruct
 	ld hl, $0002
 	add hl, bc
 	ld [hl], 0
 	depixel 12, 3, 0, 0
-	ld a, $40
+	ld a, SPRITE_ANIM_INDEX_40
 	call InitSpriteAnimStruct
 	ld a, c
 	ld [wNamingScreenCursorObjectPointer], a
diff --git a/engine/movie/game_freak_intro.asm b/engine/movie/game_freak_intro.asm
index f3f888c..456197d 100644
--- a/engine/movie/game_freak_intro.asm
+++ b/engine/movie/game_freak_intro.asm
@@ -169,7 +169,7 @@ GameFreakPresents_Star:
 	xor a
 	ld [wIntroSceneFrameCounter], a
 	depixel 10, 11, 4, 0
-	ld a, $3b	; SPRITE_ANIM_INDEX_GS_INTRO_STAR
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_STAR
 	call InitSpriteAnimStruct
 
 	ld hl, $000c	; SPRITEANIMSTRUCT_VAR1
@@ -187,7 +187,7 @@ GameFreakPresents_PlaceLogo:
 	ret z
 
 	depixel 10, 11, 4, 0
-	ld a, $3a	; SPRITE_ANIM_INDEX_GAMEFREAK_LOGO
+	ld a, SPRITE_ANIM_INDEX_GAMEFREAK_LOGO
 	call InitSpriteAnimStruct
 	call GameFreakPresents_NextScene
 
@@ -293,7 +293,7 @@ GameFreakPresents_Sparkle:
 ; set up a new sparkle sprite
 	push af
 	depixel 11, 11
-	ld a, $3c
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_SPARKLE
 	call InitSpriteAnimStruct
 	pop af
 
diff --git a/engine/movie/opening_cutscene.asm b/engine/movie/opening_cutscene.asm
index 49c4035..4b60625 100644
--- a/engine/movie/opening_cutscene.asm
+++ b/engine/movie/opening_cutscene.asm
@@ -123,9 +123,9 @@ IntroScene1:	; 43b8
 	jr nz, .draw_gfx
 
 	ld hl, wSpriteAnimDict
-	ld a, $21
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_BUBBLE
 	ld [hli], a
-	ld a, $00
+	ld a, SPRITE_ANIM_DICT_DEFAULT
 	ld [hli], a
 
 	xor a
@@ -357,7 +357,7 @@ Intro_InitBubble:
 	ld e, [hl]
 	inc hl
 	ld d, [hl]
-	ld a, $21	; SPRITE_ANIM_INDEX_GS_INTRO_BUBBLE
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_BUBBLE
 	call InitSpriteAnimStruct
 	ret
 
@@ -407,7 +407,7 @@ Intro_InitMagikarps:
 	ret
 
 .PlaceMagikarp:
-	ld a, $23	; SPRITE_ANIM_INDEX_GS_INTRO_MAGIKARP
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_MAGIKARP
 	call InitSpriteAnimStruct
 	ret
 
@@ -420,7 +420,7 @@ Intro_InitOmanyte:
 ; fallback
 
 .PlaceOmanyte:
-	ld a, $22		; SPRITE_ANIM_INDEX_GS_INTRO_SHELLDER
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_OMANYTE
 	call InitSpriteAnimStruct
 	ret
 
@@ -429,13 +429,13 @@ Intro_InitLapras:
 	and %00011111
 	ret nz
 	depixel 16, 24
-	ld a, $25		; SPRITE_ANIM_INDEX_GS_INTRO_LAPRAS
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_LAPRAS
 	call InitSpriteAnimStruct
 	ret
 
 Intro_UnusedInitAerodactyl:	; unreferenced
 	depixel 2, 0
-	ld a, $24		; SPRITE_ANIM_INDEX_UNUSED_INTRO_AERODACTYL
+	ld a, SPRITE_ANIM_INDEX_UNUSED_INTRO_AERODACTYL
 	call InitSpriteAnimStruct
 	ret
 
@@ -634,9 +634,9 @@ IntroScene6:
 	jr nz, .load
 
 	ld hl, wSpriteAnimDict
-	ld a, $22
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_OMANYTE
 	ld [hli], a
-	ld a, $00
+	ld a, SPRITE_ANIM_DICT_DEFAULT
 	ld [hli], a
 	xor a
 	ldh [hSCY], a
@@ -758,30 +758,30 @@ Intro_InitNote:
 	jr z, .SmallerNote
 
 	depixel 11, 6, 4, 0
-	ld a, $26	; SPRITE_ANIM_INDEX_GS_INTRO_NOTE
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_NOTE
 	call InitSpriteAnimStruct
 	ret
 
 .SmallerNote:
 	depixel 10, 6, 4, 0
-	ld a, $27	; SPRITE_ANIM_INDEX_GS_INTRO_SMALLER_NOTE
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_SMALLER_NOTE
 	call InitSpriteAnimStruct
 	ret
 
 
 Intro_InitJigglypuff:
 	depixel 14, 6
-	ld a, $28	; SPRITE_ANIM_INDEX_GS_INTRO_JIGGLYPUFF
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_JIGGLYPUFF
 	call InitSpriteAnimStruct
 	ret
 
 
 Intro_InitPikachu:
 	depixel 14, 24
-	ld a, $29	; SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU
 	call InitSpriteAnimStruct
 	depixel 14, 24
-	ld a, $2a	; SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU_TAIL
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_PIKACHU_TAIL
 	call InitSpriteAnimStruct
 	ret
 
@@ -812,9 +812,9 @@ IntroScene10:
 	call Request2bpp
 
 	ld hl, wSpriteAnimDict
-	ld a, $22	; SPRITE_ANIM_DICT_GS_INTRO
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_OMANYTE
 	ld [hli], a
-	ld a, $00
+	ld a, SPRITE_ANIM_DICT_DEFAULT
 	ld [hli], a
 
 	ld a, 0
@@ -1129,7 +1129,7 @@ Intro_AnimateFireball:
 	and 3
 	ret nz
 	depixel 12, 10, 4, 4
-	ld a, $2b	; SPRITE_ANIM_INDEX_GS_INTRO_FIREBALL
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_FIREBALL
 	call InitSpriteAnimStruct
 	ld hl, hSCX
 	dec [hl]
@@ -1139,13 +1139,13 @@ Intro_AnimateFireball:
 
 Intro_LoadBlastoiseObject:
 	depixel 22, 1
-	ld a, $2c	; SPRITE_ANIM_INDEX_GS_INTRO_BLASTOISE
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_BLASTOISE
 	call InitSpriteAnimStruct
 	ret
 
 Intro_LoadVenusaurObject:
 	depixel 22, 20
-	ld a, $2d	; SPRITE_ANIM_INDEX_GS_INTRO_VENUSAUR
+	ld a, SPRITE_ANIM_INDEX_GS_INTRO_VENUSAUR
 	call InitSpriteAnimStruct
 	ret
 
diff --git a/engine/movie/title.asm b/engine/movie/title.asm
index 23baa2f..d84d8c5 100644
--- a/engine/movie/title.asm
+++ b/engine/movie/title.asm
@@ -152,7 +152,7 @@ TitleSequenceInit::
 	ld d, [hl]
 	inc hl
 	push hl
-	ld a, $2E ; Title fire/note object effect type?
+	ld a, SPRITE_ANIM_INDEX_GS_TITLE_FLAME_NOTE
 	call InitSpriteAnimStruct
 	pop hl
 	pop bc