C# Class Universe.Framework.ConsoleFramework.ConsolePluginCommand

Holder object for a new console plugin command Override the methods like Run and IsHelpfull (but the defaults might work ok.)

Show file Open project: Virtual-Universe/Virtual-Universe

Public Methods

Method	Description
ConsolePluginCommand ( string command, ConsoleCommand dlg, string help ) : System	Construct a new ConsolePluginCommand for use with RegisterConsolePluginCommand(myCmd);
IsHelpfull ( string cmdWithParams ) : bool	return true if the ShowHelp(..) method might be helpful
Run ( string cmd, string cmdParams ) : void	Run the delegate the incoming string may contain the command, if so, it is chopped off the cmdParams[]
matchLength ( string cmdWithParams ) : int	Returns the match length this command has upon the 'cmdWithParams' At least a higher number for "show plugin status" then "show" would return This is used to have multi length command verbs @see OopenSim.RunPluginCommands It will only run the one with the highest number

Method Details

ConsolePluginCommand() public method

Construct a new ConsolePluginCommand for use with RegisterConsolePluginCommand(myCmd);

public ConsolePluginCommand ( string command, ConsoleCommand dlg, string help ) : System
command	string	in the form of "showme new commands"
dlg	ConsoleCommand	command delegate used in running
help	string	the text displayed in "help showme new commands"
return	System

IsHelpfull() public method

return true if the ShowHelp(..) method might be helpful

public IsHelpfull ( string cmdWithParams ) : bool
cmdWithParams	string
return	bool

Run() public method

Run the delegate the incoming string may contain the command, if so, it is chopped off the cmdParams[]

public Run ( string cmd, string cmdParams ) : void
cmd	string
cmdParams	string
return	void

matchLength() public method

Returns the match length this command has upon the 'cmdWithParams' At least a higher number for "show plugin status" then "show" would return This is used to have multi length command verbs @see OopenSim.RunPluginCommands It will only run the one with the highest number

public matchLength ( string cmdWithParams ) : int
cmdWithParams	string
return	int