revamp menu preset init process

Author: Aelto

mod-menu.xml

@@ -5,6 +5,7 @@
         <PresetsArray>
             <Preset id="0" displayName="rer_defaults" >
                 <Entry varId="RERmodEnabled" value="1" />
+                <Entry varId="RERmenuPreset" value="1" />
                 <Entry varId="Difficulty" value="4" />
                 <Entry varId="RERlevelScaling" value="0" />
                 <Entry varId="RERexternalFactorsImpact" value="2" />
@@ -18,6 +19,20 @@
             <Var id="RERmodEnabled" displayName="rer_mod_enabled" displayType="TOGGLE"></Var>
             <Var id="RERperformanceMode" displayName="rer_performance_mode" displayType="TOGGLE"></Var>
 
+            <Var id="RERmenuPreset" displayName="rer_menu_preset" displayType="OPTIONS">
+                <OptionsArray>
+                    <Option id="0" displayName="rer_default">
+                        <Entry varId="RERmenuPreset" value="0"/>
+                    </Option>
+                    <Option id="1" displayName="rer_menu_preset_none">
+                        <Entry varId="RERmenuPreset" value="1"/>
+                    </Option>
+                    <Option id="2" displayName="rer_menu_preset_enhanced_edition">
+                        <Entry varId="RERmenuPreset" value="2"/>
+                    </Option>
+                </OptionsArray>
+            </Var>
+
 			<Var id="Separator" displayName="" displayType="SUBTLE_SEPARATOR"/>
 
             <Var id="RERgeneralIntensity" displayName="rer_general_intensity" displayType="SLIDER;0;500;500"/>

src/helpers/menu_descriptors/main.wss

@@ -8,7 +8,12 @@ class RER_MainMenuDescriptor extends SU_MenuDescriptor {
 
     this.onHover(
       'RERperformanceMode',
-      "Enabling <font color='#CD7D03'>Performance Mode</font> will alter how the mod operates to focus even more on performances, sometimes by ignoring the values from the menu to use pre-defined ones, or by disabling features like the Ecosystem for a smoother experience at the cost of immersion.<br/><br/>Changes to the option requires a reload of the save to take effect."
+      "Enabling <font color='#CD7D03'>Performance Mode</font> will alter how the mod operates to focus even more on performances, sometimes by ignoring the values from the menu to use pre-defined ones, or by disabling features like the Ecosystem for a smoother experience at the cost of immersion. Note that this option is only useful if you notice a framerate drop caused by your CPU being pushed to its maximum capacity.<br/><br/>Changes to the option requires a reload of the save to take effect."
+    );
+
+    this.onHover(
+      'RERmenuPreset',
+      "Setting this option to anything else than <font color='#CD7D03'>No preset</font> will tell the mod to update all of the settings according to the selected preset the next time you load a save. The mod does NOT have to be enabled for this option to take effect, in fact it will also cause the mod to enable itself once the preset is applied."
     );
 
     this.onHoverDynamic(
@@ -35,7 +40,7 @@ class RER_MainMenuDescriptor extends SU_MenuDescriptor {
       );
 
       if (value > 200.0) {
-        return description + "<br/><br/>A value above 200% can cause performance issues from the amount of spawns it will cause, adjust encounter settings and more specifically the death threshold accordingly (a lower value).";
+        return description + "<br/><br/>A value above 200% can cause performance issues from the amount of spawns it will create, adjust encounter settings and more specifically the death threshold accordingly (a lower value).";
       }
     }
 

src/settings.wss

@@ -232,10 +232,6 @@ class RE_Settings {
     );
   }
 
-  public function shouldResetRERSettings(inGameConfigWrapper: CInGameConfigWrapper): bool {
-    return StringToFloat(inGameConfigWrapper.GetVarValue('RERmain', 'RERmodVersion')) <= 0;
-  }
-
   private function loadModEnabledSettings(inGameConfigWrapper: CInGameConfigWrapper) {
     this.is_enabled = inGameConfigWrapper.GetVarValue('RERmain', 'RERmodEnabled');
   }

src/states/initialising/initialising.wss

@@ -33,10 +33,7 @@ state Initialising in CRandomEncounters {
       return;
     }
 
-    if (parent.settings.shouldResetRERSettings(theGame.GetInGameConfigWrapper())) {
-      this.displayPresetChoiceDialogeMenu();
-    }
-
+    this.tryApplyMenuPreset();
     this.removeAllRerMapPins();
     this.updateSettings();
 
