Class BaseSettingsProvider

Namespace

MCM.Abstractions

Assembly

MCMv5.dll

The interface that is responsible for providing and manipulating settings for the end user - modder

public abstract class BaseSettingsProvider

Inheritance

object

BaseSettingsProvider

Derived

SettingsProviderWrapper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Instance

public static BaseSettingsProvider? Instance { get; }

Property Value

BaseSettingsProvider

SettingsDefinitions

public abstract IEnumerable<SettingsDefinition> SettingsDefinitions { get; }

Property Value

IEnumerable<SettingsDefinition>

Methods

GetPresets(string)

public abstract IEnumerable<ISettingsPreset> GetPresets(string id)

Parameters

id string

Returns

IEnumerable<ISettingsPreset>

GetSettings(string)

public abstract BaseSettings? GetSettings(string id)

Parameters

id string

Returns

BaseSettings

GetUnavailableSettings()

public abstract IEnumerable<UnavailableSetting> GetUnavailableSettings()

Returns

IEnumerable<UnavailableSetting>

LoadAvailableSnapshots(IEnumerable<SettingSnapshot>)

public abstract IEnumerable<BaseSettings> LoadAvailableSnapshots(IEnumerable<SettingSnapshot> snapshots)

Parameters

snapshots IEnumerable<SettingSnapshot>

Returns

IEnumerable<BaseSettings>

OverrideSettings(BaseSettings)

public abstract void OverrideSettings(BaseSettings settings)

Parameters

settings BaseSettings

ResetSettings(BaseSettings)

public abstract void ResetSettings(BaseSettings settings)

Parameters

settings BaseSettings

SaveAvailableSnapshots()

public abstract IEnumerable<SettingSnapshot> SaveAvailableSnapshots()

Returns

IEnumerable<SettingSnapshot>

SaveSettings(BaseSettings)

public abstract void SaveSettings(BaseSettings settings)

Parameters

settings BaseSettings