ToolCommand Class Reference

Base class representing a Tool command. More...

#include <ToolCommand.hpp>

Inheritance diagram for ToolCommand:

Public Member Functions
std::string	GetCommandName ()
	Retrieves the name of the command. More...
std::string	GetSyntax ()
	Retrieves the syntax of the command. More...
std::string	GetDescription ()
	Retrieves the description of the command. More...
virtual int	execute (std::vector< std::string > args)
	Executes the command. More...

Protected Attributes
std::string	command = ""
	The name of the command. More...
std::string	syntax = ""
	The syntax of the command. This should include the command name, as well as any arguments. More...
std::string	description = ""
	A description of the command. More...

Detailed Description

Base class representing a Tool command.

Member Function Documentation

execute()

virtual int ToolCommand::execute ( std::vector< std::string >  args )

inlinevirtual

Executes the command.

Parameters

args	- A list of arguments provided to the command.

Returns

The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Reimplemented in GenerateGameStubProjectCommand, GenerateScriptProjectCommand, PrepareSurfaceShaderCommand, BuildCommand, MaterialCommand, BitmapsCommand, ParseScriptsCommand, RenderModelCommand, CompileShadersCommand, HelpCommand, SetProjectCommand, BulkImportModelFolderCommand, ExportTagClassCommand, CompileTagCommand, DecompileTagCommand, GUICommand, ChooseProjectCommand, ShadercCommand, and ListProjectsCommand.

Here is the caller graph for this function:

GetCommandName()

std::string ToolCommand::GetCommandName ( )

inline

Retrieves the name of the command.

Returns

The name of the command.

Here is the caller graph for this function:

GetDescription()

std::string ToolCommand::GetDescription ( )

inline

Retrieves the description of the command.

Returns

The description of the command.

Here is the caller graph for this function:

GetSyntax()

std::string ToolCommand::GetSyntax ( )

inline

Retrieves the syntax of the command.

Returns

The syntax of the command.

Here is the caller graph for this function:

Member Data Documentation

command

std::string ToolCommand::command = ""

protected

The name of the command.

description

std::string ToolCommand::description = ""

protected

A description of the command.

syntax

std::string ToolCommand::syntax = ""

protected

The syntax of the command. This should include the command name, as well as any arguments.

---

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

• HEKTool/components/console/ToolCommand.hpp