Merge pull request #318 from GriffinRichards/doc-rm

Document region map

asm/pokemon_summary_screen.s

@@ -5791,7 +5791,7 @@ _081375B2:
 	add r4, sp, 0x1C
 	adds r0, r4, 0
 	adds r1, r5, 0
-	bl sub_80C4E08
+	bl GetMapNameGeneric_
 	b _08137626
 	.align 2, 0
 _081375E8: .4byte gUnknown_203B140
@@ -6067,7 +6067,7 @@ _08137830:
 	add r4, sp, 0x1C
 	adds r0, r4, 0
 	adds r1, r5, 0
-	bl sub_80C4E08
+	bl GetMapNameGeneric_
 	b _08137850
 _08137846:
 	add r4, sp, 0x1C

include/constants/map_types.h

@@ -3,14 +3,14 @@
 
 #define MAP_TYPE_NONE        0
 #define MAP_TYPE_TOWN        1
-#define MAP_TYPE_CITY        2 // Unused. RSE use this map type to distinguish Town and City. FRLG make no distinction
+#define MAP_TYPE_CITY        2 // Not used by any map. RSE use this map type to distinguish Town and City. FRLG make no distinction
 #define MAP_TYPE_ROUTE       3
 #define MAP_TYPE_UNDERGROUND 4
-#define MAP_TYPE_UNDERWATER  5 // Unused
+#define MAP_TYPE_UNDERWATER  5 // Not used by any map.
-#define MAP_TYPE_OCEAN_ROUTE 6 // Unused
+#define MAP_TYPE_OCEAN_ROUTE 6 // Not used by any map.
-#define MAP_TYPE_UNKNOWN     7 // Unused
+#define MAP_TYPE_UNKNOWN     7 // Not used by any map.
 #define MAP_TYPE_INDOOR      8
-#define MAP_TYPE_SECRET_BASE 9 // Unused
+#define MAP_TYPE_SECRET_BASE 9 // Not used by any map.
 
 #define MAP_BATTLE_SCENE_NORMAL   0
 #define MAP_BATTLE_SCENE_GYM      1

include/constants/region_map_sections.h

@@ -103,8 +103,8 @@
 #define MAPSEC_CINNABAR_ISLAND              0x60
 #define MAPSEC_INDIGO_PLATEAU               0x61
 #define MAPSEC_SAFFRON_CITY                 0x62
-#define MAPSEC_ROUTE_4_FLYDUP               0x63
+#define MAPSEC_ROUTE_4_POKECENTER           0x63
-#define MAPSEC_ROUTE_10_FLYDUP              0x64
+#define MAPSEC_ROUTE_10_POKECENTER          0x64
 #define MAPSEC_ROUTE_1                      0x65
 #define MAPSEC_ROUTE_2                      0x66
 #define MAPSEC_ROUTE_3                      0x67
@@ -205,6 +205,7 @@
 #define MAPSEC_EMBER_SPA                    0xC3
 #define MAPSEC_SPECIAL_AREA                 0xC4
 #define MAPSEC_NONE                         0xC5
+#define MAPSEC_COUNT                        0xC6
 
 #define METLOC_SPECIAL_EGG                  0xFD
 #define METLOC_IN_GAME_TRADE                0xFE

include/region_map.h

@@ -2,48 +2,19 @@
 #define GUARD_REGION_MAP_H
 
 #include "global.h"
-
 #include "bg.h"
 
-// Exported type declarations
-
-enum
-{
-    INPUT_EVENT_NONE,
-    INPUT_EVENT_MOVE_START,
-    INPUT_EVENT_MOVE_CONT,
-    INPUT_EVENT_MOVE_END,
-    INPUT_EVENT_A_BUTTON,
-    INPUT_EVENT_B_BUTTON,
-};
-
 enum {
-    MAPSECTYPE_NONE,
+    REGIONMAP_TYPE_NORMAL,
-    MAPSECTYPE_PLAIN,
+    REGIONMAP_TYPE_WALL,
-    MAPSECTYPE_CITY_CANFLY,
+    REGIONMAP_TYPE_FLY,
-    MAPSECTYPE_CITY_CANTFLY,
+    REGIONMAP_TYPE_COUNT
 };
 
-enum {
-    MAPPERM_0,
-    MAPPERM_1,
-    MAPPERM_2,
-    MAPPERM_3
-};
-
-enum {
-    REGIONMAP_KANTO,
-    REGIONMAP_SEVII123,
-    REGIONMAP_SEVII45,
-    REGIONMAP_SEVII67
-};
-
-// Exported RAM declarations
-
-// Exported ROM declarations
 u8 *GetMapName(u8 *dest, u16 mapsec, u16 fill);
 u8 *GetMapNameGeneric(u8 *dest, u16 mapsec);
