Class for the help command. More...

#include <help.hpp>

Inheritance diagram for Blam::Console::HelpCommand:

Public Member Functions
	HelpCommand ()

	~HelpCommand ()

CommandStatus	onCommand (std::vector< std::string > arguments)
	Called upon command execution. More...

Public Member Functions inherited from Blam::Console::ConsoleCommand
	ConsoleCommand ()
	Unused constructor. More...

	~ConsoleCommand ()
	Unused destructor. More...

Additional Inherited Members
Public Attributes inherited from Blam::Console::ConsoleCommand
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 for the help command.

This command shows a list of all commands. It was setup to mimic the result you get when pressing TAB in the console in Halo CE and Halo 2's console. In the future, it should be modified to be more of a useful help command - with the tab command showing command names as it did using a separate function.

Constructor & Destructor Documentation

◆ HelpCommand()

Blam::Console::HelpCommand::HelpCommand ( )

inline

◆ ~HelpCommand()

Blam::Console::HelpCommand::~HelpCommand ( )

inline

Member Function Documentation

◆ onCommand()

CommandStatus Blam::Console::HelpCommand::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 from Blam::Console::ConsoleCommand.

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

blam/components/ui/blam_old/console/commands/help.hpp