@@ -88,188 +85,30 @@ state Initialising in CRandomEncounters {
     constants = RER_Constants();
     current_version = StringToFloat(config.GetVarValue('RERmain', 'RERmodVersion'));
 
-    if (current_version < 2.07) {
-      config.ApplyGroupPreset('RERcontracts', 0);
-
-      current_version = 2.07;
-    }
-
-    if (current_version < 2.08) {
-      NDEBUG("[RER] The mod was updated to v2.8: the Contract System settings were reset to support the new reputation system");
-
-      // reset the contract tutorial value so it displays again
-      // config.SetVarValue('RERtutorials', 'RERtutorialMonsterContract', 1);
-      config.ApplyGroupPreset('RERcontracts', 0);
-
-      current_version = 2.08;
-    }
-
-    if (current_version < 2.09) {
-      NDEBUG("[RER] The mod was updated to v2.9: the Contract System settings were reset to support updated distance settings");
-
-      // reset the contract tutorial value so it displays again
-      // config.SetVarValue('RERtutorials', 'RERtutorialMonsterContract', 1);
-      config.ApplyGroupPreset('RERcontracts', 0);
-
-      // disable any active bounty from before v2.9 since it won't be compatible
-      // anymore.
-      parent.storages.bounty.current_bounty.is_active = false;
-
-      current_version = 2.09;
-    }
-
-    if (current_version < 2.11) {
-      NDEBUG("[RER] The mod was updated to v2.11");
-
-      current_version = 2.11;
-    }
-
-    if (current_version < 2.12) {
-      var message: string;
-
-      message += "You just updated the Random Encounters Reworked mod to the v2.12, the loot update.<br/><br/>";
-      message += "All of your reward settings were reset following the update. ";
-      message += "To simplify and streamline the loot coming from the mod, all of the old rewards were removed and replaced ";
-      message += "with a central and generic system. This system called the Loot Manager offers four loot categories:";
-      message += "<br/> - Gear";
-      message += "<br/> - Materials";
-      message += "<br/> - Consumables";
-      message += "<br/> - Valuables";
-      message += "<br/>And for each category it offers four loot rarities: ";
-      message += "<br/> - Common";
-      message += "<br/> - Uncommon";
-      message += "<br/> - Rare";
-      message += "<br/> - Exotic";
-      message += "<br/><br/>Now every time RER wants to add loot to something, it sends a call to the loot manager which will ";
-      message += "give it a list of items based on the settings you set in the menu, and this for every feature in the mod.";
-
-      NTUTO("RER v2.12 - The loot update", message);
-
-      config.ApplyGroupPreset('RERrewardsGeneral', 0);
-      config.ApplyGroupPreset('RERcontainerRefill', 0);
-      config.ApplyGroupPreset('RERkillingSpreeCustomLoot', 0);
-      config.ApplyGroupPreset('RERmonsterTrophies', 0);
-      config.ApplyGroupPreset('RERcontracts', 0);
-
-      current_version = 2.12;
-    }
-
-    if (current_version < 2.13) {
-      config.ApplyGroupPreset('RERmonsterTrophies', 0);
-
-      if (RER_playerUsesEnhancedEditionRedux()) {
-        config.SetVarValue('RERmonsterTrophies', 'RERtrophyMasterBuyingPrice', 30);
-      }
-
-      current_version = 2.13;
-    }
-
-    if (current_version < 3.0) {
-      current_version = 3.0;
-
-      config.ApplyGroupPreset('RERtutorials', 0);
-    }
-
-    if (current_version < 3.01) {
-      current_version = 3.01;
-
-      var message: string;
-      message += "Random Encounters Reworked was updated to the v3.1 - The Next-Gen update";
-      message += "<br/>A new settings was enabled automatically: disable encounter spawns when near quest markers.";
-      message += "If you wish to turn it off, you can find the toggle at the bottom of the Encounters System, General menu";
-      NTUTO("RER v3.1 - Next-Gen update", message);
-
-      config.SetVarValue('RERmonsterTrophies', 'RERtrophyMasterBuyingPrice', 1);
-      config.ApplyGroupPreset('RERtutorials', 0);
-    }
-
-    if (current_version < 3.02) {
-      current_version = 3.02;
-
-      var message: string;
-      message += "Random Encounters Reworked was updated to the v3.2";
-      message += "<br/>This version brings two major changes:";
-      message += "<br/><br/>" + RER_yellowFont("Standalone 3D markers") + " for the various things spawned by the mod "
-               + "were added. You can toggle them ON or OFF in the " + RER_yellowFont("Optional Features") + " menu.";
-
-      message += "<br/><br/>" + RER_yellowFont("Contract rewards streamlining") + ", the random nature of Tokens of Gratitude "
-               + "plus the need to find the bounty master to sell them was frustrating. "
-               + "A new option (that is enabled by default) was added to the Contracts menu to give crowns directly instead "
-               + "of tokens. If you prefer the Tokens way of getting reward, this solution was streamlined to no longer "
-               + "scale with your current reputation but instead scale linearly with the contract's difficulty: 1 plus "
-               + "an additional token every 7 Contract levels";
-
-      NTUTO("RER v3.2 - 3D Markers & Contract rewards", message);
-
-      config.SetVarValue('RERoptionalFeatures', 'RERonelinersBountyMainTarget', 1);
-      config.SetVarValue('RERoptionalFeatures', 'RERonelinersContract', 1);
-      config.SetVarValue('RERoptionalFeatures', 'RERonelinersBountyMaster', 1);
-      config.SetVarValue('RERmonsterCrowns', 'RERcrownsContract', 40);
-      config.SetVarValue('RERcontracts', 'RERcontractsRewardOption', 0);
-    }
-
-    if (current_version < 3.03) {
-      current_version = 3.03;
-
-      config.SetVarValue('RERcontracts', 'RERcontractsDeathReputationLossAmount', 1);
-
-      NTUTO("RER v3.3", "The mod was successfully updated to v3.3");
-    }
-
-    if (current_version < 3.04) {
-      current_version = 3.04;
-
-      config.SetVarValue('RERmain', 'RERlevelScaling', 0);
-      config.ApplyGroupPreset('RERcontracts', 0);
-
-      NTUTO("RER v3.4", "The mod was successfully updated to v3.4");
-    }
-
     if (current_version < 3.05) {
       current_version = 3.05;
 
       config.SetVarValue('RERmain', 'RERgeneralIntensity', 100);
 
-      NTUTO("RER v3.5", "The mod was successfully updated to v3.5");
+      NDEBUG("Random Encounters Reworked was successfully updated to v3.5");
     }
 
     config.SetVarValue('RERmain', 'RERmodVersion', constants.version);
     theGame.SaveUserSettings();
   }
 