-void sub_80BFF50(u8 a0, void (*a1)(void));
+u8 *GetMapNameGeneric_(u8 *dest, u16 mapsec);
-void MCB2_FlyMap(void);
+void InitRegionMapWithExitCB(u8 a0, void (*a1)(void));
+void CB2_OpenFlyMap(void);
 
-#endif //GUARD_REGION_MAP_H
+#endif // GUARD_REGION_MAP_H

src/field_specials.c

@@ -188,7 +188,7 @@ u8 GetLeadMonFriendship(void)
 void ShowTownMap(void)
 {
     QuestLog_OnInteractionWithSpecialNpc();
-    sub_80BFF50(1, CB2_ReturnToFieldContinueScriptPlayMapMusic);
+    InitRegionMapWithExitCB(REGIONMAP_TYPE_WALL, CB2_ReturnToFieldContinueScriptPlayMapMusic);
 }
 
 bool8 PlayerHasGrassPokemonInParty(void)

src/item_use.c

@@ -668,7 +668,7 @@ void FieldUseFunc_TownMap(u8 taskId)
 
 static void sub_80A1CAC(void)
 {
-    sub_80BFF50(0, CB2_BagMenuFromStartMenu);
+    InitRegionMapWithExitCB(REGIONMAP_TYPE_NORMAL, CB2_BagMenuFromStartMenu);
 }
 
 static void sub_80A1CC0(u8 taskId)
@@ -677,7 +677,7 @@ static void sub_80A1CC0(u8 taskId)
     {
         CleanupOverworldWindowsAndTilemaps();
         sub_80A1184();
-        sub_80BFF50(0, CB2_ReturnToField);
+        InitRegionMapWithExitCB(REGIONMAP_TYPE_NORMAL, CB2_ReturnToField);
         DestroyTask(taskId);
     }
 }

src/party_menu.c

@@ -3970,7 +3970,7 @@ static void CursorCB_FieldMove(u8 taskId)
                 sPartyMenuInternal->data[0] = fieldMove;
                 break;
             case FIELD_MOVE_FLY:
-                gPartyMenu.exitCallback = MCB2_FlyMap;
+                gPartyMenu.exitCallback = CB2_OpenFlyMap;
                 Task_ClosePartyMenu(taskId);
                 break;
             default:

src/wild_pokemon_area.c

