OpenSim.Framework.Console.ConsolePluginCommand Class Reference

Holder object for a new console plugin command More...

Public Member Functions
	ConsolePluginCommand (string command, ConsoleCommand dlg, string help)
	Construct a new ConsolePluginCommand More...
int	matchLength (string cmdWithParams)
	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 More...
void	Run (string cmd, string[] cmdParams)
	Run the delegate the incomming string may contain the command, if so, it is chopped off the cmdParams[] More...
void	ShowHelp (ConsoleBase console)
	Shows help information on the console's Notice method More...
bool	IsHelpfull (string cmdWithParams)
	return true if the ShowHelp(..) method might be helpfull More...

Detailed Description

Holder object for a new console plugin command

Override the methods like Run and IsHelpfull (but the defaults might work ok.)

Definition at line 39 of file ConsolePluginCommand.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Console.ConsolePluginCommand.ConsolePluginCommand ( string  command, ConsoleCommand  dlg, string  help  )

inline

Construct a new ConsolePluginCommand

for use with OpenSim.RegisterConsolePluginCommand(myCmd);

Parameters

command	in the form of "showme new commands"
dlg	ommand delegate used in running
help	the text displayed in "help showme new commands"

Definition at line 63 of file ConsolePluginCommand.cs.

Member Function Documentation

bool OpenSim.Framework.Console.ConsolePluginCommand.IsHelpfull ( string  cmdWithParams )

inline

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

Definition at line 133 of file ConsolePluginCommand.cs.

int OpenSim.Framework.Console.ConsolePluginCommand.matchLength ( string  cmdWithParams )

inline

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 Also

OopenSim.RunPluginCommands It will only run the one with the highest number

Definition at line 79 of file ConsolePluginCommand.cs.

void OpenSim.Framework.Console.ConsolePluginCommand.Run ( string  cmd, string[]  cmdParams  )

inline

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

Definition at line 95 of file ConsolePluginCommand.cs.

void OpenSim.Framework.Console.ConsolePluginCommand.ShowHelp ( ConsoleBase  console )

inline

Shows help information on the console's Notice method

Definition at line 125 of file ConsolePluginCommand.cs.

---

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

• Framework/Console/ConsolePluginCommand.cs