Merge pull request #197 from PikalaxALT/pokedex_screen

Some documentation in pokedex_screen

5 files changed, 86 insertions, 76 deletions

diff --git a/asm/pokedex_screen.s b/asm/pokedex_screen.s
index 94107279e..d9dcbc162 100644
--- a/asm/pokedex_screen.s
+++ b/asm/pokedex_screen.s
@@ -1026,7 +1026,7 @@ sub_8105D64: @ 8105D64
 	lsls r0, 24
 	cmp r0, 0
 	beq _08105E02
-	ldr r1, _08105E14 @ =gUnknown_843FAB0
+	ldr r1, _08105E14 @ =gMonFootprintPtrs
 	lsls r0, r4, 2
 	adds r0, r1
 	ldr r0, [r0]
@@ -1092,7 +1092,7 @@ _08105E02:
 	pop {r0}
 	bx r0
 	.align 2, 0
-_08105E14: .4byte gUnknown_843FAB0
+_08105E14: .4byte gMonFootprintPtrs
 _08105E18: .4byte gDecompressionBuffer
 	thumb_func_end sub_8105D64
 
@@ -2269,7 +2269,7 @@ sub_8106838: @ 8106838
 	lsls r0, 24
 	lsls r1, 24
 	lsrs r6, r1, 24
-	ldr r1, _08106888 @ =gUnknown_8452C4C
+	ldr r1, _08106888 @ =gDexCategories
 	lsrs r0, 21
 	adds r0, r1
 	ldr r2, [r0]
@@ -2303,7 +2303,7 @@ _08106858:
 	movs r0, 0x1
 	b _08106894
 	.align 2, 0
-_08106888: .4byte gUnknown_8452C4C
+_08106888: .4byte gDexCategories
 _0810688C:
 	adds r5, 0x1
 	cmp r5, 0x3
@@ -2322,7 +2322,7 @@ sub_81068A0: @ 81068A0
 	push {r4-r6,lr}
 	lsls r0, 24
 	lsrs r6, r0, 24
-	ldr r1, _081068C8 @ =gUnknown_8452C4C
+	ldr r1, _081068C8 @ =gDexCategories
 	lsls r0, r6, 3
 	adds r0, r1
 	ldrb r5, [r0, 0x4]
@@ -2340,7 +2340,7 @@ _081068B4:
 	movs r0, 0x1
 	b _081068D4
 	.align 2, 0
-_081068C8: .4byte gUnknown_8452C4C
+_081068C8: .4byte gDexCategories
 _081068CC:
 	adds r4, 0x1
 	cmp r4, r5
@@ -2363,7 +2363,7 @@ sub_81068DC: @ 81068DC
 	lsrs r4, r0, 24
 	lsls r1, 24
 	lsrs r6, r1, 24
-	ldr r1, _08106990 @ =gUnknown_8452C4C
+	ldr r1, _08106990 @ =gDexCategories
 	lsls r0, r4, 3
 	adds r0, r1
 	ldr r1, [r0]
@@ -2393,7 +2393,7 @@ _0810690C:
 	movs r5, 0
 	cmp r5, r9
 	bge _08106982
-	ldr r1, _08106990 @ =gUnknown_8452C4C
+	ldr r1, _08106990 @ =gDexCategories
 	lsls r0, r4, 3
 	adds r0, r1
 	mov r8, r0
@@ -2447,7 +2447,7 @@ _08106982:
 	pop {r0}
 	bx r0
 	.align 2, 0
-_08106990: .4byte gUnknown_8452C4C
+_08106990: .4byte gDexCategories
 _08106994: .4byte gUnknown_203ACF0
 _08106998: .4byte 0x0000ffff
 	thumb_func_end sub_81068DC
@@ -2458,7 +2458,7 @@ sub_810699C: @ 810699C
 	sub sp, 0x8
 	lsls r0, 24
 	lsrs r7, r0, 24
-	ldr r1, _081069F8 @ =gUnknown_8452C4C
+	ldr r1, _081069F8 @ =gDexCategories
 	lsls r0, r7, 3
 	adds r0, r1
 	ldrb r6, [r0, 0x4]
