Class TimbnGlobalData<T>

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Holds a plugin's own data that belongs to no save. Core fills Current when the plugin starts and writes it to disk when the game saves, when the player returns to the main menu, when the game quits, when the plugin unloads, and whenever Save() is called. Get one from Saves.RegisterGlobal.

public sealed class TimbnGlobalData<T> : TimbnData<T> where T : class, new()

Type Parameters

T

The plugin's global data type.

Inheritance

object

TimbnData<T>

TimbnGlobalData<T>

Inherited Members

TimbnData<T>.Current

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FilePath

The file the data is kept in, in the game's save folder. Every Timbn plugin shares it.

public string FilePath { get; }

Property Value

string

Methods

Save()

Writes the data to disk now, unless nothing in the file has changed. Core already writes on the events listed on this type, so call this only right after a change that must not be lost to a crash.

public void Save()