BlamConsoleCommand Struct Reference

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

#include <console.h>

Inheritance diagram for BlamConsoleCommand:

Public Member Functions
virtual BlamCommandResult	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...
BlamCommandType	type
	The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information. More...

Detailed Description

Class used to represent a console command.

Note

These should be deprecated and removed once BlamScript is introduced and functional. The way the console is intended to operate is that each 'command' is actually just a script function. Functionally, nothing should change - but the commands that exist should be brought over to be script functions instead, and should be usable both from the console, and from scripts.

Member Function Documentation

onCommand()

virtual BlamCommandResult BlamConsoleCommand::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 BlamCommandResult for details.

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

Member Data Documentation

aliases

std::vector<std::string> BlamConsoleCommand::aliases

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

description

std::string BlamConsoleCommand::description

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

name

std::string BlamConsoleCommand::name

The name of the console command.

syntax

std::string BlamConsoleCommand::syntax

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

type

BlamCommandType BlamConsoleCommand::type

The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information.

---

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

• blam/components/resources/console/console.h