Rename map scene vars and partially document Oak's lab

3 files changed, 74 insertions, 69 deletions

diff --git a/include/constants/flags.h b/include/constants/flags.h
index 913bf9724..fbb463c0a 100644
--- a/include/constants/flags.h
+++ b/include/constants/flags.h
@@ -581,7 +581,7 @@
 #define FLAG_0x240               0x240
 #define FLAG_0x241               0x241
 #define FLAG_0x242               0x242
-#define FLAG_GOT_COIN_CASE               0x243
+#define FLAG_GOT_COIN_CASE       0x243
 #define FLAG_0x244               0x244
 #define FLAG_0x245               0x245
 #define FLAG_0x246               0x246
@@ -750,9 +750,9 @@
 #define FLAG_0x2E9               0x2E9
 #define FLAG_0x2EA               0x2EA
 #define FLAG_0x2EB               0x2EB
-#define FLAG_0x2EC               0x2EC
-#define FLAG_0x2ED               0x2ED
-#define FLAG_0x2EE               0x2EE
+#define FLAG_REVIVED_DOME        0x2EC
+#define FLAG_REVIVED_HELIX       0x2ED
+#define FLAG_REVIVED_AMBER       0x2EE
 #define FLAG_0x2EF               0x2EF
 #define FLAG_0x2F0               0x2F0
 #define FLAG_0x2F1               0x2F1
@@ -986,7 +986,7 @@
 #define FLAG_0x3D5               0x3D5
 #define FLAG_0x3D6               0x3D6
 #define FLAG_0x3D7               0x3D7
-#define FLAG_MYSTERY_EVENT_DONE               0x3D8
+#define FLAG_MYSTERY_EVENT_DONE  0x3D8
 #define FLAG_0x3D9               0x3D9
 #define FLAG_0x3DA               0x3DA
 #define FLAG_0x3DB               0x3DB
@@ -1315,12 +1315,13 @@
 #define FLAG_SYS_POKEMON_GET (SYS_FLAGS + 0x28)
 #define FLAG_SYS_POKEDEX_GET (SYS_FLAGS + 0x29)
 #define FLAG_SYS_GAME_CLEAR (SYS_FLAGS + 0x2C)
-#define FLAG_0x82F (SYS_FLAGS + 0x2F)
+#define FLAG_SYS_RUNNING_SHOES (SYS_FLAGS + 0x2F)
 #define FLAG_0x830 (SYS_FLAGS + 0x30)
 #define FLAG_SYS_NOT_SOMEONES_PC (SYS_FLAGS + 0x34)
 #define FLAG_SYS_RIBBON_GET (SYS_FLAGS + 0x3B)
 #define FLAG_0x83C (SYS_FLAGS + 0x3C)
-#define FLAG_0x83E (SYS_FLAGS + 0x3E)
+#define FLAG_PALLET_TOWN_LADY_MOVED_FROM_SIGN (SYS_FLAGS + 0x3E)
+#define FLAG_SYS_NATIONAL_DEX (SYS_FLAGS + 0x40)
 #define FLAG_0x841 (SYS_FLAGS + 0x41)
 #define FLAG_0x842 (SYS_FLAGS + 0x42)
 #define FLAG_0x843 (SYS_FLAGS + 0x43)
diff --git a/include/constants/vars.h b/include/constants/vars.h
index 2f155646b..503d3dfed 100644
--- a/include/constants/vars.h
+++ b/include/constants/vars.h
@@ -86,66 +86,70 @@
 #define VAR_0x404D                 0x404D
 #define VAR_0x404E                 0x404E
 #define VAR_LOTAD_SIZE_RECORD      0x404F
