aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/Component.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/crepe/Component.h')
-rw-r--r--src/crepe/Component.h25
1 files changed, 23 insertions, 2 deletions
diff --git a/src/crepe/Component.h b/src/crepe/Component.h
index 8db9b2a..41badc3 100644
--- a/src/crepe/Component.h
+++ b/src/crepe/Component.h
@@ -6,18 +6,39 @@ namespace crepe {
class ComponentManager;
+/**
+ * \brief Base class for all components
+ *
+ * This class is the base class for all components. It provides a common
+ * interface for all components.
+ */
class Component {
protected:
+ //! Only the ComponentManager can create components
friend class crepe::ComponentManager;
+ /**
+ * \param id The id of the GameObject this component belongs to
+ */
Component(uint32_t id);
public:
virtual ~Component() = default;
+ /**
+ * \brief Get the maximum number of instances for this component
+ *
+ * This method returns -1 by default, which means that there is no limit
+ * for the number of instances. Concrete components can override this method
+ * to set a limit.
+ *
+ * \return The maximum number of instances for this component
+ */
virtual int get_instances_max() const { return -1; }
public:
- uint32_t game_object_id;
- bool active;
+ //! The id of the GameObject this component belongs to
+ const uint32_t GAME_OBJECT_ID;
+ //! Whether the component is active
+ bool active = true;
};
} // namespace crepe