Add fog of war to the patch map

simulation_parameters/common/difficulty_presets.json

@@ -10,6 +10,7 @@
     "osmoregulationMultiplier": 0.8,
     "freeGlucoseCloud": true,
     "passiveReproduction": true,
+    "patchMapExplorationMode": "Light",
     "limitGrowthRate": false
   },
   "normal": {
@@ -23,6 +24,7 @@
     "osmoregulationMultiplier": 1,
     "freeGlucoseCloud": true,
     "passiveReproduction": true,
+    "patchMapExplorationMode": "Intense",
     "limitGrowthRate": true
   },
   "hard": {
@@ -36,6 +38,7 @@
     "osmoregulationMultiplier": 1.2,
     "freeGlucoseCloud": false,
     "passiveReproduction": true,
+    "patchMapExplorationMode": "Intense",
     "limitGrowthRate": true
   },
   "custom": {

src/auto-evo/AutoEvoExploringTool.tscn

@@ -857,12 +857,14 @@ anchor_bottom = 0.0
 margin_right = 792.0
 margin_bottom = 206.0
 DrawDefaultMapIfEmpty = false
+IgnoreFogOfWar = true
 
 [node name="PatchDetailsPanel" parent="GUI/VBoxContainer/HistoryReportSplit/PatchMap/HBoxContainer" instance=ExtResource( 17 )]
 margin_left = 834.0
 margin_right = 1180.0
 margin_bottom = 518.0
 MoveToPatchButtonVisible = false
+IgnoreFogOfWar = true
 
 [node name="Report" type="Control" parent="GUI/VBoxContainer/HistoryReportSplit"]
 visible = false
@@ -1025,8 +1027,8 @@ HideCancelButton = true
 [connection signal="value_changed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer3/FinishXGenerationsSpin" to="." method="OnFinishXGenerationsSpinBoxValueChanged"]
 [connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer3/FinishXGenerations" to="." method="OnFinishXGenerationsButtonPressed"]
 [connection signal="value_changed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer4/RunXWorldsSpin" to="." method="OnRunXWorldsSpinBoxValueChanged"]
-[connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer4/RunXWorlds" to="." method="OnFinishXGenerationsButtonPressed"]
 [connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer4/RunXWorlds" to="." method="OnRunXWorldsButtonPressed"]
+[connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/HBoxContainer4/RunXWorlds" to="." method="OnFinishXGenerationsButtonPressed"]
 [connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/Abort" to="." method="OnAbortButtonPressed"]
 [connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/PlayWithThis" to="." method="PlayWithCurrentSettingPressed"]
 [connection signal="pressed" from="GUI/VBoxContainer/WorldEditor/VBoxContainer/PanelContainer/MarginContainer/VBoxContainer/WorldExportButton" to="." method="ExportWorlds"]

src/auto-evo/RunResults.cs

@@ -599,6 +599,14 @@ public void PrintSummary(PatchMap? previousPopulations = null)
             LocalizedStringBuilder PatchString(Patch patch)
             {
                 var builder2 = new LocalizedStringBuilder(80);
+
+                if (!patch.Explored)
+                {
+                    var unknownPatch = new LocalizedString("UNKNOWN_PATCH");
+                    builder2.Append(unknownPatch);
+                    return builder2;
+                }
+
                 if (!playerReadable)
                 {
                     builder2.Append(patch.ID);

src/early_multicellular_stage/editor/EarlyMulticellularEditor.cs

@@ -115,6 +115,11 @@ public void OnCurrentPatchUpdated(Patch patch)
         cellEditorTab.UpdateBackgroundImage(patch.BiomeTemplate);
     }
 
+    public void UpdateReportTabPatchSelector()
+    {
+        reportTab.UpdateReportTabPatchSelector();
+    }
+
     public override int WhatWouldActionsCost(IEnumerable<EditorCombinableActionData> actions)
     {
         return history.WhatWouldActionsCost(actions);

src/engine/CheatManager.cs

@@ -27,6 +27,11 @@ static CheatManager()
     /// </summary>
     public static event EventHandler<EventArgs>? OnDespawnAllEntitiesCheatUsed;
 
+    /// <summary>
+    ///   Fired whenerver the user uses the "Reveal Entire Patch Map" cheat
+    /// </summary>
+    public static event EventHandler<EventArgs>? OnRevealEntirePatchMapCheatUsed;
+
     /// <summary>
     ///   You automatically have 100% of all compounds
     /// </summary>
@@ -79,6 +84,11 @@ public static void DespawnAllEntities()
         OnDespawnAllEntitiesCheatUsed?.Invoke(null, EventArgs.Empty);
     }
 
+    public static void RevealEntirePatchMap()
+    {
+        OnRevealEntirePatchMapCheatUsed?.Invoke(null, EventArgs.Empty);
+    }
+
     public static void DisableAllCheats()
     {
         InfiniteCompounds = false;

src/general/CustomDifficulty.cs

@@ -12,5 +12,6 @@ public class CustomDifficulty : IDifficulty
     public float OsmoregulationMultiplier { get; set; }
     public bool FreeGlucoseCloud { get; set; }
     public bool PassiveReproduction { get; set; }
+    public PatchMap.FogOfWarMode PatchMapExplorationMode { get; set; }
     public bool LimitGrowthRate { get; set; }
 }

src/general/DifficultyPreset.cs

@@ -51,6 +51,9 @@ public class DifficultyPreset : IDifficulty, IRegistryType
     [JsonProperty]
     public bool PassiveReproduction { get; private set; }
 
+    [JsonProperty]
+    public PatchMap.FogOfWarMode PatchMapExplorationMode { get; private set; }
+
     [JsonProperty]
     public bool LimitGrowthRate { get; private set; }
 

src/general/IDifficulty.cs

@@ -44,6 +44,12 @@ public interface IDifficulty : IRegistryAssignable
     /// </summary>
     public bool PassiveReproduction { get; }
 
+    /// <summary>
+    ///   If true, the patch map will have to be discovered by the player instead of having the
+    ///   entire patch map revealed at the start
+    /// </summary>
+    public PatchMap.FogOfWarMode PatchMapExplorationMode { get; }
+
     /// <summary>
     ///   Whether microbes are limited in how fast they can consume reproduction compounds to grow
     /// </summary>
@@ -64,6 +70,7 @@ public static CustomDifficulty Clone(this IDifficulty difficulty)
             OsmoregulationMultiplier = difficulty.OsmoregulationMultiplier,
             FreeGlucoseCloud = difficulty.FreeGlucoseCloud,
             PassiveReproduction = difficulty.PassiveReproduction,
+            PatchMapExplorationMode = difficulty.PatchMapExplorationMode,
             LimitGrowthRate = difficulty.LimitGrowthRate,
         };
     }
@@ -81,6 +88,7 @@ public static string GetDescriptionString(this IDifficulty difficulty)
             $", Osmoregulation multiplier: {difficulty.OsmoregulationMultiplier}" +
             $", Free glucose cloud: {difficulty.FreeGlucoseCloud}" +
             $", Passive Reproduction: {difficulty.PassiveReproduction}" +
+            $", Patch Map Exploration: {difficulty.PatchMapExplorationMode}" +
             $", Limit Growth Rate: {difficulty.LimitGrowthRate}";
     }
 }

src/general/MainMenu.tscn

@@ -898,7 +898,6 @@ visible = false
 visible = false
 
 [node name="NewGameSettings" parent="." instance=ExtResource( 18 )]
-visible = false
 
 [node name="Thriveopedia" parent="." instance=ExtResource( 49 )]
 visible = false

src/general/NewGameSettings.cs

@@ -96,6 +96,12 @@ public class NewGameSettings : ControlWithInput
     [Export]
     public NodePath PassiveReproductionButtonPath = null!;
 
+    [Export]
+    public NodePath PatchMapExplorationModePath = null!;
+
+    [Export]
+    public NodePath PatchMapExplorationModeDescriptionPath = null!;
+
     [Export]
     public NodePath LimitGrowthRateButtonPath = null!;
 
@@ -176,6 +182,8 @@ public class NewGameSettings : ControlWithInput
     private Button freeGlucoseCloudButton = null!;
     private Button passiveReproductionButton = null!;
     private Button limitGrowthRateButton = null!;
+    private OptionButton patchMapExplorationMode = null!;
+    private Label patchMapExplorationModeDescription = null!;
 
     // Planet controls
     private OptionButton lifeOriginButton = null!;
@@ -257,6 +265,8 @@ public override void _Ready()
         osmoregulationMultiplierReadout = GetNode<LineEdit>(OsmoregulationMultiplierReadoutPath);
         freeGlucoseCloudButton = GetNode<Button>(FreeGlucoseCloudButtonPath);
         passiveReproductionButton = GetNode<Button>(PassiveReproductionButtonPath);
+        patchMapExplorationMode = GetNode<OptionButton>(PatchMapExplorationModePath);
+        patchMapExplorationModeDescription = GetNode<Label>(PatchMapExplorationModeDescriptionPath);
         limitGrowthRateButton = GetNode<Button>(LimitGrowthRateButtonPath);
         lifeOriginButton = GetNode<OptionButton>(LifeOriginButtonPath);
         lifeOriginButtonAdvanced = GetNode<OptionButton>(LifeOriginButtonAdvancedPath);
@@ -301,6 +311,10 @@ public override void _Ready()
             difficultyPresetAdvancedButton.AddItem(preset.UntranslatedName);
         }
 
+        patchMapExplorationMode.AddItem(TranslationServer.Translate("FOG_OF_WAR_DISABLED"));
+        patchMapExplorationMode.AddItem(TranslationServer.Translate("FOG_OF_WAR_LIGHT"));
+        patchMapExplorationMode.AddItem(TranslationServer.Translate("FOG_OF_WAR_INTENSE"));
+
         // Do this in case default values in NewGameSettings.tscn don't match the normal preset
         InitialiseToPreset(normal);
 
@@ -368,6 +382,9 @@ public void OpenFromDescendScreen(GameProperties currentGame)
         freeGlucoseCloudButton.Pressed = difficulty.FreeGlucoseCloud;
         passiveReproductionButton.Pressed = difficulty.PassiveReproduction;
         limitGrowthRateButton.Pressed = difficulty.LimitGrowthRate;
+        patchMapExplorationMode.Selected = (int)difficulty.PatchMapExplorationMode;
+
+        UpdatePatchMapExplorationModeDescription(patchMapExplorationMode.Selected);
 
         UpdateSelectedDifficultyPresetControl();
 
@@ -445,6 +462,8 @@ protected override void Dispose(bool disposing)
                 OsmoregulationMultiplierReadoutPath.Dispose();
                 FreeGlucoseCloudButtonPath.Dispose();
                 PassiveReproductionButtonPath.Dispose();
+                PatchMapExplorationModePath.Dispose();
+                PatchMapExplorationModeDescriptionPath.Dispose();
                 LimitGrowthRateButtonPath.Dispose();
                 LifeOriginButtonPath.Dispose();
                 LifeOriginButtonAdvancedPath.Dispose();
@@ -544,6 +563,7 @@ private void StartGame()
                 FreeGlucoseCloud = freeGlucoseCloudButton.Pressed,
                 PassiveReproduction = passiveReproductionButton.Pressed,
                 LimitGrowthRate = limitGrowthRateButton.Pressed,
+                PatchMapExplorationMode = (PatchMap.FogOfWarMode)patchMapExplorationMode.Selected,
             };
 
             settings.Difficulty = customDifficulty;
@@ -676,6 +696,9 @@ private void OnDifficultyPresetSelected(int index)
         freeGlucoseCloudButton.Pressed = preset.FreeGlucoseCloud;
         passiveReproductionButton.Pressed = preset.PassiveReproduction;
         limitGrowthRateButton.Pressed = preset.LimitGrowthRate;
+        patchMapExplorationMode.Selected = (int)preset.PatchMapExplorationMode;
+
+        UpdatePatchMapExplorationModeDescription(patchMapExplorationMode.Selected);
 
         UpdateSelectedDifficultyPresetControl();
     }
@@ -716,6 +739,9 @@ private void UpdateSelectedDifficultyPresetControl()
             if (limitGrowthRateButton.Pressed != preset.LimitGrowthRate)
                 continue;
 
+            if (patchMapExplorationMode.Selected != (int)preset.PatchMapExplorationMode)
+                continue;
+
             // If all values are equal to the values for a preset, use that preset
             difficultyPresetButton.Selected = preset.Index;
             difficultyPresetAdvancedButton.Selected = preset.Index;
@@ -787,6 +813,12 @@ private void OnPassiveReproductionToggled(bool pressed)
         UpdateSelectedDifficultyPresetControl();
     }
 
