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

Class for the set-project command. More...

#include <SetProjectCommand.hpp>

+ Inheritance diagram for SetProjectCommand:
+ Collaboration diagram for SetProjectCommand:

Public Member Functions

 SetProjectCommand ()
 
int execute (std::vector< std::string > args)
 Executes the command. More...
 
- 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 set-project command.

This command creates a project path file in the Editing Kit directory, informing Tool to use different data/tags folders instead of the application directory.

Constructor & Destructor Documentation

◆ SetProjectCommand()

SetProjectCommand::SetProjectCommand ( )
inline

Member Function Documentation

◆ execute()

int SetProjectCommand::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.


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