Clarify how the order of map constants matters for the Town Map (#553)

1 files changed, 132 insertions, 1 deletions

diff --git a/constants/map_constants.asm b/constants/map_constants.asm
index dad63579..7ae4af44 100644
--- a/constants/map_constants.asm
+++ b/constants/map_constants.asm
@@ -4,6 +4,13 @@ MACRO map_const
 	DEF \1_HEIGHT EQU \3
 ENDM
 
+; "Indoor" maps are grouped sequentially (see data/maps/town_map_entries.asm)
+DEF NUM_INDOOR_MAP_GROUPS EQU 0
+MACRO end_indoor_group
+	DEF INDOORGROUP_\1 EQU const_value
+	REDEF NUM_INDOOR_MAP_GROUPS EQU NUM_INDOOR_MAP_GROUPS + 1
+ENDM
+
 ; map ids
 ; indexes for:
 ; - MapHeaderBanks (see data/maps/map_header_banks.asm)
@@ -28,7 +35,9 @@ ENDM
 	map_const INDIGO_PLATEAU,                10,  9 ; $09
 	map_const SAFFRON_CITY,                  20, 18 ; $0A
 DEF NUM_CITY_MAPS EQU const_value
+
 	map_const UNUSED_MAP_0B,                  0,  0 ; $0B
+
 DEF FIRST_ROUTE_MAP EQU const_value
 	map_const ROUTE_1,                       10, 18 ; $0C
 	map_const ROUTE_2,                       10, 36 ; $0D
@@ -55,22 +64,31 @@ DEF FIRST_ROUTE_MAP EQU const_value
 	map_const ROUTE_23,                      10, 72 ; $22
 	map_const ROUTE_24,                      10, 18 ; $23
 	map_const ROUTE_25,                      30,  9 ; $24
+
 DEF FIRST_INDOOR_MAP EQU const_value
 	map_const REDS_HOUSE_1F,                  4,  4 ; $25
 	map_const REDS_HOUSE_2F,                  4,  4 ; $26
 	map_const BLUES_HOUSE,                    4,  4 ; $27
 	map_const OAKS_LAB,                       5,  6 ; $28
+	end_indoor_group PALLET_TOWN
+
 	map_const VIRIDIAN_POKECENTER,            7,  4 ; $29
 	map_const VIRIDIAN_MART,                  4,  4 ; $2A
 	map_const VIRIDIAN_SCHOOL_HOUSE,          4,  4 ; $2B
 	map_const VIRIDIAN_NICKNAME_HOUSE,        4,  4 ; $2C
 	map_const VIRIDIAN_GYM,                  10,  9 ; $2D
+	end_indoor_group VIRIDIAN_CITY
+
 	map_const DIGLETTS_CAVE_ROUTE_2,          4,  4 ; $2E
 	map_const VIRIDIAN_FOREST_NORTH_GATE,     5,  4 ; $2F
 	map_const ROUTE_2_TRADE_HOUSE,            4,  4 ; $30
 	map_const ROUTE_2_GATE,                   5,  4 ; $31
 	map_const VIRIDIAN_FOREST_SOUTH_GATE,     5,  4 ; $32
+	end_indoor_group ROUTE_2
+
 	map_const VIRIDIAN_FOREST,               17, 24 ; $33
+	end_indoor_group VIRIDIAN_FOREST
+
 	map_const MUSEUM_1F,                     10,  4 ; $34
 	map_const MUSEUM_2F,                      7,  4 ; $35
 	map_const PEWTER_GYM,                     5,  7 ; $36
@@ -78,42 +96,72 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const PEWTER_MART,                    4,  4 ; $38
 	map_const PEWTER_SPEECH_HOUSE,            4,  4 ; $39
 	map_const PEWTER_POKECENTER,              7,  4 ; $3A
+	end_indoor_group PEWTER_CITY
+
 	map_const MT_MOON_1F,                    20, 18 ; $3B
 	map_const MT_MOON_B1F,                   14, 14 ; $3C
 	map_const MT_MOON_B2F,                   20, 18 ; $3D
+	end_indoor_group MT_MOON
+
 	map_const CERULEAN_TRASHED_HOUSE,         4,  4 ; $3E
 	map_const CERULEAN_TRADE_HOUSE,           4,  4 ; $3F
 	map_const CERULEAN_POKECENTER,            7,  4 ; $40
 	map_const CERULEAN_GYM,                   5,  7 ; $41
 	map_const BIKE_SHOP,                      4,  4 ; $42
 	map_const CERULEAN_MART,                  4,  4 ; $43
+	end_indoor_group CERULEAN_CITY
+
 	map_const MT_MOON_POKECENTER,             7,  4 ; $44
+	end_indoor_group ROUTE_4
+
 	map_const CERULEAN_TRASHED_HOUSE_COPY,    4,  4 ; $45
+	end_indoor_group CERULEAN_CITY_2
+
 	map_const ROUTE_5_GATE,                   4,  3 ; $46
 	map_const UNDERGROUND_PATH_ROUTE_5,       4,  4 ; $47
 	map_const DAYCARE,                        4,  4 ; $48
+	end_indoor_group ROUTE_5
+
 	map_const ROUTE_6_GATE,                   4,  3 ; $49
 	map_const UNDERGROUND_PATH_ROUTE_6,       4,  4 ; $4A
 	map_const UNDERGROUND_PATH_ROUTE_6_COPY,  4,  4 ; $4B
+	end_indoor_group ROUTE_6
+
 	map_const ROUTE_7_GATE,                   3,  4 ; $4C
 	map_const UNDERGROUND_PATH_ROUTE_7,       4,  4 ; $4D
 	map_const UNDERGROUND_PATH_ROUTE_7_COPY,  4,  4 ; $4E
+	end_indoor_group ROUTE_7
+
 	map_const ROUTE_8_GATE,                   3,  4 ; $4F
 	map_const UNDERGROUND_PATH_ROUTE_8,       4,  4 ; $50
+	end_indoor_group ROUTE_8
+
 	map_const ROCK_TUNNEL_POKECENTER,         7,  4 ; $51
 	map_const ROCK_TUNNEL_1F,                20, 18 ; $52
+	end_indoor_group ROCK_TUNNEL
+
 	map_const POWER_PLANT,                   20, 18 ; $53
+	end_indoor_group POWER_PLANT
+
 	map_const ROUTE_11_GATE_1F,               4,  5 ; $54
 	map_const DIGLETTS_CAVE_ROUTE_11,         4,  4 ; $55
 	map_const ROUTE_11_GATE_2F,               4,  4 ; $56
+	end_indoor_group ROUTE_11
+
 	map_const ROUTE_12_GATE_1F,               5,  4 ; $57
+	end_indoor_group ROUTE_12
+
 	map_const BILLS_HOUSE,                    4,  4 ; $58
+	end_indoor_group SEA_COTTAGE
+
 	map_const VERMILION_POKECENTER,           7,  4 ; $59
 	map_const POKEMON_FAN_CLUB,               4,  4 ; $5A
 	map_const VERMILION_MART,                 4,  4 ; $5B
 	map_const VERMILION_GYM,                  5,  9 ; $5C
 	map_const VERMILION_PIDGEY_HOUSE,         4,  4 ; $5D
 	map_const VERMILION_DOCK,                14,  6 ; $5E
+	end_indoor_group VERMILION_CITY
+
 	map_const SS_ANNE_1F,                    20,  9 ; $5F
 	map_const SS_ANNE_2F,                    20,  9 ; $60
 	map_const SS_ANNE_3F,                    10,  3 ; $61
@@ -124,10 +172,14 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const SS_ANNE_1F_ROOMS,              12,  8 ; $66
 	map_const SS_ANNE_2F_ROOMS,              12,  8 ; $67
 	map_const SS_ANNE_B1F_ROOMS,             12,  8 ; $68
+	end_indoor_group SS_ANNE
+
 	map_const UNUSED_MAP_69,                  0,  0 ; $69
 	map_const UNUSED_MAP_6A,                  0,  0 ; $6A
 	map_const UNUSED_MAP_6B,                  0,  0 ; $6B
 	map_const VICTORY_ROAD_1F,               10,  9 ; $6C
+	end_indoor_group VICTORY_ROAD
+
 	map_const UNUSED_MAP_6D,                  0,  0 ; $6D
 	map_const UNUSED_MAP_6E,                  0,  0 ; $6E
 	map_const UNUSED_MAP_6F,                  0,  0 ; $6F
@@ -138,9 +190,17 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const UNUSED_MAP_74,                  0,  0 ; $74
 	map_const UNUSED_MAP_75,                  0,  0 ; $75
 	map_const HALL_OF_FAME,                   5,  4 ; $76
+	end_indoor_group POKEMON_LEAGUE
+
 	map_const UNDERGROUND_PATH_NORTH_SOUTH,   4, 24 ; $77 ; UndergroundPathNorthSouth.blk is actually 4x23
+	end_indoor_group UNDERGROUND_PATH
+
 	map_const CHAMPIONS_ROOM,                 4,  4 ; $78
+	end_indoor_group POKEMON_LEAGUE_2
+
 	map_const UNDERGROUND_PATH_WEST_EAST,    25,  4 ; $79
+	end_indoor_group UNDERGROUND_PATH_2
+
 	map_const CELADON_MART_1F,               10,  4 ; $7A
 	map_const CELADON_MART_2F,               10,  4 ; $7B
 	map_const CELADON_MART_3F,               10,  4 ; $7C
@@ -160,7 +220,11 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const CELADON_DINER,                  5,  4 ; $8A
 	map_const CELADON_CHIEF_HOUSE,            4,  4 ; $8B
 	map_const CELADON_HOTEL,                  7,  4 ; $8C
+	end_indoor_group CELADON_CITY
+
 	map_const LAVENDER_POKECENTER,            7,  4 ; $8D
+	end_indoor_group LAVENDER_TOWN
+
 	map_const POKEMON_TOWER_1F,              10,  9 ; $8E
 	map_const POKEMON_TOWER_2F,              10,  9 ; $8F
 	map_const POKEMON_TOWER_3F,              10,  9 ; $90
@@ -168,23 +232,41 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const POKEMON_TOWER_5F,              10,  9 ; $92
 	map_const POKEMON_TOWER_6F,              10,  9 ; $93
 	map_const POKEMON_TOWER_7F,              10,  9 ; $94
+	end_indoor_group POKEMON_TOWER
+
 	map_const MR_FUJIS_HOUSE,                 4,  4 ; $95
 	map_const LAVENDER_MART,                  4,  4 ; $96
 	map_const LAVENDER_CUBONE_HOUSE,          4,  4 ; $97
+	end_indoor_group LAVENDER_TOWN_2
+
 	map_const FUCHSIA_MART,                   4,  4 ; $98
 	map_const FUCHSIA_BILLS_GRANDPAS_HOUSE,   4,  4 ; $99
 	map_const FUCHSIA_POKECENTER,             7,  4 ; $9A
 	map_const WARDENS_HOUSE,                  5,  4 ; $9B
+	end_indoor_group FUCHSIA_CITY
+
 	map_const SAFARI_ZONE_GATE,               4,  3 ; $9C
+	end_indoor_group SAFARI_ZONE
+
 	map_const FUCHSIA_GYM,                    5,  9 ; $9D
 	map_const FUCHSIA_MEETING_ROOM,           7,  4 ; $9E
+	end_indoor_group FUCHSIA_CITY_2
+
 	map_const SEAFOAM_ISLANDS_B1F,           15,  9 ; $9F
 	map_const SEAFOAM_ISLANDS_B2F,           15,  9 ; $A0
 	map_const SEAFOAM_ISLANDS_B3F,           15,  9 ; $A1
 	map_const SEAFOAM_ISLANDS_B4F,           15,  9 ; $A2
+	end_indoor_group SEAFOAM_ISLANDS
+
 	map_const VERMILION_OLD_ROD_HOUSE,        4,  4 ; $A3
+	end_indoor_group VERMILION_CITY_2
+
 	map_const FUCHSIA_GOOD_ROD_HOUSE,         4,  4 ; $A4
+	end_indoor_group FUCHSIA_CITY_3
+
 	map_const POKEMON_MANSION_1F,            15, 14 ; $A5
+	end_indoor_group POKEMON_MANSION
+
 	map_const CINNABAR_GYM,                  10,  9 ; $A6
 	map_const CINNABAR_LAB,                   9,  4 ; $A7
 	map_const CINNABAR_LAB_TRADE_ROOM,        4,  4 ; $A8
@@ -193,7 +275,11 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const CINNABAR_POKECENTER,            7,  4 ; $AB
 	map_const CINNABAR_MART,                  4,  4 ; $AC
 	map_const CINNABAR_MART_COPY,             4,  4 ; $AD
+	end_indoor_group CINNABAR_ISLAND
+
 	map_const INDIGO_PLATEAU_LOBBY,           8,  6 ; $AE
+	end_indoor_group INDIGO_PLATEAU
+
 	map_const COPYCATS_HOUSE_1F,              4,  4 ; $AF
 	map_const COPYCATS_HOUSE_2F,              4,  4 ; $B0
 	map_const FIGHTING_DOJO,                  5,  6 ; $B1
@@ -203,21 +289,45 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const SILPH_CO_1F,                   15,  9 ; $B5
 	map_const SAFFRON_POKECENTER,             7,  4 ; $B6
 	map_const MR_PSYCHICS_HOUSE,              4,  4 ; $B7
+	end_indoor_group SAFFRON_CITY
+
 	map_const ROUTE_15_GATE_1F,               4,  5 ; $B8
 	map_const ROUTE_15_GATE_2F,               4,  4 ; $B9
+	end_indoor_group ROUTE_15
+
 	map_const ROUTE_16_GATE_1F,               4,  7 ; $BA
 	map_const ROUTE_16_GATE_2F,               4,  4 ; $BB
 	map_const ROUTE_16_FLY_HOUSE,             4,  4 ; $BC
+	end_indoor_group ROUTE_16
+
 	map_const ROUTE_12_SUPER_ROD_HOUSE,       4,  4 ; $BD
+	end_indoor_group ROUTE_12_2
+
 	map_const ROUTE_18_GATE_1F,               4,  5 ; $BE
 	map_const ROUTE_18_GATE_2F,               4,  4 ; $BF
+	end_indoor_group ROUTE_18
+
 	map_const SEAFOAM_ISLANDS_1F,            15,  9 ; $C0
+	end_indoor_group SEAFOAM_ISLANDS_2
+
 	map_const ROUTE_22_GATE,                  5,  4 ; $C1
+	end_indoor_group ROUTE_22
+
 	map_const VICTORY_ROAD_2F,               15,  9 ; $C2
+	end_indoor_group VICTORY_ROAD_2
+
 	map_const ROUTE_12_GATE_2F,               4,  4 ; $C3
+	end_indoor_group ROUTE_12_3
+
 	map_const VERMILION_TRADE_HOUSE,          4,  4 ; $C4
+	end_indoor_group VERMILION_CITY_3
+
 	map_const DIGLETTS_CAVE,                 20, 18 ; $C5
+	end_indoor_group DIGLETTS_CAVE
+
 	map_const VICTORY_ROAD_3F,               15,  9 ; $C6
+	end_indoor_group VICTORY_ROAD_3
+
 	map_const ROCKET_HIDEOUT_B1F,            15, 14 ; $C7
 	map_const ROCKET_HIDEOUT_B2F,            15, 14 ; $C8
 	map_const ROCKET_HIDEOUT_B3F,            15, 14 ; $C9
@@ -226,6 +336,8 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const UNUSED_MAP_CC,                  0,  0 ; $CC
 	map_const UNUSED_MAP_CD,                  0,  0 ; $CD
 	map_const UNUSED_MAP_CE,                  0,  0 ; $CE
+	end_indoor_group ROCKET_HQ
+
 	map_const SILPH_CO_2F,                   15,  9 ; $CF
 	map_const SILPH_CO_3F,                   15,  9 ; $D0
 	map_const SILPH_CO_4F,                   15,  9 ; $D1
@@ -233,9 +345,13 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const SILPH_CO_6F,                   13,  9 ; $D3
 	map_const SILPH_CO_7F,                   13,  9 ; $D4
 	map_const SILPH_CO_8F,                   13,  9 ; $D5
+	end_indoor_group SILPH_CO
+
 	map_const POKEMON_MANSION_2F,            15, 14 ; $D6
 	map_const POKEMON_MANSION_3F,            15,  9 ; $D7
 	map_const POKEMON_MANSION_B1F,           15, 14 ; $D8
+	end_indoor_group POKEMON_MANSION_2
+
 	map_const SAFARI_ZONE_EAST,              15, 13 ; $D9
 	map_const SAFARI_ZONE_NORTH,             20, 18 ; $DA
 	map_const SAFARI_ZONE_WEST,              15, 13 ; $DB
@@ -245,17 +361,29 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const SAFARI_ZONE_WEST_REST_HOUSE,    4,  4 ; $DF
 	map_const SAFARI_ZONE_EAST_REST_HOUSE,    4,  4 ; $E0
 	map_const SAFARI_ZONE_NORTH_REST_HOUSE,   4,  4 ; $E1
+	end_indoor_group SAFARI_ZONE_2
+
 	map_const CERULEAN_CAVE_2F,              15,  9 ; $E2
 	map_const CERULEAN_CAVE_B1F,             15,  9 ; $E3
 	map_const CERULEAN_CAVE_1F,              15,  9 ; $E4
+	end_indoor_group CERULEAN_CAVE
+
 	map_const NAME_RATERS_HOUSE,              4,  4 ; $E5
+	end_indoor_group LAVENDER_TOWN_3
+
 	map_const CERULEAN_BADGE_HOUSE,           4,  4 ; $E6
+	end_indoor_group CERULEAN_CITY_3
+
 	map_const UNUSED_MAP_E7,                  0,  0 ; $E7
 	map_const ROCK_TUNNEL_B1F,               20, 18 ; $E8
+	end_indoor_group ROCK_TUNNEL_2
+
 	map_const SILPH_CO_9F,                   13,  9 ; $E9
 	map_const SILPH_CO_10F,                   8,  9 ; $EA
 	map_const SILPH_CO_11F,                   9,  9 ; $EB
 	map_const SILPH_CO_ELEVATOR,              2,  2 ; $EC
+	end_indoor_group SILPH_CO_2
+
 	map_const UNUSED_MAP_ED,                  0,  0 ; $ED
 	map_const UNUSED_MAP_EE,                  0,  0 ; $EE
 	map_const TRADE_CENTER,                   5,  4 ; $EF
@@ -267,8 +395,11 @@ DEF FIRST_INDOOR_MAP EQU const_value
 	map_const LORELEIS_ROOM,                  5,  6 ; $F5
 	map_const BRUNOS_ROOM,                    5,  6 ; $F6
 	map_const AGATHAS_ROOM,                   5,  6 ; $F7
+	end_indoor_group POKEMON_LEAGUE_3
 DEF NUM_MAPS EQU const_value
 
 ; Indoor maps, such as houses, use this as the Map ID in their exit warps
 ; This map ID takes the player back to the last outdoor map they were on, stored in wLastMap
-DEF LAST_MAP EQU -1
+DEF LAST_MAP EQU $ff
+
+ASSERT NUM_MAPS <= LAST_MAP, "map IDs overlap LAST_MAP"