Skip to Main Content

BTD_Mod_Helper​.Api​.UI​.ModStartMenuEntry


BloonsTD6 Mod Helper

BTD_Mod_Helper.Api.UI

ModStartMenuEntry Class

ModContent representing an entry that will be added to the custom "Start Menu" in game, primarily used to open custom Windows

public abstract class ModStartMenuEntry : BTD_Mod_Helper.Api.NamedModContent

Inheritance System.ObjectModContentNamedModContent  ModStartMenuEntry

Derived
ModStartMenuEntry<T>
ModWindow

Properties

ModStartMenuEntry.ChildEntries Property

Entries nested beneath this entry

public System.Collections.Generic.List<BTD_Mod_Helper.Api.UI.ModStartMenuEntry> ChildEntries { get; }

Property Value

System.Collections.Generic.List<ModStartMenuEntry>

ModStartMenuEntry.DontAddToStartMenu Property

Whether this entry should be hidden from the start menu

public virtual bool DontAddToStartMenu { get; }

Property Value

System.Boolean

ModStartMenuEntry.Icon Property

SpriteReference to use for an icon. Null means no icon, empty string "" means a blank icon (still creates the margin for it within the option)

public virtual string Icon { get; }

Property Value

System.String

ModStartMenuEntry.IconScale Property

Scale for the icon

public virtual float IconScale { get; }

Property Value

System.Single

ModStartMenuEntry.ParentEntry Property

The parent entry that this should be nested under

public virtual BTD_Mod_Helper.Api.UI.ModStartMenuEntry ParentEntry { get; }

Property Value

ModStartMenuEntry

ModStartMenuEntry.StartMenuEntry Property

The Mod Helper Info used to define the Start Menu entry

public virtual BTD_Mod_Helper.Api.Components.Info StartMenuEntry { get; }

Property Value

Info

ModStartMenuEntry.StartMenuEntryHeight Property

Height for the entry option within the Start Menu

public virtual float StartMenuEntryHeight { get; }

Property Value

System.Single

ModStartMenuEntry.StartMenuEntryWidth Property

Width for the entry option within the Start Menu. 0 for automatic width

public virtual float StartMenuEntryWidth { get; }

Property Value

System.Single

Methods

ModStartMenuEntry.IsHidden() Method

Whether this start menu entry should not appear in the menu at this time

public virtual bool IsHidden();

Returns

System.Boolean
whether it's hidden or not

ModStartMenuEntry.IsSelected() Method

Whether this start menu entry should appear as selected in the menu.

public virtual bool IsSelected();

Returns

System.Boolean
whether it's selected or not

ModStartMenuEntry.StartMenuEntryClicked() Method

What to do when the start menu entry is clicked. Not called if this has child entries

public virtual void StartMenuEntryClicked();
To learn how to download BTD Mod Helper and install mods, click here