Class representing a Plugin. More...

#include <tags.h>

Public Member Functions
	BlamPlugin (std::string _file_path)

	~BlamPlugin ()

BlamResult	LoadFromDisk ()
	Loads the plugin XML document from disk. More...

int	GetVersion ()
	Retrieves the current revision of the plugin. More...

BlamTag *	CreateNewTag ()
	Creates a new tag using the plugin. More...

BlamTag *	CreateNewTag (std::string filename)
	Creates a new tag using the plugin. More...

Public Attributes
std::string	class_name_long = ""
	The long class name. Ex: `scenario`. Can be any length. More...

std::string	class_name_short = ""
	The short class name. Ex: `scnr`. Must be 4 characters or fewer. More...

int	base_size = 0
	The base size of the tag. More...

std::vector< BlamRevision >	revisions = std::vector<BlamRevision>()
	The list of revisions contained within this plugin. More...

std::vector< BlamPluginField * >	fields = std::vector<BlamPluginField*>()
	The list of fields contained within this plugin. More...

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

bool	valid = true
	Whether or not the plugin was able to be loaded. More...

Detailed Description

Class representing a Plugin.

Plugins are XML files that contain tag layout information, additional non-data fields (such as comments), tooltips, and the needed information in order to compile a tag for use with the game engine. They are a concept created by the Halo modding community and are quite useful in this context as well.

Constructor & Destructor Documentation

◆ BlamPlugin()

BlamPlugin::BlamPlugin ( std::string _file_path )

◆ ~BlamPlugin()

BlamPlugin::~BlamPlugin ( )

Member Function Documentation

◆ CreateNewTag() [1/2]

BlamTag * BlamPlugin::CreateNewTag ( )

Creates a new tag using the plugin.

Returns: A pointer to the newly created tag.

◆ CreateNewTag() [2/2]

BlamTag * BlamPlugin::CreateNewTag ( std::string filename )

Creates a new tag using the plugin.

Parameters

filename - The new filename of the tag.

Returns: A pointer to the newly created tag.

◆ GetVersion()

int BlamPlugin::GetVersion ( )

Retrieves the current revision of the plugin.

Returns: The plugin version.

◆ LoadFromDisk()

BlamResult BlamPlugin::LoadFromDisk ( )

Loads the plugin XML document from disk.

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

Member Data Documentation

◆ base_size

int BlamPlugin::base_size = 0

The base size of the tag.

◆ class_name_long

std::string BlamPlugin::class_name_long = ""

The long class name. Ex: scenario. Can be any length.

◆ class_name_short

std::string BlamPlugin::class_name_short = ""

The short class name. Ex: scnr. Must be 4 characters or fewer.

◆ fields

std::vector<BlamPluginField*> BlamPlugin::fields = std::vector<BlamPluginField*>()

The list of fields contained within this plugin.

◆ file_path

std::string BlamPlugin::file_path = ""

The path to the plugin file.

◆ revisions

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

The list of revisions contained within this plugin.

◆ valid

bool BlamPlugin::valid = true

Whether or not the plugin was able to be loaded.

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

guerilla/components/tags/tags.h
guerilla/components/tags/BlamPlugin.cpp

Public Member Functions

Public Attributes