Class ConsoleCommand

• Defined in File console.h

Inheritance Relationships

Derived Types

• public Blam::Console::ClassifyCommand (Class ClassifyCommand)

• public Blam::Console::ClearScreenCommand (Class ClearScreenCommand)

• public Blam::Console::CrashCommand (Class CrashCommand)

• public Blam::Console::CreateCommandObjectCommand (Class CreateCommandObjectCommand)

• public Blam::Console::DXRenderTargetClearCommand (Class DXRenderTargetClearCommand)

• public Blam::Console::Halo2HelpCommand (Class Halo2HelpCommand)

• public Blam::Console::Halo2PrintCommand (Class Halo2PrintCommand)

• public Blam::Console::HelpCommand (Class HelpCommand)

• public Blam::Console::HistoryCommand (Class HistoryCommand)

• public Blam::Console::ListColorsCommand (Class ListColorsCommand)

• public Blam::Console::ListLevelsCommand (Class ListLevelsCommand)

• public Blam::Console::NoUCommand (Class NoUCommand)

• public Blam::Console::PrintCommand (Class PrintCommand)

• public Blam::Console::QuitCommand (Class QuitCommand)

• public Blam::Console::RegenDebugMenuCommand (Class RegenDebugMenuCommand)

• public Blam::Console::ResolutionCommand (Class ResolutionCommand)

• public Blam::Console::ScriptDocCommand (Class ScriptDocCommand)

• public Blam::Console::ShowStatsCommand (Class ShowStatsCommand)

• public Blam::Console::VersionCommand (Class VersionCommand)

• public Blam::Console::Win32DialogTestCommand (Class Win32DialogTestCommand)

Class Documentation

class ConsoleCommand

Class used to represent a console command.

Subclassed by Blam::Console::ClassifyCommand, Blam::Console::ClearScreenCommand, Blam::Console::CrashCommand, Blam::Console::CreateCommandObjectCommand, Blam::Console::DXRenderTargetClearCommand, Blam::Console::Halo2HelpCommand, Blam::Console::Halo2PrintCommand, Blam::Console::HelpCommand, Blam::Console::HistoryCommand, Blam::Console::ListColorsCommand, Blam::Console::ListLevelsCommand, Blam::Console::NoUCommand, Blam::Console::PrintCommand, Blam::Console::QuitCommand, Blam::Console::RegenDebugMenuCommand, Blam::Console::ResolutionCommand, Blam::Console::ScriptDocCommand, Blam::Console::ShowStatsCommand, Blam::Console::VersionCommand, Blam::Console::Win32DialogTestCommand

Public Functions

ConsoleCommand()

Unused constructor.

~ConsoleCommand()

Unused destructor.

virtual CommandStatus onCommand(std::vector<std::string> arguments)

Called upon command execution.

Return

The status of the command execution. See Blam::Console::CommandStatus for details.

Parameters

• arguments: - The list of arguments passed to the command. Any space character in the command line is treated as a new argument.

Public Members

std::string name

The name of the console command.

std::string description

An optional description of the command. Shown when using the classify command.

std::string syntax

The syntax information for the command. Shown to the user when using the help command with an argument.

std::vector<std::string> aliases

A list of aliases for the command. Executing any of these instead of the command name will behave the same.

CommandType type

The type of command this is. See Blam::Console::CommandType for more information.