• Manual
  • API Documentation
  • Storage
  • Meta Data

    Show / Hide Table of Contents
    • Introduction
    • Installation
    • Getting Started
    • Demos
    • The Save System API
    • Auto Save
    • Platforms
    • Security
    • Serialization
    • Supported Data Types
    • Migration
    • FAQ
    • Changelog
    • Extend
      • Overview
      • Converter
      • Encryption
      • Storage
    • Guides
      • Overview
      • Configuring Settings
      • Using Auto Save
      • Basic Saving and Loading
      • Saving and Loading Raw Data
      • Deleting the Data
      • Saving and Loading Images
      • Saving and Loading Scene Objects
      • Saving and Loading Assets
      • Saving and Loading Readonly Properties
    • Integrations
      • Overview
      • Google Play Games
      • Xbox Live
      • Bolt
      • Firebase
      • PlayFab
      • PlayMaker
      • Steam Auto-Cloud
      • Steamworks .NET
      • Facepunch Steamworks
      • Text Mesh Pro
    • Storage
      • Overview
      • Backup
      • Catalog
      • Meta Data
      • Built-in Storages
        • File
        • PlayerPrefs
        • Memory
      • Third-party Storages
        • Firebase
          • Realtime Database
          • Cloud Storage
          • Firestore
        • PlayFab
          • Entity Objects
          • Entity Files
          • User Data
        • Steam
          • Steamworks .NET
          • Facepunch Steamworks
        • Google Play
          • Saved Game
        • Xbox Live
          • Connected Storage

    Meta Data

    The meta data API allows you to store additional information with storage items, this allows for extra functionalities such as holding a list of backups, last modification time, last access time, whether the file is encrypted or no, ...

    Loading the Meta Data

    You can load the meta data using IStorage.LoadMetaData or SaveSystemAPI.LoadMetaDataAsync method:

    StorageMetaData metaData = await SaveSystemAPI.LoadMetaDataAsync("my-identifier");
    

    Modifying the Meta Data

    StorageMetaData metaData = await SaveSystemAPI.LoadMetaDataAsync("my-identifier");
    
    // Add a new custom meta data
    metaData["Corrupted"] = true;
    
    // Or modify existing meta data
    metaData["Encrypted"] = false;
    
    // Save the modified meta data
    await SaveSystemAPI.SaveMetaDataAsync("my-identifier", metaData);
    

    Disabling the Meta Data

    You can disable the meta data feature by disabling the Use Meta Data in a Settings preset:

    Default Settings

    Default Settings Window

    Or using the Settings window or by setting the UseMetaData property of SaveSystemSettings class:

    SaveSystemSettings settings = SaveSystemSettings.DefaultSettings.Clone();
    settings.UseMetaData = false;
    

    Or disable it from default settings:

    SaveSystemSettings settings = SaveSystemSettings.DefaultSettings;
    settings.UseMetaData = false;
    
    • Improve this Doc
    • 0 Comments
    In This Article
    • Loading the Meta Data
    • Modifying the Meta Data
    • Disabling the Meta Data