Class representing a plugin enum field. More...

#include <enum.h>

Inheritance diagram for BlamPluginField_Enum:

Public Member Functions
	BlamPluginField_Enum (BlamPluginField *base_field)
	Constructs a new block plugin field from an existing generic plugin field. More...

std::string	GenerateXMLString () override
	Generates a string representing 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 (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...

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

Public Attributes
std::vector< BlamEnumFieldOption >	options
	The list of options within the enum. 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 plugin enum field.

Enum fields allow for the selection of one of any number of preset values.

Plugin enum fields store all possible options within the enum.

Constructor & Destructor Documentation

BlamPluginField_Enum::BlamPluginField_Enum ( BlamPluginField * base_field )

Constructs a new block plugin field from an existing generic plugin field.

Parameters

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

std::string BlamPluginField_Enum::GenerateXMLString ( )

overridevirtual

Generates a string representing this plugin field.

Reimplemented from BlamPluginField.

std::vector<BlamEnumFieldOption> BlamPluginField_Enum::options

The list of options within the enum.

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