Class representing a tag field. More...

#include <fields.h>

Inheritance diagram for BlamTagField:

Public Member Functions
	BlamTagField (BlamTag *_tag, BlamTagFieldType _type)
	Constructs a new tag field. More...

virtual std::string	GenerateXMLString ()
	Generates a string with the field ID and value, ready to be written to an XML file. More...

virtual std::vector< char >	GetValueAsBytes ()
	Retrieves the field value as a list of bytes. More...

BlamTagFieldType	GetType ()
	Retrieves the type of this field. More...

BlamTag *	GetTag ()
	Retrieves the tag associated with this field. More...

BlamPluginField *	GetPluginField ()
	Retrieves the plugin data associated with this field, if available. More...

bool	HasPluginField ()
	Checks whether the field has plugin data available. More...

Public Attributes
BlamPluginField *	plugin_field = nullptr
	The plugin data associated with this field, if any. More...

std::string	field_id = ""
	The ID of this field. More...

Detailed Description

Class representing a tag field.

Tag fields only store a field ID and value. This class is intended to be used as an interface, in that storing the field value is entirely up to the child class which inherits this class.

Constructor & Destructor Documentation

◆ BlamTagField()

BlamTagField::BlamTagField	(	BlamTag *	_tag,
		BlamTagFieldType	_type
	)

Constructs a new tag field.

Parameters

_tag	- The tag to associate with this field.
_type	- The type of the field.

Member Function Documentation

◆ GenerateXMLString()

std::string BlamTagField::GenerateXMLString ( )

virtual

Generates a string with the field ID and value, ready to be written to an XML file.

Returns: An XML string containing the field ID and value.

Reimplemented in BlamTagField_Block, BlamTagField_Bitfield, BlamTagField_Enum, BlamTagField_Comment, BlamTagField_Tagref, BlamTagField_Ascii, BlamTagField_Int, BlamTagField_Float32, and BlamTagField_Dataref.

◆ GetPluginField()

BlamPluginField * BlamTagField::GetPluginField ( )

Retrieves the plugin data associated with this field, if available.

Returns: Pointer to the plugin data for the field if available. If no plugin data is available, nullptr is returned.

◆ GetTag()

BlamTag * BlamTagField::GetTag ( )

Retrieves the tag associated with this field.

Returns: Pointer to the tag associated with this field.

◆ GetType()

BlamTagFieldType BlamTagField::GetType ( )

Retrieves the type of this field.

Returns: The type of this field.

◆ GetValueAsBytes()

std::vector< char > BlamTagField::GetValueAsBytes ( )

virtual

Retrieves the field value as a list of bytes.

Returns: The field value as a list of bytes.

Reimplemented in BlamTagField_Block, BlamTagField_Bitfield, BlamTagField_Enum, BlamTagField_Comment, BlamTagField_Tagref, BlamTagField_Ascii, BlamTagField_Int, BlamTagField_Float32, and BlamTagField_Dataref.

◆ HasPluginField()

bool BlamTagField::HasPluginField ( )

Checks whether the field has plugin data available.

Returns: true if the field has plugin data available, otherwise returns false.

Member Data Documentation

◆ field_id

std::string BlamTagField::field_id = ""

The ID of this field.

◆ plugin_field

BlamPluginField* BlamTagField::plugin_field = nullptr

The plugin data associated with this field, if any.

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

HEKGuerilla/components/tags/fields/fields.h
HEKGuerilla/components/tags/fields/BlamTagField.cpp

Public Member Functions

Public Attributes