added textual type/field descriptions and wiki mode

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

diff --git a/src/graphics/Font.cpp b/src/graphics/Font.cpp
index e4e538d90250abf4bb06034989f95cf247ba171a..efaad1525611302446f7fd9f46479bfd62f19637 100644 (file)
--- a/src/graphics/Font.cpp
+++ b/src/graphics/Font.cpp
@@ -82,12 +82,17 @@ void Font::CreateTypeDescription() {
        int spriteId(TypeDescription::GetTypeId("Sprite"));
 
        TypeDescription &td(TypeDescription::CreateOrGet("Font"));
+       td.SetDescription(
+                       "Simple font with fixed-width characters using a sprite for rendering.\n"
+                       "Characters from strings are mapped as follows:\n"
+                       "<pre>sprite column = column offset + (character % 16)\n"
+                       "sprite row    = row    offset + (character / 16)</pre>");
        td.SetConstructor(&Construct);
        td.SetSize(sizeof(Font));
 
-       td.AddField("sprite", FieldDescription(((char *)&f.sprite) - ((char *)&f), spriteId, true));
-       td.AddField("columnoffset", FieldDescription(((char *)&f.colOffset) - ((char *)&f), numberId, false));
-       td.AddField("rowoffset", FieldDescription(((char *)&f.rowOffset) - ((char *)&f), numberId, false));
+       td.AddField("sprite", FieldDescription(((char *)&f.sprite) - ((char *)&f), spriteId).SetReferenced().SetDescription("a sprite where each tile corresponds to a character"));
+       td.AddField("columnoffset", FieldDescription(((char *)&f.colOffset) - ((char *)&f), numberId).SetDescription("offset of the column of the first character"));
+       td.AddField("rowoffset", FieldDescription(((char *)&f.rowOffset) - ((char *)&f), numberId).SetDescription("offset of the row of the first character"));
 }
 
 void Font::Construct(void *data) {