Add constants for player and rival starters

14 files changed, 40 insertions, 41 deletions

diff --git a/constants/pokemon_constants.asm b/constants/pokemon_constants.asm
index d01398b8..f5c1c7b8 100644
--- a/constants/pokemon_constants.asm
+++ b/constants/pokemon_constants.asm
@@ -200,10 +200,13 @@
 
 NUM_POKEMON_INDEXES EQU const_value - 1
 
-; starters
-STARTER1 EQU CHARMANDER
-STARTER2 EQU SQUIRTLE
-STARTER3 EQU BULBASAUR
+; player starter
+STARTER_PIKACHU EQU PIKACHU
+
+; rival starters
+RIVAL_STARTER_JOLTEON  EQU 1
+RIVAL_STARTER_FLAREON  EQU 2
+RIVAL_STARTER_VAPOREON EQU 3
 
 ; ghost Marowak in Pokémon Tower
 RESTLESS_SOUL EQU MAROWAK
diff --git a/data/trainers/parties.asm b/data/trainers/parties.asm
index 766a1713..46bbf721 100755
--- a/data/trainers/parties.asm
+++ b/data/trainers/parties.asm
@@ -23,7 +23,7 @@ TrainerDataPointers:
 	dw TamerData
 	dw BirdKeeperData
 	dw BlackbeltData
-	dw Green1Data
+	dw Rival1Data
 	dw ProfOakData
 	dw ChiefData
 	dw ScientistData
@@ -40,8 +40,8 @@ TrainerDataPointers:
 	dw BlaineData
 	dw SabrinaData
 	dw GentlemanData
-	dw Green2Data
-	dw Green3Data
+	dw Rival2Data
+	dw Rival3Data
 	dw LoreleiData
 	dw ChannelerData
 	dw AgathaData
@@ -479,7 +479,7 @@ BlackbeltData:
 ; Victory Road 2F
 	db 43, MACHOKE, MACHOP, MACHOKE, 0
 
-Green1Data:
+Rival1Data:
 	db 5, EEVEE, 0
 ; Route 22
 	db $FF, 9, SPEAROW, 8, EEVEE, 0
@@ -671,7 +671,7 @@ GentlemanData:
 ; SS Anne 2F Rooms
 	db 17, GROWLITHE, PONYTA, 0
 
-Green2Data:
+Rival2Data:
 ; SS Anne 2F
 	db $FF, 19, SPEAROW, 16, RATTATA, 18, SANDSHREW, 20, EEVEE, 0
 ; Pokémon Tower 2F
@@ -687,7 +687,7 @@ Green2Data:
 	db $FF, 47, SANDSLASH, 45, EXEGGCUTE, 45, CLOYSTER, 47, MAGNETON, 50, KADABRA, 53, FLAREON, 0
 	db $FF, 47, SANDSLASH, 45, EXEGGCUTE, 45, MAGNETON, 47, NINETALES, 50, KADABRA, 53, VAPOREON, 0
 
-Green3Data:
+Rival3Data:
 	db $FF, 61, SANDSLASH, 59, ALAKAZAM, 61, EXEGGUTOR, 61, CLOYSTER, 63, NINETALES, 65, JOLTEON, 0
 	db $FF, 61, SANDSLASH, 59, ALAKAZAM, 61, EXEGGUTOR, 61, MAGNETON, 63, CLOYSTER, 65, FLAREON, 0
 	db $FF, 61, SANDSLASH, 59, ALAKAZAM, 61, EXEGGUTOR, 61, NINETALES, 63, MAGNETON, 65, VAPOREON, 0
diff --git a/engine/debug/debug_party.asm b/engine/debug/debug_party.asm
index 637482eb..67a27710 100644
--- a/engine/debug/debug_party.asm
+++ b/engine/debug/debug_party.asm
@@ -17,7 +17,7 @@ DebugTeam:
 	db SNORLAX, 80
 	db PERSIAN, 80
 	db JIGGLYPUFF, 15
-	db PIKACHU, 5
+	db STARTER_PIKACHU, 5
 	db -1 ; end
 
 DebugStart:
@@ -75,13 +75,13 @@ IF DEF(_DEBUG)
 	call DebugSetPokedexEntries
 	SetEvent EVENT_GOT_POKEDEX
 
-	; Player chose Pikachu.
+	; Rival chose Jolteon.
 	ld hl, wRivalStarter
-	ld a, 1
+	ld a, RIVAL_STARTER_JOLTEON
 	ld [hli], a
 	ld a, NUM_POKEMON
 	ld [hli], a ; hl = wUnknownDebugByte
-	ld a, PIKACHU
+	ld a, STARTER_PIKACHU
 	ld [hl], a ; hl = wPlayerStarter
 
 	; Give max money.
diff --git a/engine/menus/start_sub_menus.asm b/engine/menus/start_sub_menus.asm
index b9751e1e..c054761c 100755
--- a/engine/menus/start_sub_menus.asm
+++ b/engine/menus/start_sub_menus.asm
@@ -169,7 +169,7 @@ StartMenu_Pokemon::
 	res 1, [hl]
 	jp z, .loop
 	ld a, [wcf91]
-	cp PIKACHU ; is this surfing pikachu?
+	cp STARTER_PIKACHU
 	jr z, .surfingPikachu
 	ld a, $1
 	jr .continue
diff --git a/engine/movie/oak_speech/oak_speech.asm b/engine/movie/oak_speech/oak_speech.asm
index 1a327def..7acbd693 100755
--- a/engine/movie/oak_speech/oak_speech.asm
+++ b/engine/movie/oak_speech/oak_speech.asm
@@ -72,7 +72,7 @@ OakSpeech:
 	call PrintText
 	call GBFadeOutToWhite
 	call ClearScreen
-	ld a, PIKACHU
+	ld a, STARTER_PIKACHU
 	ld [wd0b5], a
 	ld [wcf91], a
 	call GetMonHeader
diff --git a/engine/movie/title_rb.asm b/engine/movie/title_rb.asm
index df630b53..597684df 100755
--- a/engine/movie/title_rb.asm
+++ b/engine/movie/title_rb.asm
@@ -92,11 +92,11 @@ TitleBallYTable:
 TitleScreenAnimateBallIfStarterOut:
 ; Animate the TitleBall if a starter just got scrolled out.
 	ld a, [wTitleScreenScene]
-	cp STARTER1
+	cp CHARMANDER ; starter 1
 	jr z, .ok
-	cp STARTER2
+	cp SQUIRTLE ; starter 2
 	jr z, .ok
-	cp STARTER3
+	cp BULBASAUR ; starter 3
 	ret nz
 .ok
 	ld e, 1 ; animate titleball
diff --git a/engine/pikachu/pikachu_emotions.asm b/engine/pikachu/pikachu_emotions.asm
index 61db6e80..f4963f17 100755
--- a/engine/pikachu/pikachu_emotions.asm
+++ b/engine/pikachu/pikachu_emotions.asm
@@ -381,7 +381,7 @@ IsPlayerPikachuAsleepInParty:
 	ld a, [hl]
 	cp $ff
 	jr z, .done
-	cp PIKACHU
+	cp STARTER_PIKACHU
 	jr nz, .curMonNotStarterPikachu
 	callfar IsThisPartymonStarterPikachu
 	jr nc, .curMonNotStarterPikachu
diff --git a/engine/pikachu/pikachu_status.asm b/engine/pikachu/pikachu_status.asm
index c73d3b3f..5fc92ead 100755
--- a/engine/pikachu/pikachu_status.asm
+++ b/engine/pikachu/pikachu_status.asm
@@ -9,7 +9,7 @@ IsStarterPikachuInOurParty::
 	push hl
 	inc a
 	jr z, .noPlayerPikachu
-	cp PIKACHU + 1
+	cp STARTER_PIKACHU + 1
 	jr nz, .curMonNotPlayerPikachu
 	ld h, d
 	ld l, e
@@ -79,7 +79,7 @@ asm_fce21:
 	ld a, [wWhichPokemon]
 	call AddNTimes
 	ld a, [hl]
-	cp PIKACHU
+	cp STARTER_PIKACHU
 	jr nz, .notPlayerPikachu
 	ld bc, wPartyMon1OTID - wPartyMon1
 	add hl, bc
@@ -189,7 +189,7 @@ IsSurfingPikachuInThePlayersParty::
 	push hl
 	inc a
 	jr z, .noSurfingPlayerPikachu
-	cp PIKACHU+1
+	cp STARTER_PIKACHU + 1
 	jr nz, .curMonNotSurfingPlayerPikachu
 	ld h, d
 	ld l, e
diff --git a/home/map_objects.asm b/home/map_objects.asm
index 51206cc5..a54e8f31 100644
--- a/home/map_objects.asm
+++ b/home/map_objects.asm
@@ -81,7 +81,7 @@ IsSurfingPikachuInParty::
 	ld b, SURF
 .loop
 	ld a, [hl]
-	cp PIKACHU
+	cp STARTER_PIKACHU
 	jr nz, .notPikachu
 	push hl
 	ld de, $8
