Class BaseSettingsBuilder

Namespace

MCM.Abstractions.FluentBuilder

Assembly

MCMv5.dll

public abstract class BaseSettingsBuilder : ISettingsBuilder

Inheritance

object

BaseSettingsBuilder

Implements

ISettingsBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

BuildAsGlobal()

Returns a Global setting instance. Use Register and Unregister for MCM to use it.

public abstract FluentGlobalSettings BuildAsGlobal()

Returns

FluentGlobalSettings

BuildAsPerCampaign()

Returns a PerCampaign setting instance. Use Register and Unregister for MCM to use it. The registered settings will be cleared before and after player joins the campaign, so do the register thing when the campaign was already joined in.

public abstract FluentPerCampaignSettings BuildAsPerCampaign()

Returns

FluentPerCampaignSettings

BuildAsPerSave()

Returns a PerSave setting instance. Use Register and Unregister for MCM to use it. The registered settings will be cleared before and after player joins the campaign, so do the register thing when the campaign was already joined in.

public abstract FluentPerSaveSettings BuildAsPerSave()

Returns

FluentPerSaveSettings

Create(string, string)

public static ISettingsBuilder? Create(string id, string displayName)

Parameters

id string

displayName string

Returns

ISettingsBuilder

CreateGroup(string, Action<ISettingsPropertyGroupBuilder>)

Creates a property group where you can define your properties. The default Group name is 'Misc'. Use the action delegate to configure the property group.

public abstract ISettingsBuilder CreateGroup(string name, Action<ISettingsPropertyGroupBuilder> builder)

Parameters

name string

builder Action<ISettingsPropertyGroupBuilder>

Returns

ISettingsBuilder

The settings builder.

CreatePreset(string, string, Action<ISettingsPresetBuilder>)

public abstract ISettingsBuilder CreatePreset(string id, string name, Action<ISettingsPresetBuilder> builder)

Parameters

id string

name string

builder Action<ISettingsPresetBuilder>

Returns

ISettingsBuilder

The settings builder.

SetFolderName(string)

See FolderName.

public abstract ISettingsBuilder SetFolderName(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetFormat(string)

See FormatType.

public abstract ISettingsBuilder SetFormat(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetOnPropertyChanged(PropertyChangedEventHandler)

See OnPropertyChanged(string?).

public abstract ISettingsBuilder SetOnPropertyChanged(PropertyChangedEventHandler value)

Parameters

value PropertyChangedEventHandler

The value.

Returns

ISettingsBuilder

The settings builder.

SetSubFolder(string)

See SubFolder.

public abstract ISettingsBuilder SetSubFolder(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetSubGroupDelimiter(char)

See SubGroupDelimiter.

public abstract ISettingsBuilder SetSubGroupDelimiter(char value)

Parameters

value char

The value.

Returns

ISettingsBuilder

The settings builder.

SetUIVersion(int)

See UIVersion.

public abstract ISettingsBuilder SetUIVersion(int value)

Parameters

value int

The value.

Returns

ISettingsBuilder

The settings builder.

WithoutDefaultPreset()

public abstract ISettingsBuilder WithoutDefaultPreset()

Returns

ISettingsBuilder

---

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