⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    SaveGameManager ScriptableObject

    Overview

    The SaveGameManager asset is the central access point for the save games system. It specifies the various save game settings as well as registering objects for instantiation at runtime.

    Inspector

    SaveGameManager

    Properties

    Miscellaneous

    Name Type Description
    Enable Save System Boolean Should this project support save games.
    Current Version Integer The current version index for your save games. Allows you to block loading save games from a version which is too early.
    Minimum Version Integer The minimum version index that can be loaded. You can raise this and the current version if you add features that might conflict with earlier save games.

    Location

    Name Type Description
    Save Path Dropdown The available save file locations.
    Sub-Folder String A sub-folder within the save path folder to place save files in. This property will not appear if "Save Path" is set to Custom.
    Custom String The custom path (from the build folder) for the save games to be saved. This property will only appear if "Save Path" is set to Custom.

    You can use the Explore To Folder button to open the save games folder in the OS file explorer.

    You can also use the Save Game Inspector button to show the save game inspector (also availabe via Tools/NeoFPS/Save Game Inspector). This allows you to open a save file and browse its contents. For more information see Troubleshooting

    Quick-Save

    Name Type Description
    Can Quick Save Boolean Sets whether the quick-save system is enabled in this project.
    Quick Load All Boolean If true, quick loading will load the latest quick/auto/manual save. If not then it will only load the latest quick-save.
    Num Quicksaves Integer The number of quicksaves to maintain. If the number exceeds this value, the oldest saves will be deleted.

    Auto-Save

    Name Type Description
    Num Autosaves Integer The number of autosaves to maintain. If the number exceeds this value, the oldest saves will be deleted.

    Manual Save

    Name Type Description
    Can Manual Save Boolean Sets whether the manual system is enabled in this project.

    Continue

    Name Type Description
    Continue From Dropdown What type of saves the game can be continued from. Available options are None, All and Auto Save Only.

    Thumbnails

    Name Type Description
    Quicksave Thumbnail Dropdown Where to get the thumbnail texture for quick-saves. Options are None, Texture, TextureFromScene, Screenshot.
    (Fallback) Texture Texture2D If the thumbnail type is set to Texture then this is the texture that will be serialized to save files. If the thumbnail type is set to Texture From Scene or Screenshot then this texture will be used in the event those methods fail.
    Autosave Thumbnail Dropdown Where to get the thumbnail texture for auto-saves. Options are None, Texture, TextureFromScene, Screenshot. The Texture / Fallback Texture property will appear below this if required.
    Manual Save Thumbnail Dropdown Where to get the thumbnail texture for manual saves. Options are None, Texture, TextureFromScene, Screenshot. The Texture / Fallback Texture property will appear below this if required.
    Screenshot Size Vector2Int If any of the thumbnail types are set to Screenshot then this property defines the resulting size of the saved screenshot texture.
    Screenshot Compression Boolean This property defines whether the resulting texture will be compressed before serialization.
    Using Linear Rendering Boolean Set this property to true if the project is set to use linear color space rendering. Screenshots need adapting to the correct color space or they can appear washed out.

    Recreatable Items

    This section in the inspector is used to register objects with the save system so that they can be instantiated at runtime. This is only required for objects which need to be instantiated for this scene only. For more information see Runtime Objects.


    See Also

    Serializing Data

    Troubleshooting

    Back to top Copyright © 2019 Yondernauts Game Studios Ltd
    Generated with DocFX