Persistence

The IDataStore service provides a way of saving and loading persistent data.
The default data store uses yaml files for serialization.

Reading and writing data

Assume you want to save and load the following class:

[Serializable]
public class PlayersData
{
   public List<string> OwnerNames { get; set; }
}

public class MyPlugin : OpenModUniversalPlugin
{
    // Defines the key for the data. The default data store uses the key as the file name for the yaml file.
    // In this case, the file will be named owners.data.yaml
    public const string OwnersKey = "owners";
    private readonly IDataStore m_DataStore;
    
    public MyPlugin(IDataStore dataStore, IServiceProvider serviceProvider) : base(serviceProvider)
    {
        m_DataStore = dataStore;
    }

    public async Task OnLoadAsync()
    {
        // first check if the data exists and create it if it does not exist
        if(!await m_DataStore.ExistsAsync(OwnersKey))
        {
            await SeedData();
        }

        var data = await m_DataStore.LoadAsync<PlayersData>(OwnersKey);        
        // do something with data
        await m_DataStore.SaveAsync<PlayersData>(OwnersKey, data);
    }

    private async Task SeedData()
    {
        // create default data
        await m_DataStore.SaveAsync(OwnersKey, new PlayersData
        {
            OwnerNames = new List<string> { "Trojaner" }
        });
    } 
}

Change watchers

You can use change watchers to automatically reload data when data for a key has changed (e.g. if a user has edited the file manually):

var fileChangeWatcher = m_DataStore.AddChangeWatcher(OwnersKey, this, OnOwnersChanged);

public void OnOwnersChanged()
{
    // Do something, e.g. read data with LoadAsync again.
}

You can use fileChangeWatcher.Dispose() to stop listening.

Note

Calls to IDataStore.SaveAsync will not trigger change watchers.