@@ -2503,7 +2503,7 @@ _081069DE:
 	movs r0, 0x1
 	b _08106A12
 	.align 2, 0
-_081069F8: .4byte gUnknown_8452C4C
+_081069F8: .4byte gDexCategories
 _081069FC: .4byte gUnknown_203ACF0
 _08106A00:
 	ldr r1, _08106A1C @ =gUnknown_203ACF0
@@ -2537,7 +2537,7 @@ sub_8106A20: @ 8106A20
 	str r0, [sp]
 	movs r0, 0
 	str r0, [sp, 0x4]
-	ldr r1, _08106A98 @ =gUnknown_8452C4C
+	ldr r1, _08106A98 @ =gDexCategories
 	str r1, [sp, 0x10]
 _08106A3A:
 	ldr r2, [sp, 0x10]
@@ -2589,7 +2589,7 @@ _08106A64:
 	movs r0, 0
 	b _08106AE8
 	.align 2, 0
-_08106A98: .4byte gUnknown_8452C4C
+_08106A98: .4byte gDexCategories
 _08106A9C: .4byte gUnknown_203ACF0
 _08106AA0:
 	adds r0, r4, 0
diff --git a/data/pokedex_screen.s b/data/pokedex_screen.s
index 2586524fb..f80eb0b3c 100644
--- a/data/pokedex_screen.s
+++ b/data/pokedex_screen.s
@@ -8,7 +8,7 @@
 	.section .rodata
 	.align 2
 
-gUnknown_843FAB0:: @ 843FAB0
+gMonFootprintPtrs:: @ 843FAB0
 	.4byte gMonFootprint_Bulbasaur
 	.4byte gMonFootprint_Bulbasaur
 	.4byte gMonFootprint_Ivysaur
@@ -2296,15 +2296,15 @@ gUnknown_8451F6C::
 	.4byte gUnknown_8415EFB, -3
 	.4byte gUnknown_8415E95, 9
 	.4byte gUnknown_8415DE0, -3
-	.4byte gUnknown_8415DF7, 0
-	.4byte gUnknown_8415E09, 1
-	.4byte gUnknown_8415E18, 2
-	.4byte gUnknown_8415E2D, 3
-	.4byte gUnknown_8415E39, 4
-	.4byte gUnknown_8415E46, 5
-	.4byte gUnknown_8415E57, 6
-	.4byte gUnknown_8415E6D, 7
-	.4byte gUnknown_8415E7B, 8
+	.4byte gText_DexCategory_GrasslandPkmn, 0
+	.4byte gText_DexCategory_ForestPkmn, 1
+	.4byte gText_DexCategory_WatersEdgePkmn, 2
+	.4byte gText_DexCategory_SeaPkmn, 3
+	.4byte gText_DexCategory_CavePkmn, 4
+	.4byte gText_DexCategory_MountainPkmn, 5
+	.4byte gText_DexCategory_RoughTerrainPkmn, 6
+	.4byte gText_DexCategory_UrbanPkmn, 7
+	.4byte gText_DexCategory_RarePkmn, 8
 	.4byte gUnknown_8415E88, -3
 	.4byte gUnknown_8415EA4, 10
 	.4byte gUnknown_8415ED5, 11
@@ -2326,15 +2326,15 @@ gUnknown_845201C::
 	.4byte gUnknown_8415F0E, 9
 	.4byte gUnknown_8415F24, 14
 	.4byte gUnknown_8415DE0, -3
-	.4byte gUnknown_8415DF7, 0
-	.4byte gUnknown_8415E09, 1
-	.4byte gUnknown_8415E18, 2
-	.4byte gUnknown_8415E2D, 3
-	.4byte gUnknown_8415E39, 4
-	.4byte gUnknown_8415E46, 5
-	.4byte gUnknown_8415E57, 6
-	.4byte gUnknown_8415E6D, 7
-	.4byte gUnknown_8415E7B, 8
+	.4byte gText_DexCategory_GrasslandPkmn, 0
+	.4byte gText_DexCategory_ForestPkmn, 1
+	.4byte gText_DexCategory_WatersEdgePkmn, 2
+	.4byte gText_DexCategory_SeaPkmn, 3
+	.4byte gText_DexCategory_CavePkmn, 4
+	.4byte gText_DexCategory_MountainPkmn, 5
+	.4byte gText_DexCategory_RoughTerrainPkmn, 6
+	.4byte gText_DexCategory_UrbanPkmn, 7
+	.4byte gText_DexCategory_RarePkmn, 8
 	.4byte gUnknown_8415E88, -3
 	.4byte gUnknown_8415EA4, 10
 	.4byte gUnknown_8415ED5, 11
