Class representing a Blamite Project. More...

#include <projects.h>

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...

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...

bool	has_project_info = false
	Whether or not a `.blam` file exists within the directory. More...

std::string	project_name = "unnamed"
	The name of the project. More...

std::string	project_root = ""
	The root folder for the project. More...

std::string	content_root = "tags"
	The root folder containing project content. More...

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.

◆ ~BlamProject()

BlamProject::~BlamProject ( )

Member Function Documentation

◆ BuildTagHierarchy()

void BlamProject::BuildTagHierarchy ( )

Builds the tag hierarchy for the project.

Member Data Documentation

◆ content_root

std::string BlamProject::content_root = "tags"

The root folder containing project content.

◆ has_project_info

bool BlamProject::has_project_info = false

Whether or not a .blam file exists within the directory.

◆ 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.

Ensure that you check that has_project_info is set to true before use, as if that value is false then the project information file was unable to be loaded.

◆ project_load_result

bool BlamProject::project_load_result = false

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

◆ project_name

std::string BlamProject::project_name = "unnamed"

The name of the project.

◆ project_root

std::string BlamProject::project_root = ""

The root folder for the project.

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

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

Public Member Functions

Public Attributes