Prevent softlock when Hookshot cannot spawn on equip

Hook into Player_InitHookshotIA
Asm check if Hookshot actor is NULL
If so, Player_UseItem item none

Author: djevangelia

ASM/build/asm_symbols.txt

@@ -2,6 +2,7 @@
 #include "objects.h"
 #include "item_effects.h"
 #include "actor.h"
+#include "player.h"
 
 extern uint16_t current_textbox_id;
 
@@ -480,7 +481,7 @@ void draw_debug_menu(z64_disp_buf_t* db) {
                 if (input_local_copy.pad_pressed.a) {
                     z64_GiveItem(&z64_game, Z64_ITEM_BUNNY_HOOD);
                     if (z64_game.pause_ctxt.state == PAUSE_STATE_OFF) {
-                        z64_usebutton(&z64_game, &z64_link, Z64_ITEM_BUNNY_HOOD, 2);
+                        Player_UseItem(&z64_game, &z64_link, Z64_ITEM_BUNNY_HOOD);
                     }
                 }
             }

ASM/build/bundle.o

@@ -1,6 +1,7 @@
 #include "gfx.h"
 #include "dpad.h"
 #include "trade_quests.h"
+#include "player.h"
 
 extern uint8_t CFG_DISPLAY_DPAD;
 
@@ -10,10 +11,8 @@ extern uint8_t CFG_DISPLAY_DPAD;
 //unknown 03 is always a3 in my testing
 //unknown 04 is always a3 + 0x08 in my testing (801043A8)
 typedef void(*playsfx_t)(uint16_t sfx, z64_xyzf_t* unk_00_, int8_t unk_01_ , float* unk_02_, float* unk_03_, float* unk_04_);
-typedef void(*usebutton_t)(z64_game_t* game, z64_link_t* link, uint8_t item, uint8_t button);
 
 #define z64_playsfx   ((playsfx_t)      0x800C806C)
-#define z64_usebutton ((usebutton_t)    0x8038C9A0)
 
 void handle_dpad() {
 
@@ -57,12 +56,12 @@ void handle_dpad() {
 
         if (z64_file.link_age == 1) {
             if (pad_pressed.dr && CAN_USE_CHILD_TRADE) {
-                z64_usebutton(&z64_game,&z64_link,z64_file.items[Z64_SLOT_CHILD_TRADE], 2);
+                Player_UseItem(&z64_game,&z64_link,z64_file.items[Z64_SLOT_CHILD_TRADE]);
             }
         }
 
         if (pad_pressed.dd && CAN_USE_OCARINA) {
-            z64_usebutton(&z64_game,&z64_link,z64_file.items[Z64_SLOT_OCARINA], 2);
+            Player_UseItem(&z64_game,&z64_link,z64_file.items[Z64_SLOT_OCARINA]);
         }
     }
 }

ASM/build/c_symbols.txt

@@ -0,0 +1,6 @@
+#ifndef PLAYER_H
+#define PLAYER_H
+
+extern void Player_UseItem(z64_game_t* game, z64_link_t* player, int32_t item);
+
+#endif

ASM/c/debug.c

@@ -41,5 +41,6 @@ z64_sEquipMoveTimer = 0x8039EAB8;
 gActorOverlayTable = 0x800E8530;
 Message_CloseTextbox = 0x800d6218;
 sSetupDL = 0x800f7d50;
+Player_UseItem = 0x8038c9a0; /* 0x80834000 */
 OVL_EnOkarinaTag_Action2 = 0x80a872d0;
 OVL_EnOkarinaTag_Action1 = 0x80a87088;

ASM/c/dpad.c

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

ASM/c/player.h

@@ -6,5 +6,15 @@
 ; Replaces  lw  t8,1644(s0)
 ;           lui at,0xffdf
 .org 0x8084a6c4         ; in Player_Action_DismountLadder (0x803a3064)
-    jal  player_ladder_cutscene
+    jal     Player_LadderCutsceneFix
     nop
+
+;================================================================================
+; Prevent softlock if Hookshot actor cannot spawn when equipping
+; (memory shortage due to Hyrule Field glitch, child equip etc)
+;================================================================================
+; Replaces  lw      a1,60(sp)
+;           sw      v0,924(a1)
+.org 0x808319d4         ; in Player_InitHookshotIA (0x8038a374)
+     jal     Player_HookshotCheckActorSpawn
+     lw      a1,60(sp)       ; displaced (loads player)

ASM/ootSymbols.ld

@@ -0,0 +1,14 @@
+Player_HookshotCheckActorSpawn:
+    bnez    v0,@@Return     ; If Hookshot actor spawned, 
+    sw      v0,924(a1)      ; set it as heldActor and continue
+
+    addiu   sp,sp,-24
+    sw      ra,16(sp)
+    move    a0,s1           ; Otherwise, use item none to avoid softlock
+    jal     Player_UseItem  ; a0 play a1 player a2 item
+    li      a2,255
+    lw      ra,16(sp)
+    addiu   sp,sp,24
+@@Return:
+    jr      ra
+    nop