Skip to Main Content

BTD_Mod_Helper​.Api​.Bloons​.ModRoundSet


BloonsTD6 Mod Helper

BTD_Mod_Helper.Api.Bloons

ModRoundSet Class

Class for a custom RoundSet

public abstract class ModRoundSet : BTD_Mod_Helper.Api.NamedModContent

Inheritance System.ObjectModContentNamedModContent  ModRoundSet

Properties

ModRoundSet.AddToOverrideMenu Property

Whether this Round set should show up in the menu allowing you to use any RoundSet for any GameMode

public virtual bool AddToOverrideMenu { get; }

Property Value

System.Boolean

ModRoundSet.AlwaysShowHints Property

Whether to bypass the base game hints settings. Useful for using your own ModSetting to control hints.

public virtual bool AlwaysShowHints { get; }

Property Value

System.Boolean

ModRoundSet.BaseRounds Property

The Base Rounds included in the RoundSet specified by BaseRoundSet

protected System.Collections.Generic.List<RoundModel> BaseRounds { get; }

Property Value

System.Collections.Generic.List<Il2CppAssets.Scripts.Models.Rounds.RoundModel>

ModRoundSet.BaseRoundSet Property

The id of the existing RoundSet to use as a base. Use RoundSetType.[name]
If this RoundSetType.None, empty, or null, then an empty round set will be used

public abstract string BaseRoundSet { get; }

Property Value

System.String

ModRoundSet.CustomHints Property

Whether these rounds should have custom hints, like Alternate Bloons Rounds does

public virtual bool CustomHints { get; }

Property Value

System.Boolean

ModRoundSet.DefinedRounds Property

The total number of rounds that have specified Bloons.


After this number of rounds, randomized Free Play rounds will happen

public abstract int DefinedRounds { get; }

Property Value

System.Int32

ModRoundSet.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

ModRoundSet.Icon Property

The Icon for the Button for this RoundSet within the UI, by default looking for the same name as the file

public virtual string Icon { get; }

Property Value

System.String

ModRoundSet.IconReference Property

If you're not going to use a custom .png for your Icon, use this to directly control its SpriteReference

public virtual SpriteReference IconReference { get; }

Property Value

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference

ModRoundSet.Rounds1Index Property

Whether to use 1-Indexed rounds in ModifyRoundsModels methods instead of 0 indexed


TODO this will default to true in a future Mod Helper update

public virtual bool Rounds1Index { get; }

Property Value

System.Boolean

Methods

ModRoundSet.GetHint(int) Method

Gets the custom hint for a specific round. This will be shown at the end of that round.


For no hint, return null.

public virtual string GetHint(int round);

Parameters

round System.Int32

Returns

System.String

ModRoundSet.ModifyEasyRoundModels(RoundModel, int) Method

Called to modify specifically just rounds from 1 to 40

public virtual void ModifyEasyRoundModels(RoundModel roundModel, int round);

Parameters

roundModel Il2CppAssets.Scripts.Models.Rounds.RoundModel

round System.Int32

ModRoundSet.ModifyGameModel(GameModel) Method

Modifies the GameModel that's used for matches played with this round set

public virtual void ModifyGameModel(GameModel gameModel);

Parameters

gameModel Il2CppAssets.Scripts.Models.GameModel

ModRoundSet.ModifyHardRoundModels(RoundModel, int) Method

Called to modify specifically just rounds from 61 to 80

public virtual void ModifyHardRoundModels(RoundModel roundModel, int round);

Parameters

roundModel Il2CppAssets.Scripts.Models.Rounds.RoundModel

round System.Int32

ModRoundSet.ModifyImpoppableRoundModels(RoundModel, int) Method

Called to modify specifically just rounds from 81 to 100

public virtual void ModifyImpoppableRoundModels(RoundModel roundModel, int round);

Parameters

roundModel Il2CppAssets.Scripts.Models.Rounds.RoundModel

round System.Int32

ModRoundSet.ModifyMediumRoundModels(RoundModel, int) Method

Called to modify specifically just rounds from 41 to 60

public virtual void ModifyMediumRoundModels(RoundModel roundModel, int round);

Parameters

roundModel Il2CppAssets.Scripts.Models.Rounds.RoundModel

round System.Int32

ModRoundSet.ModifyRoundModels(RoundModel, int) Method

Called to modify any/all rounds from 1 to DefinedRounds

public virtual void ModifyRoundModels(RoundModel roundModel, int round);

Parameters

roundModel Il2CppAssets.Scripts.Models.Rounds.RoundModel

round System.Int32

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