aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/Metadata.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/crepe/Metadata.h')
-rw-r--r--src/crepe/Metadata.h20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/crepe/Metadata.h b/src/crepe/Metadata.h
index 1577987..d52ab67 100644
--- a/src/crepe/Metadata.h
+++ b/src/crepe/Metadata.h
@@ -7,16 +7,36 @@
namespace crepe {
+/**
+ * \brief Metadata component
+ *
+ * This class represents the Metadata component. It stores the name, tag, parent
+ * and children of a GameObject.
+ */
class Metadata : public Component {
public:
+ /**
+ * \param game_object_id The id of the GameObject this component belongs to
+ * \param name The name of the GameObject
+ * \param tag The tag of the GameObject
+ */
Metadata(uint32_t game_object_id, const std::string & name,
const std::string & tag);
+ /**
+ * \brief Get the maximum number of instances for this component
+ *
+ * \return The maximum number of instances for this component
+ */
virtual int get_instances_max() const { return 1; }
public:
+ //! The name of the GameObject
std::string name;
+ //! The tag of the GameObject
std::string tag;
+ //! The id of the parent GameObject (-1 if no parent)
uint32_t parent = -1;
+ //! The ids of the children GameObjects
std::vector<uint32_t> children;
};