added textual type/field descriptions and wiki mode

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

diff --git a/src/graphics/Frame.cpp b/src/graphics/Frame.cpp
index 683bfcb54c0d6b167be6de156137f962ad5d0796..01264e8321921e4f2c55d0e14611c1547a9070fe 100644 (file)
--- a/src/graphics/Frame.cpp
+++ b/src/graphics/Frame.cpp
@@ -126,13 +126,16 @@ void Frame::CreateTypeDescription() {
        int vectorId(TypeDescription::GetTypeId("Vector"));
 
        TypeDescription &td(TypeDescription::CreateOrGet("Frame"));
+       td.SetDescription(
+                       "A frame is basically a border + a background texture.\n"
+                       "It splits an image into 3*3 parts where the edges are kept as is and the sides and the middle part are repeated as needed.");
        td.SetConstructor(&Construct);
        td.SetSize(sizeof(Frame));
 
-       td.AddField("image", FieldDescription(((char *)&f.surface) - ((char *)&f), imageId, true));
-       td.AddField("border", FieldDescription(((char *)&f.borderSize) - ((char *)&f), vectorId, false));
-       td.AddField("repeat", FieldDescription(((char *)&f.repeatSize) - ((char *)&f), vectorId, false));
-       td.AddField("offset", FieldDescription(((char *)&f.offset) - ((char *)&f), vectorId, false));
+       td.AddField("image", FieldDescription(((char *)&f.surface) - ((char *)&f), imageId).SetReferenced().SetDescription("the underlying graphic from which the frame parts are cut"));
+       td.AddField("border", FieldDescription(((char *)&f.borderSize) - ((char *)&f), vectorId).SetDescription("size of the border part, dimensions of top-left corner"));
+       td.AddField("repeat", FieldDescription(((char *)&f.repeatSize) - ((char *)&f), vectorId).SetDescription("size of the repeat part, dimensions of a single tile of the background texture"));
+       td.AddField("offset", FieldDescription(((char *)&f.offset) - ((char *)&f), vectorId).SetDescription("offset into the image where to start cutting, coordinates of the top-left corner on the image"));
 }
 
 void Frame::Construct(void *data) {