added textual type/field descriptions and wiki mode

[l2e.git] / src / common / Item.cpp

diff --git a/src/common/Item.cpp b/src/common/Item.cpp
index 9a1a735ea1db2ff3c916cec81509575d243aeef2..56f083ef62f854dd8849dbcd57d0a3f1d0ab036f 100644 (file)
--- a/src/common/Item.cpp
+++ b/src/common/Item.cpp
@@ -48,23 +48,24 @@ void Item::CreateTypeDescription() {
        int targetsId(TypeDescription::GetTypeId("TargetingMode"));
 
        TypeDescription &td(TypeDescription::CreateOrGet("Item"));
+       td.SetDescription("All data of an item (soon).");
        td.SetConstructor(&Construct);
        td.SetSize(sizeof(Item));
 
-       td.AddField("name", FieldDescription(((char *)&i.name) - ((char *)&i), stringId, true));
-       td.AddField("menuicon", FieldDescription(((char *)&i.menuIcon) - ((char *)&i), spriteId, true));
+       td.AddField("name", FieldDescription(((char *)&i.name) - ((char *)&i), stringId).SetReferenced().SetDescription("the item's name"));
+       td.AddField("menuicon", FieldDescription(((char *)&i.menuIcon) - ((char *)&i), spriteId).SetReferenced().SetDescription("icon that is displayed in menus"));
 
-       td.AddField("mostUseful", FieldDescription(((char *)&i.mostUseful) - ((char *)&i), boolId, false));
-       td.AddField("equipable", FieldDescription(((char *)&i.equipable) - ((char *)&i), boolId, false));
-       td.AddField("cursed", FieldDescription(((char *)&i.cursed) - ((char *)&i), boolId, false));
-       td.AddField("fruit", FieldDescription(((char *)&i.fruit) - ((char *)&i), boolId, false));
-       td.AddField("scenario", FieldDescription(((char *)&i.scenario) - ((char *)&i), boolId, false));
-       td.AddField("status", FieldDescription(((char *)&i.status) - ((char *)&i), boolId, false));
-       td.AddField("battle", FieldDescription(((char *)&i.battle) - ((char *)&i), boolId, false));
+       td.AddField("mostUseful", FieldDescription(((char *)&i.mostUseful) - ((char *)&i), boolId));
+       td.AddField("equipable", FieldDescription(((char *)&i.equipable) - ((char *)&i), boolId));
+       td.AddField("cursed", FieldDescription(((char *)&i.cursed) - ((char *)&i), boolId));
+       td.AddField("fruit", FieldDescription(((char *)&i.fruit) - ((char *)&i), boolId));
+       td.AddField("scenario", FieldDescription(((char *)&i.scenario) - ((char *)&i), boolId));
+       td.AddField("status", FieldDescription(((char *)&i.status) - ((char *)&i), boolId));
+       td.AddField("battle", FieldDescription(((char *)&i.battle) - ((char *)&i), boolId).SetDescription("if the item can be used in battle"));
 
-       td.AddField("targets", FieldDescription(((char *)&i.targettingMode) - ((char *)&i), targetsId, false));
-       td.AddField("ikari", FieldDescription(((char *)&i.ikari) - ((char *)&i), ikariId, true));
-       td.AddField("attackanimation", FieldDescription(((char *)&i.attackAnimation) - ((char *)&i), animationId, true));
+       td.AddField("targets", FieldDescription(((char *)&i.targettingMode) - ((char *)&i), targetsId).SetDescription("how target selection is to be performed"));
+       td.AddField("ikari", FieldDescription(((char *)&i.ikari) - ((char *)&i), ikariId).SetReferenced().SetDescription("ikari attack of the item (sensible only for equipment)"));
+       td.AddField("attackanimation", FieldDescription(((char *)&i.attackAnimation) - ((char *)&i), animationId).SetReferenced().SetDescription("animation that is run when the item is used for attacking"));
 }
 
 void Item::Construct(void *data) {