ISelectorSettingBase

public interface ISelectorSettingBase : IValueModSettingBase

The non-generic members of a Selector: how its values are displayed and stored, and selection by position.

Implements: IValueModSettingBase · IModSetting
Derived: ISelectorGlobalSetting<T> · ISelectorWorldSetting<T>

Properties

UiFormatter

string UiFormatter { get; set; }

Gets or sets the .NET format string used when a value is shown to the player. Applied by numeric types only. Changing it rebuilds the display strings.

SerializationFormatter

string SerializationFormatter { get; set; }

Gets or sets the .NET format string used when the value is saved or read by modsetting(). Numeric types only.

LocalizationPrefix

string LocalizationPrefix { get; set; }

Gets or sets the text prepended to each formatted value, with no separator, before it is looked up as a localization key. Changing it rebuilds the display strings.

Wrap

bool Wrap { get; set; }

Gets or sets whether stepping past the last value returns to the first.

Methods

GetAllowedValuesDisplay()

string[] GetAllowedValuesDisplay();

Returns the allowed values as the player sees them, in the same order as the typed GetAllowedValues(). Built on first use and cached until the values, formatter or prefix change.

SelectByIndex(Int32)

void SelectByIndex(int index);

Sets the selected value to the allowed value at index. Throws ArgumentOutOfRangeException if index is outside the allowed values.