@@ -29,61 +29,61 @@ static u16 GetMapSecIdFromWildMonHeader(const struct WildPokemonHeader * header)
 static bool32 TryGetMapSecPokedexAreaEntry(u16 mapSecId, const u16 (*lut)[2], s32 count, s32 * lutIdx_p, u16 * tableIdx_p);
 
 static const u16 sDexAreas_Kanto[][2] = {
-    { MAPSEC_PALLET_TOWN,         1 },
+    { MAPSEC_PALLET_TOWN,          1 },
-    { MAPSEC_VIRIDIAN_CITY,       2 },
+    { MAPSEC_VIRIDIAN_CITY,        2 },
-    { MAPSEC_PEWTER_CITY,         3 },
+    { MAPSEC_PEWTER_CITY,          3 },
-    { MAPSEC_CERULEAN_CITY,       4 },
+    { MAPSEC_CERULEAN_CITY,        4 },
-    { MAPSEC_LAVENDER_TOWN,       5 },
+    { MAPSEC_LAVENDER_TOWN,        5 },
-    { MAPSEC_VERMILION_CITY,      6 },
+    { MAPSEC_VERMILION_CITY,       6 },
-    { MAPSEC_CELADON_CITY,        7 },
+    { MAPSEC_CELADON_CITY,         7 },
-    { MAPSEC_FUCHSIA_CITY,        8 },
+    { MAPSEC_FUCHSIA_CITY,         8 },
-    { MAPSEC_CINNABAR_ISLAND,     9 },
+    { MAPSEC_CINNABAR_ISLAND,      9 },
-    { MAPSEC_INDIGO_PLATEAU,     10 },
+    { MAPSEC_INDIGO_PLATEAU,      10 },
-    { MAPSEC_SAFFRON_CITY,       11 },
+    { MAPSEC_SAFFRON_CITY,        11 },
-    { MAPSEC_ROUTE_4_FLYDUP,     15 },
+    { MAPSEC_ROUTE_4_POKECENTER,  15 },
-    { MAPSEC_ROUTE_10_FLYDUP,    21 },
+    { MAPSEC_ROUTE_10_POKECENTER, 21 },
-    { MAPSEC_ROUTE_1,            12 },
+    { MAPSEC_ROUTE_1,             12 },
-    { MAPSEC_ROUTE_2,            13 },
+    { MAPSEC_ROUTE_2,             13 },
-    { MAPSEC_ROUTE_3,            14 },
+    { MAPSEC_ROUTE_3,             14 },
-    { MAPSEC_ROUTE_4,            15 },
+    { MAPSEC_ROUTE_4,             15 },
-    { MAPSEC_ROUTE_5,            16 },
+    { MAPSEC_ROUTE_5,             16 },
-    { MAPSEC_ROUTE_6,            17 },
+    { MAPSEC_ROUTE_6,             17 },
-    { MAPSEC_ROUTE_7,            18 },
+    { MAPSEC_ROUTE_7,             18 },
-    { MAPSEC_ROUTE_8,            19 },
+    { MAPSEC_ROUTE_8,             19 },
-    { MAPSEC_ROUTE_9,            20 },
+    { MAPSEC_ROUTE_9,             20 },
-    { MAPSEC_ROUTE_10,           21 },
+    { MAPSEC_ROUTE_10,            21 },
-    { MAPSEC_ROUTE_11,           22 },
+    { MAPSEC_ROUTE_11,            22 },
-    { MAPSEC_ROUTE_12,           23 },
+    { MAPSEC_ROUTE_12,            23 },
-    { MAPSEC_ROUTE_13,           24 },
+    { MAPSEC_ROUTE_13,            24 },
-    { MAPSEC_ROUTE_14,           25 },
+    { MAPSEC_ROUTE_14,            25 },
-    { MAPSEC_ROUTE_15,           26 },
+    { MAPSEC_ROUTE_15,            26 },
-    { MAPSEC_ROUTE_16,           27 },
+    { MAPSEC_ROUTE_16,            27 },
-    { MAPSEC_ROUTE_17,           28 },
+    { MAPSEC_ROUTE_17,            28 },
-    { MAPSEC_ROUTE_18,           29 },
+    { MAPSEC_ROUTE_18,            29 },
-    { MAPSEC_ROUTE_19,           30 },
+    { MAPSEC_ROUTE_19,            30 },
-    { MAPSEC_ROUTE_20,           31 },
+    { MAPSEC_ROUTE_20,            31 },
-    { MAPSEC_ROUTE_21,           32 },
+    { MAPSEC_ROUTE_21,            32 },
-    { MAPSEC_ROUTE_22,           33 },
+    { MAPSEC_ROUTE_22,            33 },
-    { MAPSEC_ROUTE_23,           34 },
+    { MAPSEC_ROUTE_23,            34 },
-    { MAPSEC_ROUTE_24,           35 },
+    { MAPSEC_ROUTE_24,            35 },
-    { MAPSEC_ROUTE_25,           36 },
+    { MAPSEC_ROUTE_25,            36 },
-    { MAPSEC_VIRIDIAN_FOREST,    37 },
+    { MAPSEC_VIRIDIAN_FOREST,     37 },
-    { MAPSEC_MT_MOON,            39 },
+    { MAPSEC_MT_MOON,             39 },
-    { MAPSEC_S_S_ANNE,            6 },
+    { MAPSEC_S_S_ANNE,             6 },
-    { MAPSEC_UNDERGROUND_PATH,   11 },
+    { MAPSEC_UNDERGROUND_PATH,    11 },
-    { MAPSEC_UNDERGROUND_PATH_2, 11 },
+    { MAPSEC_UNDERGROUND_PATH_2,  11 },
-    { MAPSEC_DIGLETTS_CAVE,      38 },
+    { MAPSEC_DIGLETTS_CAVE,       38 },
-    { MAPSEC_KANTO_VICTORY_ROAD, 47 },
+    { MAPSEC_KANTO_VICTORY_ROAD,  47 },
-    { MAPSEC_ROCKET_HIDEOUT,      7 },
+    { MAPSEC_ROCKET_HIDEOUT,       7 },
-    { MAPSEC_SILPH_CO,           11 },
+    { MAPSEC_SILPH_CO,            11 },
-    { MAPSEC_POKEMON_MANSION,    46 },
+    { MAPSEC_POKEMON_MANSION,     46 },
-    { MAPSEC_KANTO_SAFARI_ZONE,  44 },
+    { MAPSEC_KANTO_SAFARI_ZONE,   44 },
-    { MAPSEC_POKEMON_LEAGUE,     47 },
+    { MAPSEC_POKEMON_LEAGUE,      47 },
-    { MAPSEC_ROCK_TUNNEL,        41 },
+    { MAPSEC_ROCK_TUNNEL,         41 },
-    { MAPSEC_SEAFOAM_ISLANDS,    45 },
+    { MAPSEC_SEAFOAM_ISLANDS,     45 },
-    { MAPSEC_POKEMON_TOWER,      43 },
+    { MAPSEC_POKEMON_TOWER,       43 },
-    { MAPSEC_CERULEAN_CAVE,      40 },
+    { MAPSEC_CERULEAN_CAVE,       40 },
-    { MAPSEC_POWER_PLANT,        42 }
+    { MAPSEC_POWER_PLANT,         42 }
 };
 
 static const u16 sDexAreas_Sevii1[][2] = {