heal_location documentation

1 files changed, 83 insertions, 54 deletions

diff --git a/src/heal_location.c b/src/heal_location.c
index 574c126e2..b5d3843b1 100644
--- a/src/heal_location.c
+++ b/src/heal_location.c
@@ -5,56 +5,85 @@
 #include "constants/maps.h"
 #include "constants/spawn_points.h"
 
-void sub_80BFE00(u32 healLocationIdx);
+void SetBlackoutRespawnHealerNpcAsLastTalked(u32 healLocationIdx);
 
+// This array defines the fly points for unlocked spawns.
 static const struct HealLocation sSpawnPoints[] = {
-    {MAP_GROUP(PALLET_TOWN),             MAP_NUM(PALLET_TOWN),             0x06, 0x08},
-    {MAP_GROUP(VIRIDIAN_CITY),           MAP_NUM(VIRIDIAN_CITY),           0x1a, 0x1b},
-    {MAP_GROUP(PEWTER_CITY),             MAP_NUM(PEWTER_CITY),             0x11, 0x1a},
-    {MAP_GROUP(CERULEAN_CITY),           MAP_NUM(CERULEAN_CITY),           0x16, 0x14},
-    {MAP_GROUP(LAVENDER_TOWN),           MAP_NUM(LAVENDER_TOWN),           0x06, 0x06},
-    {MAP_GROUP(VERMILION_CITY),          MAP_NUM(VERMILION_CITY),          0x0f, 0x07},
-    {MAP_GROUP(CELADON_CITY),            MAP_NUM(CELADON_CITY),            0x30, 0x0c},
-    {MAP_GROUP(FUCHSIA_CITY),            MAP_NUM(FUCHSIA_CITY),            0x19, 0x20},
-    {MAP_GROUP(CINNABAR_ISLAND),         MAP_NUM(CINNABAR_ISLAND),         0x0e, 0x0c},
-    {MAP_GROUP(INDIGO_PLATEAU_EXTERIOR), MAP_NUM(INDIGO_PLATEAU_EXTERIOR), 0x0b, 0x07},
-    {MAP_GROUP(SAFFRON_CITY_DUPLICATE),  MAP_NUM(SAFFRON_CITY_DUPLICATE),  0x18, 0x27},
-    {MAP_GROUP(ROUTE4),                  MAP_NUM(ROUTE4),                  0x0c, 0x06},
-    {MAP_GROUP(ROUTE10),                 MAP_NUM(ROUTE10),                 0x0d, 0x15},
-    {MAP_GROUP(ONE_ISLAND),              MAP_NUM(ONE_ISLAND),              0x0e, 0x06},
-    {MAP_GROUP(TWO_ISLAND),              MAP_NUM(TWO_ISLAND),              0x15, 0x08},
-    {MAP_GROUP(THREE_ISLAND),            MAP_NUM(THREE_ISLAND),            0x0e, 0x1c},
-    {MAP_GROUP(FOUR_ISLAND),             MAP_NUM(FOUR_ISLAND),             0x12, 0x15},
-    {MAP_GROUP(FIVE_ISLAND),             MAP_NUM(FIVE_ISLAND),             0x12, 0x07},
-    {MAP_GROUP(SEVEN_ISLAND),            MAP_NUM(SEVEN_ISLAND),            0x0c, 0x04},
-    {MAP_GROUP(SIX_ISLAND),              MAP_NUM(SIX_ISLAND),              0x0b, 0x0c},
+    [SPAWN_PALLET_TOWN     - 1] = {MAP_GROUP(PALLET_TOWN),             MAP_NUM(PALLET_TOWN),             0x06, 0x08},
+    [SPAWN_VIRIDIAN_CITY   - 1] = {MAP_GROUP(VIRIDIAN_CITY),           MAP_NUM(VIRIDIAN_CITY),           0x1a, 0x1b},
+    [SPAWN_PEWTER_CITY     - 1] = {MAP_GROUP(PEWTER_CITY),             MAP_NUM(PEWTER_CITY),             0x11, 0x1a},
+    [SPAWN_CERULEAN_CITY   - 1] = {MAP_GROUP(CERULEAN_CITY),           MAP_NUM(CERULEAN_CITY),           0x16, 0x14},
+    [SPAWN_LAVENDER_TOWN   - 1] = {MAP_GROUP(LAVENDER_TOWN),           MAP_NUM(LAVENDER_TOWN),           0x06, 0x06},
+    [SPAWN_VERMILION_CITY  - 1] = {MAP_GROUP(VERMILION_CITY),          MAP_NUM(VERMILION_CITY),          0x0f, 0x07},
+    [SPAWN_CELADON_CITY    - 1] = {MAP_GROUP(CELADON_CITY),            MAP_NUM(CELADON_CITY),            0x30, 0x0c},
+    [SPAWN_FUCHSIA_CITY    - 1] = {MAP_GROUP(FUCHSIA_CITY),            MAP_NUM(FUCHSIA_CITY),            0x19, 0x20},
+    [SPAWN_CINNABAR_ISLAND - 1] = {MAP_GROUP(CINNABAR_ISLAND),         MAP_NUM(CINNABAR_ISLAND),         0x0e, 0x0c},
+    [SPAWN_INDIGO_PLATEAU  - 1] = {MAP_GROUP(INDIGO_PLATEAU_EXTERIOR), MAP_NUM(INDIGO_PLATEAU_EXTERIOR), 0x0b, 0x07},
+    [SPAWN_SAFFRON_CITY    - 1] = {MAP_GROUP(SAFFRON_CITY_DUPLICATE),  MAP_NUM(SAFFRON_CITY_DUPLICATE),  0x18, 0x27},
+    [SPAWN_ROUTE4          - 1] = {MAP_GROUP(ROUTE4),                  MAP_NUM(ROUTE4),                  0x0c, 0x06},
+    [SPAWN_ROUTE10         - 1] = {MAP_GROUP(ROUTE10),                 MAP_NUM(ROUTE10),                 0x0d, 0x15},
+    [SPAWN_ONE_ISLAND      - 1] = {MAP_GROUP(ONE_ISLAND),              MAP_NUM(ONE_ISLAND),              0x0e, 0x06},
+    [SPAWN_TWO_ISLAND      - 1] = {MAP_GROUP(TWO_ISLAND),              MAP_NUM(TWO_ISLAND),              0x15, 0x08},
+    [SPAWN_THREE_ISLAND    - 1] = {MAP_GROUP(THREE_ISLAND),            MAP_NUM(THREE_ISLAND),            0x0e, 0x1c},
+    [SPAWN_FOUR_ISLAND     - 1] = {MAP_GROUP(FOUR_ISLAND),             MAP_NUM(FOUR_ISLAND),             0x12, 0x15},
+    [SPAWN_FIVE_ISLAND     - 1] = {MAP_GROUP(FIVE_ISLAND),             MAP_NUM(FIVE_ISLAND),             0x12, 0x07},
+    [SPAWN_SEVEN_ISLAND    - 1] = {MAP_GROUP(SEVEN_ISLAND),            MAP_NUM(SEVEN_ISLAND),            0x0c, 0x04},
+    [SPAWN_SIX_ISLAND      - 1] = {MAP_GROUP(SIX_ISLAND),              MAP_NUM(SIX_ISLAND),              0x0b, 0x0c},
 };
 
