Class ModToggleOption

Namespace

Nautilus.Options

Assembly

Nautilus.dll

A mod option class for handling an option that can be either ON or OFF.

public class ModToggleOption : ModOption<bool, ToggleChangedEventArgs>

Inheritance

object

OptionItem

ModOption<bool, ToggleChangedEventArgs>

ModToggleOption

Inherited Members

ModOption<bool, ToggleChangedEventArgs>.Value

ModOption<bool, ToggleChangedEventArgs>.OnChanged

ModOption<bool, ToggleChangedEventArgs>.GetDelegates()

ModOption<bool, ToggleChangedEventArgs>.OnChange(string, bool)

OptionItem.Id

OptionItem.Label

OptionItem.OptionGameObject

OptionItem.parentOptions

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

JsonExtensions.LoadJson<T>(T, string, bool, params JsonConverter[])

JsonExtensions.SaveJson<T>(T, string, params JsonConverter[])

ReflectionHelper.CopyFields<T>(T, T, BindingFlags)

ReflectionHelper.GetInstanceField<T>(T, string, BindingFlags)

ReflectionHelper.GetInstanceMethod<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticField<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticMethod<T>(T, string, BindingFlags)

ReflectionHelper.SetInstanceField<T>(T, string, object, BindingFlags)

ReflectionHelper.SetStaticField<T>(T, string, object, BindingFlags)

Properties

AdjusterComponent

The Adjuster for this OptionItem.

public override Type AdjusterComponent { get; }

Property Value

Type

Tooltip

The tooltip to show when hovering over the option.

public string Tooltip { get; }

Property Value

string

Methods

AddToPanel(uGUI_TabbedControlsPanel, int)

The base method for adding an object to the options panel

public override void AddToPanel(uGUI_TabbedControlsPanel panel, int tabIndex)

Parameters

panel uGUI_TabbedControlsPanel

The panel to add the option to.

tabIndex int

Where in the panel to add the option.

Create(string, string, bool, string)

Adds a new ModToggleOption to this instance.

public static ModToggleOption Create(string id, string label, bool value, string tooltip = null)

Parameters

id string

The internal ID for the toggle option.

label string

The display text to use in the in-game menu.

value bool

The starting value.

tooltip string

The tooltip to show when hovering over the option. defaults to no tooltip.

Returns

ModToggleOption