Class representing a comment plugin field. More...

#include <comment.h>

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

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 (BlamTag *tag)
	Generates a new tag field from this plugin field. 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...

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

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

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

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