Class BoolSetting

Namespace

ContentSettings.API.Settings

Assembly

RedstoneWizard08.ContentLibrary.dll

A setting that contains a boolean value.

public abstract class BoolSetting : Setting, IDisposable

Inheritance

object

Setting

BoolSetting

Implements

IDisposable

Derived

BoolOption

Inherited Members

Setting.ApplyValue()

Setting.Dispose()

Setting.Update()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Value

Gets a value indicating whether the setting is enabled.

public bool Value { get; protected set; }

Property Value

bool

Methods

Expose(bool)

Exposes the value of the setting as a string, for display purposes.

public virtual string Expose(bool value)

Parameters

value bool

The value to expose.

Returns

string

The exposed value.

GetDebugUI(ISettingHandler)

Gets the setting UI for the setting.

public override SettingUI GetDebugUI(ISettingHandler settingHandler)

Parameters

settingHandler ISettingHandler

The setting handler to get the setting UI for.

Returns

SettingUI

The setting UI for the setting.

GetDefaultValue()

Gets the default value for the setting.

public abstract bool GetDefaultValue()

Returns

bool

The default value for the setting.

GetSettingUICell()

Gets the setting UI for the setting.

public override GameObject GetSettingUICell()

Returns

GameObject

The setting UI for the setting.

Load(ISettingsSaveLoad)

Loads the setting using the provided loader.

public override void Load(ISettingsSaveLoad loader)

Parameters

loader ISettingsSaveLoad

The loader to load the setting with.

Save(ISettingsSaveLoad)

Save the setting using the provided loader.

public override void Save(ISettingsSaveLoad saver)

Parameters

saver ISettingsSaveLoad

The loader to save the setting with.

SetValue(bool, ISettingHandler)

Sets the value of the setting and saves it.

public void SetValue(bool newValue, ISettingHandler settingHandler)

Parameters

newValue bool

The new value of the setting.

settingHandler ISettingHandler

The setting handler to save the setting with.