Clean up field_specials documentation

11 files changed, 34 insertions, 32 deletions

diff --git a/data/maps/BattleFrontier_BattlePyramidLobby/scripts.inc b/data/maps/BattleFrontier_BattlePyramidLobby/scripts.inc
index 003582e1f..1860efd16 100644
--- a/data/maps/BattleFrontier_BattlePyramidLobby/scripts.inc
+++ b/data/maps/BattleFrontier_BattlePyramidLobby/scripts.inc
@@ -318,7 +318,7 @@ BattleFrontier_BattlePyramidLobby_EventScript_250B91:: @ 8250B91
 
 BattleFrontier_BattlePyramidLobby_EventScript_250BA4:: @ 8250BA4
 	copyvar VAR_0x8004, VAR_RESULT
-	special sub_813B968
+	special GetBattlePyramidHint
 	switch VAR_RESULT
 	case 0, BattleFrontier_BattlePyramidLobby_EventScript_250C8E
 	case 1, BattleFrontier_BattlePyramidLobby_EventScript_250C97
diff --git a/data/maps/BattleFrontier_BattleTowerBattleRoom2/scripts.inc b/data/maps/BattleFrontier_BattleTowerBattleRoom2/scripts.inc
index c2659b407..ecd7ac78a 100644
--- a/data/maps/BattleFrontier_BattleTowerBattleRoom2/scripts.inc
+++ b/data/maps/BattleFrontier_BattleTowerBattleRoom2/scripts.inc
@@ -25,7 +25,7 @@ BattleFrontier_BattleTowerBattleRoom2_EventScript_248F29:: @ 8248F29
 	return
 
 BattleFrontier_BattleTowerBattleRoom2_EventScript_248F2F:: @ 8248F2F
-	special sub_813A76C
+	special SetBattleTowerLinkPlayerGfx
 	return
 
 BattleFrontier_BattleTowerBattleRoom2_MapScript2_248F33: @ 8248F33
diff --git a/data/maps/BattleFrontier_BattleTowerCorridor2/scripts.inc b/data/maps/BattleFrontier_BattleTowerCorridor2/scripts.inc
index 5b4732ffb..6e3e05959 100644
--- a/data/maps/BattleFrontier_BattleTowerCorridor2/scripts.inc
+++ b/data/maps/BattleFrontier_BattleTowerCorridor2/scripts.inc
@@ -25,7 +25,7 @@ BattleFrontier_BattleTowerCorridor2_EventScript_248D8B:: @ 8248D8B
 	return
 
 BattleFrontier_BattleTowerCorridor2_EventScript_248D91:: @ 8248D91
-	special sub_813A76C
+	special SetBattleTowerLinkPlayerGfx
 	return
 
 BattleFrontier_BattleTowerCorridor2_MapScript2_248D95: @ 8248D95
diff --git a/data/maps/BattleFrontier_BattleTowerElevator/scripts.inc b/data/maps/BattleFrontier_BattleTowerElevator/scripts.inc
index 0e94d9154..f84ec194d 100644
--- a/data/maps/BattleFrontier_BattleTowerElevator/scripts.inc
+++ b/data/maps/BattleFrontier_BattleTowerElevator/scripts.inc
@@ -12,9 +12,9 @@ BattleFrontier_BattleTowerElevator_EventScript_2419F0:: @ 82419F0
 	applymovement 1, BattleFrontier_BattleTowerElevator_Movement_241A86
 	applymovement EVENT_OBJ_ID_PLAYER, BattleFrontier_BattleTowerElevator_Movement_241A8A
 	waitmovement 0
-	special sub_813A080
+	special BufferBattleTowerElevatorFloors
 	waitse
-	special ShakeScreenInElevator
+	special MoveElevator
 	waitstate
 	delay 48
 	applymovement 1, BattleFrontier_BattleTowerElevator_Movement_241A8E
