Gears
API ReferenceSettings.Global

IGlobalValueSetting<T>

A global setting that holds a value of type T, with the applied-value event.

InterfaceNamespace GearsAPI.Settings.GlobalAssembly GearsAPI.dllSource
public interface IGlobalValueSetting<T> : IGlobalModSetting, IValueModSetting<T>

A global setting that holds a value of type T. Adds the applied-value event to IValueModSetting<T>.

Type parameters: T — the value type.
Implements: IGlobalModSetting · IValueModSetting<T> · IModSetting · IValueModSettingBase
Derived: IColorSelectorGlobalSetting · ISelectorGlobalSetting<T> · ISliderGlobalSetting<T> · ISwitchGlobalSetting<T>

Events

OnValueChanged

event ValueChangedEvent<T> OnValueChanged;

Occurs when SettingValue changes to a different value: when the player saves, or when code assigns it. Type ValueChangedEvent<T>.

On this page