Implement quick load hotkey

changelog/snippets/features.7066.md

@@ -0,0 +1 @@
+- (#7066) Add a quick load hotkey that loads the game from the special quick save file.

loc/US/strings_db.lua

@@ -4464,6 +4464,8 @@ key_desc_0405="Dock"
 key_desc_0407="Select all Bombers (Normal)"
 key_desc_0408="Select all Bombers (Torpedo)"
 
+key_desc_quick_load="Load the game from the special quick save file"
+
 keymap_category_0000="UI"
 keymap_category_0004="Selection"
 keymap_category_0025="Camera"
@@ -5293,6 +5295,7 @@ sCDR_Victoria="sCDR Victoria"
 sCDR_ZanIavow="sCDR Zan-Iavow"
 saveload_0001="Saving game..."
 saveload_0002="Quick Save in progress..."
+saveload_QuickLoad="Loading Quick Save..."
 score_0001="No Rush Time Elapsed"
 score_0002="Unit Cap Reached"
 score_0003="Observer"

lua/keymap/alternativeKeyMap.lua

@@ -35,6 +35,7 @@ defaultKeyMap = {
     ['F10']                 = 'toggle_main_menu',
     ['F11']                 = 'toggle_disconnect_screen',
     ['F12']                 = 'show_objective_screen',
+    ['Shift-F9']            = 'quick_load',
 
     ['1']                   = 'group1',
     ['2']                   = 'group2',

lua/keymap/defaultKeyMap.lua

@@ -32,6 +32,7 @@ defaultKeyMap = {
     ['F10']                 = 'toggle_main_menu',
     ['F11']                 = 'toggle_disconnect_screen',
     ['F12']                 = 'show_objective_screen',
+    ['Shift-F9']            = 'quick_load',
     ['1']                   = 'group1',
     ['2']                   = 'group2',
     ['3']                   = 'group3',

lua/keymap/hotbuildKeyMap.lua

@@ -36,6 +36,7 @@ defaultKeyMap = {
     ['F10']                 = 'toggle_main_menu',
     ['F11']                 = 'toggle_disconnect_screen',
     ['F12']                 = 'show_objective_screen',
+    ['Shift-F9']            = 'quick_load',
 
     ['1']                   = 'group1',
     ['2']                   = 'group2',

lua/keymap/keyactions.lua

@@ -1834,6 +1834,10 @@ local keyActionsGame = {
         action = 'UI_Lua import("/lua/ui/game/gamemain.lua").QuickSave(LOC("<LOC QuickSave>QuickSave"))',
         category = 'ui',
     },
+    ['quick_load'] = {
+        action = 'UI_Lua import("/lua/ui/game/gamemain.lua").QuickLoad(LOC("<LOC QuickSave>QuickSave"))',
+        category = 'ui',
+    },
     ['toggle_key_bindings'] = {
         action = 'UI_Lua import("/lua/ui/dialogs/keybindings.lua").CreateUI()',
         category = 'ui',

lua/keymap/keydescriptions.lua

@@ -219,6 +219,7 @@ keyDescriptions = {
     ['cam_free'] = "<LOC key_desc_0104>Toggles camera free mode",
 
     ['quick_save'] = "<LOC key_desc_0130>Save the game to a special quick save file",
+    ['quick_load'] = "<LOC key_desc_quick_load>Load the game from the special quick save file",
     ['mouse_help'] = "<LOC key_desc_0132>Turn the mouse button help icon on/off",
 
     ['create_build_template'] = "<LOC key_desc_0181>Create a build template based on the current selection",

lua/ui/game/gamemain.lua

@@ -28,6 +28,8 @@ local ordersControl = false
 
 local OnDestroyFuncs = {}
 
+ --- game's "Non-Interactive Sequence" state as synced from Sim
+ ---@type 'on' | 'off' | false
 local NISActive = false
 local isReplay = false
 local waitingDialog = false
@@ -932,6 +934,9 @@ local rangePrefs = {
 }
 
 local preNISSettings = {}
+
+--- Called by user sync to set the NIS mode state and do callbacks for the states
+---@param state 'on' | 'off'
 function NISMode(state)
     NISActive = state
     local worldView = import("/lua/ui/game/worldview.lua")
@@ -1032,6 +1037,8 @@ function ShowNISBars()
     end
 end
 
+--- Returns true if the game is in a "Non-Interactive Sequence"
+---@return boolean
 function IsNISMode()
     if NISActive == 'on' then
         return true
@@ -1117,6 +1124,55 @@ function QuickSave(filename)
     end
 end
 
+--- Called by key action to load a special quick save file.
+---@param filename string
+function QuickLoad(filename)
+    if not SessionIsActive()
+        or not SessionIsMultiplayer()
+    then
+        --#region Duplicate code from QuickSave
+        local saveType
+        if import("/lua/ui/campaign/campaignmanager.lua").campaignMode then
+            saveType = "CampaignSave"
+        else
+            saveType = "SaveGame"
+        end
+        local path = GetSpecialFilePath(Prefs.GetCurrentProfile().Name, filename, saveType)
+        --#endregion
+
+        local statusStr = "<LOC saveload_QuickLoad>Loading Quick Save..."
+        local status = UIUtil.ShowInfoDialog(GetFrame(0), statusStr)
+
+        --#region Duplicate of `/lua/ui/dialogs/saveload.lua` `CreateLoadDialog` `DoLoad`
+        SetFrontEndData('NextOpBriefing', nil)
+        local SaveErrors = {
+            WrongVersion = '<LOC uisaveload_0005>Wrong version for savegame "%s"',
+            CantOpen = '<LOC uisaveload_0004>Couldn\'t open savegame "%s"',
+            InvalidFormat = '<LOC uisaveload_0006>"%s" is not a valid savegame',
+            InternalError = '<LOC uisaveload_0007>Internal error loading savegame "%s": %s',
+        }
+        local InternalErrors = {
+            ['eof'] = "<LOC Engine0027>EOF reached during serialization.",
+            ['noread'] = "<LOC Engine0028>Error reading file stream during serialization.",
+            ['nowrite'] = "<LOC Engine0026>Error writing data during serialization. Possibly out of disk space.",
+        }
+
+        local worked, error, detail = LoadSavedGame(path)
+        if not worked then
+            UIUtil.ShowInfoDialog(GetFrame(0),
+                -- note - the 'Unknown error...' string below is intentionally not localized because
+                -- it should never show up.  If it does, add the error string to SaveErrors.
+                LOCF(SaveErrors[error] or ('Unknown error ' .. repr(error) .. 'loading savegame %s: %s'),
+                    Basename(path, true),
+                    InternalErrors[detail] or detail),
+                "<LOC _Ok>")
+        end
+        --#endregion
+
+        status:Destroy()
+    end
+end
+
 defaultZoom = 1.4
 function SimChangeCameraZoom(newMult)
     if SessionIsActive() and