@@ -2684,16 +2684,16 @@ gUnknown_8452334:: @ 8452334 dataptr
 	.4byte gUnknown_8452318
 	.4byte gUnknown_8452324
 
-gUnknown_8452344:: @ 8452344 dataptr
-	.4byte gUnknown_8415DF7
-	.4byte gUnknown_8415E09
-	.4byte gUnknown_8415E18
-	.4byte gUnknown_8415E2D
-	.4byte gUnknown_8415E39
-	.4byte gUnknown_8415E46
-	.4byte gUnknown_8415E57
-	.4byte gUnknown_8415E6D
-	.4byte gUnknown_8415E7B
+gDexCategoryNamePtrs:: @ 8452344 dataptr
+	.4byte gText_DexCategory_GrasslandPkmn
+	.4byte gText_DexCategory_ForestPkmn
+	.4byte gText_DexCategory_WatersEdgePkmn
+	.4byte gText_DexCategory_SeaPkmn
+	.4byte gText_DexCategory_CavePkmn
+	.4byte gText_DexCategory_MountainPkmn
+	.4byte gText_DexCategory_RoughTerrainPkmn
+	.4byte gText_DexCategory_UrbanPkmn
+	.4byte gText_DexCategory_RarePkmn
 
 gUnknown_8452368:: @ 8452368 gbapal
 	.incbin "graphics/pokedex/unk_8452368.gbapal"
@@ -3393,7 +3393,7 @@ gUnknown_84527D0:: @ 84527D0
 gUnknown_84527D2:: @ 84527D2
 	.2byte SPECIES_MEW
 
-gUnknown_84527D4::
+gDexCategory_GrasslandPkmn::
 	.4byte gUnknown_84524D0, 4
 	.4byte gUnknown_84524D8, 4
 	.4byte gUnknown_84524E0, 3
@@ -3422,7 +3422,7 @@ gUnknown_84527D4::
 	.4byte gUnknown_8452564, 3
 	.4byte gUnknown_845256A, 3
 
-gUnknown_84528AC::
+gDexCategory_ForestPkmn::
 	.4byte gUnknown_8452570, 3
 	.4byte gUnknown_8452576, 3
 	.4byte gUnknown_845257C, 3
@@ -3450,7 +3450,7 @@ gUnknown_84528AC::
 	.4byte gUnknown_84525F6, 3
 	.4byte gUnknown_84525FC, 1
 
-gUnknown_845297C::
+gDexCategory_WatersEdgePkmn::
 	.4byte gUnknown_84525FE, 2
 	.4byte gUnknown_8452602, 4
 	.4byte gUnknown_845260A, 4
@@ -3468,7 +3468,7 @@ gUnknown_845297C::
 	.4byte gUnknown_8452652, 3
 	.4byte gUnknown_8452658, 2
 
-gUnknown_84529FC::
+gDexCategory_SeaPkmn::
 	.4byte gUnknown_845265C, 2
 	.4byte gUnknown_8452660, 2
 	.4byte gUnknown_8452664, 2
@@ -3486,7 +3486,7 @@ gUnknown_84529FC::
 	.4byte gUnknown_84526A6, 2
 	.4byte gUnknown_84526AA, 1
 
-gUnknown_8452A7C::
+gDexCategory_CavePkmn::
 	.4byte gUnknown_84526AC, 3
 	.4byte gUnknown_84526B2, 4
 	.4byte gUnknown_84526BA, 4
@@ -3498,7 +3498,7 @@ gUnknown_8452A7C::
 	.4byte gUnknown_84526DC, 2
 	.4byte gUnknown_84526E0, 3
 
-gUnknown_8452ACC::
+gDexCategory_MountainPkmn::
 	.4byte gUnknown_84526E6, 3
 	.4byte gUnknown_84526EC, 4
 	.4byte gUnknown_84526F4, 3