-const u16 gUnknown_83EEC98[][2] = {
-    {MAP_GROUP(PALLET_TOWN_PLAYERS_HOUSE_1F), MAP_NUM(PALLET_TOWN_PLAYERS_HOUSE_1F)},
-    {MAP_GROUP(VIRIDIAN_CITY_POKEMON_CENTER_1F), MAP_NUM(VIRIDIAN_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(PEWTER_CITY_POKEMON_CENTER_1F), MAP_NUM(PEWTER_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(CERULEAN_CITY_POKEMON_CENTER_1F), MAP_NUM(CERULEAN_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(LAVENDER_TOWN_POKEMON_CENTER_1F), MAP_NUM(LAVENDER_TOWN_POKEMON_CENTER_1F)},
-    {MAP_GROUP(VERMILION_CITY_POKEMON_CENTER_1F), MAP_NUM(VERMILION_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(CELADON_CITY_POKEMON_CENTER_1F), MAP_NUM(CELADON_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(FUCHSIA_CITY_POKEMON_CENTER_1F), MAP_NUM(FUCHSIA_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(CINNABAR_ISLAND_POKEMON_CENTER_1F), MAP_NUM(CINNABAR_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(INDIGO_PLATEAU_POKEMON_CENTER_1F), MAP_NUM(INDIGO_PLATEAU_POKEMON_CENTER_1F)},
-    {MAP_GROUP(SAFFRON_CITY_POKEMON_CENTER_1F), MAP_NUM(SAFFRON_CITY_POKEMON_CENTER_1F)},
-    {MAP_GROUP(ROUTE4_POKEMON_CENTER_1F), MAP_NUM(ROUTE4_POKEMON_CENTER_1F)},
-    {MAP_GROUP(ROUTE10_POKEMON_CENTER_1F), MAP_NUM(ROUTE10_POKEMON_CENTER_1F)},
-    {MAP_GROUP(ONE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(ONE_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(TWO_ISLAND_POKEMON_CENTER_1F), MAP_NUM(TWO_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(THREE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(THREE_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(FOUR_ISLAND_POKEMON_CENTER_1F), MAP_NUM(FOUR_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(FIVE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(FIVE_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(SEVEN_ISLAND_POKEMON_CENTER_1F), MAP_NUM(SEVEN_ISLAND_POKEMON_CENTER_1F)},
-    {MAP_GROUP(SIX_ISLAND_POKEMON_CENTER_1F), MAP_NUM(SIX_ISLAND_POKEMON_CENTER_1F)}
+// This array defines the map where you actually respawn when you black out,
+// based on where you last checkpointed.
+// This is either the player's house or a Pokémon Center.
+// The data are u16 instead of u8 for reasons unknown.
+const u16 sBlackoutRespawnHealCenterMapIdxs[][2] = {
+    [SPAWN_PALLET_TOWN     - 1] = {MAP_GROUP(PALLET_TOWN_PLAYERS_HOUSE_1F), MAP_NUM(PALLET_TOWN_PLAYERS_HOUSE_1F)},
+    [SPAWN_VIRIDIAN_CITY   - 1] = {MAP_GROUP(VIRIDIAN_CITY_POKEMON_CENTER_1F), MAP_NUM(VIRIDIAN_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_PEWTER_CITY     - 1] = {MAP_GROUP(PEWTER_CITY_POKEMON_CENTER_1F), MAP_NUM(PEWTER_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_CERULEAN_CITY   - 1] = {MAP_GROUP(CERULEAN_CITY_POKEMON_CENTER_1F), MAP_NUM(CERULEAN_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_LAVENDER_TOWN   - 1] = {MAP_GROUP(LAVENDER_TOWN_POKEMON_CENTER_1F), MAP_NUM(LAVENDER_TOWN_POKEMON_CENTER_1F)},
+    [SPAWN_VERMILION_CITY  - 1] = {MAP_GROUP(VERMILION_CITY_POKEMON_CENTER_1F), MAP_NUM(VERMILION_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_CELADON_CITY    - 1] = {MAP_GROUP(CELADON_CITY_POKEMON_CENTER_1F), MAP_NUM(CELADON_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_FUCHSIA_CITY    - 1] = {MAP_GROUP(FUCHSIA_CITY_POKEMON_CENTER_1F), MAP_NUM(FUCHSIA_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_CINNABAR_ISLAND - 1] = {MAP_GROUP(CINNABAR_ISLAND_POKEMON_CENTER_1F), MAP_NUM(CINNABAR_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_INDIGO_PLATEAU  - 1] = {MAP_GROUP(INDIGO_PLATEAU_POKEMON_CENTER_1F), MAP_NUM(INDIGO_PLATEAU_POKEMON_CENTER_1F)},
+    [SPAWN_SAFFRON_CITY    - 1] = {MAP_GROUP(SAFFRON_CITY_POKEMON_CENTER_1F), MAP_NUM(SAFFRON_CITY_POKEMON_CENTER_1F)},
+    [SPAWN_ROUTE4          - 1] = {MAP_GROUP(ROUTE4_POKEMON_CENTER_1F), MAP_NUM(ROUTE4_POKEMON_CENTER_1F)},
+    [SPAWN_ROUTE10         - 1] = {MAP_GROUP(ROUTE10_POKEMON_CENTER_1F), MAP_NUM(ROUTE10_POKEMON_CENTER_1F)},
+    [SPAWN_ONE_ISLAND      - 1] = {MAP_GROUP(ONE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(ONE_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_TWO_ISLAND      - 1] = {MAP_GROUP(TWO_ISLAND_POKEMON_CENTER_1F), MAP_NUM(TWO_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_THREE_ISLAND    - 1] = {MAP_GROUP(THREE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(THREE_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_FOUR_ISLAND     - 1] = {MAP_GROUP(FOUR_ISLAND_POKEMON_CENTER_1F), MAP_NUM(FOUR_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_FIVE_ISLAND     - 1] = {MAP_GROUP(FIVE_ISLAND_POKEMON_CENTER_1F), MAP_NUM(FIVE_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_SEVEN_ISLAND    - 1] = {MAP_GROUP(SEVEN_ISLAND_POKEMON_CENTER_1F), MAP_NUM(SEVEN_ISLAND_POKEMON_CENTER_1F)},
+    [SPAWN_SIX_ISLAND      - 1] = {MAP_GROUP(SIX_ISLAND_POKEMON_CENTER_1F), MAP_NUM(SIX_ISLAND_POKEMON_CENTER_1F)}
 };
 
-static const u8 gUnknown_83EECE8[] = {
-    0x01, 0x01, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x02, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01
+// When you respawn, your character scurries back to either their house
+// or a Pokémon Center, and hands their fainted Pokémon to their mother
+// or the Nurse for healing.
+// This array defines the index of the NPC on the map defined above
+// with whom your character interacts in this cutscene.
+static const u8 sBlackoutRespawnHealerNpcIdx[] = {
+    [SPAWN_PALLET_TOWN     - 1] = 1,
+    [SPAWN_VIRIDIAN_CITY   - 1] = 1,
+    [SPAWN_PEWTER_CITY     - 1] = 3,
+    [SPAWN_CERULEAN_CITY   - 1] = 1,
+    [SPAWN_LAVENDER_TOWN   - 1] = 1,
+    [SPAWN_VERMILION_CITY  - 1] = 1,
+    [SPAWN_CELADON_CITY    - 1] = 1,
+    [SPAWN_FUCHSIA_CITY    - 1] = 1,
+    [SPAWN_CINNABAR_ISLAND - 1] = 1,
+    [SPAWN_INDIGO_PLATEAU  - 1] = 2,
+    [SPAWN_SAFFRON_CITY    - 1] = 1,
+    [SPAWN_ROUTE4          - 1] = 1,
+    [SPAWN_ROUTE10         - 1] = 1,
+    [SPAWN_ONE_ISLAND      - 1] = 1,
+    [SPAWN_TWO_ISLAND      - 1] = 1,
+    [SPAWN_THREE_ISLAND    - 1] = 1,
+    [SPAWN_FOUR_ISLAND     - 1] = 1,
+    [SPAWN_FIVE_ISLAND     - 1] = 1,
+    [SPAWN_SEVEN_ISLAND    - 1] = 1,
+    [SPAWN_SIX_ISLAND      - 1] = 1
 };
 
 u32 GetHealLocationIndexFromMapGroupAndNum(u16 mapGroup, u16 mapNum)
@@ -89,7 +118,7 @@ const struct HealLocation * GetHealLocationPointer(u32 idx)
     return &sSpawnPoints[idx - 1];
 }
 
-void sub_80BFCD0(struct WarpData * warp)
+void SetBlackoutRespawnWarpAndHealerNpc(struct WarpData * warp)
 {
     u32 healLocationIdx;
 
@@ -107,26 +136,26 @@ void sub_80BFCD0(struct WarpData * warp)
     else
     {
         healLocationIdx = GetHealLocationIndexFromMapGroupAndNum(gSaveBlock1Ptr->lastHealLocation.mapGroup, gSaveBlock1Ptr->lastHealLocation.mapNum);
-        warp->mapGroup = gUnknown_83EEC98[healLocationIdx - 1][0];
-        warp->mapNum = gUnknown_83EEC98[healLocationIdx - 1][1];
+        warp->mapGroup = sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][0];
+        warp->mapNum = sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][1];
         warp->warpId = 0xFF;
 
-        if (gUnknown_83EEC98[healLocationIdx - 1][0] == MAP_GROUP(PALLET_TOWN_PLAYERS_HOUSE_1F) && gUnknown_83EEC98[healLocationIdx - 1][1] == MAP_NUM(PALLET_TOWN_PLAYERS_HOUSE_1F))
+        if (sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][0] == MAP_GROUP(PALLET_TOWN_PLAYERS_HOUSE_1F) && sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][1] == MAP_NUM(PALLET_TOWN_PLAYERS_HOUSE_1F))
         {
             warp->x = 8;
             warp->y = 5;
         }
-        else if (gUnknown_83EEC98[healLocationIdx - 1][0] == MAP_GROUP(INDIGO_PLATEAU_POKEMON_CENTER_1F) && gUnknown_83EEC98[healLocationIdx - 1][1] == MAP_NUM(INDIGO_PLATEAU_POKEMON_CENTER_1F))
+        else if (sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][0] == MAP_GROUP(INDIGO_PLATEAU_POKEMON_CENTER_1F) && sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][1] == MAP_NUM(INDIGO_PLATEAU_POKEMON_CENTER_1F))
         {
             warp->x = 13;
             warp->y = 12;
         }
-        else if (gUnknown_83EEC98[healLocationIdx - 1][0] == MAP_GROUP(ONE_ISLAND_POKEMON_CENTER_1F) && gUnknown_83EEC98[healLocationIdx - 1][1] == MAP_NUM(ONE_ISLAND_POKEMON_CENTER_1F))
+        else if (sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][0] == MAP_GROUP(ONE_ISLAND_POKEMON_CENTER_1F) && sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][1] == MAP_NUM(ONE_ISLAND_POKEMON_CENTER_1F))
         {
             warp->x = 5;
             warp->y = 4;
         }
-        else if (gUnknown_83EEC98[healLocationIdx - 1][0] == MAP_GROUP(SEVEN_ISLAND_TRAINER_TOWER_LOBBY) && gUnknown_83EEC98[healLocationIdx - 1][1] == MAP_NUM(SEVEN_ISLAND_TRAINER_TOWER_LOBBY))
+        else if (sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][0] == MAP_GROUP(SEVEN_ISLAND_TRAINER_TOWER_LOBBY) && sBlackoutRespawnHealCenterMapIdxs[healLocationIdx - 1][1] == MAP_NUM(SEVEN_ISLAND_TRAINER_TOWER_LOBBY))
         {
             warp->x = 4;
             warp->y = 11;
@@ -137,11 +166,11 @@ void sub_80BFCD0(struct WarpData * warp)
             warp->x = 7;
             warp->y = 4;
         }
-        sub_80BFE00(healLocationIdx);
+        SetBlackoutRespawnHealerNpcAsLastTalked(healLocationIdx);
     }
 }
 
-void sub_80BFE00(u32 healLocationIdx)
+void SetBlackoutRespawnHealerNpcAsLastTalked(u32 healLocationIdx)
 {
-    gSpecialVar_LastTalked = gUnknown_83EECE8[healLocationIdx - 1];
+    gSpecialVar_LastTalked = sBlackoutRespawnHealerNpcIdx[healLocationIdx - 1];
 }