/* * The Mana Client * Copyright (C) 2004-2009 The Mana World Development Team * Copyright (C) 2009-2010 The Mana Developers * * This file is part of The Mana Client. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "resources/itemdb.h" #include "log.h" #include "net/net.h" #include "resources/iteminfo.h" #include "resources/resourcemanager.h" #include "utils/dtor.h" #include "utils/gettext.h" #include "utils/stringutils.h" #include "utils/xml.h" #include "configuration.h" #include #include void setStatsList(const std::list &stats) { extraStats = stats; } static ItemType itemTypeFromString(const std::string &name, int id = 0) { if (name=="generic") return ITEM_UNUSABLE; else if (name=="usable") return ITEM_USABLE; else if (name=="equip-1hand") return ITEM_EQUIPMENT_ONE_HAND_WEAPON; else if (name=="equip-2hand") return ITEM_EQUIPMENT_TWO_HANDS_WEAPON; else if (name=="equip-torso") return ITEM_EQUIPMENT_TORSO; else if (name=="equip-arms") return ITEM_EQUIPMENT_ARMS; else if (name=="equip-head") return ITEM_EQUIPMENT_HEAD; else if (name=="equip-legs") return ITEM_EQUIPMENT_LEGS; else if (name=="equip-shield") return ITEM_EQUIPMENT_SHIELD; else if (name=="equip-ring") return ITEM_EQUIPMENT_RING; else if (name=="equip-charm") return ITEM_EQUIPMENT_CHARM; else if (name=="equip-necklace") return ITEM_EQUIPMENT_NECKLACE; else if (name=="equip-feet") return ITEM_EQUIPMENT_FEET; else if (name=="equip-ammo") return ITEM_EQUIPMENT_AMMO; else if (name=="racesprite") return ITEM_SPRITE_RACE; else if (name=="hairsprite") return ITEM_SPRITE_HAIR; else return ITEM_UNUSABLE; } /* * Common itemDB functions */ bool ItemDB::exists(int id) { assert(mLoaded); ItemInfos::const_iterator i = mItemInfos.find(id); return i != mItemInfos.end(); } const ItemInfo &ItemDB::get(int id) { assert(mLoaded); ItemInfos::const_iterator i = mItemInfos.find(id); if (i == mItemInfos.end()) { logger->log("ItemDB: Warning, unknown item ID# %d", id); return *mUnknown; } return *(i->second); } const ItemInfo &ItemDB::get(const std::string &name) { assert(mLoaded); NamedItemInfos::const_iterator i = mNamedItemInfos.find(normalize(name)); if (i == mNamedItemInfos.end()) { if (!name.empty()) { logger->log("ItemDB: Warning, unknown item name \"%s\"", name.c_str()); } return *mUnknown; } return *(i->second); } void ItemDB::loadSpriteRef(ItemInfo *itemInfo, xmlNodePtr node) { std::string gender = XML::getProperty(node, "gender", "unisex"); std::string filename = (const char*) node->xmlChildrenNode->content; if (gender == "male" || gender == "unisex") { itemInfo->setSprite(filename, GENDER_MALE); } if (gender == "female" || gender == "unisex") { itemInfo->setSprite(filename, GENDER_FEMALE); } } void ItemDB::loadSoundRef(ItemInfo *itemInfo, xmlNodePtr node) { std::string event = XML::getProperty(node, "event", ""); std::string filename = (const char*) node->xmlChildrenNode->content; if (event == "hit") { itemInfo->addSound(EQUIP_EVENT_HIT, filename); } else if (event == "strike") { itemInfo->addSound(EQUIP_EVENT_STRIKE, filename); } else { logger->log("ItemDB: Ignoring unknown sound event '%s'", event.c_str()); } } void ItemDB::loadFloorSprite(SpriteDisplay *display, xmlNodePtr floorNode) { for_each_xml_child_node(spriteNode, floorNode) { if (xmlStrEqual(spriteNode->name, BAD_CAST "sprite")) { SpriteReference *currentSprite = new SpriteReference; currentSprite->sprite = (const char*)spriteNode->xmlChildrenNode->content; currentSprite->variant = XML::getProperty(spriteNode, "variant", 0); display->sprites.push_back(currentSprite); } else if (xmlStrEqual(spriteNode->name, BAD_CAST "particlefx")) { std::string particlefx = (const char*)spriteNode->xmlChildrenNode->content; display->particles.push_back(particlefx); } } } void ItemDB::unload() { logger->log("Unloading item database..."); delete mUnknown; mUnknown = NULL; delete_all(mItemInfos); mItemInfos.clear(); mNamedItemInfos.clear(); mLoaded = false; } void ItemDB::loadCommonRef(ItemInfo *itemInfo, xmlNodePtr node) { if (!xmlStrEqual(node->name, BAD_CAST "item")) return; int id = XML::getProperty(node, "id", 0); if (!id) { logger->log("ItemDB: Invalid or missing item Id in " ITEMS_DB_FILE "!"); return; } else if (mItemInfos.find(id) != mItemInfos.end()) logger->log("ItemDB: Redefinition of item Id %d", id); int view = XML::getProperty(node, "view", 0); std::string name = XML::getProperty(node, "name", ""); std::string image = XML::getProperty(node, "image", ""); std::string description = XML::getProperty(node, "description", ""); std::string attackAction = XML::getProperty(node, "attack-action", ""); int attackRange = XML::getProperty(node, "attack-range", 0); std::string missileParticle = XML::getProperty(node, "missile-particle", ""); // Load Ta Item Type std::string typeStr = XML::getProperty(node, "type", "other"); itemInfo->mType = itemTypeFromString(typeStr); int weight = XML::getProperty(node, "weight", 0); itemInfo->mWeight = weight > 0 ? weight : 0; SpriteDisplay display; display.image = image; itemInfo->mId = id; itemInfo->mName = name; itemInfo->mDescription = description; itemInfo->mView = view; itemInfo->mWeight = weight; itemInfo->setAttackAction(attackAction); itemInfo->mAttackRange = attackRange; itemInfo->setMissileParticle(missileParticle); // Load , , and for_each_xml_child_node(itemChild, node) { if (xmlStrEqual(itemChild->name, BAD_CAST "sprite")) { std::string attackParticle = XML::getProperty( itemChild, "particle-effect", ""); itemInfo->mParticle = attackParticle; loadSpriteRef(itemInfo, itemChild); } else if (xmlStrEqual(itemChild->name, BAD_CAST "sound")) { loadSoundRef(itemInfo, itemChild); } else if (xmlStrEqual(itemChild->name, BAD_CAST "floor")) { loadFloorSprite(&display, itemChild); } } // If the item has got a floor image, we bind the good reference. itemInfo->mDisplay = display; } void ItemDB::addItem(ItemInfo *itemInfo) { std::string itemName = itemInfo->mName; itemInfo->mName = itemName.empty() ? _("unnamed") : itemName; mItemInfos[itemInfo->mId] = itemInfo; if (!itemName.empty()) { std::string temp = normalize(itemName); NamedItemInfos::const_iterator itr = mNamedItemInfos.find(temp); if (itr == mNamedItemInfos.end()) mNamedItemInfos[temp] = itemInfo; else logger->log("ItemDB: Duplicate name (%s) for item id %d found.", temp.c_str(), itemInfo->mId); } } template static void checkParameter(int id, const T param, const T errorValue) { if (param == errorValue) { std::stringstream errMsg; errMsg << "ItemDB: Missing " << param << " attribute for item id " << id << "!"; logger->log(errMsg.str().c_str()); } } void ItemDB::checkItemInfo(ItemInfo* itemInfo) { int id = itemInfo->mId; if (!itemInfo->getAttackAction().empty()) if (itemInfo->mAttackRange == 0) logger->log("ItemDB: Missing attack range from weapon %i!", id); if (id >= 0) { checkParameter(id, itemInfo->mName, std::string()); checkParameter(id, itemInfo->mDescription, std::string()); checkParameter(id, itemInfo->mDisplay.image, std::string()); checkParameter(id, itemInfo->mWeight, 0); } } namespace TmwAthena { // Description fields used by TaItemDB *itemInfo->mEffect. static char const *const fields[][2] = { { "attack", N_("Attack %+d") }, { "defense", N_("Defense %+d") }, { "hp", N_("HP %+d") }, { "mp", N_("MP %+d") } }; void TaItemDB::load() { if (mLoaded) unload(); logger->log("Initializing TmwAthena item database..."); mUnknown = new TaItemInfo; mUnknown->mName = _("Unknown item"); mUnknown->mDisplay = SpriteDisplay(); std::string errFile = paths.getStringValue("spriteErrorFile"); mUnknown->setSprite(errFile, GENDER_MALE); mUnknown->setSprite(errFile, GENDER_FEMALE); XML::Document doc(ITEMS_DB_FILE); xmlNodePtr rootNode = doc.rootNode(); if (!rootNode || !xmlStrEqual(rootNode->name, BAD_CAST "items")) { logger->error("ItemDB: Error while loading " ITEMS_DB_FILE "!"); return; } for_each_xml_child_node(node, rootNode) { TaItemInfo *itemInfo = new TaItemInfo; loadCommonRef(itemInfo, node); // Everything not unusable or usable is equippable by the Ta type system. itemInfo->mEquippable = itemInfo->mType != ITEM_UNUSABLE && itemInfo->mType != ITEM_USABLE; // Load nano description std::vector effect; for (int i = 0; i < int(sizeof(fields) / sizeof(fields[0])); ++i) { int value = XML::getProperty(node, fields[i][0], 0); if (!value) continue; effect.push_back(strprintf(gettext(fields[i][1]), value)); } for (std::list::iterator it = extraStats.begin(); it != extraStats.end(); it++) { int value = XML::getProperty(node, it->mTag.c_str(), 0); if (!value) continue; effect.push_back(strprintf(it->mFormat.c_str(), value)); } std::string temp = XML::getProperty(node, "effect", ""); if (!temp.empty()) effect.push_back(temp); itemInfo->mEffect = effect; checkItemInfo(itemInfo); addItem(itemInfo); } checkHairWeaponsRacesSpecialIds(); mLoaded = true; } void TaItemDB::checkItemInfo(ItemInfo* itemInfo) { ItemDB::checkItemInfo(itemInfo); // Check for unusable items? //checkParameter(id, itemInfo->mType, 0); } }; // namespace TmwAthena namespace ManaServ { static std::map triggerTable; static void initTriggerTable() { if (triggerTable.empty()) { // FIXME: This should ideally be softcoded via XML or similar. logger->log("Initializing ManaServ trigger table..."); triggerTable["existence"] = " when it is in the inventory"; triggerTable["activation"] = " upon activation"; triggerTable["equip"] = " upon successful equip"; triggerTable["leave-inventory"] = " when it leaves the inventory"; triggerTable["unequip"] = " when it is unequipped"; triggerTable["equip-change"] = " when it changes the way it is equipped"; } } void ManaServItemDB::load() { if (mLoaded) unload(); // Initialize the trigger table for effect descriptions initTriggerTable(); logger->log("Initializing ManaServ item database..."); mUnknown = new ManaServItemInfo; mUnknown->mName = _("Unknown item"); mUnknown->mDisplay = SpriteDisplay(); std::string errFile = paths.getStringValue("spriteErrorFile"); mUnknown->setSprite(errFile, GENDER_MALE); mUnknown->setSprite(errFile, GENDER_FEMALE); XML::Document doc(ITEMS_DB_FILE); xmlNodePtr rootNode = doc.rootNode(); if (!rootNode || !xmlStrEqual(rootNode->name, BAD_CAST "items")) { logger->log("ItemDB: Error while loading " ITEMS_DB_FILE "!"); return; } for_each_xml_child_node(node, rootNode) { ManaServItemInfo *itemInfo = new ManaServItemInfo; loadCommonRef(itemInfo, node); // We default eqippable and activatable to false as their actual value will be set // within the and sub-nodes.. itemInfo->mActivatable = false; itemInfo->mEquippable = false; // Load , and sub nodes. std::vector effect; for_each_xml_child_node(itemChild, node) { if (xmlStrEqual(itemChild->name, BAD_CAST "equip")) { // The fact that there is a way to equip is enough. // Discard any details, but mark the item as equippable. itemInfo->mEquippable = true; } else if (xmlStrEqual(itemChild->name, BAD_CAST "effect")) { std::string trigger = XML::getProperty( itemChild, "trigger", ""); if (trigger.empty()) { logger->log("Found empty trigger effect label, skipping."); continue; } if (trigger == "activation") itemInfo->mActivatable = true; std::map::const_iterator triggerLabel = triggerTable.find(trigger); if (triggerLabel == triggerTable.end()) { logger->log("Warning: unknown trigger %s in item %d!", trigger.c_str(), itemInfo->mId); continue; } for_each_xml_child_node(effectChild, itemChild) { if (xmlStrEqual(effectChild->name, BAD_CAST "modifier")) { std::string attribute = XML::getProperty( effectChild, "attribute", ""); double value = XML::getFloatProperty( effectChild, "value", 0.0); int duration = XML::getProperty( effectChild, "duration", 0); if (attribute.empty() || !value) { logger->log("Warning: incomplete modifier definition, skipping."); continue; } std::list::const_iterator it = extraStats.begin(), it_end = extraStats.end(); while (it != it_end && !(*it == attribute)) ++it; if (it == extraStats.end()) { logger->log("Warning: unknown modifier tag %s, skipping.", attribute.c_str()); continue; } effect.push_back( strprintf(strprintf( duration ? strprintf("%%s%%s. This effect lasts %d ticks.", duration).c_str() : "%s%s.", it->mFormat.c_str(), triggerLabel->second).c_str(), value)); } else if (xmlStrEqual(effectChild->name, BAD_CAST "modifier")) effect.push_back(strprintf("Provides an autoattack%s.", triggerLabel->second)); else if (xmlStrEqual(effectChild->name, BAD_CAST "consumes")) effect.push_back(strprintf("This will be consumed%s.", triggerLabel->second)); else if (xmlStrEqual(effectChild->name, BAD_CAST "label")) effect.push_back( (const char*)effectChild->xmlChildrenNode->content); } } // Set Item Type based on subnodes info // TODO: Improve it once the itemTypes are loaded through xml itemInfo->mType = ITEM_UNUSABLE; if (itemInfo->mActivatable) itemInfo->mType = ITEM_USABLE; else if (itemInfo->mEquippable) itemInfo->mType = ITEM_EQUIPMENT_TORSO; } // end for_each_xml_child_node(itemChild, node) itemInfo->mEffect = effect; checkItemInfo(itemInfo); addItem(itemInfo); } mLoaded = true; } void ManaServItemDB::checkItemInfo(ItemInfo* itemInfo) { ItemDB::checkItemInfo(itemInfo); // Add specific Manaserv checks here } }; // namespace ManaServ