Class ModButtonOption

Namespace

Nautilus.Options

Assembly

Nautilus.dll

A mod option class for handling a button that can be clicked.

public class ModButtonOption : OptionItem

Inheritance

object

OptionItem

ModButtonOption

Inherited Members

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, Action<ButtonClickedEventArgs>, string)

Creates a new ModButtonOption for handling a button that can be clicked.

public static ModButtonOption Create(string id, string label, Action<ButtonClickedEventArgs> onPressed = null, string tooltip = null)

Parameters

id string

The internal ID of this option.

label string

The display text to show on the in-game menus.

onPressed Action<ButtonClickedEventArgs>

Action to trigger when button is pressed. Can leave as Null and then add events using the OnPressed += method;

tooltip string

The tooltip to show when hovering over the option.

Returns

ModButtonOption

GetDelegates()

Gets the Invocation List for the OnPressed event or returns null if none present.

public IEnumerable<Action<ButtonClickedEventArgs>> GetDelegates()

Returns

IEnumerable<Action<ButtonClickedEventArgs>>

Events

OnPressed

The event that is called whenever an option is changed.

public event Action<ButtonClickedEventArgs> OnPressed

Event Type

Action<ButtonClickedEventArgs>