Skip to content

Class FlaxSaveSettings

The FlaxSaveSettings class acts as the central configuration hub for the save system. It manages everything from file paths and extensions, save data versioning, to the timing logic of the auto-save feature.

FlaxSaveSettings is used for the Save Settings asset and configured in-editor.

Properties

Assets

A list of registered ISavable assets. These are automatically serialized during RequestAssetSave and reloaded, when FlaxSave is initialized.

  • Type: List<JsonAssetReference<ISavableAsset>>
  • Access: get

Editor protection

To prevent data loss, this list is not automatically loaded in editor (unless specified otherwise). Loading assets overwrites the asset state in your project. See SkipLoadingSettingsInEditor

Tip

This list can be configured in-editor with the Settings asset


AutoSaveIntervalMinutes

The auto-save interval, converted to minutes

  • Type: int
  • Access: get
  • Note: The auto save interval can be configured in-editor with the the Settings asset


AutoSaveIntervalSeconds

The auto-save interval, converted to seconds

  • Type: int
  • Access: get
  • Note: The auto save interval can be configured in-editor with the the Settings asset


AutoSaveIntervalMilliseconds

The auto-save interval, converted to milliseconds

  • Type: int
  • Access: get
  • Note: The auto save interval can be configured in-editor with the the Settings asset


AutoSave

Enables or disables the auto-save feature.

  • Type: bool
  • Access: get
  • Note: The auto save interval can be configured in-editor with the the Settings asset

Info

The auto-save feature can be switched on and off during runtime via SetAutoSaveActive


SkipLoadingSettingsInEditor

Enables or disable automatic asset loading during system initilization in-editor. The runtime is not affected by this setting and assets are always loaded in-game.

  • Type: bool
  • Access: get
  • Note: Auto asset loading can be configured in-editor with the the Settings asset

Editor data loss risk

If set to false, the system will override your projects assets with data from the save folder. In the editor, this permanently modifies project assets. Proceed with caution.


SavegameVersion

The current version of your projects data scheme

  • Type: bool
  • Access: get

Versioning Strategy

It's best pratice to increment this version whenever you make breaking changes to your player data or ISavableAsset structures. This allows you to write checks and warn players about potential changes via UI notifications.


SavegameDirectory

Gets the absolute path of the save directory on disk


SavegameMetaFile

Gets the absolute path of the specific file containing the SaveMeta collection

  • Type: string
  • Access: get


SettingsFile

Gets the absolute path of the file, where global ISavable data is stored

  • Type: string
  • Access: get


SavegameFileExtension

The valid file extension used for save files, i.e .save or .data

  • Type: string
  • Access: get
  • Note: The save file extension can be configured in-editor with the the Settings asset


Methods

GetSaveFilePath

This method constructs the full and valid path to a specific save file

Parameter Type Description
savegameName string The name of the save file, usualy found in a SaveMeta.SaveName

|Returns||Description| |---|---| |string|The full and valid path to a specifc save file|

How it works: This is a convinience method, that combines the savegame path with a save file name and returns a vaild path to that file.


OpenDirectory

Opens the OS file explorer at the savegame directory location

Parameter Type Description
(none)

How it works: This method opens a new system explorer window at the savegame directory.

Tip

You don't need to call this code during development, the save directory can simply be opened via the Settings asset Open Directory button