Class SaveSpecificSettings

Used for storing save file specific settings.

Inheritance
object
Object
ScriptableObject
SaveSpecificSettings
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Namespace: WeaverCore.Settings
Assembly: WeaverCore.dll
Syntax
public abstract class SaveSpecificSettings : ScriptableObject

Properties

| Edit this page View Source

CurrentSaveSlot

Declaration
public static int CurrentSaveSlot { get; }
Property Value
Type Description
int
| Edit this page View Source

Enabled

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

SaveCurrentlyLoaded

Returns true if a save file is currently loaded

Declaration
public static bool SaveCurrentlyLoaded { get; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

GetSaveSettings(Type)

Finds the save specific settings of the specified type. Returns null if it has not been registered

Declaration
public static SaveSpecificSettings GetSaveSettings(Type type)
Parameters
Type Name Description
Type type
Returns
Type Description
SaveSpecificSettings

The save specific settings data. Returns null if it has not been registered
| Edit this page View Source

GetSaveSettings<T>()

Finds the save specific settings of the specified type. Returns null if it has not been registered

Declaration
public static T GetSaveSettings<T>() where T : SaveSpecificSettings
Returns
Type Description
T

The save specific settings data. Returns null if it has not been registered
Type Parameters
Name Description
T

The save settings type to retrieve
| Edit this page View Source

LoadSaveSlot(int)

Declaration
public static void LoadSaveSlot(int slot)
Parameters
Type Name Description
int slot
| Edit this page View Source

OnSaveLoaded(int)

Called after the save data has been loaded from a file

Declaration
protected virtual void OnSaveLoaded(int saveFileNumber)
Parameters
Type Name Description
int saveFileNumber

The save file number
| Edit this page View Source

OnSaveUnloaded(int)

Called right before the save data has been saved to a file

Declaration
protected virtual void OnSaveUnloaded(int saveFileNumber)
Parameters
Type Name Description
int saveFileNumber

The save file number
| Edit this page View Source

RegisterSaveSpecificSettings(SaveSpecificSettings)

Declaration
public static SaveSpecificSettings RegisterSaveSpecificSettings(SaveSpecificSettings saveSpecificData)
Parameters
Type Name Description
SaveSpecificSettings saveSpecificData
Returns
Type Description
SaveSpecificSettings
| Edit this page View Source

RegisterSaveSpecificSettings<T>()

Declaration
public static T RegisterSaveSpecificSettings<T>() where T : SaveSpecificSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

SaveAllSettings()

Declaration
public static void SaveAllSettings()
| Edit this page View Source

UnregisterSaveSpecificSettings(SaveSpecificSettings)

Declaration
public static void UnregisterSaveSpecificSettings(SaveSpecificSettings saveSpecificData)
Parameters
Type Name Description
SaveSpecificSettings saveSpecificData
| Edit this page View Source

UnregisterSaveSpecificSettings<T>()

Declaration
public static void UnregisterSaveSpecificSettings<T>() where T : SaveSpecificSettings
Type Parameters
Name Description
T

Extension Methods