 |
Blamite Game Engine - Guerilla (Library)
00421.06.29.24.2305.blamite
The tag editor for the Blamite Game Engine.
|
Go to the documentation of this file.
7 #ifdef GUERILLA_LIB_EXPORTS
8 #define GUERILLA_LIB_API __declspec(dllexport)
10 #define GUERILLA_LIB_API __declspec(dllimport)
42 std::vector<BlamBitfieldBitInfo>
bits;
52 std::string
GenerateCppStructString(std::string line_prefix =
"",
bool generate_doxygen_comments =
true)
override;
54 bool ParseXMLData(rapidxml::xml_node<>* field_node)
override;
68 std::vector<BlamBitfieldBitData>
bits;
88 bool HasBit(std::string flag_id);
97 bool GetBitValue(std::string flag_id);
107 bool SetBit(std::string flag_id,
bool value);
Class representing a tag field.
Definition: fields.h:244
std::string GetTagPath()
Generates the tag path, relative to its project.
Definition: BlamTag.cpp:754
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamTagField.cpp:19
virtual BlamTagField * GenerateTagField(BlamTag *tag)
Generates a new tag field from this plugin field.
Definition: BlamPluginField.cpp:41
BlamDatarefValueHintType
Enumerator listing all supported dataref value hint types.
Definition: fields.h:30
std::vector< BlamEnumFieldOption > options
The list of options within the enum.
Definition: enum.h:44
void ReleaseFieldData()
Releases all items in fields.
Definition: BlamTag.cpp:445
int next_new_tag_number
The number to use for the next newly created tag.
Definition: BlamPlugin.cpp:15
int fieldset_version
The fieldset version of the tag.
Definition: tags.h:112
Class representing a plugin enum field.
Definition: enum.h:41
BlamProject * project
The project that this tag belongs to.
Definition: tags.h:325
std::string class_name_short
The short class name. Ex: scnr. Must be 4 characters or fewer.
Definition: tags.h:109
#define GUERILLA_LIB_API
Definition: bitfield.h:10
std::string GetTagsRoot()
Definition: BlamProject.cpp:161
std::vector< BlamBitfieldBitData > bits
The list of bits within this bitfield.
Definition: bitfield.h:68
std::string description
An optional long description of the plugin.
Definition: tags.h:117
virtual std::string GenerateXMLString()
Generates a string representing this plugin field.
Definition: BlamPluginField.cpp:61
~BlamPlugin()
Destroys the plugin data and releases all field data.
Definition: BlamPlugin.cpp:153
void SetText(std::string text_value)
Sets the dataref's stored value to a given string.
Definition: BlamTagField_Dataref.cpp:78
BlamPluginField * ParseField(rapidxml::xml_node<> *field_node)
Attempts to parse an XML node as a plugin field.
Definition: BlamPlugin.cpp:69
std::vector< BlamTagBlockEntry * > entries
The list of entries within this block.
Definition: block.h:131
std::string description
The description of the revision.
Definition: tags.h:70
bool VerifyIDs()
Verifies that all field IDs within the plugin are valid.
Definition: BlamPlugin.cpp:761
std::string author
The revision author.
Definition: tags.h:68
BlamDatarefValueHintType value_hint
A string that can be checked against to determine the type of data being stored.
Definition: dataref.h:56
std::vector< BlamRevision > revisions
The list of revisions within the tag.
Definition: tags.h:320
std::string field_id
The ID of this field.
Definition: fields.h:256
BlamVector4 value
The value of the field, represented as a 4D vector.
Definition: vector.h:41
bool IsBuiltIn()
Checks if the plugin is a built-in plugin.
Definition: BlamPlugin.cpp:532
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamPluginField.cpp:31
std::string GenerateCppSourceFile(bool include_comments=true, bool generate_doxygen_comments=true)
Generates C++ file source code containing the necessary information about the plugin file.
Definition: BlamPlugin.cpp:716
std::string GenerateXMLString(bool keep_unused, bool keep_invalid)
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Block.cpp:133
Data structure representing a tag block entry.
Definition: block.h:17
BlamTagUpgradePolicy upgrade_policy
The tag's upgrade policy.
Definition: tags.h:337
std::string id
The ID of the bit.
Definition: bitfield.h:30
BlamColor value
The value of the field, represented as a color.
Definition: color.h:39
std::string GenerateCppHeaderFile(bool include_comments=true, bool generate_doxygen_comments=true)
Generates C++ header source code containing the necessary information about the plugin file.
Definition: BlamPlugin.cpp:615
std::string short_description
An optional short description of the plugin.
Definition: tags.h:116
std::vector< BlamRevision > revisions
The list of revisions contained within this plugin.
Definition: tags.h:119
Class representing a real (float32) tag field.
Definition: float32.h:33
int index
The bit's index.
Definition: bitfield.h:22
bool valid
Whether or not the plugin was able to be loaded.
Definition: tags.h:123
std::vector< BlamPluginField * > fields
The list of fields contained within this plugin.
Definition: tags.h:120
void RecalculateFieldData()
Recalculates all offsets and lengths for the plugin.
Definition: BlamPlugin.cpp:450
Structure representing a tag or plugin revision.
Definition: tags.h:66
std::string referenced_tag_class
Definition: tagref.h:49
virtual std::string GenerateXMLString()
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField.cpp:9
std::string file_path
The path to the plugin file.
Definition: tags.h:122
std::vector< BlamTagField * > fields
The list of fields within the tag.
Definition: tags.h:321
BlamResult LoadFromDisk()
Loads the tag as an XML document from disk.
Definition: BlamTag.cpp:474
int GetVersion()
Retrieves the current revision of the plugin.
Definition: BlamPlugin.cpp:351
bool ExportPluginToCpp(std::string export_directory="", bool include_comments=true, bool generate_doxygen_comments=true)
Exports the plugin file to the appropriate C++ source and header files.
Definition: BlamPlugin.cpp:537
BlamPlugin * plugin
Pointer to the plugin associated with this tag.
Definition: tags.h:318
Class representing an tagref tag field.
Definition: tagref.h:42
std::string GetGlobalEnumName()
Definition: BlamPluginField_Enum.cpp:356
std::string id
The ID of the bit.
Definition: bitfield.h:20
Clas representing a bitfield tag field.
Definition: bitfield.h:65
Class representing a block tag field.
Definition: block.h:128
Class representing a plugin field.
Definition: fields.h:71
Class representing a dataref tag field.
Definition: dataref.h:45
Class representing a Tag.
Definition: tags.h:296
bool SavePlugin(bool recalculate_field_data=true)
Saves the plugin file back to disk.
Definition: BlamPlugin.cpp:465
int GetVersion()
Retrieves the current revision of the tag.
Definition: BlamTag.cpp:780
BlamTagField * GetFieldFromRelativeAddress(std::string address)
Definition: BlamTagBlockEntry.cpp:71
BlamTagField * GetField(std::string field_id)
Locates a tag field with a specific ID.
Definition: BlamTag.cpp:722
bool value
The bit's value.
Definition: bitfield.h:31
BlamTagField * GetFieldFromAddress(std::string address)
Looks up a field from its address.
Definition: BlamTag.cpp:795
@ NONE
No value hint, no special treatment will be given to the data.
std::string current_option
The ID of the currently selected option.
Definition: enum.h:83
virtual BlamPluginField * Copy(BlamPlugin *new_plugin)
Creates a copy of this plugin field.
Definition: BlamPluginField.cpp:229
bool HasPluginField()
Checks whether the field has plugin data available.
Definition: BlamTagField.cpp:34
virtual bool ParseXMLData(rapidxml::xml_node<> *field_node)
Populates data within the plugin field from an XML node.
Definition: BlamPluginField.cpp:106
int data_size
The size of the referenced data.
Definition: dataref.h:49
std::vector< BlamTagField * > fields
The list of fields within the entry.
Definition: block.h:21
std::string GenerateCppGlobalEnumString(std::string line_prefix="", bool generate_doxygen_comments=true)
Definition: BlamPluginField_Enum.cpp:320
Class representing a tag enum field.
Definition: enum.h:80
std::string name
The display name of the bit.
Definition: bitfield.h:21
BlamPlugin * Copy()
Creates a unique, deep copy of this plugin.
Definition: BlamPlugin.cpp:766
int version
The revision version.
Definition: tags.h:69
BlamPluginField_Enum * bound_enum
Pointer to the global enum field this enum is bound to.
Definition: enum.h:51
float value
The value of the field.
Definition: float32.h:38
void SaveToDisk(std::string _file_path)
Saves any modifications to the XML tag back to disk.
Definition: BlamTag.cpp:568
Class representing a Plugin.
Definition: tags.h:80
std::string field_id
The ID of the field.
Definition: fields.h:83
Class representing an integer tag field.
Definition: int.h:33
int base_size
The base size of the tag.
Definition: tags.h:111
Class representing a vector tag field.
Definition: vector.h:36
BlamTag(std::string _file_path, BlamTagUpgradePolicy _upgrade_policy)
Prepares a new tag to be loaded.
Definition: BlamTag.cpp:461
Clas representing a bitfield plugin field.
Definition: bitfield.h:39
std::string project_name
The game/project that this plugin was created for.
Definition: tags.h:114
void ChangeType(BlamTagFieldType new_type)
Changes the type of a plugin field.
Definition: BlamPluginField.cpp:224
bool LocatePlugin()
Attempts to locate a compatiable plugin for a given tag.
Definition: BlamTag.cpp:689
BlamPlugin(std::string _file_path)
Prepares a new plugin for load.
Definition: BlamPlugin.cpp:143
void * data_address
The address of the referenced data.
Definition: dataref.h:48
std::string engine_version
The game engine version that generated this plugin, if applicable.
Definition: tags.h:115
BlamResult LoadFromDisk()
Loads the plugin XML document from disk.
Definition: BlamPlugin.cpp:158
std::string class_name_long
The long class name. Ex: scenario. Can be any length.
Definition: tags.h:108
Class representing a boolean tag field.
Definition: boolean.h:35
std::string file_path
The path to the tag file.
Definition: tags.h:323
std::string class_name
The class name as specified in the tag file. Used in the event a plugin could not be found.
Definition: tags.h:334
bool value
The value of the field.
Definition: boolean.h:40
Class representing a fieldref tag field.
Definition: fieldref.h:38
std::vector< BlamBitfieldBitInfo > bits
The list of bits within this bitfield.
Definition: bitfield.h:42
#define TAG_FIELDSET_VERSION
std::string field_location_address
Definition: fieldref.h:44
BlamTag * CreateNewTag()
Creates a new tag using the plugin.
Definition: BlamPlugin.cpp:366
BlamPluginField * GetField(std::string id)
Attempts to locate a field with a given ID.
Definition: BlamPlugin.cpp:410
std::string name
The name of the entry.
Definition: block.h:20
Data structure containing data for a bitfield bit.
Definition: bitfield.h:28
std::string bound_enum_id
The ID of the global enum field this enum is bound to.
Definition: enum.h:50
int64_t value
The value of the field, represented as a 32-bit integer.
Definition: int.h:38
virtual std::string GenerateCppClassString(std::string line_prefix="")
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField.cpp:101
int class_version
The class/plugin version of the tag.
Definition: tags.h:333
virtual std::string GenerateCppStructString(std::string line_prefix="", bool generate_doxygen_comments=true)
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField.cpp:96
virtual std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField.cpp:14
std::string referenced_tag_path
Definition: tagref.h:48
~BlamTag()
Releases any data used by the tag by calling ReleaseFieldData.
Definition: BlamTag.cpp:469
GUERILLA_LIB_API BlamProject * GetCurrentProject()
Definition: projects.cpp:13
Data structure containing extra data for a bitfield bit.
Definition: bitfield.h:18
Class representing a color tag field.
Definition: color.h:34