‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.Commands.CommandBuilder Class Reference

‪Custom Command builder. More...

Public Member Functions

 CommandBuilder ()
 ‪Create a new command builder. More...
 
 CommandBuilder (string name, string description=null)
 ‪Create a new command builder. More...
 
CommandBuilder Action (Action action)
 ‪Set the action the command performs. More...
 
CommandBuilder Action< A > (Action< A > action)
 ‪Set the action the command performs. More...
 
CommandBuilder Action< A, B > (Action< A, B > action)
 ‪Set the action the command performs. More...
 
CommandBuilder Action< A, B, C > (Action< A, B, C > action)
 ‪Set the action the command performs. More...
 
ICustomCommandEngine Build (bool register=true)
 ‪Build the command. More...
 
CommandBuilder Description (string description)
 ‪Describe the command. More...
 
SimpleCustomCommandEngine FromExisting ()
 ‪Build the command from an existing command. More...
 
SimpleCustomCommandEngine< A > FromExisting< A > ()
 ‪Build the command from an existing command. More...
 
SimpleCustomCommandEngine< A, B > FromExisting< A, B > ()
 ‪Build the command from an existing command. More...
 
SimpleCustomCommandEngine< A, B, C > FromExisting< A, B, C > ()
 ‪Build the command from an existing command. More...
 
string FullName ()
 ‪Get the full command name, in the form [name]::[description]::[# of parameters] More...
 
CommandBuilder Name (string name)
 ‪Name the command. More...
 

Static Public Member Functions

static CommandBuilder Builder ()
 ‪Create and return a command builder. More...
 
static CommandBuilder Builder (string name, string description=null)
 ‪Create and return a command builder. If name and description are provided, this is equivalent to More...
 

Detailed Description

Custom Command builder.

Constructor & Destructor Documentation

◆ CommandBuilder() [1/2]

TechbloxModdingAPI.Commands.CommandBuilder.CommandBuilder ( )
inline

‪Create a new command builder.

◆ CommandBuilder() [2/2]

TechbloxModdingAPI.Commands.CommandBuilder.CommandBuilder ( string  name,
string  description = null 
)
inline

‪Create a new command builder.

Parameters
name‪The command name.
description‪The command description (shown in help).

Member Function Documentation

◆ Action()

CommandBuilder TechbloxModdingAPI.Commands.CommandBuilder.Action ( Action  action)
inline

‪Set the action the command performs.

Returns
‪The builder.
Parameters
action‪The action to perform when the command is called.

◆ Action< A >()

‪Set the action the command performs.

Returns
‪The builder.
Parameters
action‪The action to perform when the command is called.
Template Parameters
A‪The 1st parameter's type.

◆ Action< A, B >()

‪Set the action the command performs.

Returns
‪The builder.
Parameters
action‪The action to perform when the command is called.
Template Parameters
A‪The 1st parameter's type.
B‪The 2nd parameter's type.

◆ Action< A, B, C >()

‪Set the action the command performs.

Returns
‪The builder.
Parameters
action‪The action to perform when the command is called.
Template Parameters
A‪The 1st parameter's type.
B‪The 2nd parameter's type.
C‪The 3rd parameter's type.

◆ Build()

ICustomCommandEngine TechbloxModdingAPI.Commands.CommandBuilder.Build ( bool  register = true)
inline

‪Build the command.

Returns
‪The built command.
Parameters
register‪Automatically register the command with CommandManager.AddCommand()?

◆ Builder() [1/2]

static CommandBuilder TechbloxModdingAPI.Commands.CommandBuilder.Builder ( )
inlinestatic

‪Create and return a command builder.

Returns
‪The builder.

◆ Builder() [2/2]

static CommandBuilder TechbloxModdingAPI.Commands.CommandBuilder.Builder ( string  name,
string  description = null 
)
inlinestatic

‪Create and return a command builder. If name and description are provided, this is equivalent to

Builder().Name(name).Description(description)

Parameters
name‪The command name.
description‪The command description (shown in help).
Returns
‪The builder.

◆ Description()

CommandBuilder TechbloxModdingAPI.Commands.CommandBuilder.Description ( string  description)
inline

‪Describe the command.

Returns
‪The builder.
Parameters
description‪The command description (shown in help).

◆ FromExisting()

SimpleCustomCommandEngine TechbloxModdingAPI.Commands.CommandBuilder.FromExisting ( )
inline

‪Build the command from an existing command.

Returns
‪The command. Use Invoke() to execute it.

◆ FromExisting< A >()

‪Build the command from an existing command.

Returns
‪The command. Use Invoke() to execute it.
Template Parameters
A‪The 1st parameter's type.

◆ FromExisting< A, B >()

‪Build the command from an existing command.

Returns
‪The command. Use Invoke() to execute it.
Template Parameters
A‪The 1st parameter's type.
B‪The 2nd parameter's type.

◆ FromExisting< A, B, C >()

‪Build the command from an existing command.

Returns
‪The command. Use Invoke() to execute it.
Template Parameters
A‪The 1st parameter's type.
B‪The 2nd parameter's type.
C‪The 3rd parameter's type.

◆ FullName()

string TechbloxModdingAPI.Commands.CommandBuilder.FullName ( )
inline

‪Get the full command name, in the form [name]::[description]::[# of parameters]

Returns
‪The name.

◆ Name()

CommandBuilder TechbloxModdingAPI.Commands.CommandBuilder.Name ( string  name)
inline

‪Name the command.

Returns
‪The builder.
Parameters
name‪The command name.

The documentation for this class was generated from the following file: