Epic/rupee sanity

code/include/z3D/actors/z_en_box.h

@@ -4,8 +4,11 @@
 #include "z3D/z3D.h"
 
 typedef struct EnBox {
-    /* 0x000 */ Actor actor;
-    /* 0x1A4 */ char unk_1A4[0x1F4];
-} EnBox; // size 0x398
+    /* 0x0000 */ DynaPolyActor dyna;
+    /* 0x01BC */ SkelAnime skelAnime;
+    /* 0x0240 */ char unk_240[0x148];
+    /* 0x0388 */ ZARInfo* zarInfo;
+    /* 0x038C */ char unk_38C[0xC];
+} EnBox; // size = 0x398
 
 #endif //_EN_BOX_H_

code/include/z3D/actors/z_en_item00.h

@@ -34,14 +34,22 @@ typedef enum Item00Type {
     /* 0xFF */ ITEM00_NONE = 0xFF
 } Item00Type;
 
+typedef struct EnItem00Extension {
+    u16 extraCollectibleFlag;
+    u8 spawnedBySceneLayer;
+} EnItem00Extension;
+
 typedef struct EnItem00 {
     /* 0x000 */ Actor actor;
-    /* 0x1A4 */ void* action_fn;
+    /* 0x1A4 */ void* actionFunc;
     /* 0x1A8 */ u16 collectibleFlag;
     /* 0x1AA */ char unk_1AA[0x4];
     /* 0x1AE */ u16 unk_1AE;
     /* 0x1B0 */ u16 unk_1B0;
     /* 0x1B2 */ char unk_1B2[0x66];
-} EnItem00; // size 0x218
+    // end of base game struct
+    /* 0x218 */ EnItem00Extension rExt;
+} EnItem00;
+_Static_assert(offsetof(EnItem00, rExt) == 0x218, "EnItem00 size");
 
 #endif //_EN_ITEM00_H_

code/include/z3D/actors/z_obj_mure3.h

@@ -0,0 +1,17 @@
+#ifndef Z_OBJ_MURE3_H
+#define Z_OBJ_MURE3_H
+
+#include "z3D/z3D.h"
+
+typedef void (*ObjMure3ActionFunc)(struct Actor*, struct GlobalContext*);
+
+struct ObjMure3;
+
+typedef struct ObjMure3 {
+    /* 0x0000 */ Actor actor;
+    /* 0x014C */ ObjMure3ActionFunc actionFunc;
+    /* 0x0150 */ struct EnItem00* spawnedRupees[7];
+    /* 0x016C */ u16 unk_16C;
+} ObjMure3; // size = 0x0170
+
+#endif

code/include/z3D/z3D.h

@@ -811,6 +811,9 @@ typedef u32 (*Flags_GetSwitch_proc)(GlobalContext* globalCtx, u32 flag);
 typedef u32 (*Flags_GetCollectible_proc)(GlobalContext* globalCtx, u32 flag);
 #define Flags_GetCollectible ((Flags_GetCollectible_proc)GAME_ADDR(0x36405C))
 
+typedef u32 (*Flags_SetCollectible_proc)(GlobalContext* globalCtx, u32 flag);
+#define Flags_SetCollectible ((Flags_SetCollectible_proc)GAME_ADDR(0x3329D8))
+
 typedef u32 (*Flags_GetClear_proc)(GlobalContext* globalCtx, u32 flag);
 #define Flags_GetClear ((Flags_GetClear_proc)GAME_ADDR(0x36CF6C))
 

code/include/z3D/z3Dactor.h

@@ -390,4 +390,8 @@ typedef void (*Actor_UpdateBgCheckInfo_proc)(struct GlobalContext* globalCtx, Ac
 typedef s32 (*Player_InCsMode_proc)(struct GlobalContext* globalCtx);
 #define Player_InCsMode ((Player_InCsMode_proc)GAME_ADDR(0x36A7A0))
 
+typedef Actor* (*Actor_FindNearby_proc)(struct GlobalContext* globalCtx, Actor* ref_actor, s16 actorId,
+                                        u8 actor_category, f32 range);
+#define Actor_FindNearby ((Actor_FindNearby_proc)GAME_ADDR(0x369334))
+
 #endif

code/oot.ld

@@ -540,6 +540,10 @@ SECTIONS
 		*(.patch_GohmaEggDeathSignalParent)
 	}
 
+	.patch_Item00GiveAutomaticItemDrop 0x1F6E4C : {
+		*(.patch_Item00GiveAutomaticItemDrop)
+	}
+
 	.patch_ItemGiveBombchuDropOne 0x1F6F70 : {
 		*(.patch_ItemGiveBombchuDropOne)
 	}
