Merge 'Fairy ocarina override' (#2080)

Author: cjohnson57

ASM/build/asm_symbols.txt

@@ -895,3 +895,23 @@ int give_sarias_gift() {
     // return 1 to skip the cutscene
     return OCARINAS_SHUFFLED || received_sarias_gift;
 }
+
+// called as part of the cutscene
+void fairy_ocarina_getitem() {
+    override_key_t lw_gift_from_saria = { .scene = 0xFF, .type = OVR_DELAYED, .flag = 0x02 };
+    override_t override = lookup_override_by_key(lw_gift_from_saria);
+    uint16_t resolved_item_id = resolve_upgrades(override);
+    switch (resolved_item_id) {
+        case 0x003B: { // Fairy Ocarina
+            z64_file.items[Z64_SLOT_OCARINA] = 0x07;
+            break;
+        }
+        case 0x000C: { // Ocarina of Time
+            z64_file.items[Z64_SLOT_OCARINA] = 0x08;
+            break;
+        }
+    }
+    item_row_t *item_row = get_item_row(resolved_item_id);
+    PLAYER_NAME_ID = override.value.base.player;
+    z64_DisplayTextbox(&z64_game, resolve_item_text_id(item_row, resolved_item_id, PLAYER_NAME_ID != PLAYER_ID), 0);
+}

ASM/build/bundle.o

@@ -22,7 +22,7 @@ enum override_type {
 };
 
 
-typedef union overide_key_t {
+typedef union override_key_t {
     uint32_t all;
     struct {
         uint8_t scene;

ASM/build/c_symbols.txt

@@ -127,6 +127,7 @@ RANDO_CONTEXT:
 
 .include "armos.asm"
 .include "ocarina_buttons.asm"
+.include "fairy_ocarina.asm"
 
 
 .align 0x10

ASM/c/get_items.c

@@ -0,0 +1,12 @@
+fairy_ocarina_getitem_override:
+    addiu   sp, sp, -0x20
+    sw      a0, 0x18(sp)
+    sw      ra, 0x1C(sp)
+
+    jal     fairy_ocarina_getitem
+    nop
+
+    lw      a0, 0x18(sp)
+    lw      ra, 0x1C(sp)
+    jr      ra
+    addiu   sp, sp, 0x20

ASM/c/get_items.h

@@ -3993,3 +3993,11 @@ courtyard_guards_kill:
 ;   sw      t7, 0x1F24(at)
     jal     ocarina_buttons
     nop
+
+;===================================================================================================
+; Overrides the function that gives Fairy Ocarina on the Lost Woods Bridge
+;===================================================================================================
+.orga 0xACCDFC
+; Replaces Item_Give(play, ITEM_OCARINA_FAIRY)
+    jal      fairy_ocarina_getitem_override
+    nop

ASM/src/build.asm

@@ -662,9 +662,6 @@ def make_bytes(txt: str, size: int) -> list[int]:
 
     # Speed obtaining Fairy Ocarina
     rom.write_bytes(0x2151230, [0x00, 0x72, 0x00, 0x3C, 0x00, 0x3D, 0x00, 0x3D])
-    block_code = [0x00, 0x4A, 0x00, 0x00, 0x00, 0x3A, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF,
-                  0xFF, 0xFF, 0x00, 0x3C, 0x00, 0x81, 0xFF, 0xFF]
-    rom.write_bytes(0x2151240, block_code)
     rom.write_bytes(0x2150E20, [0xFF, 0xFF, 0xFA, 0x4C])
 
     if world.settings.shuffle_ocarinas:

ASM/src/fairy_ocarina.asm

@@ -168,6 +168,7 @@ issue. You should always Hard Reset to avoid this issue entirely.
   * Fix a softlock caused by 8-note Sun's Songs when using `Randomize Ocarina Song Notes`, again.
   * Fix pause screen rendering causing graphical issues on some platforms.
   * Fix a long-standing bug where certain fanfares kill the currently-playing backgroud music.
+  * Fix a bug which would cause the Lost Woods bridge ocarina check, if ocarinas are unshuffled and overworld Entrance Randomizer is disabled, to give a Fairy Ocarina when it should give the Ocarina of Time.
 * **Hints**
   * Fix the cryptic hint for Ganon's Castle Boss Key.
   * Fix missing punctuation in dual hints.