• Manual
  • API Documentation
  • Storage
  • Catalog

    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

    Catalog

    The catalog holds a list of saved storage items identifier, this allows you to know what identifiers you've used, how many items you've saved and lets you to iterate through them.

    Loading the Catalog

    You can load the catalog using IStorage.LoadCatalog or SaveSystemAPI.LoadCatalogAsync method:

    List<string> catalog = await SaveSystemAPI.LoadCatalogAsync();
    

    Modifying the Catalog

    List<string> catalog = await SaveSystemAPI.LoadCatalogAsync();
    catalog.Remove("my-identifier");
    
    // Save the modified catalog
    await SaveSystemAPI.SaveCatalogAsync(catalog);
    

    Disabling the Catalog

    You can disable the catalog feature by disabling the Use Catalog in a Settings preset:

    Default Settings

    Default Settings Window

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

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

    Or disable it from default settings:

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