Commands as separate classes

Each command is now in its own class in the 'Commands' namespace, and
loaded through reflection.
This commit is contained in:
ORelio 2014-06-18 13:32:17 +02:00
parent 715bc09872
commit 36690b8b34
12 changed files with 322 additions and 78 deletions

View file

@ -0,0 +1,78 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace MinecraftClient
{
/// <summary>
/// Represents an internal MCC command: Command name, source code and usage message
/// To add a new command, inherit from this class while adding the command class to the folder "Commands".
/// If inheriting from the 'Command' class and placed in the 'Commands' namespace, the command will be
/// automatically loaded and available in main chat prompt, scripts, remote control and command help.
/// </summary>
public abstract class Command
{
/// <summary>
/// The command name
/// </summary>
public abstract string CMDName { get; }
/// <summary>
/// Usage message, eg: 'name [args]: do something'
/// </summary>
public abstract string CMDDesc { get; }
/// <summary>
/// Perform the command
/// </summary>
/// <param name="command">The full command, eg: 'mycommand arg1 arg2'</param>
/// <returns>A confirmation/error message, or "" if no message</returns>
public abstract string Run(McTcpClient handler, string command);
/// <summary>
/// Return a list of aliases for this command.
/// Override this method if you wish to put aliases to the command
/// </summary>
public virtual IEnumerable<string> getCMDAliases() { return new string[0]; }
/// <summary>
/// Check if at least one argument has been passed to the command
/// </summary>
public static bool hasArg(string command)
{
int first_space = command.IndexOf(' ');
return (first_space > 0 && first_space < command.Length - 1);
}
/// <summary>
/// Extract the argument string from the command
/// </summary>
/// <returns>Argument or "" if no argument</returns>
public static string getArg(string command)
{
if (hasArg(command))
{
return command.Substring(command.IndexOf(' ') + 1);
}
else return "";
}
/// <summary>
/// Extract the arguments as a string array from the command
/// </summary>
/// <returns>Argument array or empty array if no arguments</returns>
public static string[] getArgs(string command)
{
return getArg(command).Split(' ');
}
}
}