Script API: implement OPT_SAVECOMPONENTSIGNORE, skipping save parts

Author: ivan-mogilko

Common/ac/gamesetupstructbase.h

@@ -212,6 +212,14 @@ struct GameSetupStructBase
         }};
     }
 
+    // Returns a list of game options that must be preserved when restoring a save
+    inline static std::array<int, 1> GetPreservedOptions()
+    {
+        return std::array<int, 1> {{
+            OPT_SAVECOMPONENTSIGNORE
+        }};
+    }
+
 private:
     void SetDefaultResolution(GameResolutionType type, Size game_res);
     void SetNativeResolution(GameResolutionType type, Size game_res);

Common/ac/gamestructdefines.h

@@ -86,7 +86,8 @@
 #define OPT_SCALECHAROFFSETS 52 // apply character scaling to the sprite offsets (z, locked offs)
 #define OPT_SAVESCREENSHOTLAYER 53 // which render layers to include into savegame screenshot
 #define OPT_VOICECLIPNAMERULE 54 // which rule to use for a voice clip name based on character's name (old/new)
-#define OPT_HIGHESTOPTION   OPT_VOICECLIPNAMERULE
+#define OPT_SAVECOMPONENTSIGNORE 55 // ignore these savegame components (flag mask)
+#define OPT_HIGHESTOPTION   OPT_SAVECOMPONENTSIGNORE
 #define OPT_NOMODMUSIC      98 // [DEPRECATED]
 #define OPT_LIPSYNCTEXT     99
 

Editor/AGS.Editor/Resources/agsdefns.sh

@@ -94,6 +94,7 @@
 #define OPT_SCALECHAROFFSETS  52
 #define OPT_SAVEGAMESCREENSHOTLAYER 53
 #define OPT_VOICECLIPNAMERULE 54
+#define OPT_SAVECOMPONENTSIGNORE 55
 #define OPT_LIPSYNCTEXT       99
 
 #define COLOR_TRANSPARENT -1
@@ -3290,6 +3291,18 @@ builtin struct Screen {
 };
 #endif
 
+enum SaveComponentSelection
+{
+    eSaveCmp_None           = 0,
+    eSaveCmp_Audio          = 0x00000002,
+    eSaveCmp_Dialogs        = 0x00000008,
+    eSaveCmp_GUI            = 0x00000010,
+    eSaveCmp_Cursors        = 0x00000040,
+    eSaveCmp_Views          = 0x00000080,
+    eSaveCmp_DynamicSprites = 0x00000100,
+    eSaveCmp_Plugins        = 0x00002000
+};
+
 
 
 import readonly Character *player;

Engine/ac/game.cpp

@@ -961,7 +961,7 @@ void save_game(int slotn, const String &descript, std::unique_ptr<Bitmap> &&imag
     }
 
     // Save dynamic game data
-    SaveGameState(out.get());
+    SaveGameState(out.get(), (SaveCmpSelection)(kSaveCmp_All & ~(game.options[OPT_SAVECOMPONENTSIGNORE] & kSaveCmp_ScriptIgnoreMask)));
     // call "After Save" event callback
     run_on_event(kScriptEvent_GameSaved, RuntimeScriptValue().SetInt32(slotn));
 }
@@ -1071,7 +1071,8 @@ HSaveError load_game(const String &path, int slotNumber, bool &data_overwritten)
     }
 
     // do the actual restore
-    err = RestoreGameState(src.InputStream.get(), src.Version);
+    err = RestoreGameState(src.InputStream.get(), src.Version,
+        (SaveCmpSelection)(kSaveCmp_All & ~(game.options[OPT_SAVECOMPONENTSIGNORE] & kSaveCmp_ScriptIgnoreMask)));
     data_overwritten = true;
     if (!err)
         return err;

Engine/game/savegame.cpp

@@ -422,6 +422,9 @@ static void CopyPreservedGameOptions(GameSetupStructBase &gs, const PreservedPar
     const auto restricted_opts = GameSetupStructBase::GetRestrictedOptions();
     for (auto opt : restricted_opts)
         gs.options[opt] = pp.GameOptions[opt];
+    const auto preserved_opts = GameSetupStructBase::GetPreservedOptions();
+    for (auto opt : preserved_opts)
+        gs.options[opt] = pp.GameOptions[opt];
 }
 
 // Final processing after successfully restoring from save
@@ -680,12 +683,12 @@ HSaveError DoAfterRestore(const PreservedParams &pp, RestoredData &r_data)
     return HSaveError::None();
 }
 
-HSaveError RestoreGameState(Stream *in, SavegameVersion svg_version)
+HSaveError RestoreGameState(Stream *in, SavegameVersion svg_version, SaveCmpSelection select_cmp)
 {
     PreservedParams pp;
     RestoredData r_data;
     DoBeforeRestore(pp);
-    HSaveError err = SavegameComponents::ReadAll(in, svg_version, SavegameComponents::kSaveCmp_All, pp, r_data);
+    HSaveError err = SavegameComponents::ReadAll(in, svg_version, select_cmp, pp, r_data);
     if (!err)
         return err;
     return DoAfterRestore(pp, r_data);
@@ -762,10 +765,10 @@ void DoBeforeSave()
     }
 }
 
