-
If this setting is enabled, the player may disable any unfilled E-Tanks that they have collected, by navigating to the pause equipment screen, and moving the cursor up to the E-Tank area of the HUD.
-
Move the cursor to select an empty E-Tank, then press the A button to toggle it as enabled or disabled. Disabling an E-Tank will also disable the tanks "above" it, and enabling an E-Tank enables all the tanks "below" it.
-
Only empty E-Tanks can be disabled. To disable a full tank, Samus will have to take damage first in order to empty the tank.
+
This option controls the ability to disable E-Tanks during gameplay. When enabled, move the cursor up into the E-Tank area of the HUD, select an E-Tank and press A to toggle it.
+
Disabling an E-Tank will also disable the tanks "above" it, and enabling an E-Tank enables all the tanks "below" it.
+
+ - Off: Disables this feature: Energy Tanks cannot be disabled once collected.
+ - Standard: Only empty E-Tanks can be disabled. To disable a full tank, Samus will have to take damage first in order to empty the tank.
+ - Unrestricted: Any E-Tank can be disabled. Disabling full tanks will vent the excess energy, leaving Samus with 99 energy plus the remaining enabled tanks.
+
Reserve energy backward transfer:
diff --git a/rust/maprando/src/patch.rs b/rust/maprando/src/patch.rs
index c8f4e108e..b0de2fa07 100644
--- a/rust/maprando/src/patch.rs
+++ b/rust/maprando/src/patch.rs
@@ -18,9 +18,9 @@ use crate::{
patch::map_tiles::diagonal_flip_tile,
randomize::{LockedDoor, Randomization, get_starting_items},
settings::{
- AreaAssignmentPreset, ETankRefill, Fanfares, ItemCount, MotherBrainFight, Objective,
- ObjectiveScreen, RandomizerSettings, SaveAnimals, SpeedBooster, StartLocationMode,
- WallJump,
+ AreaAssignmentPreset, DisableETankSetting, ETankRefill, Fanfares, ItemCount,
+ MotherBrainFight, Objective, ObjectiveScreen, RandomizerSettings, SaveAnimals,
+ SpeedBooster, StartLocationMode, WallJump,
},
};
use anyhow::{Context, Result, bail, ensure};
@@ -582,7 +582,7 @@ impl Patcher<'_> {
patches.push("energy_station_reserves");
}
- if self.settings.quality_of_life_settings.disableable_etanks {
+ if self.settings.quality_of_life_settings.disableable_etanks != DisableETankSetting::Off {
patches.push("disableable_etanks");
}
@@ -689,6 +689,12 @@ impl Patcher<'_> {
}
self.rom.write_u16(snes2pc(0xdfff05), settings_flag)?;
+ if self.settings.quality_of_life_settings.disableable_etanks
+ == DisableETankSetting::Unrestricted
+ {
+ self.rom.write_u16(snes2pc(0x82F830), 0x0001)?;
+ }
+
Ok(())
}
diff --git a/rust/maprando/src/patch/map_tiles.rs b/rust/maprando/src/patch/map_tiles.rs
index 8027a1b94..54e25c7c2 100644
--- a/rust/maprando/src/patch/map_tiles.rs
+++ b/rust/maprando/src/patch/map_tiles.rs
@@ -4,8 +4,8 @@ use crate::{
customize::{CustomizeSettings, ItemDotChange},
randomize::{LockedDoor, Randomization},
settings::{
- DoorLocksSize, InitialMapRevealSettings, ItemMarkers, MapRevealLevel, MapStationReveal,
- Objective, RandomizerSettings,
+ DisableETankSetting, DoorLocksSize, InitialMapRevealSettings, ItemMarkers, MapRevealLevel,
+ MapStationReveal, Objective, RandomizerSettings,
},
};
use maprando_game::{
@@ -1522,7 +1522,7 @@ impl<'a> MapPatcher<'a> {
.into_iter()
.collect();
- if settings.quality_of_life_settings.disableable_etanks {
+ if settings.quality_of_life_settings.disableable_etanks != DisableETankSetting::Off {
// Reserve tile $2F for disabled ETank
reserved_tiles.insert(0x2F);
}
@@ -2940,7 +2940,7 @@ impl<'a> MapPatcher<'a> {
self.fix_message_boxes()?;
self.fix_hud_black()?;
self.darken_hud_grid()?;
- if self.settings.quality_of_life_settings.disableable_etanks {
+ if self.settings.quality_of_life_settings.disableable_etanks != DisableETankSetting::Off {
self.write_disabled_etank_tile()?;
}
self.apply_room_tiles()?;
diff --git a/rust/maprando/src/settings.rs b/rust/maprando/src/settings.rs
index e3d9bad92..6c3e28f69 100644
--- a/rust/maprando/src/settings.rs
+++ b/rust/maprando/src/settings.rs
@@ -119,6 +119,14 @@ pub enum StartingItemsPreset {
None,
All,
}
+
+#[derive(Serialize, Deserialize, Clone, PartialEq)]
+pub enum DisableETankSetting {
+ Off,
+ Standard,
+ Unrestricted,
+}
+
#[derive(Serialize, Deserialize, Clone, PartialEq)]
pub struct QualityOfLifeSettings {
pub preset: Option
,
@@ -149,7 +157,7 @@ pub struct QualityOfLifeSettings {
// Energy and reserves
pub etank_refill: ETankRefill,
pub energy_station_reserves: bool,
- pub disableable_etanks: bool,
+ pub disableable_etanks: DisableETankSetting,
pub reserve_backward_transfer: bool,
// Other:
pub buffed_drops: bool,
@@ -817,7 +825,17 @@ fn upgrade_qol_settings(settings: &mut serde_json::Value) -> Result<()> {
qol_settings.insert("energy_station_reserves".to_string(), false.into());
}
if !qol_settings.contains_key("disableable_etanks") {
- qol_settings.insert("disableable_etanks".to_string(), false.into());
+ qol_settings.insert("disableable_etanks".to_string(), "Off".into());
+ } else {
+ match qol_settings["disableable_etanks"].as_bool() {
+ Some(false) => {
+ qol_settings.insert("disableable_etanks".to_string(), "Off".into());
+ }
+ Some(true) => {
+ qol_settings.insert("disableable_etanks".to_string(), "Standard".into());
+ }
+ None => {}
+ };
}
if !qol_settings.contains_key("reserve_backward_transfer") {
qol_settings.insert("reserve_backward_transfer".to_string(), false.into());
diff --git a/rust/maprando/src/traverse.rs b/rust/maprando/src/traverse.rs
index 8889fac31..d079ce9db 100644
--- a/rust/maprando/src/traverse.rs
+++ b/rust/maprando/src/traverse.rs
@@ -10,7 +10,7 @@ use serde::{Deserialize, Serialize};
use crate::{
randomize::{DifficultyConfig, LockedDoor},
- settings::{MotherBrainFight, Objective, RandomizerSettings, WallJump},
+ settings::{DisableETankSetting, MotherBrainFight, Objective, RandomizerSettings, WallJump},
};
use maprando_game::{
BeamType, Capacity, DoorType, EnemyDrop, EnemyVulnerabilities, GameData, Item, Link, LinkIdx,
@@ -1157,10 +1157,8 @@ fn apply_requirement_simple(
*obj_id,
)
.into(),
- Requirement::DisableableETank => cx
- .settings
- .quality_of_life_settings
- .disableable_etanks
+ Requirement::DisableableETank => (cx.settings.quality_of_life_settings.disableable_etanks
+ != DisableETankSetting::Off)
.into(),
Requirement::Walljump => match cx.settings.other_settings.wall_jump {
WallJump::Vanilla => cx.difficulty.tech[cx.game_data.wall_jump_tech_idx].into(),
diff --git a/rust/maprando/tests/logic_scenarios.rs b/rust/maprando/tests/logic_scenarios.rs
index 574cfaf02..96813be58 100644
--- a/rust/maprando/tests/logic_scenarios.rs
+++ b/rust/maprando/tests/logic_scenarios.rs
@@ -5,9 +5,9 @@ use hashbrown::HashMap;
use maprando::{
randomize::{DifficultyConfig, Preprocessor},
settings::{
- InitialMapRevealSettings, ItemProgressionSettings, Objective, ObjectiveSettings,
- OtherSettings, QualityOfLifeSettings, RandomizerSettings, SkillAssumptionSettings,
- StartLocationSettings,
+ DisableETankSetting, InitialMapRevealSettings, ItemProgressionSettings, Objective,
+ ObjectiveSettings, OtherSettings, QualityOfLifeSettings, RandomizerSettings,
+ SkillAssumptionSettings, StartLocationSettings,
},
traverse::{LockedDoorData, Traverser},
};
@@ -82,7 +82,7 @@ struct ScenarioSettings {
shinecharge_leniency_frames: Option,
resource_multiplier: Option,
farm_time_limit: Option,
- disableable_etanks: Option,
+ disableable_etanks: Option,
buffed_drops: Option,
collectible_wall_jump: Option,
split_speed_booster: Option,
@@ -221,7 +221,17 @@ fn get_settings(scenario: &Scenario) -> Result {
remove_climb_lava: false,
etank_refill: maprando::settings::ETankRefill::Vanilla,
energy_station_reserves: false,
- disableable_etanks: settings.disableable_etanks.unwrap_or(false),
+ disableable_etanks: match settings
+ .disableable_etanks
+ .clone()
+ .unwrap_or("Off".to_string())
+ .as_str()
+ {
+ "Off" => DisableETankSetting::Off,
+ "Standard" => DisableETankSetting::Standard,
+ "Unrestricted" => DisableETankSetting::Unrestricted,
+ _ => DisableETankSetting::Off,
+ },
reserve_backward_transfer: false,
buffed_drops: settings.buffed_drops.unwrap_or(false),
early_save: false,
diff --git a/rust/maprando/tests/scenarios/disable-equipment/scenarios.json b/rust/maprando/tests/scenarios/disable-equipment/scenarios.json
index 94e481240..01367ade3 100644
--- a/rust/maprando/tests/scenarios/disable-equipment/scenarios.json
+++ b/rust/maprando/tests/scenarios/disable-equipment/scenarios.json
@@ -22,7 +22,7 @@
{
"name": "Have Disableable Tanks",
"settings": {
- "disableableEtanks": true
+ "disableableEtanks": "Standard"
},
"startRoomId": 0,
"startNodeId": 1,
diff --git a/rust/maprando/tests/schema/scenarios.schema.json b/rust/maprando/tests/schema/scenarios.schema.json
index 9224ebfe6..a415c5b15 100644
--- a/rust/maprando/tests/schema/scenarios.schema.json
+++ b/rust/maprando/tests/schema/scenarios.schema.json
@@ -66,7 +66,10 @@
"shinechargeLeniencyFrames": {"type": "integer"},
"resourceMultiplier": {"type": "number"},
"farmTimeLimit": {"type": "number"},
- "disableableEtanks": {"type": "boolean"},
+ "disableableEtanks": {
+ "type": "string",
+ "enum": ["Off", "Standard", "Unrestricted"]
+ },
"buffedDrops": {"type": "boolean"},
"collectibleWallJump": {"type": "boolean"}
}