Merge 'Fix for ladder cutscene softlock vanilla bug' (#2551)

# Conflicts:
#	ASM/build/bundle.o
#	data/generated/rom_patch.txt

Author: fenhl

ASM/build/asm_symbols.txt

@@ -133,6 +133,7 @@ RANDO_CONTEXT:
 .include "en_dns.asm"
 .include "bg_gate_shutter.asm"
 .include "big_poe.asm"
+.include "player_ladder_cutscene.asm"
 
 .align 0x10
 .importobj "../build/bundle.o"

ASM/src/build.asm

@@ -4161,3 +4161,4 @@ DemoEffect_DrawJewel_AfterHook:
 .include "hacks/ovl_en_ssh.asm"
 .include "hacks/ovl_en_okarina_tag.asm"
 .include "hacks/sound.asm"
+.include "hacks/z_player.asm"

ASM/src/hacks.asm

@@ -0,0 +1,10 @@
+.headersize(0x808301c0 - 0xbcdb70)
+
+;================================================================================
+; Fixes softlock when starting cutscene while dismounting a ladder.
+;================================================================================
+; Replaces  lw  t8,1644(s0)
+;           lui at,0xffdf
+.org 0x8084a6c4         ; in Player_Action_DismountLadder (0x803a3064)
+    jal  player_ladder_cutscene
+    nop

ASM/src/hacks/z_player.asm

@@ -0,0 +1,11 @@
+player_ladder_cutscene:
+    lbu   t4,1693(s0)                  ; player->unk_6AD
+    addi  t3,t4,-3                     ; Cutscene = 3, CS item = 4
+    bltz  t3,@@player_ladder_return    ; If not CS/CS item, continue as usual
+    nop
+    addi  ra,0x14                      ; Else, continue at 0x8084a6e0/0x803a3080 (load argument to LinkAnimation_Update)
+
+@@player_ladder_return:                ; Original code
+    lw    t8,1644(s0)
+    jr    ra
+    lui   at,0xffdf

ASM/src/player_ladder_cutscene.asm

@@ -22,6 +22,7 @@
 * Various minor fixes for advanced logic.
 * Fix for advanced logic tricks being cached when switching to glitchless logic.
 * Fix for misc hints when the hinted item was randomly selected as a starting item.
+* Fix a vanilla softlock when starting a cutscene while climbing a ladder.
 
 ## Other Changes
 * It is no longer required to have either the goron tunic or the Fewer Tunic Requirements trick for adult to go from the Bolero warp pad to the Fire temple in logic.

CHANGELOG.md

@@ -1286,13 +1286,6 @@ def calculate_traded_flags(world):
         if world.dungeon_mq['Spirit Temple']: # Patch Spirit MQ Lobby front right chest to use permanent switch flag 0x1F
             rom.write_byte(0x2b08ce4 + 13, 0x1F)
 
-        if not world.dungeon_mq['Bottom of the Well']:
-            # Collecting the final BotW basement silver rupee and activating the cutscene of the door unlocking while on the ladder causes a softlock.
-            # Move slightly the X coordinate of this actor so that it cannot be collected while climbing.
-            # This is a vanilla bug tracked at https://github.com/OoTRandomizer/OoT-Randomizer/issues/2004
-            # If and when that bug is fixed in rando, this displacement can be removed.
-            rom.write_int16(0x32E92C6, 0xFD78)
-
     # Write flag table data
     xflags_tables, alt_list = build_xflags_from_world(world)
     xflag_scene_table, xflag_room_table, xflag_room_blob, max_bit = build_xflag_tables(xflags_tables)