 |
Blamite Game Engine - Guerilla (Library)
00385.05.12.23.0209.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)
23 std::string value =
"";
Class representing a tag field.
Definition: fields.h:164
@ Int16
Indicates that the field is a 16-bit integer.
std::string GetTagPath()
Generates the tag path, relative to its project.
Definition: BlamTag.cpp:704
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamTagField.cpp:19
@ Real
Indicates that the field is a Float32.
int value
The raw value of the option. This is what is stored within a compiled tag.
Definition: enum.h:21
@ Int32
Indicates that the field is a 32-bit integer.
std::string content_root
The root folder containing project content.
Definition: projects.h:94
std::vector< BlamEnumFieldOption > options
The list of options within the enum.
Definition: enum.h:34
void ReleaseFieldData()
Releases all items in fields.
Definition: BlamTag.cpp:402
int entry_size
The size of a each block entry.
Definition: block.h:44
int next_new_tag_number
The number to use for the next newly created tag.
Definition: BlamPlugin.cpp:18
int fieldset_version
The fieldset version of the tag.
Definition: tags.h:109
@ Enum8
Indicates that the field is an Enum8.
Class representing a plugin enum field.
Definition: enum.h:31
BlamProject * project
The project that this tag belongs to.
Definition: tags.h:237
std::string class_name_short
The short class name. Ex: scnr. Must be 4 characters or fewer.
Definition: tags.h:106
@ Vector4
Indicates that the field is a vector4.
std::vector< BlamBitfieldBitData > bits
The list of bits within this bitfield.
Definition: bitfield.h:60
~BlamPlugin()
Destroys the plugin data and releases all field data.
Definition: BlamPlugin.cpp:450
@ Block
Indicates that the field is a tag block.
std::vector< BlamTagBlockEntry * > entries
The list of entries within this block.
Definition: block.h:80
std::string description
The description of the revision.
Definition: tags.h:69
std::string author
The revision author.
Definition: tags.h:67
std::vector< BlamRevision > revisions
The list of revisions within the tag.
Definition: tags.h:232
@ Ascii
Indicates that the field is a string of text.
std::string field_id
The ID of this field.
Definition: fields.h:175
BlamVector4 value
The value of the field, represented as a 4D vector.
Definition: vector.h:23
@ Dataref
Indicates that the field is a data reference.
std::string input_hint
An additional piece of short text that can be used to suggest valid input for a field.
Definition: fields.h:72
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamPluginField.cpp:44
@ Enum16
Indicates that the field is an Enum16.
Data structure representing a tag block entry.
Definition: block.h:17
@ Bitfield16
Indicates that the field is a Bitfield16.
BlamTagUpgradePolicy upgrade_policy
The tag's upgrade policy.
Definition: tags.h:249
BlamTagFieldType
Enumerator containing all possible tag field types.
Definition: fields.h:23
@ Int8
Indicates that the field is an 8-bit integer.
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:22
std::vector< BlamRevision > revisions
The list of revisions contained within this plugin.
Definition: tags.h:111
Class representing a float32 tag field.
Definition: float32.h:16
int index
The bit's index.
Definition: bitfield.h:22
std::vector< BlamPluginField * > fields
The list of fields contained within this plugin.
Definition: tags.h:112
void RecalculateFieldData()
Recalculates all offsets and lengths for the plugin.
Definition: BlamPlugin.cpp:664
Structure representing a tag or plugin revision.
Definition: tags.h:65
std::string referenced_tag_class
Definition: tagref.h:29
Class representing a block plugin field.
Definition: block.h:41
@ Color
Indicates that the field is a color.
@ Comment
Indicates that the field is a comment. These do not store any tag data.
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:114
std::vector< BlamTagField * > fields
The list of fields within the tag.
Definition: tags.h:233
BlamResult LoadFromDisk()
Loads the tag as an XML document from disk.
Definition: BlamTag.cpp:425
int GetVersion()
Retrieves the current revision of the plugin.
Definition: BlamPlugin.cpp:570
BlamPlugin * plugin
Pointer to the plugin associated with this tag.
Definition: tags.h:230
std::string id
The ID of the bit.
Definition: bitfield.h:20
std::string display_name
The display name of the field.
Definition: fields.h:69
Clas representing a bitfield tag field.
Definition: bitfield.h:57
Class representing a block tag field.
Definition: block.h:77
Class representing a plugin field.
Definition: fields.h:59
Class representing a Tag.
Definition: tags.h:210
std::string id
The ID of the option.
Definition: enum.h:19
bool SavePlugin(bool recalculate_field_data=true)
Saves the plugin file back to disk.
Definition: BlamPlugin.cpp:679
BlamTagField * GetField(std::string field_id)
Locates a tag field with a specific ID.
Definition: BlamTag.cpp:672
bool value
The bit's value.
Definition: bitfield.h:31
std::string GenerateXMLString()
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Block.cpp:128
@ Int64
Indicates that the field is a 32-bit integer.
std::string current_option
The ID of the currently selected option.
Definition: enum.h:56
@ Tagref
Indicates that the field is a tag reference.
bool visible
Whether or not the field is visible.
Definition: fields.h:68
bool HasPluginField()
Checks whether the field has plugin data available.
Definition: BlamTagField.cpp:34
int data_size
Definition: dataref.h:15
std::vector< BlamTagField * > fields
The list of fields within the entry.
Definition: block.h:21
@ Vector3
Indicates that the field is a vector3.
Class representing a tag enum field.
Definition: enum.h:53
std::string name
The display name of the bit.
Definition: bitfield.h:21
int version
The revision version.
Definition: tags.h:68
float value
The value of the field.
Definition: float32.h:21
void SaveToDisk(std::string _file_path)
Saves any modifications to the XML tag back to disk.
Definition: BlamTag.cpp:519
std::string field_id
The ID of the field.
Definition: fields.h:71
Class representing an integer tag field.
Definition: int.h:16
int base_size
The base size of the tag.
Definition: tags.h:108
std::string name
The display name of the option.
Definition: enum.h:20
Class representing a vector tag field.
Definition: vector.h:18
BlamTag(std::string _file_path, BlamTagUpgradePolicy _upgrade_policy)
Prepares a new tag to be loaded.
Definition: BlamTag.cpp:412
Clas representing a bitfield plugin field.
Definition: bitfield.h:39
@ Bitfield8
Indicates that the field is a Bitfield8.
std::vector< BlamPluginField * > fields
The list of fields within the tag block.
Definition: block.h:45
bool LocatePlugin()
Attempts to locate a compatiable plugin for a given tag.
Definition: BlamTag.cpp:640
BlamPlugin(std::string _file_path)
Prepares a new plugin for load.
Definition: BlamPlugin.cpp:445
void * data_address
Definition: dataref.h:14
BlamResult LoadFromDisk()
Loads the plugin XML document from disk.
Definition: BlamPlugin.cpp:455
std::string class_name_long
The long class name. Ex: scenario. Can be any length.
Definition: tags.h:105
std::string file_path
The path to the tag file.
Definition: tags.h:235
std::vector< std::string > allowed_classes
Definition: tagref.h:17
std::string description
An optional description of the field.
Definition: fields.h:70
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:246
Data structure representing an enum option.
Definition: enum.h:17
@ Unspecified
Indicates that the field's type is not specified. Fields with this type should be considered invalid.
std::vector< BlamBitfieldBitInfo > bits
The list of bits within this bitfield.
Definition: bitfield.h:42
#define TAG_FIELDSET_VERSION
BlamTag * CreateNewTag()
Creates a new tag using the plugin.
Definition: BlamPlugin.cpp:585
BlamPluginField * GetField(std::string id)
Attempts to locate a field with a given ID.
Definition: BlamPlugin.cpp:624
@ Bitfield32
Indicates that the field is a Bitfield32.
int offset
The offset of the field data.
Definition: fields.h:66
std::string name
The name of the entry.
Definition: block.h:20
@ Vector2
Indicates that the field is a vector2.
Data structure containing data for a bitfield bit.
Definition: bitfield.h:28
#define GUERILLA_LIB_API
Definition: ascii.h:10
int64_t value
The value of the field, represented as a 32-bit integer.
Definition: int.h:21
int length
The length of the field data.
Definition: fields.h:67
int class_version
The class/plugin version of the tag.
Definition: tags.h:245
virtual std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField.cpp:14
@ Enum32
Indicates that the field is an Enum32.
std::string referenced_tag_path
Definition: tagref.h:28
std::string value
The value of the field.
Definition: ascii.h:23
~BlamTag()
Releases any data used by the tag by calling ReleaseFieldData.
Definition: BlamTag.cpp:420
Data structure containing extra data for a bitfield bit.
Definition: bitfield.h:18
Class representing a color tag field.
Definition: color.h:17
Class representing an ascii tag field.
Definition: ascii.h:18
1.8.17