Skip to Main Content

BTD_Mod_Helper​.Api​.Components​.ModHelperOption


BloonsTD6 Mod Helper

BTD_Mod_Helper.Api.Components

ModHelperOption Class

ModHelperComponent that's the base panel for the visual representation of a ModSetting

public class ModHelperOption : BTD_Mod_Helper.Api.Components.ModHelperComponent

Inheritance UnityEngine.MonoBehaviourModHelperComponent  ModHelperOption

Derived
ModHelperCategory

Properties

ModHelperOption.BottomRow Property

The bottom row of elements containing the reset button and whatever input is added

public BTD_Mod_Helper.Api.Components.ModHelperPanel BottomRow { get; set; }

Property Value

ModHelperPanel

ModHelperOption.Icon Property

The Icon for this setting. Will be null if no Icon provided

public BTD_Mod_Helper.Api.Components.ModHelperImage Icon { get; set; }

Property Value

ModHelperImage

ModHelperOption.InfoButton Property

The button that popups the description when pressed

public BTD_Mod_Helper.Api.Components.ModHelperButton InfoButton { get; set; }

Property Value

ModHelperButton

ModHelperOption.Name Property

The displayed name for this setting

public BTD_Mod_Helper.Api.Components.ModHelperText Name { get; set; }

Property Value

ModHelperText

ModHelperOption.ResetButton Property

The button that resets this setting

public BTD_Mod_Helper.Api.Components.ModHelperButton ResetButton { get; set; }

Property Value

ModHelperButton

ModHelperOption.RestartIcon Property

The image shown when this setting requires a restart

public BTD_Mod_Helper.Api.Components.ModHelperImage RestartIcon { get; set; }

Property Value

ModHelperImage

ModHelperOption.TopRow Property

The top row of elements containing icon, name, info button

public BTD_Mod_Helper.Api.Components.ModHelperPanel TopRow { get; set; }

Property Value

ModHelperPanel

Methods

ModHelperOption.Create(string, string, string) Method

Creates a new MoodHelperOption

public static BTD_Mod_Helper.Api.Components.ModHelperOption Create(string displayName, string description=null, string icon=null);

Parameters

displayName System.String

The displayed name of the mod setting

description System.String

The description of the mod setting, if any

icon System.String

The icon of the mod setting, if any

Returns

ModHelperOption
The created ModHelperOption

ModHelperOption.Create(string, string, string) Method

Creates a new MoodHelperOption

protected static T Create<T>(string displayName, string description=null, string icon=null)
    where T : BTD_Mod_Helper.Api.Components.ModHelperOption;

Type parameters

T

Parameters

displayName System.String

The displayed name of the mod setting

description System.String

The description of the mod setting, if any

icon System.String

The icon of the mod setting, if any

Returns

T
The created ModHelperOption

ModHelperOption.SetResetAction(UnityAction) Method

Adds an action to the reset button

public void SetResetAction(UnityAction action);

Parameters

action UnityEngine.Events.UnityAction

To learn how to download BTD Mod Helper and install mods, click here