Reverse engineer unusual weather events

9 files changed, 42 insertions, 40 deletions

diff --git a/data/maps/Route105/scripts.inc b/data/maps/Route105/scripts.inc
index 6ad11bc52..74416f153 100644
--- a/data/maps/Route105/scripts.inc
+++ b/data/maps/Route105/scripts.inc
@@ -6,9 +6,9 @@ Route105_MapScripts:: @ 81EE1DB
 
 Route105_MapScript1_1EE1EB: @ 81EE1EB
 	call_if_unset FLAG_REGI_DOORS_OPENED, Route105_EventScript_1EE20B
-	compare VAR_0x4037, 9
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_105_NORTH
 	call_if_eq Route105_EventScript_2739AB
-	compare VAR_0x4037, 10
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_105_SOUTH
 	call_if_eq Route105_EventScript_273A18
 	end
 
@@ -20,9 +20,9 @@ Route105_EventScript_1EE20B:: @ 81EE20B
 Route105_MapScript1_1EE21E: @ 81EE21E
 	compare VAR_0x4039, 1
 	call_if_eq Route105_EventScript_273D13
-	compare VAR_0x4037, 9
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_105_NORTH
 	call_if_eq Route105_EventScript_273D17
-	compare VAR_0x4037, 10
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_105_SOUTH
 	call_if_eq Route105_EventScript_273D17
 	end
 
diff --git a/data/maps/Route114/scripts.inc b/data/maps/Route114/scripts.inc
index d4327a2f4..856a0f1e4 100644
--- a/data/maps/Route114/scripts.inc
+++ b/data/maps/Route114/scripts.inc
@@ -7,16 +7,16 @@ Route114_MapScripts:: @ 81F252F
 Route114_MapScript1_1F253F: @ 81F253F
 	compare VAR_0x4039, 1
 	call_if_eq Route114_EventScript_273D13
-	compare VAR_0x4037, 1
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_114_NORTH
 	call_if_eq Route114_EventScript_273D1B
-	compare VAR_0x4037, 2
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_114_SOUTH
 	call_if_eq Route114_EventScript_273D1B
 	end
 
 Route114_MapScript1_1F2561: @ 81F2561
-	compare VAR_0x4037, 1
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_114_NORTH
 	call_if_eq Route114_EventScript_273913
-	compare VAR_0x4037, 2
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_114_SOUTH
 	call_if_eq Route114_EventScript_273926
 	end
 
diff --git a/data/maps/Route115/scripts.inc b/data/maps/Route115/scripts.inc
index 9cb3ea2e0..42cf643af 100644
--- a/data/maps/Route115/scripts.inc
+++ b/data/maps/Route115/scripts.inc
@@ -5,18 +5,18 @@ Route115_MapScripts:: @ 81F2920
 	.byte 0
 
 Route115_MapScript1_1F2930: @ 81F2930
-	compare VAR_0x4037, 3
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_115_WEST
 	call_if_eq Route115_EventScript_273939
-	compare VAR_0x4037, 4
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_115_EAST
 	call_if_eq Route115_EventScript_27394C
 	end
 
 Route115_MapScript1_1F2947: @ 81F2947
 	compare VAR_0x4039, 1
 	call_if_eq Route115_EventScript_273D13
-	compare VAR_0x4037, 3
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_115_WEST
 	call_if_eq Route115_EventScript_273D1B
-	compare VAR_0x4037, 4
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_115_EAST
 	call_if_eq Route115_EventScript_273D1B
 	end
 
diff --git a/data/maps/Route116/scripts.inc b/data/maps/Route116/scripts.inc
index 90ae29f5b..afb0505c8 100644
--- a/data/maps/Route116/scripts.inc
+++ b/data/maps/Route116/scripts.inc
@@ -8,9 +8,9 @@ Route116_MapScript1_1F2C1C: @ 81F2C1C
 	call_if_set FLAG_RECOVERED_DEVON_GOODS, Route116_EventScript_1F2C47
 	compare VAR_0x4039, 1
 	call_if_eq Route116_EventScript_273D13
-	compare VAR_0x4037, 5
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_116_NORTH
 	call_if_eq Route116_EventScript_273D1B
