Class ModColorOption

Namespace

Nautilus.Options

Assembly

Nautilus.dll

A basic mod option class for handling an option that can be any UnityEngine.Color.

public class ModColorOption : ModOption<Color, ColorChangedEventArgs>

Inheritance

object

OptionItem

ModOption<Color, ColorChangedEventArgs>

ModColorOption

Inherited Members

ModOption<Color, ColorChangedEventArgs>.Value

ModOption<Color, ColorChangedEventArgs>.OnChanged

ModOption<Color, ColorChangedEventArgs>.GetDelegates()

ModOption<Color, ColorChangedEventArgs>.OnChange(string, Color)

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.LoadJsonAsync<T>(T, string, bool, params JsonConverter[])

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

JsonExtensions.SaveJsonAsync<T>(T, string, 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

Advanced

Whether to use an advanced UI

public bool Advanced { get; set; }

Property Value

bool

AdvancedExposeAlphaChannel

When using Advanced UI, whether to show the Alpha controls

public bool AdvancedExposeAlphaChannel { get; set; }

Property Value

bool

Tooltip

The tooltip to show when hovering over the option's items.

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)

Creates a new ModColorOption instance.

public static ModColorOption Create(string id, string label)

Parameters

id string

The internal ID for the Color option.

label string

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

Returns

ModColorOption

Create(string, string, Color, bool, string, bool)

Creates a new ModColorOption instance.

public static ModColorOption Create(string id, string label, Color value, bool advanced = false, string tooltip = null, bool advancedExposeAlphaChannel = true)

Parameters

id string

The internal ID for the Color option.

label string

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

value Color

The starting value.

advanced bool

Whether to use an advanced display.

tooltip string

The tooltip to show when hovering over the options.

advancedExposeAlphaChannel bool

When using advanced display. Whether to expose alpha channel control.

Returns

ModColorOption