Bronze scale

Author: GSKirox

ASM/c/item_draw_functions.c

@@ -292,6 +292,38 @@ void draw_gi_magic_spells(z64_game_t* game, uint32_t draw_id) {
     gSPDisplayList(gfx->poly_xlu.p++, item_draw_table[draw_id].args[1].dlist);
     gSPDisplayList(gfx->poly_xlu.p++, item_draw_table[draw_id].args[2].dlist);
 }
+static Gfx gGiBronzeScaleWaterColorDL[] = {
+    gsDPPipeSync(),
+    gsDPSetPrimColor(0, 0x60, 255, 255, 255, 255),
+    gsDPSetEnvColor(255, 123, 0, 255),
+    gsSPEndDisplayList(),
+};
+
+static Gfx gGiBronzeScaleColorDL[] = {
+    gsDPPipeSync(),
+    gsDPSetPrimColor(0, 0x80, 255, 255, 255, 255),
+    gsDPSetEnvColor(91, 51, 18, 255),
+    gsSPEndDisplayList(),
+};
+
+void draw_bronze_scale(z64_game_t* game, uint32_t draw_id) {
+
+    z64_gfx_t* gfx = game->common.gfx;
+
+    append_setup_dl_25_to_xlu(gfx);
+    gSPSegment(gfx->poly_xlu.p++, 0x08,
+               gen_double_tile(gfx,
+                               0, game->common.state_frames * 2, -(game->common.state_frames * 2), 64, 64,
+                               1, game->common.state_frames * 4, -(game->common.state_frames * 4), 32, 32));
+
+
+    gSPMatrix(gfx->poly_xlu.p++, append_sys_matrix(gfx), G_MTX_MODELVIEW | G_MTX_LOAD | G_MTX_NOPUSH);
+
+    gSPDisplayList(gfx->poly_xlu.p++, (Gfx*)gGiBronzeScaleColorDL);
+    gSPDisplayList(gfx->poly_xlu.p++, item_draw_table[draw_id].args[3].dlist);
+    gSPDisplayList(gfx->poly_xlu.p++, (Gfx*)gGiBronzeScaleWaterColorDL);
+    gSPDisplayList(gfx->poly_xlu.p++, item_draw_table[draw_id].args[0].dlist);
+}
 
 void draw_gi_scales(z64_game_t* game, uint32_t draw_id) {
     z64_gfx_t* gfx = game->common.gfx;

ASM/c/item_draw_functions.h

@@ -56,5 +56,6 @@ void draw_gi_flame(z64_disp_buf_t* dl, z64_game_t *game, colorRGBA8_t prim, colo
 void draw_gi_xlu_with_flame(z64_game_t *game, uint32_t draw_id);
 void draw_gi_deku_nut_with_flame(z64_game_t* game, uint32_t draw_id);
 void draw_ice_trap(z64_game_t* game, uint32_t draw_id);
+void draw_bronze_scale(z64_game_t* game, uint32_t draw_id);
 
 #endif

ASM/c/item_draw_table.c

@@ -179,6 +179,7 @@ item_draw_table_entry_t item_draw_table[] = {
     [0xA1] = { draw_gi_deku_nut_with_flame, { 0x06000E90, 0xC0C0C0FF, 0xC0C0C0FF } }, // Deku Nut Upgrade w/ Smoke Effect
     [0xA2] = { draw_gi_magic_meter,         { 0x06000000, 0x06000CC0, 0x06000F08, 0x060014E8, 0x286428FF, 0x000000FF } },  // Magic Meter Scroll 2
     [0xA3] = { draw_ice_trap,               { 0x04034380 } }, // Ice trap
+    [0x94] = { draw_bronze_scale,              { 0x06000AA0, 0x06000A40, 0x06000A80, 0x06000CC8 } }, // Bronze scale
 };
 
 void base_draw_gi_model(z64_game_t* game, uint32_t draw_id) {

ASM/c/item_effects.c

@@ -283,3 +283,20 @@ void unlock_ocarina_note(z64_file_t* save, int16_t arg1, int16_t arg2) {
             break;
     }
 }
+
+void give_progressive_scale(z64_file_t* save, int16_t arg1, int16_t arg2) {
+    switch(arg1) {
+        case 0: // Bronze scale
+            extended_savectx.extended_scale[0] = 1;
+            break;
+        case 1:
+            extended_savectx.extended_scale[0] = 2;
+            save->diving_upgrade = 1;
+            break;
+        case 2:
+            extended_savectx.extended_scale[0] = 3;
+            save->diving_upgrade = 2;
+            break;
+    }
+
+}

ASM/c/item_effects.h

@@ -31,6 +31,7 @@ void give_bombchus(z64_file_t* save, int16_t arg1, int16_t arg2);
 void trade_quest_upgrade(z64_file_t* save, int16_t item_id, int16_t arg2);
 extern uint8_t KEYRING_BOSSKEY_CONDITION;
 void unlock_ocarina_note(z64_file_t* save, int16_t arg1, int16_t arg2);
+void give_progressive_scale(z64_file_t* save, int16_t arg1, int16_t arg2);
 
 typedef enum dungeon {
     DEKU_ID       = 0,

ASM/c/item_upgrades.c

@@ -2,6 +2,7 @@
 
 #include "get_items.h"
 #include "item_table.h"
+#include "save.h"
 #include "z64.h"
 
 extern uint32_t FREE_BOMBCHU_DROPS;
@@ -17,7 +18,7 @@ typedef struct {
     uint8_t magic : 2;  // 0 = no magic, 1 = single magic, 2 = double magic
     uint8_t sticks : 2;  // 0 = no sticks, 1 = 10, 2 = 20, 3 = 30
     uint8_t nuts : 2;  // 0 = no nuts, 1 = 20, 2 = 30, 3 = 40
-    uint8_t scale : 2;  // 0 = no scale, 1 = silver scale, 2 = gold scale
+    uint8_t scale : 3;  // 0 = no scale, 1 = bronze_scale, 2 = silver scale, 3 = gold scale
     uint8_t wallet : 2;  // 0 = 99, 1 = 200, 2 = 500, 3 = 999
     uint8_t slingshot : 2;  // 0 = no slingshot, 1 = 30, 2 = 40, 3 = 50
     uint8_t bow : 2;  // 0 = no bow, 1 = 30, 2 = 40, 3 = 50

ASM/c/main.c

@@ -24,6 +24,7 @@
 #include "debug.h"
 #include "inputviewer.h"
 #include "message.h"
+#include "swim.h"
 
 void Gameplay_InitSkybox(z64_game_t* globalCtx, int16_t skyboxId);
 
@@ -69,6 +70,7 @@ void after_game_state_update() {
     }
     close_rando_display_buffer();
     give_sage_gifts();
+    manage_swim();
 }
 
 void before_skybox_init(z64_game_t* game, int16_t skyboxId) {

ASM/c/save.h

@@ -9,6 +9,7 @@ typedef struct {
     bool collected_dungeon_rewards[8];
     override_t incoming_queue[3];
     uint8_t password[6];
+    uint8_t extended_scale[0x2];
 } extended_savecontext_static_t __attribute__ ((aligned (8)));
 
 

ASM/c/swim.c

@@ -0,0 +1,72 @@
+#include "swim.h"
+
+RespawnByScene respawnsByScene[] = {
+    { 0x1D9, { { -1455, -20, 1384 }, 28761 }},      // Hyrule Field to Zora River (in water)
+    { 0x311, { { 5852, -20, 3725 }, -20025 }},      // Zora River to Hyrule Field (in water)
+    { 0x4DA, { { 1978, -36, -855 }, -16384 }},      // Zora River to Lost Woods
+    { 0x1DD, { { 4082, 860, -1018 }, -32768 }},     // Lost Woods to Zora River
+    { 0x219, { { -3276, -1033, 2908 }, 11228 }},    // Gerudo Valley to Lake Hylia
+    { 0x3D4,  { { -2361, 0, 610 }, 32768 }},        // Ice Cavern to Zora Fountain
+    { 0x21D, { { -955, -1306, 6768 }, -32768 }},    // Water Temple to Lake Hylia
+    { 0x328, { { -109, 11, -9 }, -29131 }},         // Lake Hylia to Zora Domain
+    { 0x560, { { -912, -1326, 3391 }, 0 }},         // Zora Domain to Lake Hylia
+    { 0x10E, { { -1500, 150, 1600 }, 32768}},       // Sapphire cutscene to Zora Fountain
+};
+
+void set_new_respawn() {
+
+    uint8_t newRespawnTrue = 0;
+    int32_t currentEntranceIndex = z64_game.entrance_index;
+    for (uint8_t i = 0; i < 10; i++) {
+        // Ensure we always respawn at a safe location.
+        if (currentEntranceIndex == respawnsByScene[i].scene_index) {
+            z64_Play_SetupRespawnPoint(&z64_game, 0x01, 0xDFF);
+            z64_file.respawn[RESPAWN_MODE_RETURN].pos = respawnsByScene[i].respawnInfo.pos;
+            z64_file.respawn[RESPAWN_MODE_RETURN].yaw = respawnsByScene[i].respawnInfo.yaw;
+            z64_file.respawn_flag = 2;
+            z64_game.scene_load_flag = 0x14;
+            newRespawnTrue = 1;
+            break;
+        }
+    }
+
+    // Special case for Water Temple river area, so that player respawns at the start of the room.
+    if (z64_game.scene_index == 5 && z64_game.room_index == 21) {
+        z64_Play_SetupRespawnPoint(&z64_game, 0x01, 0xDFF);
+        z64_xyzf_t riverPos = {-3063, 380, -4066};
+        z64_file.respawn[RESPAWN_MODE_RETURN].pos = riverPos;
+        z64_file.respawn[RESPAWN_MODE_RETURN].yaw = 9010;
+        z64_file.respawn_flag = 2;
+        z64_game.scene_load_flag = 0x14;
+        return;
+    }
+
+    if (newRespawnTrue == 0) {
+        z64_game.entrance_index = z64_file.entrance_index;
+        z64_game.fadeout_transition = 0x02;
+        z64_file.respawn_flag = -2;
+        z64_game.scene_load_flag = 0x14;
+    }
+}
+
+void manage_swim() {
+
+    // We found the first scale.
+    if (extended_savectx.extended_scale[0] > 0) {
+        return;
+    }
+
+    // Iron boots are equipped.
+    if (z64_file.equip_boots == 2) {
+        return;
+    }
+
+    // Always allow to swim out of water temple to avoid softlocks.
+    if (z64_game.scene_index == 5 && z64_link.common.pos_world.z > 700.0) {
+        return;
+    }
+
+    if (z64_link.state_flags_1 & 0x08000000) { // Swimming state flag.
+        set_new_respawn();
+    }
+}

ASM/c/swim.h

@@ -0,0 +1,19 @@
+#ifndef SWIM_H
+#define SWIM_H
+
+#include "z64.h"
+#include "save.h"
+
+typedef struct {
+    /* 0x00 */ z64_xyzf_t pos;
+    /* 0x0C */ uint16_t yaw;
+} SpecialRespawnInfo; // size = 0x10
+
+typedef struct {
+    int32_t scene_index;
+    SpecialRespawnInfo respawnInfo;
+} RespawnByScene;
+
+void manage_swim();
+
+#endif