Document cave scripts

1 files changed, 64 insertions, 62 deletions

diff --git a/data/maps/VictoryRoad_1F/scripts.inc b/data/maps/VictoryRoad_1F/scripts.inc
index 9b7c00c62..6536be934 100644
--- a/data/maps/VictoryRoad_1F/scripts.inc
+++ b/data/maps/VictoryRoad_1F/scripts.inc
@@ -4,45 +4,45 @@ VictoryRoad_1F_MapScripts:: @ 8235D7A
 
 VictoryRoad_1F_OnTransition: @ 8235D80
 	compare VAR_VICTORY_ROAD_1F_STATE, 1
-	call_if_eq VictoryRoad_1F_EventScript_235D97
+	call_if_eq VictoryRoad_1F_EventScript_SetEntranceWallyPos1
 	compare VAR_VICTORY_ROAD_1F_STATE, 2
-	call_if_eq VictoryRoad_1F_EventScript_235DA3
+	call_if_eq VictoryRoad_1F_EventScript_SetEntranceWallyPos2
 	end
 
-VictoryRoad_1F_EventScript_235D97:: @ 8235D97
+VictoryRoad_1F_EventScript_SetEntranceWallyPos1:: @ 8235D97
 	setobjectxyperm 4, 2, 24
 	setobjectmovementtype 4, MOVEMENT_TYPE_FACE_DOWN
 	return
 
-VictoryRoad_1F_EventScript_235DA3:: @ 8235DA3
+VictoryRoad_1F_EventScript_SetEntranceWallyPos2:: @ 8235DA3
 	setobjectxyperm 4, 3, 24
 	setobjectmovementtype 4, MOVEMENT_TYPE_FACE_DOWN
 	return
 
-VictoryRoad_1F_EventScript_235DAF:: @ 8235DAF
+VictoryRoad_1F_EventScript_WallyBattleTrigger1:: @ 8235DAF
 	lockall
 	setvar VAR_0x8008, 1
 	addobject 4
-	applymovement 4, VictoryRoad_1F_Movement_235E15
+	applymovement 4, VictoryRoad_1F_Movement_WallyApproachPlayer1
 	waitmovement 0
-	goto VictoryRoad_1F_EventScript_235DE1
+	goto VictoryRoad_1F_EventScript_WallyEntranceBattle
 	end
 
-VictoryRoad_1F_EventScript_235DC8:: @ 8235DC8
+VictoryRoad_1F_EventScript_WallyBattleTrigger2:: @ 8235DC8
 	lockall
 	setvar VAR_0x8008, 2
 	addobject 4
-	applymovement 4, VictoryRoad_1F_Movement_235E21
+	applymovement 4, VictoryRoad_1F_Movement_WallyApproachPlayer2
 	waitmovement 0
-	goto VictoryRoad_1F_EventScript_235DE1
+	goto VictoryRoad_1F_EventScript_WallyEntranceBattle
 	end
 
-VictoryRoad_1F_EventScript_235DE1:: @ 8235DE1
+VictoryRoad_1F_EventScript_WallyEntranceBattle:: @ 8235DE1
 	applymovement EVENT_OBJ_ID_PLAYER, Common_Movement_WalkInPlaceFastestDown
 	waitmovement 0
-	msgbox VictoryRoad_1F_Text_235EE6, MSGBOX_DEFAULT
-	trainerbattle_no_intro TRAINER_WALLY_1, VictoryRoad_1F_Text_235FFC
-	msgbox VictoryRoad_1F_Text_236020, MSGBOX_DEFAULT
+	msgbox VictoryRoad_1F_Text_WallyNotGoingToLoseAnymore, MSGBOX_DEFAULT
+	trainerbattle_no_intro TRAINER_WALLY_1, VictoryRoad_1F_Text_WallyEntranceDefeat
+	msgbox VictoryRoad_1F_Text_WallyPostEntranceBattle, MSGBOX_DEFAULT
 	clearflag FLAG_HIDE_VICTORY_ROAD_ENTRANCE_WALLY
 	copyobjectxytoperm 4
 	setflag FLAG_DEFEATED_WALLY_VICTORY_ROAD
