aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/UiObject.h
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-25 11:48:01 +0100
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-25 11:48:01 +0100
commitea7d7ec301968f3a542de93f487f9501b70c0cd4 (patch)
treec2a81d117f62c06d369a8e6336a4ecac675df508 /src/crepe/api/UiObject.h
parent596358ffea72aec48b389609349f717e76396ae2 (diff)
code standard fixing
Diffstat (limited to 'src/crepe/api/UiObject.h')
-rw-r--r--src/crepe/api/UiObject.h32
1 files changed, 24 insertions, 8 deletions
diff --git a/src/crepe/api/UiObject.h b/src/crepe/api/UiObject.h
index 82140a0..ae2e744 100644
--- a/src/crepe/api/UiObject.h
+++ b/src/crepe/api/UiObject.h
@@ -1,17 +1,33 @@
#pragma once
-#include "Component.h"
+#include "../Component.h"
-#include "api/EventHandler.h"
namespace crepe {
-class UiObject : public Component{
+/**
+ * @class UiObject
+ * \brief Represents a UI object in the game, derived from the Component class.
+ */
+class UiObject : public Component {
public:
- UiObject(game_object_id_t id) : Component(id){};
- int width = 0;
- int height = 0;
+ /**
+ * \brief Constructs a UiObject with the specified game object ID.
+ * \param id The unique ID of the game object associated with this UI object.
+ */
+ UiObject(game_object_id_t id);
+
+ //! The width of the UI object.
+ int width = 0;
+
+ //! The height of the UI object.
+ int height = 0;
+
public:
-virtual int get_instances_max() const { return 1; }
+ /**
+ * \brief Retrieves the maximum number of instances allowed for this UI object type.
+ * /return Always returns 1, as only a single instance is allowed.
+ */
+ virtual int get_instances_max() const override { return 1; }
};
-}
+} // namespace crepe