diff --git a/home/text.asm b/home/text.asm
index 70fade56..3b6e229c 100644
--- a/home/text.asm
+++ b/home/text.asm
@@ -553,7 +553,7 @@ TextCommandSounds::
 	db TX_SOUND_GET_ITEM_2,           SFX_GET_ITEM_2
 	db TX_SOUND_GET_KEY_ITEM,         SFX_GET_KEY_ITEM
 	db TX_SOUND_DEX_PAGE_ADDED,       SFX_DEX_PAGE_ADDED
-	db TX_SOUND_CRY_PIKACHU,          PIKACHU ; used in OakSpeech
+	db TX_SOUND_CRY_PIKACHU,          STARTER_PIKACHU ; used in OakSpeech
 	db TX_SOUND_CRY_PIDGEOT,          PIDGEOT ; used in SaffronCityText12
 	db TX_SOUND_CRY_DEWGONG,          DEWGONG ; unused
 
diff --git a/scripts/OaksLab.asm b/scripts/OaksLab.asm
index 0d995a66..3d9fde89 100755
--- a/scripts/OaksLab.asm
+++ b/scripts/OaksLab.asm
@@ -226,7 +226,7 @@ OaksLabScript9:
 	ld a, SPRITE_FACING_UP
 	ldh [hSpriteFacingDirection], a
 	call SetSpriteFacingDirectionAndDelay
-	ld a, 1
+	ld a, RIVAL_STARTER_JOLTEON
 	ld [wRivalStarter], a
 	ld a, EEVEE
 	ld [wd11e], a
@@ -371,10 +371,10 @@ OaksLabScript14:
 	; Otherwise, it will evolve into Vaporeon.
 	ld a, [wBattleResult]
 	and a
-	ld b, $3
-	jr nz, .asm_1c660
-	ld b, $2
-.asm_1c660
+	ld b, RIVAL_STARTER_VAPOREON
+	jr nz, .got_rival_starter
+	ld b, RIVAL_STARTER_FLAREON
+.got_rival_starter
 	ld a, b
 	ld [wRivalStarter], a
 
@@ -1009,7 +1009,7 @@ OaksLabRivalTakesText5:
 
 OaksLabText18:
 	text_asm
-	ld a, PIKACHU
+	ld a, STARTER_PIKACHU
 	ld [wPlayerStarter], a
 	ld [wd11e], a
 	call GetMonName
@@ -1023,7 +1023,7 @@ OaksLabText18:
 	ld [wMonDataLocation], a
 	ld a, 5
 	ld [wCurEnemyLVL], a
-	ld a, PIKACHU
+	ld a, STARTER_PIKACHU
 	ld [wd11e], a
 	ld [wcf91], a
 	call AddPartyMon
diff --git a/scripts/PalletTown.asm b/scripts/PalletTown.asm
index 45a675e7..e7cc1f7a 100755
--- a/scripts/PalletTown.asm
+++ b/scripts/PalletTown.asm
@@ -141,7 +141,7 @@ PalletTownScript4:
 	ld [wListScrollOffset], a
 	ld a, BATTLE_TYPE_PIKACHU
 	ld [wBattleType], a
-	ld a, PIKACHU
+	ld a, STARTER_PIKACHU
 	ld [wCurOpponent], a
 	ld a, 5
 	ld [wCurEnemyLVL], a
diff --git a/scripts/Route22.asm b/scripts/Route22.asm
index 5dfdc67e..4ffeff23 100755
--- a/scripts/Route22.asm
+++ b/scripts/Route22.asm
@@ -148,11 +148,11 @@ Route22Script2:
 	cp $ff
 	jp z, Route22Script_50ece
 	ld a, [wRivalStarter]
-	cp 2
-	jr nz, .asm_50fc9
-	ld a, $1
+	cp RIVAL_STARTER_FLAREON
+	jr nz, .keep_rival_starter
+	ld a, RIVAL_STARTER_JOLTEON
 	ld [wRivalStarter], a
-.asm_50fc9
+.keep_rival_starter
 	ld a, [wSpritePlayerStateData1FacingDirection]
 	and a ; cp SPRITE_FACING_DOWN
 	jr nz, .notDown
diff --git a/wram.asm b/wram.asm
index 474b9c30..0059398b 100755
--- a/wram.asm
+++ b/wram.asm
@@ -1055,8 +1055,6 @@ wHoFTeamIndex::
 wSSAnneSmokeDriftAmount::
 ; multiplied by 16 to get the number of times to go right by 2 pixels
 
-wRivalStarterTemp::
-
 wBoxMonCounts::
 ; 12 bytes
 ; array of the number of mons in each box
@@ -1153,8 +1151,6 @@ wBattleTransitionCircleScreenQuadrantX::
 
 wSSAnneSmokeX::
 
-wRivalStarterBallSpriteIndex::
-
 wDayCareNumLevelsGrown::
 
 wOptionsBattleAnimCursorX::