BlamPluginField Class Reference

Class representing a plugin field. More...

#include <fields.h>

Inheritance diagram for BlamPluginField:

Public Member Functions
	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
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 plugin field.

Plugin fields are used to store additional, non-data information related to a tag field. This information can include things display names, descriptions, and visibility. It also stores the offset and length of the data - which is required for tag compilation.

Constructor & Destructor Documentation

BlamPluginField() [1/2]

BlamPluginField::BlamPluginField	(	BlamPlugin *	_plugin,
		BlamTagFieldType	_type
	)

Constructs a new plugin field.

Parameters

_plugin	- The plugin this field should be associated with.
_type	- The type of the field.

BlamPluginField() [2/2]

BlamPluginField::BlamPluginField

(

BlamPluginField *

_old_field

)

Constructs a new plugin field.

Parameters

_old_field

- The old field to load data from. Becomes invalid after construction.

Member Function Documentation

GenerateTagField() [1/3]

BlamTagField * BlamPluginField::GenerateTagField ( BlamTag *  tag )

virtual

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.

GenerateTagField() [2/3]

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

virtual

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.

GenerateTagField() [3/3]

BlamTagField * BlamPluginField::GenerateTagField ( BlamTagField *  existing_tag_field )

virtual

Generates a new tag field from this plugin field.

With this overload, the tag field remains unchanged but has this plugin field assigned to it.

Parameters

existing_tag_field

- The existing tag field to associate this plugin field with.

Returns

Pointer to the new tag field. Will be identical to existing_tag_field.

GetPlugin()

BlamPlugin * BlamPluginField::GetPlugin

(

)

Retrieves the plugin this field is associated with.

Returns

A pointer to the plugin associated with this field.

GetType()

BlamTagFieldType BlamPluginField::GetType

(

)

Retrieves the type of this field.

See BlamTagFieldType for details.

Returns

The type of this field.

Member Data Documentation

description

std::string BlamPluginField::description = ""

An optional description of the field.

display_name

std::string BlamPluginField::display_name = ""

The display name of the field.

field_id

std::string BlamPluginField::field_id = ""

The ID of the field.

input_hint

std::string BlamPluginField::input_hint = ""

An additional piece of short text that can be used to suggest valid input for a field.

length

int BlamPluginField::length = 0x0

The length of the field data.

offset

int BlamPluginField::offset = 0x0

The offset of the field data.

require_unused_visible

bool BlamPluginField::require_unused_visible = false

If enabled, this field will only be visible when "Show Unused Fields" is enabled.

visible

bool BlamPluginField::visible = true

Whether or not the field is visible.

---

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

• HEKGuerilla/components/tags/fields/fields.h
• HEKGuerilla/components/tags/fields/BlamPluginField.cpp