-void SaveGameState(Stream *out)
+void SaveGameState(Stream *out, SaveCmpSelection select_cmp)
 {
     DoBeforeSave();
-    SavegameComponents::WriteAllCommon(out, SavegameComponents::kSaveCmp_All);
+    SavegameComponents::WriteAllCommon(out, select_cmp);
 }
 
 void ReadPluginSaveData(Stream *in, PluginSvgVersion svg_ver, soff_t max_size)

Engine/game/savegame.h

@@ -153,18 +153,49 @@ struct SavegameDescription
     SavegameDescription();
 };
 
+// SaveCmpSelection flags tell which save components to restore, and which to skip
+enum SaveCmpSelection
+{
+    kSaveCmp_None           = 0,
+    kSaveCmp_GameState      = 0x00000001,
+    kSaveCmp_Audio          = 0x00000002,
+    kSaveCmp_Characters     = 0x00000004,
+    kSaveCmp_Dialogs        = 0x00000008,
+    kSaveCmp_GUI            = 0x00000010,
+    kSaveCmp_InvItems       = 0x00000020,
+    kSaveCmp_Cursors        = 0x00000040,
+    kSaveCmp_Views          = 0x00000080,
+    kSaveCmp_DynamicSprites = 0x00000100,
+    kSaveCmp_Overlays       = 0x00000200,
+    kSaveCmp_Scripts        = 0x00000400,
+    kSaveCmp_Rooms          = 0x00000800,
+    kSaveCmp_ThisRoom       = 0x00001000,
+    kSaveCmp_Plugins        = 0x00002000,
+    kSaveCmp_All            = 0xFFFFFFFF,
+
+    // Components, allowed to be ignored by script's request
+    kSaveCmp_ScriptIgnoreMask =
+          kSaveCmp_Audio
+        | kSaveCmp_Dialogs
+        | kSaveCmp_GUI
+        | kSaveCmp_Cursors
+        | kSaveCmp_Views
+        | kSaveCmp_DynamicSprites
+        | kSaveCmp_Plugins
+};
+
 
 // Opens savegame for reading; optionally reads description, if any is provided
 HSaveError     OpenSavegame(const String &filename, SavegameSource &src,
                             SavegameDescription &desc, SavegameDescElem elems = kSvgDesc_All);
 // Opens savegame and reads the savegame description
 HSaveError     OpenSavegame(const String &filename, SavegameDescription &desc, SavegameDescElem elems = kSvgDesc_All);
 // Reads the game data from the save stream and reinitializes game state
-HSaveError     RestoreGameState(Stream *in, SavegameVersion svg_version);
+HSaveError     RestoreGameState(Stream *in, SavegameVersion svg_version, SaveCmpSelection select_cmp);
 // Opens savegame for writing and puts in savegame description
 std::unique_ptr<Stream> StartSavegame(const String &filename, const String &user_text, const Bitmap *user_image);
 // Prepares game for saving state and writes game data into the save stream
-void           SaveGameState(Stream *out);
+void           SaveGameState(Stream *out, SaveCmpSelection select_cmp);
 
 } // namespace Engine
 } // namespace AGS

Engine/game/savegame_components.cpp

@@ -1337,7 +1337,7 @@ ComponentHandler ComponentHandlers[] =
         "Dynamic Surfaces",
         0,
         0,
-        kSaveCmp_DynamicSurfaces,
+        kSaveCmp_DynamicSprites, // share flag with "Dynamic Sprites"
         WriteDynamicSurfaces,
         ReadDynamicSurfaces
     },

Engine/game/savegame_components.h

@@ -33,29 +33,6 @@ struct RestoredData;
 
 namespace SavegameComponents
 {
-    // SaveCmpSelection flags tell which save components to restore, and which to skip
-    enum SaveCmpSelection
-    {
-        kSaveCmp_None           = 0,
-        kSaveCmp_GameState      = 0x00000001,
-        kSaveCmp_Audio          = 0x00000002,
-        kSaveCmp_Characters     = 0x00000004,
-        kSaveCmp_Dialogs        = 0x00000008,
-        kSaveCmp_GUI            = 0x00000010,
-        kSaveCmp_InvItems       = 0x00000020,
-        kSaveCmp_Cursors        = 0x00000040,
-        kSaveCmp_Views          = 0x00000080,
-        kSaveCmp_DynamicSprites = 0x00000100,
-        kSaveCmp_Overlays       = 0x00000200,
-        kSaveCmp_DynamicSurfaces= 0x00000400,
-        kSaveCmp_Scripts        = 0x00000800,
-        kSaveCmp_Rooms          = 0x00001000,
-        kSaveCmp_ThisRoom       = 0x00002000,
-        kSaveCmp_Plugins        = 0x00004000,
-        kSaveCmp_All            = 0xFFFFFFFF
-    };
-
-
     // Reads all available components from the stream
     HSaveError    ReadAll(Stream *in, SavegameVersion svg_version, SaveCmpSelection select_cmp,
         const PreservedParams &pp, RestoredData &r_data);