Elaztek Developer Hub
Blamite Game Engine - Guerilla (Library)  00385.05.12.23.0209.blamite
The tag editor for the Blamite Game Engine.
comment.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <string>
4 
5 #include "../fields.h"
6 
7 #ifdef GUERILLA_LIB_EXPORTS
8 #define GUERILLA_LIB_API __declspec(dllexport)
9 #else
10 #define GUERILLA_LIB_API __declspec(dllimport)
11 #endif
12 
16 enum class BlamCommentType
17 {
18  None,
19  Info,
20  Warning,
21  Error
22 };
23 
31 {
32 private:
33 
34 public:
41 
42  std::string GenerateXMLString();
43  std::vector<char> GetValueAsBytes();
44 };
45 
53 {
54 private:
55 
56 public:
58 
65 
71  void ParseCommentType(std::string comment_type_string);
72 };
BlamTagField
Class representing a tag field.
Definition: fields.h:164
comment.h
BlamPluginField_Comment::BlamPluginField_Comment
BlamPluginField_Comment(BlamPluginField *base_field)
Constructs a new comment plugin field.
Definition: BlamPluginField_Comment.cpp:7
GUERILLA_LIB_API
#define GUERILLA_LIB_API
Definition: comment.h:10
BlamPluginField_Comment::comment_type
BlamCommentType comment_type
The type of the comment.
Definition: comment.h:57
BlamCommentType::Info
@ Info
Indicates that the comment should be presented as an informative message.
BlamCommentType::Warning
@ Warning
Indicates that the comment should be presented as a warning message.
BlamTagFieldType
BlamTagFieldType
Enumerator containing all possible tag field types.
Definition: fields.h:23
BlamPluginField_Comment::ParseCommentType
void ParseCommentType(std::string comment_type_string)
Attempts to parse the comment_type of the field from a string.
Definition: BlamPluginField_Comment.cpp:12
BlamCommentType
BlamCommentType
Enumerator used to identify the type of comment being displayed.
Definition: comment.h:16
BlamTagFieldType::Comment
@ Comment
Indicates that the field is a comment. These do not store any tag data.
BlamTagField::GenerateXMLString
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
BlamTagField_Comment::GetValueAsBytes
std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField_Comment.cpp:13
BlamPluginField
Class representing a plugin field.
Definition: fields.h:59
BlamPluginField_Comment
Class representing a comment plugin field.
Definition: comment.h:52
BlamTag
Class representing a Tag.
Definition: tags.h:210
BlamCommentType::Error
@ Error
Indicates that the comment should be presented as an error message.
BlamTagField_Comment::GenerateXMLString
std::string GenerateXMLString()
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Comment.cpp:8
BlamPluginField::field_id
std::string field_id
The ID of the field.
Definition: fields.h:71
BlamTagField_Comment
Class representing a comment tag field.
Definition: comment.h:30
BlamTagField_Comment::BlamTagField_Comment
BlamTagField_Comment(BlamTag *_tag)
Constructs a new comment field.
Definition: BlamTagField_Comment.cpp:3
BlamPluginField::GetPlugin
BlamPlugin * GetPlugin()
Retrieves the plugin this field is associated with.
Definition: BlamPluginField.cpp:49
BlamTagField::GetValueAsBytes
virtual std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField.cpp:14
BlamCommentType::None
@ None
Default value. The comment will be given the standard appearance.