-	compare VAR_0x4037, 6
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_116_SOUTH
 	call_if_eq Route116_EventScript_273D1B
 	end
 
@@ -19,9 +19,9 @@ Route116_EventScript_1F2C47:: @ 81F2C47
 	return
 
 Route116_MapScript1_1F2C4F: @ 81F2C4F
-	compare VAR_0x4037, 5
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_116_NORTH
 	call_if_eq Route116_EventScript_27395F
-	compare VAR_0x4037, 6
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_116_SOUTH
 	call_if_eq Route116_EventScript_273972
 	end
 
diff --git a/data/maps/Route118/scripts.inc b/data/maps/Route118/scripts.inc
index 758804137..88c4e1275 100644
--- a/data/maps/Route118/scripts.inc
+++ b/data/maps/Route118/scripts.inc
@@ -8,16 +8,16 @@ Route118_MapScript1_1F3DCC: @ 81F3DCC
 	call Route118_EventScript_28CCC7
 	compare VAR_0x4039, 1
 	call_if_eq Route118_EventScript_273D13
-	compare VAR_0x4037, 7
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_118_EAST
 	call_if_eq Route118_EventScript_273D1B
-	compare VAR_0x4037, 8
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_118_WEST
 	call_if_eq Route118_EventScript_273D1B
 	end
 
 Route118_MapScript1_1F3DF3: @ 81F3DF3
-	compare VAR_0x4037, 7
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_118_EAST
 	call_if_eq Route118_EventScript_273985
-	compare VAR_0x4037, 8
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_118_WEST
 	call_if_eq Route118_EventScript_273998
 	end
 
diff --git a/data/maps/Route119_WeatherInstitute_2F/scripts.inc b/data/maps/Route119_WeatherInstitute_2F/scripts.inc
index 7d557fdef..2eaeceb2f 100644
--- a/data/maps/Route119_WeatherInstitute_2F/scripts.inc
+++ b/data/maps/Route119_WeatherInstitute_2F/scripts.inc
@@ -137,11 +137,13 @@ Route119_WeatherInstitute_2F_EventScript_2700F7:: @ 82700F7
 	end
 
 Route119_WeatherInstitute_2F_EventScript_27010A:: @ 827010A
+    @ This code uses VAR_0x8004 to count the number of legendaries the player has defeated
+    @ already.
 	setvar VAR_0x8004, 0
-	call_if_set FLAG_DEFEATED_KYOGRE, Route119_WeatherInstitute_2F_EventScript_270160
-	call_if_set FLAG_DEFEATED_GROUDON, Route119_WeatherInstitute_2F_EventScript_270160
+	call_if_set FLAG_DEFEATED_KYOGRE, WeatherInstitute_UnusualWeather_IncrementLegendCount
+	call_if_set FLAG_DEFEATED_GROUDON, WeatherInstitute_UnusualWeather_IncrementLegendCount
 	compare VAR_0x8004, 2
-	goto_if_eq Route119_WeatherInstitute_2F_EventScript_270166
+	goto_if_eq WeatherInstitute_UnusualWeather_LegendariesAlreadyDefeated
 	call_if_unset FLAG_TEMP_2, Route119_WeatherInstitute_2F_EventScript_270159
 	specialvar VAR_RESULT, sub_813B374
 	compare VAR_RESULT, 1
@@ -156,16 +158,16 @@ Route119_WeatherInstitute_2F_EventScript_27014F:: @ 827014F
 	end
 
 Route119_WeatherInstitute_2F_EventScript_270159:: @ 8270159
-	special sub_813B2E4
+	special CreateUnusualWeatherEvent
 	setflag FLAG_TEMP_2
 	return
 
-Route119_WeatherInstitute_2F_EventScript_270160:: @ 8270160
+WeatherInstitute_UnusualWeather_IncrementLegendCount:: @ 8270160
 	addvar VAR_0x8004, 1
 	return
 
-Route119_WeatherInstitute_2F_EventScript_270166:: @ 8270166
-	msgbox Route119_WeatherInstitute_2F_Text_2708FC, MSGBOX_DEFAULT
+WeatherInstitute_UnusualWeather_LegendariesAlreadyDefeated:: @ 8270166
+	msgbox WeatherInstitute_UnusualWeather_LegendariesAlreadyDefeatedText, MSGBOX_DEFAULT
 	release
 	end
 
