Drag[en]gine Script Module DragonScript Script API  1.0
ConsoleCommand Class Reference

Console command. More...

Inheritance diagram for ConsoleCommand:
AISysConsoleCommand GraSysConsoleCommand PhySysConsoleCommand

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 execute ( Console  console,
Array  params 
)

Execute command.

Default implementation prints syntax to console.

Parameters
consoleConsole to send output to.
paramsList of parameters. Has to match command syntax.

§ getDescription()

String getDescription ( )

Description to display to user.

§ getName()

String getName ( )

Unique name of command.

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

§ getSyntax()

String getSyntax ( )

Command syntax.

§ new()

ConsoleCommand new ( )

Create console command.

§ setDescription()

void setDescription ( String  description)

Set description to display to user.

§ setName()

void setName ( String  name)

Set unique name of command.

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

§ setSyntax()

void setSyntax ( String  syntax)

Set command syntax.


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