added textual type/field descriptions and wiki mode

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

diff --git a/src/graphics/Sprite.cpp b/src/graphics/Sprite.cpp
index 434679ce740db47d280bdaf593f38ae1f85c302f..2495cadd86c101092131e9757b8261ee92c1fe1e 100644 (file)
--- a/src/graphics/Sprite.cpp
+++ b/src/graphics/Sprite.cpp
@@ -48,12 +48,15 @@ void Sprite::CreateTypeDescription() {
        int vectorId(TypeDescription::GetTypeId("Vector"));
 
        TypeDescription &td(TypeDescription::CreateOrGet("Sprite"));
+       td.SetDescription(
+                       "An image + a size and offset.\n"
+                       "The resulting section or a section offset by a multiple of its size can be drawn.");
        td.SetConstructor(&Construct);
        td.SetSize(sizeof(Sprite));
 
-       td.AddField("image", FieldDescription(((char *)&s.surface) - ((char *)&s), imageId, true));
-       td.AddField("size", FieldDescription(((char *)&s.size) - ((char *)&s), vectorId, false));
-       td.AddField("offset", FieldDescription(((char *)&s.offset) - ((char *)&s), vectorId, false));
+       td.AddField("image", FieldDescription(((char *)&s.surface) - ((char *)&s), imageId).SetReferenced().SetDescription("the image to cut this sprite from"));
+       td.AddField("size", FieldDescription(((char *)&s.size) - ((char *)&s), vectorId).SetDescription("dimensions of the sprite"));
+       td.AddField("offset", FieldDescription(((char *)&s.offset) - ((char *)&s), vectorId).SetDescription("offset into the image, top-left corner of the sprite's (0,0) clip"));
 }
 
 void Sprite::Construct(void *data) {