diff --git a/data/maps/BattleFrontier_Lounge1/scripts.inc b/data/maps/BattleFrontier_Lounge1/scripts.inc
index 581cbd31e..dee3fd431 100644
--- a/data/maps/BattleFrontier_Lounge1/scripts.inc
+++ b/data/maps/BattleFrontier_Lounge1/scripts.inc
@@ -31,7 +31,7 @@ BattleFrontier_Lounge1_EventScript_25E7BF:: @ 825E7BF
 	specialvar VAR_RESULT, ScriptGetPartyMonSpecies
 	compare VAR_RESULT, SPECIES_EGG
 	goto_if_eq BattleFrontier_Lounge1_EventScript_25E7FF
-	special sub_8139D98
+	special BufferVarsForIVRater
 	compare VAR_0x8005, 90
 	goto_if_le BattleFrontier_Lounge1_EventScript_25E87F
 	compare VAR_0x8005, 120
diff --git a/data/maps/BattleFrontier_Lounge7/scripts.inc b/data/maps/BattleFrontier_Lounge7/scripts.inc
index 4ea73e135..5b3f88dcf 100644
--- a/data/maps/BattleFrontier_Lounge7/scripts.inc
+++ b/data/maps/BattleFrontier_Lounge7/scripts.inc
@@ -230,7 +230,7 @@ BattleFrontier_Lounge7_EventScript_26562A:: @ 826562A
 	end
 
 BattleFrontier_Lounge7_EventScript_265635:: @ 8265635
-	special sub_813ADB8
+	special CloseBattleFrontierTutorWindow
 	special CloseBattlePointsWindow
 	msgbox BattleFrontier_Lounge7_Text_265A0E, MSGBOX_DEFAULT
 	release
@@ -261,10 +261,10 @@ BattleFrontier_Lounge7_EventScript_26564F:: @ 826564F
 
 BattleFrontier_Lounge7_EventScript_265696:: @ 8265696
 	msgbox BattleFrontier_Lounge7_Text_26595A, MSGBOX_DEFAULT
-	special sub_813AEB4
+	special GetBattleFrontierTutorMoveIndex
 	fadescreen 1
 	special CloseBattlePointsWindow
-	special sub_813ADB8
+	special CloseBattleFrontierTutorWindow
 	special sub_81B892C
 	waitstate
 	compare VAR_RESULT, 0
diff --git a/data/maps/LilycoveCity_DepartmentStoreElevator/scripts.inc b/data/maps/LilycoveCity_DepartmentStoreElevator/scripts.inc
index 5e8c39ff1..859c568e5 100644
--- a/data/maps/LilycoveCity_DepartmentStoreElevator/scripts.inc
+++ b/data/maps/LilycoveCity_DepartmentStoreElevator/scripts.inc
@@ -7,7 +7,7 @@ LilycoveCity_DepartmentStoreElevator_EventScript_220624:: @ 8220624
 	setvar VAR_0x8004, 0
 	call_if_unset FLAG_TEMP_2, LilycoveCity_DepartmentStoreElevator_EventScript_2207FC
 	copyvar VAR_0x8005, VAR_DEPT_STORE_FLOOR
-	special sub_8139B60
+	special ShowDeptStoreElevatorFloorSelect
 	message gUnknown_08272C1D
 	waitmessage
 	setvar VAR_0x8004, 0
@@ -107,17 +107,17 @@ LilycoveCity_DepartmentStoreElevator_EventScript_2207B8:: @ 82207B8
 	end
 
 LilycoveCity_DepartmentStoreElevator_EventScript_2207E0:: @ 82207E0
-	special sub_8139C10
+	special CloseDeptStoreElevatorWindow
 	release
 	end
 
 LilycoveCity_DepartmentStoreElevator_EventScript_2207E5:: @ 82207E5
-	special sub_8139C10
+	special CloseDeptStoreElevatorWindow
 	closemessage
 	applymovement VAR_LAST_TALKED, Common_Movement_WalkInPlaceDown
 	waitmovement 0
 	waitse
-	special ShakeScreenInElevator
+	special MoveElevator
 	waitstate
 	setflag FLAG_TEMP_2
 	return
