Skip to Main Content

BTD_Mod_Helper​.Api​.ModLoadTask


BloonsTD6 Mod Helper

BTD_Mod_Helper.Api

ModLoadTask Class

Class for a Coroutine style task that runs during the BTD6 loading screen

public abstract class ModLoadTask : BTD_Mod_Helper.Api.NamedModContent

Inheritance System.ObjectModContentNamedModContent  ModLoadTask

Properties

ModLoadTask.Description Property

The subtext that appears to the right of the Display Name at the bottom of the loading screen


Can be dynamically changed while running the task

public virtual string Description { get; set; }

Property Value

System.String

ModLoadTask.DisplayNamePlural Property

The name that will actually be display when referring to multiple of these

public sealed override string DisplayNamePlural { get; }

Property Value

System.String

ModLoadTask.Progress Property

If ShowProgressBar is enabled, how much Progress should be shown (from 0 to 1)

public float Progress { get; set; }

Property Value

System.Single

ModLoadTask.ShowProgressBar Property

Whether to show the progress bar during this task or not

public virtual bool ShowProgressBar { get; }

Property Value

System.Boolean

Methods

ModLoadTask.Coroutine() Method

Coroutine style function

public abstract System.Collections.IEnumerator Coroutine();

Returns

System.Collections.IEnumerator

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