ISwitchSettingBase

public interface ISwitchSettingBase : IValueModSettingBase

The non-generic members of a Switch: the two buttons, their text, and which one is lit.

Implements: IValueModSettingBase · IModSetting
Derived: ISwitchGlobalSetting<T> · ISwitchWorldSetting<T>
Nested types: ISwitchSettingBase.SelectedButton

Properties

LocalizationPrefix

string LocalizationPrefix { get; set; }

Gets or sets the text prepended to each side's formatted value, with no separator, before it is looked up as a localization key.

Methods

GetRightText()

string GetRightText();

Returns the localized text for the right value.

GetLeftText()

string GetLeftText();

Returns the localized text for the left value.

SelectButton(SelectedButton)

void SelectButton(SelectedButton button);

Sets the selected value to the value on that side.

GetSelectedButton()

SelectedButton GetSelectedButton();

Returns SelectedButton.Right when the selected value equals the right value and not the left value; otherwise Left. Derived from the value on every call.