Dragengine.Commands.ConsoleCommand Class Reference

Console command. More...

Inheritance diagram for Dragengine.Commands.ConsoleCommand:

Public Member Functions
void	execute (Console console, Array params)
	Execute command. More...
String	getDescription ()
	Description to display to user. More...
String	getName ()
	Unique name of command. More...
String	getSyntax ()
	Command syntax. More...
ConsoleCommand	new ()
	Create console command. More...
void	setDescription (String description)
void	setName (String name)
	Set unique name of command. More...
void	setSyntax (String syntax)
	Set command syntax. More...

Detailed Description

Console command.

Console commands are special commands taking parameters. They supposed to be used with a game console window or panel where the user can specify these parameters. These commands can not be bound to input events directly except using a wrapper.

Member Function Documentation

execute()

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

Execute command.

Default implementation prints syntax to console.

Parameters

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

Reimplemented in Dragengine.Commands.SystemConsoleCommand, Dragengine.Commands.ScriptModuleStatsConsoleCommand, Dragengine.Commands.LanguageConsoleCommand, Dragengine.Commands.HelpConsoleCommand, and Dragengine.Commands.GraSysConsoleCommand.

getDescription()

String Dragengine.Commands.ConsoleCommand.getDescription

(

)

Description to display to user.

getName()

String Dragengine.Commands.ConsoleCommand.getName

(

)

Unique name of command.

Allowed are upper and lower case letters, numbers and underscore.

getSyntax()

String Dragengine.Commands.ConsoleCommand.getSyntax

(

)

Command syntax.

new()

ConsoleCommand Dragengine.Commands.ConsoleCommand.new

(

)

Create console command.

Reimplemented in Dragengine.Commands.SynthSysConsoleCommand, Dragengine.Commands.ScrSysConsoleCommand, Dragengine.Commands.ScriptModuleStatsConsoleCommand, Dragengine.Commands.PhySysConsoleCommand, Dragengine.Commands.NetSysConsoleCommand, Dragengine.Commands.InpSysConsoleCommand, Dragengine.Commands.GraSysConsoleCommand, Dragengine.Commands.CRSysConsoleCommand, Dragengine.Commands.AudSysConsoleCommand, Dragengine.Commands.AmrSysConsoleCommand, and Dragengine.Commands.AISysConsoleCommand.

setDescription()

void Dragengine.Commands.ConsoleCommand.setDescription

(

String

description

)

Set description to display to user.

setName()

void Dragengine.Commands.ConsoleCommand.setName

(

String

name

)

Set unique name of command.

Allowed are upper and lower case letters, numbers and underscore.

setSyntax()

void Dragengine.Commands.ConsoleCommand.setSyntax

(

String

syntax

)

Set command syntax.

---

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

• ConsoleCommand.ds