Class representing a comment plugin field. More...

#include <comment.h>

Inheritance diagram for BlamPluginField_Comment:

Collaboration diagram for BlamPluginField_Comment:

Public Member Functions
	BlamPluginField_Comment (BlamPluginField *base_field)
	Constructs a new comment plugin field. More...

void	ParseCommentType (std::string comment_type_string)
	Attempts to parse the comment_type of the field from a string. More...

std::string	GenerateXMLString () override
	Generates a string representing this plugin field. More...

std::string	GenerateCppStructString (std::string line_prefix="", bool generate_doxygen_comments=true) override
	Generates a string containing C++ code representing this plugin field. More...

std::string	GenerateCppStructString (std::string line_prefix="", bool generate_doxygen_comments=true, bool include_description=false)

std::string	GenerateCppClassString (std::string line_prefix="") override
	Generates a string containing C++ code representing this plugin field. More...

bool	ParseXMLData (rapidxml::xml_node<> *field_node) override
	Populates data within the plugin field from an XML node. More...

BlamTagField *	GenerateTagField (BlamTag *tag) override
	Generates a new tag field from this plugin field. More...

Public Member Functions inherited from BlamPluginField
	BlamPluginField (BlamPlugin *_plugin, BlamTagFieldType _type)
	Constructs a new plugin field. More...

	BlamPluginField (BlamPluginField *_old_field)
	Constructs a new plugin field. More...

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

BlamPlugin *	GetPlugin ()
	Retrieves the plugin this field is associated with. More...

virtual BlamTagField *	GenerateTagField (BlamTagField *existing_tag_field)
	Generates a new tag field from this plugin field. More...

virtual BlamTagField *	GenerateTagField (BlamTag tag, void address)
	Generates a new tag field from this plugin field. More...

virtual void	UpdateOffsetData (int new_offset)
	Updates any offsets or lengths for the given field. More...

void	ChangeType (BlamTagFieldType new_type)
	Changes the type of a plugin field. More...

Public Attributes
BlamCommentType	comment_type = BlamCommentType::None
	The type of the comment. More...

Public Attributes inherited from BlamPluginField
int	offset = 0x0
	The offset of the field data. More...

int	length = 0x0
	The length of the field data. More...

bool	visible = true
	Whether or not the field is visible. More...

std::string	display_name = ""
	The display name of the field. More...

std::string	description = ""
	An optional description of the field. More...

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

std::string	input_hint = ""
	An additional piece of short text that can be used to suggest valid input for a field. More...

bool	require_unused_visible = false
	If enabled, this field will only be visible when "Show Unused Fields" is enabled. More...

std::string	default_value = ""
	The default text value for the field. More...

Detailed Description

Class representing a comment plugin field.

A comment field stores no data within a compiled tag. They only exist within plugin files as a way to include helpful information and documentation directly within the tag editor.

Constructor & Destructor Documentation

◆ BlamPluginField_Comment()

BlamPluginField_Comment::BlamPluginField_Comment ( BlamPluginField * base_field )

Constructs a new comment plugin field.

Parameters

base_field - The base plugin data to use for this field.

Member Function Documentation

◆ GenerateCppClassString()

std::string BlamPluginField_Comment::GenerateCppClassString ( std::string line_prefix = "" )

overridevirtual

Generates a string containing C++ code representing this plugin field.

This method will generate a string containing C++ code that is intended for use within the BlamTagClass class. This class is used by the game engine to store a tag class layout, allowing for in-engine tools to present a tag data editing UI among other things.

Parameters

line_prefix - A string that should be placed before each line, such as a certain amount of indentation spaces.

Returns: A string containing C++ code representing the field and its data.

Reimplemented from BlamPluginField.

◆ GenerateCppStructString() [1/2]

std::string BlamPluginField_Comment::GenerateCppStructString	(	std::string	line_prefix = `""`,
		bool	generate_doxygen_comments = `true`
	)

overridevirtual

Generates a string containing C++ code representing this plugin field.

This method will generate a string containing C++ code that is intended for use within the tag class data structure. This is intended to be used when exporting a tag class to C++ code.

Parameters

line_prefix - A string that should be placed before each line, such as a certain amount of indentation spaces.

Returns: A string containing C++ code representing the field and its data.

Reimplemented from BlamPluginField.

Here is the caller graph for this function:

◆ GenerateCppStructString() [2/2]

std::string BlamPluginField_Comment::GenerateCppStructString	(	std::string	line_prefix = `""`,
		bool	generate_doxygen_comments = `true`,
		bool	include_description = `false`
	)

◆ GenerateTagField()

BlamTagField * BlamPluginField_Comment::GenerateTagField ( BlamTag * tag )

overridevirtual

Generates a new tag field from this plugin field.

With this overload, a brand new tag field is created with no value.

Parameters

tag	- The tag the new field should belong to.

Returns: Pointer to the new tag field.

Reimplemented from BlamPluginField.

◆ GenerateXMLString()

std::string BlamPluginField_Comment::GenerateXMLString ( )

overridevirtual

Generates a string representing this plugin field.

Returns: An XML string containing the field ID and other attributes.

Reimplemented from BlamPluginField.

Here is the call graph for this function:

◆ ParseCommentType()

void BlamPluginField_Comment::ParseCommentType ( std::string comment_type_string )

Attempts to parse the comment_type of the field from a string.

Used when reading plugin data.

Parameters

comment_type_string - A string representing the comment type.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseXMLData()

bool BlamPluginField_Comment::ParseXMLData ( rapidxml::xml_node<> * field_node )

overridevirtual

Populates data within the plugin field from an XML node.

This is intended for use when loading a plugin from an XML document.

Parameters

field_node - Pointer to the XML node to parse plugin field data from.

Returns: true if all required field data was parsed, otherwise returns false. If this returns false, this field should be deleted and should NOT be added to the plugin - as this indicates an issue with the original plugin file.

Reimplemented from BlamPluginField.

Here is the call graph for this function:

Member Data Documentation

◆ comment_type

BlamCommentType BlamPluginField_Comment::comment_type = BlamCommentType::None

The type of the comment.

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

HEKGuerilla/components/tags/fields/comment/comment.h
HEKGuerilla/components/tags/fields/comment/BlamPluginField_Comment.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BlamPluginField_Comment()

Member Function Documentation

◆ GenerateCppClassString()

◆ GenerateCppStructString() [1/2]

◆ GenerateCppStructString() [2/2]

◆ GenerateTagField()

◆ GenerateXMLString()

◆ ParseCommentType()

◆ ParseXMLData()

Member Data Documentation

◆ comment_type