Interface ISettingsBuilder

Namespace

MCM.Abstractions.FluentBuilder

Assembly

MCMv5.dll

An interface that defines the necessary members for implementing a settings builder.

public interface ISettingsBuilder

Methods

BuildAsGlobal()

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

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.

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.

FluentPerSaveSettings BuildAsPerSave()

Returns

FluentPerSaveSettings

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.

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

Parameters

name string

builder Action<ISettingsPropertyGroupBuilder>

Returns

ISettingsBuilder

The settings builder.

CreatePreset(string, string, Action<ISettingsPresetBuilder>)

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.

ISettingsBuilder SetFolderName(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetFormat(string)

See FormatType.

ISettingsBuilder SetFormat(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetOnPropertyChanged(PropertyChangedEventHandler)

See OnPropertyChanged(string?).

ISettingsBuilder SetOnPropertyChanged(PropertyChangedEventHandler value)

Parameters

value PropertyChangedEventHandler

The value.

Returns

ISettingsBuilder

The settings builder.

SetSubFolder(string)

See SubFolder.

ISettingsBuilder SetSubFolder(string value)

Parameters

value string

The value.

Returns

ISettingsBuilder

The settings builder.

SetSubGroupDelimiter(char)

See SubGroupDelimiter.

ISettingsBuilder SetSubGroupDelimiter(char value)

Parameters

value char

The value.

Returns

ISettingsBuilder

The settings builder.

SetUIVersion(int)

See UIVersion.

ISettingsBuilder SetUIVersion(int value)

Parameters

value int

The value.

Returns

ISettingsBuilder

The settings builder.

WithoutDefaultPreset()

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