Browse Source

Updated docs for Save Data Key

master
Christopher 8 years ago
parent
commit
284f408ef5
  1. 2
      Assets/Fungus/Scripts/Components/SaveMenu.cs
  2. 3
      Docs/fungus_docs/save_system.md

2
Assets/Fungus/Scripts/Components/SaveMenu.cs

@ -14,7 +14,7 @@ namespace Fungus
/// </summary> /// </summary>
public class SaveMenu : MonoBehaviour public class SaveMenu : MonoBehaviour
{ {
[Tooltip("String key used when storing save game data in PlayerPrefs.")] [Tooltip("Save Data Key: The string key used to store save game data in Player Prefs. If you have multiple games defined in the same Unity project, use a unique key for each one.")]
[SerializeField] protected string saveDataKey = FungusConstants.DefaultSaveDataKey; [SerializeField] protected string saveDataKey = FungusConstants.DefaultSaveDataKey;
[Tooltip("Automatically load the most recently saved game on startup")] [Tooltip("Automatically load the most recently saved game on startup")]

3
Docs/fungus_docs/save_system.md

@ -75,8 +75,9 @@ The Save Menu is a simple UI which allows players to interact with the %Fungus s
## Save Menu properties ## {#save_menu_properties} ## Save Menu properties ## {#save_menu_properties}
There are 3 main properties that you might want to configure in the Save Menu. There are 4 main properties that you might want to configure in the Save Menu.
- Save Data Key: The string key used to store save game data in Player Prefs. If you have multiple games defined in the same Unity project, use a unique key for each one.
- Load On Start: Automatically load the previously saved game on startup. - Load On Start: Automatically load the previously saved game on startup.
- Auto Save: Automatically save the game to disk at every Save Point. When this option is enabled the Save and Load buttons are disabled. - Auto Save: Automatically save the game to disk at every Save Point. When this option is enabled the Save and Load buttons are disabled.
- Restart Deletes Save: Delete the save data from disk when the player restarts the game. This is useful when testing your game to ensure you’re starting from a blank save state. - Restart Deletes Save: Delete the save data from disk when the player restarts the game. This is useful when testing your game to ensure you’re starting from a blank save state.

Loading…
Cancel
Save