Added Presets documentation, reorganized quick-start section

PipeRift · Oct 27, 2020 · 17e1a31 · 17e1a31
1 parent 24e240d
commit 17e1a31
Show file tree

Hide file tree

Showing 17 changed files with 52 additions and 11 deletions.
diff --git a/Docs/SUMMARY.md b/Docs/SUMMARY.md
@@ -1,9 +1,12 @@
 # Save Extension Documentation
 
-* [1 Installation](installation.md)
-* [2 Quick Start](quick-start.md)
-- 3 Documentation
-  * [Asynchronous](docs/asynchronous.md)
+* Quick Start
+  * [Installation](quick-start/installation.md)
+  * [First Steps](quick-start/first-steps.md)
+  * [Presets](quick-start/presets.md)
+  * [Filters](quick-start/filters.md)
+- Documentation
+  * [Multi-threading](docs/multi-threading.md)
   * [Configuration](docs/configuration.md)
   * [Level Streaming](docs/level-streaming.md)
   * [Saving And Loading](docs/saving-and-loading.md)

diff --git a/Docs/docs/asynchronous.md → Docs/docs/multi-threading.md b/Docs/docs/asynchronous.md → Docs/docs/multi-threading.md
diff --git a/Docs/img/levelscript_load_save.png b/Docs/img/levelscript_load_save.png
diff --git a/Docs/quick-start/filters.md b/Docs/quick-start/filters.md
diff --git a/Docs/quick-start.md → Docs/quick-start/first-steps.md b/Docs/quick-start.md → Docs/quick-start/first-steps.md
@@ -1,6 +1,6 @@
-# Quick Start
+# First Steps
 
-Quick Start will show the basic steps to follow to setup the plugin and start using it at a base level.
+First Steps will show the basic steps to follow to setup the plugin and start using it at a base level.
 
 ## Setting Up the Project
 
@@ -10,7 +10,7 @@ If everything went right, we should see the plugin enabled under *Edit->Plugins-
 
 ![Plugin Enabled](img/plugin_enabled.png)
 
-## Using the Plugin
+## Save and Load from Keys
 
 Save Extension requires minimum setup. The only thing you have to do is to call Saving and Loading. Therefore **as an example** we will make a level-blueprint **save** when we press **R** and **load** with **T**.
 
@@ -28,13 +28,25 @@ Then we add the following functions:
 
 **Load Slot from Id** will load world from slot 0
 
-### Something to save
+## Selecting Actors and Components to save
 
-Player's rotation and location will always be saved (unless you disable it from [Configuration](docs/configuration.md)) but we can also add to the scene some actors to be saved. They could save variables, physics, positions, etc.
+**SaveExtension** doesn't save any actor class or component **by default**.
 
-### Saving a variable
+*I  know. It is confusing that a save system by default doesn't save, but it will make sense by the end of this page, I promise.*
 
-To save any variable inside an Actor or Component we can just tick "*SaveGame*" on its properties:
+To be able to save, we will need to:
+
+1. Create a [**SavePreset**](presets.md) blueprint (that inherits ***USavePreset***)
+2. Add actor and component classes relevant to be saved in the game to preset filters
+   ![Filters](img/example-filters.png)
+3. Assign the preset inside Project Settings
+   ![Assign Preset](img/default-preset.png)
+
+{% hint style='hint' %} For detailed info see [**Save Presets**](presets.md) and [**Filters**](filters.md) {% endhint %}
+
+## Marking variables to be saved
+
+To save any variable inside an Actor or Component we can just tick "*SaveGame*" on its properties (*however remember that his actor or component class must on the filter*)
 
 ![A simple Variable](img/variable.png)
 

diff --git a/Docs/quick-start/img/content_browser_preset.png b/Docs/quick-start/img/content_browser_preset.png
diff --git a/Docs/quick-start/img/default-preset.png b/Docs/quick-start/img/default-preset.png
diff --git a/Docs/quick-start/img/example-filters.png b/Docs/quick-start/img/example-filters.png
diff --git a/Docs/quick-start/img/levelscript_load_save.png b/Docs/quick-start/img/levelscript_load_save.png
diff --git a/Docs/img/open_levelscript.png → Docs/quick-start/img/open_levelscript.png b/Docs/img/open_levelscript.png → Docs/quick-start/img/open_levelscript.png
diff --git a/Docs/img/plugin_enabled.png → Docs/quick-start/img/plugin_enabled.png b/Docs/img/plugin_enabled.png → Docs/quick-start/img/plugin_enabled.png
diff --git a/Docs/quick-start/img/set-preset-bp.png b/Docs/quick-start/img/set-preset-bp.png
diff --git a/Docs/img/variable.png → Docs/quick-start/img/variable.png b/Docs/img/variable.png → Docs/quick-start/img/variable.png
diff --git a/Docs/img/variable_properties.png → Docs/quick-start/img/variable_properties.png b/Docs/img/variable_properties.png → Docs/quick-start/img/variable_properties.png
diff --git a/Docs/img/variable_properties_savegame.png → ...tart/img/variable_properties_savegame.png b/Docs/img/variable_properties_savegame.png → ...tart/img/variable_properties_savegame.png
diff --git a/Docs/installation.md → Docs/quick-start/installation.md b/Docs/installation.md → Docs/quick-start/installation.md
diff --git a/Docs/quick-start/presets.md b/Docs/quick-start/presets.md
@@ -0,0 +1,26 @@
+# Presets
+
+A preset is a blueprint that allows the system to know the specifics about how to save the game. It contains all possible options and customizations the system can use.
+That includes when, how and what to save, asset names, multithreading, custom logic,  etc.
+
+
+
+## Create a preset
+
+From the content browser, we can create a normal blueprint inheriting **USavePreset**, or just click *Save Extension -> Save Preset*
+
+![Create Preset](img/content_browser_preset.png)
+
+## Setting the active preset
+
+To set the preset that the system will use when starting up, go to *Project Settings -> Game -> Save Extension*
+
+![image-20201027234636490](img/default-preset.png)
+
+Then we assign our preset class we want to use in **Preset**.
+
+### In Blueprints
+
+The preset can also be changed from blueprints in runtime calling:
+
+![Set Active Preset](img/set-preset-bp.png)