Merge pull request #585 from GriffinRichards/doc-areamarkers

Document pokedex area markers

include/pokedex.h

@@ -15,6 +15,90 @@ enum
     FLAG_SET_CAUGHT
 };
 
+// IDs for the pokedex area markers
+enum {
+    DEX_AREA_NONE,
+    DEX_AREA_PALLET_TOWN,
+    DEX_AREA_VIRIDIAN_CITY,
+    DEX_AREA_PEWTER_CITY,
+    DEX_AREA_CERULEAN_CITY,
+    DEX_AREA_LAVENDER_TOWN,
+    DEX_AREA_VERMILION_CITY,
+    DEX_AREA_CELADON_CITY,
+    DEX_AREA_FUCHSIA_CITY,
+    DEX_AREA_CINNABAR_ISLAND,
+    DEX_AREA_INDIGO_PLATEAU,
+    DEX_AREA_SAFFRON_CITY,
+    DEX_AREA_ROUTE_1,
+    DEX_AREA_ROUTE_2,
+    DEX_AREA_ROUTE_3,
+    DEX_AREA_ROUTE_4,
+    DEX_AREA_ROUTE_5,
+    DEX_AREA_ROUTE_6,
+    DEX_AREA_ROUTE_7,
+    DEX_AREA_ROUTE_8,
+    DEX_AREA_ROUTE_9,
+    DEX_AREA_ROUTE_10,
+    DEX_AREA_ROUTE_11,
+    DEX_AREA_ROUTE_12,
+    DEX_AREA_ROUTE_13,
+    DEX_AREA_ROUTE_14,
+    DEX_AREA_ROUTE_15,
+    DEX_AREA_ROUTE_16,
+    DEX_AREA_ROUTE_17,
+    DEX_AREA_ROUTE_18,
+    DEX_AREA_ROUTE_19,
+    DEX_AREA_ROUTE_20,
+    DEX_AREA_ROUTE_21,
+    DEX_AREA_ROUTE_22,
+    DEX_AREA_ROUTE_23,
+    DEX_AREA_ROUTE_24,
+    DEX_AREA_ROUTE_25,
+    DEX_AREA_VIRIDIAN_FOREST,
+    DEX_AREA_DIGLETTS_CAVE,
+    DEX_AREA_MT_MOON,
+    DEX_AREA_CERULEAN_CAVE,
+    DEX_AREA_ROCK_TUNNEL,
+    DEX_AREA_POWER_PLANT,
+    DEX_AREA_POKEMON_TOWER,
+    DEX_AREA_SAFARI_ZONE,
+    DEX_AREA_SEAFOAM_ISLANDS,
+    DEX_AREA_POKEMON_MANSION,
+    DEX_AREA_VICTORY_ROAD,
+    DEX_AREA_ONE_ISLAND,
+    DEX_AREA_TWO_ISLAND,
+    DEX_AREA_THREE_ISLAND,
+    DEX_AREA_FOUR_ISLAND,
+    DEX_AREA_FIVE_ISLAND,
+    DEX_AREA_SIX_ISLAND, // Not associated with any MAPSEC
+    DEX_AREA_SEVEN_ISLAND, // Not associated with any MAPSEC
+    DEX_AREA_KINDLE_ROAD,
+    DEX_AREA_TREASURE_BEACH,
+    DEX_AREA_CAPE_BRINK,
+    DEX_AREA_BOND_BRIDGE,
+    DEX_AREA_THREE_ISLE_PATH,
+    DEX_AREA_RESORT_GORGEOUS,
+    DEX_AREA_WATER_LABYRINTH,
+    DEX_AREA_FIVE_ISLE_MEADOW,
+    DEX_AREA_MEMORIAL_PILLAR,
+    DEX_AREA_OUTCAST_ISLAND,
+    DEX_AREA_GREEN_PATH,
+    DEX_AREA_WATER_PATH,
+    DEX_AREA_RUIN_VALLEY,
+    DEX_AREA_TRAINER_TOWER,
+    DEX_AREA_CANYON_ENTRANCE,
+    DEX_AREA_SEVAULT_CANYON,
+    DEX_AREA_TANOBY_RUINS,
+    DEX_AREA_MT_EMBER,
+    DEX_AREA_BERRY_FOREST,
+    DEX_AREA_ICEFALL_CAVE,
+    DEX_AREA_LOST_CAVE,
+    DEX_AREA_ALTERING_CAVE,
+    DEX_AREA_PATTERN_BUSH,
+    DEX_AREA_DOTTED_HOLE,
+    DEX_AREA_TANOBY_CHAMBER,
+};
+
 struct PokedexEntry
 {
     /*0x00*/ u8 categoryName[12];

include/pokedex_area_markers.h

@@ -1,19 +1,9 @@
 #ifndef GUARD_POKEDEX_AREA_MARKERS_H
 #define GUARD_POKEDEX_AREA_MARKERS_H
 
-struct PAM_TaskData
-{
-    struct SubspriteTable subsprites;
-    void *buffer;
-    u8 unk_0C;
-    u8 spr_id;
-    u16 tilesTag;
-    u16 unk_10;
-};
-
-void SetAreaSubsprite(s32 i, s32 whichArea, struct Subsprite * subsprites);
-void Dtor_PokedexAreaMarkers(u8 taskId);
-u8 Ctor_PokedexAreaMarkers(u16 species, u16 tilesTag, u8 palIdx, u8 y);
-u8 PokedexAreaMarkers_Any(u8 taskId);
+void GetAreaMarkerSubsprite(s32 i, s32 dexArea, struct Subsprite * subsprites);
+void DestroyPokedexAreaMarkers(u8 taskId);
+u8 CreatePokedexAreaMarkers(u16 species, u16 tilesTag, u8 palIdx, u8 y);
+u8 GetNumPokedexAreaMarkers(u8 taskId);
 
 #endif //GUARD_POKEDEX_AREA_MARKERS_H

include/wild_encounter.h

@@ -8,6 +8,8 @@
 #define ROCK_WILD_COUNT     5
 #define FISH_WILD_COUNT     10
 
+#define NUM_ALTERING_CAVE_TABLES 9
+
 struct WildPokemon
 {
     u8 minLevel;

include/wild_pokemon_area.h

@@ -1,6 +1,6 @@
 #ifndef GUARD_WILD_POKEMON_AREA_H
 #define GUARD_WILD_POKEMON_AREA_H
 
-s32 BuildPokedexAreaSubspriteBuffer(u16 species, struct Subsprite * subsprites);
+s32 GetSpeciesPokedexAreaMarkers(u16 species, struct Subsprite * subsprites);
 
 #endif //GUARD_WILD_POKEMON_AREA_H