Begin documenting Apprentice, merge with master

2 files changed, 44 insertions, 50 deletions

diff --git a/data/maps/BattleFrontier_BattleTowerLobby/map.json b/data/maps/BattleFrontier_BattleTowerLobby/map.json
index 13bda5f22..32aa11636 100644
--- a/data/maps/BattleFrontier_BattleTowerLobby/map.json
+++ b/data/maps/BattleFrontier_BattleTowerLobby/map.json
@@ -76,7 +76,7 @@
       "movement_range_y": 0,
       "trainer_type": "0",
       "trainer_sight_or_berry_tree_id": "0",
-      "script": "BattleFrontier_BattleTowerLobby_EventScript_28CB96",
+      "script": "BattleFrontier_BattleTowerLobby_EventScript_Reporter",
       "flag": "FLAG_HIDE_BATTLE_TOWER_REPORTER"
     },
     {
diff --git a/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc b/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
index d64b82e92..791901b1f 100644
--- a/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
+++ b/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
@@ -10,7 +10,7 @@ BattleFrontier_BattleTowerLobby_MapScript1_23E690: @ 823E690
 	end
 
 BattleFrontier_BattleTowerLobby_MapScript1_23E694: @ 823E694
-	call BattleFrontier_BattleTowerLobby_EventScript_28CC84
+	call BattleFrontier_BattleTowerLobby_EventScript_ShowOrHideReporter
 	setvar VAR_0x8004, APPRENTICE_FUNC_10
 	special CallApprenticeFunction
 	compare VAR_0x8004, 0
@@ -56,14 +56,14 @@ BattleFrontier_BattleTowerLobby_EventScript_23E710:: @ 823E710
 	faceplayer
 	msgbox BattleFrontier_BattleTowerLobby_Text_23F583, MSGBOX_DEFAULT
 	closemessage
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 1
 	setvar VAR_0x8006, 0
-	special sub_8161F74
-	setvar VAR_0x8004, 2
+	special CallBattleTowerFunc
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 0
-	special sub_8161F74
+	special CallBattleTowerFunc
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
 	setvar VAR_0x8005, 0
 	setvar VAR_0x8006, 0
@@ -87,8 +87,8 @@ BattleFrontier_BattleTowerLobby_EventScript_23E778:: @ 823E778
 	msgbox BattleFrontier_BattleTowerLobby_Text_241486, MSGBOX_DEFAULT
 
 BattleFrontier_BattleTowerLobby_EventScript_23E780:: @ 823E780
-	setvar VAR_0x8004, 5
-	special sub_8161F74
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_GIVE_RIBBONS
+	special CallBattleTowerFunc
 	compare VAR_RESULT, 0
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_23E7A5
 	message BattleFrontier_BattleTowerLobby_Text_23F844
@@ -101,11 +101,11 @@ BattleFrontier_BattleTowerLobby_EventScript_23E7A5:: @ 823E7A5
 	msgbox BattleFrontier_BattleTowerLobby_Text_2414D4, MSGBOX_DEFAULT
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_11
 	special CallFrontierUtilFunc
-	msgbox BattleFrontier_BattleTowerLobby_Text_241520, 9
+	msgbox BattleFrontier_Text_ObtainedXBattlePoints, MSGBOX_GETPOINTS
 	call BattleFrontier_BattleTowerLobby_EventScript_23E84D
-	setvar VAR_0x8004, 1
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_1
 	setvar VAR_0x8005, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	compare VAR_RESULT, 49
 	goto_if_ne BattleFrontier_BattleTowerLobby_EventScript_23E7E2
 	msgbox BattleFrontier_BattleTowerLobby_Text_23F79D, MSGBOX_DEFAULT
@@ -121,17 +121,17 @@ BattleFrontier_BattleTowerLobby_EventScript_23E7F2:: @ 823E7F2
 	compare VAR_FRONTIER_BATTLE_MODE, 2
 	goto_if_ne BattleFrontier_BattleTowerLobby_EventScript_23E81E
 	goto_if_set FLAG_CHOSEN_MULTI_BATTLE_NPC_PARTNER, BattleFrontier_BattleTowerLobby_EventScript_23E81E
-	setvar VAR_0x8004, 1
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_1
 	setvar VAR_0x8005, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	compare VAR_RESULT, 0
 	goto_if_ne BattleFrontier_BattleTowerLobby_EventScript_23E830
 
 BattleFrontier_BattleTowerLobby_EventScript_23E81E:: @ 823E81E
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 0
-	special sub_8161F74
+	special CallBattleTowerFunc
 
 BattleFrontier_BattleTowerLobby_EventScript_23E830:: @ 823E830
 	lock
@@ -152,9 +152,9 @@ BattleFrontier_BattleTowerLobby_EventScript_23E84D:: @ 823E84D
 	special CallFrontierUtilFunc
 	special LoadPlayerParty
 	special HealPlayerParty
-	setvar VAR_0x8004, 6
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_SAVE
 	setvar VAR_0x8005, 0
-	special sub_8161F74
+	special CallBattleTowerFunc
 	playse SE_SAVE
 	waitse
 	call BattleFrontier_BattleTowerLobby_EventScript_23E8E0
@@ -218,9 +218,9 @@ BattleFrontier_BattleTowerLobby_EventScript_23E8EE:: @ 823E8EE
 	waitmessage
 	message BattleFrontier_BattleTowerLobby_Text_23F754
 	waitmessage
-	setvar VAR_0x8004, 6
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_SAVE
 	setvar VAR_0x8005, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	playse SE_SAVE
 	waitse
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
@@ -287,12 +287,12 @@ BattleFrontier_BattleTowerLobby_EventScript_23EA2A:: @ 823EA2A
 	setvar VAR_0x8005, 4
 	special CallFrontierUtilFunc
 	setvar VAR_TEMP_0, 0
-	setvar VAR_0x8004, 0
-	special sub_8161F74
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_0
+	special CallBattleTowerFunc
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
 	setvar VAR_0x8005, 3
 	setvar VAR_0x8006, 0
@@ -367,12 +367,12 @@ BattleFrontier_BattleTowerLobby_EventScript_23EB93:: @ 823EB93
 	setvar VAR_0x8005, 4
 	special CallFrontierUtilFunc
 	setvar VAR_TEMP_0, 0
-	setvar VAR_0x8004, 0
-	special sub_8161F74
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_0
+	special CallBattleTowerFunc
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
 	setvar VAR_0x8005, 3
 	setvar VAR_0x8006, 0
@@ -448,12 +448,12 @@ BattleFrontier_BattleTowerLobby_EventScript_23ECFF:: @ 823ECFF
 	setvar VAR_0x8005, 4
 	special CallFrontierUtilFunc
 	setvar VAR_TEMP_0, 0
-	setvar VAR_0x8004, 0
-	special sub_8161F74
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_0
+	special CallBattleTowerFunc
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
 	setvar VAR_0x8005, 3
 	setvar VAR_0x8006, 0
@@ -528,12 +528,12 @@ BattleFrontier_BattleTowerLobby_EventScript_23EE68:: @ 823EE68
 	setvar VAR_0x8005, 4
 	special CallFrontierUtilFunc
 	setvar VAR_TEMP_0, 0
-	setvar VAR_0x8004, 0
-	special sub_8161F74
-	setvar VAR_0x8004, 2
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_0
+	special CallBattleTowerFunc
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_2
 	setvar VAR_0x8005, 2
 	setvar VAR_0x8006, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	setvar VAR_0x8004, FRONTIER_UTIL_FUNC_2
 	setvar VAR_0x8005, 3
 	setvar VAR_0x8006, 0
@@ -541,9 +541,9 @@ BattleFrontier_BattleTowerLobby_EventScript_23EE68:: @ 823EE68
 	special LoadPlayerParty
 	closemessage
 	delay 2
-	setvar VAR_0x8004, 6
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_SAVE
 	setvar VAR_0x8005, 0
-	special sub_8161F74
+	special CallBattleTowerFunc
 	call Common_EventScript_SaveGame
 	setvar VAR_TEMP_0, 255
 	compare VAR_RESULT, 0
@@ -738,8 +738,8 @@ BattleFrontier_BattleTowerLobby_EventScript_23F0F3:: @ 823F0F3
 	setvar VAR_RESULT, 0
 
 BattleFrontier_BattleTowerLobby_EventScript_23F108:: @ 823F108
-	setvar VAR_0x8004, 12
-	special sub_8161F74
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_12
+	special CallBattleTowerFunc
 	delay 1
 	compare VAR_RESULT, 6
 	goto_if_ne BattleFrontier_BattleTowerLobby_EventScript_23F108
@@ -998,9 +998,9 @@ BattleFrontier_BattleTowerLobby_EventScript_23F3AF:: @ 823F3AF
 	setvar VAR_BRAVO_TRAINER_BATTLE_TOWER_ON, 0
 	message BattleFrontier_BattleTowerLobby_Text_24144D
 	waitmessage
-	setvar VAR_0x8004, 6
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_SAVE
 	setvar VAR_0x8005, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	special sub_80A08CC
 	waitstate
 	playse SE_SAVE
@@ -1061,9 +1061,9 @@ BattleFrontier_BattleTowerLobby_EventScript_23F496:: @ 823F496
 	setvar VAR_BRAVO_TRAINER_BATTLE_TOWER_ON, 0
 	message BattleFrontier_BattleTowerLobby_Text_24144D
 	waitmessage
-	setvar VAR_0x8004, 6
+	setvar VAR_0x8004, BATTLE_TOWER_FUNC_SAVE
 	setvar VAR_0x8005, 1
-	special sub_8161F74
+	special CallBattleTowerFunc
 	special sub_80A08CC
 	waitstate
 	playse SE_SAVE
@@ -1529,13 +1529,7 @@ BattleFrontier_BattleTowerLobby_Text_2414D4: @ 82414D4
 	.string "In recognition of your infinite talent,\n"
 	.string "we award you these Battle Point(s).$"
 
-BattleFrontier_BattleArenaLobby_Text_241520: @ 8241520
-BattleFrontier_BattleDomeLobby_Text_241520: @ 8241520
-BattleFrontier_BattleFactoryLobby_Text_241520: @ 8241520
-BattleFrontier_BattlePalaceLobby_Text_241520: @ 8241520
-BattleFrontier_BattlePikeLobby_Text_241520: @ 8241520
-BattleFrontier_BattlePyramidLobby_Text_241520: @ 8241520
-BattleFrontier_BattleTowerLobby_Text_241520: @ 8241520
+BattleFrontier_Text_ObtainedXBattlePoints: @ 8241520
 	.string "{PLAYER} obtained {STR_VAR_1} Battle Point(s).$"
 
 BattleFrontier_BattleTowerLobby_Text_241540: @ 8241540