Gears
API ReferenceSettings.World

ISwitchWorldSetting<T>

A world two-position setting.

InterfaceNamespace GearsAPI.Settings.WorldAssembly GearsAPI.dllSource
public interface ISwitchWorldSetting<T> : IWorldModSetting, IValueModSetting<T>, ISwitchSettingBase

A world two-position setting. Implemented for bool, string and any enum, with the same side defaults as the global version.

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

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