BlockField Class Reference

Class representing a tag block field, also sometimes referred to as a struct or reflexive in the modding community. More...

#include <block.h>

Inheritance diagram for BlockField:

Public Member Functions
	BlockField (int _entry_size, std::string _display_name, std::string _extra_info, std::vector< BlamPluginField * > _block_template)
void	SetMemoryLocation (void *new_address)
	Sets the address of the data that the plugin field should display. More...
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 BlamPluginField
	BlamPluginField (BlamPluginFieldType _type, std::string _display_name, std::string _extra_info)

Public Attributes
std::vector< BlamPluginField * >	block_template
	The list of block entries in this block. More...
int	active_entry = 0
	The index of the active entry. More...
tag_block< void > *	block_info
	Pointer to the current block info being represented. More...
int	entry_size = 0
	The size of each block entry. More...
Public Attributes inherited from BlamPluginField
std::string	display_name
	The display name of the tag field. More...
std::string	extra_info
	Additional information to show alongside the field. 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...
BlamPluginFieldType	type
	The type of the field. More...

Detailed Description

Class representing a tag block field, also sometimes referred to as a struct or reflexive in the modding community.

Tag blocks act much like a tag in that they store a set of child properties.

Constructor & Destructor Documentation

BlockField()

BlockField::BlockField	(	int	_entry_size,
		std::string	_display_name,
		std::string	_extra_info,
		std::vector< BlamPluginField * >	_block_template
	)

Member Function Documentation

GetFieldXMLString()

std::string BlockField::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 BlamPluginField.

SetMemoryLocation()

void BlockField::SetMemoryLocation ( void *  new_address )

virtual

Sets the address of the data that the plugin field should display.

Parameters

new_address

- The address of the field data.

Reimplemented from BlamPluginField.

ShowImPropertyControl()

void BlockField::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 BlamPluginField.

Member Data Documentation

active_entry

int BlockField::active_entry = 0

The index of the active entry.

block_info

tag_block<void>* BlockField::block_info

Pointer to the current block info being represented.

block_template

std::vector<BlamPluginField*> BlockField::block_template

The list of block entries in this block.

entry_size

int BlockField::entry_size = 0

The size of each block entry.

---

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

• blam/components/content/tags/fields/block/block.h
• blam/components/content/tags/fields/block/block.cpp