Table of Contents
Defines a command that can be run from within the Mod Helper developer console
public abstract class ModCommand : BTD_Mod_Helper.Api.ModContent
Inheritance System.Object ModContent ModCommand
Derived
↳ ExportCommand
↳ ModCommand<T>
↳ OpenCommand
↳ TestCommand
List of Sub-commands that this command has
public readonly Dictionary<string,ModCommand> SubCommands;
System.Collections.Generic.Dictionary<System.String,ModCommand>
The string name of this command
public abstract string Command { get; }
Short text description of this command
public abstract string Help { get; }
Whether the command is available to users
public virtual bool IsAvailable { get; }
Optional arguments for this command
public System.Collections.Generic.IEnumerable<CommandLine.OptionAttribute> Options { get; }
System.Collections.Generic.IEnumerable<CommandLine.OptionAttribute>
Other ModCommand that this is nested under, or null if a root command
public virtual BTD_Mod_Helper.Api.Commands.ModCommand ParentCommand { get; }
Line of text that appears as a suggestion
public string SuggestionLine { get; }
Positional values for this command
public System.Collections.Generic.IEnumerable<CommandLine.ValueAttribute> Values { get; }
System.Collections.Generic.IEnumerable<CommandLine.ValueAttribute>
Closes the command console
protected static void CloseConsole();
Runs this command
public abstract bool Execute(ref string resultText);
resultText System.String
System.Boolean
Whether this command successfully executed
Fails the command and displays which subbcommands are available to the user
protected bool ExplainSubcommands(out string resultText);
resultText System.String