Elaztek Developer Hub
Blamite Game Engine - Guerilla (Library)  00378.04.17.23.1319.blamite
The tag editor for the Blamite Game Engine.
BlamPluginField_Block Class Reference

Class representing a block plugin field. More...

#include <block.h>

+ Inheritance diagram for BlamPluginField_Block:

Public Member Functions

 BlamPluginField_Block (BlamPluginField *base_field)
 Constructs a new block plugin field from an existing generic plugin field. More...
 
 ~BlamPluginField_Block ()
 
BlamPluginFieldGetField (std::string id)
 
BlamPluginFieldGetField (std::string id, BlamTagFieldType type)
 
- 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...
 
BlamPluginGetPlugin ()
 Retrieves the plugin this field is associated with. More...
 
virtual BlamTagFieldGenerateTagField (BlamTag *tag)
 Generates a new tag field from this plugin field. More...
 
virtual BlamTagFieldGenerateTagField (BlamTagField *existing_tag_field)
 Generates a new tag field from this plugin field. More...
 
virtual BlamTagFieldGenerateTagField (BlamTag *tag, void *address)
 Generates a new tag field from this plugin field. More...
 

Public Attributes

int entry_size = 0
 The size of a each block entry. More...
 
std::vector< BlamPluginField * > fields
 The list of fields within the tag block. More...
 
int c_entry_count = 0
 The entry count. Used in tag decompilation. More...
 
int c_entry_offset = 0
 The offset of the entry data. Used in tag decompilation. 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 block plugin field.

Tag blocks act as a container for other tag fields. Each block can contain a series of "entries". Each entry will always have the same fields available (and thus be the same size), but the values of each field within an entry can differ.

Plugin block fields store the list of valid fields for any entries, as well as the size of each entry.

Constructor & Destructor Documentation

◆ BlamPluginField_Block()

BlamPluginField_Block::BlamPluginField_Block ( 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.

◆ ~BlamPluginField_Block()

BlamPluginField_Block::~BlamPluginField_Block ( )

Member Function Documentation

◆ GetField() [1/2]

BlamPluginField * BlamPluginField_Block::GetField ( std::string  id)

◆ GetField() [2/2]

BlamPluginField * BlamPluginField_Block::GetField ( std::string  id,
BlamTagFieldType  type 
)

Member Data Documentation

◆ c_entry_count

int BlamPluginField_Block::c_entry_count = 0

The entry count. Used in tag decompilation.

◆ c_entry_offset

int BlamPluginField_Block::c_entry_offset = 0

The offset of the entry data. Used in tag decompilation.

◆ entry_size

int BlamPluginField_Block::entry_size = 0

The size of a each block entry.

◆ fields

std::vector<BlamPluginField*> BlamPluginField_Block::fields

The list of fields within the tag block.


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