@@ -3517,7 +3517,7 @@ gUnknown_8452ACC::
 	.4byte gUnknown_8452738, 3
 	.4byte gUnknown_845273E, 1
 
-gUnknown_8452B54::
+gDexCategory_RoughTerrainPkmn::
 	.4byte gUnknown_8452740, 2
 	.4byte gUnknown_8452744, 4
 	.4byte gUnknown_845274C, 2
@@ -3530,7 +3530,7 @@ gUnknown_8452B54::
 	.4byte gUnknown_845276E, 3
 	.4byte gUnknown_8452774, 1
 
-gUnknown_8452BAC::
+gDexCategory_UrbanPkmn::
 	.4byte gUnknown_8452776, 4
 	.4byte gUnknown_845277E, 4
 	.4byte gUnknown_8452786, 2
@@ -3544,7 +3544,7 @@ gUnknown_8452BAC::
 	.4byte gUnknown_84527B4, 4
 	.4byte gUnknown_84527BC, 2
 
-gUnknown_8452C0C::
+gDexCategory_RarePkmn::
 	.4byte gUnknown_84527C0, 1
 	.4byte gUnknown_84527C2, 3
 	.4byte gUnknown_84527C8, 1
@@ -3554,13 +3554,13 @@ gUnknown_8452C0C::
 	.4byte gUnknown_84527D0, 1
 	.4byte gUnknown_84527D2, 1
 
-gUnknown_8452C4C:: @ 8452C4C struct { dataptr; data8; }
-	.4byte gUnknown_84527D4, 27
-	.4byte gUnknown_84528AC, 26
-	.4byte gUnknown_845297C, 16
-	.4byte gUnknown_84529FC, 16
-	.4byte gUnknown_8452A7C, 10
-	.4byte gUnknown_8452ACC, 17
-	.4byte gUnknown_8452B54, 11
-	.4byte gUnknown_8452BAC, 12
-	.4byte gUnknown_8452C0C, 8
+gDexCategories:: @ 8452C4C struct { dataptr; data8; }
+	.4byte gDexCategory_GrasslandPkmn, 27
+	.4byte gDexCategory_ForestPkmn, 26
+	.4byte gDexCategory_WatersEdgePkmn, 16
+	.4byte gDexCategory_SeaPkmn, 16
+	.4byte gDexCategory_CavePkmn, 10
+	.4byte gDexCategory_MountainPkmn, 17
+	.4byte gDexCategory_RoughTerrainPkmn, 11
+	.4byte gDexCategory_UrbanPkmn, 12
+	.4byte gDexCategory_RarePkmn, 8
diff --git a/data/strings.s b/data/strings.s
index c42765c68..d1bbeef49 100644
--- a/data/strings.s
+++ b/data/strings.s
@@ -206,31 +206,31 @@ gUnknown_8415DD7:: @ 8415DD7
 gUnknown_8415DE0:: @ 0x8415DE0
 	.string "{COLOR WHITE2}{SHADOW LIGHT_BLUE}POKéMON HABITATS$"
 
-gUnknown_8415DF7:: @ 0x8415DF7
+gText_DexCategory_GrasslandPkmn:: @ 0x8415DF7
 	.string "Grassland POKéMON$"
 
-gUnknown_8415E09:: @ 0x8415E09
+gText_DexCategory_ForestPkmn:: @ 0x8415E09
 	.string "Forest POKéMON$"
 
-gUnknown_8415E18:: @ 0x8415E18
+gText_DexCategory_WatersEdgePkmn:: @ 0x8415E18
 	.string "Water's-edge POKéMON$"
 
-gUnknown_8415E2D:: @ 0x8415E2D
+gText_DexCategory_SeaPkmn:: @ 0x8415E2D
 	.string "Sea POKéMON$"
 
-gUnknown_8415E39:: @ 0x8415E39
+gText_DexCategory_CavePkmn:: @ 0x8415E39
 	.string "Cave POKéMON$"
 
-gUnknown_8415E46:: @ 0x8415E46
+gText_DexCategory_MountainPkmn:: @ 0x8415E46
 	.string "Mountain POKéMON$"
 
