BlamConsoleCommand Struct Reference

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

#include <console.h>

Inheritance diagram for BlamConsoleCommand:

Public Member Functions
virtual BlamResult	Execute (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.

Todo:

Migrate all console command function contents to separate API functions, with these simply being proxy objects for those.

Member Function Documentation

Execute()

virtual BlamResult BlamConsoleCommand::Execute ( 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 #BlamResult for details.

Reimplemented in Blam::Resources::Console::ListLevelsCommand, Blam::Resources::Console::SetProjectRootCommand, Blam::Resources::Console::DropCommand, Blam::Resources::Console::Halo2HelpCommand, Blam::Resources::Console::ExploreCommand, Blam::Resources::Console::MapNameCommand, Blam::Resources::Console::TagLoadForceCommand, Blam::Resources::Console::VersionCommand, Blam::Resources::Console::ListenerBugCheckCommand, Blam::Resources::Console::PrintCommand, Blam::Resources::Console::TagLoadCommand, Blam::Resources::Console::ClearScreenCommand, Blam::Resources::Console::CreateCommandObjectCommand, Blam::Resources::Console::RegenDebugMenuCommand, Blam::Resources::Console::DXRenderTargetClearCommand, Blam::Resources::Console::ReloadMaterialDatablocksCommand, Blam::Resources::Console::RenderModelPerformanceTestCommand, Blam::Resources::Console::ResolutionCommand, Blam::Resources::Console::HelpCommand, Blam::Resources::Console::ListColorsCommand, Blam::Resources::Console::OpenWebURLCommand, Blam::Resources::Console::ShowStatsCommand, Blam::Resources::Console::CrashCommand, Blam::Resources::Console::GeneratePluginsCommand, Blam::Resources::Console::Halo2PrintCommand, Blam::Resources::Console::TagFieldSizesCommand, Blam::Resources::Console::ClassifyCommand, Blam::Resources::Console::DebugMenuHowToCommand, Blam::Resources::Console::InitWorldStateCommand, Blam::Resources::Console::LogCommand, Blam::Resources::Console::NoUCommand, Blam::Resources::Console::OpenGameDirectoryCommand, Blam::Resources::Console::QuitCommand, Blam::Resources::Console::ScreenshotCommand, Blam::Resources::Console::ScriptDocCommand, Blam::Resources::Console::ToggleImguiWindowCommand, Blam::Resources::Console::ViewportModeCommand, Blam::Resources::Console::Win32DialogTestCommand, Blam::Resources::Console::HistoryCommand, Blam::Resources::Console::AbortCommand, Blam::Resources::Console::SentryTestCommand, Blam::Resources::Console::WriteDebugInfoCommand, Blam::Resources::Console::SetCameraCommand, Blam::Resources::Console::ReloadShaderCommand, and Blam::Resources::Console::FindCommand.

Here is the caller graph for this function:

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/api/v1/types/console.h