added readme file

[l2e.git] / src / graphics / Gauge.cpp

diff --git a/src/graphics/Gauge.cpp b/src/graphics/Gauge.cpp
index 6925c2ff2482ae1a302d60a8d9f3bc77add64a7c..d0e891a74b56e345d8d065141bacc8d731ba11c8 100644 (file)
--- a/src/graphics/Gauge.cpp
+++ b/src/graphics/Gauge.cpp
@@ -91,15 +91,24 @@ void Gauge::CreateTypeDescription() {
        int vectorId(TypeDescription::GetTypeId("Vector"));
 
        TypeDescription &td(TypeDescription::CreateOrGet("Gauge"));
+       td.SetDescription(
+                       "Gauges display a percentage by filling the left part different than the right.\n"
+                       "The fill level is only mapped with repeat.\n"
+                       "Start is filled if the level in greater than zero, end is filled if the level is at its maximum.");
+       td.SetConstructor(&Construct);
        td.SetSize(sizeof(Gauge));
 
-       td.AddField("image", FieldDescription(((char *)&g.surface) - ((char *)&g), imageId, true));
-       td.AddField("full", FieldDescription(((char *)&g.fullOffset) - ((char *)&g), vectorId, false));
-       td.AddField("empty", FieldDescription(((char *)&g.emptyOffset) - ((char *)&g), vectorId, false));
-       td.AddField("height", FieldDescription(((char *)&g.height) - ((char *)&g), numberId, false));
-       td.AddField("start", FieldDescription(((char *)&g.startWidth) - ((char *)&g), numberId, false));
-       td.AddField("repeat", FieldDescription(((char *)&g.repeatWidth) - ((char *)&g), numberId, false));
-       td.AddField("end", FieldDescription(((char *)&g.endWidth) - ((char *)&g), numberId, false));
+       td.AddField("image", FieldDescription(((char *)&g.surface) - ((char *)&g), imageId).SetReferenced().SetDescription("the underlying graphic from which the gauge parts are cut"));
+       td.AddField("full", FieldDescription(((char *)&g.fullOffset) - ((char *)&g), vectorId).SetDescription("top-left corner of the filled gauge"));
+       td.AddField("empty", FieldDescription(((char *)&g.emptyOffset) - ((char *)&g), vectorId).SetDescription("top-left corner of the empty gauge"));
+       td.AddField("height", FieldDescription(((char *)&g.height) - ((char *)&g), numberId).SetDescription("height of the gauges"));
+       td.AddField("start", FieldDescription(((char *)&g.startWidth) - ((char *)&g), numberId).SetDescription("width of the start part"));
+       td.AddField("repeat", FieldDescription(((char *)&g.repeatWidth) - ((char *)&g), numberId).SetDescription("width of the repeat part"));
+       td.AddField("end", FieldDescription(((char *)&g.endWidth) - ((char *)&g), numberId).SetDescription("width of the end part"));
+}
+
+void Gauge::Construct(void *data) {
+       new (data) Gauge;
 }
 
 }