@@ -50,7 +50,7 @@ VictoryRoad_1F_EventScript_235DE1:: @ 8235DE1
 	releaseall
 	end
 
-VictoryRoad_1F_Movement_235E15: @ 8235E15
+VictoryRoad_1F_Movement_WallyApproachPlayer1: @ 8235E15
 	walk_left
 	walk_left
 	walk_left
@@ -64,7 +64,7 @@ VictoryRoad_1F_Movement_235E15: @ 8235E15
 	walk_up
 	step_end
 
-VictoryRoad_1F_Movement_235E21: @ 8235E21
+VictoryRoad_1F_Movement_WallyApproachPlayer2: @ 8235E21
 	walk_left
 	walk_left
 	walk_left
@@ -77,49 +77,51 @@ VictoryRoad_1F_Movement_235E21: @ 8235E21
 	walk_up
 	step_end
 
-VictoryRoad_1F_EventScript_235E2C:: @ 8235E2C
-	msgbox VictoryRoad_1F_Text_236020, MSGBOX_NPC
+@ This Wally appears near the entrance once his battle is triggered and remains there until the Hall of Fame is entered
+VictoryRoad_1F_EventScript_EntranceWally:: @ 8235E2C
+	msgbox VictoryRoad_1F_Text_WallyPostEntranceBattle, MSGBOX_NPC
 	end
 
-VictoryRoad_1F_EventScript_235E35:: @ 8235E35
-	trainerbattle_single TRAINER_WALLY_3, VictoryRoad_1F_Text_236073, VictoryRoad_1F_Text_2360DA
+@ This Wally appears and remains at the exit after the Hall of Fame is entered 
+VictoryRoad_1F_EventScript_ExitWally:: @ 8235E35
+	trainerbattle_single TRAINER_WALLY_3, VictoryRoad_1F_Text_WallyIntro, VictoryRoad_1F_Text_WallyDefeat
 	specialvar VAR_RESULT, ShouldTryRematchBattle
