Add macros, constants, and labels for map scripts and text (#367)

This introduces `def_script_pointers`, `def_text_pointers`, and `object_const_def` macros, and applies them to all maps. Most other map labels have also been identified.

1 files changed, 99 insertions, 97 deletions

diff --git a/scripts/Route24.asm b/scripts/Route24.asm
index 5cbb78a6..8fa9dd20 100644
--- a/scripts/Route24.asm
+++ b/scripts/Route24.asm
@@ -7,29 +7,30 @@ Route24_Script:
 	ld [wRoute24CurScript], a
 	ret
 
-Route24Script_513c0:
-	xor a
+Route24SetDefaultScript:
+	xor a ; SCRIPT_ROUTE24_DEFAULT
 	ld [wJoyIgnore], a
 	ld [wRoute24CurScript], a
 	ld [wCurMapScript], a
 	ret
 
 Route24_ScriptPointers:
-	dw Route24Script0
-	dw DisplayEnemyTrainerTextAndStartBattle
-	dw EndTrainerBattle
-	dw Route24Script3
-	dw Route24Script4
+	def_script_pointers
+	dw_const Route24DefaultScript,                  SCRIPT_ROUTE24_DEFAULT
+	dw_const DisplayEnemyTrainerTextAndStartBattle, SCRIPT_ROUTE24_START_BATTLE
+	dw_const EndTrainerBattle,                      SCRIPT_ROUTE24_END_BATTLE
+	dw_const Route24AfterRocketBattleScript,        SCRIPT_ROUTE24_AFTER_ROCKET_BATTLE
+	dw_const Route24PlayerMovingScript,             SCRIPT_ROUTE24_PLAYER_MOVING
 
-Route24Script0:
+Route24DefaultScript:
 	CheckEvent EVENT_GOT_NUGGET
 	jp nz, CheckFightingMapTrainers
-	ld hl, CoordsData_5140e
+	ld hl, .PlayerCoordsArray
 	call ArePlayerCoordsInArray
 	jp nc, CheckFightingMapTrainers
 	xor a
 	ldh [hJoyHeld], a
-	ld a, $1
+	ld a, TEXT_ROUTE24_COOLTRAINER_M1
 	ldh [hSpriteIndexOrTextID], a
 	call DisplayTextID
 	CheckAndResetEvent EVENT_NUGGET_REWARD_AVAILABLE
@@ -39,89 +40,90 @@ Route24Script0:
 	ld a, $1
 	ld [wSimulatedJoypadStatesIndex], a
 	call StartSimulatingJoypadStates
-	ld a, $4
+	ld a, SCRIPT_ROUTE24_PLAYER_MOVING
 	ld [wRoute24CurScript], a
 	ld [wCurMapScript], a
 	ret
 
-CoordsData_5140e:
+.PlayerCoordsArray:
 	dbmapcoord 10, 15
 	db -1 ; end
 
-Route24Script4:
+Route24PlayerMovingScript:
 	ld a, [wSimulatedJoypadStatesIndex]
 	and a
 	ret nz
 	call Delay3
-	ld a, $0
+	ld a, SCRIPT_ROUTE24_DEFAULT
 	ld [wRoute24CurScript], a
 	ld [wCurMapScript], a
 	ret
 
-Route24Script3:
+Route24AfterRocketBattleScript:
 	ld a, [wIsInBattle]
 	cp $ff
-	jp z, Route24Script_513c0
+	jp z, Route24SetDefaultScript
 	call UpdateSprites
-	ld a, $f0
+	ld a, D_RIGHT | D_LEFT | D_UP | D_DOWN
 	ld [wJoyIgnore], a
 	SetEvent EVENT_BEAT_ROUTE24_ROCKET
-	ld a, $1
+	ld a, TEXT_ROUTE24_COOLTRAINER_M1
 	ldh [hSpriteIndexOrTextID], a
 	call DisplayTextID
 	xor a
 	ld [wJoyIgnore], a
-	ld a, $0
+	ld a, SCRIPT_ROUTE24_DEFAULT
 	ld [wRoute24CurScript], a
 	ld [wCurMapScript], a
 	ret
 
 Route24_TextPointers:
-	dw Route24Text1
-	dw Route24Text2
-	dw Route24Text3
-	dw Route24Text4
-	dw Route24Text5
-	dw Route24Text6
-	dw Route24Text7
-	dw PickUpItemText
+	def_text_pointers
+	dw_const Route24CooltrainerM1Text, TEXT_ROUTE24_COOLTRAINER_M1
+	dw_const Route24CooltrainerM2Text, TEXT_ROUTE24_COOLTRAINER_M2
+	dw_const Route24CooltrainerM3Text, TEXT_ROUTE24_COOLTRAINER_M3
+	dw_const Route24CooltrainerF1Text, TEXT_ROUTE24_COOLTRAINER_F1
+	dw_const Route24Youngster1Text,    TEXT_ROUTE24_YOUNGSTER_1
+	dw_const Route24CooltrainerF2Text, TEXT_ROUTE24_COOLTRAINER_F2
+	dw_const Route24Youngster2Text,    TEXT_ROUTE24_YOUNGSTER_2
+	dw_const PickUpItemText,           TEXT_ROUTE24_TM_THUNDER_WAVE
 
 Route24TrainerHeaders:
 	def_trainers 2
 Route24TrainerHeader0:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_0, 4, Route24BattleText1, Route24EndBattleText1, Route24AfterBattleText1
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_0, 4, Route24CooltrainerM2BattleText, Route24CooltrainerM2EndBattleText, Route24CooltrainerM2AfterBattleText
 Route24TrainerHeader1:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_1, 1, Route24BattleText2, Route24EndBattleText2, Route24AfterBattleText2
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_1, 1, Route24CooltrainerM3BattleText, Route24CooltrainerM3EndBattleText, Route24CooltrainerM3AfterBattleText
 Route24TrainerHeader2:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_2, 1, Route24BattleText3, Route24EndBattleText3, Route24AfterBattleText3
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_2, 1, Route24CooltrainerF1BattleText, Route24CooltrainerF1EndBattleText, Route24CooltrainerF1AfterBattleText
 Route24TrainerHeader3:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_3, 1, Route24BattleText4, Route24EndBattleText4, Route24AfterBattleText4
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_3, 1, Route24Youngster1BattleText, Route24Youngster1EndBattleText, Route24Youngster1AfterBattleText
 Route24TrainerHeader4:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_4, 1, Route24BattleText5, Route24EndBattleText5, Route24AfterBattleText5
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_4, 1, Route24CooltrainerF2BattleText, Route24CooltrainerF2EndBattleText, Route24CooltrainerF2AfterBattleText
 Route24TrainerHeader5:
-	trainer EVENT_BEAT_ROUTE_24_TRAINER_5, 1, Route24BattleText6, Route24EndBattleText6, Route24AfterBattleText6
+	trainer EVENT_BEAT_ROUTE_24_TRAINER_5, 1, Route24Youngster2BattleText, Route24Youngster2EndBattleText, Route24Youngster2AfterBattleText
 	db -1 ; end
 
-Route24Text1:
+Route24CooltrainerM1Text:
 	text_asm
 	ResetEvent EVENT_NUGGET_REWARD_AVAILABLE
 	CheckEvent EVENT_GOT_NUGGET
 	jr nz, .got_item
-	ld hl, Route24Text_51510
+	ld hl, .YouBeatOurContestText
 	call PrintText
 	lb bc, NUGGET, 1
 	call GiveItem
 	jr nc, .bag_full
 	SetEvent EVENT_GOT_NUGGET
-	ld hl, Route24Text_5151a
+	ld hl, .ReceivedNuggetText
 	call PrintText
-	ld hl, Route24Text_51526
+	ld hl, .JoinTeamRocketText
 	call PrintText
 	ld hl, wd72d
 	set 6, [hl]
 	set 7, [hl]
-	ld hl, Route24Text_5152b
-	ld de, Route24Text_5152b
+	ld hl, .DefeatedText
+	ld de, .DefeatedText
 	call SaveEndBattleTextPointers
 	ldh a, [hSpriteIndexOrTextID]
 	ld [wSpriteIndex], a
@@ -129,152 +131,152 @@ Route24Text1:
 	call InitBattleEnemyParameters
 	xor a
 	ldh [hJoyHeld], a
-	ld a, $3
+	ld a, SCRIPT_ROUTE24_AFTER_ROCKET_BATTLE
 	ld [wRoute24CurScript], a
 	ld [wCurMapScript], a
 	jp TextScriptEnd
 .got_item
-	ld hl, Route24Text_51530
+	ld hl, .YouCouldBecomeATopLeaderText
 	call PrintText
 	jp TextScriptEnd
 .bag_full
-	ld hl, Route24Text_51521
+	ld hl, .NoRoomText
 	call PrintText
 	SetEvent EVENT_NUGGET_REWARD_AVAILABLE
 	jp TextScriptEnd
 
-Route24Text_51510:
-	text_far _Route24Text_51510
+.YouBeatOurContestText:
+	text_far _Route24CooltrainerM1YouBeatOurContestText
 	sound_get_item_1
-	text_far _Route24Text_51515
+	text_far _Route24CooltrainerM1YouJustEarnedAPrizeText
 	text_end
 
-Route24Text_5151a:
-	text_far _Route24Text_5151a
+.ReceivedNuggetText:
+	text_far _Route24CooltrainerM1ReceivedNuggetText
 	sound_get_item_1
 	text_promptbutton
 	text_end
 
-Route24Text_51521:
-	text_far _Route24Text_51521
+.NoRoomText:
+	text_far _Route24CooltrainerM1NoRoomText
 	text_end
 
-Route24Text_51526:
-	text_far _Route24Text_51526
+.JoinTeamRocketText:
+	text_far _Route24CooltrainerM1JoinTeamRocketText
 	text_end
 
-Route24Text_5152b:
-	text_far _Route24Text_5152b
+.DefeatedText:
+	text_far _Route24CooltrainerM1DefeatedText
 	text_end
 
-Route24Text_51530:
-	text_far _Route24Text_51530
+.YouCouldBecomeATopLeaderText:
+	text_far _Route24CooltrainerM1YouCouldBecomeATopLeaderText
 	text_end
 
-Route24Text2:
+Route24CooltrainerM2Text:
 	text_asm
 	ld hl, Route24TrainerHeader0
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24Text3:
+Route24CooltrainerM3Text:
 	text_asm
 	ld hl, Route24TrainerHeader1
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24Text4:
+Route24CooltrainerF1Text:
 	text_asm
 	ld hl, Route24TrainerHeader2
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24Text5:
+Route24Youngster1Text:
 	text_asm
 	ld hl, Route24TrainerHeader3
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24Text6:
+Route24CooltrainerF2Text:
 	text_asm
 	ld hl, Route24TrainerHeader4
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24Text7:
+Route24Youngster2Text:
 	text_asm
 	ld hl, Route24TrainerHeader5
 	call TalkToTrainer
 	jp TextScriptEnd
 
-Route24BattleText1:
-	text_far _Route24BattleText1
+Route24CooltrainerM2BattleText:
+	text_far _Route24CooltrainerM2BattleText
 	text_end
 
-Route24EndBattleText1:
-	text_far _Route24EndBattleText1
+Route24CooltrainerM2EndBattleText:
+	text_far _Route24CooltrainerM2EndBattleText
 	text_end
 
-Route24AfterBattleText1:
-	text_far _Route24AfterBattleText1
+Route24CooltrainerM2AfterBattleText:
+	text_far _Route24CooltrainerM2AfterBattleText
 	text_end
 
-Route24BattleText2:
-	text_far _Route24BattleText2
+Route24CooltrainerM3BattleText:
+	text_far _Route24CooltrainerM3BattleText
 	text_end
 
-Route24EndBattleText2:
-	text_far _Route24EndBattleText2
+Route24CooltrainerM3EndBattleText:
+	text_far _Route24CooltrainerM3EndBattleText
 	text_end
 
-Route24AfterBattleText2:
-	text_far _Route24AfterBattleText2
+Route24CooltrainerM3AfterBattleText:
+	text_far _Route24CooltrainerM3AfterBattleText
 	text_end
 
-Route24BattleText3:
-	text_far _Route24BattleText3
+Route24CooltrainerF1BattleText:
+	text_far _Route24CooltrainerF1BattleText
 	text_end
 
-Route24EndBattleText3:
-	text_far _Route24EndBattleText3
+Route24CooltrainerF1EndBattleText:
+	text_far _Route24CooltrainerF1EndBattleText
 	text_end
 
-Route24AfterBattleText3:
-	text_far _Route24AfterBattleText3
+Route24CooltrainerF1AfterBattleText:
+	text_far _Route24CooltrainerF1AfterBattleText
 	text_end
 
-Route24BattleText4:
-	text_far _Route24BattleText4
+Route24Youngster1BattleText:
+	text_far _Route24Youngster1BattleText
 	text_end
 
-Route24EndBattleText4:
-	text_far _Route24EndBattleText4
+Route24Youngster1EndBattleText:
+	text_far _Route24Youngster1EndBattleText
 	text_end
 
-Route24AfterBattleText4:
-	text_far _Route24AfterBattleText4
+Route24Youngster1AfterBattleText:
+	text_far _Route24Youngster1AfterBattleText
 	text_end
 
-Route24BattleText5:
-	text_far _Route24BattleText5
+Route24CooltrainerF2BattleText:
+	text_far _Route24CooltrainerF2BattleText
 	text_end
 
-Route24EndBattleText5:
-	text_far _Route24EndBattleText5
+Route24CooltrainerF2EndBattleText:
+	text_far _Route24CooltrainerF2EndBattleText
 	text_end
 
-Route24AfterBattleText5:
-	text_far _Route24AfterBattleText5
+Route24CooltrainerF2AfterBattleText:
+	text_far _Route24CooltrainerF2AfterBattleText
 	text_end
 
-Route24BattleText6:
-	text_far _Route24BattleText6
+Route24Youngster2BattleText:
+	text_far _Route24Youngster2BattleText
 	text_end
 
-Route24EndBattleText6:
-	text_far _Route24EndBattleText6
+Route24Youngster2EndBattleText:
+	text_far _Route24Youngster2EndBattleText
 	text_end
 
-Route24AfterBattleText6:
-	text_far _Route24AfterBattleText6
+Route24Youngster2AfterBattleText:
+	text_far _Route24Youngster2AfterBattleText
 	text_end