Gears
API ReferenceSettings.Global

ISwitchGlobalSetting<T>

A global two-position setting.

InterfaceNamespace GearsAPI.Settings.GlobalAssembly GearsAPI.dllSource
public interface ISwitchGlobalSetting<T> : IGlobalValueSetting<T>, ISwitchSettingBase

A global two-position setting. Implemented for bool (left false, right true), string (no sides until SetSwitchValues) and any enum (left and right are the first two declared members).

Type parameters: T — bool, string or an enum.
Implements: IGlobalValueSetting<T> · ISwitchSettingBase · IGlobalModSetting · IValueModSetting<T> · IValueModSettingBase · IModSetting

Properties

LeftValue

T LeftValue { get; set; }

Gets or sets the value the left button selects.

RightValue

T RightValue { get; set; }

Gets or sets the value the right button selects.

Methods

SetSwitchValues(T, T)

void SetSwitchValues(T leftValue, T rightValue);

Sets LeftValue and RightValue together.

On this page