-	compare VAR_RESULT, 1
-	goto_if_eq VictoryRoad_1F_EventScript_235E5C
-	msgbox VictoryRoad_1F_Text_2360FE, MSGBOX_AUTOCLOSE
+	compare VAR_RESULT, TRUE
+	goto_if_eq VictoryRoad_1F_EventScript_RematchWally
+	msgbox VictoryRoad_1F_Text_WallyPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235E5C:: @ 8235E5C
-	trainerbattle_rematch TRAINER_WALLY_3, VictoryRoad_1F_Text_236073, VictoryRoad_1F_Text_2360DA
-	msgbox VictoryRoad_1F_Text_2360FE, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_RematchWally:: @ 8235E5C
+	trainerbattle_rematch TRAINER_WALLY_3, VictoryRoad_1F_Text_WallyIntro, VictoryRoad_1F_Text_WallyDefeat
+	msgbox VictoryRoad_1F_Text_WallyPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235E73:: @ 8235E73
-	trainerbattle_single TRAINER_EDGAR, VictoryRoad_1F_Text_236184, VictoryRoad_1F_Text_2361CB
-	msgbox VictoryRoad_1F_Text_2361E5, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_Edgar:: @ 8235E73
+	trainerbattle_single TRAINER_EDGAR, VictoryRoad_1F_Text_EdgarIntro, VictoryRoad_1F_Text_EdgarDefeat
+	msgbox VictoryRoad_1F_Text_EdgarPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235E8A:: @ 8235E8A
-	trainerbattle_single TRAINER_ALBERT, VictoryRoad_1F_Text_236248, VictoryRoad_1F_Text_236290
-	msgbox VictoryRoad_1F_Text_2362A4, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_Albert:: @ 8235E8A
+	trainerbattle_single TRAINER_ALBERT, VictoryRoad_1F_Text_AlbertIntro, VictoryRoad_1F_Text_AlbertDefeat
+	msgbox VictoryRoad_1F_Text_AlbertPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235EA1:: @ 8235EA1
-	trainerbattle_single TRAINER_HOPE, VictoryRoad_1F_Text_2362EE, VictoryRoad_1F_Text_236336
-	msgbox VictoryRoad_1F_Text_236356, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_Hope:: @ 8235EA1
+	trainerbattle_single TRAINER_HOPE, VictoryRoad_1F_Text_HopeIntro, VictoryRoad_1F_Text_HopeDefeat
+	msgbox VictoryRoad_1F_Text_HopePostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235EB8:: @ 8235EB8
-	trainerbattle_single TRAINER_QUINCY, VictoryRoad_1F_Text_236390, VictoryRoad_1F_Text_2363C4
-	msgbox VictoryRoad_1F_Text_2363D5, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_Quincy:: @ 8235EB8
+	trainerbattle_single TRAINER_QUINCY, VictoryRoad_1F_Text_QuincyIntro, VictoryRoad_1F_Text_QuincyDefeat
+	msgbox VictoryRoad_1F_Text_QuincyPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_EventScript_235ECF:: @ 8235ECF
-	trainerbattle_single TRAINER_KATELYNN, VictoryRoad_1F_Text_236468, VictoryRoad_1F_Text_2364A7
-	msgbox VictoryRoad_1F_Text_2364BB, MSGBOX_AUTOCLOSE
+VictoryRoad_1F_EventScript_Katelynn:: @ 8235ECF
+	trainerbattle_single TRAINER_KATELYNN, VictoryRoad_1F_Text_KatelynnIntro, VictoryRoad_1F_Text_KatelynnDefeat
+	msgbox VictoryRoad_1F_Text_KatelynnPostBattle, MSGBOX_AUTOCLOSE
 	end
 
-VictoryRoad_1F_Text_235EE6: @ 8235EE6
+VictoryRoad_1F_Text_WallyNotGoingToLoseAnymore: @ 8235EE6
 	.string "WALLY: Hi! {PLAYER}!\p"
 	.string "I bet you're surprised to see me here!\p"
 	.string "I made it all the way here, and it's\n"
@@ -131,89 +133,89 @@ VictoryRoad_1F_Text_235EE6: @ 8235EE6
 	.string "gave me courage and strength!\p"
 	.string "Okay… Here I come!$"
 
-VictoryRoad_1F_Text_235FFC: @ 8235FFC
+VictoryRoad_1F_Text_WallyEntranceDefeat: @ 8235FFC
 	.string "Wow!\n"
 	.string "{PLAYER}, you are strong, after all!$"
 
-VictoryRoad_1F_Text_236020: @ 8236020
+VictoryRoad_1F_Text_WallyPostEntranceBattle: @ 8236020
 	.string "WALLY: I couldn't beat you today,\n"
 	.string "{PLAYER}, but one of these days, I'll\l"
 	.string "catch up to you!$"
 
-VictoryRoad_1F_Text_236073: @ 8236073
+VictoryRoad_1F_Text_WallyIntro: @ 8236073
 	.string "WALLY: Hi! {PLAYER}!\p"
 	.string "I've gotten stronger since that last\n"
 	.string "time! I wanted to show you, {PLAYER}!\p"
 	.string "Okay… Here I come!$"
 
-VictoryRoad_1F_Text_2360DA: @ 82360DA
+VictoryRoad_1F_Text_WallyDefeat: @ 82360DA
 	.string "Wow!\n"
 	.string "{PLAYER}, you are strong, after all!$"
 
-VictoryRoad_1F_Text_2360FE: @ 82360FE
+VictoryRoad_1F_Text_WallyPostBattle: @ 82360FE
 	.string "WALLY: I couldn't beat you this time,\n"
 	.string "too… But one of these days, {PLAYER},\l"
 	.string "I'm going to catch up to you…\p"
 	.string "And challenge the POKéMON LEAGUE!$"
 