-gUnknown_8415E57:: @ 0x8415E57
+gText_DexCategory_RoughTerrainPkmn:: @ 0x8415E57
 	.string "Rough-terrain POKéMON$"
 
-gUnknown_8415E6D:: @ 0x8415E6D
+gText_DexCategory_UrbanPkmn:: @ 0x8415E6D
 	.string "Urban POKéMON$"
 
-gUnknown_8415E7B:: @ 0x8415E7B
+gText_DexCategory_RarePkmn:: @ 0x8415E7B
 	.string "Rare POKéMON$"
 
 gUnknown_8415E88:: @ 0x8415E88
diff --git a/include/pokedex_screen.h b/include/pokedex_screen.h
index dfcbda05a..ab1115dd8 100644
--- a/include/pokedex_screen.h
+++ b/include/pokedex_screen.h
@@ -1,6 +1,16 @@
 #ifndef GUARD_POKEDEX_SCREEN_H
 #define GUARD_POKEDEX_SCREEN_H
 
+#define DEX_CATEGORY_GRASSLAND     0
+#define DEX_CATEGORY_FOREST        1
+#define DEX_CATEGORY_WATERS_EDGE   2
+#define DEX_CATEGORY_SEA           3
+#define DEX_CATEGORY_CAVE          4
+#define DEX_CATEGORY_MOUNTAIN      5
+#define DEX_CATEGORY_ROUGH_TERRAIN 6
+#define DEX_CATEGORY_URBAN         7
+#define DEX_CATEGORY_RARE          8
+
 void CB2_OpenPokedexFromStartMenu(void);
 s8 sub_8104AB0(u16 nationalDexNo, u8 caseId, bool8 indexIsSpecies);
 
diff --git a/src/pokedex_screen.c b/src/pokedex_screen.c
index b67f9a514..ea6df71be 100644
--- a/src/pokedex_screen.c
+++ b/src/pokedex_screen.c
@@ -115,12 +115,12 @@ void sub_8105594(u8 a0, u8 a1);
 void sub_8105E1C(u8 a0);
 void sub_8106014(void);
 void sub_810603C(void);
-bool8 sub_8106838(u8 a0, u8 a1);
+bool8 sub_8106838(u8 category, u8 a1);
 u8 sub_81068A0(u8 a0);
-void sub_810699C(u8 a0);
+void sub_810699C(u8 category);
 bool8 sub_8106A20(u16 a0);
 void sub_81067C0(void);
-void sub_81068DC(u8 a0, u8 a1);
+void sub_81068DC(u8 category, u8 a1);
 u8 sub_8106AF8(u16 a0);
 void sub_8106B34(void);
 void sub_8106E78(const u8 *a0, s32 a1);
@@ -157,7 +157,7 @@ extern const struct WindowTemplate gUnknown_84521C4;
 extern const struct WindowTemplate gUnknown_84521CC;
 extern const u16 gUnknown_845228C[];
 extern const u8 (*const gUnknown_8452334[])[4];
-extern const u8 *const gUnknown_8452344[];
+extern const u8 *const gDexCategoryNamePtrs[];
 extern const u8 gUnknown_8452388[][30];
 extern const struct ScrollArrowsTemplate gUnknown_84524B4;
 extern const struct CursorStruct gUnknown_84524C4;
@@ -1855,11 +1855,11 @@ bool8 sub_8104F0C(bool8 a0)
     FillWindowPixelBuffer(0, PIXEL_FILL(15));
     if (a0)
     {
-        sub_8106E78(gUnknown_8452344[gUnknown_203ACF0->field_28], 1);
+        sub_8106E78(gDexCategoryNamePtrs[gUnknown_203ACF0->field_28], 1);
     }
     else
     {
-        sub_8106E78(gUnknown_8452344[gUnknown_203ACF0->field_28], 0);
+        sub_8106E78(gDexCategoryNamePtrs[gUnknown_203ACF0->field_28], 0);
         sub_8104EC0(0, sub_8106AF8(gUnknown_203ACF0->field_2B), sub_8106AF8(gUnknown_203ACF0->field_2A - 1), 160, 2);
     }
     CopyWindowToVram(0, 2);