Class SaveDataCache

Namespace

Nautilus.Json

Assembly

Nautilus.dll

An abstract implementation of IJsonFile intended for use with caching per-save data.

public abstract class SaveDataCache : JsonFile, IJsonFile

Inheritance

object

JsonFile

SaveDataCache

Implements

IJsonFile

Inherited Members

JsonFile.AlwaysIncludedJsonConverters

JsonFile.OnStartedLoading

JsonFile.OnFinishedLoading

JsonFile.OnStartedSaving

JsonFile.OnFinishedSaving

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

JsonExtensions.LoadJsonAsync<T>(T, string, bool, params JsonConverter[])

JsonExtensions.LoadJson<T>(T, string, bool, params JsonConverter[])

JsonExtensions.SaveJsonAsync<T>(T, string, params JsonConverter[])

JsonExtensions.SaveJson<T>(T, string, params JsonConverter[])

ReflectionHelper.CopyFields<T>(T, T, BindingFlags)

ReflectionHelper.GetInstanceField<T>(T, string, BindingFlags)

ReflectionHelper.GetInstanceMethod<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticField<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticMethod<T>(T, string, BindingFlags)

ReflectionHelper.SetInstanceField<T>(T, string, object, BindingFlags)

ReflectionHelper.SetStaticField<T>(T, string, object, BindingFlags)

Constructors

SaveDataCache()

Creates a new instance of SaveDataCache, parsing the file name from FileNameAttribute if declared, or with default values otherwise.

public SaveDataCache()

Properties

JsonFilePath

The file path at which the JSON file is accessible for reading and writing.

public override string JsonFilePath { get; }

Property Value

string

Methods

Load(bool)

Loads the JSON properties from the file on disk into the SaveDataCache.
If you are overriding this in a subclass, be aware that SaveDataHandler. RegisterSaveDataCache<T>() calls the async load function LoadAsync(bool)!

public override void Load(bool createFileIfNotExist = true)

Parameters

createFileIfNotExist bool

Whether a new JSON file should be created with default values if it does not already exist.

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

LoadAsync(bool)

Save()

LoadWithConverters(bool, params JsonConverter[])

LoadAsync(bool)

Loads the JSON properties from the file on disk into the SaveDataCache.

public override Task LoadAsync(bool createFileIfNotExist = true)

Parameters

createFileIfNotExist bool

Whether a new JSON file should be created with default values if it does not already exist.

Returns

Task

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

Load(bool)

SaveAsync()

LoadWithConverters(bool, params JsonConverter[])

LoadWithConverters(bool, params JsonConverter[])

Loads the JSON properties from the file on disk into the SaveDataCache.

public override void LoadWithConverters(bool createFileIfNotExist = true, params JsonConverter[] jsonConverters)

Parameters

createFileIfNotExist bool

Whether a new JSON file should be created with default values if it does not already exist.

jsonConverters JsonConverter[]

Optional Newtonsoft.Json.JsonConverters to be used for serialization. The AlwaysIncludedJsonConverters will always be used, regardless of whether you pass them.

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

SaveWithConverters(params JsonConverter[])

Load(bool)

LoadWithConvertersAsync(bool, params JsonConverter[])

Loads the JSON properties from the file on disk into the SaveDataCache.

public override Task LoadWithConvertersAsync(bool createFileIfNotExist = true, params JsonConverter[] jsonConverters)

Parameters

createFileIfNotExist bool

Whether a new JSON file should be created with default values if it does not already exist.

jsonConverters JsonConverter[]

Optional Newtonsoft.Json.JsonConverters to be used for serialization. The AlwaysIncludedJsonConverters will always be used, regardless of whether you pass them.

Returns

Task

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

SaveWithConvertersAsync(params JsonConverter[])

Load(bool)

Save()

Saves the current fields and properties of the SaveDataCache as JSON properties to the file on disk.
If you are overriding this in a subclass, be aware that SaveDataHandler. RegisterSaveDataCache<T>() calls the async saving function SaveAsync()!

public override void Save()

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

Load(bool)

SaveAsync()

SaveWithConverters(params JsonConverter[])

SaveAsync()

Saves the current fields and properties of the SaveDataCache as JSON properties to the file on disk.

public override Task SaveAsync()

Returns

Task

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

LoadAsync(bool)

Save()

SaveWithConverters(params JsonConverter[])

SaveWithConverters(params JsonConverter[])

Saves the current fields and properties of the SaveDataCache as JSON properties to the file on disk.

public override void SaveWithConverters(params JsonConverter[] jsonConverters)

Parameters

jsonConverters JsonConverter[]

Optional Newtonsoft.Json.JsonConverters to be used for deserialization. The AlwaysIncludedJsonConverters will always be used, regardless of whether you pass them.

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

LoadWithConverters(bool, params JsonConverter[])

Save()

SaveWithConvertersAsync(params JsonConverter[])

Saves the current fields and properties of the SaveDataCache as JSON properties to the file on disk.

public override Task SaveWithConvertersAsync(params JsonConverter[] jsonConverters)

Parameters

jsonConverters JsonConverter[]

Optional Newtonsoft.Json.JsonConverters to be used for deserialization. The AlwaysIncludedJsonConverters will always be used, regardless of whether you pass them.

Returns

Task

Exceptions

InvalidOperationException

Thrown when the player is not in-game.

See Also

LoadWithConvertersAsync(bool, params JsonConverter[])

Save()