Add todo for reusing xaserle reveal secrets effect using room tag

Add todo for special object interaction

Dungeons/Objects/object_handler.asm

@@ -1,30 +1,52 @@
+; =========================================================
 ; Dungeon Object Handler
 
-org    $018262            ;object id 0x31
+org $018262
-  dw ExpandedObject
+  dw ExpandedObject ; Object ID 0x31
+  dw SecretObject   ; Object ID 0x32
 
 ; #_018650: dw RoomDraw_WeirdUglyPot ID 230
 org $018650
   dw HeavyPot
 
+; Item ID 22B 
+; Heavy Pot grahics
+; Currently modified to look like normal pot 
+org $00A9AC
+  dw $0D28, $0D38, $4D28, $4D38
+
+; org $01B306 ; RoomDraw_WeirdGloveRequiredPot
+;   LDA.w #$1010
+
 ; Bank01 Free Space
 org $01B53C
   ExpandedObject:
-  JSL NewObjectsCode
+  {
-  RTS
+    JSL NewObjectsCode
+    RTS
+  }
+
+  SecretObject:
+  {
+    JSL HandleSecretObjects
+    RTS
+  }
 
   HeavyPot:
-  LDA.w #$1010
+  {
-  PHX : LDX.w $042C
+    LDA.w #$1010
-  LDA.w #$1111 : STA $0500, X
+    PHX : LDX.w $042C
-  ; Store this object's position in the object buffer to $0520, X
+    LDA.w #$1111 : STA $0500, X
-  LDA $BA : STA $0520, X
+    ; Store object's position in the object buffer to $0520, X
-  ; Store it's tilemap position.
+    LDA $BA : STA $0520, X
-  TYA : STA $0540, X
+    ; Store tilemap position.
-  JMP $B350
+    TYA : STA $0540, X
-
+    JMP $B350
+  }
 warnpc $01B560
 
+; =========================================================
+
 org $2C8000
 NewObjectsCode:
 {
@@ -132,32 +154,34 @@ NewObjectsCode:
     incbin Data/small_statue.bin
 }
 
-
 ; May need to make this a table 
 ; This modifies object 0xOE to use the spritesheets for the object
 CustomDrawConfig:
 {
-  PHA
+    PHA
-  LDA $03 : AND #$00FF : CMP.w #$000E : BEQ .custom_config
+    LDA $03 : AND #$00FF : CMP.w #$000E : BEQ .custom_config
+      TYA : LSR : AND #$00FF
+      CMP #$000E : BNE .no_spriteset
+        LDA #$000E : STA $03
+    .custom_config
+      PLA
+      ORA.w #$0300 : JMP .return
+    .no_spriteset   
+      PLA
+  .return
+    RTS
+}
 
-  TYA : LSR : AND #$00FF
+; =========================================================
+; Secret Object Handler
+; Disappears if Link uses the Book of Secrets near them
 
-  CMP #$000E : BNE .no_spriteset
+HandleSecretObjects:
-    LDA #$000E : STA $03
+{
-  .custom_config
+  ; TODO: Implement the Book of Secrets check
-    PLA
+  ; TODO: Add object draw code 
-    ORA.w #$0300 : JMP .return
+  ; TODO: Implement the object's disappearance
-.no_spriteset   
+  RTL
-    PLA
-.return
-  RTS
 }
 
 pushpc
-
-; Item ID 22B 
-org $00A9AC
-  dw $0D28, $0D38, $4D28, $4D38
-
-; org $01B306 ; RoomDraw_WeirdGloveRequiredPot
-;   LDA.w #$1010

Items/book_of_secrets.asm

@@ -1,22 +1,62 @@
 ; =========================================================
 ; Book of Secrets (Reveal Secrets with Book of Mudora)
+; Interacts with SpecialObject ID 0x32 
+; Makes objects disappear when using the book
+
+org $07A45E
+EXIT_07A45E:
+
+org $07AA6C
+Link_PerformDesertPrayer:
+
+; Restored vanilla book of mudora code
+; TODO: Update to work with special object
+org $07A471
+LinkItem_Book:
+{
+    BIT.b $3A : BVS .exit
+    LDA.b $6C : BNE EXIT_07A45E
+    JSR Link_CheckNewY_ButtonPress : BCC .exit
+
+    LDA.b $3A : AND.b #$BF : STA.b $3A
+    LDA.w $02ED : BNE .do_prayer
+    LDA.b #$3C : JSR PlaySFX_Set2 ; SFX2.3C
+
+    BRA .exit
+
+  .do_prayer
+    BRL Link_PerformDesertPrayer
+
+  .exit
+    RTS
+}
+warnpc $07A494
+
+; =========================================================
 ; Makes BG2 Disappear when holding L in a building
 ; Based on the Parallel Worlds feature
 ;
-; Layer Flags: xxxsabcd (i count BG from 1 to 4 - MathOnNapkins RAM-Map counts from 0 to 3)
+; Layer Flags: xxxsabcd 
+; (i count BG from 1 to 4 
+;   - MathOnNapkins RAM-Map counts from 0 to 3)
 ; s - Sprite layer enabled 
 ; a - BG4 enabled
 ; b - BG3 enabled
 ; c - BG2 enabled
-; d - (BG1 disabled) --> only works properly if the room uses the feature "BG2 on Top"
+; d - (BG1 disabled) --> only works properly if the room 
+;                         uses the feature "BG2 on Top"
 ;
 ; Originally by XaserLE, updated by scawful
+; Note: No longer used as part of Book of Secrets globally
+; Likely will be reused for specific events where we can
+; ensure the BG2 will have something secret to show,
+; rather than allowing the ability to be used anywhere.
 
 ; =========================================================
 ; long subroutine that is executed every frame
 
 org $068365			  
-JSL LinkItem_SecretsBook ; overwrite it (originally JSL $099F91)
+JSL LinkItem_SecretsBook ; hook JSL $099F91
 
 ; =========================================================
 
@@ -28,8 +68,7 @@ LinkItem_SecretsBook:
   LDA $1B : AND #$01 : BEQ .end
 
     ; ----------
-    ; Check if we have the book of secrets
+    ; TODO: Add a new condition, such as a RoomTag check
-    LDA $7EF34D : CMP #$01 : BNE $0F ; if not, go to enable BG2
 
     ; load unfiltered joypad 1 register (AXLR|????)
     ; delete all bits except those for L
@@ -46,7 +85,7 @@ LinkItem_SecretsBook:
     ; ----------
 
 .end
-  JSL $099F91			  ; at least execute original code
+  JSL $099F91			  ; restore original code
   RTL
 }
 

Items/portal_rod.asm

@@ -1,11 +1,7 @@
-org $07A471 ; Mudora
+; portal_rod.asm by scawful
-  JSR LinkItem_PortalRod
+; TODO: Make the item an alternative to the FishingRod
-  RTS
 
-
+; Replace LinkState_UsingEther
-warnpc $07A493
-
-; *$3A50F-$3A568
 org    $07A50F
 RodAnimationTimer:
   db $03, $03, $05
@@ -109,6 +105,7 @@ LinkItem_FirePortal:
 
   STZ $0D60, X
   STZ $0D70, X
+  LDA #$09 : STA $0DD0, X
       
   PLX
 
@@ -126,6 +123,8 @@ LinkItem_FirePortal:
 
 }
 
+; =========================================================
+
 pushpc 
 
 org $02FF6E