Blam::Console::ConsoleCommand Class Reference

Class used to represent a console command. More...

#include <console.h>

Inheritance diagram for Blam::Console::ConsoleCommand:

Public Member Functions
	ConsoleCommand ()
	Unused constructor. More...
	~ConsoleCommand ()
	Unused destructor. More...
virtual CommandStatus	onCommand (std::vector< std::string > arguments)
	Called upon command execution. More...

Public Attributes
std::string	name
	The name of the console command. More...
std::string	description
	An optional description of the command. Shown when using the classify command. More...
std::string	syntax
	The syntax information for the command. Shown to the user when using the help command with an argument. More...
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. More...
CommandType	type
	The type of command this is. See Blam::Console::CommandType for more information. More...

Detailed Description

Class used to represent a console command.

Constructor & Destructor Documentation

ConsoleCommand()

Blam::Console::ConsoleCommand::ConsoleCommand ( )

inline

Unused constructor.

~ConsoleCommand()

Blam::Console::ConsoleCommand::~ConsoleCommand ( )

inline

Unused destructor.

Member Function Documentation

onCommand()

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

inlinevirtual

Called upon command execution.

Parameters

arguments

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

Returns

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

Reimplemented in Blam::Console::VersionCommand, Blam::Console::ClassifyCommand, Blam::Console::Halo2HelpCommand, Blam::Console::PrintCommand, Blam::Console::CreateCommandObjectCommand, Blam::Console::ClearScreenCommand, Blam::Console::HelpCommand, Blam::Console::RegenDebugMenuCommand, Blam::Console::ResolutionCommand, Blam::Console::ShowStatsCommand, Blam::Console::CrashCommand, Blam::Console::GeneratePluginsCommand, Blam::Console::Halo2PrintCommand, Blam::Console::DXRenderTargetClearCommand, Blam::Console::HistoryCommand, Blam::Console::ListColorsCommand, Blam::Console::ListLevelsCommand, Blam::Console::NoUCommand, Blam::Console::QuitCommand, Blam::Console::ScriptDocCommand, Blam::Console::Win32DialogTestCommand, Blam::Console::AbortCommand, and Blam::Console::SentryTestCommand.

Member Data Documentation

aliases

std::vector<std::string> Blam::Console::ConsoleCommand::aliases

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

description

std::string Blam::Console::ConsoleCommand::description

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

name

std::string Blam::Console::ConsoleCommand::name

The name of the console command.

syntax

std::string Blam::Console::ConsoleCommand::syntax

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

type

CommandType Blam::Console::ConsoleCommand::type

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

---

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

• blam/components/ui/blam_old/console/console.h