Class FluentPerSaveSettings

Namespace

MCM.Abstractions.Base.PerSave

Assembly

MCMv5.dll

public class FluentPerSaveSettings : PerSaveSettings, INotifyPropertyChanged, IFluentSettings

Inheritance

object

BaseSettings

PerSaveSettings

FluentPerSaveSettings

Implements

INotifyPropertyChanged

IFluentSettings

Derived

ExternalPerSaveSettings

Inherited Members

PerSaveSettings.Cache

PerSaveSettings.CacheInstance

PerSaveSettings.FormatType

BaseSettings.SaveTriggered

BaseSettings.LoadingComplete

BaseSettings.DefaultPresetId

BaseSettings.DefaultPresetName

BaseSettings.OnPropertyChanged(string)

BaseSettings.CopyAsNew()

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

FluentPerSaveSettings(string, string, string, string, int, char, PropertyChangedEventHandler?, IEnumerable<SettingsPropertyGroupDefinition>, IEnumerable<ISettingsPresetBuilder>)

public FluentPerSaveSettings(string id, string displayName, string folderName, string subFolder, int uiVersion, char subGroupDelimiter, PropertyChangedEventHandler? onPropertyChanged, IEnumerable<SettingsPropertyGroupDefinition> settingPropertyGroups, IEnumerable<ISettingsPresetBuilder> presets)

Parameters

id string

displayName string

folderName string

subFolder string

uiVersion int

subGroupDelimiter char

onPropertyChanged PropertyChangedEventHandler

settingPropertyGroups IEnumerable<SettingsPropertyGroupDefinition>

presets IEnumerable<ISettingsPresetBuilder>

Properties

DiscoveryType

public override string DiscoveryType { get; }

Property Value

string

DisplayName

The display name of the setting in the settings menu.

public override sealed string DisplayName { get; }

Property Value

string

FolderName

public override sealed string FolderName { get; }

Property Value

string

Id

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

public override sealed string Id { get; }

Property Value

string

SettingPropertyGroups

public List<SettingsPropertyGroupDefinition> SettingPropertyGroups { get; }

Property Value

List<SettingsPropertyGroupDefinition>

SubFolder

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

public override sealed string SubFolder { get; }

Property Value

string

SubGroupDelimiter

public override sealed char SubGroupDelimiter { get; }

Property Value

char

UIVersion

public override sealed int UIVersion { get; }

Property Value

int

Methods

CreateNew()

public override BaseSettings CreateNew()

Returns

BaseSettings

GetBuiltInPresets()

public override sealed IEnumerable<ISettingsPreset> GetBuiltInPresets()

Returns

IEnumerable<ISettingsPreset>

Register()

public void Register()

Unregister()

public void Unregister()

Events

PropertyChanged

public override sealed event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler

---

This page was last modified at 06/21/2024 00:30:43 +03:00 (UTC).

Commit Message

Author:    Vitalii Mikhailov
Commit:    4886bde83cd8d8579d8a29e1fed7cf3fbb5dea31

Switched to collection expression

Version bump