Class SettingsWrapper

Namespace

MCM.Abstractions.Base.Global

Assembly

MCMv5.dll

public abstract class SettingsWrapper : BaseSettings, INotifyPropertyChanged, IWrapper

Inheritance

object

BaseSettings

SettingsWrapper

Implements

INotifyPropertyChanged

IWrapper

Inherited Members

BaseSettings.SaveTriggered

BaseSettings.LoadingComplete

BaseSettings.DefaultPresetId

BaseSettings.DefaultPresetName

BaseSettings.DiscoveryType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

BaseSettingsExtensions.GetAllSettingPropertyDefinitions(BaseSettings)

BaseSettingsExtensions.GetAllSettingPropertyGroupDefinitions(BaseSettings)

BaseSettingsExtensions.GetExternalPresets(BaseSettings)

BaseSettingsExtensions.GetSettingPropertyGroups(BaseSettings)

BaseSettingsExtensions.GetUnsortedSettingPropertyGroups(BaseSettings)

Constructors

SettingsWrapper(object?)

protected SettingsWrapper(object? @object)

Parameters

object object

Properties

DisplayName

The display name of the setting in the settings menu.

public override string DisplayName { get; }

Property Value

string

FolderName

public override string FolderName { get; }

Property Value

string

FormatType

public override string FormatType { get; }

Property Value

string

Id

Unique identifier used to save to file. Make sure this is unique to your mod.

public override string Id { get; }

Property Value

string

Object

public object? Object { get; }

Property Value

object

SubFolder

If you want this settings file stored inside a subfolder, set this to the name of the subfolder.

public override string SubFolder { get; }

Property Value

string

SubGroupDelimiter

public override char SubGroupDelimiter { get; }

Property Value

char

UIVersion

public override int UIVersion { get; }

Property Value

int

Methods

CopyAsNew()

public override BaseSettings CopyAsNew()

Returns

BaseSettings

Create(object?)

protected abstract BaseSettings Create(object? @object)

Parameters

object object

Returns

BaseSettings

CreateNew()

public override BaseSettings CreateNew()

Returns

BaseSettings

CreatePreset(object?)

protected abstract ISettingsPreset CreatePreset(object? @object)

Parameters

object object

Returns

ISettingsPreset

GetBuiltInPresets()

public override IEnumerable<ISettingsPreset> GetBuiltInPresets()

Returns

IEnumerable<ISettingsPreset>

OnPropertyChanged(string?)

public override void OnPropertyChanged(string? propertyName = null)

Parameters

propertyName string

Events

PropertyChanged

public override event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler