Dragengine.Commands.HelpConsoleCommand Class Reference

Console command showing information about commands. More...

Inheritance diagram for Dragengine.Commands.HelpConsoleCommand:

Public Member Functions
void	execute (Console console, Array params)
	Execute command.
CommandManager	getCommandManager ()
	Command manager.
ConsoleCommandList	getConsoleCommands ()
	Console command list.
HelpConsoleCommand	new (ConsoleCommandList consoleCommands, CommandManager commandManager)
	Create console command.
void	setCommandManager (CommandManager commandManager)
	Set command manager.
void	setConsoleCommands (ConsoleCommandList consoleCommands)
	Set console command list.
Public Member Functions inherited from Dragengine.Commands.ConsoleCommand
String	getDescription ()
	Description to display to user.
String	getName ()
	Unique name of command.
String	getSyntax ()
	Command syntax.
ConsoleCommand	new ()
	Create console command.
void	setDescription (String description)
void	setName (String name)
	Set unique name of command.
void	setSyntax (String syntax)
	Set command syntax.

Detailed Description

Console command showing information about commands.

Displays either all supported commands or detailed information about a specific command.

Member Function Documentation

execute()

void Dragengine.Commands.HelpConsoleCommand.execute	(	Console	console,
		Array	params
	)

Execute command.

Parameters

console	Console to send output to.
params	List of parameters. Has to match command syntax.

Reimplemented from Dragengine.Commands.ConsoleCommand.

getCommandManager()

CommandManager Dragengine.Commands.HelpConsoleCommand.getCommandManager

(

)

Command manager.

getConsoleCommands()

ConsoleCommandList Dragengine.Commands.HelpConsoleCommand.getConsoleCommands

(

)

Console command list.

new()

HelpConsoleCommand Dragengine.Commands.HelpConsoleCommand.new	(	ConsoleCommandList	consoleCommands,
		CommandManager	commandManager
	)

Create console command.

Both consoleCommands and commandManager can be null.

setCommandManager()

void Dragengine.Commands.HelpConsoleCommand.setCommandManager

(

CommandManager

commandManager

)

Set command manager.

setConsoleCommands()

void Dragengine.Commands.HelpConsoleCommand.setConsoleCommands

(

ConsoleCommandList

consoleCommands

)

Set console command list.

---

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

• HelpConsoleCommand.ds