Class representing a data reference, or dataref for short. More...

#include <dataref.h>

Inheritance diagram for DataReferenceField:

Collaboration diagram for DataReferenceField:

Public Member Functions
	DataReferenceField (std::string _display_name, std::string _extra_info)

std::string	GetFieldXMLString (int offset)
	Generates a string representing an XML node associated with this tag field, used for generating plugin files. More...

void	ShowImPropertyControl ()
	Shows a set of ImGUI controls representing the tag field. More...

Public Member Functions inherited from BlamTagClassField
	BlamTagClassField (BlamTagFieldType _type, std::string _display_name, std::string _extra_info)

	BlamTagClassField (BlamTagFieldType _type, std::string _display_name, std::string _extra_info, std::string _valid_input_label)

virtual void	SetMemoryLocation (void *new_address)
	Sets the address of the data that the plugin field should display. More...

Additional Inherited Members
Public Attributes inherited from BlamTagClassField
std::string	display_name
	The display name of the tag field. More...

std::string	extra_info
	Additional information to show alongside the field. More...

std::string	input_hint
	A label specifying possible valid input. Not always shown. More...

bool	visible = true
	Whether or not this field should be marked as visible within the editor. More...

void *	read_address
	The address of the data the field is currently representing. More...

int	read_length
	How many bytes to read from the start of the address. More...

BlamTagFieldType	type
	The type of the field. More...

Detailed Description

Class representing a data reference, or dataref for short.

Data references allow for tags to store variable-sized, arbitrary data. This data can be anything from a string of text, audio data, or anything else that requires the storage of generic data within a tag.

Constructor & Destructor Documentation

◆ DataReferenceField()

DataReferenceField::DataReferenceField	(	std::string	_display_name,
		std::string	_extra_info
	)

Member Function Documentation

◆ GetFieldXMLString()

std::string DataReferenceField::GetFieldXMLString ( int offset )

virtual

Generates a string representing an XML node associated with this tag field, used for generating plugin files.

If this function is not overridden in the child class, the resulting string describes an unknown tag field.

Parameters

offset - The offset of this field relative to either the start of the tag data, or relative to the start of tag block entry data.

Returns: A string representation of the field, ready to be written to an XML file.

Reimplemented from BlamTagClassField.

◆ ShowImPropertyControl()

void DataReferenceField::ShowImPropertyControl ( )

virtual

Shows a set of ImGUI controls representing the tag field.

If this function is not overridden in the child class, a warning message is displayed instead.

Reimplemented from BlamTagClassField.

Here is the call graph for this function:

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

blam/api/v1/types/plugins/fields/dataref/dataref.h
blam/api/v1/types/plugins/fields/dataref/dataref.cpp