Elaztek Developer Hub
Blamite Game Engine - Tool (Library)
A command-line utility that aids in the creation of Blamite Cache (.map) Files.
BuildCommand Class Reference

Class for the build command. More...

#include <BuildCommand.hpp>

+ Inheritance diagram for BuildCommand:
+ Collaboration diagram for BuildCommand:

Public Member Functions

 BuildCommand ()
 
int execute (std::vector< std::string > args)
 Executes the command. More...
 
bool GenerateProjectInfoSourceFile (BlamProject *project_info, std::string output_file, bool use_project_dirs, std::string project_root)
 
- Public Member Functions inherited from ToolCommand
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...
 

Additional Inherited Members

- Protected Attributes inherited from ToolCommand
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

Class for the build command.

Todo:
document

Constructor & Destructor Documentation

◆ BuildCommand()

BuildCommand::BuildCommand ( )
inline

Member Function Documentation

◆ execute()

int BuildCommand::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 from ToolCommand.

+ Here is the call graph for this function:

◆ GenerateProjectInfoSourceFile()

bool BuildCommand::GenerateProjectInfoSourceFile ( BlamProject *  project_info,
std::string  output_file,
bool  use_project_dirs,
std::string  project_root 
)
inline

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