Documentation for start-of-credits script

asm/field_specials.s

@@ -581,8 +581,8 @@ _080CAA2C: .4byte 0x0000028f
 _080CAA30: .4byte gSaveBlock1Ptr
 	thumb_func_end sub_80CA9A8
 
-	thumb_func_start SpawnScriptFieldObject
+	thumb_func_start SpawnCameraObject
-SpawnScriptFieldObject: @ 80CAA34
+SpawnCameraObject: @ 80CAA34
 	push {lr}
 	sub sp, 0x8
 	ldr r0, _080CAA80 @ =gSaveBlock1Ptr
@@ -621,10 +621,10 @@ SpawnScriptFieldObject: @ 80CAA34
 	.align 2, 0
 _080CAA80: .4byte gSaveBlock1Ptr
 _080CAA84: .4byte gMapObjects
-	thumb_func_end SpawnScriptFieldObject
+	thumb_func_end SpawnCameraObject
 
-	thumb_func_start RemoveScriptFieldObject
+	thumb_func_start RemoveCameraObject
-RemoveScriptFieldObject: @ 80CAA88
+RemoveCameraObject: @ 80CAA88
 	push {lr}
 	bl GetPlayerAvatarObjectId
 	lsls r0, 24
@@ -640,7 +640,7 @@ RemoveScriptFieldObject: @ 80CAA88
 	bx r0
 	.align 2, 0
 _080CAAA8: .4byte gSaveBlock1Ptr
-	thumb_func_end RemoveScriptFieldObject
+	thumb_func_end RemoveCameraObject
 
 	thumb_func_start sub_80CAAAC
 sub_80CAAAC: @ 80CAAAC

asm/script_pokemon_util_80BF8FC.s

@@ -5,8 +5,8 @@
 
 	.text
 
-	thumb_func_start sub_80BF8FC
+	thumb_func_start Special_ChooseMonToDeleteMove
-sub_80BF8FC: @ 80BF8FC
+Special_ChooseMonToDeleteMove: @ 80BF8FC
 	push {lr}
 	sub sp, 0x4
 	bl ScriptContext2_Enable
@@ -34,7 +34,7 @@ sub_80BF8FC: @ 80BF8FC
 	.align 2, 0
 _080BF934: .4byte sub_80BF97C
 _080BF938: .4byte gTasks
-	thumb_func_end sub_80BF8FC
+	thumb_func_end Special_ChooseMonToDeleteMove
 
 	thumb_func_start sub_80BF93C
 sub_80BF93C: @ 80BF93C
@@ -100,8 +100,8 @@ _080BF9B4: .4byte gPaletteFade
 _080BF9B8: .4byte gTasks
 	thumb_func_end sub_80BF97C
 
-	thumb_func_start sub_80BF9BC
+	thumb_func_start Special_ChooseMoveToDelete
-sub_80BF9BC: @ 80BF9BC
+Special_ChooseMoveToDelete: @ 80BF9BC
 	push {r4,lr}
 	sub sp, 0x4
 	ldr r0, _080BF9F0 @ =gPlayerParty
@@ -132,7 +132,7 @@ _080BF9F8: .4byte gPlayerPartyCount
 _080BF9FC: .4byte CB2_ReturnToField
 _080BFA00: .4byte gFieldCallback
 _080BFA04: .4byte FieldCallback_ReturnToEventScript2
-	thumb_func_end sub_80BF9BC
+	thumb_func_end Special_ChooseMoveToDelete
 
 	thumb_func_start ScrSpecial_CountPokemonMoves
 ScrSpecial_CountPokemonMoves: @ 80BFA08
@@ -333,8 +333,8 @@ sub_80BFAA8: @ 80BFAA8
 _080BFBA4: .4byte gPPUpGetMask
 	thumb_func_end sub_80BFAA8
 
-	thumb_func_start sub_80BFBA8
+	thumb_func_start Special_DeleteSelectedMove
-sub_80BFBA8: @ 80BFBA8
+Special_DeleteSelectedMove: @ 80BFBA8
 	push {r4-r6,lr}
 	mov r6, r8
 	push {r6}
@@ -385,7 +385,7 @@ _080BFBFC:
 _080BFC08: .4byte gSpecialVar_0x8004
 _080BFC0C: .4byte gPlayerParty
 _080BFC10: .4byte gSpecialVar_0x8005
-	thumb_func_end sub_80BFBA8
+	thumb_func_end Special_DeleteSelectedMove
 
 	thumb_func_start sub_80BFC14
 sub_80BFC14: @ 80BFC14

data/event_scripts.s

@@ -3897,7 +3897,7 @@ EventScript_1A8CAD:: @ 81A8CAD
 	return
 
 EventScript_1A8CBD:: @ 81A8CBD
-	special sub_80BF8FC
+	special Special_ChooseMonToDeleteMove
 	waitstate
 	lock
 	faceplayer

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

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

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

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

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

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

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

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
 

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

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 Special_ChooseMoveToDelete
-	def_special sub_80BFBA8
+	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 SpawnCameraObject
-	def_special RemoveScriptFieldObject
+	def_special RemoveCameraObject
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special nullsub_75