@@ -325,7 +327,7 @@ Route119_WeatherInstitute_2F_Text_270873: @ 8270873
 	.string "Could that mean, somewhere near\n"
 	.string "{STR_VAR_1}…$"
 
-Route119_WeatherInstitute_2F_Text_2708FC: @ 82708FC
+WeatherInstitute_UnusualWeather_LegendariesAlreadyDefeatedText: @ 82708FC
 	.string "Abnormal weather conditions are\n"
 	.string "no longer being reported.\p"
 	.string "The occasional rainfall is a blessing,\n"
diff --git a/data/maps/Route125/scripts.inc b/data/maps/Route125/scripts.inc
index 4812b9691..d1046e6a4 100644
--- a/data/maps/Route125/scripts.inc
+++ b/data/maps/Route125/scripts.inc
@@ -8,16 +8,16 @@ Route125_MapScript1_1F6758: @ 81F6758
 	call_if_set FLAG_SYS_WEATHER_CTRL, Common_EventScript_SetWeather15
 	compare VAR_0x4039, 1
 	call_if_eq Route125_EventScript_273D13
-	compare VAR_0x4037, 11
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_125_WEST
 	call_if_eq Route125_EventScript_273D17
-	compare VAR_0x4037, 12
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_125_EAST
 	call_if_eq Route125_EventScript_273D17
 	end
 
 Route125_MapScript1_1F6783: @ 81F6783
-	compare VAR_0x4037, 11
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_125_WEST
 	call_if_eq Route125_EventScript_273A85
-	compare VAR_0x4037, 12
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_125_EAST
 	call_if_eq Route125_EventScript_273AF2
 	end
 
diff --git a/data/maps/Route127/scripts.inc b/data/maps/Route127/scripts.inc
index 7d5eee844..9f2018e8f 100644
--- a/data/maps/Route127/scripts.inc
+++ b/data/maps/Route127/scripts.inc
@@ -8,16 +8,16 @@ Route127_MapScript1_1F69E9: @ 81F69E9
 	call_if_set FLAG_SYS_WEATHER_CTRL, Common_EventScript_SetWeather15
 	compare VAR_0x4039, 1
 	call_if_eq Route127_EventScript_273D13
-	compare VAR_0x4037, 13
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_127_NORTH
 	call_if_eq Route127_EventScript_273D17
-	compare VAR_0x4037, 14
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_127_SOUTH
 	call_if_eq Route127_EventScript_273D17
 	end
 
 Route127_MapScript1_1F6A14: @ 81F6A14
-	compare VAR_0x4037, 13
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_127_NORTH
 	call_if_eq Route127_EventScript_273B5F
-	compare VAR_0x4037, 14
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_127_SOUTH
 	call_if_eq Route127_EventScript_273BCC
 	end
 
diff --git a/data/maps/Route129/scripts.inc b/data/maps/Route129/scripts.inc
index 8aec4bc28..5f65712d7 100644
--- a/data/maps/Route129/scripts.inc
+++ b/data/maps/Route129/scripts.inc
@@ -5,9 +5,9 @@ Route129_MapScripts:: @ 81F7284
 	.byte 0
 
 Route129_MapScript1_1F7294: @ 81F7294
-	compare VAR_0x4037, 15
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_129_WEST
 	call_if_eq Route129_EventScript_273C39
-	compare VAR_0x4037, 16
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_129_EAST
 	call_if_eq Route129_EventScript_273CA6
 	end
 
@@ -16,9 +16,9 @@ Route129_MapScript1_1F72AB: @ 81F72AB
 	call_if_eq Route129_EventScript_273D13
 	compare VAR_0x405E, 4
 	call_if_ge Route129_EventScript_1F72D8
-	compare VAR_0x4037, 15
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_129_WEST
 	call_if_eq Route129_EventScript_273D17
-	compare VAR_0x4037, 16
+	compare VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_ROUTE_129_EAST
 	call_if_eq Route129_EventScript_273D17
 	end