-  latent function displayPresetChoiceDialogeMenu() {
-    var choices: array<SSceneChoice>;
-    var manager: RER_PresetManager;
-    var response: SSceneChoice;
-
-    manager = new RER_PresetManager in this;
-    manager.master = parent;
-
-    choices = manager.getChoiceList();
-
+  latent function tryApplyMenuPreset() {
     while (isPlayerBusy()) {
       Sleep(5);
     }
 
     Sleep(5);
 
-    (new RER_RandomDialogBuilder in thePlayer).start()
-      .dialog(new REROL_whoa_in_for_one_helluva_ride in thePlayer, true)
-      .play();
-
-    response = SU_setDialogChoicesAndWaitForResponse(choices);
-    SU_closeDialogChoiceInterface();
-    manager.GotoState(response.playGoChunk);
-
+    var manager: RER_PresetManager = new RER_PresetManager in this;
+    manager.tryApplyMenuPreset(RER_getModMenuPreset(), parent);
     while (!manager.done) {
       SleepOneFrame();
     }
-
-    (new RER_RandomDialogBuilder in thePlayer).start()
-      .dialog(new REROL_ready_to_go_now in thePlayer, true)
-      .play();
-
-    theGame.SaveUserSettings();
   }
 
   private function removeAllRerMapPins() {

src/states/initialising/presets/enhanced_edition.wss

@@ -72,8 +72,8 @@ state EnhancedEdition in RER_PresetManager {
     this.wrapperMultiplyFloatValue(wrapper, 'RERmonsterTrophies', 'RERtrophyMasterBuyingPrice', 0.65);
 
     theGame.SaveUserSettings();
-
     parent.done = true;
+    parent.displayPresetAppliedPopup("Enhanced Edition (W3EE)");
   }
 
   function wrapperMultiplyFloatValue(wrapper: CInGameConfigWrapper, menu: name, value: name, multiplier: float) {

src/states/initialising/presets/preset_manager.wss

@@ -3,50 +3,41 @@ statemachine class RER_PresetManager {
   public var done: bool;
   public var master: CRandomEncounters;
 
-  public function getPresetList(): array<RER_Preset> {
-    var output: array<RER_Preset>;
-
-    output.PushBack(RER_Preset(
-      "rer_dialog_preset_vanilla",
-      'Vanilla'
-    ));
-
-    output.PushBack(RER_Preset(
-      "rer_dialog_preset_enhanced_edition",
-      'EnhancedEdition'
+  public function displayPresetAppliedPopup(preset_name: string) {
+    NDEBUG(StrReplace(
+      GetLocStringByKey()
+      "{{preset_name}}",
+      preset_name
     ));
+  }
 
-    output.PushBack(RER_Preset(
-      "rer_dialog_preset_exit_do_nothing",
-      'Exit'
-    ));
+  public function tryApplyMenuPreset(
+    preset: RER_MenuPreset,
+    master: CRandomEncounters
+  ) {
+    this.done = false;
+    this.master = master;
 
-    return output;
-  }
+     if (preset == RER_MenuPreset_Default) {
+      this.GotoState('Vanilla');
+      return;
+    }
 
-  public function getChoiceList(): array<SSceneChoice> {
-    var presets: array<RER_Preset>;
-    var choices: array<SSceneChoice>;
-    var i: int;
-
-    presets = this.getPresetList();
-
-    for (i = 0; i < presets.Size(); i += 1) {
-      choices.PushBack(SSceneChoice(
-        GetLocStringByKey(presets[i].dialog_string_key),
-        false,
-        false,
-        false,
-        DialogAction_GAME_DAGGER,
-        presets[i].state_name
-      ));
+    if (preset == RER_MenuPreset_EnhancedEdition) {
+      this.GotoState('EnhancedEdition');
+      return;
     }
 
-    return choices;
+    this.done = true;
   }
 }
 
-struct RER_Preset {
-  var dialog_string_key: string;
-  var state_name: name;
+enum RER_MenuPreset {
+  RER_MenuPreset_Default = 0,
+  RER_MenuPreset_None = 1,
+  RER_MenuPreset_EnhancedEdition = 2,
+}
+
+function RER_getModMenuPreset(): RER_MenuPreset {
+  return StringToInt(RER_menu('RERmain', 'RERmenuPreset'));
 }

src/states/initialising/presets/vanilla.wss

@@ -9,8 +9,7 @@ state Vanilla in RER_PresetManager {
 
   entry function Vanilla_applySettings() {
     parent.master.settings.resetRERSettings(theGame.GetInGameConfigWrapper());
-
     parent.done = true;
+    parent.displayPresetAppliedPopup("Defaults / Vanilla");
   }
-
 }

strings/en.w3strings.csv

@@ -556,4 +556,8 @@
 2115018488|        |rer_surround_ecosystem_popup_body|This area and its vicinity are now teeming with {{teeming_creature_names}}. The possibility of encountering {{less_likely_creature_names}} is now less likely.<br /><br />{{ecosystem_advice}}<br /><br />{{ecosystem_delay_multiplier}}
 2115018489|        |rer_ecosystem_advice|A large community of {{creature_name}} lives here due to the abundance of {{advice_creature_names}} As a result, other creatures such as {{other_creature_names}} may roam the area.
 2115018490|        |rer_ecosystem_addition_advice|<br />In addition, {{creature_name}} prevent {{advice_creature_names}} from residing here.
-2115018491|        |rer_ecosystem_delay_multiplier|Creatures in the area are multiplying at {{rate_parent}} of their usual rate.
+2115018491|        |rer_ecosystem_delay_multiplier|Creatures in the area are multiplying at {{rate_parent}} of their usual rate.
+2115018492|        |option_rer_menu_preset|Menu preset
+2115018493|        |option_rer_menu_preset_enhanced_edition|Enhanced Edition (W3EE)
+2115018494|        |option_rer_menu_preset_none|No preset
+2115018495|        |rer_menu_preset_applied_message|<u>Random Encounters Reworked</u><br/><br/>The mod is enabled and its settings were set to the <font color="#ffd33d">{{preset_name}</font> preset. If you are using an overhaul like Enhanced Edition (W3EE), make sure to visit the mod's general menu to apply the dedicated preset for a smoother experience.