-VictoryRoad_1F_Text_236184: @ 8236184
+VictoryRoad_1F_Text_EdgarIntro: @ 8236184
 	.string "I've made it this far a couple times,\n"
 	.string "but the last stretch is so long…$"
 
-VictoryRoad_1F_Text_2361CB: @ 82361CB
+VictoryRoad_1F_Text_EdgarDefeat: @ 82361CB
 	.string "My dream ends here again…$"
 
-VictoryRoad_1F_Text_2361E5: @ 82361E5
+VictoryRoad_1F_Text_EdgarPostBattle: @ 82361E5
 	.string "You've made it this far. Keep the\n"
 	.string "momentum going and become the\l"
 	.string "CHAMPION! If anyone can, it's you!$"
 
-VictoryRoad_1F_Text_236248: @ 8236248
+VictoryRoad_1F_Text_AlbertIntro: @ 8236248
 	.string "I didn't come all this way to lose now.\n"
 	.string "That possibility doesn't exist!$"
 
-VictoryRoad_1F_Text_236290: @ 8236290
+VictoryRoad_1F_Text_AlbertDefeat: @ 8236290
 	.string "Impossible…\n"
 	.string "I lost?$"
 
-VictoryRoad_1F_Text_2362A4: @ 82362A4
+VictoryRoad_1F_Text_AlbertPostBattle: @ 82362A4
 	.string "I lost here…\p"
 	.string "That means I lack the qualifications\n"
 	.string "to become the CHAMPION…$"
 
-VictoryRoad_1F_Text_2362EE: @ 82362EE
+VictoryRoad_1F_Text_HopeIntro: @ 82362EE
 	.string "This seemingly infinite and harsh road\n"
 	.string "lives up to its name of VICTORY.$"
 
-VictoryRoad_1F_Text_236336: @ 8236336
+VictoryRoad_1F_Text_HopeDefeat: @ 8236336
 	.string "Your battle style is fantastic…$"
 
-VictoryRoad_1F_Text_236356: @ 8236356
+VictoryRoad_1F_Text_HopePostBattle: @ 8236356
 	.string "You seem to have the potential for\n"
 	.string "becoming the CHAMPION.$"
 
-VictoryRoad_1F_Text_236390: @ 8236390
+VictoryRoad_1F_Text_QuincyIntro: @ 8236390
 	.string "What is the VICTORY ROAD?\n"
 	.string "I'll tell you if you win!$"
 
-VictoryRoad_1F_Text_2363C4: @ 82363C4
+VictoryRoad_1F_Text_QuincyDefeat: @ 82363C4
 	.string "Okay!\n"
 	.string "Well done!$"
 
-VictoryRoad_1F_Text_2363D5: @ 82363D5
+VictoryRoad_1F_Text_QuincyPostBattle: @ 82363D5
 	.string "Getting through here safely--that's\n"
 	.string "the final test for any TRAINER aiming\l"
 	.string "to become the POKéMON CHAMPION.\p"
 	.string "That's why it's called the VICTORY\n"
 	.string "ROAD.$"
 
-VictoryRoad_1F_Text_236468: @ 8236468
+VictoryRoad_1F_Text_KatelynnIntro: @ 8236468
 	.string "I have nothing to say to anyone\n"
 	.string "that's come this far. Come on!$"
 
-VictoryRoad_1F_Text_2364A7: @ 82364A7
+VictoryRoad_1F_Text_KatelynnDefeat: @ 82364A7
 	.string "This is a disgrace…$"
 
-VictoryRoad_1F_Text_2364BB: @ 82364BB
+VictoryRoad_1F_Text_KatelynnPostBattle: @ 82364BB
 	.string "Humph, go right on ahead.\n"
 	.string "See if I care.$"