summaryrefslogtreecommitdiffstats
path: root/src/Map.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/Map.h15
1 files changed, 13 insertions, 2 deletions
diff --git a/src/Map.h b/src/Map.h
index 3cf9977ab..ce19c8d2e 100644
--- a/src/Map.h
+++ b/src/Map.h
@@ -28,7 +28,14 @@ class cMap;
-/** Encapsulates a map decorator. */
+/** Encapsulates a map decorator.
+ *
+ * A map decorator represents an object drawn on the map that can move freely.
+ * (e.g. player trackers and item frame pointers)
+ *
+ * Excluding manually placed decorators,
+ * decorators are automatically managed (allocated and freed) by their parent cMap instance.
+ */
class cMapDecorator
{
public:
@@ -98,7 +105,11 @@ public:
typedef std::vector<ColorID> cColorList;
- /** Encapsulates the state of a map client. */
+ /** Encapsulates the state of a map client.
+ *
+ * In order to enhance performace, maps are streamed column-by-column to each client.
+ * This structure stores the state of the stream.
+ */
struct cMapClient
{
cClientHandle * m_Handle;