Class ModKeybindOption

Namespace

Nautilus.Options

Assembly

Nautilus.dll

A mod option class for handling an option that is a keybind.

public class ModKeybindOption : ModOption<KeyCode, KeybindChangedEventArgs>

Inheritance

object

OptionItem

ModOption<KeyCode, KeybindChangedEventArgs>

ModKeybindOption

Inherited Members

ModOption<KeyCode, KeybindChangedEventArgs>.Value

ModOption<KeyCode, KeybindChangedEventArgs>.OnChanged

ModOption<KeyCode, KeybindChangedEventArgs>.GetDelegates()

ModOption<KeyCode, KeybindChangedEventArgs>.OnChange(string, KeyCode)

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

Device

The currently select input source device for the ModKeybindOption.

public GameInput.Device Device { get; set; }

Property Value

GameInput.Device

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, Device, string, string)

Creates a new ModKeybindOption for handling an option that is a keybind.

public static ModKeybindOption Create(string id, string label, GameInput.Device device, string key, 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.

device GameInput.Device

The device name.

key string

The starting keybind value.

tooltip string

The tooltip to show when hovering over the option.

Returns

ModKeybindOption

Create(string, string, Device, KeyCode, string)

Creates a new ModKeybindOption for handling an option that is a keybind.

public static ModKeybindOption Create(string id, string label, GameInput.Device device, KeyCode key, 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.

device GameInput.Device

The device name.

key KeyCode

The starting keybind value.

tooltip string

The tooltip to show when hovering over the option.

Returns

ModKeybindOption