Documentation for start-of-credits script

11 files changed, 43 insertions, 25 deletions

diff --git a/data/event_scripts.s b/data/event_scripts.s
index 4f4603505..070c653df 100644
--- a/data/event_scripts.s
+++ b/data/event_scripts.s
@@ -3897,7 +3897,7 @@ EventScript_1A8CAD:: @ 81A8CAD
 	return
 
 EventScript_1A8CBD:: @ 81A8CBD
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	lock
 	faceplayer
diff --git a/data/maps/CinnabarIsland_PokemonLab_Lounge/scripts.inc b/data/maps/CinnabarIsland_PokemonLab_Lounge/scripts.inc
index ad0fce530..af25aef3b 100644
--- a/data/maps/CinnabarIsland_PokemonLab_Lounge/scripts.inc
+++ b/data/maps/CinnabarIsland_PokemonLab_Lounge/scripts.inc
@@ -55,7 +55,7 @@ CinnabarIsland_PokemonLab_Lounge_EventScript_16E33E:: @ 816E33E
 	msgbox gUnknown_81A5AD6, MSGBOX_YESNO
 	compare_var_to_value VAR_RESULT, 0
 	goto_if eq, EventScript_16E3BC
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	copyvar VAR_0x800A, VAR_0x8004
 	compare_var_to_value VAR_0x8004, 6
diff --git a/data/maps/FuchsiaCity_House3/scripts.inc b/data/maps/FuchsiaCity_House3/scripts.inc
index 6d7e033d8..8cf131bcb 100644
--- a/data/maps/FuchsiaCity_House3/scripts.inc
+++ b/data/maps/FuchsiaCity_House3/scripts.inc
@@ -12,7 +12,7 @@ FuchsiaCity_House3_EventScript_16D895:: @ 816D895
 
 EventScript_16D8B0:: @ 816D8B0
 	msgbox gUnknown_8199421
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	compare_var_to_value VAR_0x8004, 6
 	goto_if ge, EventScript_16D941
@@ -24,7 +24,7 @@ EventScript_16D8B0:: @ 816D8B0
 	goto_if eq, EventScript_16D92A
 	msgbox gUnknown_8199445
 	fadescreen 1
-	special sub_80BF9BC
+	special Special_ChooseMoveToDelete
 	fadescreen 0
 	compare_var_to_value VAR_0x8005, 4
 	goto_if eq, EventScript_16D8B0
@@ -36,7 +36,7 @@ EventScript_16D8B0:: @ 816D8B0
 	end
 
 EventScript_16D919:: @ 816D919
-	special sub_80BFBA8
+	special Special_DeleteSelectedMove
 	playfanfare MUS_ME_WASURE
 	waitfanfare
 	msgbox gUnknown_81994B1
diff --git a/data/maps/IndigoPlateau_Exterior/scripts.inc b/data/maps/IndigoPlateau_Exterior/scripts.inc
index aaeb0436f..01f9f6a62 100644
--- a/data/maps/IndigoPlateau_Exterior/scripts.inc
+++ b/data/maps/IndigoPlateau_Exterior/scripts.inc
@@ -6,33 +6,43 @@ IndigoPlateau_Exterior_MapScripts:: @ 816723B
 IndigoPlateau_Exterior_MapScript1_167246:: @ 8167246
 	setworldmapflag FLAG_WORLD_MAP_INDIGO_PLATEAU_EXTERIOR
 	compare_var_to_value VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR, 1
-	call_if eq, EventScript_167255
+	call_if eq, EventScript_IndigoPlateau_Exterior_PlayCreditsMusic
 	end
 
-EventScript_167255:: @ 8167255
+EventScript_IndigoPlateau_Exterior_PlayCreditsMusic:: @ 8167255
 	playbgm MUS_ENDING, 0
 	return
 
 IndigoPlateau_Exterior_MapScript2_16725A:: @ 816725A
-	map_script_2 VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR, 1, EventScript_167264
+	map_script_2 VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR, 1, EventScript_IndigoPlateau_Exterior_Credits
 	.2byte 0
 
