OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander Class Reference

A class to enable modules to register console and script commands, which enforces typing and valid input. More...

Inheritance diagram for OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander:

Collaboration diagram for OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander:

Public Member Functions
	Commander (string name)
	Constructor More...
void	RegisterCommand (string commandName, ICommand command)
string	GenerateRuntimeAPI ()
	Generates a runtime C# class which can be compiled and inserted via reflection to enable modules to register new script commands More...
void	Run (string function, object[] args)
	Runs a specified function with attached arguments *** DO NOT CALL DIRECTLY. *** Call ProcessConsoleCommand instead if handling human input. More...
void	ProcessConsoleCommand (string function, string[] args)

Properties
string	Name [get]
string	Help [get]
Dictionary< string, ICommand >	Commands [get]
Properties inherited from OpenSim.Region.Framework.Interfaces.ICommander
string	Name [get]
string	Help [get]
Dictionary< string, ICommand >	Commands [get]
	The commands available for this commander More...

Detailed Description

A class to enable modules to register console and script commands, which enforces typing and valid input.

Definition at line 41 of file Commander.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.Commander ( string  name )

inline

Constructor

Parameters

name

Definition at line 77 of file Commander.cs.

Member Function Documentation

string OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.GenerateRuntimeAPI ( )

inline

Generates a runtime C# class which can be compiled and inserted via reflection to enable modules to register new script commands

Returns

Returns C# source code to create a binding

Implements OpenSim.Region.Framework.Interfaces.ICommander.

Definition at line 103 of file Commander.cs.

void OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.ProcessConsoleCommand ( string  function, string[]  args  )

inline

Implements OpenSim.Region.Framework.Interfaces.ICommander.

Definition at line 142 of file Commander.cs.

void OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.RegisterCommand ( string  commandName, ICommand  command  )

inline

Implements OpenSim.Region.Framework.Interfaces.ICommander.

Definition at line 94 of file Commander.cs.

void OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.Run ( string  function, object[]  args  )

inline

Runs a specified function with attached arguments *** DO NOT CALL DIRECTLY. *** Call ProcessConsoleCommand instead if handling human input.

Parameters

function	The function name to call
args	The function parameters

Implements OpenSim.Region.Framework.Interfaces.ICommander.

Definition at line 137 of file Commander.cs.

Property Documentation

Dictionary<string, ICommand> OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.Commands

get

Definition at line 87 of file Commander.cs.

string OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.Help

get

Definition at line 57 of file Commander.cs.

string OpenSim.Region.CoreModules.Framework.InterfaceCommander.Commander.Name

get

Definition at line 51 of file Commander.cs.

---

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

• Region/CoreModules/Framework/InterfaceCommander/Commander.cs