Elaztek Developer Hub
Blamite Game Engine - blam!  00398.09.22.23.2015.blamite
The core library for the Blamite Game Engine.
comment.h
Go to the documentation of this file.
1 #pragma once
2 
4 
5 #ifdef BLAM_EXPORTS
6 #define BLAM_EXT_API __declspec(dllexport)
7 #else
8 #define BLAM_EXT_API __declspec(dllimport)
9 #endif
10 
14 enum class BlamCommentStyle
15 {
16  None,
17  Info,
18  Warning,
19  Error
20 };
21 
30 {
31 private:
33 
34 public:
35  CommentField(std::string _display_name);
36 
37  CommentField(std::string _display_name, std::string _extra_info);
38 
39  CommentField(std::string _display_name, std::string _extra_info, BlamCommentStyle _style);
40 
41  void ShowImPropertyControl();
42 
43  std::string GetFieldXMLString(int offset);
44 };
comment.h
BlamTagClassField.h
BlamTagFieldType::Comment
@ Comment
Indicates that the field is a comment. These do not store any tag data.
imgui.h
BlamTagClassField::display_name
std::string display_name
The display name of the tag field.
Definition: BlamTagClassField.h:31
BlamTagClassField::GetFieldXMLString
virtual std::string GetFieldXMLString(int offset)
Generates a string representing an XML node associated with this tag field, used for generating plugi...
Definition: BlamTagClassField.cpp:32
BlamCommentStyle::None
@ None
The comment will be given the default appearance.
ImGui::NewLine
IMGUI_API void NewLine()
Definition: imgui_widgets.cpp:1192
BlamTagClassField
Base class representing a plugin field.
Definition: BlamTagClassField.h:28
CommentField::CommentField
CommentField(std::string _display_name)
Definition: comment.cpp:7
BlamTagFieldType
BlamTagFieldType
Enumerator listing all possible plugin field types.
Definition: tags.h:30
BlamCommentStyle::Warning
@ Warning
The comment will be given a warning message appearance.
BLAM_EXT_API
#define BLAM_EXT_API
Definition: comment.h:8
ImGui::Text
IMGUI_API void Text(const char *fmt,...) IM_FMTARGS(1)
Definition: imgui_widgets.cpp:238
BlamCommentStyle
BlamCommentStyle
The style to use for the comment.
Definition: comment.h:14
BlamCommentStyle::Info
@ Info
The comment will be given an information message appearance.
BlamTagClassField::read_length
int read_length
How many bytes to read from the start of the address.
Definition: BlamTagClassField.h:37
BlamCommentStyle::Error
@ Error
The comment will be given an error message appearance.
CommentField::ShowImPropertyControl
void ShowImPropertyControl()
Shows a set of ImGUI controls representing the tag field.
Definition: comment.cpp:26
BlamTagClassField::ShowImPropertyControl
virtual void ShowImPropertyControl()
Shows a set of ImGUI controls representing the tag field.
Definition: BlamTagClassField.cpp:22
CommentField
Class representing a comment field.
Definition: comment.h:29
BlamTagClassField::extra_info
std::string extra_info
Additional information to show alongside the field.
Definition: BlamTagClassField.h:32
CommentField::GetFieldXMLString
std::string GetFieldXMLString(int offset)
Generates a string representing an XML node associated with this tag field, used for generating plugi...
Definition: comment.cpp:37