-#define VAR_MAP_SCENE_PALLET_TOWN                 0x4050
-#define VAR_0x4051                 0x4051
-#define VAR_0x4052                 0x4052
-#define VAR_VERMILION_CITY_TICKET_CHECK_TRIGGER                 0x4053
-#define VAR_0x4054                 0x4054
-#define VAR_MAP_SCENE_PALLET_TOWN_PROFESSOR_OAKS_LAB                 0x4055
-#define VAR_MAP_SCENE_PALLET_TOWN_PLAYERS_HOUSE_2F                 0x4056
-#define VAR_MAP_SCENE_VIRIDIAN_CITY_MART                 0x4057
-#define VAR_0x4058                 0x4058
-#define VAR_0x4059                 0x4059
-#define VAR_0x405A                 0x405A
-#define VAR_0x405B                 0x405B
-#define VAR_0x405C                 0x405C
-#define VAR_0x405D                 0x405D
-#define VAR_MAP_SCENE_ROUTE16                 0x405E
-#define VAR_0x405F                 0x405F
-#define VAR_0x4060                 0x4060
-#define VAR_0x4061                 0x4061
-#define VAR_0x4062                 0x4062
-#define VAR_MAP_SCENE_SEAFOAM_ISLANDS_B4F                 0x4063
-#define VAR_0x4064                 0x4064
-#define VAR_0x4065                 0x4065
-#define VAR_0x4066                 0x4066
-#define VAR_0x4067                 0x4067
-#define VAR_0x4068                 0x4068
-#define VAR_0x4069                 0x4069
-#define VAR_0x406A                 0x406A
-#define VAR_0x406B                 0x406B
-#define VAR_0x406C                 0x406C
-#define VAR_0x406D                 0x406D
-#define VAR_MAP_SCENE_FUCHSIA_CITY_SAFARI_ZONE_ENTRANCE                 0x406E
-#define VAR_0x406F                 0x406F
-#define VAR_0x4070                 0x4070
-#define VAR_0x4071                 0x4071
-#define VAR_0x4072                 0x4072
-#define VAR_MAP_SCENE_SAFFRON_CITY_POKEMON_TRAINER_FAN_CLUB                 0x4073
-#define VAR_MAP_SCENE_SEVEN_ISLAND_HOUSE_ROOM1                 0x4074
-#define VAR_MAP_SCENE_ONE_ISLAND_HARBOR                 0x4075
-#define VAR_MAP_SCENE_ONE_ISLAND_POKEMON_CENTER_1F                 0x4076
-#define VAR_0x4077                 0x4077
-#define VAR_0x4078                 0x4078
-#define VAR_MAP_SCENE_TWO_ISLAND_JOYFUL_GAME_CORNER                 0x4079
-#define VAR_0x407A                 0x407A
-#define VAR_0x407B                 0x407B
-#define VAR_0x407C                 0x407C
-#define VAR_0x407D                 0x407D
-#define VAR_MAP_SCENE_VERMILION_CITY                 0x407E
-#define VAR_0x407F                 0x407F
-#define VAR_0x4080                 0x4080
-#define VAR_0x4081                 0x4081
-#define VAR_0x4082                 0x4082
-#define VAR_MAP_SCENE_FIVE_ISLAND_LOST_CAVE_ROOM10                 0x4083
-#define VAR_MAP_SCENE_FIVE_ISLAND_RESORT_GORGEOUS                 0x4084
-#define VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR                 0x4085
-#define VAR_MAP_SCENE_FOUR_ISLAND                 0x4086
-#define VAR_0x4087                 0x4087
-#define VAR_0x4088                 0x4088
-#define VAR_MAP_SCENE_SIX_ISLAND_POKEMON_CENTER_1F                 0x4089
-#define VAR_MAP_SCENE_CINNABAR_ISLAND                 0x408A
-#define VAR_0x408B                 0x408B
+
+// Map Scene
+#define VAR_MAP_SCENE_PALLET_TOWN_OAK                                          0x4050
+#define VAR_MAP_SCENE_VIRIDIAN_CITY_OLD_MAN                                    0x4051
+#define VAR_MAP_SCENE_CERULEAN_CITY_RIVAL                                      0x4052
+#define VAR_VERMILION_CITY_TICKET_CHECK_TRIGGER                                           0x4053
+#define VAR_MAP_SCENE_ROUTE22                                                  0x4054
+#define VAR_MAP_SCENE_PALLET_TOWN_PROFESSOR_OAKS_LAB                           0x4055
+#define VAR_MAP_SCENE_PALLET_TOWN_PLAYERS_HOUSE_2F                             0x4056
+#define VAR_MAP_SCENE_VIRIDIAN_CITY_MART                                       0x4057
+#define VAR_MAP_SCENE_PALLET_TOWN_GARYS_HOUSE                                  0x4058
+#define VAR_MAP_SCENE_POKEMON_TOWER_6F                                         0x4059
+#define VAR_MAP_SCENE_VIRIDIAN_CITY_GYM_DOOR                                   0x405A
+#define VAR_MAP_SCENE_S_S_ANNE_2F_CORRIDOR                                     0x405B
+#define VAR_MAP_SCENE_SILPH_CO_7F                                              0x405C
+#define VAR_MAP_SCENE_POKEMON_TOWER_2F                                         0x405D
+#define VAR_MAP_SCENE_ROUTE16                                                  0x405E
+#define VAR_MAP_SCENE_ROUTE23                                                  0x405F
+#define VAR_MAP_SCENE_SILPH_CO_11F                                             0x4060
+#define VAR_MAP_SCENE_PEWTER_CITY_MUSEUM_1F                                    0x4061
+#define VAR_MAP_SCENE_ROUTE5_ROUTE6_ROUTE7_ROUTE8_GATES                        0x4062
+#define VAR_MAP_SCENE_SEAFOAM_ISLANDS_B4F                                      0x4063
+#define VAR_MAP_SCENE_VICTORY_ROAD_1F                                          0x4064
+#define VAR_MAP_SCENE_VICTORY_ROAD_2F_BOULDER1                                 0x4065
+#define VAR_MAP_SCENE_VICTORY_ROAD_2F_BOULDER2                                 0x4066
+#define VAR_MAP_SCENE_VICTORY_ROAD_3F                                          0x4067
+#define VAR_MAP_SCENE_POKEMON_LEAGUE                                           0x4068
+#define VAR_MAP_SCENE_CINNABAR_ISLAND_POKEMON_LAB_EXPERIMENT_ROOM_WHICH_FOSSIL 0x4069
+#define VAR_MAP_SCENE_CINNABAR_ISLAND_POKEMON_LAB_EXPERIMENT_ROOM_REVIVE_STATE 0x406A
+#define VAR_MAP_SCENE_ROUTE24                                                  0x406B
+#define VAR_MAP_SCENE_PEWTER_CITY                                              0x406C
+#define VAR_0x406D                                                             0x406D
+#define VAR_MAP_SCENE_FUCHSIA_CITY_SAFARI_ZONE_ENTRANCE                        0x406E
+#define VAR_0x406F                                                             0x406F
+#define VAR_MAP_SCENE_PALLET_TOWN_SIGN_LADY                                    0x4070
+#define VAR_MAP_SCENE_CINNABAR_ISLAND                                          0x4071
+#define VAR_0x4072                                                             0x4072
+#define VAR_MAP_SCENE_SAFFRON_CITY_POKEMON_TRAINER_FAN_CLUB                    0x4073
+#define VAR_MAP_SCENE_SEVEN_ISLAND_HOUSE_ROOM1                                 0x4074
+#define VAR_MAP_SCENE_ONE_ISLAND_HARBOR                                        0x4075
+#define VAR_MAP_SCENE_ONE_ISLAND_POKEMON_CENTER_1F                             0x4076
+#define VAR_0x4077                                                             0x4077
+#define VAR_MAP_SCENE_TWO_ISLAND                                               0x4078
+#define VAR_MAP_SCENE_TWO_ISLAND_JOYFUL_GAME_CORNER                            0x4079
+#define VAR_0x407A                                                             0x407A
+#define VAR_MAP_SCENE_THREE_ISLAND                                             0x407B
+#define VAR_MAP_SCENE_POKEMON_CENTER_TEALA                                     0x407C
+#define VAR_MAP_SCENE_CERULEAN_CITY_ROCKET                                     0x407D
+#define VAR_MAP_SCENE_VERMILION_CITY                                           0x407E
+#define VAR_MAP_SCENE_MT_EMBER_EXTERIOR                                        0x407F
+#define VAR_MAP_SCENE_ICEFALL_CAVE_BACK                                        0x4080
+#define VAR_MAP_SCENE_SAFFRON_CITY_DOJO                                        0x4081
+#define VAR_MAP_SCENE_TRAINER_TOWER                                            0x4082
+#define VAR_MAP_SCENE_FIVE_ISLAND_LOST_CAVE_ROOM10                             0x4083
+#define VAR_MAP_SCENE_FIVE_ISLAND_RESORT_GORGEOUS                              0x4084
+#define VAR_MAP_SCENE_INDIGO_PLATEAU_EXTERIOR                                  0x4085
+#define VAR_MAP_SCENE_FOUR_ISLAND                                              0x4086
+#define VAR_0x4087                                                             0x4087
+#define VAR_MAP_SCENE_ROCKET_WAREHOUSE                                         0x4088
+#define VAR_MAP_SCENE_SIX_ISLAND_POKEMON_CENTER_1F                             0x4089
+#define VAR_MAP_SCENE_CINNABAR_ISLAND_2                                        0x408A
+#define VAR_MAP_SCENE_MT_MOON_B2F                                              0x408B
+
+
 #define VAR_0x408C                 0x408C
 #define VAR_0x408D                 0x408D
 #define VAR_0x408E                 0x408E
@@ -187,7 +191,7 @@
 #define VAR_0x40B2                 0x40B2
 #define VAR_0x40B3                 0x40B3
 #define VAR_PORTHOLE               0x40B4
-#define VAR_EVENT_PICHU_SLOT                 0x40B5
+#define VAR_EVENT_PICHU_SLOT       0x40B5
 #define VAR_0x40B6                 0x40B6
 #define VAR_0x40B7                 0x40B7
 #define VAR_0x40B8                 0x40B8
diff --git a/include/global.h b/include/global.h
index 5ddf9a0a8..596f6b1d9 100644
--- a/include/global.h
+++ b/include/global.h
@@ -127,7 +127,7 @@ struct Pokedex
     /*0x00*/ u8 order;
     /*0x01*/ u8 unknown1;
     /*0x02*/ u8 nationalMagic; // must equal 0xDA in order to have National mode
-    /*0x03*/ u8 unknown2;
+    /*0x03*/ u8 unknown2; // set to 0xB9 when national dex is first enabled
     /*0x04*/ u32 unownPersonality; // set when you first see Unown
     /*0x08*/ u32 spindaPersonality; // set when you first see Spinda
     /*0x0C*/ u32 unknown3;