-EventScript_167264:: @ 8167264
+EventScript_IndigoPlateau_Exterior_Credits:: @ 8167264
+	@ After beating the champion, you are warped to the main
+	@ entrance of Indigo Plateau. This script starts running
+	@ immediately after your walking animation.
+	@ The script is timed to the music.
 	lockall
 	delay 105
+
+	@ Rival exits building. Spawn a dummy object to lock the camera.
 	opendoor 11, 6
 	waitdooranim
-	special SpawnScriptFieldObject
+	special SpawnCameraObject
 	addobject 1
 	applymovement 1, Movement_167346
 	applymovement 255, Movement_167337
 	waitmovement 0
 	closedoor 11, 6
 	waitdooranim
+
+	@ Rival runs off
 	applymovement 255, Movement_16731B
 	applymovement 1, Movement_16733E
 	waitmovement 0
 	delay 100
+
+	@ Oak exits building
 	opendoor 11, 6
 	waitdooranim
 	addobject 2
@@ -41,6 +51,8 @@ EventScript_167264:: @ 8167264
 	closedoor 11, 6
 	waitdooranim
 	delay 160
+
+	@ Oak looks at player, then walks off
 	applymovement 255, Movement_16731F
 	applymovement 2, Movement_167348
 	waitmovement 0
@@ -48,18 +60,24 @@ EventScript_167264:: @ 8167264
 	applymovement 255, Movement_16732E
 	waitmovement 0
 	delay 155
+
+	@ Player turns to face the League
 	applymovement 255, Movement_16733C
 	waitmovement 0
 	delay 90
+
+	@ Player runs off
 	applymovement 255, Movement_167335
 	waitmovement 0
 	applymovement 255, Movement_167311
 	waitmovement 0
-	special RemoveScriptFieldObject
+
+	@ Reset the map state and roll the credits
+	special RemoveCameraObject
 	setvar VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR, 0
 	removeobject 1
 	removeobject 2
-	special Special_Credits
+	special Special_Credits @ noreturn
 	waitstate
 	releaseall
 	end
diff --git a/data/maps/LavenderTown_House2/scripts.inc b/data/maps/LavenderTown_House2/scripts.inc
index 6495e7102..92873c254 100644
--- a/data/maps/LavenderTown_House2/scripts.inc
+++ b/data/maps/LavenderTown_House2/scripts.inc
@@ -13,7 +13,7 @@ LavenderTown_House2_EventScript_16B266:: @ 816B266
 
 EventScript_16B287:: @ 816B287
 	msgbox gUnknown_8193AA6
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	compare_var_to_value VAR_0x8004, 6
 	goto_if lt, EventScript_16B2B4
diff --git a/data/maps/NavelRock_Summit/scripts.inc b/data/maps/NavelRock_Summit/scripts.inc
index d2ea28c16..ba65881ce 100644
--- a/data/maps/NavelRock_Summit/scripts.inc
+++ b/data/maps/NavelRock_Summit/scripts.inc
@@ -42,7 +42,7 @@ NavelRock_Summit_EventScript_164FFB:: @ 8164FFB
 	special sub_8112364
 	lockall
 	setvar VAR_0x4001, 1
-	special SpawnScriptFieldObject
+	special SpawnCameraObject
 	setvar VAR_0x8004, 3
 	setvar VAR_0x8005, 35
 	special sub_80CD1B4
@@ -63,7 +63,7 @@ NavelRock_Summit_EventScript_164FFB:: @ 8164FFB
 	applymovement 127, Movement_1650D1
 	applymovement 1, Movement_1650D7
 	waitmovement 0
-	special RemoveScriptFieldObject
+	special RemoveCameraObject
 	setvar VAR_0x8004, SPECIES_HO_OH
 	setvar VAR_0x8005, 70
 	setvar VAR_0x8006, 0