@@ -640,6 +644,10 @@ SECTIONS
 		*(.patch_GetObjectEntry_EnHintnutsInit)
 	}
 
+	.patch_Item00GiveCollectedItemDrop 0x22B974 : {
+		*(.patch_Item00GiveCollectedItemDrop)
+	}
+
 	.patch_patch_ItemGiveBombchuDropTwo 0x22BAE4 : {
 		*(.patch_ItemGiveBombchuDropTwo)
 	}

code/src/actor.c

@@ -83,6 +83,7 @@
 #include "stalfos.h"
 #include "bubble.h"
 #include "ganondorf.h"
+#include "obj_mure3.h"
 
 #define OBJECT_GI_KEY 170
 #define OBJECT_GI_BOSSKEY 185
@@ -129,10 +130,11 @@ void Actor_Init() {
 
     gActorOverlayTable[0xF].initInfo->update = (ActorFunc)BgYdanSp_rUpdate;
 
-    gActorOverlayTable[0x15].initInfo->init    = EnItem00_rInit;
-    gActorOverlayTable[0x15].initInfo->destroy = EnItem00_rDestroy;
-    gActorOverlayTable[0x15].initInfo->update  = EnItem00_rUpdate;
-    gActorOverlayTable[0x15].initInfo->draw    = EnItem00_rDraw;
+    gActorOverlayTable[0x15].initInfo->init         = EnItem00_rInit;
+    gActorOverlayTable[0x15].initInfo->destroy      = EnItem00_rDestroy;
+    gActorOverlayTable[0x15].initInfo->update       = EnItem00_rUpdate;
+    gActorOverlayTable[0x15].initInfo->draw         = EnItem00_rDraw;
+    gActorOverlayTable[0x15].initInfo->instanceSize = sizeof(EnItem00);
 
     gActorOverlayTable[0x1D].initInfo->update = EnPeehat_rUpdate;
 
@@ -315,6 +317,8 @@ void Actor_Init() {
 
     gActorOverlayTable[0x1A3].initInfo->update = EnDntNomal_rUpdate;
 
+    gActorOverlayTable[0x1AB].initInfo->update = ObjMure3_rUpdate;
+
     gActorOverlayTable[0x1B0].initInfo->update = EnSkb_rUpdate;
 
     gActorOverlayTable[0x1B9].initInfo->init = EnGs_rInit;
@@ -379,6 +383,14 @@ u8 ActorSetup_OverrideEntry(ActorEntry* actorEntry, s32 actorEntryIndex) {
         return TRUE;
     }
 
+    if (actorEntry->id == ACTOR_EN_ITEM00) {
+        // Mark as spawned by scene layer.
+        // All vanilla actor entries for EnItem00 have Z rotation set to 0,
+        // so we can use it as a custom flag.
+        actorEntry->rot.z = -1;
+        return FALSE;
+    }
+
     return Enemizer_OverrideActorEntry(actorEntry, actorEntryIndex);
 }
 

code/src/actors/chest.h

@@ -2,14 +2,7 @@
 #define _CHEST_H_
 
 #include "z3D/z3D.h"
-
-typedef struct EnBox {
-    /* 0x0000 */ DynaPolyActor dyna;
-    /* 0x01BC */ SkelAnime skelAnime;
-    /* 0x0240 */ char unk_240[0x148];
-    /* 0x0388 */ ZARInfo* zarInfo;
-    /* 0x038C */ char unk_38C[0xC];
-} EnBox; // size = 0x398
+#include "z3D/actors/z_en_box.h"
 
 typedef enum {
     CHEST_MAJOR,

code/src/actors/item00.c

@@ -1,7 +1,10 @@
 #include "z3D/z3D.h"
 #include "z3D/actors/z_en_item00.h"
 #include "models.h"
+#include "actors/obj_mure3.h"
 #include "settings.h"
+#include "common.h"
+#include "savefile.h"
 
 #define EnItem00_Init ((ActorFunc)GAME_ADDR(0x1F69B4))
 
@@ -13,7 +16,7 @@
 
 #define THIS ((EnItem00*)thisx)
 
-#define FUN_002B175C (void*)GAME_ADDR(0x2B175C)
+#define EnItem00_Collected ((void*)GAME_ADDR(0x2B175C))
 
 void EnItem00_rInit(Actor* thisx, GlobalContext* globalCtx) {
     EnItem00* item = THIS;
@@ -44,7 +47,25 @@ void EnItem00_rInit(Actor* thisx, GlobalContext* globalCtx) {
             item->actor.params = (item->actor.params & 0xFF00) | 0x00;
         }
     }
+
+    // If Z rotation is -1, it was set in `ActorSetup_OverrideEntry`
+    if (thisx->home.rot.z == -1) {
+        item->rExt.spawnedBySceneLayer = TRUE;
+        thisx->home.rot.z              = 0;
+    }
+
     EnItem00_Init(&item->actor, globalCtx);
+
+    // For rupees spawned by Rupee Circles (ObjMure3) we use an "extraCollectibleFlag".
+    // Since collectibleFlag normally gets truncated to 0x3F we can use any value at or above
+    // 0x40. We've reserved 0x40-0x46 for Rupee circle rupees.
+    if (item->collectibleFlag == 0x00 && gIsObjMure3Updating) {
+        item->rExt.extraCollectibleFlag = gExtraCollectibleFlag;
+        gExtraCollectibleFlag += 1;
+        if (gExtraCollectibleFlag > 0x46) {
+            gExtraCollectibleFlag = 0x40;
+        }
+    }
     Model_SpawnByActor(&item->actor, globalCtx, 0);
 }
 
@@ -58,9 +79,16 @@ void EnItem00_rDestroy(Actor* thisx, GlobalContext* globalCtx) {
 void EnItem00_rUpdate(Actor* thisx, GlobalContext* globalCtx) {
     EnItem00* item = THIS;
 
-    if (Flags_GetCollectible(globalCtx, item->collectibleFlag) && item->action_fn != FUN_002B175C) {
-        Actor_Kill(&item->actor);
-        return;
+    if (gSettingsContext.mp_Enabled && item->actionFunc != EnItem00_Collected) {
+        if (Flags_GetCollectible(globalCtx, item->collectibleFlag)) {
+            Actor_Kill(&item->actor);
+            return;
+        }
+
+        u16 flag = item->rExt.extraCollectibleFlag ? item->rExt.extraCollectibleFlag : item->collectibleFlag;
+        if (SaveFile_GetRupeeSanityFlag(globalCtx->sceneNum, flag)) {
+            Model_DestroyByActor(thisx);
+        }
     }
 
     EnItem00_Update(&item->actor, globalCtx);

code/src/actors/obj_mure3.c

@@ -0,0 +1,13 @@
+#include "z3D/z3D.h"
+#include "common.h"
+
+u8 gIsObjMure3Updating   = 0;    // global variable for rupee circle rupee replacement.
+u8 gExtraCollectibleFlag = 0x40; // global variable for rupee circle rupee replacement.
+#define ObjMure3_Update ((ActorFunc)GAME_ADDR(0x002318ac))
+
+void ObjMure3_rUpdate(Actor* thisx, GlobalContext* globalCtx) {
+    gExtraCollectibleFlag = 0x40;
+    gIsObjMure3Updating   = TRUE;
+    ObjMure3_Update(thisx, globalCtx);
+    gIsObjMure3Updating = FALSE;
+}

code/src/actors/obj_mure3.h

@@ -0,0 +1,9 @@
+#ifndef _OBJ_MURE3_H_
+#define _OBJ_MURE3_H_
+
+#include "z3D/z3D.h"
+extern u8 gIsObjMure3Updating;   // global variable for rupee circle rupee replacement.
+extern u8 gExtraCollectibleFlag; // global variable for rupee circle rupee replacement.
+void ObjMure3_rUpdate(Actor* thisx, GlobalContext* globalCtx);
+
+#endif //_OBJ_MURE3_H_

code/src/hooks.s

@@ -2487,3 +2487,25 @@ hook_OcarinaNoteSound_Npc:
     cpy r1,r0
     pop {r0, r2-r12, lr}
     bx lr
+
+.global hook_Item00GiveAutomaticItemDrop
+hook_Item00GiveAutomaticItemDrop:
+    ldrsh r0,[r4,#0x1c]
+    push {r0-r12, lr}
+    cpy r0,r4 @ actor
+    bl ItemOverride_GetItemDrop
+    cmp r0,#0x0
+    pop {r0-r12, lr}
+    addne lr,lr,#0x8 @ Item overridden, skip Item_Give
+    bx lr
+
+.global hook_Item00GiveCollectedItemDrop
+hook_Item00GiveCollectedItemDrop:
+    ldrsh r0,[r5,#0x1c]
+    push {r0-r12, lr}
+    cpy r0,r5 @ actor
+    bl ItemOverride_GetItemDrop
+    cmp r0,#0x0
+    pop {r0-r12, lr}
+    addne lr,lr,#0x8 @ Item overridden, skip Item_Give
+    bx lr