Saving & Loading

How to save & load Inventool data.

Inventool doesn't have an internal method of saving data, as it's not a save system. However, it does provide a way for save systems to use save and load Inventool's data. Any save system that uses JSON or binary serialization should be able to save Inventool's data.

Saving

There are 4 things of Inventool that require saving: items, enchantments (applied to items), equipment, and currencies. You can use Inventool.CreateSavableData to get an object that contains all of this data. This method will return a InventoolSavableData struct.

InventoolSavableData mySavableData = Inventool.CreateSavableData();

Loading

Use Inventool.SetData and provide a InventoolSavableData object as the parameter to load data. This will set the inventory items, equipment, and currencies.

When setting data, no events are invoked. So, for equipment, it may be necessary for you to manually check which items the player has equipped (and enable/disable any necessary GameObjects based on that).

Inventool.SetData(mySavableData);

Example (ESave)

The code below is how you can save Inventool's data with ESave. ESave is my own save system—it's entirely free and it's been tested with Inventool. ESave is not a requirement, you can use the save system of your choice. However, the example below will only work with ESave.

using Esper.ESave;
using Esper.Inventool;
using Esper.Inventool.DataManagement;
using UnityEngine;

public class InventoolSavingExample : MonoBehaviour
{
    private const string dataID = "Inventool";

    private SaveFile saveFile;

    private void Start()
    {
        saveFile = GetComponent<SaveFileSetup>().saveFile;

        // Load the data on start
        Load();
    }

    private void OnApplicationQuit()
    {
        // Save when exited play mode or the game
        Save();
    }

    /// <summary>
    /// Saves Inventool data.
    /// </summary>
    private void Save()
    {
        var savableData = Inventool.CreateSavableData();
        saveFile.AddOrUpdateData(dataID, savableData);
        saveFile.Save();
    }

    /// <summary>
    /// Loads Inventool data if it exists.
    /// </summary>
    private void Load()
    {
        if (saveFile.HasData(dataID))
        {
            var savableData = saveFile.GetData<InventoolSavableData>(dataID);
            Inventool.SetData(savableData);
        }
    }
}