diff --git a/data/maps/PalletTown_GarysHouse/scripts.inc b/data/maps/PalletTown_GarysHouse/scripts.inc
index 5984c6e87..af5e6985b 100644
--- a/data/maps/PalletTown_GarysHouse/scripts.inc
+++ b/data/maps/PalletTown_GarysHouse/scripts.inc
@@ -55,7 +55,7 @@ EventScript_168DB9:: @ 8168DB9
 	compare_var_to_value VAR_RESULT, 0
 	goto_if eq, EventScript_168E3C
 	msgbox gUnknown_818D8B2
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	lock
 	faceplayer
diff --git a/data/maps/Route12_FishingHouse/scripts.inc b/data/maps/Route12_FishingHouse/scripts.inc
index 0b425495a..5f19babef 100644
--- a/data/maps/Route12_FishingHouse/scripts.inc
+++ b/data/maps/Route12_FishingHouse/scripts.inc
@@ -41,7 +41,7 @@ EventScript_16FF7F:: @ 816FF7F
 	goto_if eq, EventScript_16FFF5
 	special sub_80A096C
 	msgbox gUnknown_819F2DB
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	copyvar VAR_RESULT, VAR_0x8004
 	compare_var_to_value VAR_RESULT, 6
diff --git a/data/maps/Route25_SeaCottage/scripts.inc b/data/maps/Route25_SeaCottage/scripts.inc
index 254b3cbe6..b3c8e79ed 100644
--- a/data/maps/Route25_SeaCottage/scripts.inc
+++ b/data/maps/Route25_SeaCottage/scripts.inc
@@ -171,7 +171,7 @@ EventScript_1706FA:: @ 81706FA
 	closemessage
 	clearflag FLAG_TEMP_2
 	setflag FLAG_HELPED_BILL_IN_SEA_COTTAGE
-	special SpawnScriptFieldObject
+	special SpawnCameraObject
 	applymovement 127, Movement_1707BE
 	waitmovement 0
 	delay 35
@@ -214,7 +214,7 @@ EventScript_1706FA:: @ 81706FA
 	waitdooranim
 	applymovement 1, Movement_170881
 	waitmovement 0
-	special RemoveScriptFieldObject
+	special RemoveCameraObject
 	releaseall
 	end
 
diff --git a/data/maps/SixIsland_WaterPath_House1/scripts.inc b/data/maps/SixIsland_WaterPath_House1/scripts.inc
index ef18ad4b4..4cf4bc960 100644
--- a/data/maps/SixIsland_WaterPath_House1/scripts.inc
+++ b/data/maps/SixIsland_WaterPath_House1/scripts.inc
@@ -14,7 +14,7 @@ SixIsland_WaterPath_House1_EventScript_17206D:: @ 817206D
 	goto_if eq, EventScript_1720E5
 	special sub_80A0918
 	msgbox gUnknown_81A4A3F
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	copyvar VAR_RESULT, VAR_0x8004
 	compare_var_to_value VAR_RESULT, 6
diff --git a/data/specials.inc b/data/specials.inc
index 25ae2a961..13b113bbe 100644
--- a/data/specials.inc
+++ b/data/specials.inc
@@ -168,7 +168,7 @@ gSpecials:: @ 815FD60
 	def_special nullsub_75
 	def_special sub_807F888
 	def_special ChangePokemonNickname
-	def_special sub_80BF8FC
+	def_special Special_ChooseMonToDeleteMove
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special nullsub_75
@@ -229,8 +229,8 @@ gSpecials:: @ 815FD60
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special sub_80BF93C
-	def_special sub_80BF9BC
-	def_special sub_80BFBA8
+	def_special Special_ChooseMoveToDelete
+	def_special Special_DeleteSelectedMove
 	def_special ScrSpecial_GetPokemonNicknameAndMoveName
 	def_special ScrSpecial_CountPokemonMoves
 	def_special sub_80E4634
@@ -284,8 +284,8 @@ gSpecials:: @ 815FD60
 	def_special Special_HallOfFame
 	def_special sub_80CB498
 	def_special nullsub_75
-	def_special SpawnScriptFieldObject
-	def_special RemoveScriptFieldObject
+	def_special SpawnCameraObject
+	def_special RemoveCameraObject
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special nullsub_75