diff --git a/data/maps/PetalburgCity_Gym/scripts.inc b/data/maps/PetalburgCity_Gym/scripts.inc
index 119760379..749ed18f2 100644
--- a/data/maps/PetalburgCity_Gym/scripts.inc
+++ b/data/maps/PetalburgCity_Gym/scripts.inc
@@ -418,7 +418,7 @@ PetalburgCity_Gym_EventScript_204E3B:: @ 8204E3B
 	setflag FLAG_DEFEATED_PETALBURG_GYM
 	setvar VAR_PETALBURG_GYM_STATE, 7
 	setflag FLAG_BADGE05_GET
-	special sub_813B9A0
+	special ResetHealLocationFromDewford
 	call PetalburgCity_Gym_EventScript_2721F8
 	setflag FLAG_HIDE_MAUVILLE_GYM_WATTSON
 	clearflag FLAG_HIDE_MAUVILLE_CITY_WATTSON
diff --git a/data/maps/SootopolisCity/scripts.inc b/data/maps/SootopolisCity/scripts.inc
index 668a18561..d481924a2 100644
--- a/data/maps/SootopolisCity/scripts.inc
+++ b/data/maps/SootopolisCity/scripts.inc
@@ -217,7 +217,7 @@ SootopolisCity_EventScript_1E5946:: @ 81E5946
 	setweather WEATHER_ALTERNATING
 	doweather
 	setvar VAR_0x8004, 0
-	special sub_813B7D8
+	special Script_DoRayquazaScene
 	waitstate
 	applymovement 10, Common_Movement_WalkInPlaceLeft
 	applymovement 9, Common_Movement_WalkInPlaceRight
@@ -317,7 +317,7 @@ SootopolisCity_EventScript_1E5A82:: @ 81E5A82
 	setweather WEATHER_ALTERNATING
 	doweather
 	setvar VAR_0x8004, 0
-	special sub_813B7D8
+	special Script_DoRayquazaScene
 	waitstate
 	applymovement 10, Common_Movement_WalkInPlaceLeft
 	applymovement 9, Common_Movement_WalkInPlaceRight
@@ -509,7 +509,7 @@ SootopolisCity_EventScript_1E5C1E:: @ 81E5C1E
 	removeobject 10
 	addobject 11
 	setvar VAR_0x8004, 1
-	special sub_813B7D8
+	special Script_DoRayquazaScene
 	waitstate
 	playse SE_T_KAMI
 	special SpawnCameraObject
@@ -562,7 +562,7 @@ SootopolisCity_EventScript_1E5CCE:: @ 81E5CCE
 	removeobject 10
 	addobject 11
 	setvar VAR_0x8004, 1
-	special sub_813B7D8
+	special Script_DoRayquazaScene
 	waitstate
 	special SpawnCameraObject
 	applymovement EVENT_OBJ_ID_CAMERA, SootopolisCity_Movement_1E5E63
diff --git a/data/maps/TrainerHill_Elevator/scripts.inc b/data/maps/TrainerHill_Elevator/scripts.inc
index ecc48a9e9..bf3d0f9f7 100644
--- a/data/maps/TrainerHill_Elevator/scripts.inc
+++ b/data/maps/TrainerHill_Elevator/scripts.inc
@@ -39,18 +39,20 @@ TrainerHill_Elevator_EventScript_269375:: @ 8269375
 	waitstate
 	end
 
+@ Unused
 TrainerHill_Elevator_EventScript_2693CE:: @ 82693CE
 	goto TrainerHill_Elevator_EventScript_2693D4
 	end
 
+@ Functionally unused
 TrainerHill_Elevator_EventScript_2693D4:: @ 82693D4
-	special sub_8139C10
+	special CloseDeptStoreElevatorWindow
 	releaseall
 	end
 
 TrainerHill_Elevator_EventScript_2693D9:: @ 82693D9
 	waitse
-	special ShakeScreenInElevator
+	special MoveElevator
 	waitstate
 	return
 