+    private void OnPatchMapExplorationModeToggled(bool pressed)
+    {
+        _ = pressed;
+        UpdateSelectedDifficultyPresetControl();
+    }
+
     private void OnGrowthRateToggled(bool pressed)
     {
         _ = pressed;
@@ -800,6 +832,34 @@ private void OnLifeOriginSelected(int index)
         lifeOriginButtonAdvanced.Selected = index;
     }
 
+    private void OnPatchMapExplorationModeSelected(int index)
+    {
+        patchMapExplorationMode.Selected = index;
+
+        UpdatePatchMapExplorationModeDescription(index);
+
+        UpdateSelectedDifficultyPresetControl();
+    }
+
+    private void UpdatePatchMapExplorationModeDescription(int index)
+    {
+        switch (index)
+        {
+            case 0:
+                patchMapExplorationModeDescription.Text =
+                    TranslationServer.Translate("FOG_OF_WAR_DISABLED_DESCRIPTION");
+                break;
+            case 1:
+                patchMapExplorationModeDescription.Text =
+                    TranslationServer.Translate("FOG_OF_WAR_LIGHT_DESCRIPTION");
+                break;
+            case 2:
+                patchMapExplorationModeDescription.Text =
+                    TranslationServer.Translate("FOG_OF_WAR_INTENSE_DESCRIPTION");
+                break;
+        }
+    }
+
     // This and a few other callbacks are not currently needed to detect anything, but I left them in in case we
     // need them in the future / this is refactored to build the custom difficulty object in steps - hhyyrylainen
     private void OnMapTypeSelected(int index)