z_map_exp OK and somewhat documented (#877)

* z_map_exp OK * some names * Some more docs * Update prototypes in functions.h * Use reg name * namefixer * Respond to review * Respond to review * Respond to review * Add some blank lines after breaks, whoops * Respond to review * Respond to Engineer's review, pt 2 * Respond to Engineer's review, Pt 3 * Add newline char to end of z64map.h * Respond to engineer's review, Pt 4 * Respond to multiple reviews
2026-08-04 09:08:34 -04:00 · 2022-07-11 20:23:01 -07:00
parent 3b87504adc
commit e9d4b31c3d
14 changed files with 331 additions and 78 deletions
@@ -1,31 +1,257 @@
 #include "global.h"

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A000.s")
+s16 sMinimapInitPosX = 0;
+s16 sMinimapInitPosZ = 0;
+s16 sMinimapInitDir = 0;

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A074.s")
+s32 sDungeonAndBossScenes[] = {
+    SCENE_MITURIN,    SCENE_HAKUGIN,    SCENE_SEA,    SCENE_INISIE_N,  SCENE_INISIE_R,
+    SCENE_MITURIN_BS, SCENE_HAKUGIN_BS, SCENE_SEA_BS, SCENE_INISIE_BS,
+};

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A0A4.s")
+/**
+ * If the current scene is a dungeon or boss scene, this function returns an index
+ * indicating which one it is. Otherwise, it returns -1.
+ */
+s32 Map_GetDungeonOrBossAreaIndex(PlayState* play) {
+    s32 i;

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A0F0.s")
+    for (i = 0; i < ARRAY_COUNT(sDungeonAndBossScenes); i++) {
+        if (Play_GetOriginalSceneNumber(play->sceneNum) == sDungeonAndBossScenes[i]) {
+            return i;
+        }
+    }

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A164.s")
+    return -1;
+}

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A194.s")
+/**
+ * Returns true if the current scene is a dungeon or boss scene, false otherwise.
+ */
+s32 Map_IsInDungeonOrBossArea(PlayState* play) {
+    if (Map_GetDungeonOrBossAreaIndex(play) == -1) {
+        return false;
+    }

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A208.s")
+    return true;
+}

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A238.s")
+s32 func_8010A0A4(PlayState* play) {
+    if ((Map_GetDungeonOrBossAreaIndex(play) == -1) || !func_80102EF0(play)) {
+        return false;
+    }

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A2AC.s")
+    return true;
+}

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A2DC.s")
+s32 sDungeonScenes[] = {
+    SCENE_MITURIN, SCENE_HAKUGIN, SCENE_SEA, SCENE_INISIE_N, SCENE_INISIE_R,
+};

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A33C.s")
+/**
+ * If the current scene is a dungeon scene, this function returns an index
+ * indicating which one it is. Otherwise, it returns -1.
+ */
+s32 Map_GetDungeonAreaIndex(PlayState* play) {
+    s32 i;

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A410.s")
+    for (i = 0; i < ARRAY_COUNT(sDungeonScenes); i++) {
+        if (Play_GetOriginalSceneNumber(play->sceneNum) == sDungeonScenes[i]) {
+            return i;
+        }
+    }

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A430.s")
+    return -1;
+}

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A54C.s")
+/**
+ * Returns true if the current scene is a dungeon scene, false otherwise.
+ */
+s32 Map_IsInDungeonArea(PlayState* play) {
+    if (Map_GetDungeonAreaIndex(play) == -1) {
+        return false;
+    }

-#pragma GLOBAL_ASM("asm/non_matchings/code/z_map_exp/func_8010A580.s")
+    return true;
+}
+
+s32 sBossScenes[] = {
+    SCENE_MITURIN_BS, // DUNGEON_INDEX_WOODFALL_TEMPLE
+    SCENE_HAKUGIN_BS, // DUNGEON_INDEX_SNOWHEAD_TEMPLE
+    SCENE_SEA_BS,     // DUNGEON_INDEX_GREAT_BAY_TEMPLE
+    SCENE_INISIE_BS,  // DUNGEON_INDEX_STONE_TOWER_TEMPLE
+};
+
+/**
+ * If the current scene is a boss scene, this function returns an index
+ * indicating which one it is. Otherwise, it returns -1.
+ */
+s32 Map_GetBossAreaIndex(PlayState* play) {
+    s32 i;
+
+    for (i = 0; i < ARRAY_COUNT(sBossScenes); i++) {
+        if (Play_GetOriginalSceneNumber(play->sceneNum) == sBossScenes[i]) {
+            return i;
+        }
+    }
+
+    return -1;
+}
+
+/**
+ * Returns true if the current scene is a boss scene, false otherwise.
+ */
+s32 Map_IsInBossArea(PlayState* play) {
+    if (Map_GetBossAreaIndex(play) == -1) {
+        return false;
+    }
+
+    return true;
+}
+
+s32 D_801BF5A4[] = {
+    SCENE_22DEKUCITY,
+    SCENE_KOEPONARACE,
+    SCENE_F01,
+};
+
+s32 func_8010A238(PlayState* play) {
+    s32 i;
+
+    for (i = 0; i < ARRAY_COUNT(D_801BF5A4); i++) {
+        if (Play_GetOriginalSceneNumber(play->sceneNum) == D_801BF5A4[i]) {
+            return i;
+        }
+    }
+
+    return -1;
+}
+
+s32 func_8010A2AC(PlayState* play) {
+    if (func_8010A238(play) == -1) {
+        return false;
+    }
+
+    return true;
+}
+
+/**
+ * When a room is loaded, this function is used to save the player's position and rotation
+ * so that the red arrow on the minimap can be drawn correctly.
+ */
+void Minimap_SavePlayerRoomInitInfo(PlayState* play) {
+    Player* player = GET_PLAYER(play);
+
+    sMinimapInitPosX = player->actor.world.pos.x;
+    sMinimapInitPosZ = player->actor.world.pos.z;
+    sMinimapInitDir = (0x7FFF - player->actor.shape.rot.y) / 0x400;
+}
+
+void Map_InitRoomData(PlayState* play, s16 room) {
+    s32 mapIndex = gSaveContext.mapIndex;
+    InterfaceContext* interfaceCtx = &play->interfaceCtx;
+
+    func_80105C40(room);
+
+    if (room >= 0) {
+        if (Map_IsInDungeonOrBossArea(play)) {
+            gSaveContext.save.permanentSceneFlags[Play_GetOriginalSceneNumber(play->sceneNum)].rooms |= gBitFlags[room];
+            interfaceCtx->mapRoomNum = room;
+            interfaceCtx->dungeonOrBossAreaMapIndex = mapIndex;
+        }
+    } else {
+        interfaceCtx->mapRoomNum = 0;
+    }
+
+    if (gSaveContext.sunsSongState != SUNSSONG_SPEED_TIME) {
+        gSaveContext.sunsSongState = SUNSSONG_INACTIVE;
+    }
+}
+
+void Map_Destroy(void) {
+    func_80105A40();
+}
+
+void Map_Init(PlayState* play) {
+    InterfaceContext* interfaceCtx = &play->interfaceCtx;
+    s32 dungeonIndex;
+
+    func_80105C40(play->roomCtx.currRoom.num);
+    interfaceCtx->unk_278 = -1;
+    interfaceCtx->dungeonOrBossAreaMapIndex = -1;
+    interfaceCtx->mapSegment = THA_AllocEndAlign16(&play->state.heap, 0x1000);
+    if (func_8010A2AC(play)) {
+        gSaveContext.mapIndex = func_8010A238(play);
+        return;
+    }
+
+    if (Map_IsInDungeonOrBossArea(play)) {
+        dungeonIndex = Map_GetDungeonOrBossAreaIndex(play);
+        gSaveContext.mapIndex = dungeonIndex;
+        switch (play->sceneNum) {
+            case SCENE_MITURIN_BS:
+                dungeonIndex = DUNGEON_INDEX_WOODFALL_TEMPLE;
+                break;
+
+            case SCENE_HAKUGIN_BS:
+                dungeonIndex = DUNGEON_INDEX_SNOWHEAD_TEMPLE;
+                break;
+
+            case SCENE_SEA_BS:
+                dungeonIndex = DUNGEON_INDEX_GREAT_BAY_TEMPLE;
+                break;
+
+            case SCENE_INISIE_BS:
+                dungeonIndex = DUNGEON_INDEX_STONE_TOWER_TEMPLE;
+                break;
+        }
+
+        gSaveContext.dungeonIndex = dungeonIndex;
+        Map_InitRoomData(play, play->roomCtx.currRoom.num);
+    }
+}
+
+void Minimap_Draw(PlayState* play) {
+    func_80106644(play, sMinimapInitPosX, sMinimapInitPosZ, sMinimapInitDir);
+}
+
+s16 sLastRoomNum = 99;
+
+void Map_Update(PlayState* play) {
+    InterfaceContext* interfaceCtx = &play->interfaceCtx;
+    Player* player = GET_PLAYER(play);
+    Input* controller = CONTROLLER1(&play->state);
+    s32 pad1;
+    s16 floor;
+    s32 pad2;
+
+    if ((play->pauseCtx.state < 4) && (CHECK_BTN_ALL(controller->press.button, BTN_L)) && (!Play_InCsMode(play)) &&
+        (!func_80106530(play))) {
+        if (!R_MINIMAP_DISABLED) {
+            play_sound(NA_SE_SY_CAMERA_ZOOM_UP);
+        } else {
+            play_sound(NA_SE_SY_CAMERA_ZOOM_DOWN);
+        }
+
+        R_MINIMAP_DISABLED ^= 1;
+    }
+
+    func_80105B34(play);
+
+    if ((play->pauseCtx.state == 0) && (play->pauseCtx.debugState == 0)) {
+        if (Map_IsInDungeonArea(play)) {
+            floor = func_80109124(player->actor.world.pos.y);
+            if (floor != -1) {
+                gSaveContext.save.permanentSceneFlags[Play_GetOriginalSceneNumber(play->sceneNum)].unk_14 |=
+                    gBitFlags[FLOOR_INDEX_MAX - floor];
+                XREG(94) = FLOOR_INDEX_MAX - floor;
+                if (interfaceCtx->mapRoomNum != sLastRoomNum) {
+                    sLastRoomNum = interfaceCtx->mapRoomNum;
+                }
+            }
+        } else if (Map_IsInBossArea(play)) {
+            func_80105294();
+            XREG(94) = FLOOR_INDEX_MAX - func_80105318();
+        }
+    }
+}
@@ -144,8 +144,8 @@ void func_8012EBF8(PlayState* play, RoomContext* roomCtx) {
    func_800BA798(play, &play->actorCtx);
    Actor_SpawnTransitionActors(play, &play->actorCtx);
    if (-1 < roomCtx->currRoom.num) {
-        func_8010A33C(play, roomCtx->currRoom.num);
-        func_8010A2DC(play);
+        Map_InitRoomData(play, roomCtx->currRoom.num);
+        Minimap_SavePlayerRoomInitInfo(play);
    }
    func_801A3CD8(play->roomCtx.currRoom.echo);
 }
@@ -260,7 +260,7 @@ void Sram_SaveEndOfCycle(PlayState* play) {
            ((void)0, gSaveContext.cycleSceneFlags[i].collectible) & D_801C5FC0[i][3];
        gSaveContext.cycleSceneFlags[i].clearedRoom = 0;
        gSaveContext.save.permanentSceneFlags[i].unk_14 = 0;
-        gSaveContext.save.permanentSceneFlags[i].unk_18 = 0;
+        gSaveContext.save.permanentSceneFlags[i].rooms = 0;
    }

    for (; i < ARRAY_COUNT(gSaveContext.cycleSceneFlags); i++) {