Drag[en]gine Script Module DragonScript Script API  1.0
CommandManager Class Reference
Inheritance diagram for CommandManager:

Public Member Functions

void addCommand (Command command)
 
Command getCommand (int index)
 
Command getCommand (String name)
 
int getCount ()
 
bool includesCommand (String name)
 
CommandManager new ()
 
void removeAllCommands ()
 
void removeCommand (Command command)
 

Static Public Member Functions

static bool isValidName (String name)
 

Detailed Description

Manages Game Commands.

Member Function Documentation

§ addCommand()

void addCommand ( Command  command)

Adds a Command.

Parameters
commandCommand to add

§ getCommand() [1/2]

Command getCommand ( int  index)

Retrieves indexed command

Parameters
indexIndex of command
Returns
the command at index

§ getCommand() [2/2]

Command getCommand ( String  name)

Retrieves the named command

Parameters
nameName of command
Returns
the named command or null if not found

§ getCount()

int getCount ( )

Retrieves the count of commands.

Returns
count of commands

§ includesCommand()

bool includesCommand ( String  name)

Determines if the named command exists.

Parameters
nameName of command
Returns
True if the named command exists

§ isValidName()

static bool isValidName ( String  name)
static

Determines if a command name is valid.

Parameters
nameCommand Name to check
Returns
True if the command name is valid

§ new()

CommandManager new ( )

Creates a new CommandManager Object

§ removeAllCommands()

void removeAllCommands ( )

Removes all commands.

§ removeCommand()

void removeCommand ( Command  command)

Removes a Command

Parameters
commandCommand to remove

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