Class BaseSettings

Namespace

MCM.Abstractions.Base

Assembly

MCMv5.dll

Base model for MCM settings

public abstract class BaseSettings : INotifyPropertyChanged

Inheritance

object

BaseSettings

Implements

INotifyPropertyChanged

Derived

GlobalSettings

SettingsWrapper

PerCampaignSettings

PerSaveSettings

Inherited Members

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)

Fields

DefaultPresetId

public const string DefaultPresetId = "default"

Field Value

string

DefaultPresetName

public const string DefaultPresetName = "{=BaseSettings_Default}Default"

Field Value

string

LoadingComplete

public const string LoadingComplete = "LOADING_COMPLETE"

Field Value

string

SaveTriggered

public const string SaveTriggered = "SAVE_TRIGGERED"

Field Value

string

Properties

DiscoveryType

public virtual string DiscoveryType { get; }

Property Value

string

DisplayName

The display name of the setting in the settings menu.

public abstract string DisplayName { get; }

Property Value

string

FolderName

public virtual string FolderName { get; }

Property Value

string

FormatType

public virtual string FormatType { get; }

Property Value

string

Id

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

public abstract string Id { get; }

Property Value

string

SubFolder

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

public virtual string SubFolder { get; }

Property Value

string

SubGroupDelimiter

public virtual char SubGroupDelimiter { get; }

Property Value

char

UIVersion

public virtual int UIVersion { get; }

Property Value

int

Methods

CopyAsNew()

public virtual BaseSettings CopyAsNew()

Returns

BaseSettings

CreateNew()

public virtual BaseSettings CreateNew()

Returns

BaseSettings

GetBuiltInPresets()

public virtual IEnumerable<ISettingsPreset> GetBuiltInPresets()

Returns

IEnumerable<ISettingsPreset>

OnPropertyChanged(string?)

public virtual void OnPropertyChanged(string? propertyName = null)

Parameters

propertyName string

Events

PropertyChanged

public virtual event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler

---

This page was last modified at 12/23/2022 11:49:56 +02:00 (UTC).

Commit Message

Author:    Aragas
Commit:    aa889a1db7974dc13c9ff22e5740d958a2228b18

* Added MCM Source Package NuGet for easier integration