Class representing an ascii plugin field. More...

#include <ascii.h>

Inheritance diagram for BlamPluginField_Ascii:

Collaboration diagram for BlamPluginField_Ascii:

Public Member Functions
	BlamPluginField_Ascii (BlamPluginField *base_field)

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

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

BlamTagField *	GenerateTagField (BlamTag tag, void address) override
	Generates a new tag field from this plugin field. 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 std::string	GenerateXMLString ()
	Generates a string representing this plugin field. More...

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

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

Additional Inherited Members
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 an ascii plugin field.

An ascii field stores a string of text, and will always be 128 bytes long.

Constructor & Destructor Documentation

◆ BlamPluginField_Ascii()

BlamPluginField_Ascii::BlamPluginField_Ascii ( BlamPluginField * base_field )

Member Function Documentation

◆ GenerateCppClassString()

std::string BlamPluginField_Ascii::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()

std::string BlamPluginField_Ascii::GenerateCppStructString ( 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 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.

◆ GenerateTagField() [1/2]

BlamTagField * BlamPluginField_Ascii::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.

◆ GenerateTagField() [2/2]

BlamTagField * BlamPluginField_Ascii::GenerateTagField	(	BlamTag *	tag,
		void *	address
	)

overridevirtual

Generates a new tag field from this plugin field.

With this overload, a new field is created and its value(s) are read from the tag data. This should only be used when reading binary (compiled) tag files.

Parameters

tag	- The tag the new field should belong to.
address	- The address of the field value.

Returns: Pointer to the new tag field.

Reimplemented from BlamPluginField.

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

HEKGuerilla/components/tags/fields/ascii/ascii.h
HEKGuerilla/components/tags/fields/ascii/BlamPluginField_Ascii.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlamPluginField_Ascii()

Member Function Documentation

◆ GenerateCppClassString()

◆ GenerateCppStructString()

◆ GenerateTagField() [1/2]

◆ GenerateTagField() [2/2]