Class SettingsPropertyDefinitionWrapper

Namespace

MCM.Abstractions.Wrapper

Assembly

MCMv5.dll

public sealed class SettingsPropertyDefinitionWrapper : ISettingsPropertyDefinition, IPropertyDefinitionBool, IPropertyDefinitionDropdown, IPropertyDefinitionWithMinMax, IPropertyDefinitionWithEditableMinMax, IPropertyDefinitionWithFormat, IPropertyDefinitionWithCustomFormatter, IPropertyDefinitionWithId, IPropertyDefinitionText, IPropertyDefinitionGroupToggle, IPropertyGroupDefinition, IPropertyDefinitionButton, IPropertyDefinitionBase

Inheritance

object

SettingsPropertyDefinitionWrapper

Implements

ISettingsPropertyDefinition

IPropertyDefinitionBool

IPropertyDefinitionDropdown

IPropertyDefinitionWithMinMax

IPropertyDefinitionWithEditableMinMax

IPropertyDefinitionWithFormat

IPropertyDefinitionWithCustomFormatter

IPropertyDefinitionWithId

IPropertyDefinitionText

IPropertyDefinitionGroupToggle

IPropertyGroupDefinition

IPropertyDefinitionButton

IPropertyDefinitionBase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SettingsPropertyDefinitionWrapper(object)

public SettingsPropertyDefinitionWrapper(object @object)

Parameters

object object

Properties

Content

public string Content { get; }

Property Value

string

CustomFormatter

public Type? CustomFormatter { get; }

Property Value

Type

DisplayName

The display name of the setting in the settings menu.

public string DisplayName { get; }

Property Value

string

EditableMaxValue

public decimal EditableMaxValue { get; }

Property Value

decimal

EditableMinValue

public decimal EditableMinValue { get; }

Property Value

decimal

GroupName

The name of the settings group. Includes SubGroup notation if present.

public string GroupName { get; }

Property Value

string

GroupOrder

public int GroupOrder { get; }

Property Value

int

HintText

The hint text that is displayed at the bottom of the screen when the user hovers over the setting in the settings menu.

public string HintText { get; }

Property Value

string

Id

public string Id { get; }

Property Value

string

IsToggle

public bool IsToggle { get; }

Property Value

bool

MaxValue

The maximum value the setting can be set to. Used by the slider control.

public decimal MaxValue { get; }

Property Value

decimal

MinValue

The minimum value the setting can be set to. Used by the slider control.

public decimal MinValue { get; }

Property Value

decimal

Order

Require restart of the game if the value is changed.

public int Order { get; }

Property Value

int

PropertyReference

public IRef PropertyReference { get; }

Property Value

IRef

RequireRestart

Require restart of the game if the value is changed.

public bool RequireRestart { get; }

Property Value

bool

SelectedIndex

public int SelectedIndex { get; }

Property Value

int

SettingType

public SettingType SettingType { get; }

Property Value

SettingType

ValueFormat

The format in which the slider's value will be displayed in.

public string ValueFormat { get; }

Property Value

string

Methods

Clone(bool)

public SettingsPropertyDefinition Clone(bool keepRefs = true)

Parameters

keepRefs bool

Returns

SettingsPropertyDefinition