OpenSim.Framework.Console.Commands Class Reference

Inheritance diagram for OpenSim.Framework.Console.Commands:

Collaboration diagram for OpenSim.Framework.Console.Commands:

Public Member Functions
List< string >	GetHelp (string[] cmd)
	Get help for the given help string More...
void	AddCommand (string module, bool shared, string command, string help, string longhelp, CommandDelegate fn)
	Add a command to those which can be invoked from the console. More...
void	AddCommand (string module, bool shared, string command, string help, string longhelp, string descriptivehelp, CommandDelegate fn)
	Add a command to those which can be invoked from the console. More...
string[]	FindNextOption (string[] cmd, bool term)
bool	HasCommand (string command)
	Has the given command already been registered? More...
string[]	Resolve (string[] cmd)
XmlElement	GetXml (XmlDocument doc)
void	FromXml (XmlElement root, CommandDelegate fn)

Public Attributes
const string	GeneralHelpText = "To enter an argument that contains spaces, surround the argument with double quotes.\nFor example, show object name \"My long object name\"\n"
const string	ItemHelpText

Detailed Description

Definition at line 42 of file CommandConsole.cs.

Member Function Documentation

void OpenSim.Framework.Console.Commands.AddCommand ( string  module, bool  shared, string  command, string  help, string  longhelp, CommandDelegate  fn  )

inline

Add a command to those which can be invoked from the console.

Parameters

module
command
help
longhelp
fn

Implements OpenSim.Framework.ICommands.

Definition at line 280 of file CommandConsole.cs.

void OpenSim.Framework.Console.Commands.AddCommand ( string  module, bool  shared, string  command, string  help, string  longhelp, string  descriptivehelp, CommandDelegate  fn  )

inline

Add a command to those which can be invoked from the console.

Parameters

module
command
help
longhelp
descriptivehelp
fn

Implements OpenSim.Framework.ICommands.

Definition at line 295 of file CommandConsole.cs.

string [] OpenSim.Framework.Console.Commands.FindNextOption ( string[]  cmd, bool  term  )

inline

Implements OpenSim.Framework.ICommands.

Definition at line 359 of file CommandConsole.cs.

void OpenSim.Framework.Console.Commands.FromXml ( XmlElement  root, CommandDelegate  fn  )

inline

Implements OpenSim.Framework.ICommands.

Definition at line 576 of file CommandConsole.cs.

List<string> OpenSim.Framework.Console.Commands.GetHelp ( string[]  cmd )

inline

Get help for the given help string

Parameters

helpParts

Parsed parts of the help string. If empty then general help is returned.

Returns

Implements OpenSim.Framework.ICommands.

Definition at line 105 of file CommandConsole.cs.

XmlElement OpenSim.Framework.Console.Commands.GetXml ( XmlDocument  doc )

inline

Implements OpenSim.Framework.ICommands.

Definition at line 503 of file CommandConsole.cs.

bool OpenSim.Framework.Console.Commands.HasCommand ( string  command )

inline

Has the given command already been registered?

Returns

Parameters

command

Command.

Implements OpenSim.Framework.ICommands.

Definition at line 475 of file CommandConsole.cs.

Here is the call graph for this function:

string [] OpenSim.Framework.Console.Commands.Resolve ( string[]  cmd )

inline

Implements OpenSim.Framework.ICommands.

Definition at line 481 of file CommandConsole.cs.

Here is the call graph for this function:

Member Data Documentation

const string OpenSim.Framework.Console.Commands.GeneralHelpText = "To enter an argument that contains spaces, surround the argument with double quotes.\nFor example, show object name \"My long object name\"\n"

Definition at line 83 of file CommandConsole.cs.

const string OpenSim.Framework.Console.Commands.ItemHelpText

Initial value:

= @"For more information, type 'help all' to get a list of all commands,
              or type help <item>' where <item> is one of the following:"

Definition at line 86 of file CommandConsole.cs.

---

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

• Framework/Console/CommandConsole.cs