BlamProject Class Reference

Class representing a Blamite Project. More...

#include <projects.h>

Collaboration diagram for BlamProject:

Public Member Functions
	BlamProject (std::string file_path)
	Initializes and loads an existing project. More...
	~BlamProject ()
void	BuildTagHierarchy ()
	Builds the tag hierarchy for the project. More...
std::string	GetContentRoot ()
std::string	GetTagsRoot ()
std::string	GetMoviesRoot ()
std::string	GetDataRoot ()
std::string	GetCacheRoot ()
std::string	GetPluginsRoot ()
std::string	GetFontsRoot ()
std::string	GetVcxprojPath ()
std::string	GetMSBuildPath ()
std::string	GetEngineDependenciesPath ()
BlamProjectInfo	GetProjectInfoForEngine ()

Public Attributes
BlamTagTreeNode *	hierarchy_root = nullptr
	The root node for the project's tag hierarchy. More...
BlamProjectInfo	project_info
	The project information file contents. More...
bool	project_load_result = false
	Whether or not the project directory exists and is ready for use. More...
BlamProjectInfo	project_info_user

Detailed Description

Class representing a Blamite Project.

Projects can be used with or without a project information file. In the absence of a project information file (*.blam), then some features which rely on one will not be functional. Instead, the project acts as purely a content directory for tag usage within the classic editing tools, such as Sapien or Guerilla.

Constructor & Destructor Documentation

BlamProject()

BlamProject::BlamProject

(

std::string

file_path

)

Initializes and loads an existing project.

Parameters

file_path

- The path to the project directory.

Here is the call graph for this function:

~BlamProject()

BlamProject::~BlamProject

(

)

Member Function Documentation

BuildTagHierarchy()

void BlamProject::BuildTagHierarchy

(

)

Builds the tag hierarchy for the project.

Here is the call graph for this function:

Here is the caller graph for this function:

GetCacheRoot()

std::string BlamProject::GetCacheRoot

(

)

Here is the caller graph for this function:

GetContentRoot()

std::string BlamProject::GetContentRoot

(

)

Here is the caller graph for this function:

GetDataRoot()

std::string BlamProject::GetDataRoot

(

)

Here is the caller graph for this function:

GetEngineDependenciesPath()

std::string BlamProject::GetEngineDependenciesPath

(

)

GetFontsRoot()

std::string BlamProject::GetFontsRoot

(

)

Here is the caller graph for this function:

GetMoviesRoot()

std::string BlamProject::GetMoviesRoot

(

)

Here is the caller graph for this function:

GetMSBuildPath()

std::string BlamProject::GetMSBuildPath

(

)

GetPluginsRoot()

std::string BlamProject::GetPluginsRoot

(

)

Here is the caller graph for this function:

GetProjectInfoForEngine()

BlamProjectInfo BlamProject::GetProjectInfoForEngine

(

)

Here is the call graph for this function:

GetTagsRoot()

std::string BlamProject::GetTagsRoot

(

)

Here is the caller graph for this function:

GetVcxprojPath()

std::string BlamProject::GetVcxprojPath

(

)

Member Data Documentation

hierarchy_root

BlamTagTreeNode* BlamProject::hierarchy_root = nullptr

The root node for the project's tag hierarchy.

project_info

BlamProjectInfo BlamProject::project_info

The project information file contents.

project_info_user

BlamProjectInfo BlamProject::project_info_user

project_load_result

bool BlamProject::project_load_result = false

Whether or not the project directory exists and is ready for use.

---

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

• HEKGuerilla/components/projects/projects.h
• HEKGuerilla/components/projects/BlamProject.cpp