Class representing a Tag. More...

#include <tags.h>

Public Member Functions
	BlamTag (std::string _file_path, bool require_same_version)
	Prepares a new tag to be loaded. More...

	~BlamTag ()
	Releases any data used by the tag by calling ReleaseFieldData. More...

BlamResult	LoadFromDisk ()
	Loads the tag as an XML document from disk. More...

void	SaveToDisk (std::string file_path)
	Saves any modifications to the XML tag back to disk. More...

void	ReleaseFieldData ()
	Releases all items in fields. More...

bool	LocatePlugin ()
	Attempts to locate a compatiable plugin for a given tag. More...

Public Attributes
BlamPlugin *	plugin = nullptr
	Pointer to the plugin associated with this tag. More...

std::vector< BlamRevision >	revisions = std::vector<BlamRevision>()
	The list of revisions within the tag. More...

std::vector< BlamTagField * >	fields = std::vector<BlamTagField*>()
	The list of fields within the tag. More...

std::string	file_path = ""
	The path to the tag file. More...

BlamTagTreeNode *	tree_node = nullptr
	The tree node within the hierarchy that this tag belongs to. More...

int	class_version = -1
	The class/plugin version of the tag. More...

std::string	class_name = ""
	The class name as specified in the tag file. Used in the event a plugin could not be found. More...

int	fieldset_version = 0
	The fieldset version of the tag. Used when decompiling binary tags. More...

std::string	engine_version = ""
	The engine version that was used to create the tag. Used when decompiling binary tags. More...

bool	require_matching_plugin_version = false
	Whether or not an exact plugin version is required to load the tag. More...

Detailed Description

Class representing a Tag.

Tags can be in one of two formats:

Binary - Binary tags contain the raw tag data, similar to how the data would be stored within a Cache File. They do not store any layout information, and as such cannot be opened or modified without a compatiable plugin.
XML - XML tags store the tag data in an XML document, which also contains revision history and the tag structure. This is the default format that should be used during development as it is easier to track tag changes, and is more resilient to tag layout changes.

Constructor & Destructor Documentation

◆ BlamTag()

BlamTag::BlamTag	(	std::string	_file_path,
		bool	require_same_version
	)

Prepares a new tag to be loaded.

Note: This does NOT load the tag from disk. You must call LoadFromDisk or #Decompile in order to load data from disk.

Parameters

_file_path	- The path to the tag file.
require_same_version	- Whether or not the tag must be loaded with the exact matching plugin version.

◆ ~BlamTag()

BlamTag::~BlamTag ( )

Releases any data used by the tag by calling ReleaseFieldData.

Member Function Documentation

◆ LoadFromDisk()

BlamResult BlamTag::LoadFromDisk ( )

Loads the tag as an XML document from disk.

Returns: #BlamResult::Success_OK if the tag was loaded successfully, otherwise returns an error code.

◆ LocatePlugin()

bool BlamTag::LocatePlugin ( )

Attempts to locate a compatiable plugin for a given tag.

Returns: true if a plugin was found, otherwise returns false.

◆ ReleaseFieldData()

void BlamTag::ReleaseFieldData ( )

Releases all items in fields.

This will both clear the list and free any memory used by the items within the list. After this is called, any references to the fields within the tag become invalid.

◆ SaveToDisk()

void BlamTag::SaveToDisk ( std::string file_path )

Saves any modifications to the XML tag back to disk.

Parameters

file_path - The path to the resulting tag file.

Member Data Documentation

◆ class_name

std::string BlamTag::class_name = ""

The class name as specified in the tag file. Used in the event a plugin could not be found.

◆ class_version

int BlamTag::class_version = -1

The class/plugin version of the tag.

◆ engine_version

std::string BlamTag::engine_version = ""

The engine version that was used to create the tag. Used when decompiling binary tags.

◆ fields

std::vector<BlamTagField*> BlamTag::fields = std::vector<BlamTagField*>()

The list of fields within the tag.

◆ fieldset_version

int BlamTag::fieldset_version = 0

The fieldset version of the tag. Used when decompiling binary tags.

◆ file_path

std::string BlamTag::file_path = ""

The path to the tag file.

◆ plugin

BlamPlugin* BlamTag::plugin = nullptr

Pointer to the plugin associated with this tag.

◆ require_matching_plugin_version

bool BlamTag::require_matching_plugin_version = false

Whether or not an exact plugin version is required to load the tag.

◆ revisions

std::vector<BlamRevision> BlamTag::revisions = std::vector<BlamRevision>()

The list of revisions within the tag.

◆ tree_node

BlamTagTreeNode* BlamTag::tree_node = nullptr

The tree node within the hierarchy that this tag belongs to.

Will be nullptr if the tag was opened outside of the context of a project.

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

HEKGuerilla/components/tags/tags.h
HEKGuerilla/components/tags/BlamTag.cpp

Public Member Functions

Public Attributes