diff --git a/data/specials.inc b/data/specials.inc
index 499f21e0b..70c164461 100644
--- a/data/specials.inc
+++ b/data/specials.inc
@@ -284,7 +284,7 @@ gSpecials:: @ 81DBA64
 	def_special sub_80FB7A4
 	def_special DoSoftReset
 	def_special GameClear
-	def_special ShakeScreenInElevator
+	def_special MoveElevator
 	def_special ShowGlassWorkshopMenu
 	def_special SpawnCameraObject
 	def_special RemoveCameraObject
@@ -316,7 +316,7 @@ gSpecials:: @ 81DBA64
 	def_special CopyCurSecretBaseOwnerName_StrVar1
 	def_special ScriptCheckFreePokemonStorageSpace
 	def_special DoSealedChamberShakingEffect1
-	def_special sub_8139B60
+	def_special ShowDeptStoreElevatorFloorSelect
 	def_special GetShieldToyTVDecorationInfo
 	def_special IsPokerusInParty
 	def_special SetSootopolisGymCrackedIceMetatiles
@@ -442,7 +442,7 @@ gSpecials:: @ 81DBA64
 	def_special sub_8027AAC
 	def_special sub_8139980
 	def_special GetDeptStoreDefaultFloorChoice
-	def_special sub_8139D98
+	def_special BufferVarsForIVRater
 	def_special sub_80F905C
 	def_special sub_800B518
 	def_special sub_80F90DC
@@ -456,12 +456,12 @@ gSpecials:: @ 81DBA64
 	def_special sub_80B3028
 	def_special ShowScrollableMultichoice
 	def_special sub_813A630
-	def_special sub_813A080
+	def_special BufferBattleTowerElevatorFloors
 	def_special sub_81C6A94
 	def_special sub_81C4F24
 	def_special sub_81B95E0
 	def_special sub_81B9620
-	def_special sub_813A76C
+	def_special SetBattleTowerLinkPlayerGfx
 	def_special ShowNatureGirlMessage
 	def_special ShowBattlePointsWindow
 	def_special UpdateBattlePointsWindow
@@ -478,15 +478,15 @@ gSpecials:: @ 81DBA64
 	def_special PrintPlayerBerryPowderAmount
 	def_special ShowFrontierGamblerLookingMessage
 	def_special ShowFrontierGamblerGoMessage
-	def_special sub_813B7D8
+	def_special Script_DoRayquazaScene
 	def_special sub_81C72A4
 	def_special sp106_CreateStartMenu
 	def_special CountPlayerTrainerStars
 	def_special BufferBattleFrontierTutorMoveName
-	def_special sub_813ADB8
+	def_special CloseBattleFrontierTutorWindow
 	def_special sub_813ADD4
 	def_special sub_81B892C
-	def_special sub_813AEB4
+	def_special GetBattleFrontierTutorMoveIndex
 	def_special sub_813AF48
 	def_special DoDeoxysRockInteraction
 	def_special sub_813B1D0
@@ -516,7 +516,7 @@ gSpecials:: @ 81DBA64
 	def_special sub_813B568
 	def_special sub_813B534
 	def_special CallTrainerHillFunction
-	def_special sub_813B7D8
+	def_special Script_DoRayquazaScene @ Listed twice
 	def_special sub_813B80C
 	def_special sub_81D4BEC
 	def_special sub_80224D0
@@ -524,14 +524,14 @@ gSpecials:: @ 81DBA64
 	def_special DoWaldaNamingScreen
 	def_special TryGetWallpaperWithWaldaPhrase
 	def_special sub_8139ED0
-	def_special sub_813B968
+	def_special GetBattlePyramidHint
 	def_special sub_80F8B94
 	def_special ShowTrainerHillRecords
 	def_special sub_80B4808
-	def_special sub_813B9A0
+	def_special ResetHealLocationFromDewford
 	def_special sub_81B9918
 	def_special sub_80722E0
 	def_special TryPrepareSecondApproachingTrainer
 	def_special RemoveRecordsWindow
-	def_special sub_8139C10
+	def_special CloseDeptStoreElevatorWindow
 	def_special sub_80B3BC4