diff --git a/patches/ips/reserve_backward_fill.ips b/patches/ips/reserve_backward_fill.ips index ebf5c3061..d24a8c4ef 100644 Binary files a/patches/ips/reserve_backward_fill.ips and b/patches/ips/reserve_backward_fill.ips differ diff --git a/patches/rom_map/Bank 82.txt b/patches/rom_map/Bank 82.txt index 0a3866fda..6833a1eaa 100644 --- a/patches/rom_map/Bank 82.txt +++ b/patches/rom_map/Bank 82.txt @@ -1,7 +1,7 @@ F70F - F810: map_area.asm F810 - F830: vanilla_bugfixes.asm -F830 - F9F6: disable_etanks.asm -F9F6 - FA00: [FREE] +F830 - F9D0: disable_etanks.asm +F9D0 - FA00: reserve_backward_fill.asm FA00 - FA80: alternate_door_colors.asm FA80 - FA90: fix_water_fx_bug.asm FA90 - FBB0: seed_hash_display.asm diff --git a/patches/rom_map/Bank 85.txt b/patches/rom_map/Bank 85.txt index 2e60d0590..21a085fdf 100644 --- a/patches/rom_map/Bank 85.txt +++ b/patches/rom_map/Bank 85.txt @@ -6,7 +6,7 @@ $9980 - $9B00: stats.asm $9B00 - $9B20: fix_hyper_slowlock.asm $9B20 - $9FF0: pause_menu_objectives.asm $9FF0 - $A050: vanilla_fanfare_stop_sounds -$A050 - $A100: reserve_backward_fill.asm +$A050 - $A100: [FREE] $A100 - $A180: fix_transition_bad_tiles.asm $A180 - $A280: special_door_reveal.asm $A280 - $A880: map_area.asm @@ -16,7 +16,7 @@ $AA00 - $AAA0: pause_menu_objectives.asm $AAA0 - $AB00: [FREE] $AB00 - $ACA0: map_area.asm $ACA0 - $AD00: load_flash_suit -$AD00 - $AE13: disable_etanks.asm -$AE13 - $B000: [FREE] +$AD00 - $AE20: disable_etanks.asm +$AE20 - $B000: reserve_backward_fill.asm $B000 - $B600: vanilla_bugfixes.asm $B600 - $BA00: map_area.asm \ No newline at end of file diff --git a/patches/rom_map/RAM.txt b/patches/rom_map/RAM.txt index 0c10a4ad5..5b09114eb 100644 --- a/patches/rom_map/RAM.txt +++ b/patches/rom_map/RAM.txt @@ -41,7 +41,8 @@ $7EF500: room map tile graphics pointer (into bank $E4) $7EF502-$7EF594: fix_dust_torizo.asm $7EF594-$7EF596: fix_transition_bad_tiles.asm $7EF596 - vanilla_bugfixes.asm -$7EF597 - $7EFE00: [FREE] +$7EF597 - reserve_backward_fill.asm +$7EF598 - $7EFE00: [FREE] $7EFE00: map area (copy of $1F5B to be saved to SRAM) $7EFE02: map area explored mask $7EFE04: copy of $1F5D (to be saved to SRAM for escape autosave) diff --git a/patches/src/reserve_backward_fill.asm b/patches/src/reserve_backward_fill.asm index fc8c9c890..ba7c2c297 100644 --- a/patches/src/reserve_backward_fill.asm +++ b/patches/src/reserve_backward_fill.asm @@ -1,71 +1,298 @@ -!bank_85_free_space_start = $85A050 -!bank_85_free_space_end = $85A100 +!bank_85_free_space_start = $85AE20 +!bank_85_free_space_end = $85B000 -; Hook code that run when equipment screen tanks mode (Auto/Manual) is selected: -org $82AE8E - jsl hook_reserve_refill +!bank_82_free_space_start = $82F9D0 +!bank_82_free_space_end = $82FA00 + +!arrow_mode = $7EF597 + +; Hook runs when the dpad is pressed in the SUPPLY section +; (Note: disableable_etanks also hooks at a later point in this routine, at ACEF (BRANCH_UP).) +org $82AC8E + jml hook_tanks_dpad_response + nop + +; Load equipment menu +org $8291B8 + jsl hook_init_arrow_mode + nop nop -; update reserve refill code to set the counter value to maximum (#$FFFF) rather than -; to the current amount in reserves. This prevents the refill from abruptly stopping -; if switching back and forth between forward and reverse fill. +org $82AD08 + ; There's a PLP / RTS here for when we need to escape hooked $82 routines that had to JML out to $85 +fake_rtl: + +; Hook code that prepares the reserve tank delay sound counter org $82AF5E - lda #$FFFF - sta $0757 - bra process_reserve_counter + jml hook_reserve_delay_counter_init + +; Hook code that performs the reserve tank refill +org $82AF81 + jml hook_reserve_tank_refilling + +; Jump table for the equipment tanks category (A button handler) +org $82AC7C + jsr (hook_tanks_items, x) + +org $82AC87 + ; Having hijacked the jump table that's normally here, we can repurpose it for a little bit of code... +hook_tanks_arrow_trampoline: + jml hook_tanks_arrow + +org $82AD1B + jsr (hook_tanks_glowing_arrow_jumptable, x) + +org $82AD25 +hook_tanks_glowing_arrow_selected_trampoline: + jml hook_tanks_glowing_arrow_selected + +org $82ACD6 + jsl hook_tanks_dpad_move_to_reserve + nop + nop +assert pc() == $82ACDC + +org $82B292 + beq escape + tax + dex + lda $0002,y +assert pc() == $82B299 -warnpc $82AF6B -org $82AF6B -process_reserve_counter: +org $82B2A0 +escape: + +org $82C18E + dw coord_table + +org !bank_82_free_space_start + +hook_tanks_items: + dw $AE8B, $AF4F, hook_tanks_arrow_trampoline + +hook_tanks_glowing_arrow_jumptable: + dw $AD29, $ADDD, hook_tanks_glowing_arrow_selected_trampoline + +coord_table: + dw $001B, $0054 ; Tanks - mode + dw $001B, $005C ; Tanks - reserve tank + dw $0000, $0000 ; Far off-screen + +extern_arrow_glow_off: + jsr $ADEF + rtl + +warnpc !bank_82_free_space_end org !bank_85_free_space_start -hook_reserve_refill: - lda $09C0 - cmp #$0002 ; reserves on manual? - bne .done - lda $8B - and #$8800 - cmp #$8800 ; holding up + B? - bne .done +!ram_bg1_tilemap_arrow_top = $7E3902 +!ram_bg1_tilemap_arrow_end = $7E3B04 +!arrow_top_normal_tile = $3D4C ; Vanilla tile (upward arrowhead) +!arrow_end_normal_tile = $3D6F ; Vanilla tile (short horizontal end) +!arrow_top_reversed_tile = $3D4A ; Custom tile (short vertical end) +!arrow_end_reversed_tile = $3D4B ; Custom tile (rightward arrowhead) + +hook_init_arrow_mode: + jsr reset_arrow + lda #$0001 ;Hijacked + sta $0763 + rtl + +hook_tanks_glowing_arrow_selected: + lda $074F ; X = Pause palette animation frame * 2 + asl + tax + + lda.l sequence_arrow_shadow_color,x + sta $7EC0CC ; Palette 6 slot 6 (arrow hilight)) + + lda.l sequence_arrow_fill_color,x + sta $7EC0D6 ; Palette 6 slot B (arrow fill) + jml $82AE01 ; Enable energy glow + +sequence_arrow_fill_color: + dw $318C, $35AD, $3DEF, $4A52, $56B5, $6739, $739C, $7FFF, $739C, $6739, $56B5, $4A52, $3DEF, $35AD, $318C + +sequence_arrow_shadow_color: + dw $2108, $2529, $2D6B, $39CE, $4631, $56B5, $6318, $6F7B, $6318, $56B5, $4631, $39CE, $2D6B, $2108, $2529 - ; skip if samus energy <= 1 +hook_tanks_dpad_move_to_reserve: + sta $0755 ; Part of the hijacked + ; Z = Don't move to the reserve tank, NZ = Do + lda !arrow_mode + beq .vanilla lda $09C2 - cmp #$0002 - bmi .done - - ; play sound every 8 frames: - LDA $0757 - DEC A - STA $0757 - AND #$0007 - BNE .refill - LDA #$002D - JSL $80914D ;} Queue sound 2Dh, sound library 3, max queued sounds allowed = 6 (gaining/losing incremental health) - -.refill: - ; do reverse refill, where energy transfers into reserves: + dec a + rtl +.vanilla + lda $09D6 + rtl + +reset_arrow: + lda #$0000 + sta !arrow_mode + lda.l arrow_top_tile + sta !ram_bg1_tilemap_arrow_top + lda.l arrow_end_tile + sta !ram_bg1_tilemap_arrow_end + jsl extern_arrow_glow_off + ; If this reset because you went to the map need to also reset the reserve timer + lda $0757 + beq .no + lda $09D6 + clc + adc #$0007 + and #$fff8 + sta $0757 +.no + rts + +hook_tanks_arrow: + php + lda $8F + bit #$0080 + beq .no + lda !arrow_mode + eor #$0001 + sta !arrow_mode + asl + tax + lda.l arrow_top_tile, x + sta !ram_bg1_tilemap_arrow_top + lda.l arrow_end_tile, x + sta !ram_bg1_tilemap_arrow_end + lda #$0037 + jsl $809049 ; Play sound: moved cursor + ; Reset the reserve fill sound timer + lda $0757 + beq .no + txa + beq .resume_normal lda $09C2 - dec - sta $09C2 + dec a + bra .resume +.resume_normal + lda $09D6 +.resume + clc + adc #$0007 + and #$FFF8 + sta $0757 +.no + jml fake_rtl + +arrow_top_tile: + dw !arrow_top_normal_tile, !arrow_top_reversed_tile + +arrow_end_tile: + dw !arrow_end_normal_tile, !arrow_end_reversed_tile + +hook_tanks_dpad_response: + ; Arrived here by JML from an $82 JSR - MUST JML back to an $82 PLP/RTS! + ;Hijacked instructions + lda $0755 + sta $12 + + lda $8F + bit #$0200 ; P1 D-Pad Left + beq .not_left + + ; Move to the arrow + lda $09C0 ; Reserve = [AUTO] -> don't + cmp #$0001 + beq .not_left + + lda $0755 + and #$00FF + ora #$0200 + sta $0755 + bra .moved + +.not_left + lda $12 + xba + and #$00FF + cmp #$0002 ; Arrow selected + bne .not_arrow + + lda $8F + bit #$0100 ; P1 D-Pad Right + beq .not_right + + ; Move back to the Mode select + stz $0755 +.moved + lda #$0037 + jsl $809049 ; Play sound: moved cursor + +.not_right + jml fake_rtl ; Skip the rest of the vanilla routine + +.not_arrow + jml $82AC93 ; Return to vanilla code + +hook_reserve_delay_counter_init: + lda !arrow_mode + beq .vanilla + lda $09c2 ; Reserve tank delay sound counter = [Samus health] - 1, rounded up to nearest 8 + dec a + clc + adc #$0007 + and #$fff8 + sta $0757 + jml $82AF6B ; Return to vanilla code at handling the reserve tank delay sound counter +.vanilla + lda $09d6 ; Hijacked code + clc + jml $82AF62 ; Return to vanilla code + +hook_reserve_tank_refilling: + lda !arrow_mode + beq .vanilla + + ; Samus health -= 1, unless this would be 0 + lda $09C2 + dec a + beq .stop_etanks_empty + sta $09C2 lda $09D6 + inc a cmp $09D4 - bpl .overfull - inc + bpl .stop_dump_etanks sta $09D6 + lda $09C2 + dec a + beq .stop_etanks_empty bra .done - -.overfull: - ; reserves are being overfilled, so set regular energy to 1 - ; (mirroring vanilla quirky behavior that sets reserve energy to 0 when overfilling regular energy) + +.stop_dump_etanks + ; Reserves hit full, vent regular energy + lda $09D4 + sta $09D6 lda #$0001 sta $09C2 + ;jsl extern_disable_arrow_glow -.done: - ; run hi-jacked code - lda $8f - bit #$0080 - rtl +.stop_etanks_empty + stz $0755 + stz $0757 + +.done + jml fake_rtl + +.vanilla + lda $09C2 ; Hijacked code + clc + jml $82AF85 ; Return to vanilla function + +warnpc !bank_85_free_space_end + +; There's a free spot right here in the vanilla pause BG1 tiles +org $B6A940 + db $00, $00, $00, $00, $00, $00, $10, $18, $10, $18, $10, $18, $10, $18, $10, $18 + db $00, $00, $00, $00, $3C, $00, $2C, $10, $2C, $10, $2C, $10, $2C, $10, $2C, $10 -warnpc !bank_85_free_space_end \ No newline at end of file + db $00, $80, $80, $C0, $C0, $E0, $E0, $F0, $F0, $F0, $E0, $E0, $C0, $C0, $80, $80 + db $C0, $00, $60, $80, $30, $C0, $18, $E0, $08, $F0, $10, $E0, $20, $C0, $40, $80 diff --git a/rust/maprando-web/templates/generate/help/quality/reserve_backward_transfer.html b/rust/maprando-web/templates/generate/help/quality/reserve_backward_transfer.html index 59912e6d7..4813b2157 100644 --- a/rust/maprando-web/templates/generate/help/quality/reserve_backward_transfer.html +++ b/rust/maprando-web/templates/generate/help/quality/reserve_backward_transfer.html @@ -6,7 +6,8 @@

Reserve energy backward transfer

-

If enabled, the player may transfer regular energy into reserve tanks, by navigating to the reserve tank mode in the pause menu equipment screen, setting it to Manual, and holding B and Up.

+

If enabled, the player may transfer regular energy into reserve tanks. After setting the reserve tank mode to MANUAL, press D-Pad Left to move the cursor to the large arrow. Press the A button and the arrow will switch directions.

+

The arrow indicates which way energy will transfer when the "RESERVE TANK" item is activated: normally it points from the reserve tank up to regular energy, and it will always return to this state when leaving the equipment menu (to view the map or to unpause). When toggled, it will instead point down, from regular energy, into the reserve tank. Thus, energy will be transferred from regular energy tanks to reserve tanks.

When using this feature, if reserve energy is overfilled, then regular energy instantly depletes to 1, similar to the vanilla behavior which instantly depletes reserve energy to 0 when regular energy is overfilled.

diff --git a/scripts/build_ips.py b/scripts/build_ips.py index 73f4bca2f..092a03ddf 100644 --- a/scripts/build_ips.py +++ b/scripts/build_ips.py @@ -148,6 +148,9 @@ def check_range(filename, other_filename, overlap_start, overlap_end): 'buffed_drops': [ ['no_drops', 0xB4F1F4, 0xB4F4B8] ], + 'reserve_backward_fill': [ + ['hud_expansion_opaque', 0xB6A940, 0xB6A980] + ], } failed = False